プラグインマニュアル簡易版


マニュアルの見方

書式例

#include( ページ名 [, title | notitle ])
  • [ ] で囲まれた部分は省略できます。
  • ( ) 内を全て省略した場合は、( ) も省略できます。
  • , はパラメータの区切りです。後に続くパラメータを指定する場合に記述します。
  • | で区切られた項目はいずれか一つを指定します。
  • #plugin_name(option) の形式の物はブロック要素になります。
  • &plugin_name(option){文字列}; の形式の物はインライン要素になります。
  • 両方の使い方ができるプラグインもあります。

テキスト整形

new 更新のチェック

指定したページが5日以内に更新されていた場合に、New を表示します。

&new( ページ名 [, nolink ] );
  • ページ名を省略した場合は、現在のページが基準になります。
  • ページ名/ を指定した場合、ページ名/ で始まるページ全てを調べます。
  • nolink を指定するとページ名を表示しません。

note キーワード指定注釈

同じ注釈をキーワードで判別できるプラグインです。

&note{ [キーワード] : [内容] };
  • キーワードには注釈を区別するための文字列を指定します。
    • キーワードを省略すると、内容がキーワードとみなされます。
  • 内容は実際に表示される脚注です。
    • 内容を省略すると、指定したキーワードの脚注へのリンクを張ります。

ref 添付ファイル表示

添付ファイルを表示します。
ファイルが画像以外の場合はダウンロード用のリンクを生成します。

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

title ページタイトル

このプラグインはクルル人形館Wiki独自の自作プラグインです。
ページタイトル用の見出しを表示します。

#title( ページタイトル )
  • 通常の大見出し(h2)よりも上位の、タイトル専用見出し(h2 class="title")を表示します。
  • 通常の見出しと違い、contents で目次化されません。
  • 通常の見出しと違い、アンカー設定されません。

class class指定ブロック

このプラグインはクルル人形館Wiki独自の自作プラグインです。
指定クラスで囲まれたブロック要素を生成します。

#class(クラス名)
 :
 :
#class(end)
  • 開始指定と終了指定をセットで使用します。
  • 主にデザイン変更用に使います。
    • デザインの変更は管理人にしかできません。
  • 人形館Wikiでは、クラス名 attention に注意書きのデザインを指定してあります。

style style指定ブロック

指定された方法でスタイルを適用したブロック要素を生成します。
詳細は配布元のページを参照。

addline 指定行追加

1クリックで指定された文字列を追加するボタンを表示します。
詳細は配布元のページを参照。

attachref ファイル添付&表示

ファイルの添付と表示を同時に行うプラグイン。

  1. ファイル添付
  2. ページを編集して refで添付ファイルを表示

という流れを一本化します。
詳細は配布元のページを参照。

areaedit 範囲編集

ページの一部分だけを編集できるリンクを生成します。

#areaedit
 :
