Manpages

名 称

txt2tags − 文 本 格 式 化 及 转 换 工 具

总 览

txt2tags [选 项 ] [文 件 ...]

描 述

txt2tags 读 入 含 少 量 标 记 的 文 本 ， 并 将 其 转 换 为 多 种 格 式 的 文 档 ： ASCII Art, AsciiDoc, Creole, DocBook, DokuWiki, Google Code Wiki, HTML, LaTeX, Lout, MagicPoint, Man page, MoinMoin, PageMaker, Plain Text, PmWiki, SGML, Wikipedia 和 XHTML.

此 手 册 页 是 由 txt2tags转 换 一 个 示 例 文 本 文 件 生 成 。 并 且 该 示 例 文 本 文 件 同 时 被 转 换 成 HTML， 作 为 此 手 册 页 的 在 线 版 本 。

单 个 源 文 件 ， 多 种 格 式 的 目 标 文 件 − http://txt2tags.org

标 记

头 部 源 文 件 的 前 3行
标 题 = 文 字 =
带 数 字 编 号 的 标 题 + 文 字 +
注 释 % 注 释 内 容
隔 离 行 -----------------------...
粗 隔 离 行 =======================...
图 片 [filename.jpg]
链 接 [标 签 url地 址 ]

粗 体 **文 字 **
斜 体 //文 字 //
下 划 线 __文 字 __
删 除 线 --文 字 --
等 宽 ’’文 字 ’’
原 始 文 本 ""文 字 ""
标 记 文 本 ’’文 字 ’’

段 落 文 字
引 用 <TAB>文 字
列 表 - 文 字
带 编 号 的 列 表 + 文 字
定 义 式 列 表 : 文 字
表 格 | 单 元 格 1 | 单 元 格 2 | 单 元 格 3...

