stx2any - 云端在线

程序：

您的姓名

stx2any - 从结构化文本到多种格式的转换器

概要

stx2any [-T 格式 [ STX 和 m4 选项 [ 文件 文件 ...]

商品描述

stx2any 将结构化文本 (Stx) 格式的文件转换为其他格式。 格式
目前实现的有 HTML、man、原始文本、PostScript、LaTeX、XHTML 和 DocBook XML。

源格式，结构化文本，是一种带有标准标记的纯文本格式
用于表示标题、列表、强调等。标记编写起来更快，而且
比传统的基于标签的标记语言更容易记住，而且美观
源代码形式也清晰易读。 Stx 标记更好地解释在 STX 匆匆 指南，这
可以在示例目录中找到。

大部分转换发生在 m4 中，您可以定义自己的宏和其他内容
为您的文档提供结构。 stx2any 提供了类似 LaTeX 的可扩展
环境系统和用于重新安排输入的转移系统。 （Tårta på tårta，因为他们
用瑞典语说。）

因为 stx2any 不对输入执行任何类型的引用，所以标记不是
available 可以直接用目标语言编写（失去了到
多种语言）。 这样，如果您只对一种输出格式感兴趣（例如
LaTeX），您可以使用 Stx 作为最常见结构的缩写格式。

有些格式不能作为缩写使用，而是通过调用 m4 宏来使用。 你需要
宏相对较少：例如，浮动（可以在周围“漂浮”的材料）
文件）由宏创建。

配置

stx2any 接受 m4 的所有命令行选项，直接传递它们。 其中，
-D 参数非常重要，需要在这里单独提及。

-DNAME=值
定义宏 NAME 以具有扩展 VALUE。 这可以让你通过
从命令行将信息写入文档。

-T 格式
设置输出格式。 默认格式为 html。 格式 应该是以下之一：

html 生成基本的 HTML（超文本标记语言）输出。

man 产生 man 宏输出。 此输出可直接用作手册页
（尽管请参阅下面的编写手册页），或者可以将其输入 troff / groff
格式化为例如后记。

Latex 产生 LaTeX 文档准备语言输出。 你可以运行乳胶
结果可以生成例如高质量的 pdf 文件。

text 通过使用 w3m 对 HTML 输出进行后处理来生成原始文本输出。 这
生成的输出非常基本，就像剥离大多数 Stx 标记一样； 如果你
想要更多格式化的输出，请考虑将 man 输出管道传输到 nroff -man。

ps 通过使用 groff 对 man 输出进行后处理来生成简单的 postscript 输出。
如果您想进行真正的发布，请考虑使用 LaTeX 格式。

xhtml 通过使用 W3C tidy 对 HTML 输出进行后处理来生成 XHTML 输出。 由
方式，检查 http://hixie.ch/advocacy/xhtml 有关 HTML 的讨论和
XHTML。

文档-xml
生成基本的 DocBook XML 输出。 请参阅下面的错误以获取更多讨论
对这个。

--链接缩写
使用链接缩写语法。 请注意，因为链接缩写
处理分两个阶段进行，当输入到来时它并不完全工作
来自标准输入（例如，如果您使用 stx2any 作为 a 的中间部分
管道）。

- 引用
请求引用以下字符（下划线和美元符号除外）
所请求的输出格式有点神奇。 这将使它相当
很难将输出格式的标记直接放入文档中，但会
大大增加了您的文档正确的可能性（即
输出格式中没有语法错误）。

--更努力地引用我的话
请求引用下划线和美元符号。 这可能会使一些 LaTeX
文档可以工作，但可能会破坏某些使用下划线的文档
宏定义中的宏名称或美元符号。

--编号 { 上 | 离开 }
请求对章节标题进行编号。 默认值因输出格式而异：
默认情况下，章节编号对于 HTML、DocBook XML 和 man 是关闭的，对于 LaTeX 是打开的。

--table-of-contents { 上 | 离开 }
请求根据标题生成目录。 默认是
编号打开时生成目录。 未针对 DocBook XML 实现。

--make-title { 上 | 离开 }
请求“扉页”。 默认为“打开”。 这个设置没有任何
某些格式的效果。 在 HTML 中，它会在开头生成一个大标题
该文件。 在 LaTeX 中，它生成规范的 maketitle。

--无模板
根本不生成文档模板，仅生成格式化的输入文本。 你
如果您的文档将作为更大的文档的一部分包含在内，则可能需要此文件
文档。 然而，如果那个更大的文档完全用 Stx 编写，那么它将
更干净的方式是直接将所有源文件作为 stx2any 的参数
而不是之后合并结果。

--对称交叉引用
在支持链接的文档格式（HTML、DocBook）中，生成反向链接
从标签到引荐来源网址以及从引荐来源网址到标签的链接。

--latex-参数 的params
设置 LaTeX 文档的文档类参数。 默认值受影响
按系统纸张尺寸； 例如，在欧洲系统上，通常是
a4纸，无扉页。 （参见下面的“环境”。）

--html-params 的params
设置 HTML 文档的正文标记参数。 默认是没有参数。

--图片后缀 后缀
内联图像将引用带有后缀的文件 后缀。 默认为 png
HTML 和 DocBook，LaTeX 的 eps 和 man。

--没有破折号分开
在输出中，请勿使用空格将破折号与相邻文本分隔开。 这是
按照传统的英文排版（如果我理解正确的话），但是
在许多其他语言中并不标准——包括我的母语芬兰语。

- 更安全
禁用 m4 的一些不安全功能并检查一些命令行参数
被传递到 shell 来查找有问题的字符。 如果这可能是可取的
您从其他地方收到了该文档并希望确保它不会
转换后做任何恶意的事情。 目前这拒绝执行 shell
逃脱。

请注意，显然 m4 的实现没有在设计时考虑到安全性
头脑。 因此，此选项无法防止所有潜在有害的情况
事物。 据我所知，未阻止的事情包括以下内容
输出中的任意文件并写入繁忙循环（以便转换
将使用它可以获得的所有处理器时间，直到终止）。

--sed-预处理器 脚本名
运行 sed 脚本 脚本名 对于所有输入。 这允许您添加自定义
缩写标记。 它与使用 sed 预处理输入几乎相同，
然后通过管道将其输入 stx2any，但与 --link-abbrevs 交互效果更好（请参阅其
详细解释）。

--版本，-V
只需显示版本信息并退出即可。

- 帮助， -？
只需显示一个简短的帮助信息并退出。

写作 男装 PAGES

基本上，手册页只是 man 宏格式的文件。 然而，有一些
要求部分手册页位于特定位置的程序（首先是 mandb）
格式，并且手册页通常应遵循标准的分段和形式（参见 man
(1) 和 lexgrog (1) 了解详情）。

编写手册页时，页面的标题 (w_title) 应该是
程序/文件/格式/实用程序名称，并且您应该定义部分（w_section）。 使
适合 mandb 解析的页面，您应该通过一次或多次调用来启动该页面
w_man_desc。 这将为您创建一个正确的“NAME”部分。 （虽然你可以写
一个人一个。）

诊断

stx2any 可能会给出 m4 可能给出的任何错误消息，例如格式错误的输入（宏
调用缺少右括号等）。 此外，它还有以下错误
消息：

未知的输出格式：“X”
您请求的输出格式不受支持 X 使用 -T 选项。

未知的宏“X”被调用
stx2any 遇到以 w_ 开头的宏，但不知道它的定义。
这是一个警告，而不是一个错误——有问题的宏及其参数是
从输出中剥离。

N 层中的环境“X”被“Y”封闭
stx2any 中的环境必须正确嵌套。 stx2any遇到w_end(Y)
当它期待 w_end(X）。 这通常是被遗忘的 w_end(X).

If N （层）不是 0，那么问题可能出在你的
环境定义，不是在 stx2any 处理时
遇到错误。

未知环境“X”
尝试启动一个 stx2any 未知名称的环境，
即没有定义这样的环境。

分流“X”被“Y”关闭

未知转移“X”
与上面相同，但用于转移（w_begdiv 和 w_enddiv）。

尝试在安全环境中使用“X”
您请求使用 --more-secure 进行安全处理，并且该文档包含
“不安全”的宏观。 这是一条警告消息，而不是错误 - 导致宏
逐字留在文本中。

与“X”的未知交叉链接
存在文档的交叉链接 X，但 stx2any 不知道这样的
文档。 可能您没有使用gather_stx_titles收集/X/的数据，或者您
文档参考拼写错误。 这是警告，不是错误 —
引用逐字保留在输出中，没有任何类型的链接。

stx2any 成功时返回值为零，如果出现问题则返回值 XNUMX。

环境

纸面会议

纸张尺寸
用于确定 LaTeX 文档的默认纸张尺寸。

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