hypweb XC - PukiWiki/1.4/Manual/Plugin/A-D [A]

重要度

★★★★☆

&aname( アンカー名 [,{[super], [full], [noid]}] ){ アンカー文字列 };

#aname( アンカー名 [,{[super], [full], [noid]}, アンカー文字列] )

概要

指定した位置にアンカー(リンクの飛び先)を設定します。

アンカー名の値がアンカーのフラグメント指定子に使用されます。アンカー名は省略できません。アンカー名には半角英字（大文字／小文字）が使用可能です。

super,full,noid でアンカーの出力方式を指定します。

- super －アンカー文字列を上付き表示します。省略時は上付き表示されません。
- full －フラグメント指定子以外のURIを補ってアンカーを出力します。省略時はフラグメント指定子のみ出力されます。
- noid －アンカーにフラグメント指定子を出力しません。

アンカー文字列が指定された場合、指定した文字列に対してアンカーが出力されます。アンカーの存在を利用者に明示したい場合に利用します。省略時は空文字に対するアンカーとなります。
プラグイン内設定

- PLUGIN_ANAME_ID_MAX　アンカー名に指定可能な文字列長の上限
- PLUGIN_ANAME_ID_REGEX　アンカー名に指定可能な文字列の正規表現
- PLUGIN_ANAME_ID_MUST_UNIQUE　重複したアンカー名を利用した場合エラーとする

備考

通常はインライン型プラグインとして使用します。2つのブロック型プラグインに挟まれた部分にアンカー設定したい場合にインラインプラグインとして記述できないため、ブロック型プラグインとしても使えるようにしてあります。

PukiWiki本体処理でanameプラグインを内部的に呼び出しているため、必ず組み込む必要があります。

article

種別

（コマンド）

重要度

★★★☆☆

#article

概要

指定した位置に簡易掲示板を設置します。

プラグイン内設定

- PLUGIN_ARTICLE_COLS　テキストエリアのカラム数
- PLUGIN_ARTICLE_ROWS　テキストエリアの行数
- PLUGIN_ARTICLE_NAME_COLS　名前テキストエリアのカラム数
- PLUGIN_ARTICLE_SUBJECT_COLS　題名テキストエリアのカラム数
- PLUGIN_ARTICLE_NAME_FORMAT　名前の挿入フォーマット
- PLUGIN_ARTICLE_SUBJECT_FORMAT　題名の挿入フォーマット
- PLUGIN_ARTICLE_INS　入力内容を入力欄の前後どちらに挿入するか
- PLUGIN_ARTICLE_COMMENT　書き込みの下に一行コメントを入れるか
- PLUGIN_ARTICLE_AUTO_BR　改行を自動的変換するか
- PLUGIN_ARTICLE_MAIL_AUTO_SEND　投稿内容のメール自動配信をするか
- PLUGIN_ARTICLE_MAIL_FROM　投稿内容のメール送信時の送信者メールアドレス
- PLUGIN_ARTICLE_MAIL_SUBJECT_PREFIX　投稿内容のメール送信時の題名
- $_plugin_article_mailto　投稿内容のメール自動配信先アドレス

attach

種別

（コマンド）

重要度

★★★★★

#attach( [nolist] [,noform] )

概要

ページの添付ファイルの一覧を表示し、ファイル添付のための入力フォームを設置します。

nolist, noform で表示内容を指定します。

- nolist －ページの添付ファイルの一覧を表示しません。省略時は一覧を表示します。
- noform －ファイル添付のための入力フォームを表示しません。省略時は入力フォームを表示します。

プラグイン内設定

- PLUGIN_ATTACH_MAX_FILESIZE　ファイルアップロードの上限
- PLUGIN_ATTACH_UPLOAD_ADMIN_ONLY　管理者だけが添付ファイルをアップロードできるようにするか
- PLUGIN_ATTACH_DELETE_ADMIN_ONLY　管理者だけが添付ファイルを削除できるようにするか
- PLUGIN_ATTACH_DELETE_ADMIN_NOBACKUP　PLUGIN_ATTACH_DELETE_ADMIN_ONLYのとき、管理者が添付ファイルを削除するときは、バックアップを作らない
- PLUGIN_ATTACH_PASSWORD_REQUIRE　アップロード/削除時にパスワードを要求するか(PLUGIN_ATTACH_～_ADMIN_ONLYが優先)
- PLUGIN_ATTACH_RENAME_ENABLE　ファイルのリネームが可能か
- PLUGIN_ATTACH_FILE_MODE　アップロードされたファイルのアクセス権
- PLUGIN_ATTACH_FILE_ICON　アイコンイメージのファイル
- PLUGIN_ATTACH_CONFIG_PAGE_MIME　ダウンロード時のmime-typeを記述したページ

