Pukiwiki/プラグイン/1.4

Last-modified: 2012-09-09 (日) 00:52:04

PukiWiki 1.4標準プラグイン

  • 昔の説明なので、一部最新版とは違う場合があります

プラグインマニュアルの凡例

プラグインマニュアルは以下の形式で記述されています。

プラグイン名

種別

プラグインがどのような方法で呼び出しを行えるかを示します。複数の呼び出し方法をもつプラグインも存在します。

  • コマンド － コマンド形式の呼び出しが可能であることを示します。内部的に呼び出されるため、説明を省いている場合はカッコで括られています。
  • ブロック型プラグイン － ブロック型プラグインでの呼び出しが可能である事を示します。
  • インライン型プラグイン － インライン型プラグインでの呼び出しが可能である事を示します。
  • 擬似ブロック型プラグイン － PukiWiki本体で実現されている機能であることを示します。記述方式がブロック型プラグインと同じであるため、便宜上プラグインのマニュアルに含めています。
重要度

そのプラグインの一般的な利用頻度や有用性の目安を示します。さほど重要でない場合は ★☆☆☆☆ が、重要なプラグインの場合は ★★★★★ です。

書式

プラグインでの引数指定方法です。引数の指定方法の表現のため、下記の記述書式を使っています。

  • [] － 省略可能で必要に応じて記述する箇所です。
  • | － |で区切られた複数の項目のうち、指定できるのは１つである事を示します。
  • {} － 中カッコ内のみ引数の指定順序が任意である事を示します。
概要

そのプラグインの機能概要です。

引数

引数の詳細な説明です。

プラグイン内設定

プラグインのソース中で定義されている定数の一覧です。引数で変更できない詳細なカスタマイズが可能となります。

備考

プラグインに関する参考情報です。

add 【編集内容を追加】

種別

コマンド

重要度

★☆☆☆☆

書式
?cmd=add&page=ページ名
概要

既存のページに編集した内容を追加する。実行すると編集画面になる。

ページ名は省略できない。ページ名はエンコードされていなければならない。

言語ファイル設定
  • $_title_add
  • $_msg_add
備考

もともとデフォルトのskinでメニューの「追加」として使われていたが、editコマンドで事足りるため、現在のデフォルトのskinではメニューから外されている。

aname 【アンカーの設定】

種別

インライン型プラグイン

重要度

★★★☆☆

書式
&aname(アンカー名);
#aname(アンカー名)
概要

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

ブロック型プラグインとしても使用できる。

アンカー名は省略できない。

備考

通常はインライン型プラグインとして使用する。

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

なお、1.3.5まではブロック型プラグインだったが、1.4からインライン型プラグインになった。

article 【簡易掲示板の設置】

種別

ブロック型プラグイン

重要度

★★★☆☆

書式
#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 【ファイル添付用入力フォーム設置】

種別

ブロック型プラグイン

重要度

★★★★★

書式
#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を使う場合には必ず組み込んでおかなければならない。

back 【戻り先リンクの設置】

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#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 【バックアップ一覧】

種別

コマンド

重要度

★★★★★

書式
?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 【bugtrackフォームの設置】

種別

ブロック型プラグイン

重要度

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

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

書式
#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 【bugtrack一覧を設置】

種別

ブロック型プラグイン

重要度

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

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

書式
#bugtrack_list
概要

指定した位置にbugtrack一覧を設置する。

備考

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

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

calendar、calendar_edit、calendar_read 【カレンダー設置】

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#calendar(ページ名,年月)
#calendar_edit(ページ名,年月)
#calendar_read(ページ名,年月)
概要

指定した位置にカレンダーを設置する。

ページ名を省略すると設置したページのページ名になる。ページ名はWikiNameまたはBracketNameで指定する。

年月日はyyyymmの形式で指定する。省略した場合は現在の年月になる。

calendar_editは編集用、calendar_readは表示専用。

言語ファイル設定
  • $_msg_week
備考

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

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

calendar_viewer 【カレンダーページ表示】

種別

ブロック型プラグイン

重要度

★★★☆☆

書式
#calendar_viewer(ページ名,[表示年月|表示件数|this],表示モード,年月日表示の区切り文字)
概要

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

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

年月は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

種別

（コマンド）

ブロック型プラグイン

重要度

