PukiWiki/1.4/マニュアル/プラグイン/t

Sat, 06 Apr 2013 04:35:41 JST (2798d)

tb &aname(s5056787,super,full)\{†};

種別

コマンド

重要度

★☆☆☆☆

書式
?plugin=tb
&tb_id=TrackBackID
&__mode=
view|
rss
概要

TrackBack?の一覧を表示します。

POSTされた場合は他サイトからのTrackBack?に反応します。

引数

&tb_idには表示対象ページのTrackBackIDを指定します。

&__modeには一覧表示方法を指定します。

  • view − 人間が見やすい形式で表示します。
  • rss − RSS形式で表示します。
備考

pukiwiki.ini.php で、TrackBack?を使用する設定($trackback = 1を指定)が行われている必要があります。

template &aname(j2adfc3d,super,full)\{†};

種別

コマンド

重要度

★★★★☆

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

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

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

引数

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

プラグイン内設定

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

topicpath &aname(vd55c067,super,full)\{†};

種別

インライン型プラグイン

ブロック型プラグイン

重要度

★☆☆☆☆

書式

&topicpath
;

#topicpath

概要

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

パンくずリスト(Topic path)は現在参照しているウェブページの階層を表現するユーザーインターフェースです。例えばPukiWiki/ツアー?というページに#topicpathと書くと、以下の様な表記に置き換わります。

[[Top>FrontPage]]/[[PukiWiki>PukiWiki]]/[[ツアー>PukiWiki/ツアー]]

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

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

    スキンに組み込む例(pukiwiki.skin.ja.php の30行目あたり)

    <?php if ($is_page) { ?>
    <span class="small"><?php require_once(PLUGIN_DIR.'topicpath.inc.php'); echo plugin_topicpath_convert(); ?></span>
    <?php } ?>
プラグイン内設定

  • PLUGIN_TOPICPATH_TOP_DISPLAY defaultpageを一番最初に表示するかどうか。
  • PLUGIN_TOPICPATH_TOP_LABEL $defaultpageに対するラベル
  • PLUGIN_TOPICPATH_TOP_SEPARATOR 階層を区切るセパレータ
  • PLUGIN_TOPICPATH_THIS_PAGE_DISPLAY 現在表示中のページに対するリンクを表示するかどうか
  • PLUGIN_TOPICPATH_THIS_PAGE_LINK 現在表示中のページに対してリンクするかどうか

touchgraph &aname(p93402bd,super,full)\{†};

種別

コマンド

重要度

★☆☆☆☆

書式
?plugin=touchgraph
概要

TouchGraphWikiBrowser?用のインデックスを作ります。

tracker &aname(rf5296e2,super,full)\{†};

種別

(コマンド)

ブロック型プラグイン

重要度

★★★★☆

書式

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

概要

bugtrackプラグインのように、定型的な項目をもったページを作るための入力フォームを表示します。

入力項目が固定されているbugtrackプラグインと機能は似ていますが、入力項目を簡単に変更できる点が違います。FAQ,BBS,書評,TODOリストなど使い道はアイディア次第です。

入力項目の定義は:config/plugin/tracker/ 以下に所定の書式でページを作成することで設定できます。bugtrackプラグイン互換の入力項目定義が:config/plugin/tracker/default に用意されているので参考にして下さい。

引数

定義名はtrackerのプラグイン定義名を指定します。省略時は定義名defaultが指定されたとみなします。

ベースページ名はフォームから作成されるページの親階層となるページ名を指定します。省略時は設置したページとなります。

プラグイン内設定

  • TRACKER_LIST_EXCLUDE_PATTERN tracker_listで表示しないページ名を正規表現で指定する
  • TRACKER_LIST_SHOW_ERROR_PAGE 項目の取り出しに失敗したページを一覧に表示するか

基本的に設置するtracker毎に1組(4ページ)作成します。

:config/plugin/tracker/hoge
hogeテンプレートの項目の内容を記述します
:config/plugin/tracker/hoge/form
入力フォームの項目とレイアウトを記述します
:config/plugin/tracker/hoge/page
入力した内容をページ化する際のテンプレートを記述します
:config/plugin/tracker/hoge/list
tracker_listで表示するリストのレイアウトを記述します

