PikoWiki
PukiWiki/1.4/Manual/Plugin/S-U
Start:
#nofollow
#norelated
#setlinebreak(off)
#navi(../)
#contents
------------------------------
* S [#mee1bd43]
**search [#ba94ddfd]
:種別|
~コマンド
~ブロック型プラグイン
:重要度|
~★★★★★
:書式|
''?cmd=search''{
[&color(blue){&word=検索文字列};]
[&color(blue){&type=OR};]
[&color(blue){&base=抽出条件};]
}
~''#search(''
[&color(blue){抽出条件1};
[[,&color(blue){抽出条件2};]
[,&color(blue){抽出条件n};]]]
'')''
:概要|
~検索文字列の入力フォームを表示し、
指定した文字列を含むページの検索を行います。
:引数|
~'''コマンド:'''
~パラメータには検索条件を指定します。
--word － 検索する文字列を指定します。省略時は検索条件を...
--type － 'OR' 指定時、OR検索を行います。省略時はAND検索...
:|
'''ブロック型プラグイン:'''
~パラメータには検索条件フォームで表示する検索対象ページの...
--抽出条件1,2,…n － 入力フォームの抽出条件の選択肢を表示...
抽出条件選択時、選択した語句で始まるページ群に対してのみ...
特定のページ群だけを検索したい場合、検索処理がより早く終...
抽出条件を選択しなかった場合は全ページが対象となります。
省略時は選択欄が表示されず、常に全ページが検索対象となり...
:プラグイン内設定|~
--PLUGIN_SEARCH_DISABLE_GET_ACCESS GETメソッドによる検索...
--PLUGIN_SEARCH_MAX_LENGTH 検索する文字列として指定可能...
--PLUGIN_SEARCH_MAX_BASE 抽出条件として指定可能な件数の...
**server [#d69aa1d0]
:種別|
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
''#server''
:概要|
~サーバーの情報(サーバー名、サーバーソフトウエア、サーバ...
**setlinebreak [#va79297e]
:種別|
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
''#setlinebreak(''
[&color(blue){on};|&color(blue){off};|&color(blue){defaul...
'')''
:概要|
~入力文章中の改行を改行とみなすかどうかの設定を行います。
~PukiWikiが入力文章中の改行をどのように扱うかはpukiwiki.i...
|入力文章|$line_break=0;|$line_break=1;|h
|文章１&br;文章２|文章１文章２|文章１&br;文章２|
~setlinebreakプラグインは該当ページの以降の行に関して、
$line_breakの設定に因らず改行をどのように扱うかを指定でき...
:引数|
~パラメータには以降の改行の扱いを指定します。
パラメータが省略された場合、改行とみなすかどうかについて...
--on － 以降の文章で段落内の改行を改行とみなします($line_...
--off － 以降の文章で改行を無視します($line_break=0と同様...
改行を行うためには行末にチルダを記述するか、
行中で[[brプラグイン>../A-D#g693034c]]を使用する必要があ...
--default － 改行の扱いをそのサイトの$line_break設定に戻...
**showrss [#v7316017]
:種別|
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
''#showrss(''
&color(blue){RSSへのパス};
[,[&color(blue){default};|&color(blue){menubar};|&color(b...
[,[&color(blue){キャッシュ生存時間};]
[,&color(blue){1};
]]]
'')''
:概要|
~指定されたRSSを取得し、一覧表示します。
~ページの解釈毎にRSSの取得を行う為、頻繁に参照されるペー...
:引数|
~RSSへのパスにはRSSへのファイルパスやURLを指定します。
~テンプレート名には取得したRSSの表示方法を指定します。省...
--default － 単純にページを列挙します。
--menubar － ページ名の前に黒丸をつけます。MenuBarなど、...
--recent － recentプラグインの出力のように、ページ名の前...
:|
~キャッシュ生存時間はキャッシュをクリアする期限（１時間単...
~第４引数はRSSを取得した日付を表示するかどうかを指定しま...
:プラグイン内設定|~
--PLUGIN_SHOWRSS_USAGE エラー時に表示される使用方法
:備考|
~動作させるためにはPHP の xml extension が必要です。
**size [#e5db48c0]
:種別|
~インライン型プラグイン
:重要度|
~★★★☆☆
:書式|
''&size(''
&color(blue){ピクセル数値};
''){''
&color(blue){文字列};
''};''
:概要|
~文字の大きさを指定します。
:引数|
~ピクセル数値には文字の大きさを指定します。
~文字列は文字の大きさを変更する文字列を指定します。
:プラグイン内設定|~
--PLUGIN_SIZE_MAX 引数として指定可能な最大文字サイズ
--PLUGIN_SIZE_MIN 引数として指定可能な最小文字サイズ
--PLUGIN_SIZE_USAGE 引数未指定時に表示されるヘルプ
**source [#k23d3e24]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
''?cmd=source''
&color(blue){&page=ページ名};
:概要|
~指定したページの整形前のソースを表示します。
:引数|
~ページ名にはソースを表示するページ名を指定します。ページ...
**stationary [#ifad4486]
:種別|
~コマンド
~ブロック型プラグイン
~インライン型プラグイン
:重要度|
~★☆☆☆☆
:書式|
~''?plugin=stationary''
~''#stationary''
~''&stationary;''
:概要|
~stationaryプラグインはプラグイン作成を試みる人のための雛...
stationaryプラグインは単純な文字列を表示する以外は何もし...
:プラグイン内設定|~
--PLUGIN_STATIONARY_MAX プラグイン内で定数定義を行うサン...
------------------------------
* T [#u58dc027]
**template [#j2adfc3d]
:種別|
~コマンド
:重要度|
~★★★★☆
:書式|
''?plugin=template''
&color(blue){&refer=テンプレートページ};
:概要|
~既存のページをテンプレートとしてページを新規作成します。
~ページの新規作成時の雛形とするページの読込み機能との差異...
:引数|
~テンプレートページには雛形とするページを指定します。ペー...
:プラグイン内設定|~
--MAX_LEN 雛形の開始／終了位置を指定する欄で表示される最...
**topicpath [#vd55c067]
:種別|
~インライン型プラグイン
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
~''&topicpath''
'';''
~''#topicpath''
:概要|
~パンくずリスト(topicpath)と呼ばれる、現在参照しているウ...
~例えば
[[PukiWiki/ツアー]]
というページに#topicpathと書くと、以下の様な表記に置き換...
[[Top>FrontPage]] / [[PukiWiki>PukiWiki]] / [[ツアー>Puk...
~基本的には以下の２通りの使い方を想定しています。
++「ほげ/ふが/げほ」など、２～３階層以上の深いページでペ...
++スキンに組み込み、ページタイトル下の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_DEFAUL...
**touchgraph [#p93402bd]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
''?plugin=touchgraph''
:概要|
~[[TouchGraphWikiBrowser>http://www.touchgraph.com/]]用の...
**tracker [#rf5296e2]
:種別|
~（コマンド）
~ブロック型プラグイン
:重要度|
~★★★★☆
:書式|
~''#tracker(''
[&color(blue){定義名};]
[,&color(blue){ベースページ名};]
'')''
:概要|
~[[bugtrack>../A-D#a83293e8]]プラグインのように、定型的な...
~入力項目が固定されている[[bugtrack>../A-D#a83293e8]]プラ...
~入力項目の定義は:config/plugin/tracker/ 以下に所定の書式...
:引数|
~定義名は #tracker(hoge) のようにtrackerのテンプレート名...
~テンプレート名に続けてフォーム名 / リスト名を指定するこ...
~ベースページ名はフォームから作成されるページの親階層とな...
:プラグイン内設定|~
--TRACKER_LIST_EXCLUDE_PATTERN tracker_listで表示しない...
--TRACKER_LIST_SHOW_ERROR_PAGE 項目の取り出しに失敗した...
:テンプレート|~
~テンプレートは基本的に設置するtracker毎に１組（4ページ）...
--:config/plugin/tracker/hoge
~hogeテンプレートの項目の内容を記述します。
--:config/plugin/tracker/hoge/form
~入力フォームの項目とレイアウトを記述します。
--:config/plugin/tracker/default/page
~入力した内容をページ化する際のフォーマットを記述します。
--:config/plugin/tracker/hoge/list
~tracker_listで表示するリストのレイアウトを記述します。テ...
:予約項目|~
--form で使用できる予約項目
---[_name] : 記事を記録するページ名を入力するフィールドを...
---[_submit] : [追加]ボタンを表示。
--page / list で使用できる予約項目
---[_date] : 投稿日時。
---[_page] : 実際に生成したページ名。ブラケットが付く。
---[_refer] : #trackerを置いたページ。
---[_base] : ページのプレフィクス。 tracker()/tracker_lis...
---[_name] : formの [_name] の内容そのもの。記事を記録す...
---[_real] : 実際に生成したページ名から、[_refer] + '/'を...
・formに [_name] フィールドがない。~
・[_name] が空か、ページ名として無効な文字を含む。~
・[_refer] / [_name] という名前のページがすでに存在する。~
--list で使用できる予約項目
---[_update] : ページの最終更新日時。
---[_past] : 最終更新日時からの経過。
**tracker_list [#t78d6d0a]
:種別|
~（コマンド）
~ブロック型プラグイン
:重要度|
~★★★★☆
:書式|
''#tracker_list(''
[&color(blue){定義名};]
[,[&color(blue){ベースページ名};]
[,[[&color(blue){ソート項目};]
:[&color(blue){ソート順};]]
[,&color(blue){表示上限};]
]]]
'')''
:概要|
~[[tracker>./#rf5296e2]]プラグインで作成したページを一覧...
:引数|
~定義名は[[tracker>./#rf5296e2]]プラグインで指定したテン...
~ベースページ名は[[tracker>./#rf5296e2]]プラグインで指定...
~第３項目には一覧表示のソートに使う項目およびソート順を指...
~表示上限は一覧表示するページ数の上限を指定します。省略時...
------------------------------
* U [#q0183edd]
**unfreeze [#v039be15]
:種別|
~コマンド
:重要度|
~★★★☆☆
:書式|
''?plugin=unfreeze''
&color(blue){&page=ページ名};
:概要|
~ページの凍結を解除します。
:引数|
~ページ名には解除するページ名を指定します。ページ名はエン...
:プラグイン内設定|~
--PLUGIN_UNFREEZE_EDIT 凍結解除時にページの編集フォーム...
**update_entities [#r62603ec]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
''?plugin=update_entities''
:概要|
~CACHE_DIR/entities.dat を生成します。
~entities.datはHTMLの実体参照を判定するために用いられるテ...
:プラグイン内設定|~
--W3C_XHTML_DTD_LOCATION DTDの場所
:備考|
~配布ファイルに生成済のentities.datが付属するため、通常使...
#navi(../)
#setlinebreak(default)
End:
#nofollow
#norelated
#setlinebreak(off)
#navi(../)
#contents
------------------------------
* S [#mee1bd43]
**search [#ba94ddfd]
:種別|
~コマンド
~ブロック型プラグイン
:重要度|
~★★★★★
:書式|
''?cmd=search''{
[&color(blue){&word=検索文字列};]
[&color(blue){&type=OR};]
[&color(blue){&base=抽出条件};]
}
~''#search(''
[&color(blue){抽出条件1};
[[,&color(blue){抽出条件2};]
[,&color(blue){抽出条件n};]]]
'')''
:概要|
~検索文字列の入力フォームを表示し、
指定した文字列を含むページの検索を行います。
:引数|
~'''コマンド:'''
~パラメータには検索条件を指定します。
--word － 検索する文字列を指定します。省略時は検索条件を...
--type － 'OR' 指定時、OR検索を行います。省略時はAND検索...
:|
'''ブロック型プラグイン:'''
~パラメータには検索条件フォームで表示する検索対象ページの...
--抽出条件1,2,…n － 入力フォームの抽出条件の選択肢を表示...
抽出条件選択時、選択した語句で始まるページ群に対してのみ...
特定のページ群だけを検索したい場合、検索処理がより早く終...
抽出条件を選択しなかった場合は全ページが対象となります。
省略時は選択欄が表示されず、常に全ページが検索対象となり...
:プラグイン内設定|~
--PLUGIN_SEARCH_DISABLE_GET_ACCESS GETメソッドによる検索...
--PLUGIN_SEARCH_MAX_LENGTH 検索する文字列として指定可能...
--PLUGIN_SEARCH_MAX_BASE 抽出条件として指定可能な件数の...
**server [#d69aa1d0]
:種別|
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
''#server''
:概要|
~サーバーの情報(サーバー名、サーバーソフトウエア、サーバ...
**setlinebreak [#va79297e]
:種別|
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
''#setlinebreak(''
[&color(blue){on};|&color(blue){off};|&color(blue){defaul...
'')''
:概要|
~入力文章中の改行を改行とみなすかどうかの設定を行います。
~PukiWikiが入力文章中の改行をどのように扱うかはpukiwiki.i...
|入力文章|$line_break=0;|$line_break=1;|h
|文章１&br;文章２|文章１文章２|文章１&br;文章２|
~setlinebreakプラグインは該当ページの以降の行に関して、
$line_breakの設定に因らず改行をどのように扱うかを指定でき...
:引数|
~パラメータには以降の改行の扱いを指定します。
パラメータが省略された場合、改行とみなすかどうかについて...
--on － 以降の文章で段落内の改行を改行とみなします($line_...
--off － 以降の文章で改行を無視します($line_break=0と同様...
改行を行うためには行末にチルダを記述するか、
行中で[[brプラグイン>../A-D#g693034c]]を使用する必要があ...
--default － 改行の扱いをそのサイトの$line_break設定に戻...
**showrss [#v7316017]
:種別|
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
''#showrss(''
&color(blue){RSSへのパス};
[,[&color(blue){default};|&color(blue){menubar};|&color(b...
[,[&color(blue){キャッシュ生存時間};]
[,&color(blue){1};
]]]
'')''
:概要|
~指定されたRSSを取得し、一覧表示します。
~ページの解釈毎にRSSの取得を行う為、頻繁に参照されるペー...
:引数|
~RSSへのパスにはRSSへのファイルパスやURLを指定します。
~テンプレート名には取得したRSSの表示方法を指定します。省...
--default － 単純にページを列挙します。
--menubar － ページ名の前に黒丸をつけます。MenuBarなど、...
--recent － recentプラグインの出力のように、ページ名の前...
:|
~キャッシュ生存時間はキャッシュをクリアする期限（１時間単...
~第４引数はRSSを取得した日付を表示するかどうかを指定しま...
:プラグイン内設定|~
--PLUGIN_SHOWRSS_USAGE エラー時に表示される使用方法
:備考|
~動作させるためにはPHP の xml extension が必要です。
**size [#e5db48c0]
:種別|
~インライン型プラグイン
:重要度|
~★★★☆☆
:書式|
''&size(''
&color(blue){ピクセル数値};
''){''
&color(blue){文字列};
''};''
:概要|
~文字の大きさを指定します。
:引数|
~ピクセル数値には文字の大きさを指定します。
~文字列は文字の大きさを変更する文字列を指定します。
:プラグイン内設定|~
--PLUGIN_SIZE_MAX 引数として指定可能な最大文字サイズ
--PLUGIN_SIZE_MIN 引数として指定可能な最小文字サイズ
--PLUGIN_SIZE_USAGE 引数未指定時に表示されるヘルプ
**source [#k23d3e24]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
''?cmd=source''
&color(blue){&page=ページ名};
:概要|
~指定したページの整形前のソースを表示します。
:引数|
~ページ名にはソースを表示するページ名を指定します。ページ...
**stationary [#ifad4486]
:種別|
~コマンド
~ブロック型プラグイン
~インライン型プラグイン
:重要度|
~★☆☆☆☆
:書式|
~''?plugin=stationary''
~''#stationary''
~''&stationary;''
:概要|
~stationaryプラグインはプラグイン作成を試みる人のための雛...
stationaryプラグインは単純な文字列を表示する以外は何もし...
:プラグイン内設定|~
--PLUGIN_STATIONARY_MAX プラグイン内で定数定義を行うサン...
------------------------------
* T [#u58dc027]
**template [#j2adfc3d]
:種別|
~コマンド
:重要度|
~★★★★☆
:書式|
''?plugin=template''
&color(blue){&refer=テンプレートページ};
:概要|
~既存のページをテンプレートとしてページを新規作成します。
~ページの新規作成時の雛形とするページの読込み機能との差異...
:引数|
~テンプレートページには雛形とするページを指定します。ペー...
:プラグイン内設定|~
--MAX_LEN 雛形の開始／終了位置を指定する欄で表示される最...
**topicpath [#vd55c067]
:種別|
~インライン型プラグイン
~ブロック型プラグイン
:重要度|
~★☆☆☆☆
:書式|
~''&topicpath''
'';''
~''#topicpath''
:概要|
~パンくずリスト(topicpath)と呼ばれる、現在参照しているウ...
~例えば
[[PukiWiki/ツアー]]
というページに#topicpathと書くと、以下の様な表記に置き換...
[[Top>FrontPage]] / [[PukiWiki>PukiWiki]] / [[ツアー>Puk...
~基本的には以下の２通りの使い方を想定しています。
++「ほげ/ふが/げほ」など、２～３階層以上の深いページでペ...
++スキンに組み込み、ページタイトル下の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_DEFAUL...
**touchgraph [#p93402bd]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
''?plugin=touchgraph''
:概要|
~[[TouchGraphWikiBrowser>http://www.touchgraph.com/]]用の...
**tracker [#rf5296e2]
:種別|
~（コマンド）
~ブロック型プラグイン
:重要度|
~★★★★☆
:書式|
~''#tracker(''
[&color(blue){定義名};]
[,&color(blue){ベースページ名};]
'')''
:概要|
~[[bugtrack>../A-D#a83293e8]]プラグインのように、定型的な...
~入力項目が固定されている[[bugtrack>../A-D#a83293e8]]プラ...
~入力項目の定義は:config/plugin/tracker/ 以下に所定の書式...
:引数|
~定義名は #tracker(hoge) のようにtrackerのテンプレート名...
~テンプレート名に続けてフォーム名 / リスト名を指定するこ...
~ベースページ名はフォームから作成されるページの親階層とな...
:プラグイン内設定|~
--TRACKER_LIST_EXCLUDE_PATTERN tracker_listで表示しない...
--TRACKER_LIST_SHOW_ERROR_PAGE 項目の取り出しに失敗した...
:テンプレート|~
~テンプレートは基本的に設置するtracker毎に１組（4ページ）...
--:config/plugin/tracker/hoge
~hogeテンプレートの項目の内容を記述します。
--:config/plugin/tracker/hoge/form
~入力フォームの項目とレイアウトを記述します。
--:config/plugin/tracker/default/page
~入力した内容をページ化する際のフォーマットを記述します。
--:config/plugin/tracker/hoge/list
~tracker_listで表示するリストのレイアウトを記述します。テ...
:予約項目|~
--form で使用できる予約項目
---[_name] : 記事を記録するページ名を入力するフィールドを...
---[_submit] : [追加]ボタンを表示。
--page / list で使用できる予約項目
---[_date] : 投稿日時。
---[_page] : 実際に生成したページ名。ブラケットが付く。
---[_refer] : #trackerを置いたページ。
---[_base] : ページのプレフィクス。 tracker()/tracker_lis...
---[_name] : formの [_name] の内容そのもの。記事を記録す...
---[_real] : 実際に生成したページ名から、[_refer] + '/'を...
・formに [_name] フィールドがない。~
・[_name] が空か、ページ名として無効な文字を含む。~
・[_refer] / [_name] という名前のページがすでに存在する。~
--list で使用できる予約項目
---[_update] : ページの最終更新日時。
---[_past] : 最終更新日時からの経過。
**tracker_list [#t78d6d0a]
:種別|
~（コマンド）
~ブロック型プラグイン
:重要度|
~★★★★☆
:書式|
''#tracker_list(''
[&color(blue){定義名};]
[,[&color(blue){ベースページ名};]
[,[[&color(blue){ソート項目};]
:[&color(blue){ソート順};]]
[,&color(blue){表示上限};]
]]]
'')''
:概要|
~[[tracker>./#rf5296e2]]プラグインで作成したページを一覧...
:引数|
~定義名は[[tracker>./#rf5296e2]]プラグインで指定したテン...
~ベースページ名は[[tracker>./#rf5296e2]]プラグインで指定...
~第３項目には一覧表示のソートに使う項目およびソート順を指...
~表示上限は一覧表示するページ数の上限を指定します。省略時...
------------------------------
* U [#q0183edd]
**unfreeze [#v039be15]
:種別|
~コマンド
:重要度|
~★★★☆☆
:書式|
''?plugin=unfreeze''
&color(blue){&page=ページ名};
:概要|
~ページの凍結を解除します。
:引数|
~ページ名には解除するページ名を指定します。ページ名はエン...
:プラグイン内設定|~
--PLUGIN_UNFREEZE_EDIT 凍結解除時にページの編集フォーム...
**update_entities [#r62603ec]
:種別|
~コマンド
:重要度|
~★☆☆☆☆
:書式|
''?plugin=update_entities''
:概要|
~CACHE_DIR/entities.dat を生成します。
~entities.datはHTMLの実体参照を判定するために用いられるテ...
:プラグイン内設定|~
--W3C_XHTML_DTD_LOCATION DTDの場所
:備考|
~配布ファイルに生成済のentities.datが付属するため、通常使...
#navi(../)
#setlinebreak(default)
Page:
