##// END OF EJS Templates
jro_apps » redmine
RSS
Merged r4308 from trunk....
Eric Davis -
r4228:2cf5656ad0db
parent child
Show More
Side by Side Unified
Context file:
r4228:2cf5656ad0db Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,247 +1,265
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 c6f4d0fd). Added in <a href="#" class="changeset" title="Merged Git support branch (r1200 to r1226).">r1236</a>.</li>
50 50 </ul>
51 51
52 52 <p>Wiki links:</p>
53 53
54 54 <ul>
55 55 <li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
56 56 <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>
57 57 <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>
58 58 </ul>
59 59
60 60 <p>You can also link to pages of an other project wiki:</p>
61 61
62 62 <ul>
63 63 <li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
64 64 <li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
65 65 </ul>
66 66
67 67 <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>
68 68
69 <p>Links to others resources (0.7):</p>
69 <p>Links to other resources:</p>
70 70
71 71 <ul>
72 72 <li>Documents:
73 73 <ul>
74 74 <li><strong>document#17</strong> (link to document with id 17)</li>
75 75 <li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
76 76 <li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
77 <li><strong>document:some_project:"Some document"</strong> (link to a document with title "Some document" in other project "some_project")
77 78 </ul></li>
78 79 </ul>
79 80
80 81 <ul>
81 82 <li>Versions:
82 83 <ul>
83 84 <li><strong>version#3</strong> (link to version with id 3)</li>
84 85 <li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
85 86 <li><strong>version:"1.0 beta 2"</strong></li>
86 87 </ul></li>
87 88 </ul>
88 89
89 90 <ul>
90 91 <li>Attachments:
91 92 <ul>
92 93 <li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
93 94 <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>
94 95 </ul></li>
95 96 </ul>
96 97
97 98 <ul>
98 <li>Repository files
99 <li>Repository files:
99 100 <ul>
100 <li><strong>source:some/file</strong> -- Link to the file located at /some/file in the project's repository</li>
101 <li><strong>source:some/file@52</strong> -- Link to the file's revision 52</li>
102 <li><strong>source:some/file#L120</strong> -- Link to line 120 of the file</li>
103 <li><strong>source:some/file@52#L120</strong> -- Link to line 120 of the file's revision 52</li>
104 <li><strong>export:some/file</strong> -- Force the download of the file</li>
105 </ul></li>
101 <li><strong>source:some/file</strong> (link to the file located at /some/file in the project's repository)</li>
102 <li><strong>source:some/file@52</strong> (link to the file's revision 52)</li>
103 <li><strong>source:some/file#L120</strong> (link to line 120 of the file)</li>
104 <li><strong>source:some/file@52#L120</strong> (link to line 120 of the file's revision 52)</li>
105 <li><strong>source:"some file@52#L120"</strong> (use double quotes when the URL contains spaces</li>
106 <li><strong>export:some/file</strong> (force the download of the file)</li>
107 </ul></li>
106 108 </ul>
107
108 <p>Escaping (0.7):</p>
109 109
110 110 <ul>
111 <li>Forum messages:
112 <ul>
113 <li><strong>message#1218</strong> (link to message with id 1218)</li>
114 </ul></li>
115 </ul>
116
117 <ul>
118 <li>Projects:
119 <ul>
120 <li><strong>project#3</strong> (link to project with id 3)</li>
121 <li><strong>project:someproject</strong> (link to project named "someproject")</li>
122 </ul></li>
123 </ul>
124
125
126 <p>Escaping:</p>
127
128 <ul>
111 129 <li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
112 130 </ul>
113 131
114 132
115 133 <h3><a name="4" class="wiki-page"></a>External links</h3>
116 134
117 135 <p>HTTP URLs and email addresses are automatically turned into clickable links:</p>
118 136
119 137 <pre>
120 138 http://www.redmine.org, someone@foo.bar
121 139 </pre>
122 140
123 141 <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>
124 142
125 143 <p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
126 144
127 145 <pre>
128 146 "Redmine web site":http://www.redmine.org
129 147 </pre>
130 148
131 149 <p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
132 150
133 151
134 152 <h2><a name="5" class="wiki-page"></a>Text formatting</h2>
135 153
136 154
137 155 <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>
138 156
139 157 <h3><a name="6" class="wiki-page"></a>Font style</h3>
140 158
141 159 <pre>
142 160 * *bold*
143 161 * _italic_
144 162 * _*bold italic*_
145 163 * +underline+
146 164 * -strike-through-
147 165 </pre>
148 166
149 167 <p>Display:</p>
150 168
151 169 <ul>
152 170 <li><strong>bold</strong></li>
153 171 <li><em>italic</em></li>
154 172 <li><em>*bold italic*</em></li>
155 173 <li><ins>underline</ins></li>
156 174 <li><del>strike-through</del></li>
157 175 </ul>
158 176
159 177 <h3><a name="7" class="wiki-page"></a>Inline images</h3>
160 178
161 179 <ul>
162 180 <li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
163 181 <li><strong>!>image_url!</strong> right floating image</li>
164 182 <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>
165 183 </ul>
166 184
167 185 <h3><a name="8" class="wiki-page"></a>Headings</h3>
168 186
169 187 <pre>
170 188 h1. Heading
171 189 h2. Subheading
172 190 h3. Subsubheading
173 191 </pre>
174 192
175 193 <p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
176 194
177 195
178 196 <h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
179 197
180 198 <pre>
181 199 p>. right aligned
182 200 p=. centered
183 201 </pre>
184 202
185 203 <p style="text-align:center;">This is centered paragraph.</p>
186 204
187 205
188 206 <h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
189 207
190 208 <p>Start the paragraph with <strong>bq.</strong></p>
191 209
192 210 <pre>
193 211 bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
194 212 To go live, all you need to add is a database and a web server.
195 213 </pre>
196 214
197 215 <p>Display:</p>
198 216
199 217 <blockquote>
200 218 <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>
201 219 </blockquote>
202 220
203 221
204 222 <h3><a name="11" class="wiki-page"></a>Table of content</h3>
205 223
206 224 <pre>
207 225 {{toc}} => left aligned toc
208 226 {{>toc}} => right aligned toc
209 227 </pre>
210 228
211 229 <h2><a name="12" class="wiki-page"></a>Macros</h2>
212 230
213 231 <p>Redmine has the following builtin macros:</p>
214 232
215 233 <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>
216 234
217 235 <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>
218 236
219 237
220 238 <h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
221 239
222 <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, html, javascript, rhtml, ruby, scheme, xml languages.</p>
240 <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>
223 241
224 242 <p>You can highlight code in your wiki page using this syntax:</p>
225 243
226 244 <pre>
227 245 &lt;pre&gt;&lt;code class="ruby"&gt;
228 246 Place you code here.
229 247 &lt;/code&gt;&lt;/pre&gt;
230 248 </pre>
231 249
232 250 <p>Example:</p>
233 251
234 252 <pre><code class="ruby CodeRay"><span class="no"> 1</span> <span class="c"># The Greeter class</span>
235 253 <span class="no"> 2</span> <span class="r">class</span> <span class="cl">Greeter</span>
236 254 <span class="no"> 3</span> <span class="r">def</span> <span class="fu">initialize</span>(name)
237 255 <span class="no"> 4</span> <span class="iv">@name</span> = name.capitalize
238 256 <span class="no"> 5</span> <span class="r">end</span>
239 257 <span class="no"> 6</span>
240 258 <span class="no"> 7</span> <span class="r">def</span> <span class="fu">salute</span>
241 259 <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>
242 260 <span class="no"> 9</span> <span class="r">end</span>
243 261 <span class="no"><strong>10</strong></span> <span class="r">end</span>
244 262 </code>
245 263 </pre>
246 264 </body>
247 265 </html>
General Comments 0
You need to be logged in to leave comments. Login now