摘要:</p>

这份文档主要给出了一些常用的 TWiki 文章编辑方法。TWiki 是一个广泛使用的开源 wiki
系统,通常被企业和组织用户用来共享知识等。更多介绍请看它的官方站点:http://twiki.org
。</p>

这只是作者的一份编程笔记,其实与网上早期版本的 TWiki 文档中文翻译有些重复,需要更多内容请查看参考文章和链接。</p>

目录

1. 基本语法
1.1 话题
1.2 标题和段落<br />
1.3 字体
1.4 列表
1.4.1 无序号列表<br />
1.4.2 带序号列表<br />
1.5 表格
1.6 链接
1.6.1 词条链接
1.6.2 外部链接
1.6.3 页面内锚点<br />
1.6.4 图片和附件链接<br />
1.7
图标
2. 页面编辑技巧<br />
3. 参考文章和链接

1. 基本语法

[1.1 话题]

Wiki 的精神就是用词条描述世界,所以 TWiki 也是这样,它内部对内容的管理是用一个一个 WikiWord
来分类的。WikiWord 就是像前面这种两个单词构成的连接在一起的词组,里面大小写交错。</p>

TWiki 的话题(topic)推荐用 WikiWord 来建立,如果用户输入的新话题不是一个
WikiWord,那么建立新话题的按钮就不会被激活。但是 TWiki 允许用户使用非 WikiWord 建立词条,需要手动勾选上允许使用非
WikiWord 建立话题。</p>

[1.2 标题和段落]

1.2.1 标题
TWiki 中可以使用分级标题,分级标题的语法如下:
—+
—++
即在行首三个”-“和一个"+”代表一级标题,三个”-“和两个"+”代表二级标题,以此类推。当用户使用规范的标题记号建立好话题之后,可以很方便地使
用"%TOC%”标记建立一个标题目录。如果用户不想某个标题被包含,只需要在标记标记后加上两个感叹号”!!”,比如:

—+!! 目录
%TOC%
这样目录这个标题就不会包含在自动建立的目录里。</p>

1.2.2 段落
TWiki 的段落分隔和 LaTeX 有点儿类似,段落之间需要空一行。如果想输入不被 TWiki
格式化的原始文字(比如源程序等),需要用标签将这些段落包起来,主要有以下两种标签:<br />

区别是
中间的代码以完全原始方式显示,&lt;pre>

中某些 HTML 标签依然起作用。</p>

[1.3 字体和分隔线]

1.3.1 字体
TWiki 使用字体的方式比较像 HTML 的标签,就是在字符串两头加上某些标记。比如:
*Bold Font* 粗体
_Italic Font_ 斜体
__Bold Italic__ 粗斜体<br />
=Fixed Font= 等宽字符
==Bold Fixed Font== 等宽粗体字符
最最需要注意的一点是:这些标记"*_=”必须内侧与文字相连,外侧为空格,标记之间也不得有空格。</p>

1.3.2 分割线<br />
TWiki 的分割线是在行首输入连续的多于三个的减号”-“,例如<br />
—-

[1.4 列表]

1.4.1 无序号列表<br />
无序号列表的格式是:
*
*
即三个空格加”*”所进一层,六个空格加"*”缩进第二层,以此类推。</p>

1.4.2 带序号列表<br />
带序号列表的格式是:
1.
1.
即三个空格加”1″所进一层,六个空格加"1″缩进第二层,以此类推。注意,这里的"1″代表用阿拉伯数字编号列表,其它编号方式有”A”或"a”大小写
字母标号,"I”或"i”大小写罗马字母编号。</p>

注意:这里后面的小数点可要可不要,可以一直使用"1″编号,也可用”1,2,3″递增编号,效果无区别。</p>

[1.5 表格]

表格的建立是用竖线"|”分隔,比如:
|T1|T2|T3|
|A1|A2|A3|
就建立了一个两行三列的列表。单元格内部的左右对齐是利用和竖线的距离实现的。</p>

[1.6 链接]

1.6.1 词条链接
如果是规范的多词 WikiWord 话题,可以使用双方括号直接括起来,例如:[[my wiki topic]]就会直接引用
MyWikiTopic
词条;如果是非规范话题,或者引用说明和引用话题不一样,需要使用引用与说明分开的格式,例如:[[MyWikiTopic][my WIKI
topic]]。</p>

1.6.2 外部链接
外部链接可以直接使用类似与词条链接的方式来引用,例如:[[
http://blog.solrex.org][Solrex
的博客]] 。</p>

1.6.3 页面内锚点<br />
在页面内可以定义锚点,这样可以使用链接在页面内跳来跳去。定义锚点的方法是在行首使用 #WikiWord,例如:
#FootNote Footnote is….
就定义了一个到该段的锚点。引用锚点和词条链接的方式也类似,例如:[[#FootNote][to
footnote]]。如果引用别的页面的锚点,只需要在锚点前面加上该页面的话题名,例如:[[MyWikiTopic#FootNote][to
another footnote]]。</p>

1.6.4 图片和附件链接<br />
如果引用在同一页面的附件或者图片(其实一般图片也是附件),链接的格式为:%ATTACHURL%/filename.extesion,比
如:%ATTACHURL%/about.pdf;引用在不同页面的链接,需要在文件名前面加上该页面主题的名字,比如:%PUBURL%/%WEB%
/MyWikiTopic/about.pdf

[1.7 图标]

TWiki 预定义了很多图标,直接在文中就可以使用,比如帮助的小 i 图标是:%H%,update 的图标是:%U%,new
的图标是:%N%。合理使用这些图标能增强文章的可读性。</p>

2. 页面编辑技巧</p>

[1] 建立话题时合理分级,有规律地规划父话题和子话题关系。<br />
[2] 处理重复话题时使用 %INCLUDE{“XXX”}% 来包含已有的话题,比如我已经有了 PersonalComputer 话题,在建立
PC 话题时候,就应该直接在页面中使用 %INCLUDE{“PersonalComputer”}% 来避免冗余。<br />
[3] 使用%TOC%自动创建目录:当编辑一篇比较长的文章时,建议使用标题标记建立分级标题,最后使用 %TOC% 在上方建立一个可索引目录。</p>

[4] 合理使用字体和图标增加可读性。<br />
[5] 合理使用 HTML 代码来加强页面排版功能。TWiki 可以直接支持 HTML 代码,为了格式的统一,一般不建议直接使用
HTML。但有些页面排版过于复杂,使用 HTML 可以直接达到要求。<br />
[6] 使用注释的技巧:TWiki 没有装 footnote
插件时候是不支持注释链接的,但是可以通过一些技巧来实现。我们可以先在注释或者引用列表前建立一个锚点:
#FootNote

—+ Footnotes
1 aaa
1 bbb
当文中内容需要注释时,使用 HTML 和 TWiki
链接一起加一个上脚标:aaa[[[#FootNote][1]]],这样 aaa
的右上角就可以出现一个方括号,里面是带到脚注链接的脚注编号 “1”。</p>

3. 参考文章和链接

[1] 早期版本 TWiki 语法格式的中文翻译:
http://www.stlchina.org/twiki/bin/view.pl/TWiki/TextFormattingRules
[2] TWiki 官方语法文档:</p>

http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules

Leave a Reply

电子邮件地址不会被公开。 必填项已用*标注