jro_apps/redmine Commit - r7283:2504682ebbff

1

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

2

3

<head>

4

<title>RedmineWikiFormatting</title>

5

6

7

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

8

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

9

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

10

pre code { font-size:100%; }

11

pre {

12

margin: 1em 1em 1em 1.6em;

13

padding: 2px;

14

background-color: #fafafa;

15

border: 1px solid #dadada;

16

width:95%;

17

overflow-x: auto;

18

}

19

a.new { color: #b73535; }

20

21

.CodeRay .c { color:#666; }

22

23

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

24

.CodeRay .dl { color:black }

25

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

26

27

.CodeRay .il { background: #eee }

28

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

29

30

.CodeRay .iv { color:#33B }

31

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

32

33

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

34

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

35

</style>

36

</head>

37

38

<body>

39

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

40

41

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

42

43

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

44

45

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

46

<ul>

47

<li>Link to an issue: #124 (displays <del><a href="#" 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

<li>Link to a changeset: r758 (displays <a href="#" class="changeset" title="Search engine now only searches objects the user is allowed to view.">r758</a>)</li>

49

<li>Link to a changeset with a non-numeric hash: commit:c6f4d0fd (displays <a href="#" class="changeset">c6f4d0fd</a>).</li>

50

<li>Link to a changeset of another project: sandbox:r758 (displays <a href="#" class="changeset" title="Search engine now only searches objects the user is allowed to view.">sandbox:r758</a>)</li>

51

<li>Link to a changeset with a non-numeric hash: sandbox:c6f4d0fd (displays <a href="#" class="changeset">sandbox:c6f4d0fd</a>).</li>

52

</ul>

53

54

Wiki links:

55

56

<ul>

57

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

58

<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="#" class="wiki-page">Guide</a></li>

59

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

60

</ul>

61

62

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

63

64

<ul>

65

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

66

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

67

</ul>

68

69

Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.

70

71

Links to other resources:

72

73

<ul>

74

<li>Documents:

75

<ul>

76

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

77

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

78

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

79

<li>sandbox:document:"Some document" (link to a document with title "Some document" in other project "sandbox")</li>

80

</ul></li>

81

</ul>

82

83

<ul>

84

<li>Versions:

85

<ul>

86

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

87

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

88

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

89

<li>sandbox:version:1.0.0 (link to version "1.0.0" in the project "sandbox")</li>

90

</ul></li>

91

</ul>

92

93

<ul>

94

<li>Attachments:

95

<ul>

96

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

97

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

98

</ul></li>

99

</ul>

100

101

<ul>

102

<li>Repository files:

103

<ul>

104

<li>source:some/file (link to the file located at /some/file in the project's repository)</li>

105

<li>source:some/file@52 (link to the file's revision 52)</li>

106

<li>source:some/file#L120 (link to line 120 of the file)</li>

107

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

108

<li>source:"some file@52#L120" (use double quotes when the URL contains spaces</li>

109

<li>export:some/file (force the download of the file)</li>

110

<li>sandbox:source:some/file (link to the file located at /some/file in the repository of the project "sandbox")</li>

111

<li>sandbox:export:some/file (force the download of the file)</li>

112

</ul></li>

113

</ul>

114

115

<ul>

116

<li>Forum messages:

117

<ul>

118

<li>message#1218 (link to message with id 1218)</li>

119

</ul></li>

120

</ul>

121

122

<ul>

123

<li>Projects:

124

<ul>

125

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

126

<li>project:someproject (link to project named "someproject")</li>

127

</ul></li>

128

</ul>

129

130

131

Escaping:

132

133

<ul>

134

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

135

</ul>

136

137

138

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

139

140

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

141

142

<pre>

143

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

144

</pre>

145

146

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>

147

148

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

149

150

<pre>

151

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

152

</pre>

153

154

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

155

156

157

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

158

159

160

For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://www.textism.com/tools/textile/">http://www.textism.com/tools/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.

161

162

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

163

164

<pre>

165

* *bold*

166

* _italic_

167

* _*bold italic*_

168

* +underline+

169

* -strike-through-

170

</pre>

171

172

Display:

173

174

<ul>

175

176

<li>italic</li>

177

<li>*bold italic*</li>

178

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

179

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

180

</ul>

181

182

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

183

184

<ul>

185

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

186

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

187

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

188

</ul>

189

190

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

191

192

<pre>

193

h1. Heading

194

h2. Subheading

195

h3. Subsubheading

196

</pre>

197

198

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

199

200

201

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

202

203

<pre>

204

p>. right aligned

205

p=. centered

206

</pre>

207

208

This is a centered paragraph.

209

210

211

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

212

213

Start the paragraph with bq.

214

215

<pre>

216

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

217

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

218

</pre>

219

220

Display:

221

222

223

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.

224

</blockquote>

225

226

227

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

228

229

<pre>

230

{{toc}} => left aligned toc

231

{{>toc}} => right aligned toc

232

</pre>

233

234

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

235

236

Redmine has the following builtin macros:

237

238

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

239

240

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

241

242

243

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

244

245

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, cpp, css, delphi, groovy, html, java, javascript, json, php, python, rhtml, ruby, scheme, sql, xml and yaml languages.

246

247

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

248

249

<pre>

250

251

Place you code here.

252

</code></pre>

253

</pre>

254

255

Example:

256

257

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

258

2 class Greeter

259

3 def initialize(name)

260

4 @name = name.capitalize

261

5 end

262

6

263

7 def salute

264

8 puts "Hello #{@name}!"

265

9 end

266

10 end

267

</code>

268

</pre>

269

</body>

270

</html>

1

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

2

3

<head>

4

<title>RedmineWikiFormatting</title>

5

6

7

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

8

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

9

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

10

pre code { font-size:100%; }

11

pre {

12

margin: 1em 1em 1em 1.6em;

13

padding: 2px;

14

background-color: #fafafa;

15

border: 1px solid #dadada;

16

width:95%;

17

overflow-x: auto;

18

}

19

a.new { color: #b73535; }

20

21

.CodeRay .c { color:#666; }

22

23

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

24

.CodeRay .dl { color:black }

25

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

26

27

.CodeRay .il { background: #eee }

28

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

29

30

.CodeRay .iv { color:#33B }

31

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

32

33

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

34

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

35

</style>

36

</head>

37

38

<body>

39

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

40

41

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

42

43

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

44

45

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

46

<ul>

47

<li>Link to an issue: #124 (displays <del><a href="#" 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

<li>Link to a changeset: r758 (displays <a href="#" class="changeset" title="Search engine now only searches objects the user is allowed to view.">r758</a>)</li>

49

<li>Link to a changeset with a non-numeric hash: commit:c6f4d0fd (displays <a href="#" class="changeset">c6f4d0fd</a>).</li>

50

<li>Link to a changeset of another project: sandbox:r758 (displays <a href="#" class="changeset" title="Search engine now only searches objects the user is allowed to view.">sandbox:r758</a>)</li>

51

<li>Link to a changeset with a non-numeric hash: sandbox:c6f4d0fd (displays <a href="#" class="changeset">sandbox:c6f4d0fd</a>).</li>

52

</ul>

53

54

Wiki links:

55

56

<ul>

57

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

58

<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="#" class="wiki-page">Guide</a></li>

59

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

60

</ul>

61

62

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

63

64

<ul>

65

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

66

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

67

</ul>

68

69

Wiki links are displayed in red if the page doesn't exist yet, eg: <a href="#" class="wiki-page new">Nonexistent page</a>.

70

71

Links to other resources:

72

73

<ul>

74

<li>Documents:

75

<ul>

76

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

77

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

78

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

79

<li>sandbox:document:"Some document" (link to a document with title "Some document" in other project "sandbox")</li>

80

</ul></li>

81

</ul>

82

83

<ul>

84

<li>Versions:

85

<ul>

86

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

87

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

88

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

89

<li>sandbox:version:1.0.0 (link to version "1.0.0" in the project "sandbox")</li>

90

</ul></li>

91

</ul>

92

93

<ul>

94

<li>Attachments:

95

<ul>

96

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

97

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

98

</ul></li>

99

</ul>

100

101

<ul>

102

<li>Repository files:

103

<ul>

104

<li>source:some/file (link to the file located at /some/file in the project's repository)</li>

105

<li>source:some/file@52 (link to the file's revision 52)</li>

106

<li>source:some/file#L120 (link to line 120 of the file)</li>

107

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

108

<li>source:"some file@52#L120" (use double quotes when the URL contains spaces</li>

109

<li>export:some/file (force the download of the file)</li>

110

<li>sandbox:source:some/file (link to the file located at /some/file in the repository of the project "sandbox")</li>

111

<li>sandbox:export:some/file (force the download of the file)</li>

112

</ul></li>

113

</ul>

114

115

<ul>

116

<li>Forum messages:

117

<ul>

118

<li>message#1218 (link to message with id 1218)</li>

119

</ul></li>

120

</ul>

121

122

<ul>

123

<li>Projects:

124

<ul>

125

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

126

<li>project:someproject (link to project named "someproject")</li>

127

</ul></li>

128

</ul>

129

130

131

Escaping:

132

133

<ul>

134

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

135

</ul>

136

137

138

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

139

140

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

141

142

<pre>

143

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

144

</pre>

145

146

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>

147

148

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

149

150

<pre>

151

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

152

</pre>

153

154

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

155

156

157

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

158

159

160

For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See <a class="external" href="http://www.textism.com/tools/textile/">http://www.textism.com/tools/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.

161

162

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

163

164

<pre>

165

* *bold*

166

* _italic_

167

* _*bold italic*_

168

* +underline+

169

* -strike-through-

170

</pre>

171

172

Display:

173

174

<ul>

175

176

<li>italic</li>

177

<li>*bold italic*</li>

178

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

179

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

180

</ul>

181

182

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

183

184

<ul>

185

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

186

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

187

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

188

</ul>

189

190

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

191

192

<pre>

193

h1. Heading

194

h2. Subheading

195

h3. Subsubheading

196

</pre>

197

198

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

199

200

201

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

202

203

<pre>

204

p>. right aligned

205

p=. centered

206

</pre>

207

208

This is a centered paragraph.

209

210

211

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

212

213

Start the paragraph with bq.

214

215

<pre>

216

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

217

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

218

</pre>

219

220

Display:

221

222

223

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.

224

</blockquote>

225

226

227

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

228

229

<pre>

230

{{toc}} => left aligned toc

231

{{>toc}} => right aligned toc

232

</pre>

233

234

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

235

236

Redmine has the following builtin macros:

237

238

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

239

240

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

241

242

243

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

244

245

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, cpp, css, delphi, groovy, html, java, javascript, json, php, python, rhtml, ruby, scheme, sql, xml and yaml languages.

246

247

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

248

249

<pre>

250

251

Place you code here.

252

</code></pre>

253

</pre>

254

255

Example:

256

257

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

258

2 class Greeter

259

3 def initialize(name)

260

4 @name = name.capitalize

261

5 end

262

6

263

7 def salute

264

8 puts "Hello #{@name}!"

265

9 end

266

10 end

267

</code>

268

</pre>

269

</body>

270

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