意外と知らない かもしれない Redmine の機能 14 選

Redmine には気づきにくいけど、結構便利な機能があります。
今回はそういった意外と知られていないかなという機能についてまとめてみました。

• チケット
  • 1. チケットリストの右クリックメニュー
  • 2. チケットリストのオプション
  • 3. 添付ファイルの表示
• バージョン管理システムとの連携
  • 4. コミット時に活動時間を登録
  • 5. チケットの関連付けを修正
  • 6. リビジョンとのリンク
• ツールチップ
  • 7. 日付表示
  • 8. チケット番号、リビジョン番号
• Wiki
  • 9. 簡易 pre
  • 10. コードハイライト
  • 11. サムネイル用マクロ
  • 12. 折りたたみ用マクロ
  • 13. Wiki 記法のエスケープ
  • 14. サイドバー

チケット

1. チケットリストの右クリックメニュー

気づきにくいことで、逆に有名かも知れませんが、 最初に気づきにくいけど便利という典型的な機能から紹介します。

チケットリスト上で、右クリックするとメニューが表示されます。 これでチケットの項目を変更することができます。
1 度に 1 項目しか変更出来ませんが、ステータスや進捗をちょっと変更するという時に便利です。


プロジェクトの [チケット] ページだけでなく、 [マイページ] などのリストでも利用することができます。

右クリックでメニューが表示されない場合は、一度リスト項目を選択状態にしてから、右クリックしてみてください。


この機能は以下のページでも紹介されています。

• Redmine の気がつきにくい機能 | Redmine.JP Blog

2. チケットリストのオプション

チケットリストが表示しきれないから、項目を減らしたいという時はないでしょうか。 そんな時には [オプション] を使います。

これは 表示項目の選択 だけでなく、 グルーピングや説明の表示の設定も出来ます。


オプションの設定はプロジェクトごとに保存されます。 プロジェクトごとというのは面倒ですが、 プロジェクトで使われ方が違う場合はメリットとも言えます。

ちなみに、この設定はユーザー情報に保存されているようです。 Anonymous (ログイン前) ユーザーでもブラウザーのキャッシュを使って設定が残るようになっています。

3. 添付ファイルの表示

チケットに添付ファイルした画像ファイルのサムネイルを表示することができます。

これは [管理] メニューの [設定] ページの設定でチェックを入れておけば、自動で表示されます。



これは古いバージョンでは Lightbox プラグインで実現していた機能です。 プラグインの方が使いやすいのですが、 2.0 以降に対応していません。

バージョン管理システムとの連携

バージョン管理システム(SCM)との連携時の機能です。 基本的な連携方法については以前の記事をご覧ください。

• Redmine 入門 - バージョン管理システムとの連携 | プログラマーズ雑記帳

4. コミット時に活動時間を登録

SCM コミット時のコメントで refs, closes などのキーワードでチケットと関連付けができます。 この時、一緒に活動時間を登録することもできます。

登録する場合にはキーワードによる指定の後に @時間 を追加します。

refs #1234 @2:30

ただし、この機能は Redmine の設定で機能が有効になっていないと使えません。
設定ページは [管理] → [設定] → [リポジトリ] の順で開きます。


管理ユーザーでなくても Redmine インフォメーション プラグインが入れてあれば、 [設定] 情報ページから有効かどうかを確認することができます。


記述、設定方法については以下のページに詳しい説明があります。

• Redmine 1.1 新機能紹介: コミットメッセージによる作業時間の記録 | Redmine.JP Blog

5. チケットの関連付けを修正

コメントのキーワードによる関連付けは記述ミスして関連付けに失敗することはよくあります。
SCM でコメントの修正機能があったとしても、後から修正したものは redmine では認識してくれません。

こんな時に SCM のリビジョンとチケットとの関連付けの編集機能を使います。
以前はプラグインを入れないとできなかったのですが、 2.0 以降のバージョンでは標準の機能となっています。

[リポジトリ]の編集したいリビジョンのページを開いて、追加または削除を行います。

6. リビジョンとのリンク

リビジョンへのリンクを Wiki で書く場合には次のように記述します。

 rnnn
 r123

Git や Mercurial などの分散型リビジョンの場合、 番号ではなく、英数字交じりの ID の場合があります。
commit を使えば ID でもリンクを作成できます。

 commit:XXXXXX
 commit:b0f38dd0cff9

また、マルチリポジトリーの場合には | を使って指定します。

識別名|rnnn
commit:識別名|XXXXXX

svn1|r758
commit:hg|c6f4d0fd 

