摘要:
這份文檔主要給出了一些常用的 TWiki 文章編輯方法。TWiki 是一個廣泛使用的開源 wiki
系統,通常被企業和組織用戶用來共享知識等。更多介紹請看它的官方站點:http://twiki.org
。
這只是作者的一份編程筆記,其實與網上早期版本的 TWiki 文檔中文翻譯有些重復,需要更多內容請查看參考文章和鏈接。
目錄
1. 基本語法
1.1 話題
1.2 標題和段落
1.3 字體
1.4 列表
1.4.1 無序號列表
1.4.2 帶序號列表
1.5 表格
1.6 鏈接
1.6.1 詞條鏈接
1.6.2 外部鏈接
1.6.3 頁面內錨點
1.6.4 圖片和附件鏈接
1.7
圖標
2. 頁面編輯技巧
3. 參考文章和鏈接
1. 基本語法
[1.1 話題]
Wiki 的精神就是用詞條描述世界,所以 TWiki 也是這樣,它內部對內容的管理是用一個一個 WikiWord
來分類的。WikiWord 就是像前面這種兩個單詞構成的連接在一起的詞組,里面大小寫交錯。
TWiki 的話題(topic)推薦用 WikiWord 來建立,如果用戶輸入的新話題不是一個
WikiWord,那么建立新話題的按鈕就不會被激活。但是 TWiki 允許用戶使用非 WikiWord 建立詞條,需要手動勾選上允許使用非
WikiWord 建立話題。
[1.2 標題和段落]
1.2.1 標題
TWiki 中可以使用分級標題,分級標題的語法如下:
---+
---++
即在行首三個"-"和一個"+"代表一級標題,三個"-"和兩個"+"代表二級標題,以此類推。當用戶使用規范的標題記號建立好話題之后,可以很方便地使
用"%TOC%"標記建立一個標題目錄。如果用戶不想某個標題被包含,只需要在標記標記后加上兩個感嘆號"!!",比如:
---+!! 目錄
%TOC%
這樣目錄這個標題就不會包含在自動建立的目錄里。
1.2.2 段落
TWiki 的段落分隔和 LaTeX 有點兒類似,段落之間需要空一行。如果想輸入不被 TWiki
格式化的原始文字(比如源程序等),需要用標簽將這些段落包起來,主要有以下兩種標簽:
<verbatim></verbatim>
<pre></pre>
區別是 <verbatim></verbatim>
中間的代碼以完全原始方式顯示,<pre></pre> 中某些 HTML 標簽依然起作用。
[1.3 字體和分隔線]
1.3.1 字體
TWiki 使用字體的方式比較像 HTML 的標簽,就是在字符串兩頭加上某些標記。比如:
*Bold Font* 粗體
_Italic Font_ 斜體
__Bold Italic__ 粗斜體
=Fixed Font= 等寬字符
==Bold Fixed Font== 等寬粗體字符
最最需要注意的一點是:這些標記"*_="必須內側與文字相連,外側為空格,標記之間也不得有空格。
1.3.2 分割線
TWiki 的分割線是在行首輸入連續的多于三個的減號"-",例如
----
[1.4 列表]
1.4.1 無序號列表
無序號列表的格式是:
*
*
即三個空格加"*"所進一層,六個空格加"*"縮進第二層,以此類推。
1.4.2 帶序號列表
帶序號列表的格式是:
1.
1.
即三個空格加"1"所進一層,六個空格加"1"縮進第二層,以此類推。注意,這里的"1"代表用阿拉伯數字編號列表,其它編號方式有"A"或"a"大小寫
字母標號,"I"或"i"大小寫羅馬字母編號。
注意:這里后面的小數點可要可不要,可以一直使用"1"編號,也可用"1,2,3"遞增編號,效果無區別。
[1.5 表格]
表格的建立是用豎線"|"分隔,比如:
|T1|T2|T3|
|A1|A2|A3|
就建立了一個兩行三列的列表。單元格內部的左右對齊是利用和豎線的距離實現的。
[1.6 鏈接]
1.6.1 詞條鏈接
如果是規范的多詞 WikiWord 話題,可以使用雙方括號直接括起來,例如:[[my wiki topic]]就會直接引用
MyWikiTopic
詞條;如果是非規范話題,或者引用說明和引用話題不一樣,需要使用引用與說明分開的格式,例如:[[MyWikiTopic][my WIKI
topic]]。
1.6.2 外部鏈接
外部鏈接可以直接使用類似與詞條鏈接的方式來引用,例如:[[
http://blog.solrex.org][Solrex 的博客]] 。
1.6.3 頁面內錨點
在頁面內可以定義錨點,這樣可以使用鏈接在頁面內跳來跳去。定義錨點的方法是在行首使用 #WikiWord,例如:
#FootNote Footnote is....
就定義了一個到該段的錨點。引用錨點和詞條鏈接的方式也類似,例如:[[#FootNote][to
footnote]]。如果引用別的頁面的錨點,只需要在錨點前面加上該頁面的話題名,例如:[[MyWikiTopic#FootNote][to
another footnote]]。
1.6.4 圖片和附件鏈接
如果引用在同一頁面的附件或者圖片(其實一般圖片也是附件),鏈接的格式為:%ATTACHURL%/filename.extesion,比
如:%ATTACHURL%/about.pdf;引用在不同頁面的鏈接,需要在文件名前面加上該頁面主題的名字,比如:%PUBURL%/%WEB%
/MyWikiTopic/about.pdf
[1.7 圖標]
TWiki 預定義了很多圖標,直接在文中就可以使用,比如幫助的小 i 圖標是:%H%,update 的圖標是:%U%,new
的圖標是:%N%。合理使用這些圖標能增強文章的可讀性。
2. 頁面編輯技巧
[1] 建立話題時合理分級,有規律地規劃父話題和子話題關系。
[2] 處理重復話題時使用 %INCLUDE{"XXX"}% 來包含已有的話題,比如我已經有了 PersonalComputer 話題,在建立
PC 話題時候,就應該直接在頁面中使用 %INCLUDE{"PersonalComputer"}% 來避免冗余。
[3] 使用%TOC%自動創建目錄:當編輯一篇比較長的文章時,建議使用標題標記建立分級標題,最后使用 %TOC% 在上方建立一個可索引目錄。
[4] 合理使用字體和圖標增加可讀性。
[5] 合理使用 HTML 代碼來加強頁面排版功能。TWiki 可以直接支持 HTML 代碼,為了格式的統一,一般不建議直接使用
HTML。但有些頁面排版過于復雜,使用 HTML 可以直接達到要求。
[6] 使用注釋的技巧:TWiki 沒有裝 footnote
插件時候是不支持注釋鏈接的,但是可以通過一些技巧來實現。我們可以先在注釋或者引用列表前建立一個錨點:
#FootNote
---+ Footnotes
1 aaa
1 bbb
當文中內容需要注釋時,使用 HTML 和 TWiki
鏈接一起加一個上腳標:aaa<sup>[[[#FootNote][1]]]</sup>,這樣 aaa
的右上角就可以出現一個方括號,里面是帶到腳注鏈接的腳注編號 "1"。
3. 參考文章和鏈接
[1] 早期版本 TWiki 語法格式的中文翻譯:
http://www.stlchina.org/twiki/bin/view.pl/TWiki/TextFormattingRules
[2] TWiki 官方語法文檔:
http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules