You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

wiki_syntax_detailed_textile.html 15KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
  3. <head>
  4. <title>RedmineWikiFormatting</title>
  5. <meta http-equiv="content-type" content="text/html; charset=utf-8" />
  6. <style type="text/css">
  7. body { font:80% Verdana,Tahoma,Arial,sans-serif; }
  8. h1, h2, h3, h4 { font-family: Trebuchet MS,Georgia,"Times New Roman",serif; }
  9. pre, code { font-size:120%; }
  10. pre code { font-size:100%; }
  11. pre {
  12. margin: 1em 1em 1em 1.6em;
  13. padding: 2px;
  14. background-color: #fafafa;
  15. border: 1px solid #dadada;
  16. width:95%;
  17. overflow-x: auto;
  18. }
  19. a.new { color: #b73535; }
  20. .syntaxhl .line-numbers { padding: 2px 4px 2px 4px; background-color: #eee; margin:0 }
  21. .syntaxhl .comment { color:#666; }
  22. .syntaxhl .class { color:#B06; font-weight:bold }
  23. .syntaxhl .delimiter { color:black }
  24. .syntaxhl .function { color:#06B; font-weight:bold }
  25. .syntaxhl .inline { background: #eee }
  26. .syntaxhl .inline .inline-delimiter { font-weight: bold; color: #888 }
  27. .syntaxhl .instance-variable { color:#33B }
  28. .syntaxhl .reserved { color:#080; font-weight:bold }
  29. .syntaxhl .string { background-color:#fff0f0; color: #D20; }
  30. .syntaxhl .string .delimiter { color:#710 }
  31. </style>
  32. </head>
  33. <body>
  34. <h1><a name="1" class="wiki-page"></a>Wiki 格式設定</h1>
  35. <h2><a name="2" class="wiki-page"></a>連結</h2>
  36. <h3><a name="3" class="wiki-page"></a>Redmine 連結</h3>
  37. <p>在任何可以使用 Wiki 格式設定的地方, Redmine 都允許在資源(問題、變更集、 Wiki 頁面...)間建立超連結。</p>
  38. <ul>
  39. <li>連結至一個問題: <strong>#124</strong> (若該問題已經結束,則使用刪除線顯示連結: <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>)</li>
  40. <li>連結至一個問題的筆記: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
  41. </ul>
  42. <p>Wiki 連結:</p>
  43. <ul>
  44. <li><strong>[[Guide]]</strong> 顯示一個頁面名稱為 'Guide' 的連結: <a href="#" class="wiki-page">Guide</a></li>
  45. <li><strong>[[Guide#further-reading]]</strong> 會連結至一個 "further-reading" 的 HTML 錨定 (anchor) 。每個標題文字都會被自動指定一個 HTML 錨定,以便您可以用來連結它們: <a href="#" class="wiki-page">Guide</a></li>
  46. <li><strong>[[Guide|User manual]]</strong> 使用不同的文字來顯示一個頁面名稱為 'Guide' 的連結: <a href="#" class="wiki-page">User manual</a></li>
  47. </ul>
  48. <p>您也可以連結至其他專案的 Wiki 頁面:</p>
  49. <ul>
  50. <li><strong>[[sandbox:some page]]</strong> 顯示一個 Sanbox wiki 中頁面名稱為 'Some page' 的連結</li>
  51. <li><strong>[[sandbox:]]</strong> 顯示 Sandbox wiki 首頁頁面的連結</li>
  52. </ul>
  53. <p>當頁面不存在的時候, Wiki 連結會以紅色的方式顯示,例如: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
  54. <p>連結至其他資源:</p>
  55. <ul>
  56. <li>文件:
  57. <ul>
  58. <li><strong>document#17</strong> (連結到編號為 17 的文件)</li>
  59. <li><strong>document:Greetings</strong> (連結至文件標題為 "Greetings" 的文件)</li>
  60. <li><strong>document:"Some document"</strong> (文件標題包含空白字元時可以使用雙引號來標示)</li>
  61. <li><strong>sandbox:document:"Some document"</strong> (連結至另外一個 "sandbox" 專案中,文件標題為 "Some document" 的文件)</li>
  62. </ul></li>
  63. </ul>
  64. <ul>
  65. <li>版本:
  66. <ul>
  67. <li><strong>version#3</strong> (連結至編號為 3 的版本)</li>
  68. <li><strong>version:1.0.0</strong> (連結至名稱為 "1.0.0" 的版本)</li>
  69. <li><strong>version:"1.0 beta 2"</strong> (版本名稱包含空白字元時可以使用雙引號來標示)</li>
  70. <li><strong>sandbox:version:1.0.0</strong> (連結至 "sandbox" 專案中,名稱為 "1.0.0" 的版本)</li>
  71. </ul></li>
  72. </ul>
  73. <ul>
  74. <li>附加檔案:
  75. <ul>
  76. <li><strong>attachment:file.zip</strong> (連結至目前物件中,名稱為 file.zip 的附加檔案)</li>
  77. <li>目前僅提供參考到目前物件中的附加檔案 (若您正位於一個問題中,僅可參考位於此問題中之附加檔案)</li>
  78. </ul></li>
  79. </ul>
  80. <ul>
  81. <li>變更集:
  82. <ul>
  83. <li><strong>r758</strong> (連結至一個變更集)</li>
  84. <li><strong>commit:c6f4d0fd</strong> (連結至一個使用非數字雜湊的變更集)</li>
  85. <li><strong>svn1|r758</strong> (連結至指定儲存機制中之變更集,用於專案使用多個儲存機制時之情況)</li>
  86. <li><strong>commit:hg|c6f4d0fd</strong> (連結至指定儲存機制中,使用非數字雜湊的變更集)</li>
  87. <li><strong>sandbox:r758</strong> (連結至其他專案的變更集)</li>
  88. <li><strong>sandbox:commit:c6f4d0fd</strong> (連結至其他專案中,使用非數字雜湊的變更集)</li>
  89. </ul></li>
  90. </ul>
  91. <ul>
  92. <li>儲存機制中之檔案:
  93. <ul>
  94. <li><strong>source:some/file</strong> (連結至專案儲存機制中,位於 /some/file 的檔案)</li>
  95. <li><strong>source:some/file@52</strong> (連結至此檔案的 52 版次)</li>
  96. <li><strong>source:some/file#L120</strong> (連結至此檔案的第 120 行)</li>
  97. <li><strong>source:some/file@52#L120</strong> (連結至此檔案的 52 版刺中之第 120 行)</li>
  98. <li><strong>source:"some file@52#L120"</strong> (當 URL 中包含空白字元時,使用雙引號來標示)</li>
  99. <li><strong>export:some/file</strong> (強制下載此檔案)</li>
  100. <li><strong>source:svn1|some/file</strong> (連結至指定儲存機制中的此檔案,用於專案使用多個儲存機制時之情況)</li>
  101. <li><strong>sandbox:source:some/file</strong> (連結至 "sandbox" 專案的儲存機制中,位於 /some/file 的檔案)</li>
  102. <li><strong>sandbox:export:some/file</strong> (強迫下載該檔案)</li>
  103. </ul></li>
  104. </ul>
  105. <ul>
  106. <li>Forums:
  107. <ul>
  108. <li><strong>forum#1</strong> (link to forum with id 1</li>
  109. <li><strong>forum:Support</strong> (link to forum named Support)</li>
  110. <li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
  111. </ul></li>
  112. </ul>
  113. <ul>
  114. <li>論壇訊息:
  115. <ul>
  116. <li><strong>message#1218</strong> (連結至編號 1218 的訊息)</li>
  117. </ul></li>
  118. </ul>
  119. <ul>
  120. <li>專案:
  121. <ul>
  122. <li><strong>project#3</strong> (連結至編號為 3 的專案)</li>
  123. <li><strong>project:someproject</strong> (連結至名稱為 "someproject" 的專案)</li>
  124. <li><strong>project:"some project"</strong> (use double quotes if project name contains spaces)</li>
  125. </ul></li>
  126. </ul>
  127. <ul>
  128. <li>News:
  129. <ul>
  130. <li><strong>news#2</strong> (link to news item with id 2)</li>
  131. <li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
  132. <li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
  133. </ul></li>
  134. </ul>
  135. <p>逸出字元:</p>
  136. <ul>
  137. <li>您可以在文字的前面加上驚嘆號 (!) 來避免該文字被剖析成 Redmine 連結</li>
  138. </ul>
  139. <h3><a name="4" class="wiki-page"></a>外部連結</h3>
  140. <p>HTTP URLs 與電子郵件地址會自動被轉換成可被點擊的連結:</p>
  141. <pre>
  142. http://www.redmine.org, someone@foo.bar
  143. </pre>
  144. <p>顯示為: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
  145. <p>若您想要顯示指定的文字而非該 URL ,您可以使用下列標準的 textile 語法:</p>
  146. <pre>
  147. "Redmine web site":http://www.redmine.org
  148. </pre>
  149. <p>顯示為: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
  150. <h2><a name="5" class="wiki-page"></a>文字格式設定</h2>
  151. <p>對於諸如標題、粗體、表格、清單等項目, Redmine 支援使用 Textile 語法。可參考 <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> 中關於使用這些格式化功能的說明資訊。 下面包含了一些使用範例,但格式化引擎的處理能力遠多於這些簡單的使用範例。</p>
  152. <h3><a name="6" class="wiki-page"></a>字型樣式</h3>
  153. <pre>
  154. * *粗體*
  155. * _斜體_
  156. * _*粗斜體*_
  157. * +底線+
  158. * -刪除線-
  159. </pre>
  160. <p>顯示為:</p>
  161. <ul>
  162. <li><strong>粗體</strong></li>
  163. <li><em>斜體</em></li>
  164. <li><em><strong>粗斜體</strong></em></li>
  165. <li><ins>底線</ins></li>
  166. <li><del>刪除線</del></li>
  167. </ul>
  168. <h3><a name="7" class="wiki-page"></a>內置圖像</h3>
  169. <ul>
  170. <li><strong>!圖像_url!</strong> 顯示一個位於 圖像_url 位址的圖像(textile 語法)</li>
  171. <li><strong>!&gt;image_url!</strong> 右側浮動圖像</li>
  172. <li>若您附加了一個圖像到 Wiki 頁面中,可以使用他的檔案名稱來顯示成內置圖像: <strong>!attached_image.png!</strong></li>
  173. </ul>
  174. <h3><a name="8" class="wiki-page"></a>標題</h3>
  175. <pre>
  176. h1. 標題
  177. h2. 次標題
  178. h3. 次次標題
  179. </pre>
  180. <p>Redmine 為每一種標題指定一個 HTML 錨定 (anchor) ,因此您可使用 "#Heading" 、 "#Subheading" 等方式連結至這些標題。</p>
  181. <h3><a name="9" class="wiki-page"></a>段落</h3>
  182. <pre>
  183. p&gt;. 靠右對齊
  184. p=. 置中對齊
  185. </pre>
  186. <p style="text-align:center;">這是一個置中對齊的段落。</p>
  187. <h3><a name="10" class="wiki-page"></a>引用文字</h3>
  188. <p>使用 <strong>bq.</strong> 開始一個引文的段落</p>
  189. <pre>
  190. bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
  191. To go live, all you need to add is a database and a web server.
  192. </pre>
  193. <p>顯示為:</p>
  194. <blockquote>
  195. <p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
  196. </blockquote>
  197. <h3><a name="11" class="wiki-page"></a>目錄</h3>
  198. <pre>
  199. {{toc}} =&gt; 靠左對齊目錄
  200. {{&gt;toc}} =&gt; 靠右對齊目錄
  201. </pre>
  202. <h3><a name="14" class="wiki-page"></a>水平線</h3>
  203. <pre>
  204. ---
  205. </pre>
  206. <h2><a name="12" class="wiki-page"></a>巨集</h2>
  207. <p>Redmine 內建下列巨集:</p>
  208. <p>
  209. <dl>
  210. <dt><code>hello_world</code></dt>
  211. <dd><p>範例巨集。</p></dd>
  212. <dt><code>macro_list</code></dt>
  213. <dd><p>顯示所有可用巨集的清單,若巨集有提供說明也會一併顯示。</p></dd>
  214. <dt><code>child_pages</code></dt>
  215. <dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
  216. <pre><code>{{child_pages}} -- can be used from a wiki page only
  217. {{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
  218. <dt><code>include</code></dt>
  219. <dd><p>引入一個 wiki 頁面。例子:</p>
  220. <pre><code>{{include(Foo)}}</code></pre>
  221. <p>or to include a page of a specific project wiki:</p>
  222. <pre><code>{{include(projectname:Foo)}}</code></pre></dd>
  223. <dt><code>collapse</code></dt>
  224. <dd><p>Inserts of collapsed block of text. Example:</p>
  225. <pre><code>{{collapse(View details...)
  226. This is a block of text that is collapsed by default.
  227. It can be expanded by clicking a link.
  228. }}</code></pre></dd>
  229. <dt><code>thumbnail</code></dt>
  230. <dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
  231. <pre>{{thumbnail(image.png)}}
  232. {{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
  233. </dl>
  234. </p>
  235. <h2><a name="13" class="wiki-page"></a>程式碼醒目提示</h2>
  236. <p>預設使用 <a href="http://coderay.rubychan.de/" class="external">CodeRay</a> 作為程式碼醒目提示的機制,它是一個使用 Ruby 撰寫的語法醒目提示函式庫。它目前支援 c 、 cpp 、 css 、 delphi 、 groovy 、 html 、 java 、 javascript 、 json 、 php 、 python 、 rhtml 、 ruby 、 scheme 、 sql 、 xml 與 yaml 等程式語言。</p>
  237. <p>您可以使用下列語法,在 Wiki 頁面中將程式碼標示為醒目提示:</p>
  238. <pre>
  239. &lt;pre&gt;&lt;code class="ruby"&gt;
  240. 將程式碼放在這裡。
  241. &lt;/code&gt;&lt;/pre&gt;
  242. </pre>
  243. <p>例子:</p>
  244. <pre><code class="ruby syntaxhl"><span class="line-numbers"> 1</span> <span class="comment"># The Greeter class</span>
  245. <span class="line-numbers"> 2</span> <span class="reserved">class</span> <span class="class">Greeter</span>
  246. <span class="line-numbers"> 3</span> <span class="reserved">def</span> <span class="function">initialize</span>(name)
  247. <span class="line-numbers"> 4</span> <span class="instance-variable">@name</span> = name.capitalize
  248. <span class="line-numbers"> 5</span> <span class="reserved">end</span>
  249. <span class="line-numbers"> 6</span>
  250. <span class="line-numbers"> 7</span> <span class="reserved">def</span> <span class="function">salute</span>
  251. <span class="line-numbers"> 8</span> puts <span class="string"><span class="delimiter">"</span><span class="content">Hello </span><span class="inline"><span class="inline-delimiter">#{</span><span class="instance-variable">@name</span><span class="inline-delimiter">}</span></span><span class="content">!</span><span class="delimiter">"</span></span>
  252. <span class="line-numbers"> 9</span> <span class="reserved">end</span>
  253. <span class="line-numbers"><strong>10</strong></span> <span class="reserved">end</span></code>
  254. </pre>
  255. </body>
  256. </html>