PukiWiki プラグイン


プラグインマニュアルの凡例

プラグインマニュアルは以下の形式で記述されています。

プラグイン名

種別
プラグインがどのような方法で呼び出しを行えるかを示します。複数の呼び出し方法をもつプラグインも存在します。
  • コマンド − コマンド形式の呼び出しが可能であることを示します。内部的に呼び出されるため、説明を省いている場合はカッコで括られています。
  • ブロック型プラグイン − ブロック型プラグインでの呼び出しが可能である事を示します。
  • インライン型プラグイン − インライン型プラグインでの呼び出しが可能である事を示します。
  • 擬似ブロック型プラグイン − PukiWiki本体で実現されている機能であることを示します。記述方式がブロック型プラグインと同じであるため、便宜上プラグインのマニュアルに含めています。
重要度
そのプラグインの一般的な利用頻度や有用性の目安を示します。さほど重要でない場合は ★☆☆☆☆ が、重要なプラグインの場合は ★★★★★ です。
書式
プラグインでの引数指定方法です。引数の指定方法の表現のため、下記の記述書式を使っています。
  • [] − 省略可能で必要に応じて記述する箇所です。
  • | − |で区切られた複数の項目のうち、指定できるのは1つである事を示します。
  • {} − 中カッコ内のみ引数の指定順序が任意である事を示します。
概要
そのプラグインの機能概要です。
引数
引数の詳細な説明です。
プラグイン内設定
プラグインのソース中で定義されている定数の一覧です。引数で変更できない詳細なカスタマイズが可能となります。
備考
プラグインに関する参考情報です。

aname 【アンカーの設定】

種別
インライン型プラグイン / ブロック型プラグイン
重要度
★★★★☆
書式
&aname( アンカー名 [,{[super], [full], [noid]}] ){ アンカー文字列 };
#aname( アンカー名 [,{[super], [full], [noid]}, アンカー文字列] )
概要
指定した位置にアンカー(リンクの飛び先)を設定します。
引数
アンカー名の値がアンカーのフラグメント指定子に使用されます。アンカー名は省略できません。アンカー名には半角英字(大文字/小文字)が使用可能です。

super,full,noid でアンカーの出力方式を指定します。

  • super - アンカー文字列を上付き表示します。省略時は上付き表示されません。
  • full - フラグメント指定子以外のURIを補ってアンカーを出力します。省略時はフラグメント指定子のみ出力されます。
  • noid - アンカーにフラグメント指定子を出力しません。

アンカー文字列が指定された場合、指定した文字列に対してアンカーが出力されます。アンカーの存在を利用者に明示したい場合に利用します。省略時は空文字に対するアンカーとなります。

備考
通常はインライン型プラグインとして使用します。2つのブロック型プラグインに挟まれた部分にアンカー設定したい場合にインラインプラグインとして記述できないため、ブロック型プラグインとしても使えるようにしてあります。

PukiWiki本体処理でanameプラグインを内部的に呼び出しているため、必ず組み込む必要があります。

article 【簡易掲示板の設置】

種別
ブロック型プラグイン
重要度
★★★☆☆
書式
#article
概要
指定した位置に簡易掲示板を設置します。

br 【改行】

種別
ブロック型プラグイン / インライン型プラグイン
重要度
★★☆☆☆
書式
#br
&br;
概要
文章中で改行を行います。
段落やリスト、テーブル内など、行末の~による改行ではブロック要素を抜けてしまう個所で改行や空行の挿入するために用います。

clear 【回り込み解除】

種別
ブロック型プラグイン
重要度
★☆☆☆☆
書式
#clear
概要
refプラグインのaroundオプションで有効となったテキスト回り込み指定を解除します。
備考
imgプラグインのclearオプション指定時と処理内容は同等です。

color 【文字・背景色の指定】

