:wiki/help/plugin

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

プラグイン名

種別

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

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

重要度

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

書式

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

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

概要

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

引数

引数の詳細な説明です。

プラグイン内設定

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

備考

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

標準プラグイン

Plugin名	サマリ
add?	指定した既存ページの末尾に編集欄で入力した内容を追加。
amazon?	アマゾンが提供する商品のイメージと、商品名を表示。
aname?	指定した位置にアンカー(リンクの飛び先)を設定。
article?	指定した位置に簡易掲示板を設置。
attach?	ページの添付ファイルの一覧を表示し、ファイル添付のための入力フォームを設置。
back?	指定した位置に戻り先へのリンクを設置。
backup?	指定したページ、あるいは全体のバックアップ一覧を表示。
br?	文章中で改行を行う。
bugtrack?	バグ追跡システムの一部分であるバグレポートの入力フォームを設置。
bugtrack_list?	バグ追跡システムの一部分であるバグレポートの一覧表示を行う。
calendar?	指定した位置にカレンダーを設置。
calendar_edit?	指定した位置にカレンダーを設置。
calendar_read?	指定した位置にカレンダーを設置。
calendar_viewer?	calendarプラグインまたはcalendar2プラグインで作成されたページを指定した位置に表示。
calendar2?	指定した位置にカレンダーを設置。
clear?	refプラグインのaroundオプションで有効となったテキスト回り込み指定を解除。
color?	Inline要素(主に文章)の、文字色・背景色を指定。
comment?	コメントの入力用の入力欄を表示。
contents?	設置したページ中の見出しの一覧を表示。
counter?	設置したページの参照回数を表示。
deleted?	削除されたページの一覧を表示。
diff?	指定したページの現在の内容と最後のバックアップ状態との差分を表示。
dump?	指定ディレクトリ内のファイルをまとめてtar(tar.gz, tgz)形式でバックアップ/リストア。
edit?	指定したページを編集。
filelist?	ページの一覧を各ページが記録されているファイル名と共に表示。
freeze?	対象のページを凍結。
hr?	文中に水平線を挿入。
img?	添付ファイル以外の画像を表示。
include?	記述した位置に指定したページを挿入。
includesubmenu?	MenuBarに表示する内容を切り替える。
insert?	記述した位置に複数行入力欄とボタンを表示。
interwiki?	InterWikiを使用する。
lastmod?	指定したページの最終更新日時を表示。
links?	ページ間のキャッシュを更新。
list?	ページの一覧を表示。
lookup?	interwikinameと入力値から生成したURLへ移動。
ls?	記述したページより階層化されているページのページ名を一覧表示。
ls2?	指定したパターンで始まるページ名を一覧表示。
map?	サイトマップの様にページ間のリンク関係を一覧表示。
md5?	引数に指定した文字列に対するMD5値を表示。
memo?	記述した位置に複数行入力欄とボタンを表示。
menu?	ページの左側にメニュー用のページ(MenuBar)を表示。
navi?	DocBook風ナビゲーションバーを表示。
new?	指定した日時が最近であった場合、最近更新された事を強調表示。
newpage?	ページを新規作成するか、新規作成するページ名の入力欄を表示。
norelated?	ページ下部に表示される関連ページのリンクを非表示。
online?	現在PukiWikiを参照している、おおよそのユーザー数を表示。
paint?	Javaアプレットで描いた絵を、そのページに添付。
pcomment?	別ページにコメントを記録して、pcommentを設置した場所に最新の数件だけを表示。
popular?	参照回数の多いページの上位数件を表示。
random?	ランダムなページへのリンクを表示。
read?	指定したページを表示。
recent?	最近更新されたページのうち、最新の数件を表示。
ref?	JavaScript を有効にしてください
referer?	ページを照会した利用者の参照元URL(Referer)の一覧を表示。
related?	対象のページを参照しているページの一覧を表示。
rename?	既存ページの名前を変更。
rss?	RecentChangesをRSSに変換して出力。
rss10?	RecentChangesをRSS(RDF Site Summary)1.0に変換して出力。
ruby?	文字列にルビをふる。
search?	検索文字列の入力フォームを表示。
server?	サーバーの情報(サーバー名、サーバーソフトウエア、サーバー管理者)を表示。
setlinebreak?	入力文章中の改行を改行とみなすかどうかを設定。
showrss?	指定されたRSSを取得し、一覧表示。
size?	文字の大きさを指定。
source?	指定したページの整形前のソースを表示。
stationary?	プラグイン作成用ひな形。
tb?	TrackBackの一覧を表示。
template?	既存のページをテンプレートとしてページを新規作成。
topicpath?	ページの階層表現のユーザーインターフェースを提供。
touchgraph?	TouchGraphWikiBrowser用のインデックスを作る。
tracker?	定型的な項目をもったページを作るための入力フォームを表示。
tracker_list?	trackerプラグインで作成したページを一覧表示。
unfreeze?	ページの凍結を解除。
update_entities?	CACHE_DIR/entities.dat を生成。
version?	インストールされているPukiWikiのバージョンを表示。
versionlist?	pukiwiki.phpのあるディレクトリとpluginのディレクトリ内のphpファイルのバージョンを表示
vote?	選択肢と投票数と投票ボタンが並んだ簡易投票フォームを表示。
yetlist?	まだ作られていないページを一覧表示。

Plus!標準プラグイン

追加プラグイン