Mercurial > hg > soundsoftware-site

annotate public/help/ja/wiki_syntax_detailed.html @ 1628:9c5f8e24dadc live tip

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