★★★☆☆

書式
#calendar2
#calendar2(off)
概要

指定した位置にカレンダーを設置する。表示月のとなりに表示されたリンク(<< および >>)を選択することで前月／翌月分のカレンダーを表示できる。

当日分のページが作成されていた場合、カレンダーの右隣に当日分のページ内容を表示する。引数offを付けると当日分ページを表示する機能は抑制される。

備考

calender_editで作成したページはページ名/yyyymmddとなり、calender2で作成したページはページ名/yyyy-mm-ddとなるため、注意が必要。

color 【文字・背景色の指定】

種別

インライン型プラグイン

重要度

★★★★☆

書式
&color(文字色){文章};
&color(文字色,背景色){文章};
概要

引数で指定したインライン要素(主に文章)の、文字色・背景色を指定する。

備考

文字色，背景色の指定は6桁の16進数値(rrggbb)か、色名を指定する。

以下、W3C勧告書より抜粋した色名。

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(引数)
概要

引数へはabove,below,nodate,nonameのいずれかを指定する(順不同、半角カンマで区切って複数指定可、省略可)。

  • above － 入力したコメントがコメント入力欄の上に追加される
  • below － 入力したコメントがコメント入力欄の下に追加される
  • nodate － 挿入するコメントに、挿入時刻を付加しない（デフォルトは付加する）
  • noname － コメント記入者名の入力欄を非表示とする（デフォルトは表示）
備考

COMMENT_NOW_FORMATを変更して、newプラグインと併用するのがお勧め。

counter 【カウンター表示】

種別

ブロック型プラグイン

インライン型プラグイン

重要度

★★★☆☆

書式
#counter
&counter(カウンタ表示対象);
概要

カウンタ表示対象には today,yesterday,total いずれかを指定する。省略時やその他の文字列を指定した場合はtotalが指定されたとみなされる。

  • total － そのページが参照された回数の総計を表示する
  • today － そのページが参照された回数（当日分）を表示する
  • yesterday － そのページが参照された回数（昨日分）を表示する

deleted 【削除ページの一覧】

種別

コマンド

重要度

★★☆☆☆

書式
?cmd=deleted
概要

削除されたページの一覧を表示する。

備考

公開Wikiの管理者にとっては誤操作や悪意をもった編集によるページ削除をチェックするのに重宝する。

diff 【差分表示】

種別

コマンド

重要度

★★★★★

書式
?cmd=diff&page=ページ名
概要

指定したページの現在の内容と最後のバックアップ状態との差分を表示する。ページ名はエンコードされていなければならない。

備考

最後のバックアップ以外との差分を表示する場合はbackupを利用する。

edit 【ページ編集】

種別

コマンド

重要度

★★★★★

書式
?cmd=edit&page=ページ名
概要

指定したページを編集する。

ページ名はエンコードされていなければならない。

filelist 【ページ／ファイル一覧】

種別

コマンド

重要度

★☆☆☆☆

書式
?cmd=filelist
概要

ページの一覧を各ページが記録されているファイル名と共に表示する。

備考

主として管理者がメンテナンス用途に使用する。

freeze 【ページ凍結】

種別

コマンド

ブロック型プラグイン

重要度

★★★☆☆

書式
?cmd=freeze&page=ページ名
#freeze
概要

対象のページを凍結し、不用意に変更できないようにします。

コマンドとして使用された場合は、page=で指定したページを凍結し、ブロック型プラグインとして使用された場合は編集したページを凍結します。

備考

ページ名はエンコードされている必要がある。

img

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#img(,clear)
概要

refプラグインに統合されたため、基本的に使用することはない。

テキストの回り込み解除のために残っている。

include 【指定ページ表示】

種別

ブロック型プラグイン

重要度

★★★☆☆

書式
#include(ページ名 [,title|,notitle])
概要

記述した位置に引数で指定したページを表示する。

引数
  • ページ名 
    表示したいページ名
  • title/notitle 
    タイトルの表示/非表示
--title(default)
タイトルを表示します。
--notitle
タイトルを表示しません。

includesubmenu 【サブメニュー表示】

種別

ブロック型プラグイン

重要度

★★☆☆☆

書式
#includesubmenu(ページ名表示)
概要

現在表示中のページによって、MenuBarに表示する内容を切り替える為に使用する。

