hypertocp - 云端在线

程序：

您的姓名

hypertoc - 为 HTML 文档生成目录

VERSION

3.20版

概要

hypertoc --help | --手册页 | --man_help | - 男人

hypertoc [--bak 绳子 ] [ --debug ] [ --entrysep 绳子 ] [ --页脚 文件 ] [ --标题
文件 ] [ --ignore_only_one ] [ --ignore_sole_first ] [ --inline ] [ --make_anchors ] [
--make_toc] [ --notoc_match 绳子 ] [--ol | --nool ] [ --ol_num_levels ] [ --outfile
文件 ] [ --overwrite ] [ --quiet ] [ --textonly ] [ --title 绳子 ] { --toc_after
标签=后缀 } { --toc_之前 标签=前缀 } { --toc_end 标签=结束标签 } { --toc_entry 标签=级别
} [--toc_标签 绳子 ] [--toc_only | --notoc_only] [ --toc_tag 绳子 [
--toc_tag_replace ] [ --use_id ] [ --useorg ] 文件...

商品描述

hypertoc 允许您指定将被超链接到的“重要元素”
给定 HTML 文档集的“目录”(ToC)。

基本上，生成的 ToC 是一个多级列表，其中包含指向
重要元素。 hypertoc 将链接插入到 ToC 中的重要元素
用户指定的级别。

示例：

如果 H1 被指定为级别 1，则它们会出现在 ToC 的第一级列表中。 如果
H2 被指定为第 2 级，而不是它们出现在 ToC 的第二级列表中。

ToC 生成有两个方面：(1) 将合适的锚点放入 HTML
文档（--make_anchors），以及（2）从具有
在其中锚定 ToC 以链接到 (--make_toc)。 可以选择做一项或两项
这些。

hypertoc 还支持将 ToC 合并到 HTML 文档本身的能力
通过 --inline 选项。

为了让 hypertoc 支持链接到重要元素，hypertoc 插入了锚点
进入重要元素。 可以使用 hypertoc 作为过滤器，将结果输出到
另一个文件，或者可以覆盖原始文件，原始文件用
后缀（默认：“org”）附加到文件名。

还可以在配置文件和命令行中定义选项。

配置

选项可以以“--”或“-”开头； 布尔选项可以通过在它们前面加上
“不”; 可以通过再次提供选项来添加具有散列或数组值的选项
每个值。

有关更多信息，请参阅 Getopt::Long。

--arg文件 文件名
要从中读取更多选项的文件名。 这可以多次使用。 为了
例：

--argfile 你的.args --argfile 我的.args

有关详细信息，请参阅“选项文件”。

--巴克
--巴克 绳子

如果输入文件/文件正在被覆盖（--overwrite 已打开），请复制
原始文件到“文件名.绳子". 如果值为空，则没有备份文件
书面。 （默认：组织）

-调试
启用详细调试输出。 用于调试本模块； 换句话说，
别打扰。 （默认：关闭）

--entrysep
--entrysep 绳子

非分隔符字符串项目条目（默认：“，”）

--页脚
--页脚 文件

包含目录页脚文本的文件。

--标题
--标题 文件

包含目录标题文本的文件。

- 帮帮我
打印一条简短的帮助消息并退出。

--ignore_only_one
如果 ToC 中只有一项，请不要制作 ToC。

--ignore_sole_first
如果 ToC 中的第一项是最高级别，并且它是其中唯一的一项
水平，无视。 这在只有一个 H1 标题但有一个 HXNUMX 标题的网页中很有用
一个人事先不知道是否只有一个。

- 排队
将 ToC 放在文档中的给定点。 有关详细信息，请参阅“内联 ToC”。

--make_anchors | --make_anchors | --gen_anchors
为要链接到的目录创建锚点。

--make_toc | --gen_toc
制作一个链接到锚定重要元素的目录。

--man_help | --手册页 | - 男人
打印所有文档并退出。

--notoc_match
--notoc_match 绳子

如果您不希望将某些单独的标签包含在
内容，即使它们匹配“重要元素”，那么如果这个模式
匹配标签内的内容（不是正文），那么该标签将不会被包含在内，
无论是生成锚点还是生成 ToC。 （默认：class="notoc"）

--ol | --努尔
使用目录条目的有序列表（到给定的深度）。 如果 --ol 是
假（即 --nool 被设置）然后 别 对 ToC 条目使用有序列表。

（默认：假）

（请参阅 --ol_num_levels 以确定有序列表列表的深度）

--ol_num_levels
如果 --ol 为真，则 OL 列表的深度级别数。 如果设置为零，
将使用所有级别的有序列表。 （默认：1）

--输出文件
--输出文件 文件

将输出写入的文件。 这是修改后的 HTML 输出和 Table-of-
内容转到。 如果您将“-”作为文件名，则输出将转到 STDOUT。
（默认：标准输出）

--覆盖
用输出覆盖输入文件。 如果这有效，则忽略 --outfile。
用于 生成锚 用于创建“就地”锚点和 生成目录 if
--inline 选项有效。 （默认：关闭）

- 安静的
抑制信息性消息。 （默认：关闭）

- 纯文本
仅在重要元素中使用文本内容。

- 标题
- 标题 绳子

ToC 页面的标题（如果不使用 --header 或 --inline 或 --toc_only）（默认值：“表
内容”）

--toc_after
--toc_after 行李牌=后缀

--toc_after "H2="

用于定义 ToC 中重要元素的布局。 这 行李牌 是 HTML 标签
标记元素的开始。 这 后缀 是需要附加到
为该标签生成的目录条目。 这是一个累积散列参数。
（默认：未定义）

--toc_之前
--toc_之前 行李牌=字首

--toc_before "H2= "

用于定义 ToC 中重要元素的布局。 这 行李牌 是 HTML 标签
这标志着元素的开始。 这 字首 是什么需要预先
到为该标签生成的目录条目。 这是一个累积哈希
争论。 （默认：未定义）

--目录结束
--目录结束 行李牌=尾标

--toc_end "H1=/H1"

用于定义重要元素。 这 行李牌 是标记开始的 HTML 标记
元素。 这 尾标 标记元素结束的 HTML 标签。 什么时候
在输入文件中匹配，忽略大小写（但请确保您的所有 行李牌 选项
引用相同的标签完全相同！）。 这是一个累积散列参数。
（默认：H1=/H1 H2=/H2）

--目录条目
--目录条目 行李牌=水平

--toc_entry "标题=1" --toc_entry "H1=2"

用于定义重要元素。 这 行李牌 是标记开始的 HTML 标记
元素。 这 水平 是标签被认为是什么级别。 的价值 水平
必须是数字且非零。 如果值为负，则连续条目
由重要元素表示的将被设置的值分隔
--entrysep 选项。 这是一个累积散列参数。 （默认：H1=1 H2=2）

--toc_标签 | --toclabel
--目录标签 绳子

标记 ToC 的 HTML 文本。 一直使用。 （默认： ” 目录”）

--toc_only | --notoc_only
只输出目录，即目录加上toc_label。
如果有 --header 或 --footer，它们也会被输出。

如果--toc_only 为false（即--notoc_only 已设置），则如果没有--header，并且
--inline 不为真，则输出一个合适的 HTML 页面标题，如果有
no --footer 和 --inline 不正确，则将输出 HTML 页面页脚。
（默认：--notoc_only）

--目录标签
--目录标签 绳子

如果要内联包含 ToC，则这是用于匹配标签的模式
ToC 应该放在哪里。 这可以是开始标签、结束标签或注释，但
< 应该被排除在外； 也就是说，如果您希望将 ToC 放在 BODY 之后
标签，然后给出“BODY”。 如果你想要一个特殊的注释标签来制作 ToC 应该在哪里
去，然后包括注释标记，例如：“！--toc--”（默认：BODY）

--toc_tag_replace
结合--toc_tag，这是一个标志，表示给定的标签是否应该是
已替换，或者是否应将 ToC 放在标签之后。 如果您的
toc_tag 是一条注释，在您准备好 ToC 后就不需要它了。
（默认：假）

--use_id
使用 id="姓名" 用于锚点而不是姓名"> 锚点。但是如果一个锚点
已存在重要元素，这不会为该特定元素生成 ID
元件。

--useorg
使用预先存在的备份文件作为输入源； 也就是说，表格的文件
文件名.李明博 （见--bak）。

文件 FORMATS

附加选项 档
可以使用 --argfile 在文件和命令行中提供选项
文件名 命令行中的选项。 此外，文件 ~/.hypertocrc 和 ./.hypertocrc 是
检查选项。

格式如下： # 开头的行是注释。 包含在 PoD 中的行
标记也是注释。 空行被忽略。 选项本身应该是
鉴于它们在命令行上的方式，即选项名称（如： 此
--) 后跟它的值（如果有的话）。

