-- TanLeo - 20 Mar 2008

TWiki 语法格式(TWiki语法教程及TWiki使用技巧)

Winter 翻译 smile

用TWiki 编辑就和平时直接写文本一样简单 -- 就像写email。如果你喜欢,你可以使用HTML代码,但是并不要求你了解。当你写入一个 WikiWords 时,TWiki会自动链接到相应的主题。TWiki 语法速记让你通过一个简单的译码系统拥有了所有强大的HTML功能。 在你使用 Edit 界面时,本网页可以通过弹出窗口的方式完全展现给用户。

1 TWiki 编辑语法速记

格式描述: 例子: You write: 效果:
段落:
一个空行会生成一个新段落(注意空行上不要有空格).
1st paragraph  2nd paragraph 
1st paragraph

2nd paragraph

大小标题:
在一行以三个小横线'-'开头,后面跟加号'+'和相应的标题文字。一个加号'+'生成第一级标题(当然是你认为最重要的),两个加号'++'就生成二级标题,以此类推,最多可以有6个加号。 注意: 如果你使用 变量,内容的目录会自动生成,详细可以查看 TWikiVariables ,如果在标题文字前面有 !! ,则 TOC 就不会把这个标题列入目录中去,例如:如果你不希望某个标题列入目录,你就以 ---+!! text 的方式。
---++ 二级标题  ---+++ 三级标题 

二级标题

三级标题

粗体字:
字符要变得 只需要在他们两端加上 * 号.
*Bold* 
Bold
斜体字:
要把字变成 斜体 只需要在字两端加上 _ 符号.
_Italic_ 
Italic
粗斜体字:
要得到 粗斜体_ 只需要在字两端加上 __ 符号.
__Bold italic__ 
__Bold italic
Fixed Font:
要得到 fixed font ,只需要在字符串两端加上 = 符号.
=Fixed font= 
Fixed font

Bold Fixed Font:
要想得到 bold fixed font ,需要在字符两端各加上 == 符号.
==Bold fixed== 
Bold fixed
注意 : 要想达到上述效果,必须在字符串和功能字符(* _ = _ ==等)之间,没有任何空格。
_This works_, _this not _ 
This works,
_this not _
Verbatim 模式:
这是逐字模式,在一些代码两端使用
 和 
标签. 这样使得被包围的所有字符都按照你编辑的样式显示。
注意: 如果你希望在里面的HTML代码仍然能起作用,你可以使用
标签来代替使用
注意 每个标签必须自己单独一行.
 class CatAnimal {   void purr() {     <code here>   } } 
class CatAnimal {   void purr() {        } } 
分割符:
在一行的开头,用三个连续的'-'符号。
------- 

列表:
一行开头是三个空格,加一个'*'号,再加一个空格。
   * 条目 
  • 条目
多级列表:
6个空格, 9个空格, ... 然后一个'*',加上另一个空格
   * 一级条目       * 二级条目 
  • 一级条目
    • 二级条目
排序列表:
三个空格, 一个数字, 一个小数点'.', 加上另外一个空格. 除了数字之外,还可以是其他类型的排序:
类型 Sort 风格说明 Sort 样例 Sort
1. 阿拉伯数字 1, 2, 3, 4...
A. 大写字母 A, B, C, D...
a. 小写字母 a, b, c, d...
I. 大写罗马数字 I, II, III, IV...
i. 小写罗马数字 i, ii, iii, iv...

   1. 张三    1. 李四     A. 张三    A. 李四     i. 张三    i. 李四 
  1. 张三
  2. 李四
  3. 张三
  4. 李四
  5. 张三
  6. 李四
定义表:
三个空格, 一个'$'符号, 需定义词, 冒号, 空格, 解释.
   $ Winter: 搜索引擎爱好者    $ qianfeng: 技术爱好者 