ツールチップ

リンクをクリックせずにツールチップを表示させると、結構役に立つ情報を表示することがあります。

7. 日付表示

Redmine では更新日などの表示は "X 日前" といった形式で表示されます。 時間や分のオーダーでは便利なのですが、 日や月になってくると "何月何日" といった表示で見たくなってきます 。

こんな時、マウスを上に持っていってみてください。 ツールチップでは yyyy/mm/dd HH:MM 形式 で表示されます。


なお、以下のプラグインを入れると日付の表示を変更することもできます。

• Redmine の「 XX 日前」を「 yyyy/MM/dd 」日付表現で表示するプラグインを書いた - すえひろがりっっっっ!

8. チケット番号、リビジョン番号

Wiki などで #番号 と書くとチケットへのリンクとなります。
ただ、普通は番号でチケットを覚えたりしないと思います。 チケットの内容はリンク先をみないとよくわかりません。

ツールチップを使えば 題名 とステータスを確認することができます。


先ほど紹介したリビジョンへのリンクにも同様の機能があります。
リンクのツールチップはコミット時のコメント(長い場合は先頭部分)を表示します。

Wiki

Wiki による記述時の機能です。

9. 簡易 pre

整形済みテキストは <pre> ... </pre> を使用します。
これをちょっと簡単に記述することができます。

前後に空行をいれて、インデントしてみてください。 これで整形済みテキストとなります。

前の文章
(空行)
  インデントした行
整形済みテキスト内文章
  整形済みテキスト内文章
(空行)
後の文章

10. コードハイライト

Wiki ではコード片をハイライト表示することができます。

<pre><code class="xxx">
コード
<code></pre>

