PukiWiki/1.4/添付文書

  • topicpath, touchgraph の説明に含まれていた、未収録のページに対するhyperlinkを削除(代わりに本家のURLやpreformatted textを追加) -- henoheno 2006-06-04 (日) 11:51:54
  • tracker.inc.php (1.122) 以降向けのヘルプの叩き台 --- 書きかけ&仕様が修正される可能性があるので注意 -- 2007-11-08
    • 表形式で幅を固定した方が見やすい気がするほど、横長になってます。 -- 2007-11-08 (木) 02:07:12



S

search

種別

コマンド

ブロック型プラグイン

重要度

★★★★★

書式
?cmd=search{ [&word=検索文字列] [&type=OR] [&base=抽出条件] }

#search( [抽出条件1 [[,抽出条件2] [,抽出条件n]]] )

概要

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

複数の文字列を検索条件とする場合、「半角スペース」のみ、その区切り文字として利用可能です。

引数

コマンド:

パラメータには検索条件を指定します。

  • word − 検索する文字列を指定します。省略時は検索条件を入力フォームを表示します。
    • PLUGIN_SEARCH_DISABLE_GET_ACCESS が有効の場合は、URLにこのパラメータが含まれていても無視します。入力フォームを利用してください。
  • type − 'OR' 指定時、OR検索を行います。省略時はAND検索をおこないます。
  • base − 指定した文字列で始まるページのみを検索対象とします。
    • 一度全検索に切り替えた後で、再び抽出条件を指定する事はできません。また、途中で抽出条件を他のものに変更することはできません。
ブロック型プラグイン:

パラメータには検索条件フォームで表示する検索対象ページの抽出条件を指定します。

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

  • PLUGIN_SEARCH_DISABLE_GET_ACCESS GETメソッドによる検索を禁止する(DoS攻撃、SPAMbot、ワーム対策)
  • PLUGIN_SEARCH_MAX_LENGTH 検索する文字列として指定可能な最大文字数 (同)
  • PLUGIN_SEARCH_MAX_BASE 抽出条件として指定可能な件数の最大値

server

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#server
概要

サーバーの情報(サーバー名、サーバーソフトウエア、サーバー管理者)を表示します。

PKWK_SAFE_MODE が有効の場合、このプラグインは全てのリクエストを無効とします。

setlinebreak

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#setlinebreak( [on|off|default] )
概要

入力文章中の改行を改行とみなすかどうかの設定を行います。

PukiWikiが入力文章中の改行をどのように扱うかはpukiwiki.ini内の$line_breakの設定内容によって変わります(下記参照)。

入力文章$line_break=0;$line_break=1;
文章1
文章2
文章1文章2文章1
文章2

setlinebreakプラグインは該当ページの以降の行に関して、 $line_breakの設定に因らず改行をどのように扱うかを指定できるようになります。

引数

パラメータには以降の改行の扱いを指定します。 パラメータが省略された場合、改行とみなすかどうかについての設定を逆転させます。

  • on − 以降の文章で段落内の改行を改行とみなします($line_break=1と同様)。
  • off − 以降の文章で改行を無視します($line_break=0と同様)。 改行を行うためには行末にチルダを記述するか、 行中でbrプラグインを使用する必要があります。
  • default − 改行の扱いをそのサイトの$line_break設定に戻します。

showrss

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#showrss( RSSへのパス [,[default|menubar|recent] [,キャッシュ生存時間 [,1 ]]] )
概要

指定されたRSSを取得し、一覧表示します。

ページの解釈毎にRSSの取得を行う為、頻繁に参照されるページでshowrssを使用される場合はキャッシュ機能を使うことをお勧めします。相手サイトの更新頻度に応じてキャッシュの生存時間を適宜設定して下さい。

引数

RSSへのパスにはRSSへのファイルパスやURLを指定します。

テンプレート名には取得したRSSの表示方法を指定します。省略時はdefault となります。

  • default − 単純にページを列挙します。
  • menubar − ページ名の前に黒丸をつけます。MenuBarなど、横幅に制限にある場合に便利です。
  • recent − recentプラグインの出力のように、ページ名の前に黒丸をつけて更新日付が変わる毎に更新日付を出力します。

キャッシュ生存時間はキャッシュをクリアする期限(1時間単位)です。省略時、キャッシュ機能は無効となります。

第4引数はRSSを取得した日付を表示するかどうかを指定します。1を指定した場合は表示します。省略時は表示しません。

プラグイン内設定

  • PLUGIN_SHOWRSS_USAGE エラー時に表示される使用方法
備考

動作させるためにはPHP の xml extension が必要です。

?cmd=showrss を実行することでPHP のxml extension 及びmbstring extension が有効になっているかを確認できます。
ただし、PKWK_SAFE_MODE が有効の場合、確認機能が無効となります。

size

種別

インライン型プラグイン

重要度

★★★☆☆

書式
&size( ピクセル数値[px]|倍率% ){ 文字列 };
概要