例如：

# 设置ToC为三级
--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 条目
--toc_entry H1=1
--toc_end H1=/H1
--toc_before H1=
--toc_after H1=

# 制作第 2 级 ToC 条目
--toc_entry H2=2
--toc_end H2=/H2
--toc_before H2=
--toc_after H2=

# 按原样制作第 3 级条目
--toc_entry H3=3
--toc_end H3=/H3

例如： of 习俗 结束

以下选项尝试索引定义术语：

# 一个可用于 Glossary 类型文档的选项文件
--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。 这允许您在开始之前有介绍性文本或任何其他文本
到C。

请注意：
如果您使用 --header 选项，请确保指定的文件包含打开的 HTML
标签、HEAD 元素（包含 TITLE 元素）和开头的 BODY 标签。
但是，如果 --inline 选项，这些标签/元素不应该在头文件中
用来。 有关头文件应包含的内容的信息，请参阅“内联 ToC”
用于内联 ToC。

使用 --toc_label 选项，给定字符串的内容将放在
生成的 ToC（但在从 --header 文件中提取的任何文本之后）。

使用 --footer 选项，文件的内容将被附加到生成的
到C。

请注意：
如果您使用 -footer，请确保它包含结束 BODY 和 HTML 标记（除非，
当然，您正在使用 --inline 选项）。

