@@ -1,328 +1,328 | |||
|
1 | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
|
2 | 2 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> |
|
3 | 3 | <head> |
|
4 | 4 | <title>RedmineWikiFormatting</title> |
|
5 | 5 | <meta http-equiv="content-type" content="text/html; charset=utf-8" /> |
|
6 | 6 | <style type="text/css"> |
|
7 | 7 | body { font:80% Verdana,Tahoma,Arial,sans-serif; } |
|
8 | 8 | h1, h2, h3, h4 { font-family: Trebuchet MS,Georgia,"Times New Roman",serif; } |
|
9 | 9 | pre, code { font-size:120%; } |
|
10 | 10 | pre code { font-size:100%; } |
|
11 | 11 | pre { |
|
12 | 12 | margin: 1em 1em 1em 1.6em; |
|
13 | 13 | padding: 2px; |
|
14 | 14 | background-color: #fafafa; |
|
15 | 15 | border: 1px solid #e2e2e2; |
|
16 | 16 | width: auto; |
|
17 | 17 | overflow-x: auto; |
|
18 | 18 | overflow-y: hidden; |
|
19 | 19 | } |
|
20 | 20 | a.new { color: #b73535; } |
|
21 | 21 | |
|
22 | 22 | .syntaxhl .class { color:#258; font-weight:bold } |
|
23 | 23 | .syntaxhl .comment { color:#385; } |
|
24 | 24 | .syntaxhl .delimiter { color:black } |
|
25 | 25 | .syntaxhl .function { color:#06B; font-weight:bold } |
|
26 | 26 | .syntaxhl .inline { background-color: hsla(0,0%,0%,0.07); color: black } |
|
27 | 27 | .syntaxhl .inline-delimiter { font-weight: bold; color: #666 } |
|
28 | 28 | .syntaxhl .instance-variable { color:#33B } |
|
29 | 29 | .syntaxhl .keyword { color:#939; font-weight:bold } |
|
30 | 30 | .syntaxhl .string .content { color: #46a } |
|
31 | 31 | .syntaxhl .string .delimiter { color:#46a } |
|
32 | 32 | </style> |
|
33 | 33 | </head> |
|
34 | 34 | |
|
35 | 35 | <body> |
|
36 | 36 | <h1><a name="1" class="wiki-page"></a>Wiki 文本格式</h1> |
|
37 | 37 | |
|
38 | 38 | <h2><a name="2" class="wiki-page"></a>链接</h2> |
|
39 | 39 | |
|
40 | 40 | <h3><a name="3" class="wiki-page"></a>Redmine 链接</h3> |
|
41 | 41 | |
|
42 | 42 | <p>在任何使用文本格式的地方,Redmine都允许在资源(问题、变更、wiki页面...)间建立超链接。</p> |
|
43 | 43 | <ul> |
|
44 | 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 | 45 | <li>链接至一个问题的说明: <strong>#124-6</strong>, 或者 <strong>#124#note-6</strong></li> |
|
46 | 46 | </ul> |
|
47 | 47 | |
|
48 | 48 | <p>Wiki链接</p> |
|
49 | 49 | |
|
50 | 50 | <ul> |
|
51 | 51 | <li><strong>[[Guide]]</strong> 显示一个页面名为'Guide'的链接: <a href="#" class="wiki-page">Guide</a></li> |
|
52 | 52 | <li><strong>[[Guide#further-reading]]</strong> 链接到页面内的"further-reading"标签. 每个标题都会自动绑定一个标签,方便您进行链接: <a href="#" class="wiki-page">Guide</a></li> |
|
53 | 53 | <li><strong>[[Guide|User manual]]</strong> 使用不同的文字来显示一个页面名称为'Guide'的链接: <a href="#" class="wiki-page">User manual</a></li> |
|
54 | 54 | </ul> |
|
55 | 55 | |
|
56 | 56 | <p>您也可以链接到其他项目的Wiki页面(使用项目标识):</p> |
|
57 | 57 | |
|
58 | 58 | <ul> |
|
59 | 59 | <li><strong>[[sandbox:some page]]</strong> 显示Sandbox项目wiki页面的一个名为'Some page'的链接</li> |
|
60 | 60 | <li><strong>[[sandbox:]]</strong> 显示Sandbox项目wiki首页的链接</li> |
|
61 | 61 | </ul> |
|
62 | 62 | |
|
63 | 63 | <p>当页面不存在的时候,Wiki链接会以红色来显示,例如: <a href="#" class="wiki-page new">Nonexistent page</a>.</p> |
|
64 | 64 | |
|
65 | 65 | <p>链接至其他资源:</p> |
|
66 | 66 | |
|
67 | 67 | <ul> |
|
68 | 68 | <li>文档: |
|
69 | 69 | <ul> |
|
70 | 70 | <li><strong>document#17</strong> (链接到id为17的文档)</li> |
|
71 | 71 | <li><strong>document:Greetings</strong> (链接到标题为“Greeting”的文档)</li> |
|
72 | 72 | <li><strong>document:"Some document"</strong> (文档标题包含空格时使用双引号来表示)</li> |
|
73 | 73 | <li><strong>sandbox:document:"Some document"</strong> (链接至sandbox项目中标题为“Some document”的文档)</li> |
|
74 | 74 | </ul></li> |
|
75 | 75 | </ul> |
|
76 | 76 | |
|
77 | 77 | <ul> |
|
78 | 78 | <li>版本: |
|
79 | 79 | <ul> |
|
80 | 80 | <li><strong>version#3</strong> (链接至id为3的版本)</li> |
|
81 | 81 | <li><strong>version:1.0.0</strong> (链接到名称为“1.0.0”的版本)</li> |
|
82 | 82 | <li><strong>version:"1.0 beta 2"</strong>(版本名称包含空格时使用双引号来表示)</li> |
|
83 | 83 | <li><strong>sandbox:version:1.0.0</strong> (连接至sandbox项目中的“1.0.0”版本)</li> |
|
84 | 84 | </ul></li> |
|
85 | 85 | </ul> |
|
86 | 86 | |
|
87 | 87 | <ul> |
|
88 | 88 | <li>附件: |
|
89 | 89 | <ul> |
|
90 | 90 | <li><strong>attachment:file.zip</strong> (链接至当前页面下名为file.zip的附件)</li> |
|
91 | 91 | <li>目前,只有当前页面下的附件能够被引用(如果您在一个问题中,则仅可以引用此问题下的附件)</li> |
|
92 | 92 | </ul></li> |
|
93 | 93 | </ul> |
|
94 | 94 | |
|
95 | 95 | <ul> |
|
96 | 96 | <li>变更集: |
|
97 | 97 | <ul> |
|
98 | 98 | <li><strong>r758</strong> (链接至一个变更集)</li> |
|
99 | 99 | <li><strong>commit:c6f4d0fd</strong> (链接至一个非数字哈希的变更集)</li> |
|
100 | 100 | <li><strong>svn1|r758</strong> (链接至指定版本库中的变更集,用于使用多个版本库的项目)</li> |
|
101 | 101 | <li><strong>commit:hg|c6f4d0fd</strong> (链接至指定版本库中,使用非数字哈希的变更集,此例子中是"hg"版本库下的哈希变更集)</li> |
|
102 | 102 | <li><strong>sandbox:r758</strong> (链接至其他项目的变更集)</li> |
|
103 | 103 | <li><strong>sandbox:commit:c6f4d0fd</strong> (链接至其他项目中,使用非数字哈希的变更集)</li> |
|
104 | 104 | </ul></li> |
|
105 | 105 | </ul> |
|
106 | 106 | |
|
107 | 107 | <ul> |
|
108 | 108 | <li>版本库文件: |
|
109 | 109 | <ul> |
|
110 | 110 | <li><strong>source:some/file</strong> (链接至项目版本库中位于/some/file的文件)</li> |
|
111 | 111 | <li><strong>source:some/file@52</strong> (链接至此文件的第52版)</li> |
|
112 | 112 | <li><strong>source:some/file#L120</strong> (链接至此文件的第120行)</li> |
|
113 | 113 | <li><strong>source:some/file@52#L120</strong> (链接至此文件的第52版的第120行)</li> |
|
114 | 114 | <li><strong>source:"some file@52#L120"</strong> (当URL中包含空格时使用双引号来表示)</li> |
|
115 | 115 | <li><strong>export:some/file</strong> (强制下载此文件,而不是在页面上查看)</li> |
|
116 | 116 | <li><strong>source:svn1|some/file</strong> (链接至指定版本库中的文件, 用于使用多个版本库的项目)</li> |
|
117 | 117 | <li><strong>sandbox:source:some/file</strong> (链接至"sandbox"项目的版本库中位于/some/file的文件)</li> |
|
118 | 118 | <li><strong>sandbox:export:some/file</strong> (强制下载"sandbox"项目的版本库中位于/some/file的文件,而不是在页面上查看)</li> |
|
119 | 119 | </ul></li> |
|
120 | 120 | </ul> |
|
121 | 121 | |
|
122 | 122 | <ul> |
|
123 | 123 | <li>Forums: |
|
124 | 124 | <ul> |
|
125 | 125 | <li><strong>forum#1</strong> (link to forum with id 1</li> |
|
126 | 126 | <li><strong>forum:Support</strong> (link to forum named Support)</li> |
|
127 | 127 | <li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li> |
|
128 | 128 | </ul></li> |
|
129 | 129 | </ul> |
|
130 | 130 | |
|
131 | 131 | <ul> |
|
132 | 132 | <li>论坛消息: |
|
133 | 133 | <ul> |
|
134 | 134 | <li><strong>message#1218</strong> (链接至id为1218的论坛消息)</li> |
|
135 | 135 | </ul></li> |
|
136 | 136 | </ul> |
|
137 | 137 | |
|
138 | 138 | <ul> |
|
139 | 139 | <li>项目: |
|
140 | 140 | <ul> |
|
141 | 141 | <li><strong>project#3</strong> (链接至id为3的项目)</li> |
|
142 |
<li><strong>project:some |
|
|
142 | <li><strong>project:someproject</strong> (链接至名称为"someproject"的项目)</li> | |
|
143 | 143 | <li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li> |
|
144 | 144 | </ul></li> |
|
145 | 145 | </ul> |
|
146 | 146 | |
|
147 | 147 | <ul> |
|
148 | 148 | <li>News: |
|
149 | 149 | <ul> |
|
150 | 150 | <li><strong>news#2</strong> (link to news item with id 2)</li> |
|
151 | 151 | <li><strong>news:Greetings</strong> (link to news item named "Greetings")</li> |
|
152 | 152 | <li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li> |
|
153 | 153 | </ul></li> |
|
154 | 154 | </ul> |
|
155 | 155 | |
|
156 | 156 | <p>转义字符:</p> |
|
157 | 157 | |
|
158 | 158 | <ul> |
|
159 | 159 | <li>您可以在文本的前面加上感叹号(!)来避免该文本被解析成Redmine链接</li> |
|
160 | 160 | </ul> |
|
161 | 161 | |
|
162 | 162 | |
|
163 | 163 | <h3><a name="4" class="wiki-page"></a>外部链接</h3> |
|
164 | 164 | |
|
165 | 165 | <p>HTTP链接和Email地址可以被自动转换成可点击的链接: </p> |
|
166 | 166 | |
|
167 | 167 | <pre> |
|
168 | 168 | http://www.redmine.org, someone@foo.bar |
|
169 | 169 | </pre> |
|
170 | 170 | |
|
171 | 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 | 172 | |
|
173 | 173 | <p>如果您想要显示指定的文本而不是链接,您可以通过下列标准的 textile 语法:</p> |
|
174 | 174 | |
|
175 | 175 | <pre> |
|
176 | 176 | "Redmine 官网":http://www.redmine.org |
|
177 | 177 | </pre> |
|
178 | 178 | |
|
179 | 179 | <p>显示为: <a href="http://www.redmine.org" class="external">Redmine 官网</a></p> |
|
180 | 180 | |
|
181 | 181 | |
|
182 | 182 | <h2><a name="5" class="wiki-page"></a>字体格式</h2> |
|
183 | 183 | |
|
184 | 184 | |
|
185 | 185 | <p>对于像是标题、粗体、表格、列表等文字格式, Redmine 支持使用 <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> 查找关于使用这些特性的信息。下面将展示其中的一些常用的语法。</p> |
|
186 | 186 | |
|
187 | 187 | <h3><a name="6" class="wiki-page"></a>字体风格</h3> |
|
188 | 188 | |
|
189 | 189 | <pre> |
|
190 | 190 | * *粗体* |
|
191 | 191 | * _斜体_ |
|
192 | 192 | * _*粗体 斜体*_ |
|
193 | 193 | * +下划线+ |
|
194 | 194 | * -中划线- |
|
195 | 195 | </pre> |
|
196 | 196 | |
|
197 | 197 | <p>显示为:</p> |
|
198 | 198 | |
|
199 | 199 | <ul> |
|
200 | 200 | <li><strong>粗体</strong></li> |
|
201 | 201 | <li><em>斜体</em></li> |
|
202 | 202 | <li><em><strong>粗体 斜体</strong></em></li> |
|
203 | 203 | <li><ins>下划线</ins></li> |
|
204 | 204 | <li><del>中划线</del></li> |
|
205 | 205 | </ul> |
|
206 | 206 | |
|
207 | 207 | <h3><a name="7" class="wiki-page"></a>内嵌图片</h3> |
|
208 | 208 | |
|
209 | 209 | <ul> |
|
210 | 210 | <li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li> |
|
211 | 211 | <li><strong>!>image_url!</strong> right floating image</li> |
|
212 | 212 | <li>你可以上传图片附件到 wiki 页面,然后使用它的文件名作为路径: <strong>!已上传的图片.png!</strong></li> |
|
213 | 213 | </ul> |
|
214 | 214 | |
|
215 | 215 | <h3><a name="8" class="wiki-page"></a>标题</h3> |
|
216 | 216 | |
|
217 | 217 | <pre> |
|
218 | 218 | h1. 一级标题 |
|
219 | 219 | h2. 二级标题 |
|
220 | 220 | h3. 三级标题 |
|
221 | 221 | </pre> |
|
222 | 222 | |
|
223 | 223 | <p>你可以使用“#一级标题”、“#二级标题”等等来链接到这些标题</p> |
|
224 | 224 | |
|
225 | 225 | |
|
226 | 226 | <h3><a name="9" class="wiki-page"></a>段落</h3> |
|
227 | 227 | |
|
228 | 228 | <pre> |
|
229 | 229 | p>. 向右对齐 |
|
230 | 230 | p=. 居中 |
|
231 | 231 | </pre> |
|
232 | 232 | |
|
233 | 233 | <p style="text-align:center;">这是一个居中对齐的段落</p> |
|
234 | 234 | |
|
235 | 235 | |
|
236 | 236 | <h3><a name="10" class="wiki-page"></a>引用文字</h3> |
|
237 | 237 | |
|
238 | 238 | <p>在段落前加上 <strong>bq.</strong></p> |
|
239 | 239 | |
|
240 | 240 | <pre> |
|
241 | 241 | bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern. |
|
242 | 242 | To go live, all you need to add is a database and a web server. |
|
243 | 243 | </pre> |
|
244 | 244 | |
|
245 | 245 | <p>显示为:</p> |
|
246 | 246 | |
|
247 | 247 | <blockquote> |
|
248 | 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 | 249 | </blockquote> |
|
250 | 250 | |
|
251 | 251 | |
|
252 | 252 | <h3><a name="11" class="wiki-page"></a>目录</h3> |
|
253 | 253 | |
|
254 | 254 | <pre> |
|
255 | 255 | {{toc}} => 靠左对齐目录 |
|
256 | 256 | {{>toc}} => 靠右对齐目录 |
|
257 | 257 | </pre> |
|
258 | 258 | |
|
259 | 259 | <h3><a name="14" class="wiki-page"></a>水平线</h3> |
|
260 | 260 | |
|
261 | 261 | <pre> |
|
262 | 262 | --- |
|
263 | 263 | </pre> |
|
264 | 264 | |
|
265 | 265 | <h2><a name="12" class="wiki-page"></a>宏</h2> |
|
266 | 266 | |
|
267 | 267 | <p>Redmine内建了以下宏:</p> |
|
268 | 268 | |
|
269 | 269 | <p> |
|
270 | 270 | <dl> |
|
271 | 271 | <dt><code>hello_world</code></dt> |
|
272 | 272 | <dd><p>宏示例.</p></dd> |
|
273 | 273 | |
|
274 | 274 | <dt><code>macro_list</code></dt> |
|
275 | 275 | <dd><p>显示所有可用的宏列表,如果该宏有提供说明也会一并显示。</p></dd> |
|
276 | 276 | |
|
277 | 277 | <dt><code>child_pages</code></dt> |
|
278 | 278 | <dd><p>显示一个子页面列表。默认显示当前Wiki页面的所有子页面。 示例:</p> |
|
279 | 279 | <pre><code>{{child_pages}} -- 只能在Wiki页面调用 |
|
280 | 280 | {{child_pages(depth=2)}} -- 显示两级子页面</code></pre></dd> |
|
281 | 281 | |
|
282 | 282 | <dt><code>include</code></dt> |
|
283 | 283 | <dd><p>引用一个Wiki页面。示例:</p> |
|
284 | 284 | <pre><code>{{include(Foo)}}</code></pre> |
|
285 | 285 | <p>或者引用一个指定项目的Wiki页面:</p> |
|
286 | 286 | <pre><code>{{include(projectname:Foo)}}</code></pre></dd> |
|
287 | 287 | |
|
288 | 288 | <dt><code>collapse</code></dt> |
|
289 | 289 | <dd><p>插入一个折叠文本块。示例:</p> |
|
290 | 290 | <pre><code>{{collapse(View details...) |
|
291 | 291 | 这是一个默认折叠的文本块。 |
|
292 | 292 | 点击链接后将会展开此文本块. |
|
293 | 293 | }}</code></pre></dd> |
|
294 | 294 | |
|
295 | 295 | <dt><code>thumbnail</code></dt> |
|
296 | 296 | <dd><p>显示一个图像附件的可点击缩略图。示例:</p> |
|
297 | 297 | <pre>{{thumbnail(image.png)}} |
|
298 | 298 | {{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd> |
|
299 | 299 | </dl> |
|
300 | 300 | </p> |
|
301 | 301 | |
|
302 | 302 | <h2><a name="13" class="wiki-page"></a>代码高亮</h2> |
|
303 | 303 | |
|
304 | 304 | <p>Default code highlightment relies on <a href="http://coderay.rubychan.de/" class="external">CodeRay</a>, a fast syntax highlighting library written completely in Ruby. It currently supports 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) languages, where the names inside parentheses are aliases.</p> |
|
305 | 305 | |
|
306 | 306 | <p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p> |
|
307 | 307 | |
|
308 | 308 | <pre> |
|
309 | 309 | <pre><code class="ruby"> |
|
310 | 310 | 这里写 Ruby 代码 |
|
311 | 311 | </code></pre> |
|
312 | 312 | </pre> |
|
313 | 313 | |
|
314 | 314 | <p>示例:</p> |
|
315 | 315 | |
|
316 | 316 | <pre><code class="ruby syntaxhl"><span class="CodeRay"><span class="comment"># The Greeter class</span> |
|
317 | 317 | <span class="keyword">class</span> <span class="class">Greeter</span> |
|
318 | 318 | <span class="keyword">def</span> <span class="function">initialize</span>(name) |
|
319 | 319 | <span class="instance-variable">@name</span> = name.capitalize |
|
320 | 320 | <span class="keyword">end</span> |
|
321 | 321 | |
|
322 | 322 | <span class="keyword">def</span> <span class="function">salute</span> |
|
323 | 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 | 324 | <span class="keyword">end</span> |
|
325 | 325 | <span class="keyword">end</span></span></code> |
|
326 | 326 | </pre> |
|
327 | 327 | </body> |
|
328 | 328 | </html> |
General Comments 0
You need to be logged in to leave comments.
Login now