文字の大きさを指定します。

引数

ピクセル数値には文字の大きさを指定します。

ピクセル数値の代わりに、倍率をパーセンテージで指定することもできます。
この場合、ピクセル数値と区別するために、% を最後につける必要があります(省略不可)。

指定した文字の大きさが、大きすぎる(小さすぎる)場合、プラグイン内設定の値が採用されます。

文字列には文字の大きさを変更する文字列を指定します。

プラグイン内設定

  • PLUGIN_SIZE_MAX 出力可能な最大文字サイズ (ピクセル数値)
  • PLUGIN_SIZE_MIN 出力可能な最小文字サイズ (ピクセル数値)
  • PLUGIN_SIZE_PIXEL_DEFAULT 倍率を使用時の基準サイズ (ピクセル数値)
  • PLUGIN_SIZE_PERCENT_MAX 引数として指定可能な最大倍率 (パーセンテージの数値)
  • PLUGIN_SIZE_PERCENT_MIN 引数として指定可能な最小倍率 (パーセンテージの数値)
  • PLUGIN_SIZE_USAGE 引数未指定時に表示されるヘルプ
  • PLUGIN_SIZE_REGEX 引数入力を許可する文字列の正規表現
    • 通常は、変更する必要がありません

source

種別

コマンド

重要度

★☆☆☆☆

書式
?cmd=source &page=ページ名
概要

指定したページの整形前のソースを表示します。

引数

ページ名にはソースを表示するページ名を指定します。ページ名はエンコードされている必要があります。

備考

PKWK_SAFE_MODE が有効の場合、このプラグインは全てのリクエストを無効とします。

stationary

種別

コマンド

ブロック型プラグイン

インライン型プラグイン

重要度

★☆☆☆☆

書式

?plugin=stationary

#stationary

概要

stationaryプラグインはプラグイン作成を試みる人のための雛形として作成されました。
stationaryプラグインは単純な文字列を表示する以外は何もしません。

プラグイン内設定

  • PLUGIN_STATIONARY_MAX プラグイン内で定数定義を行うサンプル
概要

PKWK_SAFE_MODE または PKWK_READONLY が有効の場合、このプラグインは全てのリクエストを無効とします。


T

template

種別

コマンド

重要度

★★★★☆

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

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

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

引数

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

プラグイン内設定

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

PKWK_READONLY が有効の場合、このプラグインは全てのリクエストを無効とします。

topicpath

種別

インライン型プラグイン

ブロック型プラグイン

重要度

★☆☆☆☆

書式

&topicpath ;

#topicpath

概要

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

例えば

[[PukiWiki/ツアー]]
というページに#topicpathと書くと、以下の様な表記に置き換わります。
[[Top>FrontPage]] / [[PukiWiki>PukiWiki]] / [[ツアー>PukiWiki/ツアー]]

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

  1. 「ほげ/ふが/げほ」など、2〜3階層以上の深いページでページの行き来をしやすくするために表示する
  2. スキンに組み込み、ページタイトル下のURLの代わりに全てのページで表示する
プラグイン内設定

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

スキンに組み込む場合は、pukiwiki.skin.php の SKIN_DEFAULT_DISABLE_TOPICPATH に 0を指定して下さい。

touchgraph

種別

コマンド

重要度

★☆☆☆☆

書式
?plugin=touchgraph
概要

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

tracker

種別

(コマンド)

ブロック型プラグイン

重要度

★★★★☆

書式

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

概要

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

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

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

引数

定義名は #tracker(hoge) のようにtrackerのテンプレート名を指定します。省略時は PLUGIN_TRACKER_DEFAULT_CONFIG の設定値が指定されたとみなします。
テンプレート名に続けてフォーム名を指定することができます。ひとつのテンプレートに複数の入力フォーム形式を用意したいときに便利です。例えば、#tracker(hoge/form_alternative) とすれば :config/plugin/tracker/hoge/form_alternative の内容をフォーム表示に使用します。

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

テンプレート

