プラグインプラグインマニュアルプラグインマニュアルプラグインマニュアルの凡例AamazonanamearticleattachBbackbackupbrbugtrackbugtrack_listCcalendar、calendar_edit、calendar_readcalendar_viewercalendar2clearcolorcommentcontentscounterDdeleteddiffdumpEeditFfreezeHhrIimgincludeincludesubmenuinsertinterwikiLlastmodlistlookuplsls2MmapmemomenuNnavinewnewpagenofollownorelatedOonlinePpcommentpopularRrandomreadrecentrefrefererrelatedrenamerssrubySsearchsetlinebreakshowrsssizeTtemplatetopicpathtrackerプラグインマニュアルの凡例プラグインマニュアルは以下の形式で記述されています。種別プラグインがどのような方法で呼び出しを行えるかを示します。複数の呼び出し方法をもつプラグインも存在します。ブロック型プラグインでの呼び出しが可能である事を示します。インライン型プラグインでの呼び出しが可能である事を示します。重要度そのプラグインの一般的な利用頻度や有用性の目安を示します。書式プラグインでの引数指定方法です。引数の指定方法の表現のため、下記の記述書式を使っています。省略可能で必要に応じて記述する箇所です。|で区切られた複数の項目のうち、指定できるのは1つである事を示します。中カッコ内のみ引数の指定順序が任意である事を示します。概要そのプラグインの機能概要です。引数の詳細な説明です。プラグイン内設定プラグインのソース中で定義されている定数の一覧です。引数で変更できない詳細なカスタマイズが可能となります。備考プラグインに関する参考情報です。Aamazon種別インライン型プラグインブロック型プラグイン書式&amazon(ASIN番号);#amazon#amazon(,clear)#amazon(ASIN番号,[left|right],[タイトル|image|delimage|deltitle|delete])概要アマゾン(http://www.amazon.co.jp)が提供する商品のイメージと、商品名を表示します。ID(紹介文などを書くことで副収入がもらえるかもしれない仕組み)に対応しています。入力するだけで、予め作成した定型作品紹介フォーマットを自動生成することができます。全ての引数を省略すると、ブックレビュー作成フォームが現れます。「書評」というページにこれを置くと「書評/ASIN番号」という子ページを作ります。商品のイメージとタイトルの出力方式を指定します。表示時の位置を指定します。省略時はrightです。テキスト回り込み指定を解除します。表示内容を指定します。商品のタイトルを指定します。省略時は自動取得します。商品のイメージのみ表示します。省略時はイメージとタイトルを表示します。対応するイメージキャッシュを削除します。対応するタイトルキャッシュを削除します。対応するイメージキャッシュ,タイトルキャッシュを削除します。著作権が関連する為、アマゾンのアソシエイトプログラムを確認の上ご利用下さい。指定した位置にアンカー(リンクの飛び先)を設定します。引数アンカー名の値がアンカーのフラグメント指定子に使用されます。アンカー名は省略できません。アンカー名には半角英字(大文字/小文字)が使用可能です。アンカーの出力方式を指定します。アンカー文字列を上付き表示します。省略時は上付き表示されません。フラグメント指定子以外のURIを補ってアンカーを出力します。省略時はフラグメント指定子のみ出力されます。アンカーにフラグメント指定子を出力しません。アンカー文字列が指定された場合、指定した文字列に対してアンカーが出力されます。アンカーの存在を利用者に明示したい場合に利用します。省略時は空文字に対するアンカーとなります。指定した位置に簡易掲示板を設置します。#attach([nolist][,noform])概要ページの添付ファイルの一覧を表示し、ファイル添付のための入力フォームを設置します。表示内容を指定します。ページの添付ファイルの一覧を表示しません。省略時は一覧を表示します。ファイル添付のための入力フォームを表示しません。省略時は入力フォームを表示します。ダウンロード時のmime-typeを記述したページ備考デフォルトのskinのメニューの「添付」で呼び出されているため、デフォルトのskinを使う場合には必ず組み込む必要があります。LimitRequestBodyなどPukiWiki以外での上限設定がある事に注意して下さい。省略すると「戻る」になります。left、center、rightで表示位置を指定します。省略時はcenterになります。リンクを左寄せで表示します。リンクを中央寄せで表示します。リンクを右寄せで表示します。0、1で水平線の有無を指定します。省略すると1になります。水平線を表示しません。戻り先はリンクを選択時の移動先となるURL、ページ名のいずれかで指定します。PLUGIN_BACK_ALLOW_PAGELINKがTRUEの場合のみページ名を指定可能です。ページ名は「ページ名#anchor」の記述を行う事で移動先のアンカーも指定可能です。PLUGIN_BACK_ALLOW_JAVASCRIPTがTRUEの場合のみ戻り先の省略が可能です。onでないと機能しません。指定したページ、あるいは全体のバックアップ一覧を表示します。引数ページ名を省略すると、PukiWiki全体のバックアップ一覧を表示します。ページ名はエンコードされている必要があります。文章中で改行を行います。段落やリスト、テーブル内など、行末の~による改行ではブロック要素を抜けてしまう個所で改行や空行の挿入するために用います。(ソフト開発サイト)書式#bugtrack([[ページ名][,カテゴリー1...カテゴリーn]])概要バグ追跡システムの一部分であるバグレポートの入力フォームを設置します。引数ページ名にはバグレポートとして作成されるページの親階層となるページ名を指定します。省略時は設置したページとなります。通常、バグレポートには指定したページ名の子階層に自動的に番号が振られてページが作成されます。"バグ報告ページ"と指定して設置した場合は、バグ報告ページ/1,バグ報告ページ/2,バグ報告ページ/3...のようにバグレポートのページが作成される事になります。カテゴリーにはバグの対象となりうる要素を指定します。省略時は入力欄となります。備考ソフト開発サイトで重宝するプラグインです。バグ追跡以外の用途でバグレポートのように定型的な項目を持ったページを作成するフォームが欲しい場合,あるいはバグレポートの項目をカスタマイズしたい場合はtrackerプラグインを使用して下さい。(ソフト開発サイト)書式#bugtrack_list([ページ名])概要バグ追跡システムの一部分であるバグレポートの一覧表示を行います。引数ページ名にはバグレポートとして作成されるページの親階層となるページ名を指定します。省略時は設置したページとなります。通常はbugtrackプラグインと並べて使用します。bugtrack_listプラグインの中からbugtrackプラグインを呼び出しているため、bugtrackプラグインがないと機能しません。bugtrack_listプラグインは、tracker_listプラグインに比べて低機能ですが、リソース消費が少なく処理速度が速いというメリットがあります。この差はページ数の増加に比例して顕れる傾向があるため、使い分けが必要です。指定した位置にカレンダーを設置します。カレンダー上でyyyy/mm/ddという日付を選択すると、ページ名/yyyymmddというページを編集/表示できます。どちらで開くかが3つのプラグインの違いです。calendar_readは表示状態で開きます。引数ページ名は編集/参照するカレンダーのページの上位ページ名を指定します。ページ名を省略すると設置したページのページ名になります。年月は表示するカレンダーの西暦と月をyyyymmの形式で指定します。省略した場合は現在の年月になります。備考より高機能なcalendar2プラグインがあるため、あえてcalendarプラグインを使う必要性はほとんどなくなりました。calendar_editプラグイン及びcalendar_readプラグインの中からcalendarプラグインを呼び出しているため、calendarプラグインがないと機能しません。#calendar_viewer(ページ名,yyyy-mm|n|x*y|this[,[past|future|view][,年月日表示の区切り文字]])概要calendarプラグインまたはcalendar2プラグインで作成されたページを指定した位置に表示します。引数ページ名はcalendarプラグインまたはcalendar2プラグインを設置しているページの名前を指定します。yyyy-mmを指定時、指定した年月のページを表示します。数字を指定時、指定した件数分のページを表示します。ページ目(先頭は0)から、y件づつ一覧表示します。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となるため、注意が必要です。#clear概要refプラグインのaroundオプションで有効となったテキスト回り込み指定を解除します。備考imgプラグインのclearオプション指定時と処理内容は同等です。#FFFFFF)のいずれかで指定することができます。大文字小文字は問いません。文字色・背景色の両方を省略する事はできません。一方を省略した場合は省略した側の色の変更はされません。W3C勧告書より抜粋した色名。#comment({[above],[below],[nodate],[noname]})概要コメントの入力用の入力欄を表示します。引数コメントの挿入方法を引数で指定します。設置したページ中の見出しの一覧を表示します。設置したページの参照回数を表示します。いずれかを指定します。省略時はtotalが指定されたとみなします。ブロック型プラグインでは常にtotalが指定されたとみなします。そのページが参照された回数の総計を表示します。そのページが参照された回数(当日分)を表示します。そのページが参照された回数(昨日分)を表示します。備考すべてのページで参照回数を表示したい場合は、MenuBarやスキンからcounterプラグインを呼び出してください。削除されたページの一覧を表示します。引数file=onを指定時、バックアップ(あるいは差分)のファイル名を出力します。省略時は表示しません。dirで削除の判定方法を指定します。省略時はbackupです。公開Wikiの管理者にとっては誤操作や悪意をもった編集によるページ削除をチェックするのに重宝します。指定したページの現在の内容と最後のバックアップ状態との差分を表示します。引数ページ名に変更差分を表示するページを指定します。ページ名はエンコードされていなければなりません。最後のバックアップ以外との差分を表示する場合はbackupを利用します。tgz)形式でバックアップ/リストアします。バックアップ/リストアの実行には管理者パスワードが必要です。バックアップはファイル名をページ名に変換して取得する事ができます。この変換でリストアには利用出来なくなりますが、ファイル名からページ名の類推は容易になります。バックアップは取得するディレクトリを任意に指定する事ができます。リストアは該当ファイルの上書きによって行われます。そのため、ファイルの削除を行う事はできません。バックアップ/リストア対象として指定可能なディレクトリは、以下の通りです。備考PukiWikiが内部管理するファイルを直接取得/更新するという性質上、セキュリティ上の問題を引き起こす可能性があります。DATA_DIRのリストアを行った場合は、linksプラグインでページ間のリンク情報キャッシュを更新する必要があります。指定したページを編集します。引数コマンド型の記述では、ページ名に編集するページを指定します。ページ名はエンコードされていなければなりません。インライン型の記述では、ページ名は編集するページを指定します。省略時は設置したページです。リンクの表示方法を指定します。編集用リンクに画像を表示しません。編集用リンクの文字列として表示する文字列を指定します。対象のページを凍結し、不用意に変更できないようにします。引数ページ名には凍結するページを指定します。ページ名はエンコードされている必要があります。コマンド型でfreezeプラグインを実行するとブロック型プラグインが凍結対象のページ先頭に挿入(凍結解除の場合は削除)されます。ブロック型のfreezeプラグインはPukiWikiが内部的に利用するもので、基本的に利用者が意識する機会はありません。文中に水平線を挿入します。段落やリスト、テーブル内など、通常の水平線書式(----)ではブロックを抜けてしまう個所で水平線を挿入するために用います。リスト内など左右マージンが設定されている場合は、それを引き継ぎます。添付ファイル以外の画像を表示するために開発されましたが、該当機能がrefプラグインに統合されたため、基本的に使用することはありません。過去との互換性のために残っています。画像URLには表示する画像のURLを指定します。画像の表示位置とテキストの回りこみを指定します。指定されたとみなします。画像を右寄せで表示します。画像を右寄せで表示します。テキストの回りこみを解除します。以外は全てclearが選択されたと見なされます。記述した位置に指定したページを挿入して、複数のページをあたかも1つのページであるかのように表示します。引数ページ名には挿入するページを指定します。第2引数にnotitleを指定すると、ページ名の表示を抑制します。titleはその逆です。現在表示中のページによって、MenuBarに表示する内容を切り替える為に使用します。表示中のページの下階層のSubMenuか、同階層にあるSubMenuページを挿入表示するプラグインです。指定すると、挿入表示するページのページ名を表示します。省略時はページ名を非表示とします。記述した位置に複数行入力欄とボタンを表示します。ボタンを押下すると入力欄に入力した内容をページに挿入します。概要InterWikiを記述した際にPukiWikiが内部的に呼び出します。使用者が意識して使用する機会はありません。引数InterWiki名にはジャンプ先をInterWiki形式で指定します。InterWiki名はエンコードされている必要があります。指定したページの最終更新日時を表示します。引数ページ名には最終更新日時を表示したいページ名を指定します。省略時は設置したページとみなします。?cmd=list概要ページの一覧を表示します。記述した位置にテキスト入力欄とボタンを表示します。任意の文字列を入力してボタンを押すと、interwikinameと入力値から生成したURLへ移動します。これによって、検索エンジンにクエリを送信したり、番号をタイプするだけで該当するアーカイブにアクセスすることなどが可能になります。URLの生成にはInterWikiを利用します。このプラグインが生成するURLは、以下のようなInterWikiと同じです。InterWikiNameのページに、あらかじめURLの生成に使用するInterWikiNameを設定しておく必要があります。[[interwikiname:入力欄の値]]入力欄が空欄(空文字列)のときは、ボタンを押しても動作しません。何らかの文字列を入力する必要があります。InterWikiNameに設定した値の一つを指定します。ボタンに表示するキャプションを指定します。省略時は'lookup'です。初期値を指定したい場合に記入します。省略時は空文字列になります。記述したページより階層化されているページのページ名を一覧表示します。引数titleを指定した場合、ページ名に加えてタイトルを表示します。タイトルは各ページの一行目の内容を表示します。省略時はタイトルを表示しません。実際には、より高機能なls2を使用する機会が多いと思われます。指定したパターンで始まるページ名を一覧表示します。引数パターンには表示するページ名の共通部分を指定します。省略時は"設置したページ名/"となります。表示方法を指定します。ページに含まれる見出し(*,**,***)の一覧を併記します。下位層のページが#includeを使用していた場合、includeしているページの一覧を表示します。ページの並び順を反転し、名前の降順に表示します。省略すると名前の昇順に表示されます。見出しレベルを調整します。#ls2を書いた位置に一覧を表示する代わりにリンクを表示します。このリンクを選択すると別画面にページの一覧を表示するようにします。linkの別名表示には、パラメータlinkを指定した際に表示される文字列の代わりの文字列を指定します。'...'で始まるページの一覧となります。プラグインとの違いについて。階層化されたページの起点となるページが、lsでは記述したページ固定だが、ls2ではパラメータで指定できます。titleパラメータを指定した場合に、lsでは「ページの一行目」が表示されるが、ls2では「見出しの一覧」を表示します。いう表示オプションが追加されています。ページ名のソートにはnatcasesort()を使っているため、昇順の場合、半角英数字よりも漢字の方が先に表示されます。Mmap本wikiでは使用できません。記述した位置に複数行入力欄とボタンを表示します。ボタンを押下すると入力欄の記述内容を更新します。備考insertプラグインやarticleプラグインと似ていますが、入力した内容が入力欄の外へ出力されず、入力欄に留まる点が異なります。個人用のメモ代わりにPukiWikiを利用している場合、未整理の情報を一時的に溜め込むのに便利です。#menu(ページ名)概要デフォルトのスキンにて、ページの左側にメニュー用のページ(MenuBar)を表示するために内部的に使用されています。任意のページでブロック型プラグインとして使用すると、引数に指定したページをメニュー用ページに指定できます。記述する事で実現できます。TRUEとすると、表示中のページの上位階層のMenuBarか、同階層にあるMenuBarページをメニューとして表示するようになります。メニューとして表示されます。引数メニュー用ページとして表示するページ名を指定します。サブメニューを使用する場合にメニューとして呼び出されるページ名。