種別
インライン型プラグイン
重要度
★★★★☆
書式
&color( [文字色] [,背景色] ){ 文章 };
概要
引数で指定したインライン要素(主に文章)の、文字色・背景色を指定します。
引数
文字色・背景色はそれぞれ色名(red、blueなど)、シャープで始まる3桁の16進数値(#000~#FFF)、同じく6桁の16進数値(#000000 ~ #FFFFFF)のいずれかで指定することができます。大文字小文字は問いません。

文字色・背景色の両方を省略する事はできません。一方を省略した場合は省略した側の色の変更はされません。

備考
以下、W3C勧告書より抜粋した色名。 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 【コメント欄】

種別
ブロック型プラグイン
重要度
★★★★★
書式
#comment( {[above], [below], [nodate], [noname]} )
概要
コメントの入力用の入力欄を表示します。
引数
コメントの挿入方法を引数で指定します。
  • above - 入力したコメントがコメント入力欄の上に追加します
  • below - 入力したコメントがコメント入力欄の下に追加します(省略時はaboveが指定されたとみなします)
  • nodate - 挿入するコメントに、挿入時刻を付加しない(省略時は付加します)
  • noname - コメント記入者名の入力欄を非表示とします(省略時は表示します)

contents 【見出しの一覧】

種別
擬似ブロック型プラグイン
重要度
★★★☆☆
書式
#contents
概要
設置したページ中の見出しの一覧を表示します。

hr 【水平線】

種別
ブロック型プラグイン
重要度
★★☆☆☆
書式
#hr
概要
文中に水平線を挿入します。
備考
段落やリスト、テーブル内など、通常の水平線書式(----)ではブロックを抜けてしまう個所で水平線を挿入するために用います。リスト内など左右マージンが設定されている場合は、それを引き継ぎます。

include 【入力欄】

種別
ブロック型プラグイン
重要度
★★★☆☆
書式
#include( ページ名[,title|,notitle] )
概要
記述した位置に指定したページを挿入して、複数のページをあたかも1つのページであるかのように表示します。
引数
ページ名には挿入するページを指定します。
第2引数にnotitleを指定すると、ページ名の表示を抑制します。titleはその逆です。

insert 【入力欄】

種別
ブロック型プラグイン
重要度
★☆☆☆☆
書式
#insert
概要
記述した位置に複数行入力欄とボタンを表示します。
ボタンを押下すると入力欄に入力した内容をページに挿入します。

lastmod 【最終更新日時の表示】

種別
インライン型プラグイン
重要度
★☆☆☆☆
書式
&lastmod( [ページ名] );
概要
指定したページの最終更新日時を表示します。
引数
ページ名には最終更新日時を表示したいページ名を指定します。 省略時は設置したページとみなします。

memo 【メモ】

種別
ブロック型プラグイン
重要度
★☆☆☆☆
書式
#memo
概要
記述した位置に複数行入力欄とボタンを表示します。
ボタンを押下すると入力欄の記述内容を更新します。
備考
insertプラグインやarticleプラグインと似ていますが、入力した内容が入力欄の外へ出力されず、入力欄に留まる点が異なります。
個人用のメモ代わりにPukiWikiを利用している場合、未整理の情報を一時的に溜め込むのに便利です。

new 【new表示】

種別
インライン型プラグイン
重要度
★★☆☆☆
書式
書式1:
&new( [nodate] ){ 日付文字列 };
書式2:
&new( [ページ名] [,nolink] );
概要
指定した日時が最近であった場合、最近更新された事を強調表示します。日時の指定は直接日付時刻を記述する方法(書式1)と、指定したページ(群)の最終更新日時を採用する方法(書式2)の2通りがあります。

標準では5日以内の場合に New を、1日以内の場合に New! を表示します。期間や表示する文字列のパターンは設置者によってカスタマイズ可能です。

引数
書式1:

日付文字列を指定した場合、その日時が規定の期間内であった場合に強調表示します。省略した場合はページの更新日時をチェックする記述であると見なされます。

  • nodate - 日付文字列を表示しません。省略時は表示します。
書式2:

ページ名を指定した場合は、そのページの更新日時が規定の期間内であった場合に強調表示します。省略した場合は、プラグインを記述したそのページを指定したと見なします。

ページ名末尾が/であった場合、そのページ名で始まるページ群の中で最後の更新日時が規定の日付以内であった場合に強調表示します。

  • nolink - ページ名を表示しません。省略時はページ名(ページ群で指定した場合は最後に更新されたページ名)を表示します。
備考
日付文字列はPHP関数:strtotimeが認識できる書式である必要があります。

norelated 【関連ページの表示】

種別
ブロック型プラグイン
重要度
★★★☆☆
書式
#norelated
概要
ページ下部に表示される関連ページのリンクを非表示にします。
備考
極端に多くのページからリンクされていて関連リンクの表示が目障りである場合などに利用します。

ref 【画像など添付ファイルの展開】

種別
ブロック型プラグイン / インライン型プラグイン
重要度
★★★★☆
書式
#ref( 添付ファイル名| ページ名/添付ファイル名| URL {, [left|center|right], [wrap|nowrap], [around], [noicon], [noimg], [nolink], [zoom], [999x999], [999%] } [,タイトル] )
&ref( 添付ファイル名| ページ名/添付ファイル名| URL {, [noicon], [noimg], [nolink], [zoom], [999x999], [999%] } [,タイトル] );
概要
#attachで添付したファイルやURL先のファイルを指定位置に展開します。画像の場合は画像を表示し、それ以外の場合はダウンロード用のリンクを表示します。
引数
添付ファイル名にはページに添付したファイル名を指定します(省略時はエラーとなります)。別ページ名/添付ファイル名とする事で別ページの添付ファイルも指定できます。

ページ名にはファイルを添付したページをWikiNameかBracketNameで指定します。このオプションは最初(添付ファイル名の次)に記述してください。省略時は設置したページです。

パラメータにはファイルの展開方法を指定できます。

  • left|center|right - 表示時の位置を指定します。省略時はleft(変更可)です。
  • wrap|nowrap - テーブルタグで囲む/囲まないの指定を行います。省略時はnowrap(変更可)です。
  • around - テキストの回り込みを可能とします。省略時は回り込みを行いません。
  • noicon - ファイルが画像以外の場合に表示されるアイコンを表示しません。省略時は表示します。
  • noimg - ファイルが画像の場合に画像を展開しないようにします。省略時は展開します。
  • nolink - 元ファイルへのリンクを張らないようにします。省略時はリンクします。
  • zoom - 縦横比を保持します。省略時はサイズ指定に従います。
  • 999x999 - サイズを指定します(幅x高さ)。省略時は拡大率あるいは対象画像のサイズに従います。
  • 999% - サイズを指定(拡大率)します。省略時は100%です、
  • タイトル - 上記以外のパラメータは画像の代替文字列、リンクのタイトル属性として使用されます。ページ名やパラメータに見える文字列を使用するときは、#ref(hoge.png,,zoom)のようにタイトルの前にカンマを余分に入れます。
備考
aroundで行った回り込み指定を解除するには clearプラグインを使用して下さい。

"ほげ"という別ページの添付ファイル"fuga.jpg"をインラインプラグイン形式で参照する例:

&ref(ほげ/fuga.jpg);
いわゆるバナー画像のように表示した画像が別ページへのリンクとなるような指定例:
[[&ref(ほげ/fuga.jpg,nolink,ウェブ名);>ウェブのURL]] 
また、ほげというページに添付された画像を、そのページ内でパラメータを指定して(例えば半分の比率で)表示する例:
&ref(./fuga.jpg,50%);
&ref(ほげ/fuga.jpg,50%);

ruby 【ルビ】

種別
インライン型プラグイン
重要度
★☆☆☆☆
書式
&ruby( ルビ ){ 対象文字列 };
概要
文字列にルビをふります。
引数
ルビには表示するルビを指定します。
対象文字列にはルビがふられる文字列を指定します。
備考
XHTML 1.1のルビに対応したブラウザでないと、ルビとして表示されません。IE5.5/6では表示できます。Netscape 7/MozillaではXHTML Ruby Supportを組み込めば表示できます。
ルビに対応していないブラウザではルビをふる文字列の直後にルビが( )に入れられて表示されます。

size 【文字サイズ指定】

種別
インライン型プラグイン
重要度
★★★☆☆
書式
&size( ピクセル数値 ){ 文字列 };
概要
文字の大きさを指定します。
引数
ピクセル数値には文字の大きさを指定します。
文字列は文字の大きさを変更する文字列を指定します。

vote 【投票フォームを表示】

種別
ブロック型プラグイン
重要度
★★☆☆☆
書式
#vote( 選択肢1[選択肢1の投票数] [,選択肢2[選択肢2の投票数] [,選択肢3[選択肢3の投票数]… [,選択肢n[選択肢nの投票数]]] )
概要
選択肢と投票数と投票ボタンが並んだ簡易投票フォームを表示します。
引数
選択肢1~nに投票項目を指定します。投票項目に続けて半角大括弧"[]"で括った数値を指定すると選択肢の投票数を指定できます。
備考
各選択肢の投票数は編集によって容易に改竄できるため、厳密な投票には向きません。

トップ   編集 凍結解除 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2013-09-10 (火) 00:00:00