Redmineにおけるwiki記法

Redmineは、Wikiをはじめとして、テキストを入力するほとんどの箇所で Textile 記法が利用できます。

リンク

Redmine内でのリンク

wiki記法が使える箇所からはどこからでも、チケット、チェンジセット、wikiへのリンクを設定することができます。

  • チケットへのリンク: #124 (表示例: #124 |チケットが完了している場合、取り消し線がリンクの上に表示されます)
  • チェンジセットへのリンク(Subversion): r758 (表示例: r758)
  • ハッシュ値によるチェンジセットへのリンク(Git, Mercurialなど): commit:c6f4d0fd

Wikiへのリンク:

  • [[Guide]] ’Guide’という名前のwikiページへのリンクを表示します (表示例: Guide )
  • [[Guide|User manual]] あるページへのリンクを、別の名前で表示します (表示例: User manual )

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

  • [[sandbox:some page]] Sandboxというプロジェクトのwikiの’Some page’というページへのリンクを表示します
  • [[sandbox:]] Sandboxというプロジェクトのwikiのメインページへのリンクを表示します

Wikiへのリンクは、リンク先wikiページが存在しない場合は赤色で表示されます (表示例: Nonexistent page)

他の情報へのリンク(0.7以降で対応):

  • ドキュメント:
  • document#17 (id 17のドキュメントへのリンク)
  • document:Greetings ("Greetings"というタイトルのドキュメントへのリンク)
  • document:“Some document” (ドキュメントのタイトルに空白文字が含まれる場合は、ダブルクォーテーションで囲んでください)
  • バージョン:
  • version#3 (id 3のバージョンへのリンク)
  • version:1.0.0 (“1.0.0”という名前のバージョンへのリンク)
  • version:“1.0 beta 2”
  • 添付ファイル:
  • attachment:file.zip (file.zipという現在のオブジェクト上の添付ファイルへのリンクを表示します)
  • 現時点では、現在のオブジェクト上の添付ファルのみリンク先として指定可能です (例えばある特定の「チケット」においては、そのチケットに添付されたファイルのみリンク先にできます)
  • リポジトリのファイル
  • source:some/file — プロジェクトのリポジトリ中の /some/file というファイルへのリンク
  • source:some/file@52 — ファイルのリビジョン52へのリンク
  • source:some/file#L120 — ファイルの120行目へのリンク
  • source:some/file@52#L120 — リビジョン52のファイルの120行目へのリンク
  • export:some/file — ファイルのダウンロードを強制
  • フォーラムのメッセージ(0.8以降で対応):
  • message#52 — フォーラムの 52 番メッセージへのリンク

エスケープ (0.7以降で対応):

  • 文字列をリンクとして解釈させたくない場合は、感嘆符’!’を前につけます。

外部リンク

HTTP URLとメールアドレスは自動的にリンクになります:

http://www.redmine.org, someone@example.jp

表示例: http://www.redmine.org, someone@example.jp

URLの代わりに特定の文字列を表示させたい場合は、標準的なtextile記法が利用できます:

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

表示例: Redmine web site

テキストの書式

フォント

* *ボールド*
* _イタリック_
* _*ボールド イタリック*_
* +下線+
* -取り消し線-

実際の表示:

  • ボールド
  • イタリック
  • ボールド イタリック
  • 下線
  • 取り消し線

インラインイメージ

  • !image_url! image_urlの画像を表示します (textile記法)
  • !>image_url! 画像の右寄せ
  • wikiページに添付された画像ファイルは、ファイル名のみでインラインイメージとして表示することができます: !attached_image.png!

見出し

h1. Heading
h2. Subheading
h3. 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}} => 目次(右寄せ)

コードハイライト

コードハイライトはRubyで記述された高速なコードハイライト用ライブラリである、 CodeRay を使用して行われます。c、css, html、java, javascript、rhtml、php, python, ruby、scheme、xmlなどに対応しています。

【参考】 コードハイライトの対応形式の一覧 (Redmine.JP Blog)

wikiページで下記の記述を行うことによりコードハイライトを行うことができます:

<pre><code class="ruby">
# ここにソースコードを記述

Redmineのクラウドサービス「My Redmine」です。
オンプレミスからの移行もOK!1ヶ月の無料お試し受付中です!

詳細を確認