楽wiki

楽にページとデータを作成、管理できるwiki

プラグインマニュアル


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

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

プラグイン名

種別

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

  • ブロック型プラグイン − ブロック型プラグインでの呼び出しが可能である事を示します。
  • インライン型プラグイン − インライン型プラグインでの呼び出しが可能である事を示します。
重要度

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

書式

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

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

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

引数

引数の詳細な説明です。

プラグイン内設定

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

備考

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

A

amazon

種別

インライン型プラグイン

ブロック型プラグイン

書式

&amazon(
ASIN番号
);

#amazon

#amazon(,
clear
)

#amazon(
ASIN番号,
[left|right],
[タイトル|image|delimage|deltitle|delete]
)

概要

アマゾン(http://www.amazon.co.jp)が提供する商品のイメージと、商品名を表示します。

アマゾンのアソシエイト ID(紹介文などを書くことで副収入がもらえるかもしれない仕組み)に対応しています。 ASIN を入力するだけで、予め作成した定型作品紹介フォーマットを自動生成することができます。

引数

全ての引数を省略すると、ブックレビュー作成フォームが現れます。「書評」というページにこれを置くと「書評/ASIN番号」という子ページを作ります。

left,right,clear で商品のイメージとタイトルの出力方式を指定します。

  • left|right − 表示時の位置を指定します。省略時はrightです。
  • clear − テキスト回り込み指定を解除します。
タイトル,image で表示内容を指定します。
  • タイトル − 商品のタイトルを指定します。省略時は自動取得します。
  • image − 商品のイメージのみ表示します。省略時はイメージとタイトルを表示します。
delimage,deltitle,delete でキャッシュの削除を行います
  • delimage − 対応するイメージキャッシュを削除します。
  • deltitle − 対応するタイトルキャッシュを削除します。
  • delete − 対応するイメージキャッシュ,タイトルキャッシュを削除します。
備考

著作権が関連する為、アマゾンのアソシエイトプログラムを確認の上ご利用下さい。

aname

種別

インライン型プラグイン

ブロック型プラグイン

重要度

★★★★☆

書式

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

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

概要

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

引数

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

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

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

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

article

種別

(コマンド)

ブロック型プラグイン

重要度

★★★☆☆

書式
#article
概要

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

attach

種別

(コマンド)

ブロック型プラグイン

重要度

★★★★★

書式
#attach(
[nolist]
[,noform]
)
概要

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

引数

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

  • nolist − ページの添付ファイルの一覧を表示しません。省略時は一覧を表示します。
  • noform − ファイル添付のための入力フォームを表示しません。省略時は入力フォームを表示します。
プラグイン内設定

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

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

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


B

back

種別

ブロック型プラグイン

重要度

★☆☆☆☆

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

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

引数

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

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

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

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

  • 0 − 水平線を表示しません。
  • 1 − 水平線を表示します。

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

backup

種別

コマンド

重要度

★★★★★

書式
?cmd=backup
[&page=ページ名]
概要

指定したページ、あるいは全体のバックアップ一覧を表示します。

引数

ページ名を省略すると、PukiWiki全体のバックアップ一覧を表示します。ページ名はエンコードされている必要があります。

br

種別

ブロック型プラグイン

インライン型プラグイン

重要度

★★☆☆☆

書式

#br

&br;

概要

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

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

bugtrack

種別

(コマンド)

ブロック型プラグイン

重要度

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

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

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

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

引数

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

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

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

プラグイン内設定

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

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

bugtrack_list

種別

ブロック型プラグイン

重要度

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

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

書式
#bugtrack_list(
[ページ名]
)
概要

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

引数

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

備考

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

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

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


C

calendar、calendar_edit、calendar_read

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式

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

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

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

概要

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

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

引数

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

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

備考

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

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

calendar_viewer

種別

(コマンド)

ブロック型プラグイン

重要度

★★★☆☆

書式
#calendar_viewer(
ページ名,
yyyy-mm|
n|
x*y|
this
[,[past|future|view]
[,年月日表示の区切り文字]]
)
概要

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

引数

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

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

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

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

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

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

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

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

プラグイン内設定

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

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

calendar2

種別

(コマンド)

ブロック型プラグイン

重要度

★★★☆☆

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

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

引数

ページ名で表示するページの上位階層のページを指定できます。ページ名を省略すると設置したページのページとなります。ページ名に*を指定すると上位階層のページはなし(表示するページ名がyyyy-mm-dd)となります。