テンプレートは基本的に設置するtracker毎に1組(4ページ)作成します。

  • :config/plugin/tracker/hoge
    hogeテンプレートの項目の内容を記述します。(必須)
  • :config/plugin/tracker/hoge/form
    trackerで表示される入力フォームの項目とレイアウトを記述します。
  • :config/plugin/tracker/hoge/page
    入力した内容をページ化する際のフォーマットを記述します。(必須)
  • :config/plugin/tracker/hoge/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_EXCLUDE_PATTERN tracker_listで表示しない配下ページ名を正規表現で指定する
  • TRACKER_LIST_SHOW_ERROR_PAGE 項目の取り出しに失敗したページを一覧に表示するか
  • PLUGIN_TRACKER_LIST_SORT_LIMIT リストをソートする時に、ソート対象とする項目の上限
  • PLUGIN_TRACKER_USAGE trackerプラグインのエラー時に表示される使用方法
  • PLUGIN_TRACKER_LIST_USAGE tracker_listプラグインのエラー時に表示される使用方法
  • PLUGIN_TRACKER_DEFAULT_CONFIG テンプレート名を省略した時に、デフォルトで使われるテンプレート名
    • 初期設定値はdefault で、ページ名:config/plugin/tracker/default を指す
  • PLUGIN_TRACKER_DEFAULT_FORM tracker で表示する、フォームのテンプレートを記録している配下ページ名
    • :config/plugin/tracker/テンプレート名/ より下の部分
  • PLUGIN_TRACKER_DEFAULT_PAGE 各ページの記録・項目読み込み時に利用する、テンプレートデータを記録している配下ページ名
    • :config/plugin/tracker/テンプレート名/ より下の部分
  • PLUGIN_TRACKER_DEFAULT_LIST tracker_list でページ一覧に利用する、テンプレートデータを記録している配下ページ名
    • :config/plugin/tracker/テンプレート名/ より下の部分
  • PLUGIN_TRACKER_DEFAULT_ORDER tracker_list でソート方法が省略された時に使われるソート方法
    • 引数に入力するものと同じ形式で記述
  • PLUGIN_TRACKER_DEFAULT_LIMIT tracker_list で表示上限が省略された時に使われる値
    • 0 を指定すると全て表示
プラグイン内設定(変更する必要がないもの)

  • PLUGIN_TRACKER_SORT_TYPE_REGULAR ソート用のしきい値(通常比較ソート)
  • PLUGIN_TRACKER_SORT_TYPE_NUMERIC ソート用のしきい値(数値的比較ソート)
  • PLUGIN_TRACKER_SORT_TYPE_STRING ソート用のしきい値(文字列比較ソート)
  • PLUGIN_TRACKER_SORT_TYPE_NATURAL ソート用のしきい値(自然順比較ソート)
  • SORT_NATURAL (現状はtracker プログラム内部でのみ使われている)自然順比較ソートのタイプ名
  • PLUGIN_TRACKER_SORT_ORDER_DESC ソート用のしきい値(降順ソートオーダー)
  • PLUGIN_TRACKER_SORT_ORDER_ASC ソート用のしきい値(昇順ソートオーダー)
  • PLUGIN_TRACKER_SORT_ORDER_DEFAULT ソート順を省略した場合に使われるソートオーダー
    • ソートオーダーのしきい値を入れる
備考

PKWK_READONLY が有効の場合、このプラグインは全てのリクエストを無効とします。

tracker_list

種別

(コマンド)

ブロック型プラグイン

重要度

★★★★☆

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

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

引数

定義名はtrackerプラグインで指定したテンプレート名と同じものを指定します。省略時はPLUGIN_TRACKER_DEFAULT_CONFIG に設定されているテンプレート名が指定されたとみなします。
テンプレート名に続けてリスト名を指定することができます。ひとつのテンプレートに複数のリストフォーマットを用意したいときに便利です。例えば、#tracker_list(hoge/list_alternative) とすれば :config/plugin/tracker/hoge/list_alternative の内容をレイアウトに使用します。

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

第3項目には一覧表示のソートに使う項目およびソート順を指定します。ソート項目は :config/plugin/tracker/テンプレート名 のfield項目内の項目から選択して下さい。省略時はPLUGIN_TRACKER_DEFAULT_ORDER の設定値が指定されたと扱います。
ソート順は、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](実際のページ名)を降順、の優先順位でソートします。

表示上限は一覧表示するページ数の上限を指定します。省略時はPLUGIN_TRACKER_DEFAULT_LIMIT の設定値が指定されたと扱います。

プラグイン内設定

tracker プラグインで設定したものが使われます。


U

unfreeze

種別

コマンド

重要度

★★★☆☆

書式
?plugin=unfreeze &page=ページ名
概要

ページの凍結を解除します。

引数

ページ名には解除するページ名を指定します。ページ名はエンコードされている必要があります。

プラグイン内設定

  • PLUGIN_UNFREEZE_EDIT 凍結解除時にページの編集フォームを表示するか

update_entities

種別

コマンド

重要度

★☆☆☆☆

書式
?plugin=update_entities
概要

CACHE_DIR/entities.dat を生成します。

entities.datはHTMLの実体参照を判定するために用いられるテーブルを格納したファイルです。普通、利用者や管理者が意識する機会はありません。

プラグイン内設定

  • W3C_XHTML_DTD_LOCATION DTDの場所
備考

配布ファイルに生成済のentities.datが付属するため、通常使用する機会はありません。

PKWK_READONLY が有効の場合、このプラグインは全てのリクエストを無効とします。



*1 昇順
*2 降順
*3 昇順
*4 降順

トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2009-05-25 (月) 03:41:46
Site admin: PukiWiki Development Team

PukiWiki 1.5.2+ © 2001-2019 PukiWiki Development Team. Powered by PHP 5.6.40-0+deb8u7. HTML convert time: 0.278 sec.

OSDN