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