yyyymmで表示するカレンダーの西暦と月を指定できます。省略時は当日の年月となります。

offを指定時、当日分ページを表示する機能は抑制されます。省略時は当日分のページを表示します。

備考

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

clear

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#clear
概要

refプラグインのaroundオプションで有効となったテキスト回り込み指定を解除します。

備考

imgプラグインのclearオプション指定時と処理内容は同等です。

color

種別

インライン型プラグイン

重要度

★★★★☆

書式

&color(
[文字色]
[,背景色]
){
文章
};

概要

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

引数

文字色・背景色はそれぞれ色名(red、blueなど)、シャープで始まる3桁の16進数値(#000〜#FFF)、同じく6桁の16進数値(#000000 〜 #FFFFFF)のいずれかで指定することができます。大文字小文字は問いません。

文字色・背景色の両方を省略する事はできません。一方を省略した場合は省略した側の色の変更はされません。

プラグイン内設定

  • PLUGIN_COLOR_ALLOW_CSS 色の変更に(fontタグではなく)CSSを利用する
  • PLUGIN_COLOR_USAGE エラー時に表示される使用方法
  • PLUGIN_COLOR_REGEX 引数に指定できる色の正規表現
備考

以下、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 − 入力したコメントがコメント入力欄の下に追加します(省略時はaboveが指定されたとみなします)
  • nodate − 挿入するコメントに、挿入時刻を付加しない(省略時は付加します)
  • noname − コメント記入者名の入力欄を非表示とします(省略時は表示します)
プラグイン内設定

  • 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

種別

ブロック型プラグイン

重要度

★★★☆☆

書式

#contents

概要

設置したページ中の見出しの一覧を表示します。

counter

種別

ブロック型プラグイン

インライン型プラグイン

重要度

★★★☆☆

書式

#counter

&counter(
[total|
today|
yesterday]
);

概要

設置したページの参照回数を表示します。

引数

カウンタ表示方法として total, today, yesterday いずれかを指定します。省略時はtotalが指定されたとみなします。ブロック型プラグインでは常にtotalが指定されたとみなします。

  • total − そのページが参照された回数の総計を表示します。
  • today − そのページが参照された回数(当日分)を表示します。
  • yesterday − そのページが参照された回数(昨日分)を表示します。
備考

すべてのページで参照回数を表示したい場合は、MenuBarやスキンからcounterプラグインを呼び出してください。


D

deleted

種別

コマンド

重要度

★★☆☆☆

書式
?plugin=deleted
{[&dir=diff|
backup]
[&file=on]}
概要

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

引数

file=onを指定時、バックアップ(あるいは差分)のファイル名を出力します。省略時は表示しません。

dirで削除の判定方法を指定します。省略時はbackupです。

  • backup − バックアップが存在し、ページが存在しない時に削除されたとみなします
  • diff − 差分が存在し、ページが存在しない時に削除されたとみなします
備考

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

diff

種別

コマンド

重要度

★★★★★

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

指定したページの現在の内容と最後のバックアップ状態との差分を表示します。

引数

ページ名に変更差分を表示するページを指定します。ページ名はエンコードされていなければなりません。

備考

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

dump

種別

コマンド

重要度

★☆☆☆☆

書式

?plugin=dump

概要

指定ディレクトリ内のファイルをまとめてtar(tar.gz, tgz)形式でバックアップ/リストアします。

バックアップ/リストアの実行には管理者パスワードが必要です。

バックアップはファイル名をページ名に変換して取得する事ができます。
この変換でリストアには利用出来なくなりますが、
ファイル名からページ名の類推は容易になります。

バックアップは取得するディレクトリを任意に指定する事ができます。

リストアは該当ファイルの上書きによって行われます。
そのため、ファイルの削除を行う事はできません。

バックアップ/リストア対象として指定可能なディレクトリは、以下の通りです。

  • DATA_DIR (wiki/*.txt)
  • UPLOAD_DIR (attach/*)
  • BACKUP_DIR (backup/*)
プラグイン内設定

  • PLUGIN_DUMP_ALLOW_RESTORE リストアを許可するかどうか
  • PLUGIN_DUMP_FILENAME_ENCORDING ページ名をディレクトリ構造に変換する際の文字コード
  • PLUGIN_DUMP_MAX_FILESIZE 最大アップロードサイズ(Kbyte)
  • PLUGIN_DUMP_DUMP バックアップ時にプラグイン内で利用する引数
  • PLUGIN_DUMP_RESTORE リストア時にプラグイン内で利用する引数
備考

PukiWikiが内部管理するファイルを直接取得/更新するという性質上、
セキュリティ上の問題を引き起こす可能性があります。十分ご注意ください。

DATA_DIRのリストアを行った場合は、linksプラグインで
ページ間のリンク情報キャッシュを更新する必要があります。

E

edit

種別

コマンド

インライン型プラグイン

重要度

★★★★★

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

&edit(
[ページ名
{[,nolabel]
[,noicon]}]
){
ラベル名
};

概要

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

引数

コマンド型の記述では、ページ名に編集するページを指定します。ページ名はエンコードされていなければなりません。

インライン型の記述では、ページ名は編集するページを指定します。省略時は設置したページです。

nolabel,noicon,ラベル名 でリンクの表示方法を指定します。

  • nolabel − 編集用リンクの文字列をnoicon 指定時は短縮表記、未指定時は省略します。
  • noicon − 編集用リンクに画像を表示しません。
  • ラベル名 − 編集用リンクの文字列として表示する文字列を指定します。

F

freeze

種別

コマンド

(ブロック型プラグイン)

重要度

★★★☆☆

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

#freeze

概要

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

引数

ページ名には凍結するページを指定します。ページ名はエンコードされている必要があります。コマンド型でfreezeプラグインを実行するとブロック型プラグインが凍結対象のページ先頭に挿入(凍結解除の場合は削除)されます。

ブロック型のfreezeプラグインはPukiWikiが内部的に利用するもので、基本的に利用者が意識する機会はありません。

H

hr

種別

ブロック型プラグイン

重要度

★★☆☆☆

書式
#hr
概要

文中に水平線を挿入します。

備考

段落やリスト、テーブル内など、通常の水平線書式(----)ではブロックを抜けてしまう個所で水平線を挿入するために用います。リスト内など左右マージンが設定されている場合は、それを引き継ぎます。


I

img

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#img(
画像URL[,
right|
r|
left|
l|
clear|
c,[
clear|
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

種別

ブロック型プラグイン

重要度

★★★☆☆

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

記述した位置に指定したページを挿入して、複数のページをあたかも1つのページであるかのように表示します。

引数

ページ名には挿入するページを指定します。

第2引数にnotitleを指定すると、ページ名の表示を抑制します。titleはその逆です。

includesubmenu

種別

ブロック型プラグイン

重要度

★★☆☆☆

書式
#includesubmenu(
[showpagename]
)
概要

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

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

引数

showpagename を指定すると、挿入表示するページのページ名を表示します。省略時はページ名を非表示とします。

insert

種別

(コマンド)

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#insert
概要

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

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

プラグイン内設定

  • INSERT_COLS 編集欄の表示幅
  • INSERT_ROWS 編集欄の表示行数
  • INSERT_INS 入力内容を入力欄の前後どちらに挿入するか

interwiki

種別

コマンド

重要度

★☆☆☆☆

書式
?cmd=interwiki
&page=InterWiki名
概要

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

引数

InterWiki名にはジャンプ先をInterWiki形式で指定します。InterWiki名はエンコードされている必要があります。

L

lastmod

種別

インライン型プラグイン

重要度

★☆☆☆☆

書式

&lastmod(
[ページ名]
);

概要

指定したページの最終更新日時を表示します。

引数

ページ名には最終更新日時を表示したいページ名を指定します。
省略時は設置したページとみなします。

list

種別

コマンド

重要度

★★★★☆

書式
?cmd=list
概要

ページの一覧を表示します。

lookup

種別

(コマンド)

ブロック型プラグイン

重要度

★★★☆☆

書式
#lookup(
interwikiname
[,ボタン名
[,入力欄の初期値]]
)
概要

記述した位置にテキスト入力欄とボタンを表示します。任意の文字列を入力してボタンを押すと、interwikinameと入力値から生成したURLへ移動します。これによって、検索エンジンにクエリを送信したり、番号をタイプするだけで該当するアーカイブにアクセスすることなどが可能になります。

URLの生成にはInterWikiを利用します。このプラグインが生成するURLは、以下のようなInterWikiと同じです。InterWikiNameのページに、あらかじめURLの生成に使用するInterWikiNameを設定しておく必要があります。

[[interwikiname:入力欄の値]]

入力欄が空欄(空文字列)のときは、ボタンを押しても動作しません。必ず何らかの文字列を入力する必要があります。

引数

interwikiname: InterWikiNameに設定した値の一つを指定します。

ボタン名: ボタンに表示するキャプションを指定します。省略時は'lookup'です。

入力欄の初期値: 初期値を指定したい場合に記入します。省略時は空文字列になります。

プラグイン内設定

  • PLUGIN_LOOKUP_USAGE 引数未指定時に表示されるヘルプ

ls

種別

ブロック型プラグイン

重要度

★★☆☆☆

書式
#ls(
[title]
)
概要

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

引数

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

備考

実際には、より高機能なls2を使用する機会が多いと思われます。

ls2

種別

(コマンド)

ブロック型プラグイン

重要度

★★★☆☆

書式
#ls2(
[[パターン]
[,
{
[title],
[include],
[reverse],
[compact],
[link]
}
[,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()を使っているため、昇順の場合、半角英数字よりも漢字の方が先に表示されます。


M

map

本wikiでは使用できません。

memo

種別

(コマンド)

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#memo
概要

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

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

プラグイン内設定

  • MEMO_COLS 編集欄の表示桁数
  • MEMO_ROWS 編集欄の表示行数
備考

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

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

menu

種別

ブロック型プラグイン

重要度

★★★★☆

書式
#menu(
ページ名
)
概要

デフォルトのスキンにて、ページの左側にメニュー用のページ(MenuBar)を表示するために内部的に使用されています。

任意のページでブロック型プラグインとして使用すると、引数に指定したページをメニュー用ページに指定できます。

例えば通常はMenuBarを表示するサイトで、hogeというページだけはMenuBarの代わりにhogeMenuというページを表示したい場合、hogeというページに #menu(hogeMenu) と記述する事で実現できます。

ソース中の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 を変更して下さい。


N

navi

種別

ブロック型プラグイン

重要度

★★☆☆☆

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

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

引数

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

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

ページで最初に呼び出した場合はヘッダイメージのリンクを出力します。ページで2度目以降に呼び出された場合はフッタイメージのリンクを出力します。現在のページが目次ページである場合は対象となるページの一覧を表示します。

new

種別

インライン型プラグイン

重要度

★★☆☆☆

書式
書式1:
&new(
[nodate]
){
日付文字列
};
書式2:
&new(
[ページ名]
[,nolink]
);
概要

指定した日時が最近であった場合、最近更新された事を強調表示します。日時の指定は直接日付時刻を記述する方法(書式1)と、指定したページ(群)の最終更新日時を採用する方法(書式2)の2通りがあります。

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

引数

書式1:

日付文字列を指定した場合、その日時が規定の期間内であった場合に強調表示します。省略した場合はページの更新日時をチェックする記述であると見なされます。

  • nodate − 日付文字列を表示しません。省略時は表示します。

書式2:

ページ名を指定した場合は、そのページの更新日時が規定の期間内であった場合に強調表示します。省略した場合は、プラグインを記述したそのページを指定したと見なします。

ページ名末尾が/であった場合、そのページ名で始まるページ群の中で最後の更新日時が規定の日付以内であった場合に強調表示します。

  • nolink − ページ名を表示しません。省略時はページ名(ページ群で指定した場合は最後に更新されたページ名)を表示します。
プラグイン内設定

  • PLUGIN_NEW_DATE_FORMAT 表示フォーマット
備考

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

newpage

種別

コマンド

ブロック型プラグイン

重要度

★★★★★

書式
?plugin=newpage
&page=ページ名
&refer=関連ページ名

#newpage(
[ページ名初期値]
)

概要

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

引数

コマンド:

パラメータには新規作成するページのオプションを指定します。

ページ名には新規作成するページ名を指定します。省略時は新規作成するページ名の入力するためのページを表示します。ページ名はエンコードされている必要があります。

関連ページ名にはリンク元のページ名を指定します。新規作成するページの先頭に、ここで指定したページへのリンクが自動的に埋め込まれます。ページ名はエンコードされている必要があります。

ブロック型プラグイン:

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

nofollow

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式

#nofollow

概要

記述したページが凍結されている場合、ヘッダーに「NOFOLLOW」「NOINDEX」オプションを追加させます。

これらのオプションは検索エンジンに対し「このページを無視して欲しい」と主張します。実際にどうなるのかは検索エンジン次第です。

備考

人間や、上記のオプションを無視するプログラムには効果がありません。

norelated

本wikiでは使用する必要はありません。

O

online

本wikiでは使用できません。


P

pcomment

種別

(コマンド)

ブロック型プラグイン

重要度

★★★☆☆

書式
#pcomment({
[コメント記録ページ],
[表示件数],
[noname],
[nodate],
[above],
[below],
[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

種別

ブロック型プラグイン

重要度

★★☆☆☆

書式
#popular(
[[件数]
[,[対象外ページ]
[,true|false]
]]
)
概要

人気のある(参照回数の多い)ページの上位数件を表示します。

引数

件数には一覧の数を指定して下さい。省略時はPLUGIN_POPULAR_DEFAULTに指定した件数です。

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

true, falseで、ページのカウント条件を指定します。省略時は false です。

  • true − 今日参照のあった回数順でページを表示します。
  • false − 通算の参照回数順でページを表示します。
備考

counterプラグインのカウンター情報を利用しているので、counterプラグインを設置していないページはカウントの対象外となります。全てのページにcounterプラグインを設置するのは非効率であるため counterプラグインをMenubarやスキンに設置するのが一般的です。


R

random

種別

(コマンド)

ブロック型プラグイン

重要度

★☆☆☆☆

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

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

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

引数

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

備考

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

read

種別

コマンド

重要度

★★★★★

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

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

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

引数

ページ名には表示したいページ名を指定します。ページ名はエンコードされている必要があります。

recent

種別

ブロック型プラグイン

重要度

★★★★★

書式
#recent(
[件数]
)
概要

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

引数

件数には表示件数を指定します。省略時はプラグイン内設定で指定した値です。

ref

種別

ブロック型プラグイン

インライン型プラグイン

重要度

★★★★☆

書式

#ref(
添付ファイル名|
ページ名/添付ファイル名|
URL
[,ページ名]
{,
[left|center|right],
[wrap|nowrap],
[around],
[noicon],
[noimg],
[nolink],
[zoom],
[999x999],
[999%]
}
[,タイトル]
)

&ref(
添付ファイル名|
ページ名/添付ファイル名|
URL
[,ページ名]
{,
[noicon],
[noimg],
[nolink],
[zoom],
[999x999],
[999%]
}
[,タイトル]
);

概要

'#attach'でページに添付されたファイルを指定位置に展開します。添付ファイルが画像の場合は画像を表示し、それ以外の場合はダウンロード用のリンクを表示します。

引数

添付ファイル名にはページに添付したファイル名を指定します(省略時はエラーとなります)。別ページ名/添付ファイル名とする事で別ページの添付ファイルも指定できます。

ページ名にはファイルを添付したページをWikiNameかBracketNameで指定します。このオプションは最初(添付ファイル名の次)に記述してください。省略時は設置したページです。

パラメータにはファイルの展開方法を指定できます。

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

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

"ほげ"という別ページの添付ファイル"fuga.jpg"をインラインプラグイン形式で参照する場合、下記2通りの記述方法が存在します。

(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

本wikiでは使用できません。

related

本wikiでは使用できません。

rename

種別

コマンド

重要度

★★★☆☆

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

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

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

引数

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

実行結果は変換結果のページ(PLUGIN_RENAME_LOGPAGE で指定。標準は :RenameLog)に追記されます。

備考

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

TrackBackやRefererの情報は更新されません。

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

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

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

rss

種別

コマンド

重要度

★☆☆☆☆

書式

?plugin=rss
[&ver=0.91|
1.0|
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

ruby

種別

インライン型プラグイン

重要度

★☆☆☆☆

書式
&ruby(
ルビ
){
対象文字列
};
概要

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

引数

ルビには表示するルビを指定します。

対象文字列にはルビがふられる文字列を指定します。

プラグイン内設定

  • PLUGIN_RUBY_USAGE 引数未指定時に表示されるヘルプ
備考

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

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

S

search

種別

コマンド

ブロック型プラグイン

重要度

★★★★★

書式
?cmd=search{
[&word=検索文字列]
[&type=OR]
[&base=抽出条件]
}

#search(
[抽出条件1
[[,抽出条件2]
[,抽出条件n]]]
)

概要

検索文字列の入力フォームを表示し、
指定した文字列を含むページの検索を行います。

引数

コマンド:

パラメータには検索条件を指定します。

  • word − 検索する文字列を指定します。省略時は検索条件を入力するページを表示します。
  • type − 'OR' 指定時、OR検索を行います。省略時はAND検索をおこないます。
ブロック型プラグイン:

パラメータには検索条件フォームで表示する検索対象ページの抽出条件を指定します。

  • 抽出条件1,2,…n − 入力フォームの抽出条件の選択肢を表示順で指定します。
    抽出条件選択時、選択した語句で始まるページ群に対してのみ、検索を実行します。
    特定のページ群だけを検索したい場合、検索処理がより早く終了します。
    抽出条件を選択しなかった場合は全ページが対象となります。
    省略時は選択欄が表示されず、常に全ページが検索対象となります。

setlinebreak

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#setlinebreak(
[on|off|default]
)
概要

入力文章中の改行を改行とみなすかどうかの設定を行います。

PukiWikiが入力文章中の改行をどのように扱うかはpukiwiki.ini内の$line_breakの設定内容によって変わります(下記参照)。

入力文章$line_break=0;$line_break=1;
文章1
文章2
文章1文章2文章1
文章2

setlinebreakプラグインは該当ページの以降の行に関して、
$line_breakの設定に因らず改行をどのように扱うかを指定できるようになります。

引数

パラメータには以降の改行の扱いを指定します。
パラメータが省略された場合、改行とみなすかどうかについての設定を逆転させます。

  • on − 以降の文章で段落内の改行を改行とみなします($line_break=1と同様)。
  • off − 以降の文章で改行を無視します($line_break=0と同様)。
    改行を行うためには行末にチルダを記述するか、
    行中でbrプラグインを使用する必要があります。
  • default − 改行の扱いをそのサイトの$line_break設定に戻します。

showrss

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#showrss(
RSSへのパス
[,[default|menubar|recent]
[,[キャッシュ生存時間(分)]
[,1
]]]
)
概要

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

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

引数

RSSへのパスにはRSSへのファイルパスやURLを指定します。

テンプレート名には取得したRSSの表示方法を指定します。省略時はdefault となります。

  • default − 単純にページを列挙します。
  • menubar − ページ名の前に黒丸をつけます。MenuBarなど、横幅に制限にある場合に便利です。
  • recent − recentプラグインの出力のように、ページ名の前に黒丸をつけて更新日付が変わる毎に更新日付を出力します。

キャッシュ生存時間はキャッシュをクリアする期限(分単位)です。省略時は60分となります。15分以下の値は設定できません。

第4引数はRSSを取得した日付を表示するかどうかを指定します。1を指定した場合は表示します。省略時は表示しません。

size

種別

インライン型プラグイン

重要度

★★★☆☆

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

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

引数

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

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


T

template

種別

コマンド

重要度

★★★★☆

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

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

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

引数

テンプレートページには雛形とするページを指定します。ページ名はエンコードされている必要があります。

プラグイン内設定

  • MAX_LEN 雛形の開始/終了位置を指定する欄で表示される最大文字数

topicpath

種別

インライン型プラグイン

ブロック型プラグイン

重要度

★☆☆☆☆

書式

&topicpath
;

#topicpath

概要

パンくずリスト(topicpath)と呼ばれる、現在参照しているウェブページの階層を表現するユーザーインターフェースを提供するプラグインです。

例えば

[[PukiWiki/ツアー]]
というページに#topicpathと書くと、以下の様な表記に置き換わります。
[[Top>FrontPage]] / [[PukiWiki>PukiWiki]] / [[ツアー>PukiWiki/ツアー]]

基本的には以下の2通りの使い方を想定しています。

  1. 「ほげ/ふが/げほ」など、2〜3階層以上の深いページでページの行き来をしやすくするために表示する
  2. スキンに組み込み、ページタイトル下のURLの代わりに全てのページで表示する

tracker

種別

(コマンド)

ブロック型プラグイン

重要度

★★★★☆

書式

#tracker(
[定義名]
[,ベースページ名]
)

概要

bugtrackプラグインのように、定型的な項目をもったページを作

Last-modified: 2013-02-23 (土) 13:25:47 (4078d)
ソーシャルボタン表示