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