Wiki語法快速參考
---- = 建立水平線. \\ = 換行, \\\=force line break and clear. [link] = 建立一個連結,指向內部的wiki頁面'Link'. [this is also a link] = 建立一個連結,指向內部的wiki頁面'ThisIsAlsoALink'. [click here|link] = 建立一個連結,指向內部的wiki頁面'Link', 連結文字是'click here'. [1] = Makes a reference to a footnote numbered 1. [#1] = Marks the footnote number 1. [[link] = 不建立連結而是輸出文字'[link]'. !heading = 小號標題 !!heading = 中號標題 !!!heading = 大號標題 ''text'' = 將text斜體. __text__ = 將text粗體. {{text}} = prints 'text' in monospaced font. * text = 無符號列表 # text = 有符號列表 ;term:ex = 名詞定義,用'ex'定義名字'term'
文字相關語法
在寫wiki頁面時可以不懂任何wiki語法,只需要像寫信那樣寫自己的wiki頁面,用空行來分割不同的段落,這樣輸出的頁面跟你輸入時的格式是類似的.
標題'!'
!text = 用於定義小號標題 !!text = 用於定義中號標題 !!!text = 用於定義大號標題除了用於定義頁面輸出樣式,標題還有兩個增值用法
書籤:
所有標題都會自動生成一個頁面書籤, 這樣我們可以在其他頁面定義一個連結到這個頁面某個書籤的連結. 舉例, 在本頁有下面這樣的標題,
!!This is my heading那麼生成的HTML程式碼將如下,
在其他頁面可以通過如下文字連結到這個書籤,
[TextFormattingRules#ThisIsMyHeading] or [Bookmark Text|TextFormattingRules#ThisIsMyHeading]
生成索引和目錄:
無符號列表'*'
'*'生成無符號列表,多個'*'生成多級無符號列表. 舉例:* One * Two * Three ** Three.One
生成列表如下
- One
- Two
- Three
- Three.One
有符號列表'#'
類似無符號列表, 只是使用'#'. 舉例如下:# One # Two # Three ## Three.One
生成列表如下
- One
- Two
- Three
- Three.One
名詞定義與註釋';:'
';term:ex'用於名詞定義,名詞construct的定義舉例如下:
;__Construct__:''Something you use to do something with''將生成如下格式,
- Construct
- Something you use to do something with
term為空時用於生成註釋,舉例如下:
;:''Comment here.''將生成如下格式,
- Comment here.
文字效果(粗體和斜體)
__text__ 生成粗體文字 ''text'' 生成斜體文字
預格式化文字(Preformatted text)
三個'{'可以起到HTML標籤裡PRE的作用,這個功能在輸出程式程式碼等文字時會非常有用.
在Wiki頁面裡新增圖片
Inlined Image
最簡單的方式是使用Inlined Image,寫法和一般的連結寫法類似,舉例:[http://image15.360doc.com/DownloadImg/2010/09/1917/5404160_1.png]可顯示圖片
也可以為圖片指定ALT時的文字,格式為[this one here|http://example.com/example.png]. 例如[Hello All|http://image15.360doc.com/DownloadImg/2010/09/1917/5404160_1.png]顯示結果:
圖片可以位於Web上任意可以訪問的位置,也可以是某個頁面的附件,顯示時使用不同的連結地址就行,譬如完整URL(http://example.com/example.png)或者附件URL(WikiPage/AttachmentName).
Inline Image有一個侷限,就是隻支援特定型別的圖片格式,JSPWiki預設支援的圖片格式是PNG,我們也可以修改配置檔案jspwiki.properties來配置支援的圖片型別,配置格式舉例如下:
jspwiki.translatorReader.inlinePattern.1 = *.jpg jspwiki.translatorReader.inlinePattern.2 = *.png當前JSPWiki支援的Inline Image的格式可以參考SystemInfo.
Image Plugin
Inline Image使用簡單,但沒有格式控制,圖片型別也受限制,另一種輸出圖片的方法是使用Plugin機制,具體用法參考Image Plugin.
建立超級連結
基本應用
語法: [Like this] or [Like this|link]
link可以是某個wiki頁面, 例如[Rain Zhao]或[link sample to page Rain Zhao|RainZhao].
link也可以是一個完整的URL, 連結地址以下面的協議開頭的將被視為外部連結, http:, ftp:, mailto:, https:, or news:. 舉例, 語句 [http://java.sun.com], 將顯示 http://java.sun.com/, 語句 [Java home page|http://java.sun.com], 將顯示 Java home page.
頁腳註釋(Footnotes)
超鏈地址使用數字將建立一個Footnote, 例如 footnote[1], 將建立footnote[1], 也可以命名一個footnote, 格式與命名一個普通超鏈一樣. 例如 [Footnote number 1|1]將生成[Footnote number 1], 這是另一個 footnote[2].
使用 [#1] 定義footnote, 也可以使用[footnote 1|#1]定義footnote, 上文的兩個footnote定義在本頁最後.
InterWiki
我們還可以定義一個超鏈連結到其他wiki裡的某個頁面. 系統裡支援哪些InterWiki是在配置檔案裡配置的, 配置格式舉例如下:
jspwiki.interWikiRef.JSPWiki = http://www.jspwiki.org/Wiki.jsp?page=%s jspwiki.interWikiRef.Edit = Edit.jsp?page=%s jspwiki.interWikiRef.WikiWikiWeb = http://c2.com/cgi/wiki?%s jspwiki.interWikiRef.Google = http://www.google.com/search?q=%s應用舉例如下:
[TextFormattingRules on JSPWiki.org|JSPWiki:TextFormattingRules] [Edit:TextFormattingRules]輸入如下:TextFormattingRules on JSPWiki.org, Edit:TextFormattingRules
InterWiki其實就是輸出替換, 通過InterWiki機制我們除了連結其他wiki頁面, 還可以實現一些有趣的功能, 譬如實現在新窗口裡開啟連結:
首先在jspwiki.properties里加入如下配置:
jspwiki.interWikiRef.newhttp=http:%s" TARGET="_new jspwiki.interWikiRef.new = Wiki.jsp?page=%s" target="_new然後我們在寫wiki頁面時,就可以選擇是否在新窗口裡開啟新頁面了,
[Foster Schucker] -- open this wiki page in this window [new:Foster Schucker] -- open this wiki page in a new window [http://www.jspwiki.org] -- open this external link in this window [newhttp://www.jspwiki.org]] -- open this external link in a new window
表格相關語法
使用管道符號('|')生成表格. 使用雙管道符號生成表格標題. 舉例:
|| Heading 1 || Heading 2 | ''Gobble'' | Bar | [Main] | [SandBox]
生成表格如下,
Heading 1 | Heading 2 |
---|---|
Gobble | Bar |
使用CSS樣式表
Hi there!這是一個使用CSS樣式表的示例. 這裡使用了樣式 "commentbox", 樣式定義在 "jspwiki.css" 檔案裡. 使用格式為 %%commentbox %%. 我們可以使用CSS樣式來輸出豐富的字型顏色等各種效果,CSS可以是jspwiki.css已經定義好的樣式,也可以自己定義的樣式,下面是使用標準樣式定義的示例:
%%small This is small text %%樣式 "small" 必須在檔案 jspwiki.css 裡定義. 這種用法要求wiki頁面作者清楚管理員提供了哪些CSS樣式, 提供的CSS樣式在各個站點可能是不同的.
下面是使用自己定義的CSS樣式:
%%( font-size: 150%; color: red; ) Hello, world! %%輸出如下: Hello, world!
使用變數
在JSPWiki裡,有一些系統定義好的或者使用者自定義的變數,我們可以在自己的Wiki頁面裡讀取並顯示這些變數. 基本格式為: [{$variablename}]除了在頁面裡顯示一個已有變數, 還可以在頁面裡使用SET定義頁面變數, 基本格式為: [{SET name=value}]
注意: 變數名是不區分大小寫的, "paGeNamE" 與 "PageName" 表示相同的變數.
使用Plugin
使用Plugin的基本格式如下:[{INSERT <plugin class=""></plugin> WHERE param1=value, param2=value, ...}]