##// END OF EJS Templates
jro_apps » redmine
RSS
Fix typos in public/help/wiki_syntax_detailed.html....
Toshi MARUYAMA -
r5494:0a132e48f9d2
parent child
Show More
Side by Side Unified
Context file:
r5494:0a132e48f9d2 Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,270 +1,270
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 #dadada;
16 16 width:95%;
17 17 overflow-x: auto;
18 18 }
19 19 a.new { color: #b73535; }
20 20
21 21 .CodeRay .c { color:#666; }
22 22
23 23 .CodeRay .cl { color:#B06; font-weight:bold }
24 24 .CodeRay .dl { color:black }
25 25 .CodeRay .fu { color:#06B; font-weight:bold }
26 26
27 27 .CodeRay .il { background: #eee }
28 28 .CodeRay .il .idl { font-weight: bold; color: #888 }
29 29
30 30 .CodeRay .iv { color:#33B }
31 31 .CodeRay .r { color:#080; font-weight:bold }
32 32
33 33 .CodeRay .s { background-color:#fff0f0 }
34 34 .CodeRay .s .dl { color:#710 }
35 35 </style>
36 36 </head>
37 37
38 38 <body>
39 39 <h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
40 40
41 41 <h2><a name="2" class="wiki-page"></a>Links</h2>
42 42
43 43 <h3><a name="3" class="wiki-page"></a>Redmine links</h3>
44 44
45 45 <p>Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.</p>
46 46 <ul>
47 47 <li>Link to an issue: <strong>#124</strong> (displays <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, link is striked-through if the issue is closed)</li>
48 48 <li>Link to a changeset: <strong>r758</strong> (displays <a href="#" class="changeset" title="Search engine now only searches objects the user is allowed to view.">r758</a>)</li>
49 49 <li>Link to a changeset with a non-numeric hash: <strong>commit:c6f4d0fd</strong> (displays <a href="#" class="changeset">c6f4d0fd</a>).</li>
50 <li>Link to a changeset of another project: <strong>sandbox:r758</strong> (displays <a href="#" class="changeset" title="Search engine now only searches objects the user is allowed to view.">sanbox:r758</a>)</li>
50 <li>Link to a changeset of another project: <strong>sandbox:r758</strong> (displays <a href="#" class="changeset" title="Search engine now only searches objects the user is allowed to view.">sandbox:r758</a>)</li>
51 51 <li>Link to a changeset with a non-numeric hash: <strong>sandbox:c6f4d0fd</strong> (displays <a href="#" class="changeset">sandbox:c6f4d0fd</a>).</li>
52 52 </ul>
53 53
54 54 <p>Wiki links:</p>
55 55
56 56 <ul>
57 57 <li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
58 58 <li><strong>[[Guide#further-reading]]</strong> takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="#" class="wiki-page">Guide</a></li>
59 59 <li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="#" class="wiki-page">User manual</a></li>
60 60 </ul>
61 61
62 62 <p>You can also link to pages of an other project wiki:</p>
63 63
64 64 <ul>
65 65 <li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
66 66 <li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
67 67 </ul>
68 68
69 69 <p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
70 70
71 71 <p>Links to other resources:</p>
72 72
73 73 <ul>
74 74 <li>Documents:
75 75 <ul>
76 76 <li><strong>document#17</strong> (link to document with id 17)</li>
77 77 <li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
78 78 <li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
79 79 <li><strong>sandbox:document:"Some document"</strong> (link to a document with title "Some document" in other project "sandbox")</li>
80 80 </ul></li>
81 81 </ul>
82 82
83 83 <ul>
84 84 <li>Versions:
85 85 <ul>
86 86 <li><strong>version#3</strong> (link to version with id 3)</li>
87 87 <li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
88 88 <li><strong>version:"1.0 beta 2"</strong></li>
89 89 <li><strong>sandbox:version:1.0.0</strong> (link to version "1.0.0" in the project "sandbox")</li>
90 90 </ul></li>
91 91 </ul>
92 92
93 93 <ul>
94 94 <li>Attachments:
95 95 <ul>
96 96 <li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
97 97 <li>For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)</li>
98 98 </ul></li>
99 99 </ul>
100 100
101 101 <ul>
102 102 <li>Repository files:
103 103 <ul>
104 104 <li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
105 105 <li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
106 106 <li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
107 107 <li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
108 108 <li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
109 109 <li><strong>export:some/file</strong> (force the download of the file)</li>
110 110 <li><strong>sandbox:source:some/file</strong> (link to the file located at /some/file in the repository of the project "sandbox")</li>
111 111 <li><strong>sandbox:export:some/file</strong> (force the download of the file)</li>
112 112 </ul></li>
113 113 </ul>
114 114
115 115 <ul>
116 116 <li>Forum messages:
117 117 <ul>
118 118 <li><strong>message#1218</strong> (link to message with id 1218)</li>
119 119 </ul></li>
120 120 </ul>
121 121
122 122 <ul>
123 123 <li>Projects:
124 124 <ul>
125 125 <li><strong>project#3</strong> (link to project with id 3)</li>
126 126 <li><strong>project:someproject</strong> (link to project named "someproject")</li>
127 127 </ul></li>
128 128 </ul>
129 129
130 130
131 131 <p>Escaping:</p>
132 132
133 133 <ul>
134 134 <li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
135 135 </ul>
136 136
137 137
138 138 <h3><a name="4" class="wiki-page"></a>External links</h3>
139 139
140 140 <p>HTTP URLs and email addresses are automatically turned into clickable links:</p>
141 141
142 142 <pre>
143 143 http://www.redmine.org, someone@foo.bar
144 144 </pre>
145 145
146 146 <p>displays: <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>
147 147
148 148 <p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
149 149
150 150 <pre>
151 151 "Redmine web site":http://www.redmine.org
152 152 </pre>
153 153
154 154 <p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
155 155
156 156
157 157 <h2><a name="5" class="wiki-page"></a>Text formatting</h2>
158 158
159 159
160 160 <p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://www.textism.com/tools/textile/">http://www.textism.com/tools/textile/</a> for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.</p>
161 161
162 162 <h3><a name="6" class="wiki-page"></a>Font style</h3>
163 163
164 164 <pre>
165 165 * *bold*
166 166 * _italic_
167 167 * _*bold italic*_
168 168 * +underline+
169 169 * -strike-through-
170 170 </pre>
171 171
172 172 <p>Display:</p>
173 173
174 174 <ul>
175 175 <li><strong>bold</strong></li>
176 176 <li><em>italic</em></li>
177 177 <li><em>*bold italic*</em></li>
178 178 <li><ins>underline</ins></li>
179 179 <li><del>strike-through</del></li>
180 180 </ul>
181 181
182 182 <h3><a name="7" class="wiki-page"></a>Inline images</h3>
183 183
184 184 <ul>
185 185 <li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
186 186 <li><strong>!>image_url!</strong> right floating image</li>
187 187 <li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>!attached_image.png!</strong></li>
188 188 </ul>
189 189
190 190 <h3><a name="8" class="wiki-page"></a>Headings</h3>
191 191
192 192 <pre>
193 193 h1. Heading
194 194 h2. Subheading
195 195 h3. Subsubheading
196 196 </pre>
197 197
198 198 <p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
199 199
200 200
201 201 <h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
202 202
203 203 <pre>
204 204 p>. right aligned
205 205 p=. centered
206 206 </pre>
207 207
208 <p style="text-align:center;">This is centered paragraph.</p>
208 <p style="text-align:center;">This is a centered paragraph.</p>
209 209
210 210
211 211 <h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
212 212
213 213 <p>Start the paragraph with <strong>bq.</strong></p>
214 214
215 215 <pre>
216 216 bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
217 217 To go live, all you need to add is a database and a web server.
218 218 </pre>
219 219
220 220 <p>Display:</p>
221 221
222 222 <blockquote>
223 223 <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>
224 224 </blockquote>
225 225
226 226
227 227 <h3><a name="11" class="wiki-page"></a>Table of content</h3>
228 228
229 229 <pre>
230 230 {{toc}} => left aligned toc
231 231 {{>toc}} => right aligned toc
232 232 </pre>
233 233
234 234 <h2><a name="12" class="wiki-page"></a>Macros</h2>
235 235
236 236 <p>Redmine has the following builtin macros:</p>
237 237
238 238 <p><dl><dt><code>hello_world</code></dt><dd><p>Sample macro.</p></dd><dt><code>include</code></dt><dd><p>Include a wiki page. Example:</p>
239 239
240 240 <pre><code>{{include(Foo)}}</code></pre></dd><dt><code>macro_list</code></dt><dd><p>Displays a list of all available macros, including description if available.</p></dd></dl></p>
241 241
242 242
243 243 <h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
244 244
245 245 <p>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, cpp, css, delphi, groovy, html, java, javascript, json, php, python, rhtml, ruby, scheme, sql, xml and yaml languages.</p>
246 246
247 247 <p>You can highlight code in your wiki page using this syntax:</p>
248 248
249 249 <pre>
250 250 &lt;pre&gt;&lt;code class="ruby"&gt;
251 251 Place you code here.
252 252 &lt;/code&gt;&lt;/pre&gt;
253 253 </pre>
254 254
255 255 <p>Example:</p>
256 256
257 257 <pre><code class="ruby CodeRay"><span class="no"> 1</span> <span class="c"># The Greeter class</span>
258 258 <span class="no"> 2</span> <span class="r">class</span> <span class="cl">Greeter</span>
259 259 <span class="no"> 3</span> <span class="r">def</span> <span class="fu">initialize</span>(name)
260 260 <span class="no"> 4</span> <span class="iv">@name</span> = name.capitalize
261 261 <span class="no"> 5</span> <span class="r">end</span>
262 262 <span class="no"> 6</span>
263 263 <span class="no"> 7</span> <span class="r">def</span> <span class="fu">salute</span>
264 264 <span class="no"> 8</span> puts <span class="s"><span class="dl">"</span><span class="k">Hello </span><span class="il"><span class="idl">#{</span><span class="iv">@name</span><span class="idl">}</span></span><span class="k">!</span><span class="dl">"</span></span>
265 265 <span class="no"> 9</span> <span class="r">end</span>
266 266 <span class="no"><strong>10</strong></span> <span class="r">end</span>
267 267 </code>
268 268 </pre>
269 269 </body>
270 270 </html>
General Comments 0
You need to be logged in to leave comments. Login now