備考

デフォルトのskinのメニューの「添付」で呼び出されているため、デフォルトのskinを使う場合には必ず組み込む必要があります。

プラグイン内設定の PLUGIN_ATTACH_MAX_FILESIZE を増やす場合は、php.iniの upload_max_filesize やApache の LimitRequestBodyなどPukiWiki以外での上限設定がある事に注意して下さい。

B

back

種別

重要度

★☆☆☆☆

#back( [[表示文字列] [,[left| center| right] [,[0| 1] [,[戻り先] ]]]] )

概要

指定した位置に戻り先へのリンクを設置します。

表示文字列は省略すると「戻る」になります。

left、center、rightで表示位置を指定します。省略時はcenterになります。

- left －リンクを左寄せで表示します。
- center －リンクを中央寄せで表示します。
- right －リンクを右寄せで表示します。

0、1で水平線の有無を指定します。省略すると1になります。

- 0 －水平線を表示しません。
- 1 －水平線を表示します。

戻り先はリンクを選択時の移動先となるURL、ページ名のいずれかで指定します。PLUGIN_BACK_ALLOW_PAGELINKがTRUEの場合のみページ名を指定可能です。ページ名は「ページ名#anchor」の記述を行う事で移動先のアンカーも指定可能です。PLUGIN_BACK_ALLOW_JAVASCRIPTがTRUEの場合のみ戻り先の省略が可能です。戻り先を省略すると直前に参照していたページが戻り先になりますが、利用者のブラウザの設定がJavaScript onでないと機能しません。
プラグイン内設定

- PLUGIN_BACK_ALLOW_PAGELINK　ページ名(+アンカー名)による戻り先指定を可能とするかどうか
- PLUGIN_BACK_ALLOW_JAVASCRIPT　戻り先の指定にJavaScript (history.go(-1))を利用するかどうか
- PLUGIN_BACK_USAGE　エラー時に表示される使用方法

backup

種別: コマンド
重要度: ★★★★★
書式: ?cmd=backup [&page=ページ名]
概要: 指定したページ、あるいは全体のバックアップ一覧を表示します。
引数: ページ名を省略すると、PukiWiki全体のバックアップ一覧を表示します。ページ名はエンコードされている必要があります。
プラグイン内設定

- PLUGIN_BACKUP_DISABLE_BACKUP_RENDERING　バックアップデータをレンダリングする機能を無効にする。

br

種別

インライン型プラグイン

重要度

★★☆☆☆

#br

&br;

概要

文章中で改行を行います。

段落やリスト、テーブル内など、行末の~による改行ではブロック要素を抜けてしまう個所で改行や空行の挿入するために用います。

プラグイン内設定

- PLUGIN_BR_ESCAPE_BLOCKQUOTE　引用文中で利用した場合のタグ不整合を回避する
- PLUGIN_BR_TAG　brプラグインが出力するタグ

bugtrack

種別

（コマンド）

重要度

★☆☆☆☆ (一般サイト)

★★★★☆ (ソフト開発サイト)

#bugtrack( [[ページ名] [,カテゴリー1…カテゴリーn]] )

概要

バグ追跡システムの一部分であるバグレポートの入力フォームを設置します。

ページ名にはバグレポートとして作成されるページの親階層となるページ名を指定します。省略時は設置したページとなります。
通常、バグレポートには指定したページ名の子階層に自動的に番号が振られてページが作成されます。つまり"バグ報告ページ"と指定して設置した場合は、バグ報告ページ/1,バグ報告ページ/2,バグ報告ページ/3…のようにバグレポートのページが作成される事になります。

カテゴリーにはバグの対象となりうる要素を指定します。省略時は入力欄となります。

プラグイン内設定