テーブル(|〜|)の書式指定(c)/ヘッダ(h)/フッタ(f)行は特別扱いします
  • 目的のページに tracker プラグインを設置します。引数のテンプレート名を省略すると、:config/plugin/tracker/default の項目定義を使用します。
    #tracker(hoge)
    #tracker_list(hoge)
  • テンプレート名に続けてフォーム名/リスト名を指定することができます。

    ひとつのテンプレートに複数のフォーム形式/リストフォーマットを用意したいときに便利です。
    • :config/plugin/tracker/hoge/form_alternativeページの内容をフォーム表示に使用します。
      #tracker(hoge/form_alternative)
    • :config/plugin/tracker/hoge/list_alternativeページの内容をリストフォーマットに使用します。
      #tracker_list(hoge/list_alternative)
  • 第2引数 : 投稿されたトラッキング項目を記録する基準ページの指定
    #tracker(hoge,記録ページ)
    のように指定すると、trackerによって作成されるページ名は 記録ページ/1,記録ページ/2...のようになります。リストも同様に
    #tracker_list(hoge,記録ページ)
    と指定することで、記録ページ配下の項目をリストアップするようになります。
  • tracker_listの第3引数で、リストのソート順序を指定することができます。

    #tracker_list(,,state:SORT_ASC;priority:SORT_ASC;_real:SORT_DESC)
    項目ごとに(1)[state]を昇順->(2)[priority]を昇順->(3)[_real](実際のページ名)を降順、の優先順位でソートします。

予約項目 &aname(h3c6df38,super,full)\{†};

formで使用できる予約項目 &aname(z3b0da26,super,full)\{†};

  • [_name] : 記事を記録するページ名を入力するフィールドを表示。省略可。
  • [_submit] : [追加]ボタンを表示。

page/listで使用できる予約項目 &aname(jc2ef793,super,full)\{†};

  • [_date] : 投稿日時
  • [_page] : 実際に生成したページ名。ブラケットが付く。
  • [_refer] : #trackerを置いたページ
  • [_base] : ページのプレフィクス。 tracker()/tracker_list()の第2引数が省略された場合は[_refer]と同じ内容。
  • [_name] : formの[_name]の内容そのもの。記事を記録するページ名の一部として使用する。
  • [_real] : 実際に生成したページ名から、[_refer] + '/'を除いた名前。デフォルトは[_name]と同じ内容。

    以下のいずれかの条件に該当するときは、trackerプラグインが[_real]に連番を付与し、記事を記録するページ名を決定する。
    1. formに[_name]フィールドがない
    2. [_name]が空か、ページ名として無効な文字を含む
    3. [_refer]/[_name]という名前のページがすでに存在する

listで使用できる予約項目 &aname(vfc53dd5,super,full)\{†};

  • [_update] : ページの最終更新日時
  • [_past] : 最終更新日時からの経過

trackerで使用できる項目形式のまとめ &aname(types,super,full)\{†};

形式フォームに出力されるタグオプションリスト出力時の整形
text<input type="text" ...>size属性の値
page<input type="text" ...>size属性の値有効なページ名のときはリンクを張る
title<input type="text" ...>size属性の値固定アンカーを外し、htmlタグを取り除く
format<input type="text" ...>size属性の値configのNOT NULLあるいはNULLで指定された書式を適用
textarea<textarea ...>cols属性の値,rows属性の値
select<select ...>size属性の値[,multiple]configの項目リストで置換
radio<input type="radio" ...>-configの項目リストで置換
checkbox<input type="checkbox" ...>-configの項目リストで置換
hidden<input type="hidden" ...>--
file<input type="file" ...>size属性の値-
submit<input type="submit" ...>--

tracker_list &aname(t78d6d0a,super,full)\{†};

種別

(コマンド)

ブロック型プラグイン

重要度

★★★★☆

書式
#tracker_list(
[定義名]
[,[ベースページ名]
[,[ソート項目]
[,[ascending]
[,表示上限]
]]]
)
概要

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

引数

定義名はtrackerプラグインで指定した定義名と同じものを指定します。省略時は定義名defaultが指定されたとみなします。

ベースページ名はtrackerプラグインで指定したベースページ名と同じものを指定します。trackerプラグインでベースページ名を指定していない場合はtrackerプラグインを設置したページを指定します。省略時は設置したページとなります。

ソート項目は一覧表示のソートに使う項目を指定します。:config/plugin/tracker/定義名のページのfield項目内の項目から選択して下さい。省略時はページ名となります。

第4項目にはソート順を指定します。ascendingを指定すると昇順、それ以外は降順です。省略時は降順となります。

表示上限は一覧表示するページ数の上限を指定します。省略時は全て表示されます。