[ #areaedit(end) ]
  • 開始指定と終了指定をセットで使用します。
  • areaeditで囲まれた範囲だけを編集できます。
    • areaedit編集時にareaeditを挿入するとコメントアウトされます。
  • 終了指定を省略した場合、最初の空行までを編集エリアとします。

exrules ページ毎整形ルール

ユーザー定義の整形ルールをページ毎に指定します。
ページ内に同じ書式設定を多量に書く場合に便利です。

#exrules( パターン, 置き換え文字列 )
  • パターンには実際にページ内に書き込むルールを指定します。
  • 置き換え文字列には本来の整形ルールを指定します。
  • どちらもパターン中に * で任意文字列を指定できます。
$$文字列$$ を文字色変更(緑)に指定する
#exrules($$*$$,&color(green){*};)
__文字列__ を文字サイズ80%に指定する
#exrules(__*__,%size(80){*};)
!!文字列!! を文字サイズ200%の強調表示に指定する
#exrules(!!*!!,%size(200){''*''};)
??文字列?? をリンク切れのようなデザインに指定する
#exrules(??*??,&color(,#FFFACC){*?};)
  • この指定はページの最初で行います。
  • 以降ページ内では設定したルールが有効になります。
  • この指定はページ内でのみ有効です。

リンク生成

random ランダムリンク生成

下階層のランダムなページへのリンクを生成します。

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

navi ナビゲーションリンク生成

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

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

tsort 表ソート用リンク生成

このプラグインはクルル人形館Wiki独自の自作プラグインです。
table_editプラグインをラッピングし、動的にソート表示できるようにします。
指定の文字列をリンク化し、クリックすると指定の表をtable_editでソート表示します。

&tsort(ソート指定 [, 表ページ]){ リンク化する文字列 };
  • 表ページ、ソート指定はそのままtable_editに渡されます。
    • 指定方法はtable_editを参照して下さい。
  • 各表のヘッダ行をリンク化すると非常に便利です。

例えば

| &tsort(1n){No.}; | &tsort(2s){サイト名}; | url |h
| 1 | yahoo-japan | http://www.yahoo.cp.jp/  |
| 2 | google      | http://www.google.cp.jp/ |

とすると、サイト名をクリックするとサイト名順に、No.をクリックするとNo順にソートされます。


ページ一覧の生成

ls2 ページ一覧

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

#ls2( [ パターン , 表示方法 , linkの別名表示 ] )
  • パターンには表示するページ名の共通部分を指定します。
    • 省略時は"設置したページ名/"となります。
  • 表示方法
    • title − ページに含まれる見出し(*,**,***)の一覧を併記します。
    • include − 下位層のページが #include系を使用していた場合、includeしているページの一覧を表示します。
    • reverse − ページの並び順を反転します。省略すると昇順に表示されます。
    • compact − 見出しレベルを調整します。
    • link − #ls2を書いた位置に一覧を表示する代わりにリンクを表示します。このリンクを選択すると別画面にページの一覧を表示するようにします。
  • linkの別名表示
    • パラメータlinkを指定した際に表示される文字列の代わりの文字列を指定します。
    • 省略時は '...'で始まるページの一覧となります。

lsx ページ一覧

ls、ls2の拡張版。
詳細は配布元のページを参照。

contents 目次生成

見出しから目次を生成します。

#contents
  • そのページにある全ての見出しを目次化します。

contentsx 目次生成

contentsの拡張版。

#contentsx
  • そのページで、contentsx が書かれた場所以降にある見出しから目次を生成します。
  • 詳しくは配布元のページを参照。

popular 人気ページ一覧

カウンターの多い順にページを一覧します。

#popular( [ 件数 , 対象外ページ , true ] )
  • 対象外ページには、表示対象外とするページを正規表現で指定します。
    • 例えば FrontPage や MenuBar などのページを一覧に表示させたくないときに使用します。
    • true を指定すると今日の参照回数順で表示します。省略時はトータル参照回数順です。

recent 最新更新一覧

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

#recent( { 件数 } )

recent2 最新更新一覧

指定されたページを基準に、最新更新された数件を表示します。

#recent( { 件数 , 基準ページ } )
  • 基準ページ以下にあるページから最新更新されたページを探します。
    • 省略時は recent と同じ動作になります。

related 参照ページ一覧

現在のページにリンクしているページの一覧を表示します。

#related
  • ページタイトルをクリックした時にも表示されます。

map 簡易サイトマップ

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

コマンド型プラグイン
PukiWikiUrl?plugin=map[&refer=ページ名][&reverse=true]
  • このプラグインはコマンド型プラグインです。ページ内には記述できません。
  • &refer=ページ名
    • 起点となるページを指定します。
    • 省略するとトップページ(通常はFrontPage)になります。
  • &reverse=true
    • どこからリンクされているかを一覧表示します。
    • どこからもリンクされていないページは、画面の後半にまとめて表示されます。

追加機能

pcomment コメント入力欄

別のページにコメントを記録することができるcommentプラグインです。
設置した場所には最新のコメントだけを表示することができます。
ラジオボタンを表示し、指定した部分にコメントを付けることもできます。

#pcomment( [ コメント記録ページ , 表示件数 , options ] )
  • コメント記録ページ にはコメントを記録するページ名を指定します。
    • 省略すると、コメント/現在のページ名 になります。
    • 省略時に他のオプションを指定する場合は空白文字とします。
      #pcomment(,20)
  • 表示件数
    • 省略すると、10件表示になります。
  • options は以下の中から , 区切りで列挙できます。
    • noname − 名前の入力欄を表示しません。
    • nodate − 日付を挿入しません。
    • above − 挿入したコメントをフォームの上に表示します。上が古く、下に向かって新しい順に並びます。

通常はスパム対策してある pcomment_nospam を使用して下さい。

comment_nospam スパム対策コメント入力欄

スパム対策を施したcommentプラグインです。
articleなどから呼び出されます。

通常は別ページにコメントを保存する pcomment_nospam を使用して下さい。

pcomment_nospam スパム対策コメント入力欄

スパム対策を施したpcommentプラグインです。
内部でpcommentプラグインを呼び出しているので、スパム対策以外はpcommentと同じです。

#pcomment_nospam( [ コメント記録ページ , 表示件数 , options ] )
  • オプションの内容などはpcommentを参照して下さい。

include ページの挿入

指定したページを挿入して1つのページのように表示します。

#include( ページ名 [, title | notitle ])

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

includex ページの挿入

includeの拡張版です。
詳細は配布元のページを参照。

includesubmenu ページ別サイドメニュー

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

#includesubmenu( [ showpagename ] )
  • 表示中のページの下階層のSubMenuか、同階層にあるSubMenuページを挿入表示するプラグインです。
  • showpagename を指定すると、挿入表示するページのページ名を表示します。
    • 省略時はページ名を非表示とします。

table_edit 表データの挿入・編集

指定ページを挿入し、そのページ内の表を行ごとに編集可能にします。
また新しい行を追加する機能もあります。

#table_edit( 表ページ名 [, ソート文字列 ] )
  • 表ページ名には表データがあるページ名を指定します。
    • 最低でも表のヘッダ行だけは作成してある必要があります。
  • ソート文字列を指定すると、表を自動でソートします。
    • 指定は列の番号と指定記号( n 、s 、r )で行います。
例)
1n :1列目を基準に数字の小さい順
5s :5列目を基準に辞書順(名前順)
2sr :2列目を基準に辞書の逆順
2nr :2列目を基準に数値の大きい順

