dtplite - 云端在线

程序：

您的姓名

dtplite - 轻量级 DocTools 标记处理器

概要

点点滴滴 -o 产量 ？选项？ 格式 输入文件

点点滴滴 验证 输入文件

点点滴滴 -o 产量 ？选项？ 格式 输入目录

点点滴滴 -合并 -o 产量 ？选项？ 格式 输入目录

_________________________________________________________________________________________________

商品描述

本文件所描述的应用程序， 点点滴滴，是极品的继承者
简单 扩展. 受其功能影响 DTP doctools 处理器很多
比 扩展，但仍然易于使用； 绝对比 DTP 其
无数的子命令和选项。

点点滴滴 基于包 文档工具，就像其他两个处理器一样。

用途 機箱
点点滴滴 编写时考虑了以下三个用例。

[1] 验证单个文档，即检查它是否以有效的方式编写
文档工具格式。 此模式也可用于获得初步版本的
单个文档的格式化输出，用于在浏览器、nroff 等中显示，
允许校对格式。

[2] 为单个包生成格式化文档，即所有
联机帮助页，以及目录和关键字索引。

[3] 前一种操作方式的扩展，一种易于生成的方法
多个包的一个文档树，尤其是一个统一的表
内容和关键字索引。

除了上述之外，我们还想利用由
HTML 格式化程序。 它不是应用程序应该能够生成的唯一格式，而是
我们预计它是最常用的，它是为数不多的提供
自定义挂钩。

我们允许调用者指定页眉字符串、页脚字符串、样式表和数据
生成的文档顶部的导航链接栏。 虽然都可以设置为
只要格式化引擎提供了适当的引擎参数（请参阅部分
配置) 最后两个有内部处理，使它们特定于 HTML。

指挥 LINE
点点滴滴 -o 产量 ？选项？ 格式 输入文件
这是用例 [1] 的形式。 这 选项 稍后会在章节中解释
配置.

径 产量 （在）
此参数指定在哪里写入生成的文档。 它可以是
文件或目录的路径，或 -. 最后一个值导致应用程序
将生成的文档写入 标准输出.

如果 产量 不存在则 [file dirname $output] 必须存在并且
必须是可写目录。 生成的文档将被写入
该目录中的文件，该文件的名称将从
输入文件， 格式，以及赋予选项的值 -分机 （如果有）。

（路径|句柄） 格式 （在）
此参数指定在处理
输入，从而生成文档的格式。 见部分 FORMATS
对于应用程序识别的可能性。

径 输入文件 （在）
此参数指定要处理的文件的路径。 它必须存在，
必须是可读的，并写在 文档工具 格式。

点点滴滴 验证 输入文件
这是用例 [1] 的一种更简单的形式。 “validate”格式不产生输出
根本就只执行语法检查。 因此，输出的规范
file 或其他选项不是必需的并且被排除在外。

点点滴滴 -o 产量 ？选项？ 格式 输入目录
这是用例 [2] 的形式。 它与用例 [1] 的形式的不同之处在于
通过目录而不是文件指定输入文档。 这
其他参数是相同的，除了 产量，现在必须是通往
一个现有的可写目录。

输入文件是所有文件在 输入目录 或其任何子目录
被认可的 文件工具::文件类型 作为包含文本 文档工具 格式。

点点滴滴 -合并 -o 产量 ？选项？ 格式 输入目录
这是用例 [3] 的形式。 与用例形式的唯一区别 [2]
是附加选项 -合并.

每个这样的调用都会合并来自处理输入的生成文档
下的文件 输入目录 或其任何子目录下的文件
产量. 通过这种方式，可以逐步构建统一的
任何数量的包的文档。 注意需要跑通
所有包两次以获得完全正确的交叉引用（对于格式
支持他们）。

配置
本节描述了应用程序用户可用的所有选项，包括
选项的例外 -o 和 -合并. 这两个已经在部分中描述过
指挥 LINE.

-排除 绳子
此选项指定排除 (glob) 模式。 任何标识为联机帮助页的文件
忽略与排除模式匹配的处理。 可以提供该选项
多次，每次使用都会向排除列表添加一个额外的模式。

-分机 绳子
如果输出文件的名称必须从输入文件的名称派生
将使用名称 格式 作为默认扩展名。 这里的这个选项将
然而，覆盖它，强制它使用 绳子 作为文件扩展名。 这个选项
如果通过选项完全指定输出文件的名称，则忽略 -o.

当多次使用时，只有最后一个定义是相关的。

-标题 文件
如果且仅当所选的时，则可以使用此选项 格式 提供引擎
名为“标题”的参数。 它获取指定文件的内容并分配
无论引擎使用什么，它们都设置为该参数。 HTML 引擎将插入
标签后的文本 . 如果存在导航按钮（请参阅选项
-导航 下面），然后为它们生成的 HTML 附加到标题数据
在对参数的最终分配之前起源于此处。

当多次使用时，只有最后一个定义是相关的。

-页脚 文件
喜欢 -标题，除了：任何导航按钮都被忽略，相应的
必需的引擎参数命名为“footer”，并且数据就在之前插入
标签 .

