コマンド
ブロック型プラグイン
★★★★★
#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 となります。
キャッシュ生存時間はキャッシュをクリアする期限(1時間単位)です。省略時、キャッシュ機能は無効となります。
第4引数はRSSを取得した日付を表示するかどうかを指定します。1を指定した場合は表示します。省略時は表示しません。
動作させるためにはPHP の xml extension が必要です。
インライン型プラグイン
★★★☆☆
文字の大きさを指定します。
ピクセル数値には文字の大きさを指定します。
文字列は文字の大きさを変更する文字列を指定します。
コマンド
★☆☆☆☆
指定したページの整形前のソースを表示します。
ページ名にはソースを表示するページ名を指定します。ページ名はエンコードされている必要があります。
コマンド
ブロック型プラグイン
インライン型プラグイン
★☆☆☆☆
?plugin=stationary
#stationary
&stationary;
stationaryプラグインはプラグイン作成を試みる人のための雛形として作成されました。
stationaryプラグインは単純な文字列を表示する以外は何もしません。
コマンド
★★★★☆
既存のページをテンプレートとしてページを新規作成します。
ページの新規作成時の雛形とするページの読込み機能との差異は、テンプレートプラグインが雛形とする範囲(行単位)に選択できるのに対して、ページの新規作成で読み込むテンプレートは全文をテキストエリアにコピーする点にあります。
テンプレートページには雛形とするページを指定します。ページ名はエンコードされている必要があります。
インライン型プラグイン
ブロック型プラグイン
★☆☆☆☆
&topicpath ;
#topicpath
パンくずリスト(topicpath)と呼ばれる、現在参照しているウェブページの階層を表現するユーザーインターフェースを提供するプラグインです。
例えば
[[PukiWiki/ツアー]]というページに#topicpathと書くと、以下の様な表記に置き換わります。
[[Top>FrontPage]] / [[PukiWiki>PukiWiki]] / [[ツアー>PukiWiki/ツアー]]
基本的には以下の2通りの使い方を想定しています。
スキンに組み込む場合は、pukiwiki.skin.php の SKIN_DEFAULT_DISABLE_TOPICPATH に 0を指定して下さい。
コマンド
★☆☆☆☆
TouchGraphWikiBrowser用のインデックスを作ります。
(コマンド)
ブロック型プラグイン
★★★★☆
#tracker( [定義名] [,ベースページ名] )
bugtrackプラグインのように、定型的な項目をもったページを作るための入力フォームを表示します。
入力項目が固定されているbugtrackプラグインと機能は似ていますが、入力項目を簡単に変更できる点が違います。FAQ,BBS,書評,TODOリストなど使い道はアイディア次第です。
入力項目の定義は:config/plugin/tracker/ 以下に所定の書式でテンプレートを作成することで設定できます。bugtrackプラグイン互換の入力項目テンプレートが :config/plugin/tracker/default に用意されているので参考にして下さい。
定義名は #tracker(hoge) のように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ページ)作成します。
hogeテンプレートの項目の内容を記述します。
入力フォームの項目とレイアウトを記述します。
入力した内容をページ化する際のフォーマットを記述します。
tracker_listで表示するリストのレイアウトを記述します。テーブル(|~|)の書式指定(c) / ヘッダ(h) / フッタ(f) 行は特別扱いします。
(コマンド)
ブロック型プラグイン
★★★★☆
trackerプラグインで作成したページを一覧表示します。
定義名はtrackerプラグインで指定したテンプレート名と同じものを指定します。省略時は :config/plugin/tracker/default が指定されたとみなします。
ベースページ名はtrackerプラグインで指定したベースページ名と同じものを指定します。trackerプラグインでベースページ名を指定していない場合はtrackerプラグインを設置したページを指定します。省略時は設置したページとなります。
第3項目には一覧表示のソートに使う項目およびソート順を指定します。ソート項目は :config/plugin/tracker/テンプレート名 のfield項目内の項目から選択して下さい。省略時はページ名となります。ソート順は、ASC*1、DESC*2、SORT_ASC*3、SORT_DESC*4 をコロン(:)の後に指定してください。また、セミコロン(;)で区切ることにより、複数のソート項目、ソート順を指定可能です。例えば、#tracker_list(,,state:SORT_ASC;priority:SORT_ASC;_real:SORT_DESC) と指定した場合は、項目ごとに (1) [state]を昇順 -> (2) [priority]を昇順 -> (3) [_real](実際のページ名)を降順、の優先順位でソートします。
表示上限は一覧表示するページ数の上限を指定します。省略時は全て表示されます。
コマンド
★★★☆☆
ページの凍結を解除します。
ページ名には解除するページ名を指定します。ページ名はエンコードされている必要があります。
コマンド
★☆☆☆☆
CACHE_DIR/entities.dat を生成します。
entities.datはHTMLの実体参照を判定するために用いられるテーブルを格納したファイルです。普通、利用者や管理者が意識する機会はありません。
配布ファイルに生成済のentities.datが付属するため、通常使用する機会はありません。