表示中のページの下階層のSubMenuか、同階層にあるSubMenuページをインクルードするプラグイン。

  • ページ名表示に showpagename を指定すると、インクルードするページのページ名を表示し、省略時はページ名を非表示とする。

insert 【入力欄】

種別

コマンド

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#insert
概要

記述した位置に複数行入力欄とボタンを表示する。

ボタンを押下すると入力欄に入力した内容をページに挿入する。

interwiki

種別

コマンド

重要度

★☆☆☆☆

書式
?cmd=interwiki&page=ページ名
概要

InterWikiを記述した際にPukiWikiが内部的に呼び出します。使用者が意識して使用する機会はありません。

links 【ページ間キャッシュ更新】

種別

コマンド

重要度

★★☆☆☆（管理者）

書式
?plugin=links
概要

ページ間のキャッシュを更新します。通常使用する必要はありません。

メンテナンス作業などでページが記録されているファイルを直接操作した場合にキャッシュとページの記述内容の整合性がとれなくなるため、実行する必要があります。

備考

実行の際に管理者パスワードを要求されます。

list 【ページ一覧】

種別

コマンド

重要度

★★★★☆

書式
?cmd=list
概要

ページの一覧を表示する

lookup 【入力URLへ移動】

種別

コマンド

ブロック型プラグイン

重要度

★★★☆☆

書式
#lookup(ラベル,ボタン名,入力値)
概要

記述した位置に入力欄とボタンと表示し、ボタンを押下するとラベルと入力値から生成されたＵＲＬへジャンプします。

ＵＲＬを生成するルールはInterWikiと同様です。無理にInterWikiの記述に直すと［[ラベル:入力欄に入力した値]］となります。

ls 【階層化ページ一覧】

種別

ブロック型プラグイン

重要度

★★☆☆☆

書式
#ls([title])
概要

記述したページより階層化されているページのページ名を一覧表示します。

引数にtitleを指定するとページ名に加えてタイトルを表示します。タイトルは各ページの一行目の内容を表示します。省略時はタイトルを表示しません。

備考

より高機能なls2を使用する場合が多い。

ls2 【パターン合致ページ表示】

種別

コマンド

ブロック型プラグイン

重要度

★★★☆☆

書式
#ls2
#ls2(パターン,パラメータ,linkの別名表示)
概要

指定したパターンで始まるページ名を一覧表示します。

パターンには表示するページ名の共通部分を指定します。省略時は"記述したページ名/"となります。パターンを省略して以降のパラメータを指定する場合はカンマが必要です。

パラメータには表示方法のオプションを指定します。（順不同、半角カンマで区切って複数指定可、省略可）

  • title － ページに含まれる見出し(*,**,***)の一覧を併記します。
  • include － 下位層のページが#includeを使用していた場合、includeしているページの一覧を表示します。
  • reverse － ページの並び順を反転し、名前の降順に表示します。省略すると名前の昇順に表示されます。
  • compact － 見出しレベルを調整します。
  • link － #ls2を書いた位置にリンクを表示し、このリンクをたどることでページの一覧を表示するようにします。

    linkの別名表示には、パラメータlinkを指定した際に表示される、 '...'で始まるページの一覧の代わりに表示する文字列を指定します。省略時は '...'で始まるページの一覧となります。

備考

ls プラグインとの違いについて。

  • 階層化されたページの起点となるページが、lsでは記述したページ固定だが、ls2ではパラメータで指定できる。
  • titleパラメータを指定した場合に、lsでは「ページの一行目」が表示されるが、ls2では「見出しの一覧」を表示する。
  • include, link という表示オプションが追加されている。

    ページ名のソートにはnatcasesort()を使っているため、昇順の場合、半角英数字よりも漢字の方が先に表示されます。

map 【サイトマップ】

種別

コマンド

重要度

★☆☆☆☆

書式
?plugin=map[パラメータ]
概要

サイトマップの様にページ間のリンク関係を一覧表示します。

指定したページを起点に、リンクで辿れるページを全てツリー状に表示します。

