RedmineTextFormatting » History » Version 9

Jean-Philippe Lang, 2008-02-16 16:44
heading fix

1 1 Jean-Philippe Lang
h1. Wiki formatting
2 1 Jean-Philippe Lang
3 1 Jean-Philippe Lang
{{>TOC}}
4 1 Jean-Philippe Lang
5 1 Jean-Philippe Lang
Redmine supports "Textile":http://hobix.com/textile/ syntax for wikis and almost anything that has a text description (issues, news, messages, changesets...).
6 1 Jean-Philippe Lang
7 1 Jean-Philippe Lang
h2. Links
8 1 Jean-Philippe Lang
9 6 Jean-Philippe Lang
h3. Redmine links
10 6 Jean-Philippe Lang
11 1 Jean-Philippe Lang
Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.
12 1 Jean-Philippe Lang
13 8 Jean-Philippe Lang
* Link to an issue: *!#124* (displays #124, link is striked-through if the issue is closed)
14 6 Jean-Philippe Lang
* Link to a changeset: *!r758* (displays r758)
15 1 Jean-Philippe Lang
16 6 Jean-Philippe Lang
Wiki links:
17 1 Jean-Philippe Lang
18 3 Jean-Philippe Lang
* *[[Guide]]* displays a link to the page named 'Guide': [[Guide]]
19 1 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 1 Jean-Philippe Lang
You can also link to pages of an other project wiki:
22 3 Jean-Philippe Lang
23 1 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 1 Jean-Philippe Lang
26 1 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 6 Jean-Philippe Lang
Links to others resources (0.6.devel.1064 and above):
29 6 Jean-Philippe Lang
30 6 Jean-Philippe Lang
* Documents:
31 6 Jean-Philippe Lang
32 6 Jean-Philippe Lang
  * *!document#17* (link to document with id 17)
33 6 Jean-Philippe Lang
  * *!document:Greetings* (link to the document with title "Greetings")
34 6 Jean-Philippe Lang
  * *!document:"Some document"* (double quotes can be used when document title contains spaces)
35 6 Jean-Philippe Lang
36 6 Jean-Philippe Lang
* Versions:
37 6 Jean-Philippe Lang
38 6 Jean-Philippe Lang
  * *!version#3* (link to version with id 3)
39 6 Jean-Philippe Lang
  * *!version:1.0.0* (link to version named "1.0.0")
40 6 Jean-Philippe Lang
  * *!version:"1.0 beta 2"*
41 6 Jean-Philippe Lang
42 6 Jean-Philippe Lang
* Attachments:
43 6 Jean-Philippe Lang
  
44 6 Jean-Philippe Lang
  * *!attachment:file.zip* (link to the attachment of the current object named file.zip)
45 6 Jean-Philippe Lang
  * 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)
46 6 Jean-Philippe Lang
47 6 Jean-Philippe Lang
Escaping (0.6.devel.1064 and above):
48 6 Jean-Philippe Lang
49 6 Jean-Philippe Lang
* You can prevent Redmine links from being parsed by preceding them with an exclamation mark: !
50 6 Jean-Philippe Lang
51 6 Jean-Philippe Lang
h3. External links
52 5 Jean-Philippe Lang
53 5 Jean-Philippe Lang
HTTP URLs and email addresses are automatically turned into clickable links: 
54 5 Jean-Philippe Lang
55 5 Jean-Philippe Lang
<pre>
56 5 Jean-Philippe Lang
http://www.redmine.org, someone@foo.bar
57 5 Jean-Philippe Lang
</pre>
58 5 Jean-Philippe Lang
59 5 Jean-Philippe Lang
displays: http://www.redmine.org, someone@foo.bar
60 5 Jean-Philippe Lang
61 5 Jean-Philippe Lang
If you want to display a specific text instead of the URL, you can use the standard textile syntax:
62 5 Jean-Philippe Lang
63 5 Jean-Philippe Lang
<pre>
64 5 Jean-Philippe Lang
"Redmine web site":http://www.redmine.org
65 5 Jean-Philippe Lang
</pre>
66 5 Jean-Philippe Lang
67 1 Jean-Philippe Lang
displays: "Redmine web site":http://www.redmine.org
68 1 Jean-Philippe Lang
69 1 Jean-Philippe Lang
h2. Text formatting
70 1 Jean-Philippe Lang
71 1 Jean-Philippe Lang
h3. Font style
72 1 Jean-Philippe Lang
73 1 Jean-Philippe Lang
<pre><code>* *bold*
74 1 Jean-Philippe Lang
* _italic_
75 1 Jean-Philippe Lang
* _*bold italic*_
76 1 Jean-Philippe Lang
* +underline+
77 1 Jean-Philippe Lang
* -strike-through-
78 1 Jean-Philippe Lang
</code></pre>
79 1 Jean-Philippe Lang
80 1 Jean-Philippe Lang
Display:
81 1 Jean-Philippe Lang
82 1 Jean-Philippe Lang
 * *bold*
