comparison public/help/ja/wiki_syntax_detailed.html @ 1464:261b3d9a4903 redmine-2.4

Update to Redmine 2.4 branch rev 12663
author Chris Cannam
date Tue, 14 Jan 2014 14:37:42 +0000
parents
children
comparison
equal deleted inserted replaced
1296:038ba2d95de8 1464:261b3d9a4903
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
3 <head>
4 <title>RedmineWikiFormatting</title>
5 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
6 <style type="text/css">
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 .syntaxhl .line-numbers { padding: 2px 4px 2px 4px; background-color: #eee; margin:0 }
22 .syntaxhl .comment { color:#666; }
23
24 .syntaxhl .class { color:#B06; font-weight:bold }
25 .syntaxhl .delimiter { color:black }
26 .syntaxhl .function { color:#06B; font-weight:bold }
27
28 .syntaxhl .inline { background: #eee }
29 .syntaxhl .inline .inline-delimiter { font-weight: bold; color: #888 }
30
31 .syntaxhl .instance-variable { color:#33B }
32 .syntaxhl .reserved { color:#080; font-weight:bold }
33
34 .syntaxhl .string { background-color:#fff0f0; color: #D20; }
35 .syntaxhl .string .delimiter { color:#710 }
36
37 </style>
38 </head>
39
40 <body>
41 <h1><a name="1" class="wiki-page"></a>Wiki記法</h1>
42
43 <h2><a name="2" class="wiki-page"></a>リンク</h2>
44
45 <h3><a name="3" class="wiki-page">Redmine内のリンク</a></h3>
46
47 <p>RedmineはWiki記法が使える箇所のどこからでも、チケット・チェンジセット・Wikiページなどリソース間へリンクを行うことができます。</p>
48 <ul>
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 <li>チケットの注記へのリンク: <strong>#124-6</strong> または <strong>#124#note-6</strong></li>
51 </ul>
52
53 <p>Wikiへのリンク:</p>
54
55 <ul>
56 <li><strong>[[Guide]]</strong> "Guide"という名前のページへのリンクです: <a href="#" class="wiki-page">Guide</a></li>
57 <li><strong>[[Guide#further-reading]]</strong> "Guide"というページ内の"further-reading"というアンカーに飛びます。見出しには自動的にアンカーが設定されるのでリンク先とすることができます: <a href="#" class="wiki-page">Guide</a></li>
58 <li><strong>[[Guide|User manual]]</strong> "Guide"というページへのリンクを異なるテキストで表示: <a href="#" class="wiki-page">User manual</a></li>
59 </ul>
60
61 <p>別のプロジェクトのwikiへのリンクも可能です:</p>
62
63 <ul>
64 <li><strong>[[sandbox:some page]]</strong> sandboxという名前のプロジェクトのwikiの"some page"という名前のページへのリンク</li>
65 <li><strong>[[sandbox:]]</strong> sanbdoxという名前のプロジェクトのwikiのメインページへのリンク</li>
66 </ul>
67
68 <p>存在しないwikiページへのリンクは赤で表示されます。 例: <a href="#" class="wiki-page new">Nonexistent page</a>.</p>
69
70 <p>そのほかのリソースへのリンク:</p>
71
72 <ul>
73 <li>Documents:
74 <ul>
75 <li><strong>document#17</strong> (id 17の文書へのリンク)</li>
76 <li><strong>document:Greetings</strong> ("Greetings" というタイトルの文書へのリンク)</li>
77 <li><strong>document:"Some document"</strong> (文書のタイトルに空白が含まれる場合はダブルクォーテーションで囲んでください)</li>
78 <li><strong>sandbox:document:"Some document"</strong> ("sandbox" というプロジェクトの "Some document" というタイトルの文書へのリンク)</li>
79 </ul></li>
80 </ul>
81
82 <ul>
83 <li>Versions:
84 <ul>
85 <li><strong>version#3</strong> (id 3のバージョンへのリンク)</li>
86 <li><strong>version:1.0.0</strong> ("1.0.0"という名称のバージョンへのリンク)</li>
87 <li><strong>version:"1.0 beta 2"</strong></li>
88 <li><strong>sandbox:version:1.0.0</strong> ("sandbox"というプロジェクトの "1.0.0" という名称のバージョンへのリンク)</li>
89 </ul></li>
90 </ul>
91
92 <ul>
93 <li>添付ファイル:
94 <ul>
95 <li><strong>attachment:file.zip</strong> (現在のオブジェクトに添付された file.zip というファイルへのリンク)</li>
96 <li>現在のオブジェクト上の添付ファイルのみリンク先として指定可能です (例えばあるチケットからは、そのチケットに添付されたファイルのみリンク先にできます)</li>
97 </ul></li>
98 </ul>
99
100 <ul>
101 <li>チェンジセット:
102 <ul>
103 <li><strong>r758</strong> (チェンジセットへのリンク)</li>
104 <li><strong>commit:c6f4d0fd</strong> (ハッシュ値によるチェンジセットへのリンク)</li>
105 <li><strong>svn1|r758</strong> (複数のリポジトリが設定されたプロジェクトで、特定のリポジトリのチェンジセットへのリンク)</li>
106 <li><strong>commit:hg|c6f4d0fd</strong> (ハッシュ値による、特定のリポジトリのチェンジセットへのリンク)</li>
107 <li><strong>sandbox:r758</strong> (他のプロジェクトのチェンジセットへのリンク)</li>
108 <li><strong>sandbox:commit:c6f4d0fd</strong> (ハッシュ値による、他のプロジェクトのチェンジセットへのリンク)</li>
109 </ul></li>
110 </ul>
111
112 <ul>
113 <li>リポジトリ内のファイル:
114 <ul>
115 <li><strong>source:some/file</strong> (プロジェクトのリポジトリ内の /some/file というファイルへのリンク)</li>
116 <li><strong>source:some/file@52</strong> (ファイルのリビジョン52へのリンク)</li>
117 <li><strong>source:some/file#L120</strong> (ファイルの120行目へのリンク)</li>
118 <li><strong>source:some/file@52#L120</strong> (リビジョン52のファイルの120行目へのリンク)</li>
119 <li><strong>source:"some file@52#L120"</strong> (URLにスペースが含まれる場合はダブルクォーテーションで囲んでください)</li>
120 <li><strong>export:some/file</strong> (ファイルのダウンロードを強制)</li>
121 <li><strong>source:svn1|some/file</strong> (複数のリポジトリが設定されたプロジェクトで、特定のリポジトリのファイルへのリンク)</li>
122 <li><strong>sandbox:source:some/file</strong> ("sandbox" というプロジェクトのリポジトリ上の /some/file というファイルへのリンク)</li>
123 <li><strong>sandbox:export:some/file</strong> (ファイルのダウンロードを強制)</li>
124 </ul></li>
125 </ul>
126
127 <ul>
128 <li>フォーラムのメッセージ:
129 <ul>
130 <li><strong>message#1218</strong> (id 1218のメッセージへのリンク)</li>
131 </ul></li>
132 </ul>
133
134 <ul>
135 <li>プロジェクト:
136 <ul>
137 <li><strong>project#3</strong> (id 3のプロジェクトへのリンク)</li>
138 <li><strong>project:someproject</strong> ("someproject"という名前のプロジェクトへのリンク)</li>
139 </ul></li>
140 </ul>
141
142
143 <p>エスケープ:</p>
144
145 <ul>
146 <li>テキストをRedmineのリンクとして解釈させたくない場合は感嘆符 ! を前につけてください。</li>
147 </ul>
148
149
150 <h3><a name="4" class="wiki-page"></a>外部リンク</h3>
151
152 <p>HTTP URLとメールアドレスは自動的にリンクになります:</p>
153
154 <pre>
155 http://www.redmine.org, someone@foo.bar
156 </pre>
157
158 <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>
159
160 <p>URLのかわりに別のテキストを表示させたい場合は、標準的なtextile記法が利用できます:</p>
161
162 <pre>
163 "Redmine web site":http://www.redmine.org
164 </pre>
165
166 <p>上記の記述は次のように表示されます: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
167
168
169 <h2><a name="5" class="wiki-page"></a>テキストの書式</h2>
170
171
172 <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>
173
174 <h3><a name="6" class="wiki-page"></a>文字の書式</h3>
175
176 <pre>
177 * *太字*
178 * _斜体_
179 * _*太字で斜体*_
180 * +下線+
181 * -取り消し線-
182 </pre>
183
184 <p>表示例:</p>
185
186 <ul>
187 <li><strong>太字</strong></li>
188 <li><em>斜体</em></li>
189 <li><em><strong>太字で斜体</strong></em></li>
190 <li><ins>下線</ins></li>
191 <li><del>取り消し線</del></li>
192 </ul>
193
194 <h3><a name="7" class="wiki-page"></a>画像</h3>
195
196 <ul>
197 <li><strong>!image_url!</strong> image_urlで指定されたURLの画像を表示 (Textile記法)</li>
198 <li><strong>!&gt;image_url!</strong> 画像を右寄せ・テキスト回り込みありで表示</li>
199 <li>Wikiページに添付された画像があれば、ファイル名を指定して画像を表示させることができます: <strong>!attached_image.png!</strong></li>
200 </ul>
201
202 <h3><a name="8" class="wiki-page"></a>見出し</h3>
203
204 <pre>
205 h1. Heading
206 h2. Subheading
207 h3. Subsubheading
208 </pre>
209
210 <p>Redmineは見出しにアンカーを設定するので、"#Heading", "#Subheading"などを指定してリンクが行えます。</p>
211
212
213 <h3><a name="9" class="wiki-page"></a>段落</h3>
214
215 <pre>
216 p&gt;. 右寄せ
217 p=. センタリング
218 </pre>
219
220 <p style="text-align:center;">センタリングされた段落</p>
221
222
223 <h3><a name="10" class="wiki-page"></a>引用</h3>
224
225 <p>段落を <strong>bq.</strong> で開始してください。</p>
226
227 <pre>
228 bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
229 To go live, all you need to add is a database and a web server.
230 </pre>
231
232 <p>表示例:</p>
233
234 <blockquote>
235 <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>
236 </blockquote>
237
238
239 <h3><a name="11" class="wiki-page"></a>目次</h3>
240
241 <pre>
242 {{toc}} =&gt; 目次(左寄せ)
243 {{&gt;toc}} =&gt; 目次(右寄せ)
244 </pre>
245
246 <h3><a name="14" class="wiki-page"></a>区切り線</h3>
247
248 <pre>
249 ---
250 </pre>
251
252 <h2><a name="12" class="wiki-page"></a>マクロ</h2>
253
254 <p>Redmineには以下の組み込みマクロが用意されています:</p>
255
256 <p><dl><dt><code>hello_world</code></dt><dd><p>サンプルのマクロです。</p></dd><dt><code>include</code></dt><dd><p>別のWikiページの内容を挿入します。 以下は使用例です:</p>
257
258 <pre><code>{{include(Foo)}}</code></pre></dd><dt><code>macro_list</code></dt><dd><p>上記のマクロを含め、利用可能なマクロの一覧を表示します。</p></dd></dl></p>
259
260
261 <h2><a name="13" class="wiki-page"></a>コードハイライト</h2>
262
263 <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>
264
265 <p>Wikiページでコードハイライトを利用するには次のように記述します:</p>
266
267 <pre>
268 &lt;pre&gt;&lt;code class="ruby"&gt;
269 Place you code here.
270 &lt;/code&gt;&lt;/pre&gt;
271 </pre>
272
273 <p>表示例:</p>
274
275 <pre><code class="ruby syntaxhl"><span class="line-numbers"> 1</span> <span class="comment"># The Greeter class</span>
276 <span class="line-numbers"> 2</span> <span class="reserved">class</span> <span class="class">Greeter</span>
277 <span class="line-numbers"> 3</span> <span class="reserved">def</span> <span class="function">initialize</span>(name)
278 <span class="line-numbers"> 4</span> <span class="instance-variable">@name</span> = name.capitalize
279 <span class="line-numbers"> 5</span> <span class="reserved">end</span>
280 <span class="line-numbers"> 6</span>
281 <span class="line-numbers"> 7</span> <span class="reserved">def</span> <span class="function">salute</span>
282 <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>
283 <span class="line-numbers"> 9</span> <span class="reserved">end</span>
284 <span class="line-numbers"><strong>10</strong></span> <span class="reserved">end</span></code>
285 </pre>
286 </body>
287 </html>