Wiki記法

リンク

Redmine内のリンク

RedmineはWiki記法が使える箇所のどこからでも、チケット・チェンジセット・Wikiページなどのリソースへのリンクができます。

Wikiへのリンク:

別のプロジェクトのwikiへのリンクも可能です:

存在しないwikiページへのリンクは赤で表示されます。 例: Nonexistent page.

そのほかのリソースへのリンク:

エスケープ:

外部リンク

URL(starting with: www, http, https, ftp, ftps, sftp and sftps)とメールアドレスは自動的にリンクになります:

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

上記記述の表示例です: http://www.redmine.org, someone@foo.bar

URLのかわりに別のテキストを表示させたい場合は、標準的なtextile記法が利用できます:

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

上記記述の表示例です: Redmine web site

テキストの書式

見出し、太字、テーブル、リスト等は、RedmineはTextile記法での記述に対応しています。Textile記法の詳細は http://en.wikipedia.org/wiki/Textile_(markup_language) を参照してください。Textileの一例を以下に示しますが、実際にはここで取り上げた以外の記法にも対応しています。

文字の書式

* *太字*
* _斜体_
* _*太字で斜体*_
* +下線+
* -取り消し線-

表示例:

画像

見出し

h1. Heading

h2. Subheading

h3. Subsubheading

Redmineは見出しにアンカーを設定するので、"#Heading", "#Subheading"のように記述して見出しへのリンクが行えます。

段落

p>. 右寄せ
p=. センタリング

センタリングされた段落

引用

段落を bq. で開始してください。

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.

表示例:

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.

目次

{{toc}} => 目次(左寄せ)
{{>toc}} => 目次(右寄せ)

区切り線

---

マクロ

Redmineには以下の組み込みマクロが用意されています:

hello_world

サンプルのマクロです。

macro_list

利用可能なマクロの一覧を表示します。マクロの説明があればそれも表示します。

child_pages

子ページの一覧を表示します。引数の指定が無ければ現在のwikiページの子ページを表示します。以下は使用例です:

{{child_pages}} -- wikiページでのみ使用可能です
{{child_pages(depth=2)}} -- 2階層分のみ表示します
include

別のWikiページの内容を挿入します。 以下は使用例です:

{{include(Foo)}}

別プロジェクトのWikiページを挿入することもできます:

{{include(projectname:Foo)}}
collapse

折り畳まれた状態のテキストを挿入します。以下は使用例です:

{{collapse(詳細を表示...)
この部分はデフォルトでは折り畳まれた状態で表示されます。
リンクをクリックすると展開されます。
}}
thumbnail

添付ファイルのクリック可能なサムネイル画像を表示します。以下は使用例です:

{{thumbnail(image.png)}}
{{thumbnail(image.png, size=300, title=Thumbnail)}}
issue

チケットへのリンクをカスタマイズ可能なテキストとともに挿入します。以下は使用例です:

{{issue(123)}}                              -- Issue #123: Enhance macro capabilities
{{issue(123, project=true)}}                -- Andromeda - Issue #123:Enhance macro capabilities
{{issue(123, tracker=false)}}               -- #123: Enhance macro capabilities
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123

コードハイライト

RedmineはRubyで記述されたコードハイライト用ライブラリ Rouge を使用しています。Rougeは c, cpp (c++), csharp (c#, cs), css, diff (patch, udiff), go (golang), groovy, html, java, javascript (js), kotlin, objective_c (objc), perl (pl), php, python (py), r, ruby (rb), sass, scala, shell (bash, zsh, ksh, sh), sql, swift, xml, yaml (yml) など一般的に使われている多数の言語に対応しています（括弧内の名前はコードハイライトの指定に利用できる別名です）。全対応言語の一覧は List of languages supported by Redmine code highlighter を参照してください。

Wiki記法に対応している箇所であればどこでも以下の記述によりコードハイライトが利用できます (言語名・別名では大文字・小文字は区別されません):

<pre><code class="ruby">
  Place your code here.
</code></pre>

表示例:

# The Greeter class
class Greeter
  def initialize(name)
    @name = name.capitalize
  end

  def salute
    puts "Hello #{@name}!"
  end
end