1  :1sと同じ
1r :1srと同じ
1ns :指定できません

 1:2 :1s→2sの順でソート

  • 簡易表(csv形式の表)と通常表の両方とも編集できます。
  • ヘッダ行がない場合は行の追加ができません。
  • ヘッダ行は編集できません。
  • 表ページには複数の表を含める事ができます。
    • ソート条件を指定した場合、全ての表に対してソート条件が適用されます。

calendar2 日記用カレンダー

  • 指定した位置にカレンダーを設置します。
  • 表示月の横にある << や >> で先月/次月分のカレンダーを表示できます。
  • 日付を選択すると、ページ名/yyyy-mm-ddというページを表示/編集できます。
  • 当日のページがある場合は、右隣に内容を表示します。
#calendar2( [ ページ名|* , yyyymm , off ] )
  • ページ名で表示するページの上位階層のページを指定できます。
    • ページ名を省略すると設置したページのページ名となります。
    • ページ名の代わりに * を指定すると上位階層はなし(同階層のyyyy-mm-ddを参照)になります。
  • yyyymm で表示するカレンダーの西暦と月を指定できます。省略時は当日の年月となります。
  • off を指定すると、当日ページを表示する機能がoffになります。

calendar_viewer 日記表示

  • calendar2プラグインで作成されたページを指定した位置に表示します。
#calendar_viewer( [ ページ名 , 表示ページ , 表示条件 , 区切り文字 ] )
  • ページ名 はcalendar2プラグインを設置しているページの名前を指定します。
  • 表示ページ は表示するページを次の中から指定します。
    • yyyy-mm: 指定した年月のページを表示します。
    • 数字  : 指定した件数分のページを表示します。
    • x*y  : 先頭より数えて x ページ目(先頭は0)から、y件づつ一覧表示します。
    • this  : 今月のページを一覧表示します。
  • 表示条件 は以下の中から指定します。
    • past : 今日以前のページを表示します。
    • future: 今日以降のページを表示します。
    • view : 過去から未来へ一覧表示します。
  • 区切り文字 は年月日の区切り文字を指定します。
    • / を指定すると 2008/01/01 となります。
    • 省略した場合は - になります。