- PLUGIN_BUGTRACK_NUMBER_FORMAT　バグレポートとして作成されるページ番号の形式

備考: ソフト開発サイトで重宝するプラグインです。もしバグ追跡以外の用途でバグレポートのように定型的な項目を持ったページを作成するフォームが欲しい場合，あるいはバグレポートの項目をカスタマイズしたい場合はtracker プラグインを使用して下さい。

bugtrack_list

種別

重要度

★☆☆☆☆ (一般サイト)

★★★★☆ (ソフト開発サイト)

#bugtrack_list( [ページ名] )

概要

バグ追跡システムの一部分であるバグレポートの一覧表示を行います。

ページ名にはバグレポートとして作成されるページの親階層となるページ名を指定します。省略時は設置したページとなります。

備考

通常はbugtrack プラグインと並べて使用します。

bugtrack_listプラグインの中からbugtrack プラグインを呼び出しているため、bugtrack プラグインがないと機能しません。

bugtrack_listプラグインは、tracker_list プラグインに比べて低機能ですが、リソース消費が少なく処理速度が速いというメリットがあります。この差はページ数の増加に比例して顕れる傾向があるため、使い分けが必要です。

C

calendar、calendar_edit、calendar_read

種別

重要度

★☆☆☆☆

#calendar( [{[ページ名], [年月]}] )

#calendar_edit( [{[ページ名], [年月]}] )

#calendar_read( [{[ページ名], [年月]}] )

概要

指定した位置にカレンダーを設置します。カレンダー上でyyyy/mm/ddという日付を選択すると、ページ名/yyyymmddというページを編集／表示できます。

カレンダーの日付を選択した場合に該当するページを編集状態、表示状態のどちらで開くかが３つのプラグインの違いです。calendar_editとは編集状態で、calendar, calendar_readは表示状態で開きます。

ページ名は編集/参照するカレンダーのページの上位ページ名を指定します。ページ名を省略すると設置したページのページ名になります。

年月は表示するカレンダーの西暦と月をyyyymmの形式で指定します。省略した場合は現在の年月になります。

備考

より高機能なcalendar2プラグインがあるため、あえてcalendarプラグインを使う必要性はほとんどなくなりました。

calendar_editプラグイン及びcalendar_readプラグインの中からcalendarプラグインを呼び出しているため、calendarプラグインがないと機能しません。

calendar_viewer

種別

（コマンド）

重要度

★★★☆☆

概要

calendarプラグインまたはcalendar2プラグインで作成されたページを指定した位置に表示します。

ページ名はcalendarプラグインまたはcalendar2プラグインを設置しているページの名前を指定します。

yyyy-mmを指定時、指定した年月のページを表示します。

数字を指定時、指定した件数分のページを表示します。

x*yを指定時、先頭より数えて x ページ目(先頭は0)から、y件づつ一覧表示します。x と yはいずれも数値です。

thisを指定時、今月のページを一覧表示します。

past、future、viewで表示するページの条件を指定します。省略/無指定時はpastとなります。

- past －今日以前のページを表示します。
- future －今日以降のページを表示します。
- view －過去から未来へ一覧表示します。

年月日の区切り文字は-や/などを指定します。省略した場合は-になります。
プラグイン内設定

- PLUGIN_CALENDAR_VIEWER_USAGE　エラー時に表示される使用方法
- PLUGIN_CALENDAR_VIEWER_DATE_FORMAT　日付の表示形式

備考: calendar2プラグインでは今日の日付の記事がない場合、記事を表示しないため、午前0時になったとたんに記事が表示されなくなるという弱点がありました。calendar_viewerはその弱点を補うために開発されたプラグインです。calendar_viewは、日付が変わっても最新の記事を表示することができます。カレンダーそのものの表示はcalendar2(off)で行ないます。

calendar2

種別

（コマンド）

重要度

★★★☆☆

#calendar2( [{[ページ名|*], [yyyymm], [off]}] )

概要

指定した位置にカレンダーを設置します。表示月のとなりに表示されたリンク(<< および >>)を選択することで先月／次月分のカレンダーを表示できます。カレンダー上でyyyy/mm/ddという日付を選択すると、ページ名/yyyy-mm-ddというページを表示できます。当日分のページが作成されていた場合、カレンダーの右隣に当日分のページ内容を表示します。