##// END OF EJS Templates
jro_apps » redmine
RSS
Merged r14761 from trunk to 3.0-stable (#20911, #21105)...
Toshi MARUYAMA -
r14382:e4baf04c259d
parent child
Show More
Side by Side Unified
Context file:
r14382:e4baf04c259d Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,333 +1,333
1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2 2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
3 3 <head>
4 4 <title>RedmineWikiFormatting</title>
5 5 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
6 6 <style type="text/css">
7 7 body { font:80% Verdana,Tahoma,Arial,sans-serif; }
8 8 h1, h2, h3, h4 { font-family: Trebuchet MS,Georgia,"Times New Roman",serif; }
9 9 pre, code { font-size:120%; }
10 10 pre code { font-size:100%; }
11 11 pre {
12 12 margin: 1em 1em 1em 1.6em;
13 13 padding: 2px;
14 14 background-color: #fafafa;
15 15 border: 1px solid #dadada;
16 16 width:95%;
17 17 overflow-x: auto;
18 18 }
19 19 a.new { color: #b73535; }
20 20
21 21 .syntaxhl .line-numbers { padding: 2px 4px 2px 4px; background-color: #eee; margin:0 }
22 22 .syntaxhl .comment { color:#666; }
23 23
24 24 .syntaxhl .class { color:#B06; font-weight:bold }
25 25 .syntaxhl .delimiter { color:black }
26 26 .syntaxhl .function { color:#06B; font-weight:bold }
27 27
28 28 .syntaxhl .inline { background: #eee }
29 29 .syntaxhl .inline .inline-delimiter { font-weight: bold; color: #888 }
30 30
31 31 .syntaxhl .instance-variable { color:#33B }
32 32 .syntaxhl .reserved { color:#080; font-weight:bold }
33 33
34 34 .syntaxhl .string { background-color:#fff0f0; color: #D20; }
35 35 .syntaxhl .string .delimiter { color:#710 }
36 36
37 37 </style>
38 38 </head>
39 39
40 40 <body>
41 41 <h1><a name="1" class="wiki-page"></a>Wiki記法</h1>
42 42
43 43 <h2><a name="2" class="wiki-page"></a>リンク</h2>
44 44
45 45 <h3><a name="3" class="wiki-page">Redmine内のリンク</a></h3>
46 46
47 47 <p>RedmineはWiki記法が使える箇所のどこからでも、チケット・チェンジセット・Wikiページなどリソース間へリンクを行うことができます。</p>
48 48 <ul>
49 49 <li>チケットへのリンク: <strong>#124</strong> (終了したチケットは <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del> のように取り消し線付きで表示されます)</li>
50 50 <li>チケットの注記へのリンク: <strong>#124-6</strong> または <strong>#124#note-6</strong></li>
51 51 </ul>
52 52
53 53 <p>Wikiへのリンク:</p>
54 54
55 55 <ul>
56 56 <li><strong>[[Guide]]</strong> "Guide"という名前のページへのリンクです: <a href="#" class="wiki-page">Guide</a></li>
57 57 <li><strong>[[Guide#further-reading]]</strong> "Guide"というページ内の"further-reading"というアンカーに飛びます。見出しには自動的にアンカーが設定されるのでリンク先とすることができます: <a href="#" class="wiki-page">Guide</a></li>
58 58 <li><strong>[[Guide|User manual]]</strong> "Guide"というページへのリンクを異なるテキストで表示: <a href="#" class="wiki-page">User manual</a></li>
59 59 </ul>
60 60
61 61 <p>別のプロジェクトのwikiへのリンクも可能です:</p>
62 62
63 63 <ul>
64 64 <li><strong>[[sandbox:some page]]</strong> sandboxという名前のプロジェクトのwikiの"some page"という名前のページへのリンク</li>
65 65 <li><strong>[[sandbox:]]</strong> sanbdoxという名前のプロジェクトのwikiのメインページへのリンク</li>
66 66 </ul>
67 67
68 68 <p>存在しないwikiページへのリンクは赤で表示されます。 例: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
69 69
70 70 <p>そのほかのリソースへのリンク:</p>
71 71
72 72 <ul>
73 73 <li>Documents:
74 74 <ul>
75 75 <li><strong>document#17</strong> (id 17の文書へのリンク)</li>
76 76 <li><strong>document:Greetings</strong> ("Greetings" というタイトルの文書へのリンク)</li>
77 77 <li><strong>document:"Some document"</strong> (文書のタイトルに空白が含まれる場合はダブルクォーテーションで囲んでください)</li>
78 78 <li><strong>sandbox:document:"Some document"</strong> ("sandbox" というプロジェクトの "Some document" というタイトルの文書へのリンク)</li>
79 79 </ul></li>
80 80 </ul>
81 81
82 82 <ul>
83 83 <li>Versions:
84 84 <ul>
85 85 <li><strong>version#3</strong> (id 3のバージョンへのリンク)</li>
86 86 <li><strong>version:1.0.0</strong> ("1.0.0"という名称のバージョンへのリンク)</li>
87 87 <li><strong>version:"1.0 beta 2"</strong></li>
88 88 <li><strong>sandbox:version:1.0.0</strong> ("sandbox"というプロジェクトの "1.0.0" という名称のバージョンへのリンク)</li>
89 89 </ul></li>
90 90 </ul>
91 91
92 92 <ul>
93 93 <li>添付ファイル:
94 94 <ul>
95 95 <li><strong>attachment:file.zip</strong> (現在のオブジェクトに添付された file.zip というファイルへのリンク)</li>
96 96 <li>現在のオブジェクト上の添付ファイルのみリンク先として指定可能です (例えばあるチケットからは、そのチケットに添付されたファイルのみリンク先にできます)</li>
97 97 </ul></li>
98 98 </ul>
99 99
100 100 <ul>
101 101 <li>チェンジセット:
102 102 <ul>
103 103 <li><strong>r758</strong> (チェンジセットへのリンク)</li>
104 104 <li><strong>commit:c6f4d0fd</strong> (ハッシュ値によるチェンジセットへのリンク)</li>
105 105 <li><strong>svn1|r758</strong> (複数のリポジトリが設定されたプロジェクトで、特定のリポジトリのチェンジセットへのリンク)</li>
106 106 <li><strong>commit:hg|c6f4d0fd</strong> (ハッシュ値による、特定のリポジトリのチェンジセットへのリンク)</li>
107 107 <li><strong>sandbox:r758</strong> (他のプロジェクトのチェンジセットへのリンク)</li>
108 108 <li><strong>sandbox:commit:c6f4d0fd</strong> (ハッシュ値による、他のプロジェクトのチェンジセットへのリンク)</li>
109 109 </ul></li>
110 110 </ul>
111 111
112 112 <ul>
113 113 <li>リポジトリ内のファイル:
114 114 <ul>
115 115 <li><strong>source:some/file</strong> (プロジェクトのリポジトリ内の /some/file というファイルへのリンク)</li>
116 116 <li><strong>source:some/file@52</strong> (ファイルのリビジョン52へのリンク)</li>
117 117 <li><strong>source:some/file#L120</strong> (ファイルの120行目へのリンク)</li>
118 118 <li><strong>source:some/file@52#L120</strong> (リビジョン52のファイルの120行目へのリンク)</li>
119 119 <li><strong>source:"some file@52#L120"</strong> (URLにスペースが含まれる場合はダブルクォーテーションで囲んでください)</li>
120 120 <li><strong>export:some/file</strong> (ファイルのダウンロードを強制)</li>
121 121 <li><strong>source:svn1|some/file</strong> (複数のリポジトリが設定されたプロジェクトで、特定のリポジトリのファイルへのリンク)</li>
122 122 <li><strong>sandbox:source:some/file</strong> ("sandbox" というプロジェクトのリポジトリ上の /some/file というファイルへのリンク)</li>
123 123 <li><strong>sandbox:export:some/file</strong> (ファイルのダウンロードを強制)</li>
124 124 </ul></li>
125 125 </ul>
126 126
127 127 <ul>
128 <li>Forums:
128 <li>フォーラム:
129 129 <ul>
130 <li><strong>forum#1</strong> (link to forum with id 1</li>
131 <li><strong>forum:Support</strong> (link to forum named Support)</li>
132 <li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
130 <li><strong>forum#1</strong> (id 1のフォーラムへのリンク)</li>
131 <li><strong>forum:Support</strong> ("Support"という名前のフォーラムへのリンク)</li>
132 <li><strong>forum:"Technical Support"</strong> (フォーラム名に空白が含まれる場合はダブルクォーテーションで囲んでください)</li>
133 133 </ul></li>
134 134 </ul>
135 135
136 136 <ul>
137 137 <li>フォーラムのメッセージ:
138 138 <ul>
139 139 <li><strong>message#1218</strong> (id 1218のメッセージへのリンク)</li>
140 140 </ul></li>
141 141 </ul>
142 142
143 143 <ul>
144 144 <li>プロジェクト:
145 145 <ul>
146 146 <li><strong>project#3</strong> (id 3のプロジェクトへのリンク)</li>
147 147 <li><strong>project:someproject</strong> ("someproject"という名前のプロジェクトへのリンク)</li>
148 <li><strong>project:"some project"</strong> (use double quotes if project name contains spaces)</li>
148 <li><strong>project:"some project"</strong> (プロジェクト名に空白が含まれる場合はダブルクォーテーションで囲んでください)</li>
149 149 </ul></li>
150 150 </ul>
151 151
152 152 <ul>
153 <li>News:
153 <li>ニュース:
154 154 <ul>
155 <li><strong>news#2</strong> (link to news item with id 2)</li>
156 <li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
157 <li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
155 <li><strong>news#2</strong> (id 2のニュースへのリンク)</li>
156 <li><strong>news:Greetings</strong> ("Greetings"というタイトルのニュースへのリンク)</li>
157 <li><strong>news:"First Release"</strong> (タイトルに空白が含まれる場合はダブルクォーテーションで囲んでください)</li>
158 158 </ul></li>
159 159 </ul>
160 160
161 161 <p>エスケープ:</p>
162 162
163 163 <ul>
164 164 <li>テキストをRedmineのリンクとして解釈させたくない場合は感嘆符 ! を前につけてください。</li>
165 165 </ul>
166 166
167 167
168 168 <h3><a name="4" class="wiki-page"></a>外部リンク</h3>
169 169
170 170 <p>HTTP URLとメールアドレスは自動的にリンクになります:</p>
171 171
172 172 <pre>
173 173 http://www.redmine.org, someone@foo.bar
174 174 </pre>
175 175
176 176 <p>上記の記述は次のように表示されます: <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></p>
177 177
178 178 <p>URLのかわりに別のテキストを表示させたい場合は、標準的なtextile記法が利用できます:</p>
179 179
180 180 <pre>
181 181 "Redmine web site":http://www.redmine.org
182 182 </pre>
183 183
184 184 <p>上記の記述は次のように表示されます: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
185 185
186 186
187 187 <h2><a name="5" class="wiki-page"></a>テキストの書式</h2>
188 188
189 189
190 190 <p>見出し、太字、テーブル、リスト等は、RedmineはTextile記法での記述に対応しています。Textile記法の詳細は <a class="external" href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a> を参照してください。Textileの一例を以下に示しますが、実際にはここで取り上げた以外の記法にも対応しています。</p>
191 191
192 192 <h3><a name="6" class="wiki-page"></a>文字の書式</h3>
193 193
194 194 <pre>
195 195 * *太字*
196 196 * _斜体_
197 197 * _*太字で斜体*_
198 198 * +下線+
199 199 * -取り消し線-
200 200 </pre>
201 201
202 202 <p>表示例:</p>
203 203
204 204 <ul>
205 205 <li><strong>太字</strong></li>
206 206 <li><em>斜体</em></li>
207 207 <li><em><strong>太字で斜体</strong></em></li>
208 208 <li><ins>下線</ins></li>
209 209 <li><del>取り消し線</del></li>
210 210 </ul>
211 211
212 212 <h3><a name="7" class="wiki-page"></a>画像</h3>
213 213
214 214 <ul>
215 215 <li><strong>!image_url!</strong> image_urlで指定されたURLの画像を表示 (Textile記法)</li>
216 216 <li><strong>!&gt;image_url!</strong> 画像を右寄せ・テキスト回り込みありで表示</li>
217 217 <li>Wikiページに添付された画像があれば、ファイル名を指定して画像を表示させることができます: <strong>!attached_image.png!</strong></li>
218 218 </ul>
219 219
220 220 <h3><a name="8" class="wiki-page"></a>見出し</h3>
221 221
222 222 <pre>
223 223 h1. Heading
224 224 h2. Subheading
225 225 h3. Subsubheading
226 226 </pre>
227 227
228 228 <p>Redmineは見出しにアンカーを設定するので、"#Heading", "#Subheading"などを指定してリンクが行えます。</p>
229 229
230 230
231 231 <h3><a name="9" class="wiki-page"></a>段落</h3>
232 232
233 233 <pre>
234 234 p&gt;. 右寄せ
235 235 p=. センタリング
236 236 </pre>
237 237
238 238 <p style="text-align:center;">センタリングされた段落</p>
239 239
240 240
241 241 <h3><a name="10" class="wiki-page"></a>引用</h3>
242 242
243 243 <p>段落を <strong>bq.</strong> で開始してください。</p>
244 244
245 245 <pre>
246 246 bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
247 247 To go live, all you need to add is a database and a web server.
248 248 </pre>
249 249
250 250 <p>表示例:</p>
251 251
252 252 <blockquote>
253 253 <p>Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.<br />To go live, all you need to add is a database and a web server.</p>
254 254 </blockquote>
255 255
256 256
257 257 <h3><a name="11" class="wiki-page"></a>目次</h3>
258 258
259 259 <pre>
260 260 {{toc}} =&gt; 目次(左寄せ)
261 261 {{&gt;toc}} =&gt; 目次(右寄せ)
262 262 </pre>
263 263
264 264 <h3><a name="14" class="wiki-page"></a>区切り線</h3>
265 265
266 266 <pre>
267 267 ---
268 268 </pre>
269 269
270 270 <h2><a name="12" class="wiki-page"></a>マクロ</h2>
271 271
272 272 <p>Redmineには以下の組み込みマクロが用意されています:</p>
273 273
274 274 <p>
275 275 <dl>
276 276 <dt><code>hello_world</code></dt>
277 277 <dd><p>サンプルのマクロです。</p></dd>
278 278
279 279 <dt><code>macro_list</code></dt>
280 280 <dd><p>上記のマクロを含め、利用可能なマクロの一覧を表示します。</p></dd>
281 281
282 282 <dt><code>child_pages</code></dt>
283 283 <dd><p>子ページの一覧を表示します。引数の指定が無ければ現在のwikiページの子ページを表示します。以下は使用例です:</p>
284 284 <pre><code>{{child_pages}} -- wikiページでのみ使用可能です
285 285 {{child_pages(depth=2)}} -- 2階層分のみ表示します</code></pre></dd>
286 286
287 287 <dt><code>include</code></dt>
288 288 <dd><p>別のWikiページの内容を挿入します。 以下は使用例です:</p>
289 289 <pre><code>{{include(Foo)}}</code></pre>
290 290 <p>プロジェクトを指定することもできます。:</p>
291 291 <pre><code>{{include(projectname:Foo)}}</code></pre></dd>
292 292
293 293 <dt><code>collapse</code></dt>
294 294 <dd><p>折り畳まれた状態のテキストを挿入します。以下は使用例です:</p>
295 295 <pre><code>{{collapse(詳細を表示...)
296 296 この部分はデフォルトでは折り畳まれた状態で表示されます。
297 297 リンクをクリックすると展開されます。
298 298 }}</code></pre></dd>
299 299
300 300 <dt><code>thumbnail</code></dt>
301 301 <dd><p>添付ファイルのクリック可能なサムネイル画像を表示します。以下は使用例です:</p>
302 302 <pre>{{thumbnail(image.png)}}
303 303 {{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
304 304 </dl>
305 305 </p>
306 306
307 307 <h2><a name="13" class="wiki-page"></a>コードハイライト</h2>
308 308
309 309 <p>Redmineのコードハイライトは <a href="http://coderay.rubychan.de/" class="external">CodeRay</a> という、Rubyで記述された高速なライブラリを使用しています。Coderayはc, cpp, css, delphi, groovy, html, java, javascript, json, php, python, rhtml, ruby, scheme, sql, xml, yamlに対応しています。</p>
310 310
311 311 <p>Wikiページでコードハイライトを利用するには次のように記述します:</p>
312 312
313 313 <pre>
314 314 &lt;pre&gt;&lt;code class="ruby"&gt;
315 315 Place your code here.
316 316 &lt;/code&gt;&lt;/pre&gt;
317 317 </pre>
318 318
319 319 <p>表示例:</p>
320 320
321 321 <pre><code class="ruby syntaxhl"><span class="line-numbers"> 1</span> <span class="comment"># The Greeter class</span>
322 322 <span class="line-numbers"> 2</span> <span class="reserved">class</span> <span class="class">Greeter</span>
323 323 <span class="line-numbers"> 3</span> <span class="reserved">def</span> <span class="function">initialize</span>(name)
324 324 <span class="line-numbers"> 4</span> <span class="instance-variable">@name</span> = name.capitalize
325 325 <span class="line-numbers"> 5</span> <span class="reserved">end</span>
326 326 <span class="line-numbers"> 6</span>
327 327 <span class="line-numbers"> 7</span> <span class="reserved">def</span> <span class="function">salute</span>
328 328 <span class="line-numbers"> 8</span> puts <span class="string"><span class="delimiter">"</span><span class="content">Hello </span><span class="inline"><span class="inline-delimiter">#{</span><span class="instance-variable">@name</span><span class="inline-delimiter">}</span></span><span class="content">!</span><span class="delimiter">"</span></span>
329 329 <span class="line-numbers"> 9</span> <span class="reserved">end</span>
330 330 <span class="line-numbers"><strong>10</strong></span> <span class="reserved">end</span></code>
331 331 </pre>
332 332 </body>
333 333 </html>
General Comments 0
You need to be logged in to leave comments. Login now