PageRenderTime 42ms CodeModel.GetById 19ms app.highlight 17ms RepoModel.GetById 1ms app.codeStats 0ms

/doc/Chinese/manpage-zh.html

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