HikiDocのオプションをメモ
HikiDocのto_html(or to_xhtml)メソッドには、いくつかのオプションが指定できます。
ぱっとググっただけではまとめたものが見あたらない(Hikiのメーリングリストに断片的に存在するんだけど…)のでメモしてみます。
- use_wiki_name
- WikiName記法(含む^WikiName記法)の解釈を有効するか。trueを指定した場合に有効となる。デフォルトはtrue。
- use_not_wiki_name
- ^WikiName記法を有効にするか。これをtrueにすると有効になり、WikiNameの直前にハット記号(^)つけると、WikiNameとしてのリンク置換が抑制される。デフォルトはtrue。
- allow_blacket_inline_image
- URL記法(2重カギ括弧)において、インライン画像への置換を有効にするか。これをtrueにすると、指定したURLの拡張子がjpg,jpeg,png,gifの場合、aタグではなくimgタグに置換される。デフォルトはtrue。
- level
- 見出し記法(感嘆符)をヘッダタグ(h1〜h6)に置換する際のオフセット値を指定する。使用されるヘッダタグは次の計算値に基づいて決定される。[ヘッダタグのレベル] = ((感嘆符の連続数 - 1) + level)。例えば、levelに2を指定すると、"!"はh2タグに置換される。デフォルトは1。
- plugin_syntax
- プラグイン記法(2重中括弧)を評価するプラグイン文法メソッドを指定する。パース時に、プラグイン文法メソッドには2重中括弧を除いた文字列が引数として渡される。プラグイン文法メソッドは、置換すべき内容が存在すれば引数の文字列を破壊的に更新した上で戻り値にtrueを返すことで、それをパーサに渡すことが出来る。デフォルトではフォーマットのチェックのみを行う(HikiDoc内部の)プラグイン文法メソッドが指定される。
あれ…そんなに数はないのね。