LicanaはWiki CreoleテキストをHTMLに変換するツール。 テキスト整形規則Creole 1.0 およびCreole追加仕様に対応している。 ディレクトリを再帰的にたどって変換する必要のあるファイルを探し出し、多数のファイルを一度に変換できる。 静的なウェブ文書ツリーを作成するのに使われる。
LicanaはGNU GPLv3+ライセンスの下にある。
Copyright (c) 2019 Kashiko Koibumi (BM-NBk7BXQx8AiCpUCLWzgovcpGf93shKN1) <kashiko@tuta.io>
ソースコードは https://gitlab.com/kashiko/licana-gnat/ にある。
LicanaはAda 2012で書かれていて、ビルドするにはGNATを使う。GNATCOLLも必要である。 プロジェクトのディレクトリで gprbuild を実行すると、実行ファイル obj/licana が作られる。 これを好きな所にコピーして、コマンドとして呼び出して使う。
GNU/Linuxで動作確認をしてある。
Licanaは、起点となるディレクトリ以下にある拡張子 ".txt" のテキストファイルそれぞれに対し、 拡張子 ".html" の変換されたHTMLファイルを生成する。 設定ファイル licana.conf が存在するディレクトリが起点ディレクトリとなる。 テキストファイルに対応するHTMLファイルが存在しないとき、テキストファイルがHTMLファイルより新しいとき、 あるいは設定ファイルがHTMLファイルより新しいときのみ変換が行なわれる。 --force (または -f) オプションを指定した場合は、これらの条件を考慮せず、すべてのテキストファイルをHTMLファイルに変換する。
まず、起点とするディレクトリを現在のディレクトリとした状態で licana init を実行すると、 そのディレクトリにデフォルトの設定ファイル licana.conf が生成される(同時にデフォルトのスタイルシート style.css も生成される)。 その後、単に licana を実行すると、上に述べたように、起点ディレクトリから再帰的に変換作業が行なわれる。 起点ディレクトリより深いディレクトリに居るときに licana を実行しても、 起点ディレクトリにさかのぼり、そこから再帰的に変換作業が行なわれる。
--verbose (または -v) オプションを指定すると、作業ログ出力が若干詳しくなる。
動作設定は licana.conf をテキストエディタで編集して行なう。
Embedded (デフォルトは False) を True にすると、HTMLヘッダとフッタを出力しない。 他のHTMLファイルに埋め込むときに使われる。
Style_Sheet_URL (デフォルトは style.css) では、スタイルシートのURLを指定できる。
Tilde_Escape_In_Headings_Enabled (デフォルトは False) を True にすると、見出しの中でチルダによるエスケープができるようになる。
Additions_Enabled (デフォルトは False) を True にすると、 (ブロックの)Creole追加仕様が利用できるようになる。
Indent_Style (デフォルトは class="indent") では、 Creole追加仕様 にあるインデントされた段落のスタイルやクラスを指定できる。
Heading_Anchors_Enabled (デフォルトは False) を True にすると、各見出しにアンカーが生成される。
Null_Contents_Enabled (デフォルトは False) を True にすると、HTMLに変換された結果が見えなくなる場合でも整形規則が適用される。
URL_Schemes (デフォルトは http,ftp,https,file) では、URLとして認識されるスキームを指定できる。
Additions_Enabled (デフォルトは False) を True にすると、 (段落内の)Creole追加仕様が利用できるようになる。
MathJax_Enabled (デフォルトは False) を True にすると、MathJaxを使えるようになる。
URL_Fragment_Prefix_Omission_Enabled (デフォルトは False) を True にすると、アンカーに対する角括弧リンクで # が省略されて表示される。