83 1 Jean-Philippe Lang
 * _italic_
84 1 Jean-Philippe Lang
 * _*bold italic*_
85 1 Jean-Philippe Lang
 * +underline+
86 1 Jean-Philippe Lang
 * -strike-through-
87 1 Jean-Philippe Lang
88 9 Jean-Philippe Lang
h3. Inline images
89 1 Jean-Philippe Lang
90 1 Jean-Philippe Lang
* *&#33;image_url&#33;* displays an image located at image_url (textile syntax)
91 1 Jean-Philippe Lang
* *&#33;>image_url&#33;* right floating image
92 1 Jean-Philippe Lang
* If you have an image attached to your wiki page, it can be displayed inline using its filename: *&#33;attached_image.png&#33;*
93 1 Jean-Philippe Lang
94 1 Jean-Philippe Lang
95 1 Jean-Philippe Lang
h3. Headings
96 1 Jean-Philippe Lang
97 1 Jean-Philippe Lang
<pre><code>h1. Heading
98 1 Jean-Philippe Lang
h2. Subheading
99 1 Jean-Philippe Lang
h3. Subheading
100 1 Jean-Philippe Lang
</code></pre>
101 1 Jean-Philippe Lang
102 1 Jean-Philippe Lang
h3. Paragraphs
103 1 Jean-Philippe Lang
104 1 Jean-Philippe Lang
<pre><code>p>. right aligned
105 1 Jean-Philippe Lang
p=. centered
106 1 Jean-Philippe Lang
</code></pre>
107 2 Jean-Philippe Lang
108 1 Jean-Philippe Lang
p=. This is centered paragraph.
109 1 Jean-Philippe Lang
110 1 Jean-Philippe Lang
h3. Blockquotes
111 1 Jean-Philippe Lang
112 1 Jean-Philippe Lang
Start the paragraph with *bq.*
113 1 Jean-Philippe Lang
114 1 Jean-Philippe Lang
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
115 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
116 1 Jean-Philippe Lang
</code></pre>
117 1 Jean-Philippe Lang
118 1 Jean-Philippe Lang
Display:
119 1 Jean-Philippe Lang
120 1 Jean-Philippe Lang
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
121 1 Jean-Philippe Lang
To go live, all you need to add is a database and a web server.
122 1 Jean-Philippe Lang
123 1 Jean-Philippe Lang
h3. Table of content
124 1 Jean-Philippe Lang
125 1 Jean-Philippe Lang
<pre><code>{{toc}} => left aligned toc
126 1 Jean-Philippe Lang
{{>toc}} => right aligned toc
127 1 Jean-Philippe Lang
</code></pre>
128 1 Jean-Philippe Lang
129 7 Jean-Philippe Lang
h2. Macros
130 7 Jean-Philippe Lang
131 7 Jean-Philippe Lang
Redmine has the following builtin macros:
132 7 Jean-Philippe Lang
133 7 Jean-Philippe Lang
{{macro_list}}
134 7 Jean-Philippe Lang
135 7 Jean-Philippe Lang
136 1 Jean-Philippe Lang
h2. Code highlighting
137 4 Jean-Philippe Lang
138 1 Jean-Philippe Lang
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.
139 1 Jean-Philippe Lang
140 1 Jean-Philippe Lang
You can highlight code in your wiki page using this syntax:
141 1 Jean-Philippe Lang
142 1 Jean-Philippe Lang
<pre><code><pre><code class="ruby">
143 1 Jean-Philippe Lang
  Place you code here.
144 1 Jean-Philippe Lang
</code></pre>
145 1 Jean-Philippe Lang
</pre></code>
146 1 Jean-Philippe Lang
147 1 Jean-Philippe Lang
Example:
148 1 Jean-Philippe Lang
149 1 Jean-Philippe Lang
<pre><code class="ruby">
150 1 Jean-Philippe Lang
# The Greeter class
151 1 Jean-Philippe Lang
class Greeter
152 1 Jean-Philippe Lang
  def initialize(name)
153 1 Jean-Philippe Lang
    @name = name.capitalize
154 1 Jean-Philippe Lang
  end
155 1 Jean-Philippe Lang
 
156 1 Jean-Philippe Lang
  def salute
157 1 Jean-Philippe Lang
    puts "Hello #{@name}!"
158 1 Jean-Philippe Lang
  end
159 1 Jean-Philippe Lang
end
160 1 Jean-Philippe Lang
</pre></code>