TXT2TAGS
2006年7月
名称
txt2tags - 文本格式化及转换工具
总览
txt2tags [选项]... [文件]...
描述
txt2tags 是一个用Python开发的GPL文本格式化及转换工具。
它以最小的开销将单一的文本文件转换为
HTML, XHTML, SGML, LaTeX, Lout,Man Page, MoinMoin, MagicPoint 及 PageMaker
格式的文档。
用户只要知道很少的txt2tags简单标记，编写纯文本文件即可。程序会做所有辛苦的工作，加入复杂的标签，并处理目标文档中的错误。
同一个文本文件可以转换为支持的任一目标格式，不用另外进行编辑。这也是txt2tags的目的: 单源，多目标。
请访问程序主页
http://txt2tags.sourceforge.net。
选项
- -C, --config-file
-
从外部文件中读入配置(效果同 %!includeconf)
- --css-sugar
-
在HTML 和 XHTML格式的目标文件中插入CSS-friendly标签
- --css-inside
-
在HTML 和 XHTML头部插入CSS文件内容
- --dump-config
-
打印找到的所有配置并退出
- --dump-source
-
查看文档源文件，源文件中includes命令包含的文件内容全部展开
- --encoding
-
指定目标文件的编码(utf-8, iso-8859-1, 等)
- --gui
-
调用Tk图形界面
- -h, --help
-
打印帮助信息并退出
- -H, --no-headers
-
不显示头部、标题和尾部信息
- --headers
-
显示头部、标题和尾部信息(默认 打开)
- -i, --infile=FILE
-
指定输入文件名 FILE ('-' 表示 标准输入)
- --mask-email
-
隐藏邮件地址(防止垃圾邮件地址收割器发现邮件地址)：x@y.z 转换为 <x (a) y z>
- -n, --enum-title
-
对所有标题行进行编号：1, 1.1, 1.1.1, 等
- --no-dump-config
-
清除所有的配置
- --no-dump-source
-
清除所有的源
- --no-encoding
-
去掉编码设置
- --no-enum-title
-
关闭标题自动编号效果
- --no-infile
-
去掉所有预设的infile声明
- --no-mask-email
-
不隐藏邮件地址，关闭 --mask-email 选项
- --no-outfile
-
去掉预设的 outfile 声明
- --no-quiet
-
显示信息，关闭 --quiet 选项
- --no-rc
-
不使用用户配置文档：~/.txt2tagsrc
- --no-style
-
去掉文件样式设置
- --no-toc
-
目标文件中不加目录
- --no-toc-only
-
关闭 --toc-only 选项
- -o, --outfile=FILE
-
设置输出文件名为 FILE ('-' 是 标准输出)
- -q, --quiet
-
安静模式，除了出错的信息其他都不显示
- --rc
-
使用用户配置文档：~/.txt2tagsrc (默认 打开)
- --style=FILE
-
指定 FILE 作为文件样式表 (类似 Html CSS)
- -t, --target
-
指定目标文件类型。目前支持：
html, xhtml, sgml, tex, lout, man, mgp, moin, pm6, txt
- --toc
-
生成目标文件时加目录
- --toc-level=N
-
显示的最大目录层次设为 N
- --toc-only
-
打印文档目录并退出
- -v, --verbose
-
文件转换时显示详细的信息
- -V, --version
-
打印程序版本并退出
默认情况下，转换生成的文件以'file.<type>'保存。使用 --outfile 可以强制指定输出文件名。如果输入文件置'-'，则从标准输入中读入；如果输出文件置'-'，则输出到标准输出。
结构
Txt2tags的源文件可以包含以下三个部分：
- 头部
-
头三行。用于文档声明。
如果不需要指定头部信息，则放空或指定
no-header选项。
- 设置
-
从第四行开始。所有设置的格式均为%!keyword: value。
也可以在配置文件或命令行中进行设置。
- 主体
-
真正的文档源！只要有这部分内容就是一个可用的 txt2tags 文件。
设置
源文件转换的定制有两种方法。一种是采用外部的配置文件，比如RC文件(~/.txt2tagsrc) 或 用户指定的其它文件。另一种是在源文件内部使用设置选项直接进行配置。两种方法采用同样的语法。
- %!target:
-
设置输出文件格式
- %!options(target):
-
设置输出文件的一些选项
- %!include: file.t2t
-
把一个 txt2tags 文件内容作为t2t内容的一部分加入源文件
- %!include: ``file.txt``
-
把一个文本文件的内容作为原文引用块加入源文件
- %!include: ''file.html''
-
把一个文件字面上所有内容加到目标文件中
- %!style:
-
为XHTML和HTML格式的目标文件设置CSS级联样式表
或
为TEX格式的目标文件导入 \usepackage 模块
- %!encoding:
-
设置字符集(例如 iso-8859-1) 解决国际化问题
- %!includeconf:
-
把一个外部的文件内容作为当前源文件的配置
- %!guicolors:
-
设置Tk图形界面的颜色
- %!preproc:
-
用户定制的宏，在文本解析之前被执行
- %!postproc:
-
用户定制的宏，在文本解析之后被执行
设置规则
- 设置只在文档中配置部分才起作用，在文档的主体部分则被视为普通的注释行。唯一的例外是include命令，它在主体部分仍可用。
- 如果在文档中的配置部分出现多个相同关键词的配置，那么只有最后一个起作用。有三个例外：options, preproc 和postproc，它们的选项是累加的。
- 如果设置行里的关键词不是可用的，则将此行视为普通的注释行。
- 这些设置的优先级高于txt2tagsrc文件，但低于命令行选项。
语法
只需在纯文本文件中使用非常简单的标记语法来定义文档结构及格式。
下面是全部标记列表：
基础
头部 源文件的头三行
标题 = 文字 =
带数字编号的标题 + 文字 +
段落 文字
美化
粗体 **文字**
斜体 //文字//
下划线 __文字__
等宽 ``文字``
文本块
引用 <TAB>文字
列表 - 条目
带编号的列表 + 条目
定义式列表 : 条目
完全引用行 ``` 内容
完全引用域 ```<LineBreak> 内容 <LineBreak>```
原文行 """ 内容
原文域 """<LineBreak> 内容 <LineBreak>"""
表格 | 单元1 | 单元2 | 单元3...
其他
水平线 -----------------------...
粗水平线 =======================...
链接 [标签 url地址]
图像 [filename.jpg]
原始文字 ""内容""
注释 % 注释内容
请阅读Txt2tags User Guide(在程序文档目录下) 获得每个标记的详细说明。
例子
假设你已经写了一个带标记的file.t2t文件，现在我们开始进行转换。
- 转换为HTML文件，文件名为 file.html
-
$ txt2tags -t html file.t2t
- 同上，使用重定向
-
$ txt2tags -t html -o - file.t2t > file.html
- 包含目录
-
$ txt2tags -t html --toc file.t2t
- 包含目录，且对每个条目进行编号
-
$ txt2tags -t html --toc --enum-title file.t2t
- 快速浏览目录
-
$ txt2tags --toc-only file.t2t
- 从标准输入读入一行进行快速测试
-
$ (echo ; echo "**bold**") | txt2tags -t html -H -
宏
- %%date
-
用于显示当前日期，默认格式为YYYYMMDD(年月日)。
格式是可调的，调整时使用的语法：%%date(format-string)
- %%infile
-
用于得到源文件的信息。
格式是可调的，调整时使用的语法：%%infile(format-string)
有用的例子：使用尾部链接[查看源文件 %%infile]， 文件名被改掉的话链接也会自动更新。
- %%mtime
-
用于得到源文件的最近修改时间。与%%date宏使用相同的格式。
- %%outfile
-
用于得到目标文件的信息。
格式是可调的，调整时使用的语法：%%outfile(format-string)
有用的例子：使用引用自身的链接"This is the manpage.html file"，文件名改掉的话链接也会自动更新。
- %%toc
-
%%toc宏指定目录在文档中存放的未知。你想把它放在文档中哪个位置都可以。
注意: %%toc宏只有在设置了--toc选项的情况下才会被展开。
作者
程序由 Aurelio Marinho Jargas <<verde (a) aurelio net>> 编写并维护。
此手册页原始文本由Jose Inacio Coelho <<jic (a) technologist com>> 编写，使用txt2tags转换为man格式。
中文版由 Abby Pan <<abbypan (a) mail ustc edu cn>>翻译。
版权
Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006 Aurelio Marinho Jargas
This is free software; see the source for copying conditions. There is
NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.