如果未指定 --header 选项，则适当的起始 HTML 标记将是
添加，除非指定了 --toc_only 选项。 如果 --footer 选项不是
指定，将添加适当的结束 HTML 标记，除非 --toc_only 选项
已指定。

如果您不想/不需要处理页眉、页脚、文件，那么您可以
指定 ToC 文件的标题，--title 选项； 它允许您指定一个
标题或标签，放在 ToC 条目列表之前，--toc_label 选项。 两种选择
有默认值，有关每个选项的更多信息，请参阅“选项”。

如果您不想提供 HTML 页面标签，而只想提供 ToC 本身，那么
指定 --toc_only 选项。 如果没有 --header 或 --footer 文件，那么这将
只需输出 --toc_label 的内容和 ToC 本身。

内联 此 变革理论
通过以下方式支持将 ToC 直接合并到 HTML 文档中的能力
--内联选项。

内联将在处理的文件列表中的第一个文件上完成，并且只会
如果该文件包含与 --toc_tag 值匹配的开始标记，则完成。

如果 --overwrite 为真，则列表中的第一个文件将被覆盖，
生成的 ToC 插入到适当的位置。 否则是第一个的修改版本
file 输出到 STDOUT 或由 --outfile 选项定义的输出文件。

选项 --toc_tag 和 --toc_tag_replace 用于确定 ToC 的位置和方式
插入到输出中。

例如： 1

# 这是默认值
--toc_tag 主体 --notoc_tag_replace

这会将生成的 ToC 放在第一个文件的 BODY 标签之后。 如果 --header
指定选项，则在BODY之后插入指定文件的内容
标签。 如果 --toc_label 选项不为空，则 --toc_label 指定的文本
选项被插入。 然后插入 ToC，最后，如果 --footer 选项是
指定，它插入页脚。 然后输入文件的其余部分如下
过。

例如： 2

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

这会将生成的 ToC 放在表单的第一个注释之后， 然后
注释将被 ToC 替换（按顺序
--标题
--目录标签
变革理论
--footer) 后跟输入文件的其余部分。

请注意：
头文件不应包含开始的 HTML 标记和 HEAD 元素，因为
正在处理的 HTML 文件应该已经包含这些标签/元素。

示例

创建 an 一致 变革理论 一种 文件
hypertoc --inline --make_anchors --overwrite --make_toc index.html

这将在“index.html”中创建锚点，创建一个标题为“Table of
Contents”并将其放在“index.html”的BODY标签之后。文件index.html.org将
包含原始 index.html 文件，没有 ToC 或锚点。

创建 a 变革理论 文件 止 多 档
首先，创建锚点。

hypertoc --make_anchors --覆盖index.html fred.html george.html

然后创建 ToC

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

