formating_fix.patch

Formatting patch - Tomas Pospisek, 2008-10-22 16:46

Download (18.7 KB)

View differences:

wiki_syntax_detailed.html.format_fix 2008-10-22 16:44:57.000000000 +0200
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
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 .af { color:#00C }
22
.CodeRay .an { color:#007 }
23
.CodeRay .av { color:#700 }
24
.CodeRay .aw { color:#C00 }
25
.CodeRay .bi { color:#509; font-weight:bold }
26
.CodeRay .c  { color:#666; }
27

  
28
.CodeRay .ch { color:#04D }
29
.CodeRay .ch .k { color:#04D }
30
.CodeRay .ch .dl { color:#039 }
31

  
32
.CodeRay .cl { color:#B06; font-weight:bold }
33
.CodeRay .co { color:#036; font-weight:bold }
34
.CodeRay .cr { color:#0A0 }
35
.CodeRay .cv { color:#369 }
36
.CodeRay .df { color:#099; font-weight:bold }
37
.CodeRay .di { color:#088; font-weight:bold }
38
.CodeRay .dl { color:black }
39
.CodeRay .do { color:#970 }
40
.CodeRay .ds { color:#D42; font-weight:bold }
41
.CodeRay .e  { color:#666; font-weight:bold }
42
.CodeRay .en { color:#800; font-weight:bold }
43
.CodeRay .er { color:#F00; background-color:#FAA }
44
.CodeRay .ex { color:#F00; font-weight:bold }
45
.CodeRay .fl { color:#60E; font-weight:bold }
46
.CodeRay .fu { color:#06B; font-weight:bold }
47
.CodeRay .gv { color:#d70; font-weight:bold }
48
.CodeRay .hx { color:#058; font-weight:bold }
49
.CodeRay .i  { color:#00D; font-weight:bold }
50
.CodeRay .ic { color:#B44; font-weight:bold }
51

  
52
.CodeRay .il { background: #eee }
53
.CodeRay .il .il { background: #ddd }
54
.CodeRay .il .il .il { background: #ccc }
55
.CodeRay .il .idl { font-weight: bold; color: #888 }
56

  
57
.CodeRay .in { color:#B2B; font-weight:bold }
58
.CodeRay .iv { color:#33B }
59
.CodeRay .la { color:#970; font-weight:bold }
60
.CodeRay .lv { color:#963 }
61
.CodeRay .oc { color:#40E; font-weight:bold }
62
.CodeRay .of { color:#000; font-weight:bold }
63
.CodeRay .op { }
64
.CodeRay .pc { color:#038; font-weight:bold }
65
.CodeRay .pd { color:#369; font-weight:bold }
66
.CodeRay .pp { color:#579 }
67
.CodeRay .pt { color:#339; font-weight:bold }
68
.CodeRay .r  { color:#080; font-weight:bold }
69

  
70
.CodeRay .rx { background-color:#fff0ff }
71
.CodeRay .rx .k { color:#808 }
72
.CodeRay .rx .dl { color:#404 }
73
.CodeRay .rx .mod { color:#C2C }
74
.CodeRay .rx .fu  { color:#404; font-weight: bold }
75

  
76
.CodeRay .s  { background-color:#fff0f0 }
77
.CodeRay .s  .s { background-color:#ffe0e0 }
78
.CodeRay .s  .s  .s { background-color:#ffd0d0 }
79
.CodeRay .s  .k { color:#D20 }
80
.CodeRay .s  .dl { color:#710 }
81

  
82
.CodeRay .sh { background-color:#f0fff0 }
83
.CodeRay .sh .k { color:#2B2 }
84
.CodeRay .sh .dl { color:#161 }
85

  
86
.CodeRay .sy { color:#A60 }
87
.CodeRay .sy .k { color:#A60 }
88
.CodeRay .sy .dl { color:#630 }
89

  
90
.CodeRay .ta { color:#070 }
91
.CodeRay .tf { color:#070; font-weight:bold }
92
.CodeRay .ts { color:#D70; font-weight:bold }
93
.CodeRay .ty { color:#339; font-weight:bold }
94
.CodeRay .v  { color:#036 }
95
.CodeRay .xt { color:#444 }
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 }
96 35
</style>
97 36
</head>
98 37

  
99 38
<body>
100 39
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>
101 40

  
41
    <h2><a name="2" class="wiki-page"></a>Links</h2>
102 42

  
43
        <h3><a name="3" class="wiki-page"></a>Redmine links</h3>
103 44

  
104
	<h2><a name="2" class="wiki-page"></a>Links</h2>
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="/issues/show/124" 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="/repositories/revision/1?rev=758" 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="/repositories/revision/1?rev=1236" 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="Guide.html" class="wiki-page">Guide</a></li>
56
            <li><strong>[[Guide|User manual]]</strong> displays a link to the same page but with a different text: <a href="Guide.html" class="wiki-page">User manual</a></li>
57
        </ul>
58

  
59
        <p>You can also link to pages of an other project wiki:</p>
60

  
61
        <ul>
62
            <li><strong>[[sandbox:some page]]</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
63
            <li><strong>[[sandbox]]</strong> displays a link to the Sandbox wiki main page</li>
64
        </ul>
65

  
66
        <p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="Nonexistent_page.html" class="wiki-page new">Nonexistent page</a>.</p>
67

  
68
        <p>Links to others resources (0.7):</p>
69

  
70
        <ul>
71
            <li>Documents:
72
                <ul>
73
                    <li><strong>document#17</strong> (link to document with id 17)</li>
74
                    <li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
75
                    <li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
76
                </ul></li>
77
        </ul>
78

  
79
        <ul>
80
            <li>Versions:
81
                <ul>
82
                    <li><strong>version#3</strong> (link to version with id 3)</li>
83
                    <li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
84
                    <li><strong>version:"1.0 beta 2"</strong></li>
85
                </ul></li>
86
        </ul>
87

  
88
        <ul>
89
            <li>Attachments:
90
                <ul>
91
                    <li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
92
                    <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>
93
                </ul></li>
94
        </ul>
95

  
96
        <ul>
97
             <li>Repository files
98
                <ul>
99
                    <li><strong>source:some/file</strong>          -- Link to the file located at /some/file in the project's repository</li>
100
                    <li><strong>source:some/file@52</strong>       -- Link to the file's revision 52</li>
101
                    <li><strong>source:some/file#L120</strong>     -- Link to line 120 of the file</li>
102
                    <li><strong>source:some/file@52#L120</strong>  -- Link to line 120 of the file's revision 52</li>
103
                    <li><strong>export:some/file</strong>          -- Force the download of the file</li>
104
            </ul></li>
105
        </ul>
106
        
107
        <p>Escaping (0.7):</p>
108

  
109
        <ul>
110
            <li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
111
        </ul>
105 112

  
106 113

  
107
	<h3><a name="3" class="wiki-page"></a>Redmine links</h3>
108

  
109

  
110
	<p>Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.</p>
111

  
112

  
113
	<ul>
114
	<li>Link to an issue: <strong>#124</strong> (displays <del><a href="/issues/show/124" 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>
115
		<li>Link to a changeset: <strong>r758</strong> (displays <a href="/repositories/revision/1?rev=758" class="changeset" title="Search engine now only searches objects the user is allowed to view.">r758</a>)</li>
116
		<li>Link to a changeset with a non-numeric hash: <strong>commit:c6f4d0fd</strong> (displays c6f4d0fd).  Added in <a href="/repositories/revision/1?rev=1236" class="changeset" title="Merged Git support branch (r1200 to r1226).">r1236</a>.</li>
117
	</ul>
118

  
119

  
120
	<p>Wiki links:</p>
121

  
122

  
123
	<ul>
124
	<li><strong>&#91;&#91;Guide&#93;&#93;</strong> displays a link to the page named 'Guide': <a href="Guide.html" class="wiki-page">Guide</a></li>
125
		<li><strong>&#91;&#91;Guide|User manual&#93;&#93;</strong> displays a link to the same page but with a different text: <a href="Guide.html" class="wiki-page">User manual</a></li>
126
	</ul>
127

  
128

  
129
	<p>You can also link to pages of an other project wiki:</p>
130

  
131

  
132
	<ul>
133
	<li><strong>&#91;&#91;sandbox:some page&#93;&#93;</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>
134
		<li><strong>&#91;&#91;sandbox:&#93;&#93;</strong> displays a link to the Sandbox wiki main page</li>
135
	</ul>
136

  
137

  
138
	<p>Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="Nonexistent_page.html" class="wiki-page new">Nonexistent page</a>.</p>
139

  
140

  
141
	<p>Links to others resources (0.7):</p>
142

  
143

  
144
	<ul>
145
	<li>Documents:
146

  
147
	<ul>
148
	<li><strong>document#17</strong> (link to document with id 17)</li>
149
		<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>
150
		<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>
151
	</ul></li>
152
	</ul>
153

  
154

  
155
	<ul>
156
	<li>Versions:
157

  
158
	<ul>
159
	<li><strong>version#3</strong> (link to version with id 3)</li>
160
		<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>
161
		<li><strong>version:"1.0 beta 2"</strong></li>
162
	</ul></li>
163
	</ul>
164

  
165

  
166
	<ul>
167
	<li>Attachments:
168

  
169
	<ul>
170
	<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>
171
		<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>
172
	</ul></li>
173
	</ul>
174

  
175

  
176
    <ul>
177
	<li>Repository files
178

  
179
	<ul>
180
	<li><strong>source:some/file</strong>          -- Link to the file located at /some/file in the project's repository</li>
181
		<li><strong>source:some/file@52</strong>       -- Link to the file's revision 52</li>
182

  
183
		<li><strong>source:some/file#L120</strong>     -- Link to line 120 of the file</li>
184
		<li><strong>source:some/file@52#L120</strong>  -- Link to line 120 of the file's revision 52</li>
185
		<li><strong>export:some/file</strong>          -- Force the download of the file</li>
186
	</ul></li>
187

  
188
	</ul>
189
	
190
	
191
	
192
	<p>Escaping (0.7):</p>
193

  
194

  
195
	<ul>
196
	<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>
197
	</ul>
198

  
199

  
200
	<h3><a name="4" class="wiki-page"></a>External links</h3>
201

  
202

  
203
	<p>HTTP URLs and email addresses are automatically turned into clickable links:</p>
114
        <h3><a name="4" class="wiki-page"></a>External links</h3>
204 115

  
116
        <p>HTTP URLs and email addresses are automatically turned into clickable links:</p>
205 117

  
206 118
<pre>
207 119
http://www.redmine.org, someone@foo.bar
208 120
</pre>
209 121

  
210
	<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>
211

  
212

  
213
	<p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
122
        <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>
214 123

  
124
        <p>If you want to display a specific text instead of the URL, you can use the standard textile syntax:</p>
215 125

  
216 126
<pre>
217 127
"Redmine web site":http://www.redmine.org
218 128
</pre>
219 129

  
220
	<p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
130
        <p>displays: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
221 131

  
222 132

  
223
	<h2><a name="5" class="wiki-page"></a>Text formatting</h2>
133
    <h2><a name="5" class="wiki-page"></a>Text formatting</h2>
224 134

  
225 135

  
226
	<p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax.  See <a class="external" href="http://hobix.com/textile/">http://hobix.com/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>
227

  
228

  
229
	<h3><a name="6" class="wiki-page"></a>Font style</h3>
136
    <p>For things such as headlines, bold, tables, lists, Redmine supports Textile syntax.  See <a class="external" href="http://hobix.com/textile/">http://hobix.com/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>
230 137

  
138
        <h3><a name="6" class="wiki-page"></a>Font style</h3>
231 139

  
232 140
<pre>
233 141
* *bold*
......
237 145
* -strike-through-
238 146
</pre>
239 147

  
240
	<p>Display:</p>
241

  
242

  
243
	<ul>
244
	<li><strong>bold</strong></li>
245
		<li><em>italic</em></li>
246
		<li><em>*bold italic*</em></li>
247
		<li><ins>underline</ins></li>
248
		<li><del>strike-through</del></li>
249
	</ul>
250

  
251

  
252
	<h3><a name="7" class="wiki-page"></a>Inline images</h3>
253

  
148
        <p>Display:</p>
254 149

  
255
	<ul>
256
	<li><strong>&#33;image_url&#33;</strong> displays an image located at image_url (textile syntax)</li>
257
		<li><strong>&#33;>image_url&#33;</strong> right floating image</li>
258
		<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: <strong>&#33;attached_image.png&#33;</strong></li>
259
	</ul>
260

  
261

  
262
	<h3><a name="8" class="wiki-page"></a>Headings</h3>
150
        <ul>
151
            <li><strong>bold</strong></li>
152
            <li><em>italic</em></li>
153
            <li><em>*bold italic*</em></li>
154
            <li><ins>underline</ins></li>
155
            <li><del>strike-through</del></li>
156
        </ul>
157

  
158
        <h3><a name="7" class="wiki-page"></a>Inline images</h3>
159

  
160
        <ul>
161
            <li><strong>!image_url!</strong> displays an image located at image_url (textile syntax)</li>
162
            <li><strong>!>image_url!</strong> right floating image</li>
163
            <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>
164
        </ul>
263 165

  
166
        <h3><a name="8" class="wiki-page"></a>Headings</h3>
264 167

  
265 168
<pre>
266 169
h1. Heading
......
268 171
h3. Subheading
269 172
</pre>
270 173

  
271
	<h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
272

  
174
        <h3><a name="9" class="wiki-page"></a>Paragraphs</h3>
273 175

  
274 176
<pre>
275
p&gt;. right aligned
177
p>. right aligned
276 178
p=. centered
277 179
</pre>
278 180

  
279
	<p style="text-align:center;">This is centered paragraph.</p>
280

  
181
        <p style="text-align:center;">This is centered paragraph.</p>
281 182

  
282
	<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
283 183

  
184
        <h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
284 185

  
285
	<p>Start the paragraph with <strong>bq.</strong></p>
286

  
186
        <p>Start the paragraph with <strong>bq.</strong></p>
287 187

  
288 188
<pre>
289 189
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
290 190
To go live, all you need to add is a database and a web server.
291 191
</pre>
292 192

  
293
	<p>Display:</p>
294

  
295

  
296
	<blockquote>
297
		<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>
298
	</blockquote>
193
        <p>Display:</p>
299 194

  
195
        <blockquote>
196
                <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>
197
        </blockquote>
300 198

  
301
	<h3><a name="11" class="wiki-page"></a>Table of content</h3>
302 199

  
200
        <h3><a name="11" class="wiki-page"></a>Table of content</h3>
303 201

  
304 202
<pre>
305
{{toc}} =&gt; left aligned toc
306
{{&gt;toc}} =&gt; right aligned toc
203
{{toc}} => left aligned toc
204
{{>toc}} => right aligned toc
307 205
</pre>
308 206

  
309
	<h2><a name="12" class="wiki-page"></a>Macros</h2>
207
    <h2><a name="12" class="wiki-page"></a>Macros</h2>
310 208

  
209
    <p>Redmine has the following builtin macros:</p>
311 210

  
312
	<p>Redmine has the following builtin macros:</p>
211
    <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>
313 212

  
213
    <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>
314 214

  
315
	<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>
316 215

  
216
    <h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
317 217

  
318
	<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>
319

  
320

  
321
	<h2><a name="13" class="wiki-page"></a>Code highlighting</h2>
322

  
323

  
324
	<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>
325

  
326

  
327
	<p>You can highlight code in your wiki page using this syntax:</p>
218
    <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>
328 219

  
220
    <p>You can highlight code in your wiki page using this syntax:</p>
329 221

  
330 222
<pre>
331 223
&lt;pre&gt;&lt;code class="ruby"&gt;
......
333 225
&lt;/code&gt;&lt;/pre&gt;
334 226
</pre>
335 227

  
336
	<p>Example:</p>
337

  
228
    <p>Example:</p>
338 229

  
339 230
<pre><code class="ruby CodeRay"><span class="no"> 1</span> <span class="c"># The Greeter class</span>
340 231
<span class="no"> 2</span> <span class="r">class</span> <span class="cl">Greeter</span>