jro_apps/redmine Commit - r2013:1169ff05aff2

1

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

1

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

2

2

3

<head>

3

<head>

4

<title>RedmineWikiFormatting</title>

4

<title>RedmineWikiFormatting</title>

5

5

6

6

7

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

7

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

8

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

8

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

9

pre, code { font-size:120%; }

9

pre, code { font-size:120%; }

10

pre code { font-size:100%; }

10

pre code { font-size:100%; }

11

pre {

11

pre {

12

margin: 1em 1em 1em 1.6em;

12

margin: 1em 1em 1em 1.6em;

13

padding: 2px;

13

padding: 2px;

14

background-color: #fafafa;

14

background-color: #fafafa;

15

border: 1px solid #dadada;

15

border: 1px solid #dadada;

16

width:95%;

16

width:95%;

17

overflow-x: auto;

17

overflow-x: auto;

18

}

18

}

19

a.new { color: #b73535; }

19

a.new { color: #b73535; }

20

21

.CodeRay .af { color:#~~00C~~ }

21

.CodeRay .c { color:#666; }

22

.CodeRay .an { color:#007 }

22

23

.CodeRay .av { color:#~~700~~ }

23

.CodeRay .cl { color:#B06; font-weight:bold }

24

.CodeRay .aw { color:~~#C00~~ }

24

.CodeRay .dl { color:black }

25

.CodeRay .bi { color:#~~509~~; font-weight:bold }

25

.CodeRay .fu { color:#06B; font-weight:bold }

26

.CodeRay .c { color:#666; }

26

27

.CodeRay .il { background: #eee }

28

.CodeRay .ch { color:#04D }

28

.CodeRay .il .idl { font-weight: bold; color: #888 }

29

.CodeRay .ch .k { color:#04D }

29

30

.CodeRay .ch .dl { color:#~~039~~ }

30

.CodeRay .iv { color:#33B }

31

.CodeRay .r { color:#080; font-weight:bold }

32

.CodeRay .cl { color:#B06; font-weight:bold }

32

33

.CodeRay .co { color:#036; font-weight:bold }

33

.CodeRay .s { background-color:#fff0f0 }

34

.CodeRay .cr { color:#0A0 }

34

.CodeRay .s .dl { color:#710 }

35

.CodeRay .cv { color:#369 }

35

</style>

36

.CodeRay .df { color:#099; font-weight:bold }

36

</head>

37

.CodeRay .di { color:#088; font-weight:bold }

37

38

.CodeRay .dl { color:black }

38

<body>

39

.CodeRay .do { color:#970 }

39

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

40

.CodeRay .ds { color:#D42; font-weight:bold }

40

41

.CodeRay .e { color:#666; font-weight:bold }

41

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

42

.CodeRay .en { color:#800; font-weight:bold }

42

43

.CodeRay .er { color:#F00; background-color:#FAA }

43

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

44

.CodeRay .ex { color:#F00; font-weight:bold }

44

45

.CodeRay .fl { color:#60E; font-weight:bold }

45

Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.

46

.CodeRay .fu { color:#06B; font-weight:bold }

46

<ul>

47

.CodeRay .gv { color:#d70; font-weight:bold }

47

<li>Link to an issue: #124 (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

.CodeRay .hx { color:#058; font-weight:bold }

48

<li>Link to a changeset: r758 (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

.CodeRay .i { color:#00D; font-weight:bold }

49

<li>Link to a changeset with a non-numeric hash: commit:c6f4d0fd (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

.CodeRay .ic { color:#B44; font-weight:bold }

50

</ul>

51

52

.CodeRay .il { background: #eee }

52

Wiki links:

53

.CodeRay .il .il { background: #ddd }

53

54

.CodeRay .il .il .il { background: #ccc }

54

<ul>

55

.CodeRay .il .idl { font-weight: bold; color: #888 }

55

<li>[[Guide]] displays a link to the page named 'Guide': <a href="Guide.html" class="wiki-page">Guide</a></li>

56

<li>[[Guide#further-reading]] takes you to the anchor "further-reading". Headings get automatically assigned anchors so that you can refer to them: <a href="Guide.html#further-reading" class="wiki-page">Guide</a></li>

57

.CodeRay .in { color:#B2B; font-weight:bold }

57

<li>[[Guide|User manual]] displays a link to the same page but with a different text: <a href="Guide.html" class="wiki-page">User manual</a></li>

58

.CodeRay .iv { color:#33B }

58

</ul>

59

.CodeRay .la { color:#970; font-weight:bold }

59

60

.CodeRay .lv { color:#963 }

60

You can also link to pages of an other project wiki:

61

.CodeRay .oc { color:#40E; font-weight:bold }

61

62

.CodeRay .of { color:#000; font-weight:bold }

62

<ul>

63

.CodeRay .op { }

63

<li>[[sandbox:some page]] displays a link to the page named 'Some page' of the Sandbox wiki</li>

64

.CodeRay .pc { color:#038; font-weight:bold }

64

<li>[[sandbox]] displays a link to the Sandbox wiki main page</li>

65

.CodeRay .pd { color:#369; font-weight:bold }

65

</ul>

66

.CodeRay .pp { color:#579 }

66

67

.CodeRay .pt { color:#339; font-weight:bold }

67

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

68

.CodeRay .r { color:#080; font-weight:bold }

68

69

Links to others resources (0.7):

70

.CodeRay .rx { background-color:#fff0ff }

70

71

.CodeRay .rx .k { color:#808 }

71

<ul>

72

.CodeRay .rx .dl { color:#404 }

72

<li>Documents:

73

.CodeRay .rx .mod { color:#C2C }

73

<ul>

74

.CodeRay .rx .fu { color:#404; font-weight: bold }

74

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

75

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

76

.CodeRay .s { background-color:#fff0f0 }

76

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

77

.CodeRay .s .s { background-color:#ffe0e0 }

77

</ul></li>

78

.CodeRay .s .s .s { background-color:#ffd0d0 }

78

</ul>

79

.CodeRay .s .k { color:#D20 }

79

80

.CodeRay .s .dl { color:#710 }

80

<ul>

81

<li>Versions:

82

.CodeRay .sh { background-color:#f0fff0 }

82

<ul>

83

.CodeRay .sh .k { color:#2B2 }

83

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

84

.CodeRay .sh .dl { color:#161 }

84

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

85

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

86

.CodeRay .sy { color:#A60 }

86

</ul></li>

87

.CodeRay .sy .k { color:#A60 }

87

</ul>

88

.CodeRay .sy .dl { color:#630 }

88

89

<ul>

90

.CodeRay .ta { color:#070 }

90

<li>Attachments:

91

.CodeRay .tf { color:#070; font-weight:bold }

91

<ul>

92

.CodeRay .ts { color:#D70; font-weight:bold }

92

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

93

.CodeRay .ty { color:#339; font-weight:bold }

93

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

94

.CodeRay .v { color:#036 }

94

</ul></li>

95

.CodeRay .xt { color:#444 }

95

</ul>

96

</style>

96

97

</head>

97

<ul>

98

<li>Repository files

99

<body>

99

<ul>

100

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

100

<li>source:some/file -- Link to the file located at /some/file in the project's repository</li>

101

<li>source:some/file@52 -- Link to the file's revision 52</li>

102

<li>source:some/file#L120 -- Link to line 120 of the file</li>

103

<li>source:some/file@52#L120 -- Link to line 120 of the file's revision 52</li>

104

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

104

<li>export:some/file -- Force the download of the file</li>

105

</ul></li>

106

</ul>

107

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

107

108

Escaping (0.7):

109

110

Redmine allows hyperlinking between issues, changesets and wiki pages from anywhere wiki formatting is used.

110

<ul>

111

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

112

</ul>

113

<ul>

113

114

<li>Link to an issue: #124 (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>

114

115

<li>Link to a changeset: r758 (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>

115

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

116

<li>Link to a changeset with a non-numeric hash: commit:c6f4d0fd (displays c6f4d0fd). Added in <a href="/repositories/revision/1?rev=1236" class="changeset" title="Merged Git support branch (r1200 to r1226).">r1236</a>.</li>

116

117

</ul>

117

HTTP URLs and email addresses are automatically turned into clickable links:

118

119

<pre>

120

Wiki links:

120

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

121

</pre>

122

123

<ul>

123

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>

124

<li>[[Guide]] displays a link to the page named 'Guide': <a href="Guide.html" class="wiki-page">Guide</a></li>

124

125

<li>[[Guide|User manual]] displays a link to the same page but with a different text: <a href="Guide.html" class="wiki-page">User manual</a></li>

125

If you want to display a specific text instead of the URL, you can use the standard textile syntax:

126

</ul>

126

127

<pre>

128

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

129

You can also link to pages of an other project wiki:

129

</pre>

130

131

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

132

<ul>

132

133

<li>[[sandbox:some page]] displays a link to the page named 'Some page' of the Sandbox wiki</li>

133

134

<li>[[sandbox:]] displays a link to the Sandbox wiki main page</li>

134

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

135

</ul>

135

136

137

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.

138

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

138

139

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

140

141

Links to others resources (0.7):

141

<pre>

142

* *bold*

143

* _italic_

144

<ul>

144

* _*bold italic*_

145

<li>Documents:

145

* +underline+

146

* -strike-through-

147

<ul>

147

</pre>

148

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

148

149

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

149

Display:

150

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

150

151

</ul></li>

151

<ul>

152

</ul>

152

153

<li>italic</li>

154

<li>*bold italic*</li>

155

<ul>

155

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

156

<li>Versions:

156

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

157

</ul>

158

<ul>

158

159

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

159

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

160

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

160

161

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

161

<ul>

162

</ul></li>

162

<li>!image_url! displays an image located at image_url (textile syntax)</li>

163

</ul>

163

<li>!>image_url! right floating image</li>

164

<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: !attached_image.png!</li>

165

</ul>

166

<ul>

166

167

<li>Attachments:

167

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

168

169

<ul>

169

<pre>

170

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

170

h1. Heading

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>

171

h2. Subheading

172

</ul></li>

172

h3. Subsubheading

173

</ul>

173

</pre>

174

175

Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.

176

<ul>

176

177

<li>Repository files

177

178

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

179

<ul>

179

180

<li>source:some/file -- Link to the file located at /some/file in the project's repository</li>

180

<pre>

181

<li>source:some/file@52 -- Link to the file's revision 52</li>

181

p>. right aligned

182

p=. centered

183

<li>source:some/file#L120 -- Link to line 120 of the file</li>

183

</pre>

184

<li>source:some/file@52#L120 -- Link to line 120 of the file's revision 52</li>

184

185

<li>export:some/file -- Force the download of the file</li>

185

This is centered paragraph.

186

</ul></li>

186

187

188

</ul>

188

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

189

190

Start the paragraph with bq.

191

192

Escaping (0.7):

192

<pre>

193

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

194

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

195

<ul>

195

</pre>

196

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

196

197

</ul>

197

Display:

198

199

200

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

200

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.

201

</blockquote>

202

203

HTTP URLs and email addresses are automatically turned into clickable links:

203

204

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

205

206

<pre>

206

<pre>

207

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

207

{{toc}} => left aligned toc

208

</pre>

208

{{>toc}} => right aligned toc

209

</pre>

210

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>

210

211

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

212

213

If you want to display a specific text instead of the URL, you can use the standard textile syntax:

213

Redmine has the following builtin macros:

214

215

<dl><dt><code>hello_world</code></dt><dd>Sample macro.</dd><dt><code>include</code></dt><dd>Include a wiki page. Example:

216

<pre>

216

217

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

217

<pre><code>{{include(Foo)}}</code></pre></dd><dt><code>macro_list</code></dt><dd>Displays a list of all available macros, including description if available.</dd></dl>

218

</pre>

218

219

220

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

220

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

221

222

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.

223

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

223

224

You can highlight code in your wiki page using this syntax:

225

226

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.

226

<pre>

227

228

Place you code here.

229

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

229

</code></pre>

230

</pre>

231

232

<pre>

232

Example:

233

* *bold*

233

234

* _italic_

234

<pre><code class="ruby CodeRay"> 1 # The Greeter class

235

* _*bold italic*_

235

2 class Greeter

236

* +underline+

236

3 def initialize(name)

237

* -strike-through-

237

4 @name = name.capitalize

238

</pre>

238

5 end

239

6

240

Display:

240

7 def salute

241

8 puts "Hello #{@name}!"

242

9 end

243

<ul>

243

10 end

244

244

</code>

245

<li>italic</li>

245

</pre>

246

<li>*bold italic*</li>

246

</body>

247

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

247

</html>

248

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

249

</ul>

250

251

252

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

253

254

255

<ul>

256

<li>!image_url! displays an image located at image_url (textile syntax)</li>

257

<li>!>image_url! right floating image</li>

258

<li>If you have an image attached to your wiki page, it can be displayed inline using its filename: !attached_image.png!</li>

259

</ul>

260

261

262

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

263

264

265

<pre>

266

h1. Heading

267

h2. Subheading

268

h3. Subheading

269

</pre>

270

271

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

272

273

274

<pre>

275

p>. right aligned

276

p=. centered

277

</pre>

278

279

This is centered paragraph.

280

281

282

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

283

284

285

Start the paragraph with bq.

286

287

288

<pre>

289

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

290

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

291

</pre>

292

293

Display:

294

295

296

297

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.

298

</blockquote>

299

300

301

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

302

303

304

<pre>

305

{{toc}} => left aligned toc

306

{{>toc}} => right aligned toc

307

</pre>

308

309

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

310

311

312

Redmine has the following builtin macros:

313

314

315

<dl><dt><code>hello_world</code></dt><dd>Sample macro.</dd><dt><code>include</code></dt><dd>Include a wiki page. Example:

316

317

318

<pre><code>{{include(Foo)}}</code></pre></dd><dt><code>macro_list</code></dt><dd>Displays a list of all available macros, including description if available.</dd></dl>

319

320

321

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

322

323

324

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.

325

326

327

You can highlight code in your wiki page using this syntax:

328

329

330

<pre>

331

332

Place you code here.

333

</code></pre>

334

</pre>

335

336

Example:

337

338

339

<pre><code class="ruby CodeRay"> 1 # The Greeter class

340

2 class Greeter

341

3 def initialize(name)

342

4 @name = name.capitalize

343

5 end

344

6

345

7 def salute

346

8 puts "Hello #{@name}!"

347

9 end

348

10 end

349

</code>

350

</pre>

351

</body>

352

</html>

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages