RedmineTextFormatting » History » Revision 4
Revision 3 (Jean-Philippe Lang, 2007-10-13 12:22) → Revision 4/127 (Jean-Philippe Lang, 2007-12-07 21:32)
h1. Wiki formatting
{{>TOC}}
Redmine supports "Textile":http://hobix.com/textile/ syntax for wikis and almost anything that has a text description (issues, news, messages, changesets...).
h2. Links
Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.
h3. Links to issues and changesets
* Link to an issue: #1
* Link to a changeset: r5
h3. Wiki links
* *[[Guide]]* displays a link to the page named 'Guide': [[Guide]]
* *[[Guide|User manual]]* displays a link to the same page but with a different text: [[Guide|User manual]]
You can also link to pages of an other project wiki:
* *[[sandbox:some page]]* displays a link to the page named 'Some page' of the Sandbox wiki
* *[[sandbox:]]* displays a link to the Sandbox wiki main page
Wiki links are displayed in red if the page doesn't exist yet, eg: [[Nonexistent page]].
h3. Links to an external URL
HTTP URLs and email addresses are automatically turned into clickable links: http://www.redmine.org, someone@foo.bar
h2. Text formatting
h3. Font style
<pre><code>* *bold*
* _italic_
* _*bold italic*_
* +underline+
* -strike-through-
</code></pre>
Display:
* *bold*
* _italic_
* _*bold italic*_
* +underline+
* -strike-through-
h2. Inline images
* *!image_url!* displays an image located at image_url (textile syntax)
* *!>image_url!* right floating image
* If you have an image attached to your wiki page, it can be displayed inline using its filename: *!attached_image.png!*
h3. Headings
<pre><code>h1. Heading
h2. Subheading
h3. Subheading
</code></pre>
h3. Paragraphs
<pre><code>p>. right aligned
p=. centered
</code></pre>
p=. This is centered paragraph.
h3. Blockquotes
Start the paragraph with *bq.*
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
To go live, all you need to add is a database and a web server.
</code></pre>
Display:
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
To go live, all you need to add is a database and a web server.
h3. Table of content
<pre><code>{{toc}} => left aligned toc
{{>toc}} => right aligned toc
</code></pre>
h2. Code highlighting
Code highlightment relies on "CodeRay":http://coderay.rubychan.de/, a fast syntax highlighting library written completely in Ruby. It currently supports c, html, javascript, rhtml, ruby, scheme, xml languages.
You can highlight code in your wiki page using this syntax:
<pre><code><pre><code class="ruby">
Place you code here.
</code></pre>
</pre></code>
Example:
<pre><code class="ruby">
# The Greeter class
class Greeter
def initialize(name)
@name = name.capitalize
end
def salute
puts "Hello #{@name}!"
end
end
</pre></code>