![[PukiWiki]](http://momochi.orz.ne.jp/image/momochi.gif "[PukiWiki]")
おしながき*
http://calorism5.blog.fc2.com/ |
* プラグインマニュアル [#v0ed77c7]
#contents
#hr
** プラグインマニュアルの凡例 [#vf3c6f93]
プラグインマニュアルは以下の形式で記述されています。
''プラグイン名''
:種別|
~プラグインがどのような方法で呼び出しを行えるかを示します。複数の呼び出し方法をもつプラグインも存在します。
--コマンド − コマンド形式の呼び出しが可能であることを示します。内部的に呼び出されるため、説明を省いている場合はカッコで括られています。
--ブロック型プラグイン − ブロック型プラグインでの呼び出しが可能である事を示します。
--インライン型プラグイン − インライン型プラグインでの呼び出しが可能である事を示します。
--擬似ブロック型プラグイン − PukiWiki本体で実現されている機能であることを示します。記述方式がブロック型プラグインと同じであるため、便宜上プラグインのマニュアルに含めています。
:重要度|
~そのプラグインの一般的な利用頻度や有用性の目安を示します。さほど重要でない場合は ★☆☆☆☆ が、重要なプラグインの場合は ★★★★★ です。
:書式|
~プラグインでの引数指定方法です。引数の指定方法の表現のため、下記の記述書式を使っています。
--[] − 省略可能で必要に応じて記述する箇所です。
--| − |で区切られた複数の項目のうち、指定できるのは１つである事を示します。
--{} − 中カッコ内のみ引数の指定順序が任意である事を示します。
:概要|
~そのプラグインの機能概要です。
:引数|
~引数の詳細な説明です。
:プラグイン内設定|
~プラグインのソース中で定義されている定数の一覧です。引数で変更できない詳細なカスタマイズが可能となります。
:備考|
~プラグインに関する参考情報です。
----
* A [#w8de4799]
** add [#nc6c46d0]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
?cmd=add&page=ページ名
:概要|
~既存のページに編集した内容を追加する。実行すると編集画面になる。
~ページ名は省略できない。ページ名はエンコードされていなければならない。
:言語ファイル設定|
--$_title_add
--$_msg_add
:備考|
~もともとデフォルトのskinでメニューの「追加」として使われていたが、editコマンドで事足りるため、現在のデフォルトのskinではメニューから外されている。
**aname [#a432835b]
:種別|
~インライン型プラグイン
:重要度|
~★★★☆☆
:書式|
&aname(アンカー名);
#aname(アンカー名)
:概要|
~指定した位置にアンカー(リンクの飛び先)を設定する。
~ブロック型プラグインとしても使用できる。
~アンカー名は省略できない。
:備考|
~通常はインライン型プラグインとして使用する。
~2つのブロック型プラグインに挟まれた部分にアンカー設定したい場合にインラインとしては記述できないため、ブロック型プラグインとしても使えるようにしてある。例外的措置。
~なお、1.3.5まではブロック型プラグインだったが、1.4からインライン型プラグインになった。
**article [#qc2a52a0]
:種別|
~ブロック型プラグイン
:重要度|
~★★★☆☆
:書式|
#article
:概要|
~指定した位置に簡易掲示板を設置する。
:言語ファイル設定|
--$_btn_name
--$_btn_article
--$_btn_subject
--$_title_collided
--$_msg_collided
--$_title_updated
:プラグイン内設定|
--article_COLS
--article_ROWS
--NAME_COLS
--SUBJECT_COLS
--NAME_FORMAT
--NO_NAME
--SUBJECT_FORMAT
--NO_SUBJECT
--ARTICLE_INS
--ARTICLE_COMMENT
--ARTICLE_AUTO_BR
--MAIL_AUTO_SEND
--MAIL_FROM
--MAIL_SUBJECT_PREFIX
--$_mailto
**attach [#k586d232]
:種別|
~ブロック型プラグイン
:重要度|
~★★★★★
:書式|
#attach
:概要|
~指定した位置にファイル添付のための入力フォームを設置する。
~コマンドラインから?plugin=attach&page=ページ名&pcmd=…としてattachの各機能を使用することは可能だが、ページ名はエンコードされていなければならない。手入力で実行することはまずない。
:言語ファイル設定|
--msg_uploaded
--msg_deleted
--msg_freezed
--msg_unfreezed
--msg_upload
--msg_info
--msg_confirm
--msg_list
--msg_listpage
--msg_listall
--msg_file
--msg_maxsize
--msg_count
--msg_password
--msg_adminpass
--msg_delete
--msg_freeze
--msg_unfreeze
--msg_isfreeze
--msg_require
--msg_filesize
--msg_date
--msg_dlcount
--msg_md5hash
--msg_page
--msg_filename
--err_noparm
--err_exceed
--err_exists
--err_notfound
--err_noexist
--err_delete
--err_password
--err_adminpass
--btn_upload
--btn_info
--btn_submit
:プラグイン内設定|
--MAX_FILESIZE
--ATTACH_UPLOAD_ADMIN_ONLY
--ATTACH_DELETE_ADMIN_ONLY
--ATTACH_PASSWORD_REQUIRE
--ATTACH_CONFIG_PAGE_MIME
:備考|
~プラグインではあるが、デフォルトのskinのメニューの「添付」でコマンドのように呼び出しているため、デフォルトのskinを使う場合には必ず組み込んでおかなければならない。
*B [#n25a28f6]
**back [#zceb4056]
:種別|
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
#back(表示文字列,表示位置,水平線の有無,戻り先)
:概要|
~指定した位置に戻り先へのリンクを設置する。
~表示文字列は省略すると「戻る」になる。
~表示位置は、left、center、rightを指定する。省略時はcenterになる。
~水平線の有無は、0、1で指定する。省略すると1になる。
~戻り先はURLで指定する。現状ではWikiNameやBracketNameを指定できない。省略すると直前のページになるが、利用者のブラウザの設定がJavaScript onでないと機能しない。
:備考|
~JavaScriptを使わない場合は、InterWikiName及びAliasでbackプラグインと同じことが簡単に実現できる。backプラグインでは戻り先をWikiNameやBracketNameで指定できないため、JavaScriptを使わないとPukiWiki内での移動には使いにくい。
~backプラグインをインストールする場合は、スキンの<head>ブロック内に<meta>タグでJavaScriptのContent Script Typeを宣言しておかなければいけない。
**backup [#ze8434c5]
:種別|
~コマンド
:重要度|
~★★★★★
:書式|
?cmd=backup&page=ページ名
:概要|
~指定したページのバックアップ一覧を表示する。
~ページ名を省略すると、PukiWIki全体のバックアップ一覧を表示する。ページ名はエンコードされていなければならない。
:言語ファイル設定|
--$_msg_backuplist
--$_msg_diff
--$_msg_nowdiff
--$_msg_source
--$_msg_backup
--$_msg_nobackup
--$_msg_view
--$_msg_goto
--$_msg_deleleted
--$_msg_addline
--$_msg_delline
--$_title_backupdiff
--$_title_backupnowdiff
--$_title_backupsource
--$_title_backup
--$_title_pagebackuplist
--$_title_backuplist
**bugtrack [#l4bf5298]
:種別|
~ブロック型プラグイン
:重要度|
~★☆☆☆☆ (一般サイト)
~★★★★☆ (ソフト開発サイト)
:書式|
#bugtrack(ページ名,種別1,種別2…)
:概要|
~指定した位置にbugtrackフォームを設置する。
~ページ名はbugtrackで作成される記事の親階層となるページ名を指定する。bugtrackは、記事ごとに指定したページ名の子階層に番号を自動的に振ってページを作成していく。
~種別は複数個指定することで選択肢となる。
:言語ファイル設定|
--$_bugtrack_plugin_priority_list
--$_bugtrack_plugin_state_list
--$_bugtrack_plugin_state_sort
--$_bugtrack_plugin_state_bgcolor
--$_bugtrack_plugin_title
--$_bugtrack_plugin_base
--$_bugtrack_plugin_summary
--$_bugtrack_plugin_priority
--$_bugtrack_plugin_state
--$_bugtrack_plugin_name
--$_bugtrack_plugin_date
--$_bugtrack_plugin_body
--$_bugtrack_plugin_category
--$_bugtrack_plugin_pagename
--$_bugtrack_plugin_pagename_comment
--$_bugtrack_plugin_version_comment
--$_bugtrack_plugin_version
--$_bugtrack_plugin_submit
:備考|
~ソフト開発サイトで重宝するプラグインだが、上記の言語ファイル設定で表示文字列を変更すれば、意見提案コーナーや書評投稿コーナーなど他の用途でも使える。
**bugtrack_list [#s584a422]
:種別|
~ブロック型プラグイン
:重要度|
~★☆☆☆☆ (一般サイト)
~★★★★☆ (ソフト開発サイト)
:書式|
#bugtrack_list
:概要|
~指定した位置にbugtrack一覧を設置する。
:備考|
~通常はbugtrackプラグインと並べて使用する。
~bugtrack_listプラグインの中からbugtrackプラグインを呼び出しているため、bugtrackプラグインがないと機能しない。
*C [#r1f429e1]
**calendar、calendar_edit、calendar_read [#j28896ea]
:種別|
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
#calendar(ページ名,年月)
#calendar_edit(ページ名,年月)
#calendar_read(ページ名,年月)
:概要|
~指定した位置にカレンダーを設置する。
~ページ名を省略すると設置したページのページ名になる。ページ名はWikiNameまたはBracketNameで指定する。
~年月日はyyyymmの形式で指定する。省略した場合は現在の年月になる。
~calendar_editは編集用、calendar_readは表示専用。
:言語ファイル設定|
--$_msg_week
:備考|
~より高機能なcalendar2プラグインがあるため、あえてcalendarプラグインを使う必要性はほとんどなくなった。
~calendar_editプラグイン及びcalendar_readプラグインの中からcalendarプラグインを呼び出しているため、calendarプラグインがないと機能しない。
**calendar_viewer [#p9cd9464]
:種別|
~ブロック型プラグイン
:重要度|
~★★★☆☆
:書式|
#calendar_viewer(ページ名,[表示年月|表示件数|this],表示モード,年月日表示の区切り文字)
:概要|
~calendarプラグインまたはcalendar2プラグインで作成されたページを指定した位置に表示する。
~ページ名はcalendarプラグインまたはcalendar2プラグインを設置しているページの名前を指定する。ページ名はWikiNameまたはBracketNameで指定する。
~[表示年月|表示件数|this]は3つのうちのいずれかを指定する（[]は必要ない）。表示年月の場合はyyyy-mmの形式で記述する。表示件数は表示する日記の件数を意味する。thisを指定すると今月のページを一覧表示する。
~表示モードはpast、future、viewを指定する。pastは今日以前のページを表示、futureは今日以降のページを表示、viewは過去から未来へ一覧表示。表示モードを省略するとpastになる。
~年月日の区切り文字は-や/などを指定する。省略した場合は-になる。
:言語ファイル設定|
--$_err_calendar_viewer_param
--$_err_calendar_viewer_param2
--$_msg_calendar_viewer_right
--$_msg_calendar_viewer_left
:備考|
~calendarやcalendarプラグインでは今日の日付の記事がない場合、記事を表示しないため、午前0時になったとたんに記事が表示されなくなるという弱点があった。その弱点を補うために開発されたプラグイン。calendar_viewは、日付が変わっても最新の記事を表示することができる。カレンダーそのものの表示はcalendar2(off)で行なう。
**calendar2 [#x3bbd0a5]
:種別|
~（コマンド）
~ブロック型プラグイン
:重要度|
~★★★☆☆
:書式|
#calendar2
#calendar2(ページ名,off)
:概要|
~指定した位置にカレンダーを設置する。表示月のとなりに表示されたリンク(<< および >>)を選択することで前月／翌月分のカレンダーを表示できる。
~ページ名を記述すると、内容を記述するページを指定できる。場所はページ名/yyyy-mm-ddで、省略した場合は設置したページの下階層に書き込まれる。
~日付をクリックすると、その日付のページが作成されていない場合、編集画面が表示される。ページが作成されていた場合はそのページを開く。
~当日分のページが作成されていた場合、カレンダーの右隣に当日分のページ内容を表示する。引数offを付けると当日分ページを表示する機能は抑制される。
//:言語ファイル設定|
//--
:備考|
~calender_editで作成したページはページ名/yyyymmddとなり、calender2で作成したページはページ名/yyyy-mm-ddとなるため、注意が必要。
**color [#l9f45961]
:種別|
~インライン型プラグイン
:重要度|
~★★★★☆
:書式|
&color(文字色){文章};
&color(文字色,背景色){文章};
:概要|
~引数で指定したインライン要素(主に文章)の、文字色・背景色を指定する。
//:言語ファイル設定|
//--
:備考|
~文字色，背景色の指定は6桁の16進数値(rrggbb)か、色名を指定する。
~以下、[[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 [#b13c93c6]
:種別|
~コマンド
~ブロック型プラグイン
:重要度|
~★★★★★
:書式|
#comment(引数)
:概要|
~引数へはabove,below,nodate,nonameのいずれかを指定する(順不同、半角カンマで区切って複数指定可、省略可)。
--above − 入力したコメントがコメント入力欄の上に追加される
--below − 入力したコメントがコメント入力欄の下に追加される
--nodate − 挿入するコメントに、挿入時刻を付加しない（デフォルトは付加する）
--noname − コメント記入者名の入力欄を非表示とする（デフォルトは表示）
//:言語ファイル設定|
//--
:備考|
~[[COMMENT_NOW_FORMATを変更>dev:BugTrack/287]]して、newプラグインと併用するのがお勧め。
**counter [#fbc81444]
:種別|
~ブロック型プラグイン
~インライン型プラグイン
:重要度|
~★★★☆☆
:書式|
#counter
&counter(カウンタ表示対象);
:概要|
~カウンタ表示対象には today,yesterday,total いずれかを指定する。省略時やその他の文字列を指定した場合はtotalが指定されたとみなされる。
--total − そのページが参照された回数の総計を表示する
--today − そのページが参照された回数（当日分）を表示する
--yesterday − そのページが参照された回数（昨日分）を表示する
//:言語ファイル設定|
//--
//:備考|
//~
*D [#eae6b48d]
**deleted [#na5dbffd]
:種別|
~コマンド
:重要度|
~★★☆☆☆
:書式|
?cmd=deleted
:概要|
~削除されたページの一覧を表示する。
//:言語ファイル設定|
//--
:備考|
~公開Wikiの管理者にとっては誤操作や悪意をもった編集によるページ削除をチェックするのに重宝する。
**diff [#ta6406c5]
:種別|
~コマンド
:重要度|
~★★★★★
:書式|
?cmd=diff&page=ページ名
:概要|
~指定したページの現在の内容と最後のバックアップ状態との差分を表示する。ページ名はエンコードされていなければならない。
//:言語ファイル設定|
//--
:備考|
~最後のバックアップ以外との差分を表示する場合はbackupを利用する。
* E [#q45dc325]
**edit [#i1e8d3e8]
:種別|
~コマンド
~インライン型プラグイン
:重要度|
~★★★★★
:書式|
''?cmd=edit''
&color(#ffcccc){&page=ページ名};
~''&edit(''
[&color(#ffcccc){ページ名};
{[,&color(#ffcccc){nolabel};]
[,&color(#ffcccc){noicon};]}]
''){''
&color(#ffcccc){ラベル名};
''};''
:概要|
~指定したページを編集します。
:引数|
~コマンド型の記述では、ページ名に編集するページを指定します。ページ名はエンコードされていなければなりません。
~インライン型の記述では、ページ名は編集するページを指定します。省略時は設置したページです。
~nolabel,noicon,ラベル名 でリンクの表示方法を指定します。
--nolabel − 編集用リンクの文字列をnoicon 指定時は短縮表記、未指定時は省略します。
--noicon − 編集用リンクに画像を表示しません。
--ラベル名 − 編集用リンクの文字列として表示する文字列を指定します。
:プラグイン内設定|~
--PLUGIN_EDIT_FREEZE_REGEX freezeプラグインを介さず、直接入力されたfreezeを除去する正規表現
------------------------------
* F [#n4aa1621]
**filelist [#zfddbc2e]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
''?cmd=filelist''
:概要|
~ページの一覧を各ページが記録されているファイル名と共に表示します。
:備考|
~主として管理者がメンテナンス用途に使用します。
**freeze [#le1aaa47]
:種別|
~コマンド
~（ブロック型プラグイン）
:重要度|
~★★★☆☆
:書式|
''?cmd=freeze''
&color(#ffcccc){&page=ページ名};
~''#freeze''
:概要|
~対象のページを凍結し、不用意に変更できないようにします。
:引数|
~ページ名には凍結するページを指定します。ページ名はエンコードされている必要があります。コマンド型でfreezeプラグインを実行するとブロック型プラグインが凍結対象のページ先頭に挿入（凍結解除の場合は削除）されます。
~ブロック型のfreezeプラグインはPukiWikiが内部的に利用するもので、基本的に利用者が意識する機会はありません。
* H [#xfadc6da]
**hr [#i56a8485]
:種別|
~ブロック型プラグイン
:重要度|
~★★☆☆☆
:書式|
''#hr''
:概要|
~文中に水平線を挿入します。
:備考|
~段落やリスト、テーブル内など、通常の水平線書式(----)ではブロックを抜けてしまう個所で水平線を挿入するために用います。リスト内など左右マージンが設定されている場合は、それを引き継ぎます。
------------------------------
* I [#qaa75d46]
**img [#v66d65c4]
:種別|
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
''#img(''
&color(#ffcccc){画像URL};[,
&color(#ffcccc){right};|
&color(#ffcccc){r};|
&color(#ffcccc){left};|
&color(#ffcccc){l};|
&color(#ffcccc){clear};|
&color(#ffcccc){c};,[
&color(#ffcccc){clear};|
&color(#ffcccc){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 [#nd4e3577]
:種別|
~ブロック型プラグイン
:重要度|
~★★★☆☆
:書式|
''#include(''
&color(#ffcccc){ページ名[,title|,notitle]};
'')''
:概要|
~記述した位置に指定したページを挿入して、複数のページをあたかも１つのページであるかのように表示します。
:引数|
~ページ名には挿入するページを指定します。~
第2引数にnotitleを指定すると、ページ名の表示を抑制します。titleはその逆です。
:プラグイン内設定|~
--PLUGIN_INCLUDE_MAX 一度にインクルードできるページの最大数
--PLUGIN_INCLUDE_WITH_TITLE title,notitle を未指定時に挿入時にページ名を表示するか・しないか
--PLUGIN_INCLUDE_USAGE 引数未指定時に表示されるヘルプ
**includesubmenu [#a7f1d129]
:種別|
~ブロック型プラグイン
:重要度|
~★★☆☆☆
:書式|
''#includesubmenu(''
[&color(#ffcccc){showpagename};]
'')''
:概要|
~現在表示中のページによって、MenuBarに表示する内容を切り替える為に使用します。
~表示中のページの下階層のSubMenuか、同階層にあるSubMenuページを挿入表示するプラグインです。
:引数|
~showpagename を指定すると、挿入表示するページのページ名を表示します。省略時はページ名を非表示とします。
**insert [#q51c8898]
:種別|
~（コマンド）
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
''#insert''
:概要|
~記述した位置に複数行入力欄とボタンを表示します。
~ボタンを押下すると入力欄に入力した内容をページに挿入します。
:プラグイン内設定|~
--INSERT_COLS 編集欄の表示幅
--INSERT_ROWS 編集欄の表示行数
--INSERT_INS 入力内容を入力欄の前後どちらに挿入するか
**interwiki [#k3075466]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
''?cmd=interwiki''
&color(#ffcccc){&page=InterWiki名};
:概要|
~InterWikiを記述した際にPukiWikiが内部的に呼び出します。使用者が意識して使用する機会はありません。
:引数|
~InterWiki名にはジャンプ先をInterWiki形式で指定します。InterWiki名はエンコードされている必要があります。
* L [#o648e077]
**lastmod [#icd62a6b]
:種別|
~インライン型プラグイン
:重要度|
~★☆☆☆☆
:書式|
~''&lastmod(''
[&color(#ffcccc){ページ名};]
'');''
:概要|
~指定したページの最終更新日時を表示します。
:引数|
~ページ名には最終更新日時を表示したいページ名を指定します。
省略時は設置したページとみなします。
**links [#m5bbd018]
:種別|
~コマンド
:重要度|
~★★☆☆☆（管理者）
:書式|
''?plugin=links''
:概要|
~ページ間のキャッシュを更新します。通常使用する必要はありません。
~メンテナンス作業などでページが記録されているファイルを直接操作した場合にキャッシュとページの記述内容の整合性がとれなくなるため、実行する必要があります。
:備考|
~実行の際に管理者パスワードを要求されます。
**list [#l9a47a57]
:種別|
~コマンド
:重要度|
~★★★★☆
:書式|
''?cmd=list''
:概要|
~ページの一覧を表示します。
**lookup [#u9c3d366]
:種別|
~（コマンド）
~ブロック型プラグイン
:重要度|
~★★★☆☆
:書式|
''#lookup(''
&color(#ffcccc){interwikiname};
[,&color(#ffcccc){ボタン名};
[,&color(#ffcccc){入力欄の初期値};]]
'')''
:概要|
~記述した位置にテキスト入力欄とボタンを表示します。任意の文字列を入力してボタンを押すと、interwikinameと入力値から生成したURLへ移動します。これによって、検索エンジンにクエリを送信したり、番号をタイプするだけで該当するアーカイブにアクセスすることなどが可能になります。
~URLの生成にはInterWikiを利用します。このプラグインが生成するURLは、以下のようなInterWikiと同じです。InterWikiNameのページに、あらかじめURLの生成に使用するInterWikiNameを設定しておく必要があります。
[[interwikiname:入力欄の値]]
~入力欄が空欄(空文字列)のときは、ボタンを押しても動作しません。必ず何らかの文字列を入力する必要があります。
:引数|
~interwikiname: InterWikiNameに設定した値の一つを指定します。
~ボタン名: ボタンに表示するキャプションを指定します。省略時は'lookup'です。
~入力欄の初期値: 初期値を指定したい場合に記入します。省略時は空文字列になります。
:プラグイン内設定|~
--PLUGIN_LOOKUP_USAGE 引数未指定時に表示されるヘルプ
**ls [#b596a628]
:種別|
~ブロック型プラグイン
:重要度|
~★★☆☆☆
:書式|
''#ls(''
[&color(#ffcccc){title};]
'')''
:概要|
~記述したページより階層化されているページのページ名を一覧表示します。
:引数|
~titleを指定した場合、ページ名に加えてタイトルを表示します。タイトルは各ページの一行目の内容を表示します。省略時はタイトルを表示しません。
:備考|
~実際には、より高機能なls2を使用する機会が多いと思われます。
**ls2 [#d2ce34ea]
:種別|
~（コマンド）
~ブロック型プラグイン
:重要度|
~★★★☆☆
:書式|
''#ls2(''
[[&color(#ffcccc){パターン};]
[,
{
[&color(#ffcccc){title};],
[&color(#ffcccc){include};],
[&color(#ffcccc){reverse};],
[&color(#ffcccc){compact};],
[&color(#ffcccc){link};]
}
[,&color(#ffcccc){linkの別名表示};]
]]
'')''
:概要|
~指定したパターンで始まるページ名を一覧表示します。
:引数|
~パターンには表示するページ名の共通部分を指定します。省略時は"設置したページ名/"となります。
~title,include,reverse,compact,link で表示方法を指定します。
--title − ページに含まれる見出し(*,**,***)の一覧を併記します。
--include − 下位層のページが#includeを使用していた場合、includeしているページの一覧を表示します。
--reverse − ページの並び順を反転し、名前の降順に表示します。省略すると名前の昇順に表示されます。
--compact − 見出しレベルを調整します。
--link − #ls2を書いた位置に一覧を表示する代わりにリンクを表示します。このリンクを選択すると別画面にページの一覧を表示するようにします。
:|~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]]を使っているため、昇順の場合、半角英数字よりも漢字の方が先に表示されます。
------------------------------
* M [#cdfaaa0f]
**map [#i89f687e]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
''?plugin=map''
[&color(#ffcccc){&refer=ページ名};]
[&color(#ffcccc){&reverse=true};]
:概要|
~サイトマップの様にページ間のリンク関係を一覧表示します。
~指定したページを起点に、リンクで辿れるページを全てツリー状に表示します。
:引数|
~引数には一覧表示方法のオプションを指定します。
--&refer=ページ名 − 起点となるページを指定します。省略すると、サイトのトップページ(通常はFrontPage)が起点となります。
--&reverse=true − どこへリンクしているかではなく、どこからリンクされているかを一覧表示します。 どこからもリンクされていないページは、画面の後半にまとめて表示されます。
:プラグイン内設定|~
--PLUGIN_MAP_SHOW_HIDDEN 表示対象外のページをリストアップするかどうか
**md5 [#wec9aa1f]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
''?plugin=md5''
&color(#ffcccc){&md5=文字列};
:概要|
~選択したパスワードの形式に応じて、pukiwiki.ini.php に保存する
パスワード用文字列を出力します。
~パスワードのフォーマットは以下の8種類の中から選択できます。
DESあるいはMD5アルゴリズムを利用したPHP crypt() および LDAP crypt ((crypt()関数の出力はシステムに依存するため、移植性が高くありません))、
MD5 アルゴリズムを利用したPHP md5()、LDAP MD5、およびLDAP SMD5(シードあり)、
SHA-1 アルゴリズムを利用したPHP sha()、LDAP SHA、および LDAP SSHA(シードあり)
:備考|
~PukiWiki内で利用するパスワードは、パスワード文字列そのものの代わりに、
実際のパスワードから導出された文字列(セキュリティハッシュ)を保存することが可能です。~
これは悪意ある者にpukiwiki.ini.phpの中身を覗き見られた場合に、
パスワードが安易に漏洩しない事を目的としたものです。~
~
SHA-1 アルゴリズムを利用するためには、PHP 4.3.0 以降を使用するか mhash エクステンションを導入する必要があります。
~
~プラグイン名に反してMD5以外のパスワードフォーマットも選択可能です。
これは従来、パスワードから導出したMD5ハッシュ値を利用していた経緯によるものです。
~
~md5のプラグインを呼び出すURLの中にパスワードを含める利用方法は互換性のため残っていますが、推奨されません。
~
~このプラグインは PKWK_SAFE_MODE ないし PKWK_READONLY の設定で無効化されます。
**memo [#h2cba975]
:種別|
~（コマンド）
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
''#memo''
:概要|
~記述した位置に複数行入力欄とボタンを表示します。
~ボタンを押下すると入力欄の記述内容を更新します。
:プラグイン内設定|~
--MEMO_COLS 編集欄の表示桁数
--MEMO_ROWS 編集欄の表示行数
:備考|
~insertプラグインやarticleプラグインと似ていますが、入力した内容が入力欄の外へ出力されず、入力欄に留まる点が異なります。
~個人用のメモ代わりにPukiWikiを利用している場合、未整理の情報を一時的に溜め込むのに便利です。
**menu [#vc24ce14]
:種別|
~ブロック型プラグイン
:重要度|
~★★★★☆
:書式|
''#menu(''
&color(#ffcccc){ページ名};
'')''
:概要|
~デフォルトのスキンにて、ページの左側にメニュー用のページ(MenuBar)を表示するために内部的に使用されています。
~任意のページでブロック型プラグインとして使用すると、引数に指定したページをメニュー用ページに指定できます。&br;
例えば通常はMenuBarを表示するサイトで、hogeというページだけはMenuBarの代わりにhogeMenuというページを表示したい場合、hogeというページに #menu(hogeMenu) と記述する事で実現できます。
~ソース中のMENU_ENABLE_SUBMENU をTRUEとすると、表示中のページの上位階層のMenuBarか、同階層にあるMenuBarページをメニューとして表示するようになります。&br;
例えば 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 を変更して下さい。
------------------------------
* N [#ge4daaa6]
**navi [#yd9441b2]
:種別|
~ブロック型プラグイン
:重要度|
~★★☆☆☆
:書式|
''#navi(''
[&color(#ffcccc){目次ページ};]
'')''
:概要|
~[[DocBook>http://www.docbook.org/oasis/]]風ナビゲーションバーを表示します。
~目次となるページに下階層のページが存在する時、それら全てのページ（の先頭と末尾）に記述する事で Prev, Home, Next というリンクを表示します。これによって下階層のページを順に参照するのに便利になります。
:引数|
~目次ページに順番に見て回るページの上階層にあたるページを指定します。
~例えば hoge, hoge/1, hoge/2, hoge/3 というページが存在する場合、hoge/2に#navi(hoge)を記述するとhogeに移動するHomeというリンク、hoge/1に移動するPrevというリンク、hoge/3に移動するNextというリンクを表示します。
~ページで最初に呼び出した場合はヘッダイメージのリンクを出力します。ページで２度目以降に呼び出された場合はフッタイメージのリンクを出力します。現在のページが目次ページである場合は対象となるページの一覧を表示します。
:プラグイン内設定|~
--PLUGIN_NAVI_EXCLUSIVE_REGEX 除外するページを正規表現で指定する
--PLUGIN_NAVI_LINK_TAGS <link>タグを出力するかどうか
**new [#meab71a6]
:種別|
~インライン型プラグイン
:重要度|
~★★☆☆☆
:書式|
:'''書式1:'''|''&new(''
[&color(#ffcccc){nodate};]
''){''
&color(#ffcccc){日付文字列};
''};''
:'''書式2:'''|''&new(''
[&color(#ffcccc){ページ名};]
[,&color(#ffcccc){nolink};]
'');''
:概要|
~指定した日時が最近であった場合、最近更新された事を強調表示します。日時の指定は直接日付時刻を記述する方法('''書式1''')と、指定したページ（群）の最終更新日時を採用する方法('''書式2''')の２通りがあります。
~標準では5日以内の場合に ''New'' を、１日以内の場合に ''New!'' を表示します。期間や表示する文字列のパターンは設置者によってカスタマイズ可能です。
:引数|
~'''書式1:'''
~日付文字列を指定した場合、その日時が規定の期間内であった場合に強調表示します。省略した場合はページの更新日時をチェックする記述であると見なされます。
--nodate − 日付文字列を表示しません。省略時は表示します。
:|
~'''書式2:'''
~ページ名を指定した場合は、そのページの更新日時が規定の期間内であった場合に強調表示します。省略した場合は、プラグインを記述したそのページを指定したと見なします。
~ページ名末尾が/であった場合、そのページ名で始まるページ群の中で最後の更新日時が規定の日付以内であった場合に強調表示します。
--nolink − ページ名を表示しません。省略時はページ名（ページ群で指定した場合は最後に更新されたページ名）を表示します。
:プラグイン内設定|~
--PLUGIN_NEW_DATE_FORMAT 表示フォーマット
:備考|
~日付文字列は[[PHP関数:strtotime]]が認識できる書式である必要があります。
**newpage [#lec55a94]
:種別|
~コマンド
~ブロック型プラグイン
:重要度|
~★★★★★
:書式|
''?plugin=newpage''
&color(#ffcccc){&page=ページ名};
&color(#ffcccc){&refer=関連ページ名};
~''#newpage(''
[&color(#ffcccc){ページ名初期値};]
'')''
:概要|
~ページを新規作成するか、新規作成するページ名の入力欄を表示します。
:引数|
~'''コマンド:'''
~パラメータには新規作成するページのオプションを指定します。
~ページ名には新規作成するページ名を指定します。省略時は新規作成するページ名の入力するためのページを表示します。ページ名はエンコードされている必要があります。
~関連ページ名にはリンク元のページ名を指定します。新規作成するページの先頭に、ここで指定したページへのリンクが自動的に埋め込まれます。ページ名はエンコードされている必要があります。
~
~'''ブロック型プラグイン:'''
~ページ名初期値には新規作成するページ名を入力する入力欄に初期表示する文字列を指定します。
**nofollow [#s8c0fa4c]
:種別|
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
~''#nofollow''
:概要|
~記述したページが凍結されている場合、ヘッダーに「NOFOLLOW」「NOINDEX」オプションを追加させます。
~これらのオプションは検索エンジンに対し「このページを無視して欲しい」と主張します。実際にどうなるのかは検索エンジン次第です。
:備考|
~人間や、上記のオプションを無視するプログラムには効果がありません。
**norelated [#uebd3c7c]
:種別|
~ブロック型プラグイン
:重要度|
~★★★☆☆
:書式|
''#norelated''
:概要|
~ページ下部に表示される関連ページのリンクを非表示にします。
:備考|
~極端に多くのページからリンクされていて関連リンクの表示が目障りである場合などに利用します。
* O [#c4c5830a]
**online [#vc9c6801]
:種別|
~ブロック型プラグイン
~インライン型プラグイン
:重要度|
~★★☆☆☆
:書式|
~''#online''
~''&online'''';''
:概要|
~現在PukiWikiを参照している、おおよそのユーザー数を表示します。
~ユーザー数は、プラグインを呼び出された時点で記録されたＩＰアドレスとタイムスタンプのうち、５分以内(変更可能)にアクセスのあったアドレスの数です。
:プラグイン内設定|~
--PLUGIN_ONLINE_TIMEOUT タイムアウトの秒数
--PLUGIN_ONLINE_USER_LIST ユーザー情報を保存するファイル
--PLUGIN_ONLINE_LIST_REGEX ユーザー情報取得用の正規表現
:備考|
~ユーザー数のカウントはページ単位でなく、設置されたPukiWiki毎に行っているため、MenuBarなど頻繁に呼び出される場所に記述するかスキンに埋め込むのが普通です。
------------------------------
* P [#eb773236]
**paint [#v8e0f909]
:種別|
~（コマンド）
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
''#paint(''
[&color(#ffcccc){幅};]
[,&color(#ffcccc){高さ};]
'')''
:概要|
~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 [#n889950d]
:種別|
~（コマンド）
~ブロック型プラグイン
:重要度|
~★★★☆☆
:書式|
''#pcomment(''{
[&color(#ffcccc){コメント記録ページ};],
[&color(#ffcccc){表示件数};],
[&color(#ffcccc){noname};],
[&color(#ffcccc){nodate};],
[&color(#ffcccc){above};],
[&color(#ffcccc){below};],
[&color(#ffcccc){reply};]
}'')''
:概要|
~別のページにコメントを記録することができるcommentプラグインです。設置した場所には最新のコメントだけを表示することができます。ラジオボタンを表示し、指定した部分にコメントを付けることもできます。
:引数|
~コメント記録ページ にはコメントを記録するページ名を指定します。省略すると、pcommentプラグイン内の PLUGIN_PCOMMENT_PAGE で指定されたページにコメントが記録されます。デフォルトは [コメント/(設置したページ名)] です。指定したページが存在しなくても、最初にコメントを追加した時に作成します。
~表示件数 は表示する最新コメントの数を指定します。第1レベルの番号なしリストだけをカウントします。省略すると、pcommentのデフォルト件数(通常10件。 PLUGIN_PCOMMENT_NUM_COMMENTS で変更可能)が表示されます。~
表示件数は コメント記録ページ より後に指定して下さい。コメント記録ページを省略して 表示件数 を指定する場合は、 コメント記録ページ に空白を指定します。（例: #pcomment(,15)）
~noname,nodate,above,below,reply でコメントの表示方法、入力方法を指定します。
--noname − 名前の入力欄を表示しません。
--nodate − 日付を挿入しません。
--above − 挿入したコメントをフォームの上に表示します。コメントは上が古く、下に向かって新しい順に並びます。
--below − 挿入したコメントをフォームの下に表示します。コメントは下が古く、上に向かって新しい順に並びます。
--reply − コメントの頭にラジオボタンを表示します。あるコメントに対するリプライが、そのコメントのラジオボタンをチェックすることで可能になります。
:プラグイン内設定|~
--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 コメントページのタイムスタンプを更新せず、設置ページのタイムスタンプを更新するか
:備考|
~更新が衝突したときは、予期せぬ場所にコメントが挿入されるのを防ぐため、リプライ先を指定して記入したコメントはaboveまたはbelowの設定にしたがって 一番前か一番後ろに追加されます。
~コメント記入後に表示されるページのタイトルに「(#pcommentを書いたページ)を更新しました」と表示されますが、実際に更新されたのはコメントを記録するページです。
~コメントを投稿しても、#pcommentが書かれたページは更新されないので、最終更新ページにはコメントを記録したページだけが更新として表示されます。
~コメントとして相対参照([ [../] ]など)を用いた場合は、書いたページと書き込まれたページのどちらかで、意図したとおりに変換されない可能性があります。
~自動過去ログ化機能は PLUGIN_PCOMMENT_AUTO_LOG の件数 ＋ PLUGIN_PCOMMENT_NUM_COMMENTS の件数分のコメントを投稿した時に作動します。
**popular [#aa6d5e99]
:種別|
~ブロック型プラグイン
:重要度|
~★★☆☆☆
:書式|
''#popular(''
[[&color(#ffcccc){件数};]
[,[&color(#ffcccc){対象外ページ};]
[,&color(#ffcccc){true};|&color(#ffcccc){false};]
]]
'')''
:概要|
~人気のある（参照回数の多い）ページの上位数件を表示します。
:引数|
~件数には一覧の数を指定して下さい。省略時はPLUGIN_POPULAR_DEFAULTに指定した件数です。
~対象外ページには、表示対象外とするページを正規表現で指定します。例えば FrontPage や MenuBar などのページを一覧に表示させたくないときに使用します。
~true, falseで、ページのカウント条件を指定します。省略時は false です。
--true − 今日参照のあった回数順でページを表示します。
--false − 通算の参照回数順でページを表示します。
:プラグイン内設定|~
--PLUGIN_POPULAR_DEFAULT 件数未指定時の件数
:備考|
~[[counter>../A-D#zedb02cf]]プラグインのカウンター情報を利用しているので、counterプラグインを設置していないページはカウントの対象外となります。全てのページにcounterプラグインを設置するのは非効率であるため counterプラグインをMenubarやスキンに設置するのが一般的です。
------------------------------
* R [#heb39161]
**random [#bdab4a5d]
:種別|
~（コマンド）
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
''#random(''
[&color(#ffcccc){メッセージ};]
'')''
:概要|
~ランダムなページへのリンクを表示するプラグイン。
~表示するページの候補は設置したページの下階層のページです。
:引数|
~メッセージにはリンクに表示する文字列を指定します。省略時は 'press here.' となります。
:備考|
~ブラウザの再読み込み対策はしていません。リロードされるたびにランダムな表示を繰り返します。
**read [#qd5d7395]
:種別|
~コマンド
:重要度|
~★★★★★
:書式|
''?cmd=read''
&color(#ffcccc){&page=ページ名};
:概要|
~指定したページを表示します。該当ページが存在しない場合は編集状態で開き、ページ名がInterWikiであった場合は、その解決を行います。
~plugin=やcmd=が指定されていない場合に内部で暗黙に呼び出されるため、利用者が意識する機会は少ないです。
:引数|
~ページ名には表示したいページ名を指定します。ページ名はエンコードされている必要があります。
**recent [#f6f25416]
:種別|
~ブロック型プラグイン
:重要度|
~★★★★★
:書式|
''#recent(''
[&color(#ffcccc){件数};]
'')''
:概要|
~最近更新されたページのうち、最新の数件を表示します。
:引数|
~件数には表示件数を指定します。省略時はプラグイン内設定で指定した値です。
:プラグイン内設定|~
--PLUGIN_RECENT_DEFAULT_LINES 件数未指定時の件数
--PLUGIN_RECENT_CACHE RecentChangesのキャッシュの場所
--PLUGIN_RECENT_USAGE 引数未指定時に表示されるヘルプ
--PLUGIN_RECENT_EXEC_LIMIT １ページ中で実行可能な上限回数
**ref [#h9e797dc]
:種別|
~ブロック型プラグイン
~インライン型プラグイン
:重要度|
~★★★★☆
:書式|
~''#ref(''
&color(#ffcccc){添付ファイル名};|
&color(#ffcccc){ページ名/添付ファイル名};|
&color(#ffcccc){URL};
[,&color(#ffcccc){ページ名};]
{,
[&color(#ffcccc){left};|&color(#ffcccc){center};|&color(#ffcccc){right};],
[&color(#ffcccc){wrap};|&color(#ffcccc){nowrap};],
[&color(#ffcccc){around};],
[&color(#ffcccc){noicon};],
[&color(#ffcccc){noimg};],
[&color(#ffcccc){nolink};],
[&color(#ffcccc){zoom};],
[&color(#ffcccc){999x999};],
[&color(#ffcccc){999%};]
}
[,&color(#ffcccc){タイトル};]
'')''
~''&ref(''
&color(#ffcccc){添付ファイル名};|
&color(#ffcccc){ページ名/添付ファイル名};|
&color(#ffcccc){URL};
[,&color(#ffcccc){ページ名};]
{,
[&color(#ffcccc){noicon};],
[&color(#ffcccc){noimg};],
[&color(#ffcccc){nolink};],
[&color(#ffcccc){zoom};],
[&color(#ffcccc){999x999};],
[&color(#ffcccc){999%};]
}
[,&color(#ffcccc){タイトル};]
'');''
:概要|
~'#attach'でページに添付されたファイルを指定位置に展開します。添付ファイルが画像の場合は画像を表示し、それ以外の場合はダウンロード用のリンクを表示します。
:引数|
~添付ファイル名にはページに添付したファイル名を指定します（省略時はエラーとなります）。別ページ名/添付ファイル名とする事で別ページの添付ファイルも指定できます。
~ページ名にはファイルを添付したページをWikiNameかBracketNameで指定します。このオプションは最初(添付ファイル名の次)に記述してください。省略時は設置したページです。
~パラメータにはファイルの展開方法を指定できます。
--left|center|right − 表示時の位置を指定します。省略時はleft(変更可)です。
--wrap|nowrap − テーブルタグで囲む/囲まないの指定を行います。省略時はnowrap(変更可)です。
--around − テキストの回り込みを可能とします。省略時は回り込みを行いません。
--noicon − ファイルが画像以外の場合に表示されるアイコンを表示しません。省略時は表示します。
--noimg − ファイルが画像の場合に画像を展開しないようにします。省略時は展開します。
--nolink − 元ファイルへのリンクを張らないようにします。省略時はリンクします。
--zoom − 縦横比を保持します。省略時はサイズ指定に従います。
--999x999 − サイズを指定します(幅x高さ)。省略時は拡大率あるいは対象画像のサイズに従います。
--999% − サイズを指定(拡大率)します。省略時は100%です、
--タイトル − 上記以外のパラメータは画像の代替文字列、リンクのタイトル属性として使用されます。ページ名やパラメータに見える文字列を使用するときは、#ref(hoge.png,,zoom)のようにタイトルの前にカンマを余分に入れます。
:プラグイン内設定|~
--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 のデータに直接アクセスするか
:備考|
~aroundで行った回り込み指定を解除するには clearプラグイン、あるいはimgプラグインを使用して下さい。
~"ほげ"という別ページの添付ファイル"fuga.jpg"をインラインプラグイン形式で参照する場合、下記２通りの記述方法が存在します。
(1) &ref(ほげ/fuga.jpg);
(2) &ref(fuga.jpg,[[ほげ]]);
~上記２通りの記述のうち、(2)の記述方式は旧バージョンと互換性を維持するために用意されたもので、推奨される記述方式は(1)です。&br;
いずれの記述方法であっても一般的な動作は同じですが、いわゆるバナー画像のように表示した画像が別ページへのリンクとなるよう以下の指定をした場合、
(1) [[&ref(ほげ/fuga.jpg,nolink,ウェブ名);>ウェブのURL]]
(2) [[&ref(fuga.jpg,[[ほげ]],nolink,ウェブ名);>ウェブのURL]]
(1)の記述方法は期待通りの動作をしますが、(2)の記述方法ではうまくリンクされません。&br;
また、ほげというページに添付された画像を、そのページ内でパラメータを指定して（例えば半分の比率で）表示する場合、
(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 [#l8d62a01]
:種別|
~コマンド
:重要度|
~★★★☆☆
:書式|
''?plugin=referer''
[&color(#ffcccc){&page=ページ名};]
[&color(#ffcccc){&sort=};
&color(#ffcccc){0d};|&color(#ffcccc){0a};|
&color(#ffcccc){1d};|&color(#ffcccc){1a};|
&color(#ffcccc){2d};|&color(#ffcccc){2a};|
&color(#ffcccc){3};
]
:概要|
~ページを照会した利用者の参照元URL(Referer)の一覧を表示します。
:引数|
~ページ名にはRefererを表示するページ名を指定します。ページ名はエンコードされている必要があります。省略時はRefererが記録されているページの一覧を表示します。
~sortでReferer一覧のソート順を指定します。
--0d − 最終更新日時(新着順)
--0a − 最終更新日時(日付順)
--1d − 初回登録日時(新着順)
--1a − 初回登録日時(日付順)
--2d − カウンタ(大きい順)
--2a − カウンタ(小さい順)
--3 − Referer
:プラグイン内設定|~
--CONFIG_REFERER 無視するURIを指定したページ
:備考|
~pukiwiki.ini.php で、Refererを使用する設定($referer = 1を指定)が行われている必要があります。
**related [#v4da5475]
:種別|
~コマンド
~擬似ブロック型プラグイン
:重要度|
~★★★☆☆
:書式|
~''?plugin=related''
[&color(#ffcccc){&page=ページ名};]
~''#related''
:概要|
~対象のページを参照しているページの一覧を表示します。
:引数|
~ブロック型で実行時、設置したページが対象となります。
~コマンドで実行時、ページ名に対象となるページを指定できます。省略した場合、トップページが指定されたとみなします。
**rename [#m95d6531]
:種別|
~コマンド
:重要度|
~★★★☆☆
:書式|
''?plugin=rename''
[&color(#ffcccc){&refer=ページ名};]
:概要|
~既存ページの名前を変更します。実行には管理者権限が必要です。
~ページの本文のほか、指定されたページ名の差分、バックアップ、添付ファイル、カウンターを一気にリネームします。
:引数|
~ページ名には変更するページの名前を指定します。省略時はページ名の選択または正規表現置換用文字列入力画面が表示されます。
~実行結果は変換結果のページ（PLUGIN_RENAME_LOGPAGE で指定。標準は :RenameLog）に追記されます。
:プラグイン内設定|~
--PLUGIN_RENAME_LOGPAGE ページ名の変換結果を出力するページ名
:備考|
~ページ内のリンクの書き換えは行ないません。yetlistなどを駆使して対処してください。
~TrackBackやRefererの情報は更新されません。
~リネーム対象のページが凍結されているかどうかはチェックしていません。
~関連ページにリネーム対象の文字列が複数含まれているとおかしくなります。
--たとえば、hogeおよびhoge/hogeという二つのページがあったときに、hogeページをfugaに(関連ページを含んで)リネームすると、hoge/hogeページの名前がfuga/fugaになってしまいます。
**rss [#iaac8b70]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
~''?plugin=rss''
[&color(#ffcccc){&ver=};&color(#ffcccc){0.91};|
&color(#ffcccc){1.0};|
&color(#ffcccc){2.0};]
:概要|
~RecentChangesをRSSに変換して出力します。
:引数|
~verで出力するRSSを指定します。省略時は0.91を出力します。
:備考|
~RSSはサイトの要約を配信するために使われるXMLフォーマットです。RSS 1.0はRDF(Resource Description Framework)にもとづいたRSS 0.9の後継フォーマットです。RSS 0.91は RDFにもとづかないRSSの実装で、RSS 2.0は RSS 0.91および 0.92の後継フォーマットです。RSSという頭字語が何の略であるかは、それぞれ異なります。
~''RSS 0.9および1.0'': RDF Site Summary
~''RSS 0.91および0.92'': Rich Site Summary
~''RSS 2.0'': Really Simple Syndication
**rss10 [#v879eb4d]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
~''?cmd=rss10''
:概要|
~RecentChangesをRSS(RDF Site Summary)1.0に変換して出力します。
:備考|
~rss10プラグインの機能はrssプラグインにマージされたため、
このプラグインは過去との互換性のためにのみ存在しています。
(将来的に削除される可能性があります)
~このプラグインにアクセスすると、HTTPステータス・コード 301
(Moved Permanently)とともに、ver=1.0オプションを指定したrssプラグイン
のURIへリダイレクトされます。
**ruby [#u3fad1fe]
:種別|
~インライン型プラグイン
:重要度|
~★☆☆☆☆
:書式|
''&ruby(''
&color(#ffcccc){ルビ};
''){''
&color(#ffcccc){対象文字列};
''};''
:概要|
~文字列にルビをふります。
:引数|
~ルビには表示するルビを指定します。
~対象文字列にはルビがふられる文字列を指定します。
:プラグイン内設定|~
--PLUGIN_RUBY_USAGE 引数未指定時に表示されるヘルプ
:備考|
~XHTML 1.1のルビに対応したブラウザでないと、ルビとして表示されません。IE5.5/6では表示できます。Netscape 7/Mozillaでは[[XHTML Ruby Support:http://white.sakura.ne.jp/~piro/xul/_rubysupport.html]]を組み込めば表示できます。
~ルビに対応していないブラウザではルビをふる文字列の直後にルビが( )に入れられて表示されます。
*S [#pf998177]
**search [#h6c493f1]
:種別|
~コマンド
:重要度|
~★★★★★
:書式|
?cmd=search[パラメータ]
:概要|
~指定した文字列を含むページの検索を行います。
~パラメータには検索条件を指定します。(複数指定可、順不同、省略可)
--word − 検索する文字列を指定します。
--type − 'OR' 指定時、OR検索を行います。(省略時はAND検索)
//:言語ファイル設定|
//--
//:備考|
//~
**server [#od292024]
:種別|
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
#server
:概要|
~サーバーの情報(サーバー名、サーバーソフトウエア、サーバー管理者)を表示します。
//:言語ファイル設定|
//--
//:備考|
//~
**showrss [#i8120f35]
:種別|
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
#showrss(RSSへのパス, テンプレート名, キャッシュ生存時間, 更新日表示フラグ)
:概要|
~指定されたRSSを取得し、一覧表示します。
~ページの解釈毎にRSSの取得を行う為、頻繁に参照されるページでshowrssを使用される場合はキャッシュ機能を使うことをお勧めします。相手サイトの更新頻度に応じてキャッシュの生存時間を適宜設定して下さい。
~RSSへのパスにはRSSへのファイルパスやURLを指定します。(省略不可)
~テンプレート名には取得したRSSの表示方法を指定します。default, menubar, recentが指定できます。（省略時はdefault）
~キャッシュ生存時間はキャッシュをクリアする期限（１時間単位）です。省略時、キャッシュ機能は無効となります。
~更新日表示フラグはRSSを取得した日付を表示するかどうかを指定します。1を指定した場合のみ表示します。
//:言語ファイル設定|
//--
//:備考|
//~
**size [#wcf76895]
:種別|
~インライン型プラグイン
:重要度|
~★★★☆☆
:書式|
&size(ピクセル数値){文字列}
:概要|
~文字の大きさを指定します。
~ピクセル数値には文字の大きさを指定します。
~文字列は文字の大きさを変更する文字列を指定します。
//:言語ファイル設定|
//--
//:備考|
//~
**source [#f2303162]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
?cmd=source&page=ページ名
:概要|
~指定したページの整形前のソースを表示します。
//:言語ファイル設定|
//--
:備考|
~ページ名はエンコードされている必要があります。
*T [#j33be42a]
**tb [#j1585eeb]
:種別|
~コマンド
:重要度|
~★★☆☆☆
:書式|
?plugin=tb
:概要|
~TrackBackに反応します。
//:言語ファイル設定|
//--
:備考|
~TrackBackを送信するには[[質問箱/379]]を参照。
**template [#ueac6d45]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
?plugin=template&refer=テンプレートページ
:概要|
~既存のページをテンプレートとしてページを新規作成します。
~テンプレートページには雛形とするページを指定します。(省略不可)
~ページの新規作成時の雛形とするページの読込み機能とは、テンプレートプラグインが雛形とする範囲(行単位)に選択できるのに対して、ページの新規作成では全文をテキストエリアにコピーする点が異なります。
//:言語ファイル設定|
//--
:備考|
~ページ名はエンコードされている必要があります。
**touchgraph [#q0c0bb41]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
?plugin=touchgraph
:概要|
~TouchGraphWikiBrowser用のインデックスを作ります。
//:言語ファイル設定|
//--
//:備考|
//~
**tracker [#geaa219a]
:種別|
~ブロック型プラグイン
:重要度|
~★★☆☆☆
:書式|
#tracker
:概要|
bugtrackプラグインの汎用化版です。。入力項目、フォームのデザイン、リストの
デザインを自由に設定できます。
//:言語ファイル設定|
//--
:備考|
~詳細は[[しろくろのへや:tracker.inc.php]]を参照してください。
*U [#w1025bfb]
**unfreeze [#e882e3eb]
:種別|
~コマンド
:重要度|
~★★★☆☆
:書式|
?plugin=unfreeze&page=ページ名
:概要|
~ページの凍結を解除します。
~ページ名には解除するページ名を指定します。
//:言語ファイル設定|
//--
:備考|
~ページ名はエンコードされている必要があります。
*V [#k5824188]
**version [#gc1629fd]
:種別|
~ブロック型プラグイン
~インライン型プラグイン
:重要度|
~★☆☆☆☆
:書式|
#version
&version;
:概要|
~インストールされているPukiWikiのバージョンを表示する。
//:言語ファイル設定|
//--
//:備考|
//~
**versionlist [#ead06561]
:種別|
~コマンド
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
?plugin=versionlist
#versionlist
:概要|
~pukiwiki.phpのあるディレクトリとpluginのディレクトリ内のphpファイルのバージョンを表示する。
//:言語ファイル設定|
//--
//:備考|
//~
**vote [#wf9de988]
:種別|
~コマンド
~ブロック型プラグイン
:重要度|
~★★☆☆☆
:書式|
#vote(選択肢１[0],選択肢２[0],選択肢３[投票数][0],[[WikiName]][投票数]…[0])
:概要|
~選択肢と投票ボタンが並んだフォームを表示します。
~選択肢には文章の他、WikiName/BracketNameを使用できます。
//:言語ファイル設定|
//--
:備考|
~各選択肢の投票数は容易に改竄できるため、厳密な投票には向きません。
*Y [#sf50b180]
**yetlist [#i541ecab]
:種別|
~コマンド
:重要度|
~★★☆☆☆
:書式|
?plugin=yetlist
:概要|
~まだ作られていないページを一覧表示する。
~既存のページでWikiNameあるいはBracketNameで指定されているが、まだ作られていないページを一覧表示します。
//:言語ファイル設定|
//--
:備考|
~自分以外の誰かがページを書くかもしれないという点は非常にWiki的ですが
//(これ以後は？)->標準搭載にはないよ
|