当多次使用时，只有最后一个定义是相关的。

风格 文件
如果且仅当所选的时，则可以使用此选项 格式 提供引擎
名为“meta”的参数。 指定后会生成一段 HTML 代码
宣布 文件 作为生成文档的样式表并将其分配给
参数。 HTML 引擎将把这个插入到文档中，就在
行李牌 .

处理输入目录时，样式表文件被复制到输出中
目录和生成的 HTML 将引用副本，以使结果更
自成一体。 处理输入文件时，我们没有位置可以复制
样式表，因此只需按照指定的方式引用它。

当多次使用时，只有最后一个定义是相关的。

-toc 径
此选项指定用于目录的 doctoc 文件而不是
生成我们自己的。

当多次使用时，只有最后一个定义是相关的。

-pre+目录 标签路径|文本

-post+目录 标签路径|文本
此选项指定要在导航中使用的其他 dococ 文件（或文本）
酒吧。

多种用途的定位和处理就像选项 -prenav 和 -邮政导航,
见下文。

-导航 标签网址

-prenav 标签网址
使用此选项指定一个导航按钮 标签 显示和 网址 至
链接到。 This option can be used if and only if the selected 格式 提供了一个
名为“header”的引擎参数。 为此生成的 HTML 附加到
我们从选项中获得的任何数据 -标题 在它被插入到生成的之前
文档。

多次使用时，会收集所有定义并显示导航栏
已创建，第一个定义显示在左边缘，最后一个定义显示
在右边。

url 可以是相对的。 在这种情况下，它被假定为相对于主要
文件（目录和关键字索引），并将被转换为所有其他文件仍然链接
正常。

-邮政导航 标签网址
使用此选项指定一个导航按钮 标签 显示和 网址 至
链接到。 This option can be used if and only if the selected 格式 提供了一个
名为“header”的引擎参数。 为此生成的 HTML 附加到
我们从选项中获得的任何数据 -标题 在它被插入到生成的之前
文档。

多次使用时，会收集所有定义并显示导航栏
已创建，最后一个定义显示在右边缘，第一个定义显示
到左边。

url 可以是相对的。 在这种情况下，它被假定为相对于主要
文件（目录和关键字索引），并将被转换为所有其他文件仍然链接
正常。

FORMATS
首先 格式 参数将被视为包含代码的 tcl 文件的路径
对于请求的格式化引擎。 该参数将被视为其中之一的名称
下面列出的预定义格式当且仅当路径不存在时。

备注 a 局限性: 如果将格式视为实现 tcl 脚本的路径
引擎是成功的，那么这个脚本不仅要实现引擎 API
文档工具，即 文档工具_api， 但对于 dococ_api 和 docidx_api 以及。 否则
目录和关键字索引的生成将失败。

预定义格式列表，即由包提供 文档工具:

恩罗夫 处理器生成 *roff 输出，这是 unix 联机帮助页的标准格式。

HTML 处理器生成 HTML 输出，供 Web 浏览器使用和显示。 这个
发动机是目前唯一提供所需各种发动机参数的发动机
用于输出的额外定制。

微信 处理器生成 TMML 输出，Tcl 手册页标记语言，衍生的
的 XML。

胶乳 处理器生成 LaTeX 输出。

维基 处理器生成 Wiki 标记，如理解的那样 维基.

名单 处理器提取由提供的信息 联机帮助页_开始. 这种格式是
在内部用于提取元数据，目录和
关键字索引来源于。

空 处理器不产生任何输出。 这相当于 验证.

目录 结构
在本节中，我们将描述应用程序生成的目录结构
产量 在处理所有文档时 输入目录. 换句话说，这只是
与用例 [2] 和 [3] 相关。

[2] 处理单组输入时创建如下目录结构
文件。 使用的文件扩展名用于 HTML 输出，但这无关紧要
到结构，只是用来拥有正确的文件名。

输出/
目录.html
index.html的
文件/
路径/到/FOO.html

示例中的最后一行显示了为位于以下位置的文件 FOO 生成的文档

输入目录/路径/到/FOO

[3] 将多个包合并成一个统一的文档集时生成的目录
结构有点深：

产量
.toc
.idx
.tocdoc
.idx文档
.xrf文件
目录.html
index.html的
FOO1/
...
FOO2/
目录.html
文件/
路径/到/BAR.html

每个目录 FOO1, ... 包含为包生成的文档
FOO1, ... 并遵循用例 [2] 所示的结构。 唯一的例外是
没有每个包的索引。

文件 ”.toc“”.idx“和”.xrf文件" 包含整体的内部状态
输出并将在下一次调用时读取和更新。 他们的内容不会
被记录在案。 当输出所需的所有包都已被删除时删除这些文件
处理，即输出完成时。

文件 ”.tocdoc“和”.idx文档", 是 dococ 和 docidx 中的中间文件
分别包含主目录和关键字索引的标记
转换为所选输出格式之前的文档集。 他们是
留在原地，即不删除，作为doctoc和docidx的演示
标记。

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