備考
calendar2プラグインでは今日の日付の記事がない場合、記事を表示しないため、午前0時になったとたんに記事が表示されなくなります。calendar_viewは、日付が変わっても最新の記事を表示することができます。カレンダーそのものの表示は行わないため、カレンダー自体は calendar2(off) で表示します。

search 検索フォーム

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

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

tvote 投票フォーム

投票数順に自動で並び変わる投票用フォームを表示します。
新しい項目を投票者が任意に作ることが可能です。

#tvote( 項目1 , 項目2 , 項目3 ... )
  • 項目には最初に表示する項目を指定します。
  • 投票や項目の追加があると、ソースが自動で置き換わります。

管理人向け

nofollow 検索ロボット避け

記述したページを凍結した場合、ヘッダーに「NOFOLLOW」「NOINDEX」オプションを追加させます。
これらのオプションは検索エンジンに対し「このページを無視して欲しい」と主張します。
ただし全ての検索エンジンがこれに従うわけではありません。

#nofollow

description 検索用ページ説明

検索エンジン用にページの説明を記述します。
検索エンジンがページを収集した際、ここで指定した文章が検索結果に表示されます。
ただし全ての検索エンジンがこれに従うわけではありません。

#description(ページの説明)

keywords 検索用キーワード

検索エンジン用に検索キーワードを記述します。
検索エンジンで検索した際、ここで指定したキーワードで検索できるようになります。
ただし全ての検索エンジンがこれに従うわけではありません。

#keywords(検索キーワード)
  • 検索キーワードは ,(カンマ)区切りで複数指定できます。

md5 暗号化

選択したパスワードの形式に応じて、pukiwiki.ini.php に保存するパスワード用文字列を出力します。

コマンド型プラグイン
?plugin=md5&md5=文字列
  • パスワードのフォーマットは以下の8種類の中から選択できます。
    • DESあるいはMD5アルゴリズムを利用したPHP crypt() および LDAP crypt()
    • MD5 アルゴリズムを利用したPHP md5()、LDAP MD5、およびLDAP SMD5(シードあり)
    • SHA-1 アルゴリズムを利用したPHP sha()、LDAP SHA、および LDAP SSHA(シードあり)

memo メモ書き

記述した位置に複数行入力欄とボタンを表示します。
ボタンを押下すると入力欄の記述内容を更新します。

#memo
  • insertプラグインやarticleプラグインと似ていますが、入力した内容が入力欄の外へ出力されず、入力欄に留まる点が異なります。
  • 個人用のメモ代わりにPukiWikiを利用している場合、未整理の情報を一時的に溜め込むのに便利です。

tracker 定型ページ生成フォーム

定型的な項目をもったページを作るための入力フォームを表示します。
入力項目の定義は:config/plugin/tracker/ 以下に所定の書式でテンプレートを作成することで設定できます。

#tracker( 定義名 [, ベースページ名 ] )
  • 定義名はテンプレート名を指定します。
    • 省略時は :config/plugin/tracker/default
  • テンプレート名に続けてフォーム名 / リスト名を指定することができます。
    • ひとつのテンプレートに複数のフォーム形式 / リストフォーマットを用意したいときに便利です。
    • 例えば、#tracker(hoge/form_alternative) とすれば :config/plugin/tracker/hoge/form_alternative の内容をフォーム表示に使用しますし、#tracker_list(hoge/list_alternative) とすれば :config/plugin/tracker/hoge/list_alternative の内容をレイアウトに使用します。
  • ベースページ名はフォームから作成されるページの親階層となるページ名を指定します。省略時は設置したページとなります。