Winter
一个搜索引擎爱好者,程序员
Qianfeng
技术爱好者
表格:
可以有任意多行。每行是表格的一行,可以有一个或多个单元格。每个单元格开始和结尾都用'|'标示。每行开头的空格都会被忽略。
注意:
  • | bold | 表头单元格.
  • | center-spaced | 单元格居中显示.
  • | right-spaced | 单元格右对齐.
  • | 2 colspan || 跨栏显示单元格 (如, 单元格中没有文本).
  • |^| 在单元格写入'^'符号,会自动把多行的单元格合并。(这个功能需要插件TablePlugin支持).
  • 如果在一行之内包含大量文本,你想在编辑的过程中可读性强,你可以用'\'作为一行的结束,这样把一行变成多行。
• 表格的单元格会随着浏览器自动折行。
| *L* | *C* | *R* | | A2 |  2  |  2 | | A3 |  3  |  3 | | 多栏 ||| | A4-6行 | four | four | |^| five | five | |^| six | six | 
L C R
A2 2 2
A3 3 3
多栏
A4-6行 four four
five five
six six
WikiWord 链接:
大小写连在一起的多个词(称WikiWords)会自动产生一个链接.
注意 : 如果你想链接不同 TWiki 的链接,可写成 TopicName. (链接文本就是网页的topic名字,只有在WebHome 的时候是web名字)
WebNotify  Main.TWikiUsers 
WebNotify

TWikiUsers

强制链接:
你可以使用两个方括号来强制生成链接
注意: 在括号包含的文本中可以有空格。topic名会自动按照一定规则生成:把每个词的首字母大写,然后移掉空格。例如: text formatting FAQ 将会自动连接到topic: TextFormattingFAQ. 你也可用使用链接文本来链接到不同的网页。
注意: 若不想自动强制产生链接,你可以在'[['之前使用'!',例如这样的开头 [[....
[[wiki syntax]]  [[Main.TWiki users]]  未生成链接: ![[wiki syntax]] 
wiki syntax

Main.TWiki users

未生成链接: wiki syntax

特定链接:
你可以使用嵌套的'['符号生成链接,自己指定链接地址和链接文本。如: 链接文本. 网页内部链接地址(如 WikiSyntax )和外部链接地址(如 http://stlchina.org/) 都支持.
注意 : 强制链接*规则对于内部链接地址同样支持.
*注意
: 对于外部链接,你可以把在链接地址和链接文本之间的 ][ 用一个空格代替.
注意 : 链接网页内部标签也可做为链接地址的一部分(即可以直接链接到另一网页的某个特定位置), 如: 返回主目录GNU Action.
[[WikiSyntax][TWiki语法]]  [[http://winterxy.com][Winter实验室]]  [[http://stlchina.org STL中文站]] 
TWiki语法

Winter实验室

STL中文站

书签:
你可以在网页内部定义一个书签,然后在其他地方链接它。定义书签的格式:在一行的开头写上: #AnchorName , 书签名必须是一个有效的 WikiWord 。链接书签的格式是: MyTopic#MyAnchor ,和加*链接*的格式差不多. 如果你是在topic内部链接到同一topic的其他书签,你可以不用写topic的名字。.
[[WikiWord#NotThere]]  [[#MyAnchor][Jump]]  #MyAnchor To here 
WikiWord#NotThere

Jump

To here

取消链接:
WikiWord 前加上一个'!'符号,就可以取消WikiWord上的链接.
!SunOS 
SunOS
使链接失效:
你可以通过在文本的两端使用 和 符号,让被包围的文本中的所有自动链接都失效。
注意: 每个符号应该单独一行
注意: 这同样适用于TWiki表格, 但是你需要在表格的结尾和 符号之间增加一空行(现在需要 TablePlugin 插件支持).
   RedHat &  SuSE  
RedHat & SuSE
Mailto: 链接:
使用'mailto'链接,你可以增加很多描述性的链接文本,详细的注意行或信息块,或还可让email地址不可见。生成'mailto'链接的方式: descriptive text.
[[mailto:winter@winterxy.com 给Winter发mail]]  [[mailto:winter@winterxy.com?subject=hello 主题是'hello'的mail]] 
给Winter发mail

主题是'hello'的mail

Topic revision: r1 - 2008-03-20 - TanLeo
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2022 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback