|
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 #e2e2e2;
|
|
16
|
width: auto;
|
|
17
|
overflow-x: auto;
|
|
18
|
overflow-y: hidden;
|
|
19
|
}
|
|
20
|
a.new { color: #b73535; }
|
|
21
|
|
|
22
|
.syntaxhl .class { color:#258; font-weight:bold }
|
|
23
|
.syntaxhl .comment { color:#385; }
|
|
24
|
.syntaxhl .delimiter { color:black }
|
|
25
|
.syntaxhl .function { color:#06B; font-weight:bold }
|
|
26
|
.syntaxhl .inline { background-color: hsla(0,0%,0%,0.07); color: black }
|
|
27
|
.syntaxhl .inline-delimiter { font-weight: bold; color: #666 }
|
|
28
|
.syntaxhl .instance-variable { color:#33B }
|
|
29
|
.syntaxhl .keyword { color:#939; font-weight:bold }
|
|
30
|
.syntaxhl .string .content { color: #46a }
|
|
31
|
.syntaxhl .string .delimiter { color:#46a }
|
|
32
|
</style>
|
|
33
|
</head>
|
|
34
|
|
|
35
|
<body>
|
|
36
|
<h1><a name="1" class="wiki-page"></a>Wiki 格式設定</h1>
|
|
37
|
|
|
38
|
<h2><a name="2" class="wiki-page"></a>連結</h2>
|
|
39
|
|
|
40
|
<h3><a name="3" class="wiki-page"></a>Redmine 連結</h3>
|
|
41
|
|
|
42
|
<p>在任何可以使用 Wiki 格式設定的地方， Redmine 都允許在資源 （議題、變更集、 Wiki 頁面...） 間建立超連結。</p>
|
|
43
|
<ul>
|
|
44
|
<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>
|
|
45
|
<li>連結至一個議題的筆記： <strong>#124-6</strong>, 或 <strong>#124#note-6</strong></li>
|
|
46
|
</ul>
|
|
47
|
|
|
48
|
<p>Wiki 連結：</p>
|
|
49
|
|
|
50
|
<ul>
|
|
51
|
<li><strong>[[Guide]]</strong> 顯示一個頁面名稱為 'Guide' 的連結： <a href="#" class="wiki-page">Guide</a></li>
|
|
52
|
<li><strong>[[Guide#further-reading]]</strong> 會顯示連結至一個 "further-reading" 的 HTML 錨定 (anchor) 。每個標題文字都會被自動指定一個 HTML 錨定，以便您可以用來連結它們： <a href="#" class="wiki-page">Guide</a></li>
|
|
53
|
<li><strong>[[Guide|User manual]]</strong> 使用不同的文字來顯示一個頁面名稱為 'Guide' 的連結： <a href="#" class="wiki-page">User manual</a></li>
|
|
54
|
</ul>
|
|
55
|
|
|
56
|
<p>您也可以連結至其他專案的 Wiki 頁面：</p>
|
|
57
|
|
|
58
|
<ul>
|
|
59
|
<li><strong>[[sandbox:some page]]</strong> 顯示一個 Sanbox wiki 中頁面名稱為 'Some page' 的連結</li>
|
|
60
|
<li><strong>[[sandbox:]]</strong> 顯示 Sandbox wiki 首頁頁面的連結</li>
|
|
61
|
</ul>
|
|
62
|
|
|
63
|
<p>當頁面不存在的時候， Wiki 連結會以紅色的方式顯示，例如： <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
|
|
64
|
|
|
65
|
<p>連結至其他資源：</p>
|
|
66
|
|
|
67
|
<ul>
|
|
68
|
<li>文件：
|
|
69
|
<ul>
|
|
70
|
<li><strong>document#17</strong> (連結到編號為 17 的文件)</li>
|
|
71
|
<li><strong>document:Greetings</strong> (連結至文件標題為 "Greetings" 的文件)</li>
|
|
72
|
<li><strong>document:"Some document"</strong> (文件標題包含空白字元時可以使用雙引號來標示)</li>
|
|
73
|
<li><strong>sandbox:document:"Some document"</strong> (連結至另外一個 "sandbox" 專案中，文件標題為 "Some document" 的文件)</li>
|
|
74
|
</ul></li>
|
|
75
|
</ul>
|
|
76
|
|
|
77
|
<ul>
|
|
78
|
<li>版本：
|
|
79
|
<ul>
|
|
80
|
<li><strong>version#3</strong> (連結至編號為 3 的版本)</li>
|
|
81
|
<li><strong>version:1.0.0</strong> (連結至名稱為 "1.0.0" 的版本)</li>
|
|
82
|
<li><strong>version:"1.0 beta 2"</strong> (版本名稱包含空白字元時可以使用雙引號來標示)</li>
|
|
83
|
<li><strong>sandbox:version:1.0.0</strong> (連結至 "sandbox" 專案中，名稱為 "1.0.0" 的版本)</li>
|
|
84
|
</ul></li>
|
|
85
|
</ul>
|
|
86
|
|
|
87
|
<ul>
|
|
88
|
<li>附加檔案：
|
|
89
|
<ul>
|
|
90
|
<li><strong>attachment:file.zip</strong> (連結至目前物件中，名稱為 file.zip 的附加檔案)</li>
|
|
91
|
<li>目前僅提供參考到目前物件中的附加檔案 (若您正位於一個議題中，僅可參考位於此議題中之附加檔案)</li>
|
|
92
|
</ul></li>
|
|
93
|
</ul>
|
|
94
|
|
|
95
|
<ul>
|
|
96
|
<li>變更集：
|
|
97
|
<ul>
|
|
98
|
<li><strong>r758</strong> (連結至一個變更集)</li>
|
|
99
|
<li><strong>commit:c6f4d0fd</strong> (使用雜湊碼連結至一個變更集)</li>
|
|
100
|
<li><strong>svn1|r758</strong> (連結至指定儲存機制中之變更集，用於專案使用多個儲存機制時之情況)</li>
|
|
101
|
<li><strong>commit:hg|c6f4d0fd</strong> (使用某特定儲存機制中的雜湊碼連結至一個變更集)</li>
|
|
102
|
<li><strong>sandbox:r758</strong> (連結至其他專案的變更集)</li>
|
|
103
|
<li><strong>sandbox:commit:c6f4d0fd</strong> (使用其他專案的雜湊碼連結至一個變更集)</li>
|
|
104
|
</ul></li>
|
|
105
|
</ul>
|
|
106
|
|
|
107
|
<ul>
|
|
108
|
<li>儲存機制中之檔案：
|
|
109
|
<ul>
|
|
110
|
<li><strong>source:some/file</strong> (連結至專案儲存機制中，位於 /some/file 的檔案)</li>
|
|
111
|
<li><strong>source:some/file@52</strong> (連結至該檔案的 52 版次)</li>
|
|
112
|
<li><strong>source:some/file#L120</strong> (連結至該檔案的第 120 行)</li>
|
|
113
|
<li><strong>source:some/file@52#L120</strong> (連結至該檔案的 52 版次中之第 120 行)</li>
|
|
114
|
<li><strong>source:"some file@52#L120"</strong> (當 URL 中包含空白字元時，使用雙引號來標示)</li>
|
|
115
|
<li><strong>export:some/file</strong> (強制下載該檔案)</li>
|
|
116
|
<li><strong>source:svn1|some/file</strong> (連結至指定儲存機制中的該檔案，用於專案使用多個儲存機制時之情況)</li>
|
|
117
|
<li><strong>sandbox:source:some/file</strong> (連結至 "sandbox" 專案的儲存機制中，位於 /some/file 的檔案)</li>
|
|
118
|
<li><strong>sandbox:export:some/file</strong> (強迫下載該檔案)</li>
|
|
119
|
</ul></li>
|
|
120
|
</ul>
|
|
121
|
|
|
122
|
<ul>
|
|
123
|
<li>論壇：
|
|
124
|
<ul>
|
|
125
|
<li><strong>forum#1</strong> (連結至編號為 1 的論壇)</li>
|
|
126
|
<li><strong>forum:Support</strong> (連結至名稱為 Support 的論壇)</li>
|
|
127
|
<li><strong>forum:"Technical Support"</strong> (當論壇名稱中包含空白字元時，使用雙引號來標示)</li>
|
|
128
|
</ul></li>
|
|
129
|
</ul>
|
|
130
|
|
|
131
|
<ul>
|
|
132
|
<li>論壇訊息：
|
|
133
|
<ul>
|
|
134
|
<li><strong>message#1218</strong> (連結至編號為 1218 的訊息)</li>
|
|
135
|
</ul></li>
|
|
136
|
</ul>
|
|
137
|
|
|
138
|
<ul>
|
|
139
|
<li>專案：
|
|
140
|
<ul>
|
|
141
|
<li><strong>project#3</strong> (連結至編號為 3 的專案)</li>
|
|
142
|
<li><strong>project:someproject</strong> (連結至名稱為 "someproject" 的專案)</li>
|
|
143
|
<li><strong>project:"some project"</strong> (當專案名稱中包含空白字元時，使用雙引號來標示)</li>
|
|
144
|
</ul></li>
|
|
145
|
</ul>
|
|
146
|
|
|
147
|
<ul>
|
|
148
|
<li>新聞：
|
|
149
|
<ul>
|
|
150
|
<li><strong>news#2</strong> (連結至編號為 2 的新聞項目)</li>
|
|
151
|
<li><strong>news:Greetings</strong> (連結至名稱為 "Greetings" 的新聞項目)</li>
|
|
152
|
<li><strong>news:"First Release"</strong> (當新聞項目名稱中包含空白字元時，使用雙引號來標示)</li>
|
|
153
|
</ul></li>
|
|
154
|
</ul>
|
|
155
|
|
|
156
|
<p>逸出字元：</p>
|
|
157
|
|
|
158
|
<ul>
|
|
159
|
<li>您可以在文字的前面加上驚嘆號 (!) 來避免該文字被剖析成 Redmine 連結</li>
|
|
160
|
</ul>
|
|
161
|
|
|
162
|
|
|
163
|
<h3><a name="4" class="wiki-page"></a>外部連結</h3>
|
|
164
|
|
|
165
|
<p>HTTP URLs 與電子郵件地址會自動被轉換成可被點擊的連結：</p>
|
|
166
|
|
|
167
|
<pre>
|
|
168
|
http://www.redmine.org, someone@foo.bar
|
|
169
|
</pre>
|
|
170
|
|
|
171
|
<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>
|
|
172
|
|
|
173
|
<p>若您想要顯示指定的文字而非該 URL ，您可以使用下列標準的 textile 語法:</p>
|
|
174
|
|
|
175
|
<pre>
|
|
176
|
"Redmine web site":http://www.redmine.org
|
|
177
|
</pre>
|
|
178
|
|
|
179
|
<p>會顯示成： <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
|
|
180
|
|
|
181
|
|
|
182
|
<h2><a name="5" class="wiki-page"></a>文字格式設定</h2>
|
|
183
|
|
|
184
|
|
|
185
|
<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>
|
|
186
|
|
|
187
|
<h3><a name="6" class="wiki-page"></a>字型樣式</h3>
|
|
188
|
|
|
189
|
<pre>
|
|
190
|
* *粗體*
|
|
191
|
* _斜體_
|
|
192
|
* _*粗斜體*_
|
|
193
|
* +底線+
|
|
194
|
* -刪除線-
|
|
195
|
</pre>
|
|
196
|
|
|
197
|
<p>會顯示成：</p>
|
|
198
|
|
|
199
|
<ul>
|
|
200
|
<li><strong>粗體</strong></li>
|
|
201
|
<li><em>斜體</em></li>
|
|
202
|
<li><em><strong>粗斜體</strong></em></li>
|
|
203
|
<li><ins>底線</ins></li>
|
|
204
|
<li><del>刪除線</del></li>
|
|
205
|
</ul>
|
|
206
|
|
|
207
|
<h3><a name="7" class="wiki-page"></a>內嵌圖像</h3>
|
|
208
|
|
|
209
|
<ul>
|
|
210
|
<li><strong>!image_url!</strong> 顯示一個位於 image_url 位址的圖像 (textile 語法)</li>
|
|
211
|
<li><strong>!>image_url!</strong> 右側浮動圖像</li>
|
|
212
|
<li>若您附加了一個圖像到 Wiki 頁面中，可以使用他的檔案名稱來顯示成內嵌圖像： <strong>!attached_image.png!</strong></li>
|
|
213
|
</ul>
|
|
214
|
|
|
215
|
<h3><a name="8" class="wiki-page"></a>標題</h3>
|
|
216
|
|
|
217
|
<pre>
|
|
218
|
h1. 標題
|
|
219
|
h2. 次標題
|
|
220
|
h3. 次次標題
|
|
221
|
</pre>
|
|
222
|
|
|
223
|
<p>Redmine 為每一種標題指定一個 HTML 錨定 (anchor) ，因此您可使用 "#標題" 、 "#次標題" 等方式連結至這些標題。</p>
|
|
224
|
|
|
225
|
|
|
226
|
<h3><a name="9" class="wiki-page"></a>段落</h3>
|
|
227
|
|
|
228
|
<pre>
|
|
229
|
p>. 靠右對齊
|
|
230
|
p=. 置中對齊
|
|
231
|
</pre>
|
|
232
|
|
|
233
|
<p style="text-align:center;">這是一個置中對齊的段落。</p>
|
|
234
|
|
|
235
|
|
|
236
|
<h3><a name="10" class="wiki-page"></a>區塊引述</h3>
|
|
237
|
|
|
238
|
<p>使用 <strong>bq.</strong> 啟動一個區塊引述的段落。</p>
|
|
239
|
|
|
240
|
<pre>
|
|
241
|
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
|
242
|
To go live, all you need to add is a database and a web server.
|
|
243
|
</pre>
|
|
244
|
|
|
245
|
<p>顯示為：</p>
|
|
246
|
|
|
247
|
<blockquote>
|
|
248
|
<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>
|
|
249
|
</blockquote>
|
|
250
|
|
|
251
|
|
|
252
|
<h3><a name="11" class="wiki-page"></a>目錄</h3>
|
|
253
|
|
|
254
|
<pre>
|
|
255
|
{{toc}} => 靠左對齊目錄
|
|
256
|
{{>toc}} => 靠右對齊目錄
|
|
257
|
</pre>
|
|
258
|
|
|
259
|
<h3><a name="14" class="wiki-page"></a>水平線</h3>
|
|
260
|
|
|
261
|
<pre>
|
|
262
|
---
|
|
263
|
</pre>
|
|
264
|
|
|
265
|
<h2><a name="12" class="wiki-page"></a>巨集</h2>
|
|
266
|
|
|
267
|
<p>Redmine 內建下列巨集：</p>
|
|
268
|
|
|
269
|
<p>
|
|
270
|
<dl>
|
|
271
|
<dt><code>hello_world</code></dt>
|
|
272
|
<dd><p>範例巨集。</p></dd>
|
|
273
|
|
|
274
|
<dt><code>macro_list</code></dt>
|
|
275
|
<dd><p>顯示所有可用巨集的清單，若巨集有提供說明也會一併顯示。</p></dd>
|
|
276
|
|
|
277
|
<dt><code>child_pages</code></dt>
|
|
278
|
<dd><p>顯示子頁面的清單。若未指定參數，它將會顯示目前 Wiki 頁面的子頁面清單。範例：</p>
|
|
279
|
<pre><code>{{child_pages}} -- 僅可於某 Wiki 頁面中被使用
|
|
280
|
{{child_pages(depth=2)}} -- 僅顯示兩層巢狀層次</code></pre></dd>
|
|
281
|
|
|
282
|
<dt><code>include</code></dt>
|
|
283
|
<dd><p>引入一個 wiki 頁面。範例：</p>
|
|
284
|
<pre><code>{{include(Foo)}}</code></pre>
|
|
285
|
<p>或用以引入某特定專案的 Wiki 頁面：</p>
|
|
286
|
<pre><code>{{include(projectname:Foo)}}</code></pre></dd>
|
|
287
|
|
|
288
|
<dt><code>collapse</code></dt>
|
|
289
|
<dd><p>插入一個摺疊的文字區塊。範例：</p>
|
|
290
|
<pre><code>{{collapse(View details...)
|
|
291
|
This is a block of text that is collapsed by default.
|
|
292
|
It can be expanded by clicking a link.
|
|
293
|
}}</code></pre></dd>
|
|
294
|
|
|
295
|
<dt><code>thumbnail</code></dt>
|
|
296
|
<dd><p>顯示可被點擊的附加圖像之縮圖。範例：</p>
|
|
297
|
<pre>{{thumbnail(image.png)}}
|
|
298
|
{{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
|
|
299
|
</dl>
|
|
300
|
</p>
|
|
301
|
|
|
302
|
<h2><a name="13" class="wiki-page"></a>程式碼醒目提示</h2>
|
|
303
|
|
|
304
|
<p>預設使用 <a href="http://coderay.rubychan.de/" class="external">CodeRay</a> 作為程式碼醒目提示的機制，它是一個使用 Ruby 撰寫的語法醒目提示函式庫。目前支援 c, clojure, cpp (c++, cplusplus), css, delphi (pascal), diff (patch), erb (eruby, rhtml), go, groovy, haml, html (xhtml), java, javascript (ecmascript, ecma_script, java_script, js), json, lua, php, python, ruby (irb), sass, sql, taskpaper, text (plain, plaintext), xml and yaml (yml) 等語言，括弧中的名稱是該語言的別名。</p>
|
|
305
|
|
|
306
|
<p>您可載任何支援 Wiki 格式設定的地方，使用這個語法來醒目提示程式碼 (注意語言與其別名的名稱不須區分大小寫)：</p>
|
|
307
|
|
|
308
|
<pre>
|
|
309
|
<pre><code class="ruby">
|
|
310
|
將程式碼放在這裡。
|
|
311
|
</code></pre>
|
|
312
|
</pre>
|
|
313
|
|
|
314
|
<p>範例：</p>
|
|
315
|
|
|
316
|
<pre><code class="ruby syntaxhl"><span class="CodeRay"><span class="comment"># The Greeter class</span>
|
|
317
|
<span class="keyword">class</span> <span class="class">Greeter</span>
|
|
318
|
<span class="keyword">def</span> <span class="function">initialize</span>(name)
|
|
319
|
<span class="instance-variable">@name</span> = name.capitalize
|
|
320
|
<span class="keyword">end</span>
|
|
321
|
|
|
322
|
<span class="keyword">def</span> <span class="function">salute</span>
|
|
323
|
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>
|
|
324
|
<span class="keyword">end</span>
|
|
325
|
<span class="keyword">end</span></span></code>
|
|
326
|
</pre>
|
|
327
|
</body>
|
|
328
|
</html>
|