テンプレート
テンプレートは基本的に設置するtracker毎に1組(4ページ)作成します。
config/plugin/tracker/定義名
定義名テンプレートの項目の内容を記述します。
config/plugin/tracker/定義名/form
入力フォームの項目とレイアウトを記述します。
config/plugin/tracker/定義名/page
入力した内容をページ化する際のフォーマットを記述します。
config/plugin/tracker/定義名/list
tracker_listで表示するリストのレイアウトを記述します。
テーブル(|〜|)の書式指定(c) / ヘッダ(h) / フッタ(f) 行は特別扱いします。
予約項目
form で使用できる予約項目
[_name]  : 記事を記録するページ名を入力するフィールドを表示。省略可。
[_submit] : [追加]ボタンを表示。
page / list で使用できる予約項目
[_date] : 投稿日時。
[_page] : 実際に生成したページ名。ブラケットが付く。
[_refer]: #trackerを置いたページ。
[_base] : ページのプレフィクス。 tracker()/tracker_list() の第2引数が省略された場合は [_refer] と同じ内容。
[_name] : formの [_name] の内容そのもの。記事を記録するページ名の一部として使用する。
[_real] : 実際に生成したページ名から、[_refer] + '/'を除いた名前。デフォルトは [_name] と同じ内容。
以下のいずれかの条件に該当するときは、trackerプラグインが[_real]に連番を付与し、記事を記録するページ名を決定する。
・formに [_name] フィールドがない。
・[_name] が空か、ページ名として無効な文字を含む。
・[_refer] / [_name] という名前のページがすでに存在する。
list で使用できる予約項目
[_update] : ページの最終更新日時。
[_past] : 最終更新日時からの経過。

tracker_list 定型ページ一覧

trackerプラグインで作成したページを一覧表示します。

#tracker_list( [ 定義名 , ベースページ名 , ソート項目:ソート順 , 表示上限 ] )
  • 定義名はtrackerで指定したテンプレート名と同じものを指定します。
    • 省略時は :config/plugin/tracker/default が指定されたとみなします。
  • ベースページ名はtrackerで指定したベースページ名と同じものを指定します。
    • trackerでベースページ名を指定していない場合はtrackerを設置したページを指定します。
    • 省略時は設置したページとなります。
  • 第3項目には一覧表示のソートに使う項目およびソート順を指定します。
    • ソート項目は :config/plugin/tracker/テンプレート名 のfield項目内の項目から選択して下さい。
      • 省略時はページ名となります。
    • ソート順は以下の中からコロン(:)の後に指定してください。
      • ASC (昇順固定)
      • DESC (降順固定)
      • SORT_ASC (昇順:閲覧者が変更可)
      • SORT_DESC (降順:閲覧者が変更可)
例 stateを昇順(変更化)でソートする場合
#tracker_list(,,state:SORT_ASC)
  • また、セミコロン(;)で区切ることにより、複数のソート項目、ソート順を指定可能です。
例 3つの項目を指定してソートする場合
#tracker_list(,,state:SORT_ASC;priority:SORT_ASC;_real:SORT_DESC)
  • この場合は項目ごとに (1) [state]を昇順 -> (2) [priority]を昇順 -> (3) [_real](実際のページ名)を降順、の優先順位でソートします。
  • 表示上限は一覧表示するページ数の上限を指定します。省略時は全て表示されます。

プラグイン変更部分一覧

font
排出タグのstyle変更
table_edit
追加、編集の文字を追、編にそれぞれ変更(この文字が原因でセルの縦幅が広がるのを防ぐため)
第3引数にnolinkを指定する事で、表ページへのリンクを生成する機能を追加
表ページが存在しない場合、そのページを新規生成するリンクを表示するように変更
tsort(追加)
table_editの表をソート出力する独自プラグイン
tracker
作成するページ名を4桁固定(0001〜9999)に変更
デフォルトデザインの変更
tvote
排出タグ修正
article
返信用コメント欄を #comment_nospam に変更
pcomment
排出タグ変更、コメント部デザイン変更
pcomment_nospam
排出タグ変更
areaedit
編集時に最初にプレビュー表示されないように変更

トップ   差分 バックアップ リロード   一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
最終更新日時: 2013-03-11 (月) 02:05:05 (1984d)