Project

General

Profile

RedmineTextFormatting » History » Version 3

Jean-Philippe Lang, 2007-10-13 12:22

1 1 Jean-Philippe Lang
h1. Wiki formatting
2
3
{{>TOC}}
4
5
Redmine supports "Textile":http://hobix.com/textile/ syntax for wikis and almost anything that has a text description (issues, news, messages, changesets...).
6
7
h2. Links
8
9
Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.
10
11
h3. Links to issues and changesets
12
13
* Link to an issue: #1
14
* Link to a changeset: r5
15
16
h3. Wiki links
17
18
* *[[Guide]]* displays a link to the page named 'Guide': [[Guide]]
19 3 Jean-Philippe Lang
* *[[Guide|User manual]]* displays a link to the same page but with a different text: [[Guide|User manual]]
20 1 Jean-Philippe Lang
21
You can also link to pages of an other project wiki:
22
23 3 Jean-Philippe Lang
* *[[sandbox:some page]]* displays a link to the page named 'Some page' of the Sandbox wiki
24 1 Jean-Philippe Lang
* *[[sandbox:]]* displays a link to the Sandbox wiki main page
25
26 3 Jean-Philippe Lang
Wiki links are displayed in red if the page doesn't exist yet, eg: [[Nonexistent page]].
27 1 Jean-Philippe Lang
28
h3. Links to an external URL
29
30
HTTP URLs and email addresses are automatically turned into clickable links: http://www.redmine.org, someone@foo.bar
31
32
h2. Text formatting
33
34
h3. Font style
35
36
<pre><code>* *bold*
37
* _italic_
38
* _*bold italic*_
39
* +underline+
40
* -strike-through-
41
</code></pre>
42
43
Display:
44
45
 * *bold*
46
 * _italic_
47
 * _*bold italic*_
48
 * +underline+
49
 * -strike-through-
50
51
h2. Inline images
52
53
* *&#33;image_url&#33;* displays an image located at image_url (textile syntax)
54
* *&#33;>image_url&#33;* right floating image
55
* If you have an image attached to your wiki page, it can be displayed inline using its filename: *&#33;attached_image.png&#33;*
56
57
58
h3. Headings
59
60
<pre><code>h1. Heading
61
h2. Subheading
62
h3. Subheading
63
</code></pre>
64
65
h3. Paragraphs
66
67
<pre><code>p>. right aligned
68
p=. centered
69
</code></pre>
70
71 2 Jean-Philippe Lang
p=. This is centered paragraph.
72 1 Jean-Philippe Lang
73
h3. Blockquotes
74
75
Start the paragraph with *bq.*
76
77
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
78
To go live, all you need to add is a database and a web server.
79
</code></pre>
80
81
Display:
82
83
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
84
To go live, all you need to add is a database and a web server.
85
86
h3. Table of content
87
88
<pre><code>{{toc}} => left aligned toc
89
{{>toc}} => right aligned toc
90
</code></pre>
91
92
h2. Code highlighting
93
94
Code highlightment relies on "CodeRay":http://coderay.rubychan.de/, a fast syntax highlighting library written completely in Ruby. It currently supports c, html, rhtml, ruby, scheme, xml languages.
95
96
You can highlight code in your wiki page using this syntax:
97
98
<pre><code><pre><code class="ruby">
99
  Place you code here.
100
</code></pre>
101
</pre></code>
102
103
Example:
104
105
<pre><code class="ruby">
106
# The Greeter class
107
class Greeter
108
  def initialize(name)
109
    @name = name.capitalize
110
  end
111
 
112
  def salute
113
    puts "Hello #{@name}!"
114
  end
115
end
116
</pre></code>