パラメータには一覧表示方法のオプションを指定します。

  • &refer=ページ名 － 起点となるページを指定します。省略すると、サイトのトップページ(通常はFrontPage)が起点となります。
  • &reverse=true － どこへリンクしているかではなく、どこからリンクされているかを一覧表示します。 どこからもリンクされていないページは、画面の後半にまとめて表示されます。
  • &url=true － WikiName/BracketName/InterWikiNameに加えて、 ページに記入されているurl(http/https/ftp/mailto)を表示します。
備考

reverse=trueを指定したときは、url=trueを指定してもurlは表示されません。

md5 【入力をMD5変換】

種別

コマンド

重要度

★☆☆☆☆

書式
?plugin=md5&md5=文字列
概要

引数に指定した文字列に対するMD5値を表示します。

備考

pukiwiki.ini.phpに指定するPukiWikiの管理者パスワードはパスワードのMD5値で指定しますが、このプラグインを利用すると楽に取得できます。

memo 【メモ】

種別

コマンド

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#memo
概要

記述した位置に複数行入力欄とボタンを表示する。

ボタンを押下すると入力欄の記述内容を更新する。

備考

insertプラグインやarticleプラグインと似ているが、入力した内容が入力欄の外へ出力されず、入力欄に留まる点が異なる。

個人用のメモ代わりにPukiWikiを利用している場合、未整理の情報を一時的に溜め込むのに重宝する。

navi 【ナビゲーションバー表示】

種別

ブロック型プラグイン

重要度

★★☆☆☆

書式
#navi(目次ページ)
概要

DocBook風ナビゲーションバーを表示する。

目次となるページに下階層のページが存在する時、それら全てのページ（の先頭と末尾）に記述する事で Prev, Home, Next というリンクを表示します。これによって下階層のページを順に参照するのに便利になります。

目次ページに順番に見て回るページの上階層にあたるページを指定します。

例えば hoge, hoge/1, hoge/2, hoge/3 というページが存在する場合、hoge/2に#navi(hoge)を記述するとhogeに移動するHomeというリンク、hoge/1に移動するPrevというリンク、hoge/3に移動するNextというリンクを表示します。

new 【new表示】

種別

インライン型プラグイン

重要度

★★☆☆☆

書式
&new(日時);
概要

日時に指定した内容が規定の日付以内であった場合にNewと表示します。

標準では5日以内の場合に New を、１日以内の場合に New! を表示します。期間や表示する文字列のパターンは設置者によってカスタマイズ可能です。

日時はPHP関数:strtotimeが認識できる書式である必要があります。

備考

commentプラグインと組み合わせて使用するのが一般的です。

newpage 【新規ページの作成】

種別

コマンド

ブロック型プラグイン

重要度

★★★★★

書式
?plugin=newpage[パラメータ]
#newpage(ページ名初期値)
概要

ページを新規作成するか、新規作成するページ名の入力欄を表示します。

パラメータには新規作成するページのオプションを指定します。ページ名はエンコードされている必要があります。（複数指定可、省略可）

  • &refer=ページ名 － 関連ページ名を指定します。新規作成するページの先頭に、ここで指定したページへのリンクが自動的に埋め込まれます。
  • &page=ページ名 － 新規作成するページ名を指定します。省略時は新規作成するページ名の入力するためのページを表示します。

    ページ名初期値には新規作成するページ名を入力する入力欄に初期表示する文字列を指定します。

norelated 【関連ページの表示】

種別

ブロック型プラグイン

重要度

★★★☆☆

書式
#norelated
概要

ページ下部に表示される関連ページのリンクを非表示にします。

備考

極端に多くのページからリンクされていて関連リンクの表示が目障りである場合などに利用します。

online 【同時参照者数表示】

種別

ブロック型プラグイン

インライン型プラグイン

重要度

★★☆☆☆

書式
#online
&online;
概要

現在PukiWikiを参照している、おおよそのユーザー数を表示します。

ユーザー数は、プラグインを呼び出された時点で記録されたＩＰアドレスとタイムスタンプのうち、５分以内(変更可能)にアクセスのあったアドレスの数です。

備考

ユーザー数のカウントはページ単位でなく、設置されたPukiWiki毎に行っているため、MenuBarなど頻繁に呼び出される場所に記述するかスキンに埋め込むのが普通です。

paint 【絵の添付】

種別

コマンド

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#paint(幅,高さ)
概要

Javaアプレットで描いた絵を、そのページに添付します。

ば科学的愛情で配布されているBBSPainter.jarを使用しています。