完 全 引 用 行 ’’’ 文 字
原 文 引 用 行 """ 文 字
标 记 引 用 行 ’’’ 文 字

完 全 引 用 块 ’’’
多 行 文 本
’’’
原 文 引 用 块 """
多 行 文 本
"""
标 记 引 用 块 ’’’
多 行 文 本
’’’

选 项

−−art−chars=PATTERN

定 义 PATTERN为 组 成 ASCII艺 术 字 的 字 符 模 板 ， 按 以 下 顺 序 指 定 ： 拐 角 ， 边 框 ， 侧 面 ， 一 级 块 ， 二 级 块 ， 二 级 水 平 线 ， 三 级 水 平 线 ， 四 级 水 平 线 ， 五 级 水 平 线 。 默 认 的 模 板 是 +−|−==−^"。 此 选 项 只 在 输 出 目 标 格 式 为 艺 术 ASCII时 可 用 。

−C, −−config−file=FILE

从 外 部 文 件 FILE中 读 入 配 置 。 配 置 项 格 式 为 %!关 键 字 :取 值 ， 详 情 请 见 配 置 小 节 。

−−css−sugar

优 化 生 成 的 嵌 入 CSS样 式 HTML/XHTML内 容 。 移 除 标 签 属 性 ， 禁 用 样 式 属 性 ， 头 部 内 容 由 H1、 H2和 H3组 成 ， 新 建 以 下 DIV： #header, #body, .toc。

−−css−inside

在 HTML/XHTML头 部 嵌 入 CSS文 件 的 内 容 。 使 用 −−style指 定 读 入 的 CSS文 件 。

−−dump−config

输 出 所 有 配 置 项 后 退 出 。

−−dump−source

输 出 文 档 源 文 件 ， 并 展 开 (%!include) 中 的 内 容 。

−−encoding=CODE

设 置 源 文 件 转 换 成 目 标 CODE时 采 用 的 字 符 集 。 例 如 UTF−8 and iso−8859−1。

−−gui

启 动 TK图 形 界 面 。

−h, −−help

输 出 帮 助 信 息 后 退 出 。

−H, −−no−headers

输 出 内 容 时 不 显 示 头 部 、 尾 部 信 息 ， 只 显 示 主 体 内 容 。

−−headers

输 出 内 容 时 显 示 头 部 、 尾 部 信 息 。 此 选 项 默 认 打 开 。

−−height=NUM

设 置 输 出 内 容 为 NUM行 。 此 选 项 只 在 目 标 文 档 格 式 为 艺 术 ASCII、 且 指 定 −−slides时 可 用 。

−i, −−infile=FILE

指 定 FILE为 输 入 的 源 文 件 名 。 如 果 指 定 为 ’−’， 则 从 STDIN读 入 源 文 本 。

−−mask−email

隐 藏 邮 件 地 址 ， 以 防 止 垃 圾 邮 件 地 址 收 割 。 移 除 @和 .。 邮 件 地 址 foo [AT] bar.com 被 转 换 为 <foo (a) bar com>。

−n, −−enum−title

对 所 有 标 题 行 进 行 自 动 编 号 。 显 示 的 前 缀 为 1, 1.1, 1.1.1, ...

−−no−dump−config

取 消 −−dump−config动 作 。

−−no−dump−source

取 消 −−dump−source动 作 。

−−no−encoding

清 除 encoding设 置 。

−−no−enum−title

关 闭 标 题 自 动 编 号 的 设 置 。

−−no−infile

清 除 之 前 所 有 infile的 声 明 。

−−no−targets

取 消 −−targets动 作 。

−−no−mask−email

关 闭 隐 藏 邮 件 地 址 的 特 性 。

−−no−outfile

清 除 之 前 所 有 outfile的 声 明 。

−−no−quiet

输 出 消 息 ， 关 闭 −−quiet选 项 。

−−no−rc

不 读 入 用 户 配 置 文 件 ~/.txt2tagsrc。

−−no−slides

关 闭 演 示 文 档 特 性 。

−−no−style

清 除 所 有 样 式 设 置 。

−−no−toc

不 输 出 目 录 。

−−no−toc−only

关 闭 −−toc−only动 作 。

−o, −−outfile=FILE

指 定 输 出 的 文 件 名 为 FILE。 指 定 ’−’则 将 结 果 输 出 到 STDOUT。

−q, −−quiet

安 静 模 式 。 关 闭 除 了 错 误 之 外 的 所 有 其 他 消 息 输 出 。

−−rc

读 入 用 户 配 置 文 件 ~/.txt2tagsrc。 此 选 项 默 认 打 开 。

−−slides

指 定 输 出 格 式 为 演 示 文 档 ， 此 选 项 只 在 输 出 目 标 格 式 为 艺 术 ASCII时 可 用 。

−−style=FILE

指 定 FILE作 为 目 标 文 档 的 样 式 文 件 。 用 于 指 定 HTML/XHTML文 档 使 用 的 CSS文 件 ， LaTeX文 档 使 用 的 样 式 包 。 此 选 项 可 以 多 次 使 用 ， 以 指 定 多 个 样 式 文 件 。

−t, −−target=TYPE

指 定 输 出 目 标 文 档 的 类 型 为 TYPE。 一 些 常 用 的 类 型 为 ： html, xhtml, tex, man, txt。 使 用 −−targets选 项 查 看 所 有 支 持 的 目 标 文 档 类 型 。

−−targets

输 出 所 有 可 用 的 目 标 文 档 类 型 后 退 出 。

−−toc

在 输 出 内 容 中 包 含 自 动 生 成 的 目 录 信 息 ， 置 于 头 部 内 容 和 主 体 内 容 之 间 。 也 可 以 通 过 ’%%TOC’’宏 显 示 指 定 目 录 输 出 位 置 。

−−toc−level=NUM

指 定 目 录 最 大 深 度 为 NUM。 所 有 比 NUM深 的 标 题 不 会 在 目 录 中 显 示 。

−−toc−only

输 出 目 录 后 退 出 。

−v, −−verbose

在 文 档 转 换 过 程 中 输 出 详 细 的 信 息 。 此 选 项 可 以 多 次 使 用 ， 以 提 高 输 出 的 消 息 量 。

−V, −−version

输 出 程 序 版 本 后 退 出 。

−−width=NUM

设 置 输 出 的 宽 度 为 NUM， 此 选 项 只 在 输 出 目 标 格 式 为 艺 术 ASCII时 可 用 。

源 文 件

源 文 件 扩 展 名 一 般 为 .t2t (例 如 myfile.t2t)。 可 以 在 以 下 三 个 区 域 指 定 源 文 件 ：
头 部 (可 选 )

源 文 件 的 前 三 行 。 如 果 不 需 要 头 部 信 息 ， 则 源 文 件 首 行 留 空 。 用 于 指 定 文 档 标 题 、 作 者 、 版 本 和 日 期 信 息 。

配 置 (可 选 )

紧 接 在 头 部 信 息 之 后 （ 第 4行 或 第 2行 ） ， 在 主 体 内 容 之 前 结 束 。 用 于 指 定 各 种 配 置 项 ， 格 式 为 %!关 键 字 :取 值 。

主 体

从 头 部 区 域 之 后 的 第 一 个 有 效 文 本 行 开 始 （ 非 注 释 或 配 置 ） ， 直 至 源 文 件 结 束 。 用 于 指 定 文 档 内 容 。

配 置

配 置 用 于 定 制 txt2tags， 与 选 项 类 似 。 配 置 项 可 以 在 源 文 件 的 配 置 区 域 ， ~/.txt2tagsrc文 件 ， −−config−file指 定 的 外 部 文 件 中 指 定 。
%!target

配 置 输 出 目 标 文 档 类 型 ， 功 能 与 −−target相 同 。 举 例 ：
%!target: html

%!options(target)

设 置 该 目 标 类 型 （ target） 文 档 的 默 认 选 项 。 必 须 以 命 令 行 的 形 式 调 用 。 举 例 ：
%!options(html): --toc --toc-level 3 --css-sugar

%!includeconf

指 定 读 入 外 部 文 件 中 包 含 的 配 置 项 ， 功 能 与 −−config−file相 同 。 举 例 ：
%!includeconf: myconfig.t2t

%!style

为 目 标 文 档 指 定 样 式 文 件 ， 功 能 与 −−style相 同 。 可 以 多 次 使 用 。 举 例 ：
%!style: colors.css

%!encoding

指 定 目 标 文 档 使 用 的 字 符 集 ， 功 能 与 −−encoding相 同 。 举 例 ：
%!encoding: UTF-8

%!preproc

指 定 查 找 /替 换 的 过 滤 器 ， 在 txt2tags解 析 源 文 档 之 前 ， 改 变 源 文 档 的 内 容 。 格 式 采 用 Python正 则 表 达 式 。 举 例 ：
%!preproc: "JJS" "John J. Smith"

%!postproc

指 定 查 找 /替 换 的 过 滤 器 ， 在 txt2tags转 换 源 文 档 之 后 ， 改 变 目 标 文 档 的 内 容 。 格 式 采 用 Python正 则 表 达 式 。 举 例 ：
%!postproc(html): "<B>" "<STRONG>"

如 果 同 一 个 关 键 字 多 次 出 现 ， 则 以 最 后 的 取 值 为 准 （ options, preproc and postproc是 累 计 的 除 外 ） 。 异 常 关 键 字 被 忽 略 。 解 析 顺 序 为 ： ~/.txt2tagsrc， 源 文 档 的 配 置 区 域 ， −−config−file命 令 行 选 项 。

指 令

指 令 在 文 本 转 换 过 程 中 生 效 。 指 令 必 须 在 源 文 件 主 体 内 容 中 指 定 。
%!csv: file.csv

读 入 一 个 外 部 的 CSV文 件 ， 作 为 表 格 。

%!include: file.t2t

读 入 一 个 txt2tags文 件 。

%!include: ’’file.txt’’

读 入 一 个 文 本 文 件 的 内 容 ， 作 为 源 文 件 的 “原 文 引 用 块 ”。

%!include: ’’file.html’’

读 入 一 个 标 签 文 件 内 容 到 目 标 文 档 。

宏

使 用 宏 很 容 易 在 文 档 中 插 入 动 态 内 容 。 宏 必 须 在 源 文 件 的 主 体 内 容 中 指 定 。 除 了 %%toc， 所 有 宏 都 能 够 用 修 饰 符 指 定 格 式 ， 例 如 %Y和 %f。 详 情 请 查 看 txt2tags用 户 指 南 。

%%date

插 入 当 前 日 期 。 默 认 格 式 是 %%date(%Y%m%d)， 输 出 YYYYMMDD。

%%infile

插 入 源 文 件 所 在 路 径 。 默 认 格 式 是 %%infile(%f)。 常 用 尾 部 链 接 举 例 ： [查 看 源 文 件 %%infile]。

%%mtime

插 入 源 文 件 修 改 时 间 。 默 认 格 式 是 %%date(%Y%m%d)， 输 出 YYYYMMDD。

%%outfile

输 出 目 标 文 档 所 在 路 径 。 默 认 格 式 是 %%outfile(%f)。 常 用 的 自 引 用 形 式 举 例 ： "这 是 manpage−zh.man 文 件 "。

%%toc

指 定 目 录 信 息 所 在 位 置 。 可 以 多 次 使 用 。 注 意 同 时 指 定 −−toc选 项 。

示 例

txt2tags −t html file.t2t

转 换 成 HTML， 将 转 换 的 结 果 输 出 到 文 件 file.html。

txt2tags −t html −o − file.t2t

转 换 成 HTML， 将 转 换 的 结 果 输 出 到 STDOUT。

txt2tags −t html −−toc file.t2t

转 换 成 HTML， 包 含 自 动 生 成 的 目 录 。

txt2tags −t html −−toc −−toc−level 2 −n file.t2t

转 换 成 HTML， 并 生 成 目 录 ， 目 录 深 度 为 2， 各 项 标 题 采 用 数 字 编 号 。

txt2tags −−toc−only file.t2t

只 输 出 目 录 ， 不 进 行 实 际 的 转 换 。

txt2tags −t html −−css−sugar −−style base.css −−style ui.css file.t2t

转 换 成 HTML， 并 预 先 设 置 采 用 CSS， 同 时 指 定 引 用 两 个 外 部 CSS文 件 。

txt2tags −t art −−slides −−width 80 −−height 25 −o − file.t2t | more

生 成 艺 术 ASCII演 示 文 档 ， 用 于 在 80x25的 屏 幕 或 窗 口 上 演 示 。

(echo ; echo "**bold**") | txt2tags −t html −H −

易 用 的 单 行 指 令 ， 从 STDIN读 取 内 容 做 快 速 的 测 试 。

txt2tags −t html −o − file.t2t | tidy > file.html

将 转 换 的 结 果 输 出 到 STDOUT， 然 后 调 用 外 部 程 序 优 化 结 果 代 码 ， 最 终 保 存 到 文 件 。

文 件

~/.txt2tagsrc

用 户 默 认 配 置 文 件 。

环 境

T2TCONFIG

该 值 设 置 用 户 默 认 配 置 文 件 的 绝 对 路 径 。

作 者

原 文 由 Aurelio Jargas <verde [AT] aurelio.net>编 写 。

中 文 版 由 Abby Pan <abbypan [AT] gmail.com>翻 译 。

缺 陷

http://bugs.txt2tags.org

版 权

Copyright (C) 2001−2010 Aurelio Jargas, GNU GPL v2