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

Winter 翻譯 用TWiki 編輯就和平時直接寫文本一樣簡單 -- 就像寫email。如果你喜歡，你可以使用HTML代碼，但是并不要求你了解。當你寫入一個 WikiWords 時，TWiki會自動鏈接到相應的主題。TWiki 語法速記讓你通過一個簡單的譯碼系統擁有了所有強大的HTML功能。 在你使用 Edit 界面時，本網頁可以通過彈出窗口的方式完全展現給用戶。

1 TWiki 編輯語法速記?

格式描述:	例子: You write:	效果:
段落: 一個空行會生成一個新段落(注意空行上不要有空格).	1st paragraph 2nd paragraph	1st paragraph 2nd paragraph
大小標題: 在一行以三個小橫線'-'開頭，后面跟加號'+'和相應的標題文字。一個加號'+'生成第一級標題(當然是你認為最重要的)，兩個加號'++'就生成二級標題，以此類推，最多可以有6個加號。 注意: 如果你使用 %TOC% 變量，內容的目錄會自動生成，詳細可以查看 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 模式: 這是逐字模式，在一些代碼兩端使用 <verbatim> 和 </verbatim> 標簽. 這樣使得被包圍的所有字符都按照你編輯的樣式顯示。 注意: 如果你希望在里面的HTML代碼仍然能起作用，你可以使用 <pre> 和 </pre> 標簽來代替使用 注意 每個標簽必須自己單獨一行.	<verbatim> class CatAnimal { ? void purr() { ??? <code here> ? } } </verbatim>	class CatAnimal { ? void purr() { ??? <code here> ? } }
分割符: 在一行的開頭，用三個連續的'-'符號。	-------
列表: 一行開頭是三個空格，加一個'*'號，再加一個空格。	?? * 條目	·???????? 條目
多級列表: 6個空格, 9個空格, ... 然后一個'*'，加上另一個空格	?? * 一級條目 ????? * 二級條目	·???????? 一級條目 o??? 二級條目
排序列表: 三個空格, 一個數字, 一個小數點'.', 加上另外一個空格. 除了數字之外，還可以是其他類型的排序: 類型 風格說明 樣例 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???????? 李四 1???????? 張三 2???????? 李四 1???????? 張三 1???????? 李四
定義表: 三個空格, 一個'$'符號, 需定義詞, 冒號, 空格, 解釋.	?? $ 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 的鏈接，可寫成 Otherweb.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/) 都支持. 注意 : *強制鏈接*規則對于內部鏈接地址同樣支持. 注意 : 對于外部鏈接，你可以把在鏈接地址和鏈接文本之間的 ][ 用一個空格代替. 注意 : 鏈接網頁內部標簽也可做為鏈接地址的一部分（即可以直接鏈接到另一網頁的某個特定位置), 如： [[WebHome#MyAnchor][返回主目錄]] 和 [[http://gnu.org/#Action][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
使鏈接失效: 你可以通過在文本的兩端使用 <noautolink> 和 </noautolink> 符號，讓被包圍的文本中的所有自動鏈接都失效。 注意: 每個符號應該單獨一行 注意: 這同樣適用于TWiki表格, 但是你需要在表格的結尾和 </noautolink> 符號之間增加一空行(現在需要 TablePlugin 插件支持).	?<noautolink> ?RedHat & ?SuSE ?</noautolink>	RedHat & SuSE
Mailto: 鏈接: 使用'mailto'鏈接，你可以增加很多描述性的鏈接文本，詳細的注意行或信息塊，或還可讓email地址不可見。生成'mailto'鏈接的方式： [[mailto:user@domain descriptive text]].	[[mailto:winter@winterxy.com 給Winter發mail]] [[mailto:winter@winterxy.com?subject=hello 主題是'hello'的mail]]	給Winter發mail 主題是'hello'的mail

2 使用 HTML

你可任意的使用任何HTML代碼 - 但要提醒的是，你仍需注意一些技術方面的細節。

2.1 HTML 和 TWiki 可用性?

·???????? TIP: 作為共同編輯的頁面，最好還是不要使用HTML代碼，而使用 TWiki 語法來代替 - 這樣可以讓頁面保持整潔而容易編輯。

·???????? 注意: TWiki 支持多種瀏覽器和系統平臺，標準TWiki安裝版本兼容HTML5.0和XHTML 1.0 - 你增加的HTML代碼，特定的瀏覽器標簽(或者其他的不兼容低版本的補充)都有可能降低兼容性

·???????? 關于使用HTML的建議:

o??? 使用 XHTML 1.0 Transitional 語法

o??? 不要跨行寫一個標簽.

o??? 刪除所有空行。 TWiki會在每個空行上插入 <p /> 段落標簽，這樣對那些不能插入段落的標簽來說，就會引起問題。例如：在table 標簽之間就不能使用 <p />

2.2 TWiki 的 HTML 展現

·???????? TWiki 把一些簡化符號翻譯成 XHTML 1.0 格式顯示. 若要拷貝網頁的內容，你只需要查看網頁源文件，然后保存其內容。

o??? 若你需頻繁保存為HTML格式，你需要使用插件： TWiki:Plugins/GenHTMLAddon - 它能 "產生一個目錄，其中包含所有要發布成HTML格式的TWiki頁面，并包含了所有的附件."

·???????? 注意: HTML代碼中所有 <...> 標簽必須寫在同一行，否則這個標簽就會被分開.

o??? 你可利用這個特征寫一些非封閉的三角符號 - 例如大于號 '>'或小于號'<' - 它會自動翻譯成相應的符號，和你寫相應的HTML代碼一樣( &lt; ), 如: a < b

o??? 如果你在粘貼HTML文本的時候發現了問題，你可以把這些代碼放在沒有自動換行的文本編輯器檢查一下。也可在你的HTML編輯器中用不帶硬回車的自動換行方式保存文本。

2.3 TWiki 和 JavaScript

在你的TWiki中，你可以使用 JavaScript. TWiki在顯示時可能會干擾 JavaScript 代碼，如果你希望避免這種情況，你可使用HTML注釋，或者使用 <pre> 標簽:

<script type="text/javascript">

<!-- 隱藏的 JavaScript 和 <pre> 來避免 TWiki 顯示

... 把你的 JavaScript代碼放在這兒...

// 不在隱藏? </pre> 讓TWiki正常顯示 -->

</script>

3 超鏈接

不需任何格式就可生成超級鏈接是TWiki最核心的特征之一，TWiki是通過 TWikiWords? 來實現此功能的。TWiki在其語法基礎上擴展了新的鏈接規則，并提供了一套靈活的選項。

3.1 內部鏈接

·???????? GoodStyle 是一個 WikiWord , 并且會鏈接到本TWiki網站內的 GoodStyle 主題。

·???????? NotExistingYet? 是一個需要增加的主題。點擊后面的 ? 號就會生成新的主題。 (你可以試一試，然后選擇 Cancel - 如果你已經生成這個主題了，那么這個例子就不行了!)

3.2 外部鏈接

·???????? http://..., https://..., ftp://..., gopher://..., news://..., file://..., telnet://... 和 mailto:...@... 都是自動鏈接的。

·???????? Email 地址，如 name@domain.com 也是自動鏈接的。

·???????? [[方括號規則]] 可讓你方便的生成 non-WikiWord 的鏈接.

o??? 你也可以寫成這種形式： [[http://yahoo.com Yahoo 首頁]] ，或者一種更方便的形式：雅虎 page ，這樣不需要任何描述文本，可以直接生成外部鏈接.

4 TWiki 變量

變量就是用百分號 % 包圍的那些名字，可以任意擴充。

·???????? %TOC% : 自動生成本文內容的目錄。此目錄是基于每個topic 的heading 定義 - 本文開頭就有一個目錄例子。

·???????? %WEB% : 當前的web名, 例如，目前的Web是 TWiki.

·???????? %TOPIC% : 當前的topic 名, 例如，本網頁的topic是 TextFormattingRules.

·???????? %ATTACHURL% : 當前topic的附件的url. 例如：如果你上傳了一個附件，你可以寫這種格式 %ATTACHURL%/image.gif 來在文中顯示你的文件或者圖片鏈接.

·???????? %INCLUDE{"SomeTopic"}% : 包含其他主題（topic）. 當前的web是默認的web(一個網頁顯示需要web名和topic名). 例如，你用這種格式可以把 SiteMap 頁面包含進來: %INCLUDE{"TWiki.SiteMap"}%

·???????? %CODE{"xxx"}% 和 %ENDCODE% : 以代碼的方式顯示文本，支持cpp perl php tcl bash等，需要插件TWiki.BeautifierPlugin 支持。例如

%CODE{"cpp"}%

#include <stdio.h>

main () //Here is a comment

{ printf("hello world!");

}

%ENDCODE%

你會得到

#include <stdio.h>

main () //Here is a comment

{ printf("hello world!");

}

·???????? %SEARCH{"sushi"}% : 內聯的搜索功能可以把搜索結果嵌入某個topic中。 FormattedSearch 會告訴你如何使用格式，如果生成基于網頁的應用。

·???????? TWikiPreferences 定義了全站范圍的變量. 除此之外還有:

o??? 換行: 用 %BR% 來另起一行.

o??? 文本顏色: 用: %RED% 紅色 %ENDCOLOR% 和 %BLUE% 藍色 %ENDCOLOR% colors 可得到: 紅色和 藍色.

o??? 圖形素材: 用: %H% 幫助, %T% 提示, %X% 警告 可以得到: 幫助, 提示, 警告. 更多的信息請參考 TWikiDocGraphics.

·???????? 還有更多的變量, 可以參考 TWikiVariables.

·???????? 若希望讓某個變量失效，在變量之前加上感嘆號'!'。例如: !%SOMEVARIABLE%你會得到: %SOMEVARIABLE%.

5 TWiki插件中的擴展格式

插件為TWiki提供更強大的文本編輯能力，你可以擴展這些功能到其他許多領域。例如，可選的電子表格插件，可以讓你利用基本的TWiki表格的語法來生成漂亮的電子表格.

可以選擇的插件都列在TWiki.org網站的 插件列表。在目前版本已經安裝的插件都列在變量 %PLUGINDESCRIPTIONS% 中:

·???????? SpreadSheetPlugin (any TWiki, $Rev: 17387 (11 Aug 2008) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text

·???????? BeautifierPlugin (Dakar, $Rev: 0 (06 Jul 2008) $): Highlights and formats code fragments

·???????? CalendarPlugin (Dakar, $Rev: 0 (23 Sep 2008) $): Show a monthly calendar with highlighted events

·???????? ChartPlugin (Dakar, $Rev: 0 (05 Jul 2008) $):

·???????? CommentPlugin (03 Aug 2008, $Rev: 17302 (11 Aug 2008) $): Allows users to quickly post comments to a page without an edit/preview/save cycle

·???????? EditTablePlugin (4.8.4, $Rev: 17302 (11 Aug 2008) $): Edit TWiki tables using edit fields, date pickers and drop down boxes

·???????? InterwikiPlugin (03 Aug 2008, $Rev: 14913 (17 Sep 2007) $): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic

·???????? PreferencesPlugin (TWiki-4.2, $Rev: 15487 (11 Aug 2008) $): Allows editing of preferences using fields predefined in a form

·???????? SmiliesPlugin (Dakar, $Rev: 16049 (11 Aug 2008) $): Render smilies as icons, like for? :-) or for? :eek:

·???????? TablePlugin (1.034, $Rev: 17367 (11 Aug 2008) $): Control attributes of tables and sorting of table columns

·???????? TemplateToolkitPlugin (Dakar, $Rev: 0$): Allow Template Toolkit expansion of topics

·???????? TinyMCEPlugin: (disabled)

·???????? TwistyPlugin (1.4.10, $Rev: 15653 (19 Nov 2007) $): Twisty section JavaScript library to open/close content dynamically

點擊當前的插件，可以在 TWikiPreferences 為整個網站設置.

6 常見編輯錯誤

TWiki語法規則相當簡單，很容易上手。但還是有些細節需要小心，以下內容節選自 TextFormattingFAQ:

·???????? 問: 被尖括號 <filename> 括起來的文本不能顯示，如何才能顯示？

o??? 答: 尖括號 '<' 和 '>' 在HTML中有特殊含義，用來定義HTML標簽。若想直接顯示，則需寫成 '&lt;' 代替 '<', 和 '&gt;' 代替 '>'.
例如: 輸入 'prog &lt;filename&gt;' 你會得到 'prog <filename>'.

·???????? 問: 為什么有時候符號 '&' 不能顯示？

o??? 答: 符號 '&' 在HTML中有特殊的意義，它經常用來表示一些轉義字符的開頭，例如 '&copy;' 用來表示 ? copyright 字符. 若想直接顯示 '&' , 則需寫成 '&amp;' 代替 '&'.
例如: 輸入 'This &amp; that' 你會得到 'This & that'.

·???????? 問: 如何在table中顯示 '|' ？

o??? 答: 由于'|'是table的單元格分隔符，在table中顯示'|'需寫成 &#124; 例如：

|test | content |

|first| echo &#124; |

你可以得到：

test	content
first	echo |

轉載于:https://www.cnblogs.com/shipengzhi/articles/2086826.html

總結

以上是生活随笔為你收集整理的TWiki 语法格式(TWiki语法教程及TWiki使用技巧)的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。