HTML_RENDER_TOOL¶

Kinkdoc文書を単一のHTMLファイルにレンダリングする起動可能モジュール。

使い方

kink [Kink_options]... mod:kink/doc/render/html/HTML_RENDER_TOOL [Mod_options] <JSON >HTML

コマンドは、kinkdocのJSONデータを標準出力から読み取って、単一のHTMLファイルに変換し、標準出力に書き出す。

Mod_options

• --style {Style_file_path} : CSSファイルのパスを指定する。ファイルの内容はUTF-8でエンコードされていなければならない。内容は、HTMLファイルのstyle要素の中に挿入される。

• --template {Template_file_path} : HTMLテンプレートファイルのパスを指定する。詳細は次の節に。

HTMLテンプレートの内容

HTMLテンプレートはUTF-8でエンコードされていた、Str.formatのテンプレート文字列でなければならない。その内容には、HTMLエスケープされた文書タイトルのためのプレースホルダとして `{Title}`, CSSのプレースホルダとして `{Style}`, <body>要素の内容のプレースホルダとして `{Body}` を含まなければならない。

デフォルトのテンプレートは次の通り:

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8" />
  <title>{Title}</title>
  <style>
{Style}
  </style>
</head>
<body>
{Body}
</body>
</html>

終了ステータス

コマンドが成功したら、終了ステータス0で終了する。

失敗したら、コマンドは0以外の終了ステータスで終了する。

使い方の例

$ kink mod:kink/doc/DOC_PARSE_TOOL --title 'API reference' src >doc.json
...
$ kink mod:kink/doc/render/html/HTML_RENDER_TOOL <doc.json >doc.html

6.48.1. HTML_RENDER_TOOL.main(Argv)¶

mainはモジュールの起動関数である。