创建 an 一致 变革理论 after 此 第一 标题 of 此 第一 文件
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”文件中创建锚点，创建
一个没有标题的 ToC 并将其放在“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

这将创建一个内联 ToC 覆盖原始文件，并替换一个
注释，并将 H2 标头作为级别 1，将 H3 标头作为级别 2。这可以是
在 .html 文件由其他进程生成的情况下很有用，然后您可以创建
ToC 作为最后一步。

创建 a 变革理论 习俗 分子
hypertoc --quiet --make_anchors --bak "" --overwrite \
--toc_entry 标题=1 --toc_end 标题=/标题
--toc_entry H2=2 --toc_entry H3=3 \
--toc_end H2=/H2 --toc_end H3=/H3 \
--make_toc --outfile index.html \
mary.html fred.html 乔治.html

这会在 H2 和 H3 元素上创建锚点，并创建一个名为 index.html 的 ToC 文件，
在 TITLE 以及 H2 和 H3 元素上建立索引。

创建 a 变革理论 习俗 分子 和 选项 文件
给定一个名为“custom.opt”的选项文件，如下所示：

# 标题，H2 和 H3
--toc_entry 标题=1
--toc_end 标题=/标题
--toc_entry H2=2
--toc_end H2=/H2
--toc_entry H3=3
--toc_end H3=/H3

那么前面的例子可以有更短的命令行，如下所示：

hypertoc --quiet --make_anchors --bak "" --overwrite \
--argfile custom.opt --make_toc --outfile index.html mary.html fred.html george.html

附注

· hypertoc 足够聪明，可以检测重要元素内的锚点。 如果锚
定义 NAME 属性，hypertoc 使用该值。 否则，它会添加自己的 NAME
归因于锚点。 如果 --use_id 为真，那么它同样会检查并使用
身份证件。

· 如果将 TITLE 元素指定为重要元素，则会对其进行特殊处理。 这是
将锚点 (A) 插入 TITLE 元素是非法的。 因此，hypertoc 实际上会
链接到文件名本身而不是文档的 TITLE 元素。

· 如果重要元素不包含任何非空格，hypertoc 将忽略它
人物。 如果存在这种情况，则会生成警告消息。

· 如果你有一个显着元素的序列，这些元素以轻微无序的方式变化
时尚，例如 H1 -> H3 -> H2 甚至 H2 -> H1，尽管 hypertoc 处理这个
创建一个仍然是好的 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. 我的第二个 H1 标题

在这种情况下，最好不要使用 --ol 选项。

· 如果生成anchors的时候没有使用--overwrite，那么这个命令需要
分两遍完成，以便给出正确的文件名（具有实际文件名的文件名）
锚定在其中）到 ToC 生成部分。 否则 ToC 将有锚点
指向没有它们的文件。

· 使用 --inline 时，需要注意是否覆盖 -- 如果将 ToC 设置为
被包含在给定的标签（例如默认的 BODY）之后，然后如果运行命令
重复一个可以在同一个文件中获得多个 ToC，一个接一个。

洞穴

· 3.10 版（及更高版本）生成比以前更详细的（对 SEO 友好的）锚点
版本。 因此，使用较早版本生成的锚点将与 3.10 版不匹配
锚。

· hypertoc 3.00 版（及更高版本）的行为与 2.x 版有些不同
海图。 它现在被设计为一次性完成所有事情，并且已经降低了某些
选项：不再使用 --infile 选项（所有文件名都放在末尾
命令）; --toc_file 选项不再存在； 使用 --outfile 选项
反而; 不再支持 --tocmap 选项。

它现在生成小写标记而不是大写标记。

· hypertoc 不是很有效（内存和速度），并且对于大的来说可能很慢
文档。

· 现在锚点和 ToC 的生成是一次性完成的，甚至更多的内存
使用比以前的情况。 这在处理多个
文件，因为所有文件在处理之前都被读入内存。

· 如果一个重要元素包含在一个
锚。 例如：

FOO 命令

将转换为（如果 h1 是重要元素），

该FOO命令

这是非法的，因为锚不能嵌套。

将锚语句放在要锚定的元素中是更好的风格。 为了
例如，以下是首选：

FOO 命令

hypertoc 将检测“foo”名称并使用它。

更好的是使用 ID：

FOO 命令

· 不识别不带引号的 NAME 属性。

使用 onworks.net 服务在线使用 hypertocp