Project

General

Profile

Download (8.8 KB)

Patch #815 » 815.diff

John Goerzen, 2008-03-12 20:59

View differences:

public/help/wiki_syntax.html
58 58 
<tr><th></th><td>!<em>attached_image</em>!</td><td></td></tr>
59 59 
</table>
60 60 

  		




  61
  
  
    
<p><a href="http://www.redmine.org/wiki/redmine/RedmineWikiFormatting" onclick="window.open('http://www.redmine.org/wiki/redmine/RedmineWikiFormatting', '', ''); return false;">More Information</a></p>

  		




  
  61
  
    
<p><a href="wiki_syntax_detailed.html" onclick="window.open('wiki_syntax_detailed.html', '', ''); return false;">More Information</a></p>

  		




  62
  62
  
    

  		




  63
  63
  
    
</body>

  		




  64
  64
  
    
</html>

  		












  

    
      public/help/wiki_syntax_detailed.html
    
  





  
  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>

  		




  
  7
  
    
body { font:80% Verdana,Tahoma,Arial,sans-serif; }

  		




  
  8
  
    
h1, h2, h3, h4 {  font-family: Trebuchet MS,Georgia,"Times New Roman",serif; }

  		




  
  9
  
    
</style>

  		




  
  10
  
    
</head>

  		




  
  11
  
    
<body>

  		




  
  12
  
    
<h1><a name="1" class="wiki-page"></a>Wiki formatting</h1>

  		




  
  13
  
    

  		




  
  14
  
    

  		




  
  15
  
    

  		




  
  16
  
    
	<h2><a name="2" class="wiki-page"></a>Links</h2>

  		




  
  17
  
    

  		




  
  18
  
    

  		




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

  		




  
  20
  
    

  		




  
  21
  
    

  		




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

  		




  
  23
  
    

  		




  
  24
  
    

  		




  
  25
  
    
	<ul>

  		




  
  26
  
    
	<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>

  		




  
  27
  
    
		<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>

  		




  
  28
  
    
	</ul>

  		




  
  29
  
    

  		




  
  30
  
    

  		




  
  31
  
    
	<p>Wiki links:</p>

  		




  
  32
  
    

  		




  
  33
  
    

  		




  
  34
  
    
	<ul>

  		




  
  35
  
    
	<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>

  		




  
  36
  
    
		<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>

  		




  
  37
  
    
	</ul>

  		




  
  38
  
    

  		




  
  39
  
    

  		




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

  		




  
  41
  
    

  		




  
  42
  
    

  		




  
  43
  
    
	<ul>

  		




  
  44
  
    
	<li><strong>&#91;&#91;sandbox:some page&#93;&#93;</strong> displays a link to the page named 'Some page' of the Sandbox wiki</li>

  		




  
  45
  
    
		<li><strong>&#91;&#91;sandbox:&#93;&#93;</strong> displays a link to the Sandbox wiki main page</li>

  		




  
  46
  
    
	</ul>

  		




  
  47
  
    

  		




  
  48
  
    

  		




  
  49
  
    
	<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>

  		




  
  50
  
    

  		




  
  51
  
    

  		




  
  52
  
    
	<p>Links to others resources (0.6.devel.1064 and above):</p>

  		




  
  53
  
    

  		




  
  54
  
    

  		




  
  55
  
    
	<ul>

  		




  
  56
  
    
	<li>Documents:

  		




  
  57
  
    

  		




  
  58
  
    
	<ul>

  		




  
  59
  
    
	<li><strong>document#17</strong> (link to document with id 17)</li>

  		




  
  60
  
    
		<li><strong>document:Greetings</strong> (link to the document with title "Greetings")</li>

  		




  
  61
  
    
		<li><strong>document:"Some document"</strong> (double quotes can be used when document title contains spaces)</li>

  		




  
  62
  
    
	</ul></li>

  		




  
  63
  
    
	</ul>

  		




  
  64
  
    

  		




  
  65
  
    

  		




  
  66
  
    
	<ul>

  		




  
  67
  
    
	<li>Versions:

  		




  
  68
  
    

  		




  
  69
  
    
	<ul>

  		




  
  70
  
    
	<li><strong>version#3</strong> (link to version with id 3)</li>

  		




  
  71
  
    
		<li><strong>version:1.0.0</strong> (link to version named "1.0.0")</li>

  		




  
  72
  
    
		<li><strong>version:"1.0 beta 2"</strong></li>

  		




  
  73
  
    
	</ul></li>

  		




  
  74
  
    
	</ul>

  		




  
  75
  
    

  		




  
  76
  
    

  		




  
  77
  
    
	<ul>

  		




  
  78
  
    
	<li>Attachments:

  		




  
  79
  
    

  		




  
  80
  
    
	<ul>

  		




  
  81
  
    
	<li><strong>attachment:file.zip</strong> (link to the attachment of the current object named file.zip)</li>

  		




  
  82
  
    
		<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>

  		




  
  83
  
    
	</ul></li>

  		




  
  84
  
    
	</ul>

  		




  
  85
  
    

  		




  
  86
  
    

  		




  
  87
  
    
	<p>Escaping (0.6.devel.1064 and above):</p>

  		




  
  88
  
    

  		




  
  89
  
    

  		




  
  90
  
    
	<ul>

  		




  
  91
  
    
	<li>You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !</li>

  		




  
  92
  
    
	</ul>

  		




  
  93
  
    

  		




  
  94
  
    

  		




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

  		




  
  96
  
    

  		




  
  97
  
    

  		




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

  		




  
  99
  
    

  		




  
  100
  
    

  		




  
  101
  
    
