WiLiKi:Macros

WiLiKi:Macros

二重角括弧で囲まれ、「$」で始まる語句はWiLiKiのマクロです。 マクロの中には引数をとることができるものもあります。 引数はマクロ語句の後に空白文字で区切って列挙できます。

マクロには種類が2つあります。 1つは「書き手マクロ(writer macro)」で、WiLiKiが内容を保存する際マクロが解釈されて解釈結果が書き込まれます。 内容書き込みを行うと、データベースは解釈後の内容を保持し、マクロを再び見ることはできなくなります。 もう一方は「読み手マクロ(reader macro)」で、WiLiKiが出力内容を作る際マクロが解釈されます。データベースはマクロの記述をそのまま保持しています。 書き手マクロは1個の「$」が、読み手マクロは2個の「$」が前に来ます。

今のところ、WiLiKiには次のようなマクロがあります。

$date

(writer macro). 現在の日付を書き込みます。

$$include wikiname

(reader macro). 「wikiname」で指定された ページの内容をそのまま引用して表示します。指定されたページが存在 しない場合、このマクロは処理されません。

$$index prefix

(reader macro). 「prefix」で始まるwikiページのリスト を箇条書きにして表示します。例えば '[[$$index あ]]' は、 ページ名が「あ」で始まるページのリストを表示します。

$$cindex prefix [separator]

(reader macro). コンパクトな目次を表示します。 $$index と似ていますが、ページ一覧は <ul> ... </ul> (箇条書き)を使うのではなく、「separator」に指定した文字によって区切られて表示されます。 「separator」を省略した場合は空白文字が用いられます。

$$toc [pagename]

(reader macro). 指定したページ内の見出し一覧を表示します。 「pagename」を指定しなかった場合は現在のページの見出し一覧が表示されます。

マクロとして認識できないマクロ名を指定した場合、そのマクロ記述はそのまま残されます。

More ...