• Home
• コーポレートブログ
• 知っておきたいRedmineのおすすめWiki記法

石原です。今日はRedmineを普段使っていて便利だと思うWiki記法をいくつかご紹介します。

collapse

チケットなどで入力した内容を折りたたんで表示できます。チケットに長文のコメントがあるとチケットの画面がその分長くなってしまいますが、折りたためばコンパクトに表示できます。

入力時
折りたたみ時
展開時

記述方法

折りたたんで表示したい内容を {{collapse と }} で囲みます。折りたたみ時は「表示」、展開時は「隠す」が表示され、クリックすると展開したり折りたたんだりできます。

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

展開時・折りたたみ時にクリックするテキストは好きなテキストを表示できます。その場合は {{collapse(表示するテキスト) と }} で囲みます。折りたたみ時も展開時も指定したテキストが表示されます。

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

また、{{collapse(折りたたみ時に表示するテキスト,展開時に表示するテキスト)のようにテキストを2つ書くと、折りたたみ時と展開時に表示するテキストを指定できます。

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

画像のサイズ指定

チケットやWikiなどで画像を埋め込んで表示するときに画像のサイズを指定できます。管理 > 設定 > 全般 > テキスト書式 がTextileかMarkdownによって書き方が違います。

Textile

以下の流れで簡単にサイズを指定できます。

1. チケットなどの入力欄に埋め込みたい画像をドラッグ&ドロップで添付する
2. 埋め込み用の記述が !image.png! のように自動的に追加される
3. {width:300px} のようにサイズを指定する記述を入力する

!{width:300px}image.png!

CommonMark Markdown

これまで画像のサイズが指定できるのはTextileのみでしたが、Redmineの次期バージョン5.1 / RedMica 2.2（Redmine互換オープンソースソフトウェア）以降はCommonMark MarkdownでCSSの一部プロパティの利用に対応したため、CommonMark Markdownを使うとできるようになりました。

CommonMark MarkdownとMarkdownは ![](image.png) の形式の記述で画像を埋め込みできますが、サイズを指定するにはHTMLに書き換えます。

<img src="image.png" style="width: 300px;">

なお、Markdownは画像サイズの指定はできません。CommonMark Markdownへの変更をおすすめします。

include

Wikiページの内容をほかのページに表示できます。例えばWikiに記載した内容をホームやプロジェクトの概要に表示できます。

記述方法

• 同じプロジェクトのWikiページを表示する場合
  {{include(Wikiページの名前)}}
• 別プロジェクトのWikiページを表示する場合
  {{include(プロジェクト識別子:Wikiページの名前)}}

弊社が運営するRedmineのクラウドサービス「My Redmine」のお客様からウェルカムメッセージをシステム管理者以外でも編集できるようにしたいという問い合わせがあり、ウェルカムメッセージにincludeでWikiページの内容を表示する方法を案内しました。ホーム画面に表示する内容は 管理 > 設定 > 全般 > ウェルカムメッセージ で設定できますが、システム管理者権限がないと更新できません。公開プロジェクトのWikiをincludeで表示すれば、一般ユーザーでもWikiを編集するとウェルカムメッセージの内容も更新できます。

Wiki記法を調べる方法

チケットのコメントなど入力欄のツールバーのHelp（？アイコン）からWiki記法を参照できるので、Redmineで入力中に調べることができます。

「？」アイコンをクリックすると小さなウインドウが表示されます。

一番下までスクロールして左下の「より詳細なリファレンス」または「More Information」をクリックすると、さらに詳細なWiki記法が表示されます。

また、下記サイトにも主な記法をまとめています。

• Redmineにおけるwiki記法
  https://redmine.jp/tech_note/RedmineWikiFormatting/
• Textile記法
  https://redmine.jp/tech_note/textile/
• Markdown記法
  https://redmine.jp/tech_note/markdown/

【スタッフ募集中】
弊社ではAWSを活用したソリューションの企画・設計・構築・運用や、Ruby on Rails・JavaScriptフレームワークなどを使用したアプリケーション開発を行うスタッフを募集しています。採用情報の詳細
弊社での勤務に関心をお持ちの方は、知り合いの弊社社員・関係者を通じてご連絡ください。

---