ハイライト自体は使ったことがある人は多いと思います。
これはメジャーなものだけでなく、意外と対応している言語はあります (C# などの最近の言語は対応が悪いですが)

対応言語(CodeRay 1.0.9) :

• C, C++
• Delphi(Pascal)
• Java, Groovy, Clojure
• HTML, CSS, Haml
• XML, JSON, YAML
• JavaScript
• Ruby, HTML ERB Template
• PHP
• Python
• diff
• SQL

しかし、 「 xxx には何を書けばいいの ?」 ということはないでしょうか。
そういう時にはソースファイルで使う拡張子を記述してください。 C++ では cpp 、 JavaScript では js といった具合です。

そのコードに対応していなければ、整形済みテキストなるだけです。 エラーとはなりませんし、バージョンが上がれば後から対応する可能性もあります。 とりあえず、試してみるといいでしょう。

なお、次のものは明確なソースファイルがないので、使う場合は覚えておいた方がいいかもしれません。

対象	キーワード
HTML ERB Template	erb, rhtml
Diff	diff, patch
SQL	sql

11. サムネイル用マクロ

画像をサムネイルで表示する Wiki マクロです。
古いバージョンではプラグインを入れる必要がありましたが、 2.1 から標準の機能になっています。

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

12. 折りたたみ用マクロ

ログを張り付ける場合などではページがとても長くなることがあります。 こんな時にはテキストを折りたたんで表示する Wiki マクロを使うと見やすくなります。
これは 2.2.0 で追加されています。

{{collapse(詳細...)
これは折りたたまれたテキストブロックです。
デフォルトでは折りたたまれ、リンクのクリックで開きます。
}}

なお、こちらはテキスト限定ですが、 以前紹介した Cut Tag プラグインでは任意のものを折りたためます。

• Redmine お勧めプラグイン - Cut Tag | プログラマーズ雑記帳

13. Wiki 記法のエスケープ

Wiki 内で記法自身の説明を書いたり、 表のなかで | の文字を使ったりといった場合に Wiki 記法を無視させたいことがあります。

このような場合には <notextile> を使用します。

<notextile> エスケープする記述 </notextile>

あまりよく使う機能ではないですが、知らないと書けないものもでてきます。 頭の片隅にでも置いておくと役に立つときがくるかもしれません。

14. サイドバー

Wiki ページのサイドバーを自分で作成することができます。 こちらも以前はプラグインが必要だった機能です。
Sidebar という名前で Wiki ページを作成するとサイドバーにその内容が表示されます。

作成する場合は、最初に適当な Wiki ページで [[Sidebar]] と書いたページを作成(プレビュー)します。
そのリンクから Sidebar の名前のページを作成します。


作成するとその内容がサイドバーに追加されます。

Redmine お勧めプラグイン - Attach image from clipboard

今回は Attach image from clipboard プラグインの紹介です。
これはクリップボードから直接画像を直接添付できるようにするプラグインです。

• Attach image from clipboard - Plugins - Redmine

同様の機能を持つプラグインに Redmine Attach Screenshot があります。違いは次のようなところです。

• ピュア JavaScript
  • Redmine Attach Screenshot は Java
• チケットだけでなく、 Wiki 、 ニュースなどでも使える
• 日本語メッセージあり

HTML5 での JavaScript の機能追加

プラグインの紹介の前にピュア JavaScript のところを少し説明します。

HTML5 仕様ではWeb アプリケーション関連の JavaScript の機能として次の機能が追加されました。

• Drag & Drop
• ローカルファイルの IO
• クリップボードの利用 (正確には別仕様ですが)

これらを利用すれば、ファイルの添付など処理がとても使いやすくなります。
実際、このクリップボードの機能を利用して作られたのが今回のプラグインです。

ただし、 HTML 仕様への対応はブラウザーによるため、 Clipboard API に対応している Chrome や Firefox などを使う必要があります。


今回のプラグインは Clipboard API を使用していますが、Drab & Drop や ファイルの IO を利用したプラグインもあります。
ただし、こちらは私の試した環境 (Redmine 2.2.1 、 Windows) では動作しませんでした。

• Redmine jquery file upload plugin - Plugins - Redmine

使い方

インストールするとファイル添付の下にクリップボード用のリンクが追加されます。


これをクリックし、 Ctrl-V で貼り付けます。 貼付け後、更に領域を選択すこともできます。


また、指定後にできるチェーンのリンクをクリックすると、画像埋め込み用のコードを取得することもできます。


thumbnail マクロについては、以前の記事を見てください。

• 意外と知らない かもしれない Redmine の機能 13 選 #サムネイル用マクロ | プログラマーズ雑記帳

なお、私の試した環境では Wiki だと、たまに失敗しました。(Ver. 1.4)

インストール

GitHub のページから zip ファイルをダウンロードします。

• Tags ・ peclik/clipboard_image_paste ・ GitHub
• GitHub, Bitbucket でのファイルのダウンロード方法 | プログラマーズ雑記帳

(RedmineRoot)/plugins ディレクトリー以下に展開し、
ファイル名を clipboard_image_paste に変更します。

データベースを使うタイプではないので、 あとは Redmine を再起動すれば、動作するようになります。

Redmine お勧めプラグイン - Inline Note Images (チケットのコメントでも添付画像をサムネイル)

Excel のような WYSIWYG アプリに比べて、 Redmine で不便だなと感じるのは画像の貼り付けではないでしょうか。 それでいて、エラー状況のスクリーンショットなどを貼り付けたいことは結構あります。
今回はそんな作業をちょっと楽にする Inline Note Images plugin の紹介です。

• Inline Note Images plugin - Plugins - Redmine

プラグインの用途

以前、 Redmine 入門 で、 2 つのプラグインの紹介をしました。この 2 つのコンボで画像の貼り付けはかなり楽になります。

• Redmine Attach Screenshot プラグイン
  • クリップボードから直接画像を添付
• Lightbox Plugin for image attachment プラグイン
  • チケットの添付画像を自動でサムネイル表示

Redmine Attach Screenshot プラグインは Redmine 2.x に対応済みです。
また、前回紹介した Attach image from clipboard も同じ用途で使えます。(チケット以外でも使えるのが利点ですが、ブラウザーを選びます)

Lightbox プラグインは 2.x に対応してませんが、 デフォルトの機能で近いことは実現出来ます。

• 意外と知らない かもしれない Rdemine の機能 13 選 #添付ファイルの表示 | プログラマーズ雑記帳

これで問題は無いのですが、残念な点が一つあります。
それはチケットのコメントで足した画像ファイルはサムネイル表示されないことです。


これを可能にするのが Inline Note Images プラグインです。
インストールされていれば、 コメントでもサムネイル表示されるようになります。


大きな画像はサムネイルで、小さい場合はそのまま表示されるようです。

インストール

GitHub のページから zip ファイルをダウンロードします。

• anjlab/redmine_inline_note_images_plugin ・ GitHub
• GitHub, Bitbucket でのファイルのダウンロード方法 | プログラマーズ雑記帳

データベースを使うタイプではないので、次の手順でインストール出来ます。

1. (RedmineRoot)/plugins ディレクトリー以下に展開
2. ファイル名を redmine_inline_note_images_plugin に変更
   • 名前を変更していないと 404 Not Found エラー
3. Redmine (Web サーバー) を再起動