幅と高さに、デフォルトのキャンバスサイズを指定します。省略時は(80,60)となります（変更可能）

備考

-pukiwikiのインストールディレクトリに上記BBSPainter.jarを入れるのを忘れないでください。このプラグインが何の役にも立たなくなります。

pcomment 【コメント記入】

種別

コマンド

ブロック型プラグイン

重要度

★★★☆☆

書式
#pcomment(コメント記録ページ,表示件数,パラメータ)
概要

別ページにコメントを記録して、参照ページに最新の数件だけを表示します。枝にコメントを付けることもできます。

コメント記録ページにはコメントを記録するページ名を指定します。省略すると、pcommentで指定された[ベースページ名/カレントページ名]にコメントが記録されます。指定したページが存在しなくても、最初のコメント記録時に作成されます。

参照先ページに表示するコメントの数を指定します。第1レベルの番号なしリストだけをカウントします。
省略すると、pcommentのデフォルト(通常10件。変更可能)が表示されます。
pageを省略してcountを指定するときは、パラメータの最初にカンマが必要です。

パラメータにはコメントの表示方法、入力方法を指定します。

  • noname － 名前の入力欄を表示しません。
  • nodate － 日付を挿入しません。
  • above － 挿入したコメントをフォームの上に表示します。コメントは上が古く、下に向かって新しい順に並びます。
  • below － 挿入したコメントをフォームの下に表示します。コメントは下が古く、上に向かって新しい順に並びます。
  • reply － コメントの頭にラジオボタンを表示します。あるコメントに対するリプライが、そのコメントのラジオボタンをチェックすることで可能になります。
備考

更新が衝突したときは、予期せぬ場所にコメントが挿入されるのを防ぐため、リプライ先を指定して記入したコメントはaboveまたはbelowの設定にしたがって 一番前か一番後ろに追加されます。

コメント記入後に表示されるページのタイトルに「(#pcommentを書いたページ)を更新しました」と表示されますが、実際に更新されたのはコメントを記録するページです。

コメントを投稿しても、#pcommentが書かれたページは更新されないので、最終更新ページにはコメントを記録したページだけが更新として表示されます。

相対参照([ [../] ]など)は、書いたページと書き込まれたページのどちらかで、意図したとおりに変換されない可能性があります。

popular 【人気のあるページを列挙】

種別

ブロック型プラグイン

重要度

★★☆☆☆

書式
#popular([件数],[対象外ページ],[今日?フラグ])
概要

よく参照される（人気のある）ページの上位数件を表示します。

件数には一覧の数を指定して下さい。省略時は10件(変更可能)です。

対象外ページには、表示対象外とするページを正規表現で指定します。例えば FrontPage や MenuBar などのページを一覧に表示させたくないときに使用します。

今日人気のページを表示させたい場合は「今日?フラグ」を true に設定して下さい。デフォルトは false (合計アクセス数)です。

備考

プラグイン/counter のカウンター情報を利用しているので、#counter 記述のないページは表示されません。

random 【ランダムなページを表示】

種別

コマンド

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#random(メッセージ)
概要

ランダムなページを表示するプラグイン。

表示するページの候補は設置したページの下階層のページです。

メッセージにはリンクに表示する文字列を指定します。省略時は 'press here.' となります。（変更可）

備考

ブラウザの再読み込み対策はしていません。リロードされるたびにランダムな表示を繰り返します。

read 【ページを表示】

種別

コマンド

重要度

★★★★★

書式
?cmd=read&page=ページ名
概要

指定したページを表示する。該当ページが存在しない場合は編集状態で開き、ページ名がInterWikiであった場合は、その解決を行う。

plugin=やcmd=が指定されていない場合に内部で暗黙に呼び出されるため、利用者が意識する機会は少ない。

備考

ページ名はエンコードされている必要がある。

recent 【最新の数件を表示】

種別

ブロック型プラグイン

重要度

★★★★★

書式
#recent(件数)
概要

最近更新されたページのうち、最新の数件を表示します。

件数には表示件数を指定します。省略時は10件です。

ref【添付ファイルの展開】

種別

ブロック型プラグイン

インライン型プラグイン

重要度

★★★★☆

書式
#ref(ファイル名,ページ,パラメータ,タイトル])
&ref(ファイル名,ページ,パラメータ,タイトル]);
概要

