hypertocp - クラウドでオンライン

プログラム：

NAME

hypertoc - HTML ドキュメントの目次を生成する

VERSION

バージョン3.20

SYNOPSIS

hypertoc --help | --マンページ | --man_help | - 男

hypertoc [--bak 文字列 ] [ --debug ] [ --entrysep 文字列 ] [ --フッター file ] [ --header
file ] [ --ignore_only_one ] [ --ignore_sole_first ] [ --inline ] [ --make_anchors ] [
--make_toc ] [ --notoc_match 文字列 ] [ --ol | --nool ] [ --ol_num_levels ] [ --outfile
file ] [ --overwrite ] [ --quiet ] [ --textonly ] [ --title 文字列 ] { --toc_after
タグ=サフィックス } { --toc_before タグ=プレフィックス } { --toc_end タグ=終了タグ } { --toc_entry タグ=レベル
} [ --toc_label 文字列 ] [ --toc_only | --notoc_only ] [ --toc_tag 文字列 ] [
--toc_tag_replace ] [ --use_id ] [ --useorg ] ファイル ...

DESCRIPTION

hypertoc では、ハイパーリンクされる「重要な要素」を指定できます。
特定の HTML ドキュメント セットの「目次」(ToC)。

基本的に、生成された目次は、へのリンクを含む複数レベルのリストです。
重要な要素。 hypertoc は、重要な要素へのリンクを目次に挿入します。
ユーザーが指定したレベル。

例：

H1 がレベル 1 として指定されている場合、ToC の最初のレベル リストに表示されます。 もしも
H2 は、ToC の第 2 レベルのリストに表示されるよりも、レベル XNUMX として指定されています。

ToC の生成には 1 つの側面があります: (XNUMX) HTML に適切なアンカーを配置する
ドキュメント (--make_anchors)、および (2) を持つ HTML ドキュメントから ToC を生成する
ToC がリンクするためのアンカー (--make_toc)。 のいずれかまたは両方を選択できます。
これら。

hypertoc は、ToC を HTML ドキュメント自体に組み込む機能もサポートしています。
--inline オプションを介して。

hypertoc が重要な要素へのリンクをサポートするために、hypertoc はアンカーを挿入します。
重要な要素に。 hypertoc をフィルターとして使用して、結果を
別のファイル、または元のファイルを上書きして、元のファイルをバックアップすることができます
ファイル名に追加される接尾辞 (デフォルト: "org")。

コマンドラインだけでなく、設定ファイルでもオプションを定義できます。

OPTIONS

オプションは「--」または「-」で始めることができます。 ブール値オプションは、前に付けることで無効にすることができます
"番号"; ハッシュ値または配列値を含むオプションは、オプションを再度指定することで追加できます
それぞれの値。

詳細については、Getopt::Long を参照してください。

--argfile ファイル名
追加のオプションを読み取るファイルの名前。 これは複数回使用できます。 にとって
例：

--argfile your.args --argfile my.args

詳細については、「オプション ファイル」を参照してください。

--バク
--バク 文字列

入力ファイルが上書きされている (--overwrite がオンになっている) 場合は、
元のファイルを「ファイル名.文字列"。値が空の場合、バックアップ ファイルはありません。
書いた。 (デフォルト:組織)

- デバッグ
詳細なデバッグ出力を有効にします。 このモジュールのデバッグに使用されます。 言い換えると、
気にしないでください。 (デフォルト:オフ)

--entrysep
--entrysep 文字列

非の区切り文字列項目のエントリ (デフォルト: ", ")

-フッター
-フッター file

目次のフッター テキストを含むファイル。

- ヘッダ
- ヘッダ file

目次のヘッダー テキストを含むファイル。

- 助けて
短いヘルプメッセージを印刷して終了します。

--ignore_only_one
ToC に項目が XNUMX つしかない場合は、ToC を作成しないでください。

--ignore_sole_first
ToC の最初の項目が最高レベルであり、かつそれがその唯一の項目である場合
レベル、無視してください。 これは、H1 ヘッダーが XNUMX つしかない Web ページで役立ちますが、
XNUMXつだけになるかどうかは事前にわかりません。

- 列をなして
ドキュメントの特定の時点で ToC を挿入します。 詳細については、「ToC のインライン化」を参照してください。

--make_anchors | --gen_anchors
リンクする目次のアンカーを作成します。

--make_toc | --gen_toc
アンカーされた重要な要素にリンクする目次を作成します。

--man_help | --マンページ | - 男
すべてのドキュメントを印刷して終了します。

