プラグインマニュアルは以下の形式で記述されています。
プラグイン名
プラグインがどのような方法で呼び出しを行えるかを示します。複数の呼び出し方法をもつプラグインも存在します。
そのプラグインの一般的な利用頻度や有用性の目安を示します。さほど重要でない場合は ★☆☆☆☆ が、重要なプラグインの場合は ★★★★★ です。
プラグインでの引数指定方法です。引数の指定方法の表現のため、下記の記述書式を使っています。
そのプラグインの機能概要です。
引数の詳細な説明です。
プラグインのソース中で定義されている定数の一覧です。引数で変更できない詳細なカスタマイズが可能となります。
プラグインに関する参考情報です。
インライン型プラグイン
ブロック型プラグイン
&amazon(
ASIN番号
);
#amazon
#amazon(,
clear
)
#amazon(
ASIN番号,
[left|right],
[タイトル|image|delimage|deltitle|delete]
)
アマゾン(http://www.amazon.co.jp)が提供する商品のイメージと、商品名を表示します。
アマゾンのアソシエイト ID(紹介文などを書くことで副収入がもらえるかもしれない仕組み)に対応しています。 ASIN を入力するだけで、予め作成した定型作品紹介フォーマットを自動生成することができます。
全ての引数を省略すると、ブックレビュー作成フォームが現れます。「書評」というページにこれを置くと「書評/ASIN番号」という子ページを作ります。
left,right,clear で商品のイメージとタイトルの出力方式を指定します。
著作権が関連する為、アマゾンのアソシエイトプログラムを確認の上ご利用下さい。
インライン型プラグイン
ブロック型プラグイン
★★★★☆
&aname(
アンカー名
[,{[super],
[full],
[noid]}]
){
アンカー文字列
};
#aname(
アンカー名
[,{[super],
[full],
[noid]},
アンカー文字列]
)
指定した位置にアンカー(リンクの飛び先)を設定します。
アンカー名の値がアンカーのフラグメント指定子に使用されます。アンカー名は省略できません。アンカー名には半角英字(大文字/小文字)が使用可能です。
super,full,noid でアンカーの出力方式を指定します。
アンカー文字列が指定された場合、指定した文字列に対してアンカーが出力されます。アンカーの存在を利用者に明示したい場合に利用します。省略時は空文字に対するアンカーとなります。
(コマンド)
ブロック型プラグイン
★★★☆☆
指定した位置に簡易掲示板を設置します。
(コマンド)
ブロック型プラグイン
★★★★★
ページの添付ファイルの一覧を表示し、ファイル添付のための入力フォームを設置します。
nolist, noform で表示内容を指定します。
デフォルトのskinのメニューの「添付」で呼び出されているため、デフォルトのskinを使う場合には必ず組み込む必要があります。
プラグイン内設定の PLUGIN_ATTACH_MAX_FILESIZE を増やす場合は、php.iniの upload_max_filesize やApache の LimitRequestBodyなどPukiWiki以外での上限設定がある事に注意して下さい。
ブロック型プラグイン
★☆☆☆☆
指定した位置に戻り先へのリンクを設置します。
表示文字列は省略すると「戻る」になります。
left、center、rightで表示位置を指定します。省略時はcenterになります。
0、1で水平線の有無を指定します。省略すると1になります。
戻り先はリンクを選択時の移動先となるURL、ページ名のいずれかで指定します。PLUGIN_BACK_ALLOW_PAGELINKがTRUEの場合のみページ名を指定可能です。ページ名は「ページ名#anchor」の記述を行う事で移動先のアンカーも指定可能です。PLUGIN_BACK_ALLOW_JAVASCRIPTがTRUEの場合のみ戻り先の省略が可能です。戻り先を省略すると直前に参照していたページが戻り先になりますが、利用者のブラウザの設定がJavaScript onでないと機能しません。
コマンド
★★★★★
指定したページ、あるいは全体のバックアップ一覧を表示します。
ページ名を省略すると、PukiWiki全体のバックアップ一覧を表示します。ページ名はエンコードされている必要があります。
ブロック型プラグイン
インライン型プラグイン
★★☆☆☆
#br
&br;
文章中で改行を行います。
段落やリスト、テーブル内など、行末の~による改行ではブロック要素を抜けてしまう個所で改行や空行の挿入するために用います。
(コマンド)
ブロック型プラグイン
★☆☆☆☆ (一般サイト)
★★★★☆ (ソフト開発サイト)
バグ追跡システムの一部分であるバグレポートの入力フォームを設置します。
ページ名にはバグレポートとして作成されるページの親階層となるページ名を指定します。省略時は設置したページとなります。
通常、バグレポートには指定したページ名の子階層に自動的に番号が振られてページが作成されます。つまり"バグ報告ページ"と指定して設置した場合は、バグ報告ページ/1,バグ報告ページ/2,バグ報告ページ/3…のようにバグレポートのページが作成される事になります。
カテゴリーにはバグの対象となりうる要素を指定します。省略時は入力欄となります。
ソフト開発サイトで重宝するプラグインです。もしバグ追跡以外の用途でバグレポートのように定型的な項目を持ったページを作成するフォームが欲しい場合,あるいはバグレポートの項目をカスタマイズしたい場合はtrackerプラグインを使用して下さい。
ブロック型プラグイン
★☆☆☆☆ (一般サイト)
★★★★☆ (ソフト開発サイト)
バグ追跡システムの一部分であるバグレポートの一覧表示を行います。
ページ名にはバグレポートとして作成されるページの親階層となるページ名を指定します。省略時は設置したページとなります。
通常はbugtrackプラグインと並べて使用します。
bugtrack_listプラグインの中からbugtrackプラグインを呼び出しているため、bugtrackプラグインがないと機能しません。
bugtrack_listプラグインは、tracker_listプラグインに比べて低機能ですが、リソース消費が少なく処理速度が速いというメリットがあります。この差はページ数の増加に比例して顕れる傾向があるため、使い分けが必要です。
ブロック型プラグイン
★☆☆☆☆
#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プラグインまたはcalendar2プラグインで作成されたページを指定した位置に表示します。
ページ名はcalendarプラグインまたはcalendar2プラグインを設置しているページの名前を指定します。
yyyy-mmを指定時、指定した年月のページを表示します。
数字を指定時、指定した件数分のページを表示します。
x*yを指定時、先頭より数えて x ページ目(先頭は0)から、y件づつ一覧表示します。x と yはいずれも数値です。
thisを指定時、今月のページを一覧表示します。
past、future、viewで表示するページの条件を指定します。省略/無指定時はpastとなります。
年月日の区切り文字は-や/などを指定します。省略した場合は-になります。
calendar2プラグインでは今日の日付の記事がない場合、記事を表示しないため、午前0時になったとたんに記事が表示されなくなるという弱点がありました。calendar_viewerはその弱点を補うために開発されたプラグインです。calendar_viewは、日付が変わっても最新の記事を表示することができます。カレンダーそのものの表示はcalendar2(off)で行ないます。
(コマンド)
ブロック型プラグイン
★★★☆☆
指定した位置にカレンダーを設置します。表示月のとなりに表示されたリンク(<< および >>)を選択することで先月/次月分のカレンダーを表示できます。カレンダー上でyyyy/mm/ddという日付を選択すると、ページ名/yyyy-mm-ddというページを表示できます。当日分のページが作成されていた場合、カレンダーの右隣に当日分のページ内容を表示します。
ページ名で表示するページの上位階層のページを指定できます。ページ名を省略すると設置したページのページとなります。ページ名に*を指定すると上位階層のページはなし(表示するページ名がyyyy-mm-dd)となります。
yyyymmで表示するカレンダーの西暦と月を指定できます。省略時は当日の年月となります。
offを指定時、当日分ページを表示する機能は抑制されます。省略時は当日分のページを表示します。
calender_editで作成したページはページ名/yyyymmddとなり、calender2で作成したページはページ名/yyyy-mm-ddとなるため、注意が必要です。
ブロック型プラグイン
★☆☆☆☆
refプラグインのaroundオプションで有効となったテキスト回り込み指定を解除します。
imgプラグインのclearオプション指定時と処理内容は同等です。
インライン型プラグイン
★★★★☆
&color(
[文字色]
[,背景色]
){
文章
};
引数で指定したインライン要素(主に文章)の、文字色・背景色を指定します。
文字色・背景色はそれぞれ色名(red、blueなど)、シャープで始まる3桁の16進数値(#000〜#FFF)、同じく6桁の16進数値(#000000 〜 #FFFFFF)のいずれかで指定することができます。大文字小文字は問いません。
文字色・背景色の両方を省略する事はできません。一方を省略した場合は省略した側の色の変更はされません。
以下、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"
(コマンド)
ブロック型プラグイン
★★★★★
コメントの入力用の入力欄を表示します。
コメントの挿入方法を引数で指定します。
ブロック型プラグイン
★★★☆☆
#contents
設置したページ中の見出しの一覧を表示します。
ブロック型プラグイン
インライン型プラグイン
★★★☆☆
#counter
&counter(
[total|
today|
yesterday]
);
設置したページの参照回数を表示します。
カウンタ表示方法として total, today, yesterday いずれかを指定します。省略時はtotalが指定されたとみなします。ブロック型プラグインでは常にtotalが指定されたとみなします。
すべてのページで参照回数を表示したい場合は、MenuBarやスキンからcounterプラグインを呼び出してください。
コマンド
★★☆☆☆
削除されたページの一覧を表示します。
file=onを指定時、バックアップ(あるいは差分)のファイル名を出力します。省略時は表示しません。
dirで削除の判定方法を指定します。省略時はbackupです。
公開Wikiの管理者にとっては誤操作や悪意をもった編集によるページ削除をチェックするのに重宝します。
コマンド
★★★★★
指定したページの現在の内容と最後のバックアップ状態との差分を表示します。
ページ名に変更差分を表示するページを指定します。ページ名はエンコードされていなければなりません。
最後のバックアップ以外との差分を表示する場合はbackupを利用します。
コマンド
★☆☆☆☆
?plugin=dump
指定ディレクトリ内のファイルをまとめてtar(tar.gz, tgz)形式でバックアップ/リストアします。
バックアップ/リストアの実行には管理者パスワードが必要です。
バックアップはファイル名をページ名に変換して取得する事ができます。
この変換でリストアには利用出来なくなりますが、
ファイル名からページ名の類推は容易になります。
バックアップは取得するディレクトリを任意に指定する事ができます。
リストアは該当ファイルの上書きによって行われます。
そのため、ファイルの削除を行う事はできません。
バックアップ/リストア対象として指定可能なディレクトリは、以下の通りです。
PukiWikiが内部管理するファイルを直接取得/更新するという性質上、
セキュリティ上の問題を引き起こす可能性があります。十分ご注意ください。
DATA_DIRのリストアを行った場合は、linksプラグインで
ページ間のリンク情報キャッシュを更新する必要があります。
コマンド
インライン型プラグイン
★★★★★
&edit(
[ページ名
{[,nolabel]
[,noicon]}]
){
ラベル名
};
指定したページを編集します。
コマンド型の記述では、ページ名に編集するページを指定します。ページ名はエンコードされていなければなりません。
インライン型の記述では、ページ名は編集するページを指定します。省略時は設置したページです。
nolabel,noicon,ラベル名 でリンクの表示方法を指定します。
コマンド
(ブロック型プラグイン)
★★★☆☆
#freeze
対象のページを凍結し、不用意に変更できないようにします。
ページ名には凍結するページを指定します。ページ名はエンコードされている必要があります。コマンド型でfreezeプラグインを実行するとブロック型プラグインが凍結対象のページ先頭に挿入(凍結解除の場合は削除)されます。
ブロック型のfreezeプラグインはPukiWikiが内部的に利用するもので、基本的に利用者が意識する機会はありません。
ブロック型プラグイン
★★☆☆☆
文中に水平線を挿入します。
段落やリスト、テーブル内など、通常の水平線書式(----)ではブロックを抜けてしまう個所で水平線を挿入するために用います。リスト内など左右マージンが設定されている場合は、それを引き継ぎます。
ブロック型プラグイン
★☆☆☆☆
添付ファイル以外の画像を表示するために開発されましたが、該当機能がrefプラグインに統合されたため、基本的に使用することはありません。過去との互換性のために残っています。
画像URLには表示する画像のURLを指定します。
画像にはjpeg(jpg), gif, png のみ指定可能です。
right,r,left,l,clear,c で画像の表示位置とテキストの回りこみを指定します。省略時は left が指定されたとみなします。
ブロック型プラグイン
★★★☆☆
記述した位置に指定したページを挿入して、複数のページをあたかも1つのページであるかのように表示します。
ページ名には挿入するページを指定します。
第2引数にnotitleを指定すると、ページ名の表示を抑制します。titleはその逆です。
ブロック型プラグイン
★★☆☆☆
現在表示中のページによって、MenuBarに表示する内容を切り替える為に使用します。
表示中のページの下階層のSubMenuか、同階層にあるSubMenuページを挿入表示するプラグインです。
showpagename を指定すると、挿入表示するページのページ名を表示します。省略時はページ名を非表示とします。
(コマンド)
ブロック型プラグイン
★☆☆☆☆
記述した位置に複数行入力欄とボタンを表示します。
ボタンを押下すると入力欄に入力した内容をページに挿入します。
コマンド
★☆☆☆☆
InterWikiを記述した際にPukiWikiが内部的に呼び出します。使用者が意識して使用する機会はありません。
InterWiki名にはジャンプ先をInterWiki形式で指定します。InterWiki名はエンコードされている必要があります。
インライン型プラグイン
★☆☆☆☆
&lastmod(
[ページ名]
);
指定したページの最終更新日時を表示します。
ページ名には最終更新日時を表示したいページ名を指定します。
省略時は設置したページとみなします。
コマンド
★★★★☆
ページの一覧を表示します。
(コマンド)
ブロック型プラグイン
★★★☆☆
記述した位置にテキスト入力欄とボタンを表示します。任意の文字列を入力してボタンを押すと、interwikinameと入力値から生成したURLへ移動します。これによって、検索エンジンにクエリを送信したり、番号をタイプするだけで該当するアーカイブにアクセスすることなどが可能になります。
URLの生成にはInterWikiを利用します。このプラグインが生成するURLは、以下のようなInterWikiと同じです。InterWikiNameのページに、あらかじめURLの生成に使用するInterWikiNameを設定しておく必要があります。
[[interwikiname:入力欄の値]]
入力欄が空欄(空文字列)のときは、ボタンを押しても動作しません。必ず何らかの文字列を入力する必要があります。
interwikiname: InterWikiNameに設定した値の一つを指定します。
ボタン名: ボタンに表示するキャプションを指定します。省略時は'lookup'です。
入力欄の初期値: 初期値を指定したい場合に記入します。省略時は空文字列になります。
ブロック型プラグイン
★★☆☆☆
記述したページより階層化されているページのページ名を一覧表示します。
titleを指定した場合、ページ名に加えてタイトルを表示します。タイトルは各ページの一行目の内容を表示します。省略時はタイトルを表示しません。
実際には、より高機能なls2を使用する機会が多いと思われます。
(コマンド)
ブロック型プラグイン
★★★☆☆
指定したパターンで始まるページ名を一覧表示します。
パターンには表示するページ名の共通部分を指定します。省略時は"設置したページ名/"となります。
title,include,reverse,compact,link で表示方法を指定します。
linkの別名表示には、パラメータlinkを指定した際に表示される文字列の代わりの文字列を指定します。省略時は '...'で始まるページの一覧となります。
ls プラグインとの違いについて。
ページ名のソートにはnatcasesort()を使っているため、昇順の場合、半角英数字よりも漢字の方が先に表示されます。
本wikiでは使用できません。
(コマンド)
ブロック型プラグイン
★☆☆☆☆
記述した位置に複数行入力欄とボタンを表示します。
ボタンを押下すると入力欄の記述内容を更新します。
insertプラグインやarticleプラグインと似ていますが、入力した内容が入力欄の外へ出力されず、入力欄に留まる点が異なります。
個人用のメモ代わりにPukiWikiを利用している場合、未整理の情報を一時的に溜め込むのに便利です。
ブロック型プラグイン
★★★★☆
デフォルトのスキンにて、ページの左側にメニュー用のページ(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 がメニューとして表示されます。
メニュー用ページとして表示するページ名を指定します。
デフォルトのメニュー用ページをMenuBar以外のページとする場合は、pukiwiki.ini.php の $menubar を変更して下さい。
ブロック型プラグイン
★★☆☆☆
ナビゲーションバーを表示します。目次となるページに下階層のページが存在する時、それら全てのページ(の先頭と末尾)に記述する事で Prev, Home, Next というリンクを表示します。これによって下階層のページを順に参照するのに便利になります。
目次ページに順番に見て回るページの上階層にあたるページを指定します。
例えば hoge, hoge/1, hoge/2, hoge/3 というページが存在する場合、hoge/2に#navi(hoge)を記述するとhogeに移動するHomeというリンク、hoge/1に移動するPrevというリンク、hoge/3に移動するNextというリンクを表示します。
ページで最初に呼び出した場合はヘッダイメージのリンクを出力します。ページで2度目以降に呼び出された場合はフッタイメージのリンクを出力します。現在のページが目次ページである場合は対象となるページの一覧を表示します。
インライン型プラグイン
★★☆☆☆
指定した日時が最近であった場合、最近更新された事を強調表示します。日時の指定は直接日付時刻を記述する方法(書式1)と、指定したページ(群)の最終更新日時を採用する方法(書式2)の2通りがあります。
標準では5日以内の場合に New を、1日以内の場合に New! を表示します。期間や表示する文字列のパターンは設置者によってカスタマイズ可能です。
書式1:
日付文字列を指定した場合、その日時が規定の期間内であった場合に強調表示します。省略した場合はページの更新日時をチェックする記述であると見なされます。
書式2:
ページ名を指定した場合は、そのページの更新日時が規定の期間内であった場合に強調表示します。省略した場合は、プラグインを記述したそのページを指定したと見なします。
ページ名末尾が/であった場合、そのページ名で始まるページ群の中で最後の更新日時が規定の日付以内であった場合に強調表示します。
日付文字列はPHP関数:strtotimeが認識できる書式である必要があります。
コマンド
ブロック型プラグイン
★★★★★
#newpage(
[ページ名初期値]
)
ページを新規作成するか、新規作成するページ名の入力欄を表示します。
コマンド:
パラメータには新規作成するページのオプションを指定します。
ページ名には新規作成するページ名を指定します。省略時は新規作成するページ名の入力するためのページを表示します。ページ名はエンコードされている必要があります。
関連ページ名にはリンク元のページ名を指定します。新規作成するページの先頭に、ここで指定したページへのリンクが自動的に埋め込まれます。ページ名はエンコードされている必要があります。
ブロック型プラグイン:
ページ名初期値には新規作成するページ名を入力する入力欄に初期表示する文字列を指定します。
ブロック型プラグイン
★☆☆☆☆
#nofollow
記述したページが凍結されている場合、ヘッダーに「NOFOLLOW」「NOINDEX」オプションを追加させます。
これらのオプションは検索エンジンに対し「このページを無視して欲しい」と主張します。実際にどうなるのかは検索エンジン次第です。
人間や、上記のオプションを無視するプログラムには効果がありません。
本wikiでは使用する必要はありません。
本wikiでは使用できません。
(コマンド)
ブロック型プラグイン
★★★☆☆
別のページにコメントを記録することができるcommentプラグインです。設置した場所には最新のコメントだけを表示することができます。ラジオボタンを表示し、指定した部分にコメントを付けることもできます。
コメント記録ページ にはコメントを記録するページ名を指定します。省略すると、pcommentプラグイン内の PLUGIN_PCOMMENT_PAGE で指定されたページにコメントが記録されます。デフォルトは [コメント/(設置したページ名)] です。指定したページが存在しなくても、最初にコメントを追加した時に作成します。
表示件数 は表示する最新コメントの数を指定します。第1レベルの番号なしリストだけをカウントします。省略すると、pcommentのデフォルト件数(通常10件。 PLUGIN_PCOMMENT_NUM_COMMENTS で変更可能)が表示されます。
表示件数は コメント記録ページ より後に指定して下さい。コメント記録ページを省略して 表示件数 を指定する場合は、 コメント記録ページ に空白を指定します。(例: #pcomment(,15))
noname,nodate,above,below,reply でコメントの表示方法、入力方法を指定します。
更新が衝突したときは、予期せぬ場所にコメントが挿入されるのを防ぐため、リプライ先を指定して記入したコメントはaboveまたはbelowの設定にしたがって 一番前か一番後ろに追加されます。
コメント記入後に表示されるページのタイトルに「(#pcommentを書いたページ)を更新しました」と表示されますが、実際に更新されたのはコメントを記録するページです。
コメントを投稿しても、#pcommentが書かれたページは更新されないので、最終更新ページにはコメントを記録したページだけが更新として表示されます。
コメントとして相対参照([ [../] ]など)を用いた場合は、書いたページと書き込まれたページのどちらかで、意図したとおりに変換されない可能性があります。
自動過去ログ化機能は PLUGIN_PCOMMENT_AUTO_LOG の件数 + PLUGIN_PCOMMENT_NUM_COMMENTS の件数分のコメントを投稿した時に作動します。
ブロック型プラグイン
★★☆☆☆
人気のある(参照回数の多い)ページの上位数件を表示します。
件数には一覧の数を指定して下さい。省略時はPLUGIN_POPULAR_DEFAULTに指定した件数です。
対象外ページには、表示対象外とするページを正規表現で指定します。例えば FrontPage や MenuBar などのページを一覧に表示させたくないときに使用します。
true, falseで、ページのカウント条件を指定します。省略時は false です。
counterプラグインのカウンター情報を利用しているので、counterプラグインを設置していないページはカウントの対象外となります。全てのページにcounterプラグインを設置するのは非効率であるため counterプラグインをMenubarやスキンに設置するのが一般的です。
(コマンド)
ブロック型プラグイン
★☆☆☆☆
ランダムなページへのリンクを表示するプラグイン。
表示するページの候補は設置したページの下階層のページです。
メッセージにはリンクに表示する文字列を指定します。省略時は 'press here.' となります。
ブラウザの再読み込み対策はしていません。リロードされるたびにランダムな表示を繰り返します。
コマンド
★★★★★
指定したページを表示します。該当ページが存在しない場合は編集状態で開き、ページ名がInterWikiであった場合は、その解決を行います。
plugin=やcmd=が指定されていない場合に内部で暗黙に呼び出されるため、利用者が意識する機会は少ないです。
ページ名には表示したいページ名を指定します。ページ名はエンコードされている必要があります。
ブロック型プラグイン
★★★★★
最近更新されたページのうち、最新の数件を表示します。
件数には表示件数を指定します。省略時はプラグイン内設定で指定した値です。
ブロック型プラグイン
インライン型プラグイン
★★★★☆
#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で指定します。このオプションは最初(添付ファイル名の次)に記述してください。省略時は設置したページです。
パラメータにはファイルの展開方法を指定できます。
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)はエラーとなります。
(7) &ref(fuga.jpg);(7)は(6)と似た記述ですが、添付ファイル名の次の引数が省略されているため、エラーにはなりません。
本wikiでは使用できません。
本wikiでは使用できません。
コマンド
★★★☆☆
既存ページの名前を変更します。実行には管理者権限が必要です。
ページの本文のほか、指定されたページ名の差分、バックアップ、添付ファイル、カウンターを一気にリネームします。
ページ名には変更するページの名前を指定します。省略時はページ名の選択または正規表現置換用文字列入力画面が表示されます。
実行結果は変換結果のページ(PLUGIN_RENAME_LOGPAGE で指定。標準は :RenameLog)に追記されます。
ページ内のリンクの書き換えは行ないません。yetlistなどを駆使して対処してください。
TrackBackやRefererの情報は更新されません。
リネーム対象のページが凍結されているかどうかはチェックしていません。
関連ページにリネーム対象の文字列が複数含まれているとおかしくなります。
コマンド
★☆☆☆☆
?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
インライン型プラグイン
★☆☆☆☆
文字列にルビをふります。
ルビには表示するルビを指定します。
対象文字列にはルビがふられる文字列を指定します。
XHTML 1.1のルビに対応したブラウザでないと、ルビとして表示されません。IE5.5/6では表示できます。Netscape 7/MozillaではXHTML Ruby Supportを組み込めば表示できます。
ルビに対応していないブラウザではルビをふる文字列の直後にルビが( )に入れられて表示されます。
コマンド
ブロック型プラグイン
★★★★★
#search(
[抽出条件1
[[,抽出条件2]
[,抽出条件n]]]
)
検索文字列の入力フォームを表示し、
指定した文字列を含むページの検索を行います。
コマンド:
パラメータには検索条件を指定します。
パラメータには検索条件フォームで表示する検索対象ページの抽出条件を指定します。
ブロック型プラグイン
★☆☆☆☆
入力文章中の改行を改行とみなすかどうかの設定を行います。
PukiWikiが入力文章中の改行をどのように扱うかはpukiwiki.ini内の$line_breakの設定内容によって変わります(下記参照)。
入力文章 | $line_break=0; | $line_break=1; |
文章1 文章2 | 文章1文章2 | 文章1 文章2 |
setlinebreakプラグインは該当ページの以降の行に関して、
$line_breakの設定に因らず改行をどのように扱うかを指定できるようになります。
パラメータには以降の改行の扱いを指定します。
パラメータが省略された場合、改行とみなすかどうかについての設定を逆転させます。
ブロック型プラグイン
★☆☆☆☆
指定されたRSSを取得し、一覧表示します。
ページの解釈毎にRSSの取得を行う為、頻繁に参照されるページでshowrssを使用される場合はキャッシュ機能を使うことをお勧めします。相手サイトの更新頻度に応じてキャッシュの生存時間を適宜設定して下さい。
RSSへのパスにはRSSへのファイルパスやURLを指定します。
テンプレート名には取得したRSSの表示方法を指定します。省略時はdefault となります。
キャッシュ生存時間はキャッシュをクリアする期限(分単位)です。省略時は60分となります。15分以下の値は設定できません。
第4引数はRSSを取得した日付を表示するかどうかを指定します。1を指定した場合は表示します。省略時は表示しません。
インライン型プラグイン
★★★☆☆
文字の大きさを指定します。
ピクセル数値には文字の大きさを指定します。
文字列は文字の大きさを変更する文字列を指定します。
コマンド
★★★★☆
既存のページをテンプレートとしてページを新規作成します。
ページの新規作成時の雛形とするページの読込み機能との差異は、テンプレートプラグインが雛形とする範囲(行単位)に選択できるのに対して、ページの新規作成で読み込むテンプレートは全文をテキストエリアにコピーする点にあります。
テンプレートページには雛形とするページを指定します。ページ名はエンコードされている必要があります。
インライン型プラグイン
ブロック型プラグイン
★☆☆☆☆
&topicpath
;
#topicpath
パンくずリスト(topicpath)と呼ばれる、現在参照しているウェブページの階層を表現するユーザーインターフェースを提供するプラグインです。
例えば
[[PukiWiki/ツアー]]というページに#topicpathと書くと、以下の様な表記に置き換わります。
[[Top>FrontPage]] / [[PukiWiki>PukiWiki]] / [[ツアー>PukiWiki/ツアー]]
基本的には以下の2通りの使い方を想定しています。
(コマンド)
ブロック型プラグイン
★★★★☆
#tracker(
[定義名]
[,ベースページ名]
)
bugtrackプラグインのように、定型的な項目をもったページを作