<pre>

  		




  
  102
  
    
http://www.redmine.org, someone@foo.bar

  		




  
  103
  
    
</pre>

  		




  
  104
  
    

  		




  
  105
  
    
	<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>

  		




  
  106
  
    

  		




  
  107
  
    

  		




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

  		




  
  109
  
    

  		




  
  110
  
    

  		




  
  111
  
    
<pre>

  		




  
  112
  
    
"Redmine web site":http://www.redmine.org

  		




  
  113
  
    
</pre>

  		




  
  114
  
    

  		




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

  		




  
  116
  
    

  		




  
  117
  
    

  		




  
  118
  
    
	<h2><a name="5" class="wiki-page"></a>Text formatting</h2>

  		




  
  119
  
    

  		




  
  120
  
    

  		




  
  121
  
    
	<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>

  		




  
  122
  
    

  		




  
  123
  
    

  		




  
  124
  
    
	<h3><a name="6" class="wiki-page"></a>Font style</h3>

  		




  
  125
  
    

  		




  
  126
  
    

  		




  
  127
  
    
<pre><code>* *bold*

  		




  
  128
  
    
* _italic_

  		




  
  129
  
    
* _*bold italic*_

  		




  
  130
  
    
* +underline+

  		




  
  131
  
    
* -strike-through-

  		




  
  132
  
    
&lt;/code></pre>

  		




  
  133
  
    

  		




  
  134
  
    
	<p>Display:</p>

  		




  
  135
  
    

  		




  
  136
  
    

  		




  
  137
  
    
	<ul>

  		




  
  138
  
    
	<li><strong>bold</strong></li>

  		




  
  139
  
    
		<li><em>italic</em></li>

  		




  
  140
  
    
		<li><em>*bold italic*</em></li>

  		




  
  141
  
    
		<li><ins>underline</ins></li>

  		




  
  142
  
    
		<li><del>strike-through</del></li>

  		




  
  143
  
    
	</ul>

  		




  
  144
  
    

  		




  
  145
  
    

  		




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

  		




  
  147
  
    

  		




  
  148
  
    

  		




  
  149
  
    
	<ul>

  		




  
  150
  
    
	<li><strong>&#33;image_url&#33;</strong> displays an image located at image_url (textile syntax)</li>

  		




  
  151
  
    
		<li><strong>&#33;>image_url&#33;</strong> right floating image</li>

  		




  
  152
  
    
		<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>

  		




  
  153
  
    
	</ul>

  		




  
  154
  
    

  		




  
  155
  
    

  		




  
  156
  
    
	<h3><a name="8" class="wiki-page"></a>Headings</h3>

  		




  
  157
  
    

  		




  
  158
  
    

  		




  
  159
  
    
