[Japanese] [English]

Index

• 概要

• 使い方

  • 例

• オプション

  • -b NUM (--base-level=NUM)
  • -d NUM (--max-depth=NUM)
  • --with-part=PART

Title: RD の HeadLine の目次を作る

Version1.0.0 rd-hindex-1.0.0.tar.gz

森川さんと安宅さんが拙作オリジナル版rd-hindex.rbを改良してくれました。 ありがとうございます。 これを機に正式リリースします。

1 概要

RD から HeadLine の目次 RD を作成する。 長文 RD を扱うときは便利。

+ レベル 5 のヘッダ

と

++ レベル 6 のヘッダ

も目次として取り込む仕様になっている。

他にも、目次レベルの最小値と最大値の設定やフィルター機能を利用している RD のための名前付き PART にも対応している。

2 使い方

まずこのスクリプトで目次を作成します。

1. 目次作成

   $ ruby rd-hindex.rb input.rd > input.hindex.rd

2. rd2コマンドでもとのRDより先に指定するか、もとのRDにIncludeで取り込む。

2.1 例

例えばこの rd-hindex.ja.rd でやってみると以下のような感じ

1. 目次ファイル生成。

   $ ruby rd-hindex.rb rd-hindex.ja.rd > rd-hindex.ja.hindex.rd

2. 取り込んで HTML 作成。

   $ rd2 rd-hindex.ja.hindex.rd rd-hindex.ja.rd > rd-hindex.ja.html

加えて、test-rd-hindex.rbにもテストプログラム兼実行例が置いている。

3 オプション

3.1 -b NUM (--base-level=NUM)

目次レベルの最小値を設定する。 デフォールト値は2。 つまり、h2要素以下に対して目次を作成する。 h1要素も目次に含めるには、-b 1 を指定する。

3.2 -d NUM (--max-depth=NUM)

目次レベルの最大値を設定する。 デフォールト値は6。

3.3 --with-part=PART

フィルター機能を利用している RD の「名前付き Part」に対応 している。例えば PART に "JA:rd" を指定すると、 "=begin JA" と "=end JA" でくくられた部分の目次も作成する。 なお "JA:include" と指定した場合は目次を作成しない。 (rd2 の --with-part オプションと書式をあわせたつもり)。

Back to Top