|
未分類プラグイン の変更点
#freeze
#contents
* プラグインマニュアル [#g4919d30]
** プラグインマニュアルの凡例 [#jce09f74]
プラグインマニュアルは以下の形式で記述されています。
''プラグイン名''
''種別''
プラグインがどのような方法で呼び出しを行えるかを示します。複数の呼び出し方法をもつプラグインも存在します。
-- コマンド - コマンド形式の呼び出しが可能であることを示します。内部的に呼び出されるため、説明を省いている場合はカッコで括られています。
-- ブロック型プラグイン - ブロック型プラグインでの呼び出しが可能である事を示します。
-- インライン型プラグイン - インライン型プラグインでの呼び出しが可能である事を示します。
-- 擬似ブロック型プラグイン - PukiWiki本体で実現されている機能であることを示します。記述方式がブロック型プラグインと同じであるため、便宜上プラグインのマニュアルに含めています。
''重要度''
そのプラグインの一般的な利用頻度や有用性の目安を示します。さほど重要でない場合は ★☆☆☆☆ が、重要なプラグインの場合は ★★★★★ です。
''書式''
プラグインでの引数指定方法です。引数の指定方法の表現のため、下記の記述書式を使っています。
-- [] - 省略可能で必要に応じて記述する箇所です。
-- | - |で区切られた複数の項目のうち、指定できるのは1つである事を示します。
-- {} - 中カッコ内のみ引数の指定順序が任意である事を示します。
''概要''
そのプラグインの機能概要です。
''引数''
引数の詳細な説明です。
''プラグイン内設定''
プラグインのソース中で定義されている定数の一覧です。引数で変更できない詳細なカスタマイズが可能となります。
''備考''
プラグインに関する参考情報です。
//--- --- --- ---
* A [#a_]
** add 実行すると編集画面が表示されます。更新ボタンを押すと、指定した既存ページの末尾に編集欄で入力した内容が追加されます。 [#add]
''種別''
コマンド
''重要度''
★☆☆☆☆
''書式''
''?cmd=add'' &color(blue){&page=ページ名};
''概要''
実行すると編集画面が表示されます。更新ボタンを押すと、指定した既存ページの末尾に編集欄で入力した内容が追加されます。
''引数''
ページ名は省略できません。ページ名はエンコードされている必要があります。
#br
[[edit>未分類プラグイン#edit]]が編集画面に既存のページ内容を表示するのに対し、addは常に編集画面が空となります。不用意に既存の入力内容を
変更する事がないため、単純に追記していくだけのページではaddを使うと便利です。
#br
''備考''
もともとデフォルトのskinでメニューの「追加」として使われていましたが、editコマンド(編集)で事足りるため、デフォルトのskinではメニューから外されています。
** aname 指定した位置にアンカー(リンクの飛び先)を設定します。 [#aname]
''種別''
インライン型プラグイン
ブロック型プラグイン
#br
''重要度''
★★★★☆
#br
''書式''
''&aname('' &color(blue){アンカー名}; [,{[&color(blue){super};], [&color(blue){full};], [&color(blue){noid};]}] ''){'' &color(blue){アンカー文字列}; ''};''
#br
''#aname('' &color(blue){アンカー名}; [,{[&color(blue){super};], [&color(blue){full};], [&color(blue){noid};]}, &color(blue){アンカー文字列};] )
#br
''概要''
指定した位置にアンカー(リンクの飛び先)を設定します。
#br
''引数''
アンカー名の値がアンカーのフラグメント指定子に使用されます。アンカー名は省略できません。
アンカー名には半角英字(大文字/小文字)が使用可能です。
#br
super,full,noid でアンカーの出力方式を指定します。
#br
-- &color(blue){super}; - アンカー文字列を上付き表示します。省略時は上付き表示されません。
-- &color(blue){full}; - フラグメント指定子以外のURIを補ってアンカーを出力します。省略時はフラグメント指定子のみ出力されます。
--&color(blue){noid}; - アンカーにフラグメント指定子を出力しません。
&br;
&color(blue){アンカー文字列};が指定された場合、指定した文字列に対してアンカーが出力されます。アンカーの存在を
利用者に明示したい場合に利用します。省略時は空文字に対するアンカーとなります。
#br
''プラグイン内設定''
#br
-- PLUGIN_ANAME_ID_MAX アンカー名に指定可能な文字列長の上限
-- PLUGIN_ANAME_ID_REGEX アンカー名に指定可能な文字列の正規表現
-- PLUGIN_ANAME_ID_MUST_UNIQUE 重複したアンカー名を利用した場合エラーとする
&br;
''備考''
通常はインライン型プラグインとして使用します。2つのブロック型プラグインに挟まれた部分にアンカー設定したい場合に
インラインプラグインとして記述できないため、ブロック型プラグインとしても使えるようにしてあります。
#br
PukiWiki本体処理でanameプラグインを内部的に呼び出しているため、必ず組み込む必要があります。
** article 指定した位置に簡易掲示板を設置します。 [#article]
''種別''
(コマンド)
ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''#article''
#br
''概要''
指定した位置に簡易掲示板を設置します。
#br
''プラグイン内設定''
#br
-- 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]
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★★★★★
#br
''書式''
''#attach('' [&color(blue){nolist};] [,&color(blue){noform};] '')''
#br
''概要''
ページの添付ファイルの一覧を表示し、ファイル添付のための入力フォームを設置します。
#br
''引数''
nolist, noform で表示内容を指定します。
#br
-- nolist - ページの添付ファイルの一覧を表示しません。省略時は一覧を表示します。
-- noform - ファイル添付のための入力フォームを表示しません。省略時は入力フォームを表示します。
&br;
''プラグイン内設定''
#br
-- 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_FILE_MODE アップロードされたファイルのアクセス権
-- PLUGIN_ATTACH_FILE_ICON アイコンイメージのファイル
-- PLUGIN_ATTACH_CONFIG_PAGE_MIME ダウンロード時のmime-typeを記述したページ
&br;
''備考''
デフォルトのskinのメニューの「添付」で呼び出されているため、デフォルトのskinを使う場合には必ず組み込む必要があります。
#br
プラグイン内設定の PLUGIN_ATTACH_MAX_FILESIZE を増やす場合は、php.iniの upload_max_filesize やApache の
LimitRequestBodyなどPukiWiki以外での上限設定がある事に注意して下さい。
#hr
//---
* B [#b_]
** back 指定した位置に戻り先へのリンクを設置します。 [#back]
''種別''
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆
#br
''書式''
''#back('' [[&color(blue){表示文字列};] [,[&color(blue){left};| &color(blue){center};| &color(blue){right};] [,[&color(blue){0};| &color(blue){1};] [,[&color(blue){戻り先};] ]]]] '')''
#br
''概要''
指定した位置に戻り先へのリンクを設置します。
#br
''引数''
表示文字列は省略すると「戻る」になります。
#br
left、center、rightで表示位置を指定します。省略時はcenterになります。
#br
-- left - リンクを左寄せで表示します。
-- center - リンクを中央寄せで表示します。
-- right - リンクを右寄せで表示します。
&br;
0、1で水平線の有無を指定します。省略すると1になります。
#br
-- 0 - 水平線を表示しません。
-- 1 - 水平線を表示します。
#br
&br;
戻り先はリンクを選択時の移動先となるURL、ページ名のいずれかで指定します。PLUGIN_BACK_ALLOW_PAGELINKがTRUEの場合のみページ名を指定可能です。
ページ名は「ページ名#anchor」の記述を行う事で移動先のアンカーも指定可能です。
PLUGIN_BACK_ALLOW_JAVASCRIPTがTRUEの場合のみ戻り先の省略が可能です。
戻り先を省略すると直前に参照していたページが戻り先になりますが、利用者のブラウザの設定がJavaScript onでないと機能しません。
#br
''プラグイン内設定''
#br
-- PLUGIN_BACK_ALLOW_PAGELINK ページ名(+アンカー名)による戻り先指定を可能とするかどうか
-- PLUGIN_BACK_ALLOW_JAVASCRIPT 戻り先の指定にJavaScript(history.go(-1))を利用するかどうか
-- PLUGIN_BACK_USAGE エラー時に表示される使用方法
** backup 指定したページ、あるいは全体のバックアップ一覧を表示します。 [#backup]
''種別''
コマンド
#br
''重要度''
★★★★★
#br
''書式''
''?cmd=backup'' [&color(blue){&page=ページ名};]
#br
''概要''
#br
指定したページ、あるいは全体のバックアップ一覧を表示します。
''引数''
ページ名を省略すると、PukiWiki全体のバックアップ一覧を表示します。ページ名はエンコードされている必要があります。
#br
''プラグイン内設定''
#br
-- PLUGIN_BACKUP_DISABLE_BACKUP_RENDERING バックアップデータをレンダリングする機能を無効にする。
** br 文章中で改行を行います。 [#br]
''種別''
ブロック型プラグイン
インライン型プラグイン
#br
''重要度''
★★☆☆☆
#br
''書式''
''#br''
#br
''&br;''
#br
''概要''
文章中で改行を行います。
#br
段落やリスト、テーブル内など、行末の~による改行ではブロック要素を抜けてしまう個所で改行や空行の挿入するために用います。
#br
''プラグイン内設定''
#br
-- PLUGIN_BR_ESCAPE_BLOCKQUOTE 引用文中で利用した場合のタグ不整合を回避する
-- PLUGIN_BR_TAG brプラグインが出力するタグ
** bugtrack [#bugtrack]
''種別''
(コマンド)
#br
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆ (一般サイト)
#br
★★★★☆ (ソフト開発サイト)
''書式''
''#bugtrack('' [[&color(blue){ページ名};] [,&color(blue){カテゴリー1…カテゴリーn};]] '')''
''概要''
バグ追跡システムの一部分であるバグレポートの入力フォームを設置します。
#br
''引数''
ページ名にはバグレポートとして作成されるページの親階層となるページ名を指定します。省略時は設置したページとなります。
通常、バグレポートには指定したページ名の子階層に自動的に番号が振られてページが作成されます。つまり"バグ報告ページ"と指定して設置した場合は、バグ報告ページ/1,バグ報告ページ/2,バグ報告ページ/3…のようにバグレポートのページが作成される事になります。
#br
カテゴリーにはバグの対象となりうる要素を指定します。省略時は入力欄となります。
#br
''プラグイン内設定''
#br
-- PLUGIN_BUGTRACK_NUMBER_FORMAT バグレポートとして作成されるページ番号の形式
&br;
''備考''
ソフト開発サイトで重宝するプラグインです。もしバグ追跡以外の用途でバグレポートのように定型的な項目を持ったページを作成するフォームが欲しい場合,あるいはバグレポートの項目をカスタマイズしたい場合は[[tracker>未分類プラグイン#tracker]]プラグインを使用して下さい。
** bugtrack_list [#bugtrack_list]
''種別''
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆ (一般サイト)
#br
★★★★☆ (ソフト開発サイト)
#br
''書式''
''#bugtrack_list('' [&color(blue){ページ名};] '')''
''概要''
バグ追跡システムの一部分であるバグレポートの一覧表示を行います。
#br
''引数''
ページ名にはバグレポートとして作成されるページの親階層となるページ名を指定します。省略時は設置したページとなります。
#br
''備考''
通常はbugtrackプラグインと並べて使用します。
#br
bugtrack_listプラグインの中からbugtrackプラグインを呼び出しているため、bugtrackプラグインがないと機能しません。
#br
bugtrack_listプラグインは、[[tracker_list>未分類プラグイン#tracker_list]]プラグインに比べて低機能ですが、リソース消費が少なく処理速度が速いというメリットがあります。この差はページ数の増加に比例して顕れる傾向があるため、使い分けが必要です。
#hr
* C [#c_]
** calendar、calendar_edit、calendar_read [#calendar]
''種別''
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆
#br
''書式''
''#calendar('' [{[&color(blue){ページ名};], [&color(blue){年月};]}] '')''
''#calendar_edit('' [{[&color(blue){ページ名};], [&color(blue){年月};]}] '')''
''#calendar_read('' [{[&color(blue){ページ名};], [&color(blue){年月};]}] '')''
#br
''概要''
指定した位置にカレンダーを設置します。カレンダー上でyyyy/mm/ddという日付を選択すると、ページ名/yyyymmddというページを編集/表示できます。
#br
カレンダーの日付を選択した場合に該当するページを編集状態、表示状態のどちらで開くかが3つのプラグインの違いです。
calendar_editとは編集状態で、calendar, calendar_readは表示状態で開きます。
#br
''引数''
ページ名は編集/参照するカレンダーのページの上位ページ名を指定します。 ページ名を省略すると設置したページのページ名になります。
#br
年月は表示するカレンダーの西暦と月をyyyymmの形式で指定します。省略した場合は現在の年月になります。
''備考''
より高機能なcalendar2プラグインがあるため、あえてcalendarプラグインを使う必要性はほとんどなくなりました。
#br
calendar_editプラグイン及びcalendar_readプラグインの中からcalendarプラグインを呼び出しているため、calendarプラグインがないと機能しません。
//---
** calendar_viewer [#calendar_viewer]
''種別''
(コマンド)
ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''#calendar_viewer('' &color(blue){ページ名};, &color(blue){yyyy-mm};| &color(blue){n};| &color(blue){x*y};| &color(blue){this}; [,[&color(blue){past};|&color(blue){future};|&color(blue){view};] [,&color(blue){年月日表示の区切り文字};]] '')''
#br
''概要''
calendarプラグインまたはcalendar2プラグインで作成されたページを指定した位置に表示します。
#br
''引数''
ページ名はcalendarプラグインまたはcalendar2プラグインを設置しているページの名前を指定します。
#br
yyyy-mmを指定時、指定した年月のページを表示します。
#br
数字を指定時、指定した件数分のページを表示します。
#br
x*yを指定時、先頭より数えて x ページ目(先頭は0)から、y件づつ一覧表示します。x と yはいずれも数値です。
#br
thisを指定時、今月のページを一覧表示します。
#br
past、future、viewで表示するページの条件を指定します。省略/無指定時はpastとなります。
#br
-- past - 今日以前のページを表示します。
-- future - 今日以降のページを表示します。
-- view - 過去から未来へ一覧表示します。
&br;
年月日の区切り文字は-や/などを指定します。省略した場合は-になります。
#br
''プラグイン内設定''
#br
-- PLUGIN_CALENDAR_VIEWER_USAGE エラー時に表示される使用方法
-- PLUGIN_CALENDAR_VIEWER_DATE_FORMAT 日付の表示形式
&br;
''備考''
calendar2プラグインでは今日の日付の記事がない場合、記事を表示しないため、午前0時になったとたんに記事が表示されなくなるという弱点がありました。
calendar_viewerはその弱点を補うために開発されたプラグインです。calendar_viewは、日付が変わっても
最新の記事を表示することができます。カレンダーそのものの表示はcalendar2(off)で行ないます。
//---
** calendar2 [#calendar2]
''種別''
(コマンド)
ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''#calendar2('' [{[&color(blue){ページ名};|&color(blue){*};], [&color(blue){yyyymm};], [&color(blue){off};]}] '')''
#br
''概要''
指定した位置にカレンダーを設置します。表示月のとなりに表示されたリンク(<< および >>)を選択することで先月/次月分のカレンダーを表示できます。カレンダー上でyyyy/mm/ddという日付を選択すると、ページ名/yyyy-mm-ddというページを表示できます。当日分のページが作成されていた場合、カレンダーの右隣に当日分のページ内容を表示します。
#br
''引数''
ページ名で表示するページの上位階層のページを指定できます。ページ名を省略すると設置したページのページとなります。ページ名に*を指定すると上位階層のページはなし(表示するページ名がyyyy-mm-dd)となります。
#br
yyyymmで表示するカレンダーの西暦と月を指定できます。省略時は当日の年月となります。
#br
offを指定時、当日分ページを表示する機能は抑制されます。省略時は当日分のページを表示します。
#br
''備考''
calender_editで作成したページはページ名/yyyymmddとなり、calender2で作成したページはページ名/yyyy-mm-ddとなるため、注意が必要です。
//---
** clear refプラグインのaroundオプションで有効となったテキスト回り込み指定を解除します。 [#clear]
''種別''
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆
#br
''書式''
''#clear''
#br
''概要''
refプラグインのaroundオプションで有効となったテキスト回り込み指定を解除します。
#br
''備考''
imgプラグインのclearオプション指定時と処理内容は同等です。
** color 引数で指定したインライン要素(主に文章)の、文字色・背景色を指定します。 [#color]
''種別''
インライン型プラグイン
#br
''重要度''
★★★★☆
#br
''書式''
''&color('' [&color(blue){文字色};] [,&color(blue){背景色};] ''){'' &color(blue){文章}; ''};''
#br
''概要''
引数で指定したインライン要素(主に文章)の、文字色・背景色を指定します。
#br
''引数''
文字色・背景色はそれぞれ色名(red、blueなど)、シャープで始まる3桁の16進数値(#000~#FFF)、同じく6桁の16進数値(#000000 ~ #FFFFFF)のいずれかで指定することができます。大文字小文字は問いません。
#br
文字色・背景色の両方を省略する事はできません。一方を省略した場合は省略した側の色の変更はされません。
#br
''プラグイン内設定''
#br
-- PLUGIN_COLOR_ALLOW_CSS 色の変更に(fontタグではなく)CSSを利用する
-- PLUGIN_COLOR_USAGE エラー時に表示される使用方法
-- PLUGIN_COLOR_REGEX 引数に指定できる色の正規表現
&br;
''備考''
以下、[[W3C勧告書>http://www.w3.org/TR/1999/REC-html401-19991224/types.html#h-6.5]]より抜粋した色名。 Aqua = "#00FFFF", Black = "#000000", Blue = "#0000FF", Fuchsia = "#FF00FF", Gray = "#808080", Green = "#008000", Lime = "#00FF00", Maroon = "#800000", Navy = "#000080", Olive = "#808000", Purple = "#800080", Red = "#FF0000", Silver = "#C0C0C0", Teal = "#008080", White = "#FFFFFF", Yellow = "#FFFF00"
** comment コメントの入力用の入力欄を表示します。 [#comment]
''種別''
(コマンド)
ブロック型プラグイン
#br
''重要度''
★★★★★
#br
''書式''
''#comment('' {[&color(blue){above};], [&color(blue){below};], [&color(blue){nodate};], [&color(blue){noname};]} '')''
#br
''概要''
コメントの入力用の入力欄を表示します。
#br
''引数''
コメントの挿入方法を引数で指定します。
#br
-- above - 入力したコメントがコメント入力欄の上に追加します
-- below - 入力したコメントがコメント入力欄の下に追加します(省略時はaboveが指定されたとみなします)
-- nodate - 挿入するコメントに、挿入時刻を付加しない(省略時は付加します)
-- noname - コメント記入者名の入力欄を非表示とします(省略時は表示します)
&br;
''プラグイン内設定''
#br
-- PLUGIN_COMMENT_DIRECTION_DEFAULT コメントを入力欄の前後どちらに挿入するか
-- PLUGIN_COMMENT_SIZE_MSG コメントのテキストエリアの表示幅
-- PLUGIN_COMMENT_SIZE_NAME コメントの名前テキストエリアの表示幅
-- PLUGIN_COMMENT_FORMAT_MSG コメント欄の挿入フォーマット
-- PLUGIN_COMMENT_FORMAT_NAME 名前欄の挿入フォーマット
-- PLUGIN_COMMENT_FORMAT_NOW 時刻欄の挿入フォーマット
-- PLUGIN_COMMENT_FORMAT_STRING コメント内容全体の挿入フォーマット
//---
** contents 設置したページ中の見出しの一覧を表示します。 [#kab68071]
''種別''
擬似ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''#contents''
#br
''概要''
設置したページ中の見出しの一覧を表示します。
//---
** counter 設置したページの参照回数を表示します。 [#counter]
''種別''
ブロック型プラグイン
#br
インライン型プラグイン
#br
''重要度''
★★★☆☆
''書式''
''#counter''
#br
''&counter('' [&color(blue){total};| &color(blue){today};| &color(blue){yesterday};] '');''
#br
''概要''
設置したページの参照回数を表示します。
#br
''引数''
カウンタ表示方法として total, today, yesterday いずれかを指定します。省略時はtotalが指定されたとみなします。ブロック型プラグインでは常にtotalが指定されたとみなします。
#br
-- total - そのページが参照された回数の総計を表示します。
-- today - そのページが参照された回数(当日分)を表示します。
-- yesterday - そのページが参照された回数(昨日分)を表示します。
&br;
''プラグイン内設定''
#br
-- PLUGIN_COUNTER_SUFFIX ページ参照回数を保持するデータファイルの拡張子
&br;
''備考''
すべてのページで参照回数を表示したい場合は、MenuBarやスキンからcounterプラグインを呼び出してください。
#hr
* D [#d_]
** deleted 削除されたページの一覧を表示します。 [#deleted]
''種別''
コマンド
#br
''重要度''
★★☆☆☆
#br
''書式''
''?plugin=deleted'' {[&color(blue){&dir=diff};| &color(blue){backup};] [&color(blue){&file=on};]}
#br
''概要''
削除されたページの一覧を表示します。
#br
''引数''
file=onを指定時、バックアップ(あるいは差分)のファイル名を出力します。省略時は表示しません。
#br
dirで削除の判定方法を指定します。省略時はbackupです。
#br
-- backup - バックアップが存在し、ページが存在しない時に削除されたとみなします
''?plugin=deleted&dir=backup''
-- diff - 差分が存在し、ページが存在しない時に削除されたとみなします
''?plugin=deleted&dir=diff''
&br;
''備考''
公開Wikiの管理者にとっては誤操作や悪意をもった編集によるページ削除をチェックするのに重宝します。
//---
** diff 指定したページの現在の内容と最後のバックアップ状態との差分を表示します。 [#diff]
''種別''
コマンド
#br
''重要度''
★★★★★
#br
''書式''
''?cmd=diff'' &color(blue){&page=ページ名};
#br
''概要''
指定したページの現在の内容と最後のバックアップ状態との差分を表示します。
#br
''引数''
ページ名に変更差分を表示するページを指定します。ページ名はエンコードされていなければなりません。
#br
''備考''
最後のバックアップ以外との差分を表示する場合は[[backup>未分類プラグイン#backup]]を利用します。
** dump 指定ディレクトリ内のファイルをまとめてtar(tar.gz, tgz)形式でバックアップ/リストアします。 [#dump]
''種別''
コマンド
#br
''重要度''
★☆☆☆☆
#br
''書式''
''?plugin=dump''
#br
''概要''
指定ディレクトリ内のファイルをまとめてtar(tar.gz, tgz)形式でバックアップ/リストアします。
バックアップ/リストアの実行には管理者パスワードが必要です。
バックアップはファイル名をページ名に変換して取得する事ができます。 この変換でリストアには利用出来なくなりますが、 ファイル名からページ名の類推は容易になります。
バックアップは取得するディレクトリを任意に指定する事ができます。
リストアは該当ファイルの上書きによって行われます。 そのため、ファイルの削除を行う事はできません。
バックアップ/リストア対象として指定可能なディレクトリは、以下の通りです。
#br
-- DATA_DIR (wiki/*.txt)
-- UPLOAD_DIR (attach/*)
-- BACKUP_DIR (backup/*)
&br;
''プラグイン内設定''
&br;
-- PLUGIN_DUMP_ALLOW_RESTORE リストアを許可するかどうか
-- PLUGIN_DUMP_FILENAME_ENCORDING ページ名をディレクトリ構造に変換する際の文字コード
-- PLUGIN_DUMP_MAX_FILESIZE 最大アップロードサイズ(Kbyte)
-- PLUGIN_DUMP_DUMP バックアップ時にプラグイン内で利用する引数
-- PLUGIN_DUMP_RESTORE リストア時にプラグイン内で利用する引数
&br;
''備考''
PukiWikiが内部管理するファイルを直接取得/更新するという性質上、 セキュリティ上の問題を引き起こす可能性があります。十分ご注意ください。
#br
DATA_DIRのリストアを行った場合は、[[links>未分類プラグイン#links]]プラグインで ページ間のリンク情報キャッシュを更新する必要があります。
* E [#e_]
** edit 指定したページを編集します。 [#edit]
''種別''
コマンド
インライン型プラグイン
''重要度''
★★★★★
''書式''
''?cmd=edit'' &color(blue){&page=ページ名};
''&edit('' [&color(blue){ページ名}; {[,&color(blue){nolabel};] [,&color(blue){noicon};]}] ''){'' &color(blue){ラベル名}; ''};''
''概要''
指定したページを編集します。
''引数''
コマンド型の記述では、ページ名に編集するページを指定します。ページ名はエンコードされていなければなりません。
インライン型の記述では、ページ名は編集するページを指定します。省略時は設置したページです。
nolabel,noicon,ラベル名 でリンクの表示方法を指定します。
-- nolabel - 編集用リンクの文字列をnoicon 指定時は短縮表記、未指定時は省略します。
-- noicon - 編集用リンクに画像を表示しません。
-- ラベル名 - 編集用リンクの文字列として表示する文字列を指定します。
''プラグイン内設定''
-- PLUGIN_EDIT_FREEZE_REGEX freezeプラグインを介さず、直接入力されたfreezeを除去する正規表現
*F [#f_]
** filelist ページの一覧を各ページが記録されているファイル名と共に表示します。 [#filelist]
''種別''
コマンド
''重要度''
★☆☆☆☆
''書式''
''?cmd=filelist''
''概要''
ページの一覧を各ページが記録されているファイル名と共に表示します。
''備考''
主として管理者がメンテナンス用途に使用します。
※表示するには管理者のパスワードが必要です。
** freeze 対象のページを凍結し、不用意に変更できないようにします。 [#freeze]
''種別''
コマンド
(ブロック型プラグイン)
''重要度''
★★★☆☆
''書式''
''?cmd=freeze'' &color(blue){&page=ページ名};
''#freeze''
''概要''
対象のページを凍結し、不用意に変更できないようにします。
''引数''
ページ名には凍結するページを指定します。ページ名はエンコードされている必要があります。コマンド型でfreezeプラグインを実行するとブロック型プラグインが凍結対象のページ先頭に挿入(凍結解除の場合は削除)されます。
ブロック型のfreezeプラグインはPukiWikiが内部的に利用するもので、基本的に利用者が意識する機会はありません。
''備考''
※実行の際に管理者パスワードを要求されます。
* H [#h_]
** hr 文中に水平線を挿入します。 [#hr]
''種別''
ブロック型プラグイン
''重要度''
★★☆☆☆
''書式''
''#hr''
''概要''
文中に水平線を挿入します。
''備考''
段落やリスト、テーブル内など、通常の水平線書式(----)ではブロックを抜けてしまう個所で水平線を挿入するために用います。リスト内など左右マージンが設定されている場合は、それを引き継ぎます。
* I [#i_]
** img 添付ファイル以外の画像を表示するために開発されましたが、該当機能がrefプラグインに統合されたため、基本的に使用することはありません。過去との互換性のために残っています。 [#img]
''種別''
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
''#img('' &color(blue){画像URL};[, &color(blue){right};| &color(blue){r};| &color(blue){left};| &color(blue){l};| &color(blue){clear};| &color(blue){c};,[ &color(blue){clear};| &color(blue){c}; ]] '')''
''概要''
添付ファイル以外の画像を表示するために開発されましたが、該当機能が''ref''プラグインに統合されたため、基本的に使用することはありません。過去との互換性のために残っています。
''引数''
画像URLには表示する画像のURLを指定します。 画像にはjpeg(jpg), gif, png のみ指定可能です。
right,r,left,l,clear,c で画像の表示位置とテキストの回りこみを指定します。省略時は left が指定されたとみなします。
-- right,r - 画像を右寄せで表示します。
-- left,l - 画像を右寄せで表示します。
-- clear,c - テキストの回りこみを解除します。内部的には right,r,left,l 以外は全てclearが選択されたと見なされます。
''プラグイン内設定''
-- PLUGIN_IMG_CLEAR clear指定時に出力するタグ
-- PLUGIN_IMG_USAGE 引数未指定時に表示されるヘルプ
** include 記述した位置に指定したページを挿入して、複数のページをあたかも1つのページであるかのように表示します。 [#include]
''種別''
ブロック型プラグイン
''重要度''
★★★☆☆
''書式''
#include( ページ名[,title|,notitle] )
''概要''
記述した位置に指定したページを挿入して、複数のページをあたかも1つのページであるかのように表示します。
''引数''
ページ名には挿入するページを指定します。
第2引数にnotitleを指定すると、ページ名の表示を抑制します。titleはその逆です。
''プラグイン内設定''
-- PLUGIN_INCLUDE_MAX 一度にインクルードできるページの最大数
-- PLUGIN_INCLUDE_WITH_TITLE title,notitle を未指定時に挿入時にページ名を表示するか・しないか
-- PLUGIN_INCLUDE_USAGE 引数未指定時に表示されるヘルプ
** includesubmenu 現在表示中のページによって、MenuBarに表示する内容を切り替える為に使用します。 [#includesubmenu]
''種別''
ブロック型プラグイン
#br
''重要度''
★★☆☆☆
#br
''書式''
''#includesubmenu('' [&color(blue){showpagename};] )
#br
''概要''
現在表示中のページによって、MenuBarに表示する内容を切り替える為に使用します。
#br
表示中のページの下階層のSubMenuか、同階層にあるSubMenuページを挿入表示するプラグインです。
#br
''引数''
showpagename を指定すると、挿入表示するページのページ名を表示します。省略時はページ名を非表示とします。
//---
** insert 記述した位置に複数行入力欄とボタンを表示します。ボタンを押下すると入力欄に入力した内容をページに挿入します。 [#insert]
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
''#insert''
''概要''
記述した位置に複数行入力欄とボタンを表示します。
ボタンを押下すると入力欄に入力した内容をページに挿入します。
''プラグイン内設定''
-- INSERT_COLS 編集欄の表示幅
-- INSERT_ROWS 編集欄の表示行数
-- INSERT_INS 入力内容を入力欄の前後どちらに挿入するか
''備考''
ブラウザによっては、複数行入力欄の右下角に入力欄の大きさを変更することができる「つまみ」が表示されます。
「つまみ」が表示されるかどうか?はブラウザによって異なります。
** interwiki [#interwiki]
''種別''
コマンド
''重要度''
★☆☆☆☆
''書式''
''?cmd=interwiki'' &color(blue){&page=InterWiki名};
''概要''
InterWikiを記述した際にPukiWikiが内部的に呼び出します。使用者が意識して使用する機会はありません。
''引数''
InterWiki名にはジャンプ先をInterWiki形式で指定します。InterWiki名はエンコードされている必要があります。
* L [#l_]
** lastmod 指定したページの最終更新日時を表示します。 [#lastmod]
''種別''
インライン型プラグイン
''重要度''
★☆☆☆☆
''書式''
''&lastmod('' [&color(blue){ページ名};] '');''
''概要''
指定したページの最終更新日時を表示します。
''引数''
ページ名には最終更新日時を表示したいページ名を指定します。 省略時は設置したページとみなします。
** links [#links]
''種別''
コマンド
#br
''重要度''
★★☆☆☆(管理者)
#br
''書式''
''?plugin=links''
''概要''
ページ間のキャッシュを更新します。通常使用する必要はありません。
#br
メンテナンス作業などでページが記録されているファイルを直接操作した場合にキャッシュとページの記述内容の整合性がとれなくなるため、実行する必要があります。
#br
''備考''
実行の際に管理者パスワードを要求されます。
//---
** list ページの一覧を表示します。 [#list]
''種別''
コマンド
''重要度''
★★★★☆
''書式''
''?cmd=list''
''概要''
ページの一覧を表示します。
//---
** lookup [#lookup]
''種別''
(コマンド)
#br
ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''#lookup('' &color(blue){interwikiname}; [,&color(blue){ボタン名}; [,&color(blue){入力欄の初期値};]] '')''
''概要''
記述した位置にテキスト入力欄とボタンを表示します。任意の文字列を入力してボタンを押すと、interwikinameと入力値から生成したURLへ移動します。これによって、検索エンジンにクエリを送信したり、番号をタイプするだけで該当するアーカイブにアクセスすることなどが可能になります。
#br
URLの生成にはInterWikiを利用します。このプラグインが生成するURLは、以下のようなInterWikiと同じです。InterWikiNameのページに、あらかじめURLの生成に使用するInterWikiNameを設定しておく必要があります。
#br
[[interwikiname:入力欄の値]]
入力欄が空欄(空文字列)のときは、ボタンを押しても動作しません。必ず何らかの文字列を入力する必要があります。
#br
''引数''
interwikiname: InterWikiNameに設定した値の一つを指定します。
#br
ボタン名: ボタンに表示するキャプションを指定します。省略時は'lookup'です。
#br
入力欄の初期値: 初期値を指定したい場合に記入します。省略時は空文字列になります。
#br
''プラグイン内設定''
#br
-- PLUGIN_LOOKUP_USAGE 引数未指定時に表示されるヘルプ
//---
** ls 記述したページより階層化されているページのページ名を一覧表示します。 [#ls]
''種別''
ブロック型プラグイン
''重要度''
★★☆☆☆
''書式''
''#ls('' [&color(blue){title};] '')''
''概要''
記述したページより階層化されているページのページ名を一覧表示します。
''引数''
titleを指定した場合、ページ名に加えてタイトルを表示します。タイトルは各ページの一行目の内容を表示します。省略時はタイトルを表示しません。
''備考''
実際には、より高機能なls2を使用する機会が多いと思われます。
//---
** ls2 指定したパターンで始まるページ名を一覧表示します。 [#c614720e]
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★★★☆☆
''書式''
''#ls2('' [[&color(blue){パターン};] [, { [&color(blue){title};], [&color(blue){include};], [&color(blue){reverse};], [&color(blue){compact};], [&color(blue){link};] } [,&color(blue){linkの別名表示};] ]] '')''
''概要''
指定したパターンで始まるページ名を一覧表示します。
''引数''
パターンには表示するページ名の共通部分を指定します。省略時は"設置したページ名/"となります。
title,include,reverse,compact,link で表示方法を指定します。
-- title - ページに含まれる見出し(*,**,***)の一覧を併記します。
-- include - 下位層のページが#includeを使用していた場合、includeしているページの一覧を表示します。
-- reverse - ページの並び順を反転し、名前の降順に表示します。省略すると名前の昇順に表示されます。
-- compact - 見出しレベルを調整します。
-- link - #ls2を書いた位置に一覧を表示する代わりにリンクを表示します。このリンクを選択すると別画面にページの一覧を表示するようにします。
&br;
linkの別名表示には、パラメータlinkを指定した際に表示される文字列の代わりの文字列を指定します。省略時は '' '...'で始まるページの一覧''となります。
''プラグイン内設定''
-- PLUGIN_LS2_ANCHOR_PREFIX 見出しアンカーの書式
-- PLUGIN_LS2_ANCHOR_ORIGIN 見出しアンカーの開始番号
-- PLUGIN_LS2_LIST_COMPACT compactオプション省略時、見出しレベルを調整するか
''備考''
ls プラグインとの違いについて。
-- 階層化されたページの起点となるページが、lsでは記述したページ固定だが、ls2ではパラメータで指定できます。
-- titleパラメータを指定した場合に、lsでは「ページの一行目」が表示されるが、ls2では「見出しの一覧」を表示します。
-- include, link という表示オプションが追加されています。
-- ページ名のソートには[[natcasesort()>http://www.php.net/manual/ja/function.natcasesort.php]]を使っているため、昇順の場合、半角英数字よりも漢字の方が先に表示されます。
#hr
//---
* M [#m_]
** marquee 流れる文字を表示します。表示するブラウザによっては正しく表示されないことがあります。 [#b063c45a]
http://wikiwiki.jp/sample/?%CE%AE%A4%EC%A4%EB%CA%B8%BB%FA
|650|c
| ''Contents''|
|#contents|
*マニュアル [#zce17f93]
#marquee(文字列,behavior,loop,背景色,文字色,文字サイズ);
marqueeを表示します。表示するブラウザによっては正しく表示されないことがあります。
*使用例 [#ce5f5be4]
【書式】
#marquee(スクロール表示);
【表示】
#marquee(スクロール表示);
【書式】
#marquee(端にぶつかると停止(slide),slide);
【表示】
#marquee(端にぶつかると停止(slide),slide);
【書式】
#marquee(端から端までを往復(alternate),alternate);
【表示】
#marquee(端から端までを往復(alternate),alternate);
【書式】
#marquee(ループ5回,,5);
【表示】
#marquee(ループ5回,,5);
【書式】
#marquee(ループ5回+文字色変更,,5,,red);
【表示】
#marquee(ループ5回+文字色変更,,5,,red);
【書式】
#marquee(ループ5回+背景色変更,,5,pink);
【表示】
#marquee(ループ5回+背景色変更,,5,pink);
【書式】
#marquee(文字サイズ20px,,,black,#aaffaa,20);
【表示】
#marquee(文字サイズ20px,,,black,#aaffaa,20);
*関連リンク [#ie87edaa]
-[[自作プラグイン/marquee.inc.php - PukiWiki-official>pukiwiki-official:自作プラグイン/marquee.inc.php]]
-[[自作プラグイン/marquee.inc.php - teanan.homeip.net:http://teanan.homeip.net/pukiwiki/?%BC%AB%BA%EE%A5%D7%A5%E9%A5%B0%A5%A4%A5%F3%2Fmarquee.inc.php]]
** map サイトマップの様にページ間のリンク関係を一覧表示します。 [#map]
''種別''
コマンド
''重要度''
★☆☆☆☆
''書式''
''?plugin=map'' [&color(blue){&refer=ページ名};] [&color(blue){&reverse=true};]
''概要''
サイトマップの様にページ間のリンク関係を一覧表示します。
指定したページを起点に、リンクで辿れるページを全てツリー状に表示します。
''引数''
引数には一覧表示方法のオプションを指定します。
-- &refer=ページ名 - 起点となるページを指定します。省略すると、サイトのトップページ(通常はFrontPage)が起点となります。
-- &reverse=true - どこへリンクしているかではなく、どこからリンクされているかを一覧表示します。 どこからもリンクされていないページは、画面の後半にまとめて表示されます。
''プラグイン内設定''
-- PLUGIN_MAP_SHOW_HIDDEN 表示対象外のページをリストアップするかどうか
** md5 [#md5]
''種別''
コマンド
#br
''重要度''
★☆☆☆☆
#br
''書式''
''?plugin=md5'' &color(blue){&md5=文字列};
#br
''概要''
選択したパスワードの形式に応じて、pukiwiki.ini.php に保存する パスワード用文字列を出力します。
#br
パスワードのフォーマットは以下の8種類の中から選択できます。 DESあるいはMD5アルゴリズムを利用したPHP crypt() および LDAP crypt ((crypt()関数の出力はシステムに依存するため、移植性が高くありません))、 MD5 アルゴリズムを利用したPHP md5()、LDAP MD5、およびLDAP SMD5(シードあり)、 SHA-1 アルゴリズムを利用したPHP sha()、LDAP SHA、および LDAP SSHA(シードあり)
#br
''備考''
PukiWiki内で利用するパスワードは、パスワード文字列そのものの代わりに、 実際のパスワードから導出された文字列(セキュリティハッシュ)を保存することが可能です。
これは悪意ある者にpukiwiki.ini.phpの中身を覗き見られた場合に、 パスワードが安易に漏洩しない事を目的としたものです。
#br
SHA-1 アルゴリズムを利用するためには、PHP 4.3.0 以降を使用するか mhash エクステンションを導入する必要があります。
#br
プラグイン名に反してMD5以外のパスワードフォーマットも選択可能です。 これは従来、パスワードから導出したMD5ハッシュ値を利用していた経緯によるものです。
#br
md5のプラグインを呼び出すURLの中にパスワードを含める利用方法は互換性のため残っていますが、推奨されません。
#br
このプラグインは PKWK_SAFE_MODE ないし PKWK_READONLY の設定で無効化されます。
//---
** memo 記述した位置に複数行入力欄とボタンを表示します。 [#memo]
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
''#memo''
''概要''
記述した位置に複数行入力欄とボタンを表示します。
ボタンを押下すると入力欄の記述内容を更新します。
''プラグイン内設定''
-- MEMO_COLS 編集欄の表示桁数
-- MEMO_ROWS 編集欄の表示行数
''備考''
[[insert>未分類プラグイン#insert]]プラグインや[[article>未分類プラグイン#article]]プラグインと似ていますが、入力した内容が入力欄の外へ出力されず、入力欄に留まる点が異なります。
個人用のメモ代わりにPukiWikiを利用している場合、未整理の情報を一時的に溜め込むのに便利です。
#br
ブラウザによっては、複数行入力欄の右下角に入力欄の大きさを変更することができる「つまみ」が表示されます。
「つまみ」が表示されるかどうか?はブラウザによって異なります。
** menu 任意のページでブロック型プラグインとして使用すると、引数に指定したページをメニュー用ページに指定できます。 [#menu]
''種別''
ブロック型プラグイン
''重要度''
★★★★☆
''書式''
''#menu('' &color(blue){ページ名}; '')''
''概要''
デフォルトのスキンにて、ページの左側にメニュー用のページ(MenuBar)を表示するために内部的に使用されています。
#br
任意のページでブロック型プラグインとして使用すると、引数に指定したページをメニュー用ページに指定できます。
例えば通常はMenuBarを表示するサイトで、hogeというページだけはMenuBarの代わりにhogeMenuというページを表示したい場合、
hogeというページに #menu(hogeMenu) と記述する事で実現できます。
#br
ソース中のMENU_ENABLE_SUBMENU をTRUEとすると、表示中のページの上位階層のMenuBarか、同階層にあるMenuBarページを
メニューとして表示するようになります。
例えば FrontPage, MenuBar, hoge, fuga, hoge/MenuBar, hoge/hoge というページが存在する場合は、
FrontPage、fuga、MenuBar では MenuBar がメニューとして表示され、hoge, hoge/MenuBar, hoge/hogeでは
hoge/MenuBar がメニューとして表示されます。
''引数''
メニュー用ページとして表示するページ名を指定します。
''プラグイン内設定''
-- MENU_ENABLE_SUBMENU サブメニューを使用するか
-- MENU_SUBMENUBAR サブメニューを使用する場合にメニューとして呼び出されるページ名。デフォルトは MenuBar。
''備考''
デフォルトのメニュー用ページをMenuBar以外のページとする場合は、pukiwiki.ini.php の $menubar を変更して下さい。
#hr
* N [#n_]
** navi DocBook風ナビゲーションバーを表示します。 [#navi]
''種別''
ブロック型プラグイン
''重要度''
★★☆☆☆
''書式''
''#navi('' [&color(blue){目次ページ};] '')''
''概要''
DocBook風ナビゲーションバーを表示します。
目次となるページに下階層のページが存在する時、それら全てのページ(の先頭と末尾)に記述する事で Prev, Home, Next というリンクを表示します。これによって下階層のページを順に参照するのに便利になります。
''引数''
目次ページに順番に見て回るページの上階層にあたるページを指定します。
例えば hoge, hoge/1, hoge/2, hoge/3 というページが存在する場合、hoge/2に#navi(hoge)を記述するとhogeに移動するHomeというリンク、hoge/1に移動するPrevというリンク、hoge/3に移動するNextというリンクを表示します。
ページで最初に呼び出した場合はヘッダイメージのリンクを出力します。ページで2度目以降に呼び出された場合はフッタイメージのリンクを出力します。現在のページが目次ページである場合は対象となるページの一覧を表示します。
''プラグイン内設定''
-- PLUGIN_NAVI_EXCLUSIVE_REGEX 除外するページを正規表現で指定する
-- PLUGIN_NAVI_LINK_TAGS <link>タグを出力するかどうか
** new 指定した日時が最近であった場合、最近更新された事を強調表示します。 [#nf4072c4]
''種別''
インライン型プラグイン
''重要度''
★★☆☆☆
''書式''
#br
''書式'''1:'''''
''&new('' [&color(blue){nodate};] ''){'' &color(blue){日付文字列}; ''};''
#br
''書式'''2:'''''
''&new('' [&color(blue){ページ名};] [,&color(blue){nolink};] '');''
''概要''
指定した日時が最近であった場合、最近更新された事を強調表示します。日時の指定は直接日付時刻を記述する方法(書式1)と、指定したページ(群)の最終更新日時を採用する方法(書式2)の2通りがあります。
標準では5日以内の場合に New を、1日以内の場合に New! を表示します。期間や表示する文字列のパターンは設置者によってカスタマイズ可能です。
''引数''
''書式'''1:'''''
日付文字列を指定した場合、その日時が規定の期間内であった場合に強調表示します。省略した場合はページの更新日時をチェックする記述であると見なされます。
-- nodate - 日付文字列を表示しません。省略時は表示します。
#br
''書式'''2:'''''
ページ名を指定した場合は、そのページの更新日時が規定の期間内であった場合に強調表示します。省略した場合は、プラグインを記述したそのページを指定したと見なします。
ページ名末尾が/であった場合、そのページ名で始まるページ群の中で最後の更新日時が規定の日付以内であった場合に強調表示します。
-- nolink - ページ名を表示しません。省略時はページ名(ページ群で指定した場合は最後に更新されたページ名)を表示します。
''プラグイン内設定''
-- PLUGIN_NEW_DATE_FORMAT 表示フォーマット
''備考''
日付文字列は[[PHP関数:strtotime>http://jp2.php.net/manual/ja/function.strtotime.php]]が認識できる書式である必要があります。
** newpage ページを新規作成するか、新規作成するページ名の入力欄を表示します。 [#h98605cc]
''種別''
コマンド
ブロック型プラグイン
''重要度''
★★★★★
''書式''
''?plugin=newpage'' &color(blue){&page=ページ名}; &color(blue){&refer=関連ページ名};
''#newpage('' [&color(blue){ページ名初期値};] '')''
''概要''
ページを新規作成するか、新規作成するページ名の入力欄を表示します。
''引数''
コマンド''':'''
パラメータには新規作成するページのオプションを指定します。
#br
ページ名には新規作成するページ名を指定します。省略時は新規作成するページ名の入力するためのページを表示します。ページ名はエンコードされている必要があります。
#br
関連ページ名にはリンク元のページ名を指定します。新規作成するページの先頭に、ここで指定したページへのリンクが自動的に埋め込まれます。ページ名はエンコードされている必要があります。
#br
ブロック型プラグイン''':'''
#br
ページ名初期値には新規作成するページ名を入力する入力欄に初期表示する文字列を指定します。
** norelated ページ下部に表示される関連ページのリンクを非表示にします。 [#q4ad2049]
''種別''
ブロック型プラグイン
''重要度''
★★★☆☆
''書式''
''#norelated''
''概要''
ページ下部に表示される関連ページのリンクを非表示にします。
''備考''
極端に多くのページからリンクされていて関連リンクの表示が目障りである場合などに利用します。
#hr
//---
* O [#o_]
** online 現在PukiWikiを参照している、おおよそのユーザー数を表示します。 [#online]
''種別''
ブロック型プラグイン
インライン型プラグイン
''重要度''
★★☆☆☆
''書式''
''#online''
''&online;''
''概要''
現在PukiWikiを参照している、おおよそのユーザー数を表示します。
ユーザー数は、プラグインを呼び出された時点で記録されたIPアドレスとタイムスタンプのうち、5分以内(変更可能)にアクセスのあったアドレスの数です。
''プラグイン内設定''
-- PLUGIN_ONLINE_TIMEOUT タイムアウトの秒数
-- PLUGIN_ONLINE_USER_LIST ユーザー情報を保存するファイル
-- PLUGIN_ONLINE_LIST_REGEX ユーザー情報取得用の正規表現
''備考''
ユーザー数のカウントはページ単位でなく、設置されたPukiWiki毎に行っているため、MenuBarなど頻繁に呼び出される場所に記述するかスキンに埋め込むのが普通です。
* P [#p_]
** paint Javaアプレットで描いた絵を、そのページに添付します。※swikiでは動作しません。 [#paint]
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
''#paint('' [&color(blue){幅};] [,&color(blue){高さ};] '')''
''概要''
Javaアプレットで描いた絵を、そのページに添付します。
[[ば科学的愛情>http://www.geocities.co.jp/SiliconValley-SanJose/8609/]]で配布されている[[BBSPainter.jar>http://www.geocities.co.jp/SiliconValley-SanJose/8609/java/bbspainter/]]を使用しています。
幅と高さに、デフォルトのキャンバスサイズを指定します。省略時は(80,60)となります(変更可能)
''プラグイン内設定''
-- PAINT_INSERT_INS 入力内容を先頭/末尾のどちらに挿入するか
-- PAINT_DEFAULT_WIDTH デフォルトの描画領域の幅
-- PAINT_DEFAULT_HEIGHT デフォルトの描画領域の高さ
-- PAINT_MAX_WIDTH 描画領域の幅の上限
-- PAINT_MAX_HEIGHT 描画領域の高さの上限
-- PAINT_APPLET_WIDTH アプレット領域の幅
-- PAINT_APPLET_HEIGHT アプレット領域の高さ
-- PAINT_NAME_FORMAT 名前欄の挿入フォーマット
-- PAINT_MSG_FORMAT コメント欄の挿入フォーマット
-- PAINT_NOW_FORMAT 時刻欄の挿入フォーマット
-- PAINT_FORMAT コメント内容全体の挿入フォーマット(メッセージあり)
-- PAINT_FORMAT_NOMSG コメント内容全体の挿入フォーマット(メッセージなし)
''備考''
PukiWikiのインストールディレクトリに上記BBSPainter.jarを入れるのを忘れないでください。このプラグインが何の役にも立たなくなります。
//---
** pcomment 別のページにコメントを記録することができるcommentプラグインです。 [#pcomment]
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★★★☆☆
''書式''
''#pcomment(''{ [&color(blue){コメント記録ページ};], [&color(blue){表示件数};], [&color(blue){noname};], [&color(blue){nodate};], [&color(blue){above};], [&color(blue){below};], [&color(blue){reply};] }'')''
''概要''
別のページにコメントを記録することができるcommentプラグインです。設置した場所には最新のコメントだけを表示することができます。
ラジオボタンを表示し、指定した部分にコメントを付けることもできます。
''引数''
コメント記録ページ にはコメントを記録するページ名を指定します。省略すると、pcommentプラグイン内の
PLUGIN_PCOMMENT_PAGE で指定されたページにコメントが記録されます。デフォルトは [コメント/(設置したページ名)] です。
指定したページが存在しなくても、最初にコメントを追加した時に作成します。
#br
表示件数 は表示する最新コメントの数を指定します。第1レベルの番号なしリストだけをカウントします。省略すると、
pcommentのデフォルト件数(通常10件。 PLUGIN_PCOMMENT_NUM_COMMENTS で変更可能)が表示されます。
表示件数は コメント記録ページ より後に指定して下さい。コメント記録ページを省略して 表示件数 を指定する場合は、
コメント記録ページ に空白を指定します。(例: #pcomment(,15))
#br
noname,nodate,above,below,reply でコメントの表示方法、入力方法を指定します。
-- noname - 名前の入力欄を表示しません。
-- nodate - 日付を挿入しません。
-- above - 挿入したコメントをフォームの上に表示します。コメントは上が古く、下に向かって新しい順に並びます。
-- below - 挿入したコメントをフォームの下に表示します。コメントは下が古く、上に向かって新しい順に並びます。
-- reply - コメントの頭にラジオボタンを表示します。あるコメントに対するリプライが、そのコメントのラジオボタンをチェックすることで可能になります。
&br;
''プラグイン内設定''
&br;
-- PLUGIN_PCOMMENT_PAGE ページ名のデフォルト(%sに$vars['page']が入る)
-- PLUGIN_PCOMMENT_NUM_COMMENTS 表示する(最新の)コメント数のデフォルト
-- PLUGIN_PCOMMENT_SIZE_NAME 名前欄の表示桁数
-- PLUGIN_PCOMMENT_SIZE_MSG コメント欄の表示桁数
-- PLUGIN_PCOMMENT_DIRECTION_DEFAULT 入力内容を先頭/末尾のどちらに挿入するか
-- PLUGIN_PCOMMENT_FORMAT_NAME 名前欄の挿入フォーマット
-- PLUGIN_PCOMMENT_FORMAT_MSG コメント欄の挿入フォーマット
-- PLUGIN_PCOMMENT_FORMAT_NOW 時刻欄の挿入フォーマット
-- PLUGIN_PCOMMENT_FORMAT_STRING コメント内容全体の挿入フォーマット
-- PLUGIN_PCOMMENT_AUTO_LOG 自動過去ログ化を行う際の1ページあたりの件数(0で無効)
-- PLUGIN_PCOMMENT_TIMESTAMP コメントページのタイムスタンプを更新せず、設置ページのタイムスタンプを更新するか
&br;
''備考''
更新が衝突したときは、予期せぬ場所にコメントが挿入されるのを防ぐため、リプライ先を指定して記入したコメントは
aboveまたはbelowの設定にしたがって 一番前か一番後ろに追加されます。
#br
コメント記入後に表示されるページのタイトルに「(#pcommentを書いたページ)を更新しました」と表示されますが、
実際に更新されたのはコメントを記録するページです。
#br
コメントを投稿しても、#pcommentが書かれたページは更新されないので、最終更新ページにはコメントを
記録したページだけが更新として表示されます。
#br
コメントとして相対参照([ [../] ]など)を用いた場合は、書いたページと書き込まれたページのどちらかで、
意図したとおりに変換されない可能性があります。
#br
自動過去ログ化機能は PLUGIN_PCOMMENT_AUTO_LOG の件数 + PLUGIN_PCOMMENT_NUM_COMMENTS
の件数分のコメントを投稿した時に作動します。
//---
** popular 人気のある(参照回数の多い)ページの上位数件を表示します。 [#popular]
''種別''
ブロック型プラグイン
''重要度''
★★☆☆☆
''書式''
''#popular('' [[&color(blue){件数};] [,[&color(blue){対象外ページ};] [,&color(blue){true};|&color(blue){false};] ]] '')''
''概要''
人気のある(参照回数の多い)ページの上位数件を表示します。
''引数''
件数には一覧の数を指定して下さい。省略時はPLUGIN_POPULAR_DEFAULTに指定した件数です。
対象外ページには、表示対象外とするページを正規表現で指定します。例えば FrontPage や MenuBar などのページを一覧に表示させたくないときに使用します。
true, falseで、ページのカウント条件を指定します。省略時は false です。
-- true - 今日参照のあった回数順でページを表示します。
-- false - 通算の参照回数順でページを表示します。
&br;
''プラグイン内設定''
#br
-- PLUGIN_POPULAR_DEFAULT 件数未指定時の件数
&br;
''備考''
[[counter>未分類プラグイン#counter]]プラグインのカウンター情報を利用しているので、counterプラグインを設置していないページは
カウントの対象外となります。全てのページにcounterプラグインを設置するのは非効率であるため
counterプラグインをMenubarやスキンに設置するのが一般的です。
#hr
//---
* R [#r_]
** random ランダムなページへのリンクを表示するプラグイン。 [#random]
''種別''
(コマンド)
#br
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆
#br
''書式''
''#random('' [&color(blue){メッセージ};] '')''
#br
''概要''
ランダムなページへのリンクを表示するプラグイン。
#br
表示するページの候補は設置したページの下階層のページです。
#br
''引数''
メッセージにはリンクに表示する文字列を指定します。省略時は '&color(blue){press here.};' となります。
備考
ブラウザの再読み込み対策はしていません。リロードされるたびにランダムな表示を繰り返します。
** read 指定したページを表示します。該当ページが存在しない場合は編集状態で開き... [#read]
''種別''
コマンド
#br
''重要度''
★★★★★
#br
''書式''
''?cmd=read'' &color(blue){&page=ページ名};
#br
''概要''
指定したページを表示します。該当ページが存在しない場合は編集状態で開き、ページ名がInterWikiであった場合は、その解決を行います。
#br
plugin=やcmd=が指定されていない場合に内部で暗黙に呼び出されるため、利用者が意識する機会は少ないです。
#br
''引数''
ページ名には表示したいページ名を指定します。ページ名はエンコードされている必要があります。
** recent 最近更新されたページのうち、最新の数件を表示します。 [#mbd785d0]
''種別''
ブロック型プラグイン
#br
''重要度''
★★★★★
#br
''書式''
''#recent('' [&color(blue){件数};] '')''
''概要''
最近更新されたページのうち、最新の数件を表示します。
#br
''引数''
件数には表示件数を指定します。省略時はプラグイン内設定で指定した値です。
#br
''プラグイン内設定''
#br
-- PLUGIN_RECENT_DEFAULT_LINES 件数未指定時の件数
-- PLUGIN_RECENT_CACHE RecentChangesのキャッシュの場所
-- PLUGIN_RECENT_USAGE 引数未指定時に表示されるヘルプ
** ref '#attach'でページに添付されたファイルを指定位置に展開します。 [#ref]
''種別''
ブロック型プラグイン
インライン型プラグイン
#br
''重要度''
★★★★☆
#br
''書式''
''#ref('' &color(blue){添付ファイル名};| &color(blue){ページ名};/&color(blue){添付ファイル名};| &color(blue){URL}; [,&color(blue){ページ名};] {, [&color(blue){left};|&color(blue){center};|&color(blue){right};], [&color(blue){wrap};|&color(blue){nowrap};], [&color(blue){around};], [&color(blue){noicon};], [&color(blue){noimg};], [&color(blue){nolink};], [&color(blue){zoom};], [&color(blue){999x999};], [&color(blue){999%};] } [,&color(blue){タイトル};] '')''
#br
&ref( &color(blue){添付ファイル名};| &color(blue){ページ名/添付ファイル名};| &color(blue){URL}; [,&color(blue){ページ名};] {, [&color(blue){noicon};], [&color(blue){noimg};], [&color(blue){nolink};], [&color(blue){zoom};], [&color(blue){999x999};], [&color(blue){999%};] } [,&color(blue){タイトル};] '');''
#br
''概要''
'[[#attach>未分類プラグイン#attach]]'でページに添付されたファイルを指定位置に展開します。添付ファイルが画像の場合は画像を表示し、それ以外の場合はダウンロード用のリンクを表示します。
#br
''引数''
添付ファイル名にはページに添付したファイル名を指定します(省略時はエラーとなります)。別ページ名/添付ファイル名とする事で別ページの添付ファイルも指定できます。
#br
ページ名にはファイルを添付したページをWikiNameかBracketNameで指定します。このオプションは最初(添付ファイル名の次)に記述してください。省略時は設置したページです。
#br
パラメータにはファイルの展開方法を指定できます。
#br
-- left|center|right - 表示時の位置を指定します。省略時はleft(変更可)です。
-- wrap|nowrap - テーブルタグで囲む/囲まないの指定を行います。省略時はnowrap(変更可)です。
-- around - テキストの回り込みを可能とします。省略時は回り込みを行いません。
-- noicon - ファイルが画像以外の場合に表示されるアイコンを表示しません。省略時は表示します。
-- noimg - ファイルが画像の場合に画像を展開しないようにします。省略時は展開します。
-- nolink - 元ファイルへのリンクを張らないようにします。省略時はリンクします。
-- zoom - 縦横比を保持します。省略時はサイズ指定に従います。
-- 999x999 - サイズを指定します(幅x高さ)。省略時は拡大率あるいは対象画像のサイズに従います。
-- 999% - サイズを指定(拡大率)します。省略時は100%です、
-- タイトル - 上記以外のパラメータは画像の代替文字列、リンクのタイトル属性として使用されます。ページ名やパラメータに見える文字列を使用するときは、#ref(hoge.png,,zoom)のようにタイトルの前にカンマを余分に入れます。
&br;
''プラグイン内設定''
#br
-- PLUGIN_REF_USAGE 引数未指定時に表示されるヘルプ
-- PLUGIN_REF_IMAGE マッチ時に指定ファイルを画像とみなす正規表現
-- FILE_ICON アイコンイメージのファイル
-- PLUGIN_REF_DEFAULT_ALIGN left,center,right省略時の表示位置
-- PLUGIN_REF_WRAP_TABLE wrap,nowrap省略時にテーブルタグで囲むか
-- PLUGIN_REF_URL_GET_IMAGE_SIZE URL指定時に画像サイズを取得するか
-- PLUGIN_REF_DIRECT_ACCESS 添付ファイルの画像表示で UPLOAD_DIR のデータに直接アクセスするか
&br;
''備考''
aroundで行った回り込み指定を解除するには clearプラグイン、あるいはimgプラグインを使用して下さい。
#br
"ほげ"という別ページの添付ファイル"fuga.jpg"をインラインプラグイン形式で参照する場合、下記2通りの記述方法が存在します。
#br
(1) &ref(ほげ/fuga.jpg);
(2) &ref(fuga.jpg,[[ほげ]]);
上記2通りの記述のうち、(2)の記述方式は旧バージョンと互換性を維持するために用意されたもので、推奨される記述方式は(1)です。
いずれの記述方法であっても一般的な動作は同じですが、いわゆるバナー画像のように表示した画像が別ページへのリンクとなるよう以下の指定をした場合、
(1) [[&ref(ほげ/fuga.jpg,nolink,ウェブ名);>ウェブのURL]]
(2) [[&ref(fuga.jpg,[[ほげ]],nolink,ウェブ名);>ウェブのURL]]
(1)の記述方法は期待通りの動作をしますが、(2)の記述方法ではうまくリンクされません。
また、ほげというページに添付された画像を、そのページ内でパラメータを指定して(例えば半分の比率で)表示する場合、
(3) &ref(./fuga.jpg,50%);
(4) &ref(ほげ/fuga.jpg,50%);
(5) &ref(fuga.jpg,[[ほげ]],50%);
(6) &ref(fuga.jpg,50%);
(3)~(5)は期待通りに同じ結果をしますが、(6)はエラーとなります。 これは(6)の書式が(2)の記述方式であるため、 添付ファイル名fuga.jpgの次の引数にページ名を期待するためです。
(7) &ref(fuga.jpg);
(7)は(6)と似た記述ですが、添付ファイル名の次の引数が省略されているため、エラーにはなりません。
** referer ページを照会した利用者の参照元URL(Referer)の一覧を表示します。 [#referer]
''種別''
コマンド
#br
''重要度''
★★★☆☆
#br
''書式''
''?plugin=referer'' [&color(blue){&page=ページ名};] [&color(blue){&sort= 0d};|&color(blue){0a};| &color(blue){1d};|&color(blue){1a};| &color(blue){2d};|&color(blue){2a};| &color(blue){3}; ]
#br
''概要''
ページを照会した利用者の参照元URL(Referer)の一覧を表示します。
#br
''引数''
ページ名にはRefererを表示するページ名を指定します。ページ名はエンコードされている必要があります。省略時はRefererが記録されているページの一覧を表示します。
#br
sortでReferer一覧のソート順を指定します。
#br
-- 0d - 最終更新日時(新着順)
-- 0a - 最終更新日時(日付順)
-- 1d - 初回登録日時(新着順)
-- 1a - 初回登録日時(日付順)
-- 2d - カウンタ(大きい順)
-- 2a - カウンタ(小さい順)
-- 3 - Referer
&br;
''プラグイン内設定''
#br
-- CONFIG_REFERER 無視するURIを指定したページ
&br;
''備考''
pukiwiki.ini.php で、Refererを使用する設定($referer = 1を指定)が行われている必要があります。
** related 対象のページを参照しているページの一覧を表示します。 [#related]
''種別''
コマンド
#br
擬似ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''?plugin=related'' [&color(blue){&page=ページ名};]
#br
''#related''
''概要''
対象のページを参照しているページの一覧を表示します。
#br
''引数''
ブロック型で実行時、設置したページが対象となります。
#br
コマンドで実行時、ページ名に対象となるページを指定できます。省略した場合、トップページが指定されたとみなします。
** rename 既存ページの名前を変更します。実行には管理者権限が必要です。 [#rename]
''種別''
コマンド
#br
''重要度''
★★★☆☆
#br
''書式''
''?plugin=rename'' [&color(blue){&refer=ページ名};]
''概要''
既存ページの名前を変更します。実行には管理者権限が必要です。
#br
ページの本文のほか、指定されたページ名の差分、バックアップ、添付ファイル、カウンターを一気にリネームします。
#br
''引数''
ページ名には変更するページの名前を指定します。省略時はページ名の選択または正規表現置換用文字列入力画面が表示されます。
#br
実行結果は変換結果のページ(PLUGIN_RENAME_LOGPAGE で指定。標準は :RenameLog)に追記されます。
#br
''プラグイン内設定''
#br
-- PLUGIN_RENAME_LOGPAGE ページ名の変換結果を出力するページ名
''備考''
ページ内のリンクの書き換えは行ないません。yetlistなどを駆使して対処してください。
#br
TrackBackやRefererの情報は更新されません。
#br
リネーム対象のページが凍結されているかどうかはチェックしていません。
#br
関連ページにリネーム対象の文字列が複数含まれているとおかしくなります。
#br
-- たとえば、hogeおよびhoge/hogeという二つのページがあったときに、hogeページをfugaに(関連ページを含んで)リネームすると、hoge/hogeページの名前がfuga/fugaになってしまいます。
** ruby 文字列にルビをふります。 [#ruby]
''種別''
インライン型プラグイン
#br
''重要度''
★☆☆☆☆
#br
''書式''
''&ruby('' &color(blue){ルビ}; ''){'' &color(blue){対象文字列}; ''};''
''概要''
文字列にルビをふります。
#br
''引数''
ルビには表示するルビを指定します。
#br
対象文字列にはルビがふられる文字列を指定します。
#br
''プラグイン内設定''
#br
-- PLUGIN_RUBY_USAGE 引数未指定時に表示されるヘルプ
&br;
''備考''
XHTML 1.1のルビに対応したブラウザでないと、ルビとして表示されません。IE5.5/6では表示できます。Netscape 7/Mozillaでは[[XHTML Ruby Support>http://white.sakura.ne.jp/~piro/xul/_rubysupport.html]]を組み込めば表示できます。
#br
ルビに対応していないブラウザではルビをふる文字列の直後にルビが( )に入れられて表示されます。
#hr
//---
* S [#s_]
** search 検索文字列の入力フォームを表示し、 指定した文字列を含むページの検索を行います。 [#search]
''種別''
コマンド
#br
ブロック型プラグイン
#br
''重要度''
★★★★★
#br
''書式''
''?cmd=search''{ [&color(blue){&word=検索文字列};] [&color(blue){&type=OR};] }
''#search''
#br
''概要''
検索文字列の入力フォームを表示し、 指定した文字列を含むページの検索を行います。
#br
''引数''
パラメータには検索条件を指定します。
#br
-- word - 検索する文字列を指定します。省略時は検索条件を入力するページを表示します。
-- type - 'OR' 指定時、OR検索を行います。省略時はAND検索をおこないます。
&br;
''プラグイン内設定''
&br;
-- PLUGIN_SEARCH_DISABLE_GET_ACCESS GETメソッドによる検索を禁止する(DoS攻撃、SPAMbot、ワーム対策)
-- PLUGIN_SEARCH_MAX_LENGTH 検索する文字列として指定可能な最大文字数 (同)
- ''#search 検索フォーム設置例示''
#search
** setlinebreak 入力文章中の改行を改行とみなすかどうかの設定を行います。 [#setlinebreak]
''種別''
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
''#setlinebreak('' [&color(blue){on};|&color(blue){off};|&color(blue){default};] '')''
''概要''
入力文章中の改行を改行とみなすかどうかの設定を行います。
PukiWikiが入力文章中の改行をどのように扱うかはpukiwiki.ini内の$line_breakの設定内容によって変わります(下記参照)。
|BGCOLOR(#D0D6DF):入力文章|BGCOLOR(#D0D6DF):$line_break=0;|BGCOLOR(#D0D6DF):$line_break=1;|
|BGCOLOR(#EFF4FF):|BGCOLOR(#EFF4FF):|BGCOLOR(#EFF4FF):|c
|文章1&br;文章2|文章1文章2|文章1&br;文章2|
setlinebreakプラグインは該当ページの以降の行に関して、 $line_breakの設定に因らず改行をどのように扱うかを指定できるようになります。
''引数''
パラメータには以降の改行の扱いを指定します。 パラメータが省略された場合、改行とみなすかどうかについての設定を逆転させます。
--on - 以降の文章で段落内の改行を改行とみなします($line_break=1と同様)。
--off - 以降の文章で改行を無視します($line_break=0と同様)。 改行を行うためには行末にチルダを記述するか、 行中で&color(blue){brプラグイン};を使用する必要があります。
--default - 改行の扱いをそのサイトの$line_break設定に戻します。
** size 文字の大きさを指定します。 [#size]
''種別''
インライン型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''&size('' &color(blue){ピクセル数値}; ''){'' &color(blue){文字列}; ''};''
#br
''概要''
文字の大きさを指定します。
#br
''引数''
ピクセル数値には文字の大きさを指定します。
#br
文字列は文字の大きさを変更する文字列を指定します。
#br
''プラグイン内設定''
#br
-- PLUGIN_SIZE_MAX 引数として指定可能な最大文字サイズ
-- PLUGIN_SIZE_MIN 引数として指定可能な最小文字サイズ
-- PLUGIN_SIZE_USAGE 引数未指定時に表示されるヘルプ
** source 指定したページの整形前のソースを表示します。 [#source]
''種別''
コマンド
#br
''重要度''
★☆☆☆☆
#br
''書式''
''?cmd=source'' &color(blue){&page=ページ名};
#br
''概要''
指定したページの整形前のソースを表示します。
#br
''引数''
ページ名にはソースを表示するページ名を指定します。ページ名はエンコードされている必要があります。
#hr
//---
** 横分割 include(splitinclude) それぞれのページ内容を3つまで横に並べて表示するプラグイン。 [#k3b3d4dc]
''#splitinclude(''[&color(blue){ページ名1};],[&color(blue){ページ名2};],[&color(blue){ページ名3};]'')''
と指定することで、それぞれのページ内容を横に並べて表示するプラグイン。
ページ名は,区切りで3つまで指定することができます。
閲覧者にとって読み込み権限のあるページのみ動作します。
#br
ページ名は省略できません。
* T [#t_]
** tb TrackBackの一覧を表示します。 [#mdc27273]
[#tb]
''種別''
コマンド
#br
''重要度''
★☆☆☆☆
#br
''書式''
''?plugin=tb'' &color(blue){&tb_id=TrackBackID &__mode= view};| &color(blue){rss};
#br
''概要''
TrackBackの一覧を表示します。
#br
POSTされた場合は他サイトからのTrackBackに反応します。
#br
''引数''
&tb_idには表示対象ページのTrackBackIDを指定します。
#br
&__modeには一覧表示方法を指定します。
#br
-- view - 人間が見やすい形式で表示します。
-- rss - RSS形式で表示します。
&br;
''プラグイン内設定''
#br
-- PLUGIN_TB_LANGUAGE TrackBackのRSSで出力する言語
-- PLUGIN_TB_ERROR エラー時の返り値
-- PLUGIN_TB_NOERROR エラーなし時の返り値
&br;
''備考''
pukiwiki.ini.php で、TrackBackを使用する設定($trackback = 1を指定)が行われている必要があります。
** template 既存のページをテンプレートとしてページを新規作成します。 [#template]
''種別''
コマンド
#br
''重要度''
★★★★☆
#br
''書式''
''?plugin=template'' &color(blue){&refer=テンプレートページ};
#br
''概要''
既存のページをテンプレートとしてページを新規作成します。
#br
ページの新規作成時の雛形とするページの読込み機能との差異は、テンプレートプラグインが雛形とする範囲(行単位)に選択できるのに対して、ページの新規作成で読み込むテンプレートは全文をテキストエリアにコピーする点にあります。
#br
''引数''
テンプレートページには雛形とするページを指定します。ページ名はエンコードされている必要があります。
#br
''プラグイン内設定''
#br
-- MAX_LEN 雛形の開始/終了位置を指定する欄で表示される最大文字数
#aname(topicpath)
** topicpath パンくずリスト(topicpath)と呼ばれる、ページの階層表現のユーザーインターフェースを提供するプラグイン。 [#t1e3c134]
''種別''
インライン型プラグイン
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
&topicpath;
#topicpath
''概要''
パンくずリスト(topicpath)と呼ばれる、ページの階層表現のユーザーインターフェースを提供するプラグイン。
パンくずリスト(Topic path)は現在参照しているウェブページの階層を表現するユーザーインターフェースです。例えば&color(blue){PukiWiki/ツアー};というページに#topicpathと書くと、以下の様な表記に置き換わります。
[[Top>FrontPage]]/[[PukiWiki>PukiWiki]]/[[ツアー>PukiWiki/ツアー]]
基本的には以下の2通りの使い方を想定しています。
i.「ほげ/ふが/げほ」など、2~3階層以上の深いページでページの行き来をしやすくするために表示する
ii.スキンに組み込み、ページタイトル下のURLの代わりに全てのページで表示する
''プラグイン内設定''
-- PLUGIN_TOPICPATH_TOP_DISPLAY defaultpageを一番最初に表示するかどうか。
-- PLUGIN_TOPICPATH_TOP_LABEL $defaultpageに対するラベル
-- PLUGIN_TOPICPATH_TOP_SEPARATOR 階層を区切るセパレータ
-- PLUGIN_TOPICPATH_THIS_PAGE_DISPLAY 現在表示中のページに対するリンクを表示するかどうか
-- PLUGIN_TOPICPATH_THIS_PAGE_LINK 現在表示中のページに対してリンクするかどうか
''備考''
スキンに組み込む場合は、pukiwiki.skin.php の SKIN_DEFAULT_DISABLE_TOPICPATH に 0を指定して下さい。
** ツールチップ(tooltip) マウスをあわせるとツールチップを表示します。 [#tooltip]
&tooltip(単語){説明文};
と入力することでマウスをあわせるとツールチップを表示します。
利用例)
Mercurialは分散型&tooltip(SCM){Source Code Management; バージョン管理システム};のひとつです。
と入力すると
Mercurialは分散型&tooltip(SCM){Source Code Management; バージョン管理システム};のひとつです。
と表示します。
** touchgraph TouchGraphWikiBrowser用のインデックスを作ります。 [#touchgraph]
''種別''
コマンド
#br
''重要度''
★☆☆☆☆
#br
''書式''
''?plugin=touchgraph''
''概要''
TouchGraphWikiBrowser用のインデックスを作ります。
** tracker [#tracker]
''種別''
(コマンド)
#br
ブロック型プラグイン
#br
''重要度''
★★★★☆
#br
''書式''
''#tracker('' [&color(blue){定義名};] [,&color(blue){ベースページ名};] '')''
#br
''概要''
[[bugtrack>未分類プラグイン#bugtrack]]プラグインのように、定型的な項目をもったページを作るための入力フォームを表示します。
#br
入力項目が固定されている[[bugtrack>未分類プラグイン#bugtrack]]プラグインと機能は似ていますが、入力項目を簡単に変更できる点が違います。
FAQ,BBS,書評,TODOリストなど使い道はアイディア次第です。
#br
入力項目の定義は:config/plugin/tracker/ 以下に所定の書式でテンプレートを作成することで設定できます。
[[bugtrack>未分類プラグイン#bugtrack]]プラグイン互換の入力項目テンプレートが :config/plugin/tracker/default に用意されているので参考にして下さい。
#br
''引数''
定義名は #tracker(hoge) のようにtrackerのテンプレート名を指定します。省略時は :config/plugin/tracker/default が指定されたとみなします。
#br
テンプレート名に続けてフォーム名 / リスト名を指定することができます。
ひとつのテンプレートに複数のフォーム形式 / リストフォーマットを用意したいときに便利です。
例えば、#tracker(hoge/form_alternative) とすれば
:config/plugin/tracker/hoge/form_alternative の内容をフォーム表示に使用しますし、
#tracker_list(hoge/list_alternative) とすれば :config/plugin/tracker/hoge/list_alternative の内容をレイアウトに使用します。
#br
ベースページ名はフォームから作成されるページの親階層となるページ名を指定します。省略時は設置したページとなります。
#br
''プラグイン内設定''
#br
-- TRACKER_LIST_EXCLUDE_PATTERN tracker_listで表示しないページ名を正規表現で指定する
-- TRACKER_LIST_SHOW_ERROR_PAGE 項目の取り出しに失敗したページを一覧に表示するか
&br;
''テンプレート''
#br
テンプレートは基本的に設置するtracker毎に1組(4ページ)作成します。
#br
-- :config/plugin/tracker/hoge
hogeテンプレートの項目の内容を記述します。
&br;
-- :config/plugin/tracker/hoge/form
入力フォームの項目とレイアウトを記述します。
&br;
-- :config/plugin/tracker/default/page
入力した内容をページ化する際のフォーマットを記述します。
&br;
-- :config/plugin/tracker/hoge/list
tracker_listで表示するリストのレイアウトを記述します。テーブル(|~|)の書式指定(c) / ヘッダ(h) / フッタ(f) 行は特別扱いします。
&br;
''予約項目''
#br
-- form で使用できる予約項目
--- [_name] : 記事を記録するページ名を入力するフィールドを表示。省略可。
--- [_submit] : [追加]ボタンを表示。
-- page / list で使用できる予約項目
--- [_date] : 投稿日時。
--- [_page] : 実際に生成したページ名。ブラケットが付く。
--- [_refer] : #trackerを置いたページ。
--- [_base] : ページのプレフィクス。 tracker()/tracker_list() の第2引数が省略された場合は [_refer] と同じ内容。
--- [_name] : formの [_name] の内容そのもの。記事を記録するページ名の一部として使用する。
--- [_real] : 実際に生成したページ名から、[_refer] + '/'を除いた名前。デフォルトは [_name] と同じ内容。以下のいずれかの条件に該当するときは、[[tracker>未分類プラグイン#tracker]]プラグインが[_real]に連番を付与し、記事を記録するページ名を決定する。
・formに [_name] フィールドがない。
・[_name] が空か、ページ名として無効な文字を含む。
・[_refer] / [_name] という名前のページがすでに存在する。
-- list で使用できる予約項目
--- [_update] : ページの最終更新日時。
--- [_past] : 最終更新日時からの経過。
** tracker_list [#tracker_list]
''種別''
(コマンド)
#br
ブロック型プラグイン
#br
''重要度''
★★★★☆
#br
''書式''
''#tracker_list('' [&color(blue){定義名};] [,[&color(blue){ベースページ名};] [,[[&color(blue){ソート項目};] :[&color(blue){ソート順};]] [,&color(blue){表示上限};] ]]] '')''
#br
''概要''
[[tracker>未分類プラグイン#tracker]]プラグインで作成したページを一覧表示します。
#br
''引数''
定義名は[[tracker>未分類プラグイン#tracker]]プラグインで指定したテンプレート名と同じものを指定します。
省略時は :config/plugin/tracker/default が指定されたとみなします。
#br
ベースページ名は[[tracker>未分類プラグイン#tracker]]プラグインで指定したベースページ名と同じものを指定します。
[[tracker>未分類プラグイン#tracker]]プラグインでベースページ名を指定していない場合は[[tracker>未分類プラグイン#tracker]]プラグインを設置したページを指定します。
省略時は設置したページとなります。
#br
第3項目には一覧表示のソートに使う項目およびソート順を指定します。ソート項目は :config/plugin/tracker/テンプレート名 のfield項目内の項目から選択して下さい。省略時はページ名となります。ソート順は、ASC((昇順固定))、DESC((降順固定))、SORT_ASC((昇順(閲覧者が変更可) ))、SORT_DESC((降順(閲覧者が変更可) )) をコロン(:)の後に指定してください。また、セミコロン(;)で区切ることにより、複数のソート項目、ソート順を指定可能です。例えば、#tracker_list(,,state:SORT_ASC;priority:SORT_ASC;_real:SORT_DESC) と指定した場合は、項目ごとに (1) [state]を昇順 -> (2) [priority]を昇順 -> (3) [_real](実際のページ名)を降順、の優先順位でソートします。
#br
表示上限は一覧表示するページ数の上限を指定します。省略時は全て表示されます。
#hr
//---
* V [#v_]
** vote 選択肢と投票数と投票ボタンが並んだ簡易投票フォームを表示します。 [#vote]
''種別''
コマンド
#br
ブロック型プラグイン
#br
''重要度''
★★☆☆☆
#br
''書式''
''#vote('' &color(blue){選択肢1};[&color(blue){選択肢1の投票数};] [,&color(blue){選択肢2};[&color(blue){選択肢2の投票数};] [,&color(blue){選択肢3};[&color(blue){選択肢3の投票数};]… [,&color(blue){選択肢n};[&color(blue){選択肢nの投票数};]]] '')''
''概要''
選択肢と投票数と投票ボタンが並んだ簡易投票フォームを表示します。
#br
''引数''
選択肢1~nに投票項目を指定します。投票項目に続けて半角大括弧"[]"で括った数値を指定すると選択肢の投票数を指定できます。
#br
''備考''
''各選択肢の投票数''は編集によって容易に改竄できるため、厳密な投票には向きません。
#br
※ページを凍結していても動作可能です。凍結した場合には''各選択肢の投票数''の編集は不可能になります。
#br
''使用例''
#vote( 選択肢1[選択肢1の投票数] [[0],選択肢2[選択肢2の投票数] [[1],選択肢3[選択肢3の投票数]… [[0],選択肢n[選択肢nの投票数]]] [1])
#vote( 選択肢1[選択肢1の投票数] [[1],選択肢2[選択肢2の投票数] [[1],選択肢3[選択肢3の投票数]… [[0],選択肢n[選択肢nの投票数]]] [1])
#hr
//---
* Y [#y_]
** yetlist まだ作られていないページを一覧表示します。 [#yetlist]
''種別''
コマンド
#br
''重要度''
★★☆☆☆
#br
''書式''
''?plugin=yetlist''
''概要''
まだ作られていないページを一覧表示します。
#br
まだ作られていないページとは、既存のページでWikiNameあるいはBracketNameで指定されていて、まだ作られていないページです。
#br
''備考''
自分以外の誰かがページを書くかもしれないという点は非常にWiki的ですが、実際の運用面ではcommentに記述された一見さんの名前やWikiName同様のパラメータ名など、ページ化しにくいキーワードが大量に引っかかってしまいます。
|