<pre><code>h1. Heading

  		




  
  160
  
    
h2. Subheading

  		




  
  161
  
    
h3. Subheading

  		




  
  162
  
    
&lt;/code></pre>

  		




  
  163
  
    

  		




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

  		




  
  165
  
    

  		




  
  166
  
    

  		




  
  167
  
    
<pre><code>p&gt;. right aligned

  		




  
  168
  
    
p=. centered

  		




  
  169
  
    
&lt;/code></pre>

  		




  
  170
  
    

  		




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

  		




  
  172
  
    

  		




  
  173
  
    

  		




  
  174
  
    
	<h3><a name="10" class="wiki-page"></a>Blockquotes</h3>

  		




  
  175
  
    

  		




  
  176
  
    

  		




  
  177
  
    
	<p>Start the paragraph with <strong>bq.</strong></p>

  		




  
  178
  
    

  		




  
  179
  
    

  		




  
  180
  
    
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.

  		




  
  181
  
    
To go live, all you need to add is a database and a web server.

  		




  
  182
  
    
&lt;/code></pre>

  		




  
  183
  
    

  		




  
  184
  
    
	<p>Display:</p>

  		




  
  185
  
    

  		




  
  186
  
    

  		




  
  187
  
    
	<blockquote>

  		




  
  188
  
    
		<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>

  		




  
  189
  
    
	</blockquote>

  		




  
  190
  
    

  		




  
  191
  
    

  		




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

  		




  
  193
  
    

  		




  
  194
  
    

  		




  
  195
  
    
<pre><code>{{toc}} =&gt; left aligned toc

  		




  
  196
  
    
{{&gt;toc}} =&gt; right aligned toc

  		




  
  197
  
    
&lt;/code></pre>

  		




  
  198
  
    

  		




  
  199
  
    
	<h2><a name="12" class="wiki-page"></a>Macros</h2>

  		




  
  200
  
    

  		




  
  201
  
    

  		




  
  202
  
    
	<p>Redmine has the following builtin macros:</p>

  		




  
  203
  
    

  		




  
  204
  
    

  		




  
  205
  
    
	<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>

  		




  
  206
  
    

  		




  
  207
  
    

  		




  
  208
  
    
	<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>

  		




  
  209
  
    

  		




  
  210
  
    

  		




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

  		




  
  212
  
    

  		




  
  213
  
    

  		




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

  		




  
  215
  
    

  		




  
  216
  
    

  		




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

  		




  
  218
  
    

  		




  
  219
  
    

  		




  
  220
  
    
<pre><code>&lt;pre&gt;&lt;code class="ruby"&gt;

  		




  
  221
  
    
  Place you code here.

  		




  
  222
  
    
&lt;/code&gt;&lt;/pre&gt;

  		




  
  223
  
    
</pre>&lt;/code>

  		




  
  224
  
    

  		




  
  225
  
    
	<p>Example:</p>

  		




  
  226
  
    

  		




  
  227
  
    

  		




  
  228
  
    
<pre><code class="ruby CodeRay"><span class="no"> 1</span> <span class="c"># The Greeter class</span>

  		




  
  229
  
    
<span class="no"> 2</span> <span class="r">class</span> <span class="cl">Greeter</span>

  		




  
  230
  
    
<span class="no"> 3</span>   <span class="r">def</span> <span class="fu">initialize</span>(name)

  		




  
  231
  
    
<span class="no"> 4</span>     <span class="iv">@name</span> = name.capitalize

  		




  
  232
  
    
<span class="no"> 5</span>   <span class="r">end</span>

  		




  
  233
  
    
<span class="no"> 6</span> 

  		




  
  234
  
    
<span class="no"> 7</span>   <span class="r">def</span> <span class="fu">salute</span>

  		




  
  235
  
    
<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> 

  		




  
  236
  
    
<span class="no"> 9</span>   <span class="r">end</span>

  		




  
  237
  
    
<span class="no"><strong>10</strong></span> <span class="r">end</span>

  		




  
  238
  
    
</pre>&lt;/code>

  		




  
  239
  
    
</body>

  		




  
  240
  
    
</html>

  		















  (2-2/2)