Mercurial > hg > soundsoftware-site

comparison public/help/.svn/text-base/wiki_syntax_detailed.html.svn-base @ 0:513646585e45

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Import Redmine trunk SVN rev 3859
author Chris Cannam
date Fri, 23 Jul 2010 15:52:44 +0100
parents
children 94944d00e43c
comparison
equal deleted inserted replaced
-1:000000000000 0:513646585e45
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
21 .CodeRay .c { color:#666; }
22
23 .CodeRay .cl { color:#B06; font-weight:bold }
24 .CodeRay .dl { color:black }
25 .CodeRay .fu { color:#06B; font-weight:bold }
26
27 .CodeRay .il { background: #eee }
28 .CodeRay .il .idl { font-weight: bold; color: #888 }
29
30 .CodeRay .iv { color:#33B }
31 .CodeRay .r { color:#080; font-weight:bold }
32
33 .CodeRay .s { background-color:#fff0f0 }
34 .CodeRay .s .dl { color:#710 }
35 </style>
36 </head>
37
38 <body>
39 <h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
40
41 <h2><a name="2" class="wiki-page"></a>Links</h2>
42
43 <h3><a name="3" class="wiki-page"></a>Redmine links</h3>
44
45 <p>Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.</p>
46 <ul>
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 <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 <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 </ul>
51
52 <p>Wiki links:</p>
53
54 <ul>
55 <li><strong>[[Guide]]</strong> displays a link to the page named 'Guide': <a href="#" class="wiki-page">Guide</a></li>
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 <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 </ul>
59
60 <p>You can also link to pages of an other project wiki:</p>
61
62 <ul>
63 <li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
64 <li><strong>[[sandbox:]]</strong> displays a link to the Sandbox wiki main page</li>
65 </ul>
66
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
69 <p>Links to others resources (0.7):</p>
70
71 <ul>
72 <li>Documents:
73 <ul>
74 <li><strong>document#17</strong> (link to document with id 17)</li>
75 <li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
76 <li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
77 </ul></li>
78 </ul>
79
80 <ul>
81 <li>Versions:
82 <ul>
83 <li><strong>version#3</strong> (link to version with id 3)</li>
84 <li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
85 <li><strong>version:"1.0 beta 2"</strong></li>
86 </ul></li>
87 </ul>
88
89 <ul>
90 <li>Attachments:
91 <ul>
92 <li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
93 <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 </ul></li>
95 </ul>
96
97 <ul>
98 <li>Repository files
99 <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>
106 </ul>
107
108 <p>Escaping (0.7):</p>
109
110 <ul>
111 <li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
112 </ul>
113
114
115 <h3><a name="4" class="wiki-page"></a>External links</h3>
116
117 <p>HTTP URLs and email addresses are automatically turned into clickable links:</p>
118
119 <pre>
120 http://www.redmine.org, someone@foo.bar
121 </pre>
122
123 <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
125 <p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
126
127 <pre>
128 "Redmine web site":http://www.redmine.org
129 </pre>
130
131 <p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
132
133
134 <h2><a name="5" class="wiki-page"></a>Text formatting</h2>
135
136
137 <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
139 <h3><a name="6" class="wiki-page"></a>Font style</h3>
140
141 <pre>
142 * *bold*
143 * _italic_
144 * _*bold italic*_
145 * +underline+
146 * -strike-through-
147 </pre>
148
149 <p>Display:</p>
150
151 <ul>
152 <li><strong>bold</strong></li>
153 <li><em>italic</em></li>
154 <li><em>*bold italic*</em></li>
155 <li><ins>underline</ins></li>
156 <li><del>strike-through</del></li>
157 </ul>
158
159 <h3><a name="7" class="wiki-page"></a>Inline images</h3>
160
161 <ul>
162 <li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
163 <li><strong>!>image_url!</strong> right floating image</li>
164 <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 </ul>
166
167 <h3><a name="8" class="wiki-page"></a>Headings</h3>
168
169 <pre>
170 h1. Heading
171 h2. Subheading
172 h3. Subsubheading
173 </pre>
174
175 <p>Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.</p>
176
177
178 <h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
179
180 <pre>
181 p>. right aligned
182 p=. centered
183 </pre>
184
185 <p style="text-align:center;">This is centered paragraph.</p>
186
187
188 <h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
189
190 <p>Start the paragraph with <strong>bq.</strong></p>
191
192 <pre>
193 bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
194 To go live, all you need to add is a database and a web server.
195 </pre>
196
197 <p>Display:</p>
198
199 <blockquote>
200 <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 </blockquote>
202
203
204 <h3><a name="11" class="wiki-page"></a>Table of content</h3>
205
206 <pre>
207 {{toc}} => left aligned toc
208 {{>toc}} => right aligned toc
209 </pre>
210
211 <h2><a name="12" class="wiki-page"></a>Macros</h2>
212
213 <p>Redmine has the following builtin macros:</p>
214
215 <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
217 <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
219
220 <h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
221
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>
223
224 <p>You can highlight code in your wiki page using this syntax:</p>
225
226 <pre>
227 &lt;pre&gt;&lt;code class="ruby"&gt;
228 Place you code here.
229 &lt;/code&gt;&lt;/pre&gt;
230 </pre>
231
232 <p>Example:</p>
233
234 <pre><code class="ruby CodeRay"><span class="no"> 1</span> <span class="c"># The Greeter class</span>
235 <span class="no"> 2</span> <span class="r">class</span> <span class="cl">Greeter</span>
236 <span class="no"> 3</span> <span class="r">def</span> <span class="fu">initialize</span>(name)
237 <span class="no"> 4</span> <span class="iv">@name</span> = name.capitalize
238 <span class="no"> 5</span> <span class="r">end</span>
239 <span class="no"> 6</span>
240 <span class="no"> 7</span> <span class="r">def</span> <span class="fu">salute</span>
241 <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 <span class="no"> 9</span> <span class="r">end</span>
243 <span class="no"><strong>10</strong></span> <span class="r">end</span>
244 </code>
245 </pre>
246 </body>
247 </html>