--notoc_match
--notoc_match 文字列

のテーブルに含めたくない特定のタグがある場合は、
内容が「重要な要素」に一致していても、このパターンの場合
(本体ではなく) タグ内のコンテンツに一致する場合、そのタグは含まれません。
アンカーの生成でも、ToC の生成でも。 (デフォルト: class="notoc")

--オール | --ノール
目次エントリの順序付きリストを (特定の深さまで) 使用します。 --ol の場合
false (つまり --nool が設定されている) の場合 しない ToC エントリには番号付きリストを使用します。

(デフォルト: false)

( --ol_num_levels を参照して、順序付きリストのリストの深さを判断してください)

--ol_num_levels
--ol が true の場合、OL リストの深さのレベル数。 ゼロに設定すると、
すべてのレベルで番号付きリストを使用します。 (デフォルト:1)

--outfile
--outfile file

出力を書き込むファイル。 これは、変更された HTML 出力と Table-of-
内容は へ。 ファイル名として「-」を指定すると、出力は STDOUT に送られます。
(デフォルト: STDOUT)

-上書き
入力ファイルを出力で上書きします。 これが有効な場合、 --outfile は無視されます。
で使われる 生成アンカー アンカーを「所定の位置に」作成するため 生成_toc if
--inline オプションが有効です。 (デフォルト:オフ)

- 静かな
情報メッセージを抑制します。 (デフォルト: オフ)

- テキストのみ
重要な要素にはテキスト コンテンツのみを使用します。

- 題名
- 題名 文字列

