PageRenderTime 22ms CodeModel.GetById 12ms app.highlight 6ms RepoModel.GetById 1ms app.codeStats 0ms

/doc/Chinese/manpage-zh.t2t

http://txt2tags.googlecode.com/
Unknown | 381 lines | 259 code | 122 blank | 0 comment | 0 complexity | 0ee6de5dc6c8e98758481fead13b7be4 MD5 | raw file
  1TXT2TAGS
  2
  32010年8月
  4
  5%!target: man
  6%!encoding: UTF-8
  7
  8%!postproc(man): ' \(#\w+\)' ''
  9
 10%!options(html): --mask-email --toc
 11%!postproc(html): <HEAD> '<HEAD>\n<STYLE>body{margin:3em;} pre{background:#ffc;}</STYLE>'
 12
 13
 14= 名称 =[name]
 15
 16txt2tags - 文本格式化及转换工具 
 17
 18= 总览 =[synopsis]
 19
 20**txt2tags** [//选项//] [//文件//...]
 21
 22= 描述 =[description]
 23
 24**txt2tags** 读入含少量标记的文本,并将其转换为多种格式的文档:
 25//ASCII Art//,
 26//AsciiDoc//,
 27//Creole//,
 28//DocBook//,
 29//DokuWiki//,
 30//Google Code Wiki//,
 31//HTML//,
 32//LaTeX//,
 33//Lout//,
 34//MagicPoint//,
 35//Man page//,
 36//MoinMoin//,
 37//PageMaker//,
 38//Plain Text//,
 39//PmWiki//,
 40//SGML//,
 41//Wikipedia// 和
 42//XHTML//.
 43% TRANSLATOR: please keep the alphabetical order of this list.
 44
 45此手册页是由**txt2tags**转换一个示例文本文件生成。并且该示例文本文件同时被转换成HTML,作为此手册页的在线版本。
 46
 47单个源文件,多种格式的目标文件 - http://txt2tags.org
 48
 49
 50= 标记 =[markup]
 51
 52```
 53头部                源文件的前3行
 54标题                = 文字 =
 55带数字编号的标题    + 文字 +
 56注释                % 注释内容
 57隔离行              -----------------------...
 58粗隔离行            =======================...
 59图片                [filename.jpg]
 60链接                [标签 url地址]
 61
 62粗体                **文字**
 63斜体                //文字//
 64下划线              __文字__
 65删除线              --文字--
 66等宽                ``文字``
 67原始文本            ""文字""
 68标记文本            ''文字''
 69
 70段落                文字
 71引用                <TAB>文字
 72列表                 - 文字
 73带编号的列表        + 文字
 74定义式列表          : 文字
 75表格                | 单元格1 | 单元格2 | 单元格3...
 76
 77完全引用行          ``` 文字
 78原文引用行          """ 文字
 79标记引用行          ''' 文字
 80
 81完全引用块          ```
 82                    多行文本
 83                    ```
 84原文引用块          """
 85                    多行文本
 86                    """
 87标记引用块          '''
 88                    多行文本
 89                    '''
 90```
 91
 92= 选项 =[options]
 93
 94:     **--art-chars**=//PATTERN//
 95定义//PATTERN//为组成ASCII艺术字的字符模板,按以下顺序指定:
 96拐角,边框,侧面,一级块,二级块,二级水平线,三级水平线,四级水平线,五级水平线。
 97默认的模板是 +-|-==-^"。此选项只在输出目标格式为艺术ASCII时可用。
 98
 99: **-C**, **--config-file**=//FILE//
100从外部文件//FILE//中读入配置。配置项格式为//%!关键字:取值//,详情请见
101[配置 #settings] 小节。
102
103:     **--css-sugar**
104优化生成的嵌入CSS样式HTML/XHTML内容。移除标签属性,禁用样式属性,头部内容由H1、H2和H3组成,新建以下DIV:
105//#header//, //#body//, //.toc//。
106
107:     **--css-inside**
108在HTML/XHTML头部嵌入CSS文件的内容。使用``--style``指定读入的CSS文件。
109
110:     **--dump-config**
111输出所有配置项后退出。
112
113:     **--dump-source**
114输出文档源文件,并展开 (``%!include``) 中的内容。
115
116:     **--encoding**=//CODE//
117设置源文件转换成目标//CODE//时采用的字符集。例如 UTF-8 and iso-8859-1。
118
119:     **--gui**
120启动TK图形界面。
121
122: **-h**, **--help**
123输出帮助信息后退出。
124
125: **-H**, **--no-headers**
126输出内容时不显示头部、尾部信息,只显示主体内容。
127
128:     **--headers**
129输出内容时显示头部、尾部信息。此选项默认打开。
130
131:     **--height**=//NUM//
132设置输出内容为//NUM//行。此选项只在目标文档格式为艺术ASCII、且指定``--slides``时可用。
133
134: **-i**, **--infile**=//FILE//
135指定//FILE//为输入的源文件名。如果指定为'-',则从STDIN读入源文本。
136
137:     **--mask-email**
138隐藏邮件地址,以防止垃圾邮件地址收割。移除@和.。邮件地址
139""foo@bar.com"" 被转换为 <foo (a) bar com>。
140
141: **-n**, **--enum-title**
142对所有标题行进行自动编号。显示的前缀为 1, 1.1, 1.1.1, ... 
143
144:     **--no-dump-config**
145取消``--dump-config``动作。
146
147:     **--no-dump-source**
148取消``--dump-source``动作。
149
150:     **--no-encoding**
151清除encoding设置。
152
153:     **--no-enum-title**
154关闭标题自动编号的设置。
155
156:     **--no-infile**
157清除之前所有infile的声明。
158
159:     **--no-targets**
160取消``--targets``动作。
161
162:     **--no-mask-email**
163关闭隐藏邮件地址的特性。
164
165:     **--no-outfile**
166清除之前所有outfile的声明。
167
168:     **--no-quiet**
169输出消息,关闭--quiet选项。
170
171:     **--no-rc**
172不读入用户配置文件~/.txt2tagsrc。
173
174:     **--no-slides**
175关闭演示文档特性。
176
177:     **--no-style**
178清除所有样式设置。
179
180:     **--no-toc**
181不输出目录。
182
183:     **--no-toc-only**
184关闭``--toc-only``动作。
185
186: **-o**, **--outfile**=//FILE//
187指定输出的文件名为//FILE//。指定'-'则将结果输出到STDOUT。
188
189: **-q**, **--quiet**
190安静模式。关闭除了错误之外的所有其他消息输出。
191
192:     **--rc**
193读入用户配置文件~/.txt2tagsrc。此选项默认打开。
194
195:     **--slides**
196指定输出格式为演示文档,此选项只在输出目标格式为艺术ASCII时可用。
197
198:     **--style**=//FILE//
199指定//FILE//作为目标文档的样式文件。用于指定HTML/XHTML文档使用的CSS文件,LaTeX文档使用的样式包。此选项可以多次使用,以指定多个样式文件。
200
201: **-t**, **--target**=//TYPE//
202指定输出目标文档的类型为//TYPE//。一些常用的类型为://html//, //xhtml//, //tex//, //man//, //txt//。使用``--targets``选项查看所有支持的目标文档类型。
203
204:     **--targets**
205输出所有可用的目标文档类型后退出。
206
207:     **--toc**
208在输出内容中包含自动生成的目录信息,置于头部内容和主体内容之间。也可以
209通过`%%TOC``宏显示指定目录输出位置。 
210
211:     **--toc-level**=//NUM//
212指定目录最大深度为//NUM//。所有比//NUM//深的标题不会在目录中显示。
213
214:     **--toc-only**
215输出目录后退出。
216
217: **-v**, **--verbose**
218在文档转换过程中输出详细的信息。此选项可以多次使用,以提高输出的消息量。
219
220: **-V**, **--version**
221输出程序版本后退出。
222
223:     **--width**=//NUM//
224设置输出的宽度为//NUM//,此选项只在输出目标格式为艺术ASCII时可用。
225:
226
227= 源文件 =[source]
228
229源文件扩展名一般为//.t2t// (例如 ``myfile.t2t``)。可以在以下三个区域指定源文件:
230
231: **头部** (可选)
232源文件的前三行。如果不需要头部信息,则源文件首行留空。
233用于指定文档标题、作者、版本和日期信息。
234
235: **配置** (可选)
236紧接在头部信息之后(第4行或第2行),在主体内容之前结束。
237用于指定各种配置项,格式为``%!关键字:取值``。
238
239: **主体**
240从头部区域之后的第一个有效文本行开始(非注释或配置),直至源文件结束。
241用于指定文档内容。
242:
243
244= 配置 =[settings]
245
246配置用于定制**txt2tags**,与选项类似。配置项可以在源文件的配置区域,``~/.txt2tagsrc``文件,``--config-file``指定的外部文件中指定。
247
248: **%!target**
249配置输出目标文档类型,功能与``--target``相同。举例:
250``` %!target: html
251
252: **%!options(target)**
253设置该目标类型(target)文档的默认选项。必须以命令行的形式调用。举例:
254``` %!options(html): --toc --toc-level 3 --css-sugar
255
256: **%!includeconf**
257指定读入外部文件中包含的配置项,功能与``--config-file``相同。举例:
258``` %!includeconf: myconfig.t2t
259
260: **%!style**
261为目标文档指定样式文件,功能与``--style``相同。可以多次使用。举例:
262``` %!style: colors.css
263
264: **%!encoding**
265指定目标文档使用的字符集,功能与``--encoding``相同。举例:
266``` %!encoding: UTF-8
267
268: **%!preproc**
269指定查找/替换的过滤器,在txt2tags解析源文档之前,改变源文档的内容。格式采用Python正则表达式。举例:
270``` %!preproc:  "JJS"  "John J. Smith"
271
272: **%!postproc**
273指定查找/替换的过滤器,在txt2tags转换源文档之后,改变目标文档的内容。格式采用Python正则表达式。举例:
274``` %!postproc(html):  "<B>"  "<STRONG>"
275:
276
277如果同一个关键字多次出现,则以最后的取值为准(options, preproc and postproc是累计的除外)。异常关键字被忽略。解析顺序为:``~/.txt2tagsrc``,源文档的配置区域,``--config-file``命令行选项。
278
279
280= 指令 =[commands]
281
282指令在文本转换过程中生效。指令必须在源文件主体内容中指定。
283
284: **%!csv: file.csv**
285读入一个外部的CSV文件,作为表格。
286
287: **%!include: file.t2t**
288读入一个txt2tags文件。
289
290: **%!include: ""``file.txt``""**
291读入一个文本文件的内容,作为源文件的“原文引用块”。
292
293: **%!include: ""''file.html''""**
294读入一个标签文件内容到目标文档。
295:
296
297= 宏 =[macros]
298
299使用宏很容易在文档中插入动态内容。宏必须在源文件的主体内容中指定。
300除了``%%toc``,所有宏都能够用修饰符指定格式,例如``%Y``和``%f``。详情请查看txt2tags用户指南。
301
302: **""%%date""**
303插入当前日期。默认格式是``%%date(%Y%m%d)``,输出YYYYMMDD。
304
305: **""%%infile""**
306插入源文件所在路径。默认格式是``%%infile(%f)``。常用尾部链接举例:``[查看源文件 %%infile]``。
307
308: **""%%mtime""**
309插入源文件修改时间。默认格式是``%%date(%Y%m%d)``,输出YYYYMMDD。
310
311: **""%%outfile""**
312输出目标文档所在路径。默认格式是``%%outfile(%f)``。常用的自引用形式举例:"这是 %%outfile 文件"。
313
314: **""%%toc""**
315指定目录信息所在位置。可以多次使用。注意同时指定``--toc``选项。
316:
317
318= 示例 =[examples]
319
320: ``txt2tags -t html file.t2t``
321
322转换成HTML,将转换的结果输出到文件file.html。
323
324: ``txt2tags -t html -o - file.t2t``
325
326转换成HTML,将转换的结果输出到STDOUT。
327
328: ``txt2tags -t html --toc file.t2t``
329
330转换成HTML,包含自动生成的目录。
331
332: ``txt2tags -t html --toc --toc-level 2 -n file.t2t``
333
334转换成HTML,并生成目录,目录深度为2,各项标题采用数字编号。
335
336: ``txt2tags --toc-only file.t2t``
337
338只输出目录,不进行实际的转换。
339
340: ``txt2tags -t html --css-sugar --style base.css --style ui.css file.t2t``
341
342转换成HTML,并预先设置采用CSS,同时指定引用两个外部CSS文件。
343
344: ``txt2tags -t art --slides --width 80 --height 25 -o - file.t2t | more``
345
346生成艺术ASCII演示文档,用于在80x25的屏幕或窗口上演示。
347
348: ``(echo ; echo "**bold**") | txt2tags -t html -H -``
349
350易用的单行指令,从STDIN读取内容做快速的测试。
351
352: ``txt2tags -t html -o - file.t2t | tidy > file.html``
353
354将转换的结果输出到STDOUT,然后调用外部程序优化结果代码,最终保存到文件。
355:
356
357= 文件 =[files]
358
359: ~/.txt2tagsrc
360用户默认配置文件。
361:
362
363= 环境 =[environment]
364
365: T2TCONFIG
366该值设置用户默认配置文件的绝对路径。
367:
368
369= 作者 =[author]
370
371原文由Aurelio Jargas <verde@aurelio.net>编写。
372
373中文版由Abby Pan <abbypan@gmail.com>翻译。
374
375= 缺陷 =[bugs]
376
377http://bugs.txt2tags.org
378
379= 版权 =[copyright]
380
381Copyright (C) 2001-%%date(%Y) Aurelio Jargas, GNU GPL v2