nDiki : InlineParser

WRI Wiki 日記 ロック BracketName WiKicker WikiEngine hns 識別子 文法 InlineBlockNode 正規表現 HtmlFragmentVisitor 脚注 プラグイン

■ [ WiKicker ] WiKicker へ脚注機能追加

WiKicker スタイルで日記を記述するにあたり欠けている機能として「脚注」がある。 Wiki としては必須でないので WiKicker には導入していないのだが、日記としては無いと困る。 脚注が使えると文を書く時に正直手を抜ける。 また hns 上の旧記事をコンバートする時にも無いといろいろ面倒だし。

ということで実装。

@ インラインブロック

さてどうしたものか。 WiKicker の WRI (BracketName 等を含む識別子)としての実装なら、parser の変更もなく新しいWRI scheme の追加と対応するクラスを書くだけですむ。 しかし WRI は終端記号なので、そうすると脚注の中でWRIを使えなくなる。 それは困る。

ということで、やはり非終端記号が必要。 悩んだあげく、

 {{scheme: ... }}

という「インラインブロック非終端記号」を導入。 {{..}} というのは確かいくつかの WikiEngine でプラグイン呼び出しで使っている記法だったような。

• 一般的な文章中には現れず、
• かといって文章中に混ぜてもそれほど違和感なく(wiki ではこれが重要)
• これ以上文法を追加したくないので、今後機能追加の際に利用できるように scheme 指定できる

といった点から、このようにしてみた。 2番目の点で合格点の出せる記法かどうかは微妙だが、まぁ許せる範囲かな。

{{ }} は、1行中に現れる必要有り。 「...」は scheme specific part だが、今のところ scheme によらず、InlineParser で解析されて部分木になるため、WRI とか ... とかも書ける。 InlineParser では正規表現を使っていて括弧の数は数えないので、今のところ {{ }} の中に {{ }} は書けないが、まぁ問題ないでしょう。

@ 脚注記法

で脚注は、

 {{fn: ...}}

となる。 普通。

@ 実装

• InlineParser の拡張
• InlineBlockNode クラスの追加
• 各 Visitor に visit_InlineBlockNode を追加。
• HtmlFragmentVisitor に fn: の処理を追加。

いざ実装してみると、ちょこっとのコードで実現。 脚注番号の降り方とか、今後改良する点はあるけど、大枠は完成。

• Wikiの文法の標準化 (2004-02-10)
• [ WiKicker ] hell mode - HTMLタグ付けブロックの導入 (2005-09-13)
• 無制限 HTML タグ付けブロックを使って nDiki に Google ... (2007-08-23)
• WiKicker に JSON でのページ出力機能を追加 (2007-04-03)
• キックオフミーティング2日目 (2004-10-26)