'#attach'でページに添付されたファイルを指定位置に展開します。

引数
  • ファイル名 
    ページに添付したファイル名を指定します（省略時はエラーとなります）。
別ページ名/添付ファイル名とする事で別ページの添付ファイルも指定できます。
  • ページ 
    ファイルを添付したページをWikiNameかBracketNameで指定します。
このオプションは最初(添付ファイル名の次)に記述してください。
省略時は記述したページです。
  • パラメータ 
    ファイルの展開方法を指定できます。
    • left|center|right － 表示時の位置を指定します。省略時はleft(変更可)です。
    • wrap|nowrap － テーブルタグで囲む/囲まないの指定を行います。省略時はnowrap(変更可)です。
    • around － テキストの回り込みを可能とします。省略時は回り込みを行いません。
    • noicon － ファイルが画像以外の場合に表示されるアイコンを表示しません。省略時は表示します。
    • noimg － ファイルが画像の場合に画像を展開しないようにします。省略時は展開します。
    • nolink － 元ファイルへのリンクを張らないようにします。省略時はリンクします。
    • zoom － 縦横比を保持します。省略時はサイズ指定に従います。
    • 999x999 － サイズを指定します(幅x高さ)。省略時は拡大率あるいは対象画像のサイズに従います。
    • 999% － サイズを指定(拡大率)します。省略時は100%です、
    • 上記以外 － 上記以外のパラメータは画像の代替文字列、リンクのタイトル属性として使用されます。ページ名やパラメータに見える文字列を使用するときは、#ref(hoge.png,,zoom)のようにタイトルの前にカンマを余分に入れます。
備考

aroundで行った回り込み指定を解除するには imgプラグインを ＃img(,clear) の様に使用して下さい。

rename【ページ名変更】

種別

コマンド

重要度

★★★☆☆

書式
?plugin=rename&refer=ページ名
概要

既存ページの名前を変更します。実行には管理者権限が必要です。

ページの本文のほか、指定されたページ名の差分、バックアップ、添付ファイル、カウンターを一気にリネームします。

ページ名には変更するページの名前を指定します。省略時はページ名の選択または正規表現置換用文字列入力画面が表示されます。

変換結果は：RenameLogページに実行結果を追記されます。

備考

ページ内のリンクの書き換えは行ないません。yetlistなどを駆使して対処してください。

リネーム対象のページが凍結されているかどうかはチェックしていません。

関連ページにリネーム対象の文字列が複数含まれているとおかしくなります。

  • たとえば、hogeおよびhoge/hogeという二つのページがあったときに、hogeページをfugaに(関連ページを含んで)リネームすると、hoge/hogeページの名前がfuga/fugaになってしまいます。

rss 【RSS0.91変換】

種別

コマンド

重要度

★☆☆☆☆

書式
?cmd=rss
#rss
概要

RecentChangesをRSS(RDF Site Summary)0.91に変換して出力します。

備考

RSSはサイトの要約を提供するのに使われるXMLフォーマットです。

rss10 【RSS1.0変換】

種別

コマンド

重要度

★☆☆☆☆

書式
?cmd=rss10
概要

RecentChangesをRSS(RDF Site Summary)1.0に変換して出力します。

ruby 【ルビ】

種別

インライン型プラグイン

重要度

★☆☆☆☆

書式
&ruby(ルビ){ルビをふる文字列};
概要

文字列にルビをふります。

備考

XHTML 1.1のルビに対応したブラウザでないと、ルビとして表示されません。IE5.5/6では表示できます。Netscape 7/MozillaではXHTML Ruby Supportを組み込めば表示できます。

ルビに対応していないブラウザではルビをふる文字列の直後にルビが( )に入れられて表示されます。

search 【検索】

種別

コマンド

重要度

★★★★★

書式
?cmd=search[パラメータ]
概要

指定した文字列を含むページの検索を行います。

パラメータには検索条件を指定します。(複数指定可、順不同、省略可)

  • word － 検索する文字列を指定します。
  • type － 'OR' 指定時、OR検索を行います。(省略時はAND検索)

server【サーバー情報表示】

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#server
概要

サーバーの情報(サーバー名、サーバーソフトウエア、サーバー管理者)を表示します。

