使用可能プラグイン
をテンプレートにして作成
[
トップ
] [
新規
|
一覧
|
単語検索
|
最終更新
|
ヘルプ
]
開始行:
* PukiWiki プラグイン [#g26abaee]
#contents
----
** プラグインマニュアルの凡例 [#vf3c6f93]
プラグインマニュアルは以下の形式で記述されています。
''プラグイン名''
:種別|プラグインがどのような方法で呼び出しを行えるかを示...
--コマンド − コマンド形式の呼び出しが可能であることを示し...
--ブロック型プラグイン − ブロック型プラグインでの呼び出し...
--インライン型プラグイン − インライン型プラグインでの呼び...
--擬似ブロック型プラグイン − PukiWiki本体で実現されている...
:重要度|そのプラグインの一般的な利用頻度や有用性の目安を...
:書式|プラグインでの引数指定方法です。引数の指定方法の表...
--[] − 省略可能で必要に応じて記述する箇所です。
--| − |で区切られた複数の項目のうち、指定できるのは１つで...
--{} − 中カッコ内のみ引数の指定順序が任意である事を示しま...
:概要|そのプラグインの機能概要です。
:引数|引数の詳細な説明です。
:プラグイン内設定|プラグインのソース中で定義されている定...
:備考|プラグインに関する参考情報です。
----
**aname 【アンカーの設定】 [#k72ffff8]
:種別|インライン型プラグイン / ブロック型プラグイン
:重要度|★★★★☆
:書式|''&aname(''
&color(blue){アンカー名};
[,{[&color(blue){super};],
[&color(blue){full};],
[&color(blue){noid};]}]
''){''
&color(blue){アンカー文字列};
''};''~
''#aname(''
&color(blue){アンカー名};
[,{[&color(blue){super};],
[&color(blue){full};],
[&color(blue){noid};]},
&color(blue){アンカー文字列};]
'')''
:概要|指定した位置にアンカー(リンクの飛び先)を設定します。
:引数|アンカー名の値がアンカーのフラグメント指定子に使用...
~super,full,noid でアンカーの出力方式を指定します。
--super － アンカー文字列を上付き表示します。省略時は上付...
--full － フラグメント指定子以外のURIを補ってアンカーを出...
--noid － アンカーにフラグメント指定子を出力しません。
:|~アンカー文字列が指定された場合、指定した文字列に対して...
:備考|通常はインライン型プラグインとして使用します。2つの...
~PukiWiki本体処理でanameプラグインを内部的に呼び出してい...
**article 【簡易掲示板の設置】 [#z6d7fb52]
:種別|ブロック型プラグイン
:重要度|★★★☆☆
:書式|''#article''
:概要|指定した位置に簡易掲示板を設置します。
**br 【改行】 [#n3c8ec2f]
:種別|ブロック型プラグイン / インライン型プラグイン
:重要度|★★☆☆☆
:書式|''#br''~
''&br'''';''
:概要|文章中で改行を行います。~
段落やリスト、テーブル内など、行末の~による改行ではブロッ...
**clear 【回り込み解除】 [#e85687eb]
:種別|ブロック型プラグイン
:重要度|★☆☆☆☆
:書式|''#clear''
:概要|refプラグインのaroundオプションで有効となったテキス...
:備考|imgプラグインのclearオプション指定時と処理内容は同...
**color 【文字・背景色の指定】 [#v07c3b65]
:種別|インライン型プラグイン
:重要度|★★★★☆
:書式|''&color(''
[&color(blue){文字色};]
[,&color(blue){背景色};]
''){''
&color(blue){文章};
''};''
:概要|引数で指定したインライン要素(主に文章)の、文字色・...
:引数|文字色・背景色はそれぞれ色名(red、blueなど)、シャー...
~文字色・背景色の両方を省略する事はできません。一方を省略...
:備考|以下、[[W3C勧告書:http://www.w3.org/TR/1999/REC-htm...
Aqua = "#00FFFF",
Black = "#000000",
Blue = "#0000FF",
Fuchsia = "#FF00FF",
Gray = "#808080",
Green = "#008000",
Lime = "#00FF00",
Maroon = "#800000",
Navy = "#000080",
Olive = "#808000",
Purple = "#800080",
Red = "#FF0000",
Silver = "#C0C0C0",
Teal = "#008080",
White = "#FFFFFF",
Yellow = "#FFFF00"
**comment 【コメント欄】 [#zd619fe9]
:種別|ブロック型プラグイン
:重要度|★★★★★
:書式|''#comment(''
{[&color(blue){above};],
[&color(blue){below};],
[&color(blue){nodate};],
[&color(blue){noname};]}
'')''
:概要|コメントの入力用の入力欄を表示します。
:引数|コメントの挿入方法を引数で指定します。
--above － 入力したコメントがコメント入力欄の上に追加します
--below － 入力したコメントがコメント入力欄の下に追加しま...
--nodate － 挿入するコメントに、挿入時刻を付加しない（省...
--noname － コメント記入者名の入力欄を非表示とします（省...
**contents 【見出しの一覧】 [#r4b95920]
:種別|擬似ブロック型プラグイン
:重要度|★★★☆☆
:書式|''#contents''
:概要|設置したページ中の見出しの一覧を表示します。
**hr 【水平線】 [#vb664872]
:種別|ブロック型プラグイン
:重要度|★★☆☆☆
:書式|''#hr''
:概要|文中に水平線を挿入します。
:備考|段落やリスト、テーブル内など、通常の水平線書式(----...
**include 【入力欄】 [#o2b4e411]
:種別|ブロック型プラグイン
:重要度|★★★☆☆
:書式|''#include(''
&color(blue){ページ名[,title|,notitle]};
'')''
:概要|記述した位置に指定したページを挿入して、複数のペー...
:引数|ページ名には挿入するページを指定します。~
第2引数にnotitleを指定すると、ページ名の表示を抑制します...
**insert 【入力欄】 [#qb37cf03]
:種別|ブロック型プラグイン
:重要度|★☆☆☆☆
:書式|''#insert''
:概要|記述した位置に複数行入力欄とボタンを表示します。~
ボタンを押下すると入力欄に入力した内容をページに挿入しま...
**lastmod 【最終更新日時の表示】 [#qbc5d441]
:種別|インライン型プラグイン
:重要度|★☆☆☆☆
:書式|''&lastmod(''
[&color(blue){ページ名};]
'');''
:概要|指定したページの最終更新日時を表示します。
:引数|ページ名には最終更新日時を表示したいページ名を指定...
省略時は設置したページとみなします。
**memo 【メモ】 [#j5080276]
:種別|ブロック型プラグイン
:重要度|★☆☆☆☆
:書式|''#memo''
:概要|記述した位置に複数行入力欄とボタンを表示します。~
ボタンを押下すると入力欄の記述内容を更新します。
:備考|insertプラグインやarticleプラグインと似ていますが、...
個人用のメモ代わりにPukiWikiを利用している場合、未整理の...
**new 【new表示】 [#wf76f528]
:種別|インライン型プラグイン
:重要度|★★☆☆☆
:書式|
:'''書式1:'''|''&new(''
[&color(blue){nodate};]
''){''
&color(blue){日付文字列};
''};''
:'''書式2:'''|''&new(''
[&color(blue){ページ名};]
[,&color(blue){nolink};]
'');''
:概要|指定した日時が最近であった場合、最近更新された事を...
~標準では5日以内の場合に ''New'' を、１日以内の場合に ''N...
:引数|'''書式1:'''
~日付文字列を指定した場合、その日時が規定の期間内であった...
--nodate － 日付文字列を表示しません。省略時は表示します。
:|'''書式2:'''
~ページ名を指定した場合は、そのページの更新日時が規定の期...
~ページ名末尾が/であった場合、そのページ名で始まるページ...
--nolink － ページ名を表示しません。省略時はページ名（ペ...
:備考|日付文字列は[[PHP関数:strtotime]]が認識できる書式で...
**norelated 【関連ページの表示】 [#vfeaac41]
:種別|ブロック型プラグイン
:重要度|★★★☆☆
:書式|''#norelated''
:概要|ページ下部に表示される関連ページのリンクを非表示に...
:備考|極端に多くのページからリンクされていて関連リンクの...
**ref 【画像など添付ファイルの展開】 [#j51c9555]
:種別|ブロック型プラグイン / インライン型プラグイン
:重要度|★★★★☆
:書式|''#ref(''
&color(blue){添付ファイル名};|
&color(blue){ページ名/添付ファイル名};|
&color(blue){URL};
{,
[&color(blue){left};|&color(blue){center};|&color(blue){r...
[&color(blue){wrap};|&color(blue){nowrap};],
[&color(blue){around};],
[&color(blue){noicon};],
[&color(blue){noimg};],
[&color(blue){nolink};],
[&color(blue){zoom};],
[&color(blue){999x999};],
[&color(blue){999%};]
}
[,&color(blue){タイトル};]
'')''~
''&ref(''
&color(blue){添付ファイル名};|
&color(blue){ページ名/添付ファイル名};|
&color(blue){URL};
{,
[&color(blue){noicon};],
[&color(blue){noimg};],
[&color(blue){nolink};],
[&color(blue){zoom};],
[&color(blue){999x999};],
[&color(blue){999%};]
}
[,&color(blue){タイトル};]
'');''
:概要|#attachで添付したファイルやURL先のファイルを指定位...
:引数|添付ファイル名にはページに添付したファイル名を指定...
~ページ名にはファイルを添付したページをWikiNameかBracketN...
~パラメータにはファイルの展開方法を指定できます。
--left|center|right － 表示時の位置を指定します。省略時は...
--wrap|nowrap － テーブルタグで囲む/囲まないの指定を行い...
--around － テキストの回り込みを可能とします。省略時は回...
--noicon － ファイルが画像以外の場合に表示されるアイコン...
--noimg － ファイルが画像の場合に画像を展開しないようにし...
--nolink － 元ファイルへのリンクを張らないようにします。...
--zoom － 縦横比を保持します。省略時はサイズ指定に従いま...
--999x999 － サイズを指定します(幅x高さ)。省略時は拡大率...
--999% － サイズを指定(拡大率)します。省略時は100%です、
--タイトル － 上記以外のパラメータは画像の代替文字列、リ...
:備考|aroundで行った回り込み指定を解除するには clearプラ...
~"ほげ"という別ページの添付ファイル"fuga.jpg"をインライン...
&ref(ほげ/fuga.jpg);
いわゆるバナー画像のように表示した画像が別ページへのリン...
[[&ref(ほげ/fuga.jpg,nolink,ウェブ名);>ウェブのURL]]
また、ほげというページに添付された画像を、そのページ内で...
&ref(./fuga.jpg,50%);
&ref(ほげ/fuga.jpg,50%);
**ruby 【ルビ】 [#s335a400]
:種別|インライン型プラグイン
:重要度|★☆☆☆☆
:書式|
''&ruby(''
&color(blue){ルビ};
''){''
&color(blue){対象文字列};
''};''
:概要|文字列にルビをふります。
:引数|ルビには表示するルビを指定します。~
対象文字列にはルビがふられる文字列を指定します。
:備考|XHTML 1.1のルビに対応したブラウザでないと、ルビとし...
ルビに対応していないブラウザではルビをふる文字列の直後に...
**size 【文字サイズ指定】 [#i49bc1df]
:種別|インライン型プラグイン
:重要度|★★★☆☆
:書式|''&size(''
&color(blue){ピクセル数値};
''){''
&color(blue){文字列};
''};''
:概要|文字の大きさを指定します。
:引数|ピクセル数値には文字の大きさを指定します。~
文字列は文字の大きさを変更する文字列を指定します。
**vote 【投票フォームを表示】 [#i49c197d]
:種別|ブロック型プラグイン
:重要度|★★☆☆☆
:書式|''#vote(''
&color(blue){選択肢1};[&color(blue){選択肢1の投票数};]
[,&color(blue){選択肢2};[&color(blue){選択肢2の投票数};]
[,&color(blue){選択肢3};[&color(blue){選択肢3の投票数};]…
[,&color(blue){選択肢n};[&color(blue){選択肢nの投票数};]]]
'')''
:概要|選択肢と投票数と投票ボタンが並んだ簡易投票フォーム...
:引数|選択肢1～nに投票項目を指定します。投票項目に続けて...
:備考|各選択肢の投票数は編集によって容易に改竄できるため...
終了行:
* PukiWiki プラグイン [#g26abaee]
#contents
----
** プラグインマニュアルの凡例 [#vf3c6f93]
プラグインマニュアルは以下の形式で記述されています。
''プラグイン名''
:種別|プラグインがどのような方法で呼び出しを行えるかを示...
--コマンド − コマンド形式の呼び出しが可能であることを示し...
--ブロック型プラグイン − ブロック型プラグインでの呼び出し...
--インライン型プラグイン − インライン型プラグインでの呼び...
--擬似ブロック型プラグイン − PukiWiki本体で実現されている...
:重要度|そのプラグインの一般的な利用頻度や有用性の目安を...
:書式|プラグインでの引数指定方法です。引数の指定方法の表...
--[] − 省略可能で必要に応じて記述する箇所です。
--| − |で区切られた複数の項目のうち、指定できるのは１つで...
--{} − 中カッコ内のみ引数の指定順序が任意である事を示しま...
:概要|そのプラグインの機能概要です。
:引数|引数の詳細な説明です。
:プラグイン内設定|プラグインのソース中で定義されている定...
:備考|プラグインに関する参考情報です。
----
**aname 【アンカーの設定】 [#k72ffff8]
:種別|インライン型プラグイン / ブロック型プラグイン
:重要度|★★★★☆
:書式|''&aname(''
&color(blue){アンカー名};
[,{[&color(blue){super};],
[&color(blue){full};],
[&color(blue){noid};]}]
''){''
&color(blue){アンカー文字列};
''};''~
''#aname(''
&color(blue){アンカー名};
[,{[&color(blue){super};],
[&color(blue){full};],
[&color(blue){noid};]},
&color(blue){アンカー文字列};]
'')''
:概要|指定した位置にアンカー(リンクの飛び先)を設定します。
:引数|アンカー名の値がアンカーのフラグメント指定子に使用...
~super,full,noid でアンカーの出力方式を指定します。
--super － アンカー文字列を上付き表示します。省略時は上付...
--full － フラグメント指定子以外のURIを補ってアンカーを出...
--noid － アンカーにフラグメント指定子を出力しません。
:|~アンカー文字列が指定された場合、指定した文字列に対して...
:備考|通常はインライン型プラグインとして使用します。2つの...
~PukiWiki本体処理でanameプラグインを内部的に呼び出してい...
**article 【簡易掲示板の設置】 [#z6d7fb52]
:種別|ブロック型プラグイン
:重要度|★★★☆☆
:書式|''#article''
:概要|指定した位置に簡易掲示板を設置します。
**br 【改行】 [#n3c8ec2f]
:種別|ブロック型プラグイン / インライン型プラグイン
:重要度|★★☆☆☆
:書式|''#br''~
''&br'''';''
:概要|文章中で改行を行います。~
段落やリスト、テーブル内など、行末の~による改行ではブロッ...
**clear 【回り込み解除】 [#e85687eb]
:種別|ブロック型プラグイン
:重要度|★☆☆☆☆
:書式|''#clear''
:概要|refプラグインのaroundオプションで有効となったテキス...
:備考|imgプラグインのclearオプション指定時と処理内容は同...
**color 【文字・背景色の指定】 [#v07c3b65]
:種別|インライン型プラグイン
:重要度|★★★★☆
:書式|''&color(''
[&color(blue){文字色};]
[,&color(blue){背景色};]
''){''
&color(blue){文章};
''};''
:概要|引数で指定したインライン要素(主に文章)の、文字色・...
:引数|文字色・背景色はそれぞれ色名(red、blueなど)、シャー...
~文字色・背景色の両方を省略する事はできません。一方を省略...
:備考|以下、[[W3C勧告書:http://www.w3.org/TR/1999/REC-htm...
Aqua = "#00FFFF",
Black = "#000000",
Blue = "#0000FF",
Fuchsia = "#FF00FF",
Gray = "#808080",
Green = "#008000",
Lime = "#00FF00",
Maroon = "#800000",
Navy = "#000080",
Olive = "#808000",
Purple = "#800080",
Red = "#FF0000",
Silver = "#C0C0C0",
Teal = "#008080",
White = "#FFFFFF",
Yellow = "#FFFF00"
**comment 【コメント欄】 [#zd619fe9]
:種別|ブロック型プラグイン
:重要度|★★★★★
:書式|''#comment(''
{[&color(blue){above};],
[&color(blue){below};],
[&color(blue){nodate};],
[&color(blue){noname};]}
'')''
:概要|コメントの入力用の入力欄を表示します。
:引数|コメントの挿入方法を引数で指定します。
--above － 入力したコメントがコメント入力欄の上に追加します
--below － 入力したコメントがコメント入力欄の下に追加しま...
--nodate － 挿入するコメントに、挿入時刻を付加しない（省...
--noname － コメント記入者名の入力欄を非表示とします（省...
**contents 【見出しの一覧】 [#r4b95920]
:種別|擬似ブロック型プラグイン
:重要度|★★★☆☆
:書式|''#contents''
:概要|設置したページ中の見出しの一覧を表示します。
**hr 【水平線】 [#vb664872]
:種別|ブロック型プラグイン
:重要度|★★☆☆☆
:書式|''#hr''
:概要|文中に水平線を挿入します。
:備考|段落やリスト、テーブル内など、通常の水平線書式(----...
**include 【入力欄】 [#o2b4e411]
:種別|ブロック型プラグイン
:重要度|★★★☆☆
:書式|''#include(''
&color(blue){ページ名[,title|,notitle]};
'')''
:概要|記述した位置に指定したページを挿入して、複数のペー...
:引数|ページ名には挿入するページを指定します。~
第2引数にnotitleを指定すると、ページ名の表示を抑制します...
**insert 【入力欄】 [#qb37cf03]
:種別|ブロック型プラグイン
:重要度|★☆☆☆☆
:書式|''#insert''
:概要|記述した位置に複数行入力欄とボタンを表示します。~
ボタンを押下すると入力欄に入力した内容をページに挿入しま...
**lastmod 【最終更新日時の表示】 [#qbc5d441]
:種別|インライン型プラグイン
:重要度|★☆☆☆☆
:書式|''&lastmod(''
[&color(blue){ページ名};]
'');''
:概要|指定したページの最終更新日時を表示します。
:引数|ページ名には最終更新日時を表示したいページ名を指定...
省略時は設置したページとみなします。
**memo 【メモ】 [#j5080276]
:種別|ブロック型プラグイン
:重要度|★☆☆☆☆
:書式|''#memo''
:概要|記述した位置に複数行入力欄とボタンを表示します。~
ボタンを押下すると入力欄の記述内容を更新します。
:備考|insertプラグインやarticleプラグインと似ていますが、...
個人用のメモ代わりにPukiWikiを利用している場合、未整理の...
**new 【new表示】 [#wf76f528]
:種別|インライン型プラグイン
:重要度|★★☆☆☆
:書式|
:'''書式1:'''|''&new(''
[&color(blue){nodate};]
''){''
&color(blue){日付文字列};
''};''
:'''書式2:'''|''&new(''
[&color(blue){ページ名};]
[,&color(blue){nolink};]
'');''
:概要|指定した日時が最近であった場合、最近更新された事を...
~標準では5日以内の場合に ''New'' を、１日以内の場合に ''N...
:引数|'''書式1:'''
~日付文字列を指定した場合、その日時が規定の期間内であった...
--nodate － 日付文字列を表示しません。省略時は表示します。
:|'''書式2:'''
~ページ名を指定した場合は、そのページの更新日時が規定の期...
~ページ名末尾が/であった場合、そのページ名で始まるページ...
--nolink － ページ名を表示しません。省略時はページ名（ペ...
:備考|日付文字列は[[PHP関数:strtotime]]が認識できる書式で...
**norelated 【関連ページの表示】 [#vfeaac41]
:種別|ブロック型プラグイン
:重要度|★★★☆☆
:書式|''#norelated''
:概要|ページ下部に表示される関連ページのリンクを非表示に...
:備考|極端に多くのページからリンクされていて関連リンクの...
**ref 【画像など添付ファイルの展開】 [#j51c9555]
:種別|ブロック型プラグイン / インライン型プラグイン
:重要度|★★★★☆
:書式|''#ref(''
&color(blue){添付ファイル名};|
&color(blue){ページ名/添付ファイル名};|
&color(blue){URL};
{,
[&color(blue){left};|&color(blue){center};|&color(blue){r...
[&color(blue){wrap};|&color(blue){nowrap};],
[&color(blue){around};],
[&color(blue){noicon};],
[&color(blue){noimg};],
[&color(blue){nolink};],
[&color(blue){zoom};],
[&color(blue){999x999};],
[&color(blue){999%};]
}
[,&color(blue){タイトル};]
'')''~
''&ref(''
&color(blue){添付ファイル名};|
&color(blue){ページ名/添付ファイル名};|
&color(blue){URL};
{,
[&color(blue){noicon};],
[&color(blue){noimg};],
[&color(blue){nolink};],
[&color(blue){zoom};],
[&color(blue){999x999};],
[&color(blue){999%};]
}
[,&color(blue){タイトル};]
'');''
:概要|#attachで添付したファイルやURL先のファイルを指定位...
:引数|添付ファイル名にはページに添付したファイル名を指定...
~ページ名にはファイルを添付したページをWikiNameかBracketN...
~パラメータにはファイルの展開方法を指定できます。
--left|center|right － 表示時の位置を指定します。省略時は...
--wrap|nowrap － テーブルタグで囲む/囲まないの指定を行い...
--around － テキストの回り込みを可能とします。省略時は回...
--noicon － ファイルが画像以外の場合に表示されるアイコン...
--noimg － ファイルが画像の場合に画像を展開しないようにし...
--nolink － 元ファイルへのリンクを張らないようにします。...
--zoom － 縦横比を保持します。省略時はサイズ指定に従いま...
--999x999 － サイズを指定します(幅x高さ)。省略時は拡大率...
--999% － サイズを指定(拡大率)します。省略時は100%です、
--タイトル － 上記以外のパラメータは画像の代替文字列、リ...
:備考|aroundで行った回り込み指定を解除するには clearプラ...
~"ほげ"という別ページの添付ファイル"fuga.jpg"をインライン...
&ref(ほげ/fuga.jpg);
いわゆるバナー画像のように表示した画像が別ページへのリン...
[[&ref(ほげ/fuga.jpg,nolink,ウェブ名);>ウェブのURL]]
また、ほげというページに添付された画像を、そのページ内で...
&ref(./fuga.jpg,50%);
&ref(ほげ/fuga.jpg,50%);
**ruby 【ルビ】 [#s335a400]
:種別|インライン型プラグイン
:重要度|★☆☆☆☆
:書式|
''&ruby(''
&color(blue){ルビ};
''){''
&color(blue){対象文字列};
''};''
:概要|文字列にルビをふります。
:引数|ルビには表示するルビを指定します。~
対象文字列にはルビがふられる文字列を指定します。
:備考|XHTML 1.1のルビに対応したブラウザでないと、ルビとし...
ルビに対応していないブラウザではルビをふる文字列の直後に...
**size 【文字サイズ指定】 [#i49bc1df]
:種別|インライン型プラグイン
:重要度|★★★☆☆
:書式|''&size(''
&color(blue){ピクセル数値};
''){''
&color(blue){文字列};
''};''
:概要|文字の大きさを指定します。
:引数|ピクセル数値には文字の大きさを指定します。~
文字列は文字の大きさを変更する文字列を指定します。
**vote 【投票フォームを表示】 [#i49c197d]
:種別|ブロック型プラグイン
:重要度|★★☆☆☆
:書式|''#vote(''
&color(blue){選択肢1};[&color(blue){選択肢1の投票数};]
[,&color(blue){選択肢2};[&color(blue){選択肢2の投票数};]
[,&color(blue){選択肢3};[&color(blue){選択肢3の投票数};]…
[,&color(blue){選択肢n};[&color(blue){選択肢nの投票数};]]]
'')''
:概要|選択肢と投票数と投票ボタンが並んだ簡易投票フォーム...
:引数|選択肢1～nに投票項目を指定します。投票項目に続けて...
:備考|各選択肢の投票数は編集によって容易に改竄できるため...
ページ名:
![[PukiWiki]](image/my/logo.jpg "[PukiWiki]"){kind=logo}