ToC ページのタイトル (--header または --inline または --toc_only を使用しない場合) (デフォルト: "Table
目次」）

--toc_after
--toc_after タグ=サフィックス

--toc_after "H2= "

ToC の重要な要素のレイアウトを定義するため。 の タグ はHTMLタグです
要素の開始を示します。 の サフィックス に追加する必要があるものです
そのタグ用に生成された目次エントリ。 これは累積ハッシュ引数です。
(デフォルト: 未定義)

--toc_before
--toc_before タグ=接頭辞

--toc_before "H2= "

ToC の重要な要素のレイアウトを定義します。 の タグ HTMLタグです
要素の開始を示します。 の 接頭辞 先頭に追加する必要があるものです
そのタグ用に生成された目次エントリに。 これは累積ハッシュです
口論。 (デフォルト: 未定義)

--toc_end
--toc_end タグ=終了タグ

--toc_end "H1=/H1"

重要な要素を定義するため。 の タグ の開始を示す HTML タグです。
要素。 の 終了タグ 要素の終わりを示す HTML タグ。 いつ
入力ファイルで一致する場合、大文字と小文字は無視されます (ただし、すべての タグ オプション
同じタグを参照することはまったく同じです!)。 これは累積ハッシュ引数です。
(デフォルト: H1=/H1 H2=/H2)

--toc_entry
--toc_entry タグ=レベル

--toc_entry "TITLE=1" --toc_entry "H1=2"

重要な要素を定義するため。 の タグ の開始を示す HTML タグです。
要素。 の レベル タグが考慮されるレベルです。 の値 レベル
ゼロ以外の数値でなければなりません。 値が負の場合、連続エントリ
重要な要素によって表される要素は、によって設定された値によって区切られます
--entrysep オプション。 これは累積ハッシュ引数です。 (デフォルト: H1=1 H2=2)

--toc_label | --トクラベル
--toc_label 文字列

ToC にラベルを付ける HTML テキスト。 常に使用されます。 （デフォルト： " 目次"）

--toc_only | --notoc_only
目次のみ、つまり、目次と toc_label を出力します。
--header や --footer があれば、それらも出力されます。

--toc_only が false (つまり、 --notoc_only が設定されている) の場合、 --header がない場合、および
--inline が true でない場合、適切な HTML ページ ヘッダーが出力されます。
no --footer および --inline が true でない場合、HTML ページのフッターが出力されます。
(デフォルト:--notoc_only)

--toc_tag
--toc_tag 文字列

ToC がインラインで含まれる場合、これはタグの照合に使用されるパターンです
ToC を配置する場所。 これは開始タグ、終了タグ、コメントのいずれでもかまいませんが、
< は省略してください。 つまり、TOC を BODY の後に配置する場合
タグを付けてから、「BODY」を付けます。 特別なコメント タグを ToC の必要な場所に作成する場合
次に、コメント マークを含めます。例: "!--toc--" (デフォルト: BODY)

--toc_tag_replace
--toc_tag と組み合わせて、これは指定されたタグが必要かどうかを示すフラグです。
または、ToC をタグの後に配置する必要がある場合。 これは、次の場合に役立ちます。
toc_tag はコメントであり、ToC を配置した後は必要ありません。
(デフォルト: false)

--use_id
id=" を使用名ではなくアンカーの "名"> アンカー。ただし、アンカーの場合
重要な要素がすでに存在するため、その特定の ID は作成されません
要素。

--userorg
既存のバックアップ ファイルを入力ソースとして使用します。 つまり、形式のファイル
ファイル名.BAK (--bak を参照)。

FILE 書式

オプション
オプションは、 --argfile を使用してコマンドラインだけでなく、ファイルでも指定できます。
ファイル名 コマンドラインのオプション。 また、ファイル ~/.hypertocrc および ./.hypertocrc は
オプションを確認しました。

形式は次のとおりです。 # で始まる行はコメントです。 PoD で囲まれた行
マーカーもコメントです。 空行は無視されます。 オプション自体は
コマンドラインでの方法、つまりオプション名 (配合工業用化学製品の 　
--) その後にその値 (存在する場合) が続きます。

例：

# ToC を XNUMX レベルに設定
--toc_entry H1=1
--toc_entry H2=2
--toc_entry H3=3

--toc_end H1=/H1
--toc_end H2=/H2
--toc_end H3=/H3

--argfile を指定することで、オプション ファイルをネストすることができます。 ファイル名 オプション内の引数
ファイル、参照されたファイルも取得します。

詳細については、Getopt::ArgvFile を参照してください。

詳細

重要 要素
目次の重要な要素を定義する例をいくつか示します。

例 of デフォルト

以下は、何も明示的に指定されていない場合のデフォルト設定を反映しています。

--toc_entry "H1=1" --toc_end "H1=/H1" --toc_entry "H2=2" --toc_end "H2=/H2"

または、可能な「オプション ファイル」のいずれかで定義されている場合:

＃ デフォルトの設定
--toc_entry H1=1
--toc_end H1=/H1
--toc_entry H2=2
--toc_end H2=/H2

例 of ビフォアーアフター

次のオプションは、before/after オプションを利用します。

# フォーマットを追加するオプション ファイル
# レベル 1 の目次エントリを作成
--toc_entry H1=1
--toc_end H1=/H1
--toc_before H1=
--toc_after H1=

# レベル 2 の目次エントリを作成
--toc_entry H2=2
--toc_end H2=/H2
--toc_before H2=
--toc_after H2=

# レベル 3 のエントリをそのまま作成
--toc_entry H3=3
--toc_end H3=/H3

例 of カスタム end

次のオプションは、定義用語の索引付けを試みます。

# 用語集タイプのドキュメントで機能するオプション ファイル
--toc_entry H1=1
--toc_end H1=/H1
--toc_entry H2=2
--toc_end H2=/H2

# ドキュメントには各 DT の DD があると仮定します。それ以外の場合は ToC
# テキストの多いエントリを取得します。
--toc_entry DT=3
--toc_end DT=DD
--toc_before DT=
--toc_after DT=

書式設定 　 目次
--toc_entry などのオプションを使用すると、ToC エントリの外観を制御できますが、
作成される ToC ファイルの最終的な外観に影響を与えるその他のオプションです。

--header オプションを使用すると、指定されたファイルの内容がヘッダーの前に追加されます。
ToC を生成しました。 これにより、導入テキストまたはその他のテキストをテキストの前に置くことができます。
目次

注：
--header オプションを使用する場合は、指定されたファイルに開始 HTML が含まれていることを確認してください。
タグ、HEAD 要素 (TITLE 要素を含む)、および開始 BODY タグです。
ただし、 --inline オプションが
使用されている。 ヘッダー ファイルに何を含める必要があるかについては、「ToC のインライン化」を参照してください。
ToC をインライン化するため。

--toc_label オプションを使用すると、指定された文字列の内容がラベルの前に追加されます。
ToC を生成します (ただし、 --header ファイルから取得したテキストの後)。

--footer オプションを使用すると、生成されたファイルの後にファイルの内容が追加されます。
目次

注：
-footer を使用する場合は、BODY と HTML の終了タグが含まれていることを確認してください (ただし、
もちろん、 --inline オプションを使用しています)。

--header オプションが指定されていない場合、適切な開始 HTML マークアップは
--toc_only オプションが指定されていない限り、追加されました。 --footer オプションが指定されていない場合
--toc_only オプションを指定しない限り、適切な終了 HTML マークアップが追加されます。
指定されています。

ヘッダー、フッター、ファイルを処理したくない/処理する必要がない場合は、
--title オプションで ToC ファイルのタイトルを指定します。 そしてそれはあなたが指定することを可能にします
--toc_label オプションで、ToC エントリのリストの前に置く見出しまたはラベル。 両方のオプション
各オプションの詳細については、「オプション」を参照してください。

HTML ページ タグを提供せずに ToC 自体が必要な場合は、
--toc_only オプションを指定します。 --header または --footer ファイルがない場合、これは
--toc_label の内容と ToC 自体を出力するだけです。

インライン化 　 目次
ToC を HTML ドキュメントに直接組み込む機能は、
--inline オプション。

インライン化は、処理されたファイルのリストの最初のファイルに対して行われます。
そのファイルに --toc_tag 値と一致する開始タグが含まれている場合に実行されます。

--overwrite が true の場合、リストの最初のファイルが上書きされます。
生成された ToC が適切な場所に挿入されます。 それ以外の場合は、最初の修正版
file は、STDOUT または --outfile オプションで定義された出力ファイルに出力されます。

オプション --toc_tag および --toc_tag_replace を使用して、ToC の場所と方法を決定します。
出力に挿入されます。

例 1

# これがデフォルトです
--toc_tag BODY --notoc_tag_replace

これにより、最初のファイルの BODY タグの後に、生成された ToC が配置されます。 --header の場合
オプションを指定すると、指定したファイルの内容が BODY の後に挿入されます。
鬼ごっこ。 --toc_label オプションが空でない場合、 --toc_label オプションで指定されたテキスト
オプションが挿入されます。 次に目次が挿入され、最後に --footer オプションが指定されている場合
指定すると、フッターが挿入されます。 その後、入力ファイルの残りの部分はそのまま続きます
前に。

例 2

--toc_tag '!--toc--' --toc_tag_replace

これにより、生成された ToC がフォームの最初のコメントの後に配置されます、そしてそれ
コメントは ToC に置き換えられます (順番に
- ヘッダ
--toc_label
目次
--footer) の後に、残りの入力ファイルが続きます。

注：
ヘッダー ファイルには、開始 HTML タグと HEAD 要素を含めないでください。
処理中の HTML ファイルには、これらのタグ/要素がすでに含まれている必要があります。

例

創造する an インライン 目次 for XNUMXつ file
hypertoc --inline --make_anchors --overwrite --make_tocindex.html

これにより、「index.html」にアンカーが作成され、「Table of
Contents」を作成し、「index.html」の BODY タグの後に配置します。ファイル index.html.org は、
ToC やアンカーを含まない元の index.html ファイルが含まれます。

創造する a 目次 file から の試合に ファイル
まず、アンカーを作成します。

hypertoc --make_anchors --overwriteindex.html fred.html george.html

次に、ToC を作成します。

hypertoc --make_toc --outfile table.html index.html fred.html george.html

創造する an インライン 目次 After 　 最初の 見出し of 　 最初の file
hypertoc --make_anchors --inline --overwrite --make_toc --toc_tag /H1 \
--notoc_tag_replace --toc_label "" index.html fred.html george.html

これにより、「index.html」、「fred.html」、および「george.html」ファイルにアンカーが作成されます。
ヘッダーなしの目次を作成し、「index.html」の最初の H1 ヘッダーの後に配置してバックアップします
元のファイルを「index.html.org」、「fred.html.org」、「george.html.org」に

創造する an インライン 目次 　 カスタム 要素は
hypertoc --quiet --make_anchors --bak "" --overwrite \
--make_toc --inline --toc_label "" --toc_tag '!--toc--' \
--toc_tag_replace \
--toc_entry H2=1 --toc_entry H3=2 \
--toc_end H2=/H2 --toc_end H3=/H3 myfile.html

これにより、元のファイルを上書きするインラインの目次が作成され、
コメントであり、H2 ヘッダーをレベル 1、H3 ヘッダーをレベル 2 とします。
.html ファイルが他のプロセスによって生成される場合に便利です。
最後のステップとして目次。

創造する a 目次 　 カスタム 要素は
hypertoc --quiet --make_anchors --bak "" --overwrite \
--toc_entry TITLE=1 --toc_end TITLE=/TITLE
--toc_entry H2=2 --toc_entry H3=3 \
--toc_end H2=/H2 --toc_end H3=/H3 \
--make_toc --outfileindex.html \
メアリー.html フレッド.html ジョージ.html

これにより、H2 要素と H3 要素にアンカーが作成され、index.html という ToC ファイルが作成されます。
TITLE、および H2 要素と H3 要素のインデックス作成。

創造する a 目次 　 カスタム 要素は & オプション file
次のように「custom.opt」というオプション ファイルがあるとします。

# タイトル、H2、H3
--toc_entry TITLE=1
--toc_end TITLE=/TITLE
--toc_entry H2=2
--toc_end H2=/H2
--toc_entry H3=3
--toc_end H3=/H3

前の例では、次のように短いコマンド ラインを使用できます。

hypertoc --quiet --make_anchors --bak "" --overwrite \
--argfilecustom.opt --make_toc --outfileindex.html mary.html fred.html george.html

注意事項

· hypertoc は、重要な要素内のアンカーを検出するのに十分スマートです。 アンカーなら
NAME 属性を定義し、hypertoc は値を使用します。 それ以外の場合は、独自の NAME を追加します
アンカーへの属性。 --use_id が true の場合、同様にチェックして使用します
ID。

· TITLE 要素は、重要な要素として指定されている場合、特別に扱われます。 それは
アンカー (A) を TITLE 要素に挿入することは違法です。 したがって、hypertoc は実際には
ドキュメントの TITLE 要素ではなく、ファイル名自体へのリンク。

· hypertoc は、非空白が含まれていない場合、重要な要素を無視します
文字。 そのような状態が存在する場合、警告メッセージが生成されます。

・少し乱れた状態で変化する重要な要素の連続がある場合
H1 -> H3 -> H2 または H2 -> H1 などのファッション。
順序付きリストを使用している場合は、まだ適切な HTML であるリストを作成します。
追加のリスト要素が追加されるため、奇妙な番号付けが行われます。
正しいレベルで要素をネストするために挿入されます。

例 (H2 -> H1 with --ol_num_levels=1):

1.
* 私の H2 ヘッダー
2.私のH1ヘッダー

例 (H1 -> H3 -> H2 with --ol_num_levels=0 および H3 も重要):

1.私のH1ヘッダー
1.
1.私のH3ヘッダー
2.私のH2ヘッダー
2. 1 つ目の HXNUMX ヘッダー

このような場合、 --ol オプションを使用しない方がよい場合があります。

· アンカーを生成するときに --overwrite を使用していない場合、コマンドは
正しいファイル名 (実際の
それらのアンカー) を ToC 生成部分に追加します。 それ以外の場合、ToC にはアンカーがあります
それらを持たないファイルを指しています。

· --inline を使用する場合、上書きする場合は注意が必要です -- ToC を
特定のタグ (デフォルトの BODY など) の後に含めることができ、コマンドを実行すると
繰り返し、同じファイルで複数の目次を次々に取得できます。

警告

· バージョン 3.10 (およびそれ以降) は、以前よりも詳細な (SEO に適した) アンカーを生成します。
バージョン。 したがって、以前のバージョンで生成されたアンカーは、バージョン 3.10 と一致しません。
アンカー。

· hypertoc のバージョン 3.00 (およびそれ以降) は、hypertoc のバージョン 2.x とは多少異なる動作をします。
ハイパートック。 XNUMX 回のパスですべてを実行するように設計されており、特定の機能が低下しています。
オプション: --infile オプションは使用されなくなりました (すべてのファイル名は
コマンド）; --toc_file オプションはなくなりました。 --outfile オプションを使用する
代わりは; --tocmap オプションはサポートされなくなりました。

大文字のタグではなく小文字のタグを生成するようになりました。

· hypertoc はあまり効率的ではありません (メモリと速度)。
ドキュメント。

· アンカーと ToC の生成が XNUMX 回のパスで行われるようになったため、さらに多くのメモリが使用可能になりました
以前より使われています。 これは、複数を処理する場合により顕著です
すべてのファイルは処理前にメモリに読み込まれるためです。

· 重要な要素が内部に含まれている場合、無効なマークアップが生成されます。
アンカー。 例えば：

FOO コマンド

(h1 が重要な要素の場合) に変換されます。

FOOコマンド

アンカーをネストできないため、これは違法です。

アンカーする要素内にアンカー ステートメントを配置する方が適切なスタイルです。 にとって
たとえば、以下が推奨されます。

FOO コマンド

hypertoc は "foo" NAME を検出して使用します。

さらに良いのは、ID を使用することです。

FOO コマンド

· 引用符のない NAME 属性は認識されません。

onworks.net サービスを使用してオンラインで hypertocp を使用する