showrss【RSS取得・表示】

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#showrss(RSSへのパス, テンプレート名, キャッシュ生存時間, 更新日表示フラグ)
概要

指定されたRSSを取得し、一覧表示します。

ページの解釈毎にRSSの取得を行う為、頻繁に参照されるページでshowrssを使用される場合はキャッシュ機能を使うことをお勧めします。相手サイトの更新頻度に応じてキャッシュの生存時間を適宜設定して下さい。

RSSへのパスにはRSSへのファイルパスやURLを指定します。(省略不可)

テンプレート名には取得したRSSの表示方法を指定します。default, menubar, recentが指定できます。（省略時はdefault）

キャッシュ生存時間はキャッシュをクリアする期限（１時間単位）です。省略時、キャッシュ機能は無効となります。

更新日表示フラグはRSSを取得した日付を表示するかどうかを指定します。1を指定した場合のみ表示します。

size 【文字サイズ指定】

種別

インライン型プラグイン

重要度

★★★☆☆

書式
&size(ピクセル数値){文字列}
概要

文字の大きさを指定します。

ピクセル数値には文字の大きさを指定します。

文字列は文字の大きさを変更する文字列を指定します。

source 【ソース表示】

種別

コマンド

重要度

★☆☆☆☆

書式
?cmd=source&page=ページ名
概要

指定したページの整形前のソースを表示します。

備考

ページ名はエンコードされている必要があります。

template 【テンプレートから新規ページ作成】

種別

コマンド

重要度

★☆☆☆☆

書式
?plugin=template&refer=テンプレートページ
概要

既存のページをテンプレートとしてページを新規作成します。

テンプレートページには雛形とするページを指定します。(省略不可)

ページの新規作成時の雛形とするページの読込み機能とは、テンプレートプラグインが雛形とする範囲(行単位)に選択できるのに対して、ページの新規作成では全文をテキストエリアにコピーする点が異なります。

備考

ページ名はエンコードされている必要があります。

touchgraph【インデックス作成】

種別

コマンド

重要度

★☆☆☆☆

書式
?plugin=touchgraph
概要

TouchGraphWikiBrowser用のインデックスを作ります。

tracker【bugtrack表示】

種別

ブロック型プラグイン

重要度

★★☆☆☆

書式
#tracker
概要
bugtrackプラグインの汎用化版です。。入力項目、フォームのデザイン、リストの
デザインを自由に設定できます。
備考

詳細はしろくろのへや:tracker.inc.phpを参照してください。

unfreeze【凍結を解除】

種別

コマンド

重要度

★★★☆☆

書式
?plugin=unfreeze&page=ページ名
概要

ページの凍結を解除します。

ページ名には解除するページ名を指定します。

備考

ページ名はエンコードされている必要があります。

version 【バージョン表示】

種別

ブロック型プラグイン

インライン型プラグイン

重要度

★☆☆☆☆

書式
#version
&version;
概要

インストールされているPukiWikiのバージョンを表示する。

versionlist【PHPバージョン表示】

種別

コマンド

ブロック型プラグイン

重要度

★☆☆☆☆

書式
?plugin=versionlist
#versionlist
概要

pukiwiki.phpのあるディレクトリとpluginのディレクトリ内のphpファイルのバージョンを表示する。

vote 【投票フォームを表示】

種別

コマンド

ブロック型プラグイン

重要度

★★☆☆☆

書式
#vote(選択肢１[0],選択肢２[0],選択肢３[投票数][0],[[WikiName]][投票数]…[0])
概要

選択肢と投票ボタンが並んだフォームを表示します。

選択肢には文章の他、WikiName/BracketNameを使用できます。

備考

各選択肢の投票数は容易に改竄できるため、厳密な投票には向きません。

yetlist【未作成ページを表示】

種別

コマンド

重要度

★★☆☆☆

書式
?plugin=yetlist
概要

まだ作られていないページを一覧表示する。

既存のページでWikiNameあるいはBracketNameで指定されているが、まだ作られていないページを一覧表示します。

備考

自分以外の誰かがページを書くかもしれないという点は非常にWiki的ですが、実際の運用面ではcommentに記述された一見さんの名前やWikiName同様のパラメータ名など、ページ化しにくいキーワードが大量に引っかかってしまいます。