A
accordion
- 種別
ブロック型プラグイン
- 重要度
★★★★★
- 書式
#accordion(title,*|**|***,open|close){{ 記事 記事 記事 }}
- 概要
記事を見出しにまとめて+ボタンで開閉ができます。長い記事をスッキリさせるのに便利です。
{{ と }} を使って上下挟みます。- 引数
- title
見出しのタイトルです。 - *|**|***
見出しのレベルです。 - open|close
最初から開く → open
最初から閉じる → close
- title
- 備考
- ※従来の書式 accordion_start ~ accordion_end は非推奨になりました。
add
- 種別
コマンド
- 重要度
★☆☆☆☆
- 書式
?cmd=add&page=ページ名
- 概要
実行すると編集画面が表示されます。更新ボタンを押すと、指定した既存ページの末尾に編集欄で入力した内容が追加されます。
- 引数
ページ名は省略できません。ページ名はエンコードされている必要があります。
通常の編集画面が既存のページ内容を表示するのに対し、addは常に編集画面が空となります。不用意に既存の入力内容を変更する事がないため、単純に追記していくだけのページではaddを使うと便利です。
aname
- 種別
インライン型プラグイン
ブロック型プラグイン
- 重要度
★★★★☆
- 書式
&aname(アンカー名[,{[super],[full],[noid]}]){アンカー文字列}; #aname(アンカー名[,{[super],[full],[noid]},アンカー文字列])
- 概要
指定した位置にアンカー(リンクの飛び先)を設定します。
- 引数
アンカー名の値がアンカーのフラグメント指定子に使用されます。アンカー名は省略できません。アンカー名には半角英字(大文字/小文字)が使用可能です。
super,full,noid でアンカーの出力方式を指定します。
- super - アンカー文字列を上付き表示します。省略時は上付き表示されません。
- full - フラグメント指定子以外のURIを補ってアンカーを出力します。省略時はフラグメント指定子のみ出力されます。
- noid - アンカーにフラグメント指定子を出力しません。
アンカー文字列が指定された場合、指定した文字列に対してアンカーが出力されます。アンカーの存在を利用者に明示したい場合に利用します。省略時は空文字に対するアンカーとなります。
- 備考
通常はインライン型プラグインとして使用します。2つのブロック型プラグインに挟まれた部分にアンカー設定したい場合にインラインプラグインとして記述できないため、ブロック型プラグインとしても使えるようにしてあります。
areaedit
- 種別
ブロック型プラグイン
インライン型プラグイン
- 重要度
★★☆☆☆
- 書式
#areaedit([start|end|btn:<name>|nofreeze|collect[:<page>]]) &areaedit([nofreeze|preview[:<num>]]){<text>};
- 概要
ページ内の指定領域のみを編集対象とするプラグイン
- 引数
- text: 編集対象。
start: 範囲の開始。省略できる。
end: 範囲の終了。これを引数とする記述ごと省略すると、子要素のみが対象に。
btn:<name>: <name>をボタン名に変更。
nofreeze: ページが凍結されていても、その範囲は凍結されてないようにできる。
noauth: ページに編集権限がなくても、その範囲は権限があるようにできる。
collect: 同じページ内のインライン型の編集対象を収集する。
collect:<page>: <page>で指定したページ内で編集対象を収集する。
preview: インライン型に限り、編集時に編集対象の直前の空行や見出しから編集対象までを表示(99行分探索)。
preview:<num>: previewに続けて「:」と数字を書くと、空行や見出しを探す最大行数を指定できる。
article
- 種別
(コマンド)
ブロック型プラグイン
- 重要度
★★★☆☆
- 書式
#article
- 概要
指定した位置に簡易掲示板を設置します。
attach
- 種別
(コマンド)
ブロック型プラグイン
- 重要度
★★★★★
- 書式
#attach([nolist][,noform])
- 概要
ページの添付ファイルの一覧を表示し、ファイル添付のための入力フォームを設置します。
- 引数
nolist, noform で表示内容を指定します。
- nolist - ページの添付ファイルの一覧を表示しません。省略時は一覧を表示します。
- noform - ファイル添付のための入力フォームを表示しません。省略時は入力フォームを表示します。
attachref
- 種別
インライン型プラグイン
- 重要度
★★★★★
- 書式
&attachref([<file>][,<refの引数>][,button]){<ボタン名>};
- 概要
ページの添付ファイルの一覧を表示し、ファイル添付のための入力フォームを設置します。
- 引数
refの引数
B
back
- 種別
ブロック型プラグイン
- 重要度
★☆☆☆☆
- 書式
#back([[表示文字列][,[left|center|right][,[0|1][,[戻り先]]]]])
- 概要
指定した位置に戻り先へのリンクを設置します。
- 引数
表示文字列は省略すると「戻る」になります。
left、center、rightで表示位置を指定します。省略時はcenterになります。
- left - リンクを左寄せで表示します。
- center - リンクを中央寄せで表示します。
- right - リンクを右寄せで表示します。
0、1で水平線の有無を指定します。省略すると1になります。
- 0 - 水平線を表示しません。
- 1 - 水平線を表示します。
戻り先はリンクを選択時の移動先となるURL、ページ名のいずれかで指定します。PLUGIN_BACK_ALLOW_PAGELINKがTRUEの場合のみページ名を指定可能です。ページ名は「ページ名#anchor」の記述を行う事で移動先のアンカーも指定可能です。PLUGIN_BACK_ALLOW_JAVASCRIPTがTRUEの場合のみ戻り先の省略が可能です。戻り先を省略すると直前に参照していたページが戻り先になりますが、利用者のブラウザの設定がJavaScript onでないと機能しません。
br
- 種別
ブロック型プラグイン
インライン型プラグイン
- 重要度
★★☆☆☆
- 書式
#br &br;
- 概要
文章中で改行を行います。
段落やリスト、テーブル内など、行末の~による改行ではブロック要素を抜けてしまう個所で改行や空行の挿入するために用います。
C
calc
- 種別
- インライン型プラグイン
- 重要度
- ★☆☆☆☆
- 書式
例:&calc("expression" [,"decimals" [,""|"comma"|"zeropad" [,"integers"]]]);
&calc("4 * (5 - 3) / 8",3,"comma");
- 概要
- 実行すると expression に指定した式を計算してその結果を表示します。
decimals で小数点以下の桁数を、integers で整数部の桁数を指定します。
第2引数で comma を指定するとコンマ区切り、zeropad を指定するとゼロ埋めで表示します。
整数部、小数部合わせて15桁までの計算、表示が可能です。 - 引数
- expression:
計算する式。足し算(+)、引き算(-)、掛け算(*)、割り算(/)、剰余(%)、累乗(^)が計算でき、
優先順位指定のために括弧を使うことができます。
また、関数として min()、max()、avg() が使用できます。
使用例:
表示2, 3, 4 の中で最小の数値は &calc("min(2, 3, 4)"); です。 2, 3, 4 の中で最大の数値は &calc("max(2, 3, 4)"); です。 2, 3, 4 の平均は &calc("avg(2, 3, 4)"); です。
2, 3, 4 の中で最小の数値は 2 です。
2, 3, 4 の中で最大の数値は 4 です。
2, 3, 4 の平均は 3 です。
decimals:
小数点以下の桁数を指定します。
割り切れる場合は指定した桁数になるまで0が表示されます。
-1 を指定すると小数点以下が四捨五入されず、自然な形で表示されます。
例:
表示decimals を指定しない: &calc("20 / 3"); decimals を指定: &calc("20 / 3",3); decimals に-1を指定: &calc("20 / 3",-1);
decimals を指定しない: 7
decimals を指定: 6.667
decimals に-1を指定: 6.66666666666667
""|"comma"|"zeropad":
comma:コンマ区切りで表示
zeropad: integers で指定した桁数に達するまで0埋めして表示
例:
表示コンマ区切り: &calc("1000000",-1,"comma"); ゼロ埋め: &calc("1000000",-1,"zeropad",10);
コンマ区切り: 1,000,000
ゼロ埋め: 0001000000 - 備考
- 処理負荷軽減のため、複雑すぎる計算(括弧を過度に入れ子にするなど)はエラーになります。
calendar、calendar_edit、calendar_read
- 種別
ブロック型プラグイン
- 重要度
★☆☆☆☆
- 書式
#calendar([{[ページ名],[年月]}]) #calendar_edit([{[ページ名],[年月]}]) #calendar_read([{[ページ名],[年月]}])
- 概要
指定した位置にカレンダーを設置します。カレンダー上でyyyy/mm/ddという日付を選択すると、ページ名/yyyymmddというページを編集/表示できます。
カレンダーの日付を選択した場合に該当するページを編集状態、表示状態のどちらで開くかが3つのプラグインの違いです。calendar_editとは編集状態で、calendar, calendar_readは表示状態で開きます。
- 引数
ページ名は編集/参照するカレンダーのページの上位ページ名を指定します。
ページ名を省略すると設置したページのページ名になります。年月は表示するカレンダーの西暦と月をyyyymmの形式で指定します。省略した場合は現在の年月になります。
- 備考
より高機能なcalendar2プラグインがあるため、あえてcalendarプラグインを使う必要性はほとんどなくなりました。
calendar_viewer
- 種別
(コマンド)
ブロック型プラグイン
- 重要度
★★★☆☆
- 書式
#calendar_viewer(ページ名,yyyy-mm|n|x*y|this[,[past|future|view][,年月日表示の区切り文字]])
- 概要
calendarプラグインまたはcalendar2プラグインで作成されたページを指定した位置に表示します。
- 引数
ページ名はcalendarプラグインまたはcalendar2プラグインを設置しているページの名前を指定します。
yyyy-mmを指定時、指定した年月のページを表示します。
数字を指定時、指定した件数分のページを表示します。
x*yを指定時、先頭より数えて x ページ目(先頭は0)から、y件づつ一覧表示します。x と yはいずれも数値です。
thisを指定時、今月のページを一覧表示します。
past、future、viewで表示するページの条件を指定します。省略/無指定時はpastとなります。
- past - 今日以前のページを表示します。
- future - 今日以降のページを表示します。
- view - 過去から未来へ一覧表示します。
年月日の区切り文字は-や/などを指定します。省略した場合は-になります。
- 備考
calendar2プラグインでは今日の日付の記事がない場合、記事を表示しないため、午前0時になったとたんに記事が表示されなくなるという弱点がありました。calendar_viewerはその弱点を補うために開発されたプラグインです。calendar_viewは、日付が変わっても最新の記事を表示することができます。カレンダーそのものの表示はcalendar2(off)で行ないます。
calendar2
- 種別
(コマンド)
ブロック型プラグイン
- 重要度
★★★☆☆
- 書式
#calendar2([{[ページ名|*],[yyyymm],[off]}])
- 概要
指定した位置にカレンダーを設置します。表示月のとなりに表示されたリンク(<< および >>)を選択することで先月/次月分のカレンダーを表示できます。カレンダー上でyyyy/mm/ddという日付を選択すると、ページ名/yyyy-mm-ddというページを表示できます。当日分のページが作成されていた場合、カレンダーの右隣に当日分のページ内容を表示します。
- 引数
ページ名で表示するページの上位階層のページを指定できます。ページ名を省略すると設置したページのページとなります。ページ名に*を指定すると上位階層のページはなし(表示するページ名がyyyy-mm-dd)となります。
yyyymmで表示するカレンダーの西暦と月を指定できます。省略時は当日の年月となります。
offを指定時、当日分ページを表示する機能は抑制されます。省略時は当日分のページを表示します。
- 備考
calender_editで作成したページはページ名/yyyymmddとなり、calender2で作成したページはページ名/yyyy-mm-ddとなるため、注意が必要です。
clear
- 種別
ブロック型プラグイン
- 重要度
★☆☆☆☆
- 書式
#clear
- 概要
refプラグインのaroundオプションで有効となったテキスト回り込み指定を解除します。
- 備考
imgプラグインのclearオプション指定時と処理内容は同等です。
code
- 種別
ブロック型プラグイン
- 重要度
★☆☆☆☆
- 書式
#code[([言語名][,number|nonumber])]{{ ソースコード }}
- 概要
ソースコードにコードハイライトを適用します。
- 引数
- 言語名
言語名を指定します。
例えば、javaなど。 - number|nonumber
行番号の表示を指定します。
- 言語名
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
- 概要
設置したページ中の見出しの一覧を表示します。
counter
- 種別
ブロック型プラグイン
インライン型プラグイン
- 重要度
★★★☆☆
- 書式
#counter &counter([total|oday|yesterday]);
- 概要
設置したページの参照回数を表示します。
- 引数
カウンタ表示方法として total, today, yesterday いずれかを指定します。省略時はtotalが指定されたとみなします。ブロック型プラグインでは常にtotalが指定されたとみなします。
- total - そのページが参照された回数の総計を表示します。
- today - そのページが参照された回数(当日分)を表示します。
- yesterday - そのページが参照された回数(昨日分)を表示します。
- 備考
すべてのページで参照回数を表示したい場合は、MenuBarやスキンからcounterプラグインを呼び出してください。
D
deleted
- 種別
コマンド
- 重要度
★★☆☆☆
- 書式
?cmd=deleted{[&dir=diff|backup][&file=on]}
- 概要
削除されたページの一覧を表示します。
- 引数
file=onを指定時、バックアップ(あるいは差分)のファイル名を出力します。省略時は表示しません。
dirで削除の判定方法を指定します。省略時はbackupです。
- backup - バックアップが存在し、ページが存在しない時に削除されたとみなします
- diff - 差分が存在し、ページが存在しない時に削除されたとみなします
- 備考
公開Wikiの管理者にとっては誤操作や悪意をもった編集によるページ削除をチェックするのに重宝します。
dump
- 種別
コマンド
- 重要度
★☆☆☆☆
- 書式
?cmd=dump
- 概要
指定ディレクトリ内のファイルをまとめてtar(tar.gz, tgz)形式でバックアップ/リストアします。
バックアップの実行には管理者パスワードが必要です。
バックアップはファイル名をページ名に変換して取得する事ができます。
この変換でリストアには利用出来なくなりますが、
ファイル名からページ名の類推は容易になります。
バックアップは取得するディレクトリを任意に指定する事ができます。
そのため、ファイルの削除を行う事はできません。
バックアップ/リストア対象として指定可能なディレクトリは、以下の通りです。- DATA_DIR (wiki/*.txt)
- UPLOAD_DIR (attach/*)
- BACKUP_DIR (backup/*)