スポンサーサイト

上記の広告は1ヶ月以上更新のないブログに表示されています。
新しい記事を書く事で広告が消せます。
 

Redmine入門 - Wiki 、ニュース、文書、ファイル、フォーラムの用途

Redmine にはチケットだけではなく、 種々のデータを扱うことが出来ます。 それらの機能の用途について説明します。
  1. [Wiki]
  2. [文書]
  3. [ファイル]
  4. [ニュース]
  5. [フォーラム]
  6. プラグインによる管理データの追加

これらの用途を理解するうえで注意するべきことは、 Redmine は社内のプロジェクト管理システムとしてだけでなく、 SourceForge といった OSS ホスティングサービス のようなネットで公開するためのプロジェクト管理システムとしての利用も考慮されて作られている ということです。
主として公開用に用意されているような機能は社内で使う場合には必要がなかったり、 使う場合に注意が必要だったりします。

Wiki

Redmine ドキュメントを管理する機能がいろいろありますが、 [Wiki] はドキュメントを記述する機能の中で最も基本的なものです。 通常、プロジェクト内で共有したいドキュメントは [Wiki] に書くと思ってください。
公開用としては、ここにプロジェクトの詳しい説明やプログラムのマニュアルを書いたりします。

チケットなど他のドキュメントを書くところでも使えるのですが、 [Wiki] では Wiki 記法と呼ばれるフォーマットでドキュメントを書くことによって、 比較的簡単にマークアップしたドキュメントを書くことができるようになっています。
この Wiki 記法で書いたドキュメントが html ではどうなるかというのを表示する プレビュー 機能があり、確認しながら書くことが出来ます。 また、画像などを添付して、それを埋め込んで表示することも出来ます。

ここでは用途の説明だけで、実際の Wiki 記法に関する説明は次回に行います。

文書

[文書]でも Wiki 記法でドキュメントを書くことが出来ます。 [文書] も [Wiki] も同じようなことができるので、使いわけは難しいところですが、 [文書] では [Wiki] のプレビュー機能がなく、あまり長いドキュメントを書くのには向いていません。
このため、 [Wiki] の場合はドキュメントを直接 [Wiki] に書くのに対して、 [文書] は Word 文書や PDF といったドキュメントファイルを登録するのに使用します。
文書のデータを作成する場合には、文書ファイルを添付したり、次回以降で説明する方法で他のシステムなどへのリンクを張ったりした後、その説明を Wiki 記法で書くことになります。

この文書ファイルの管理を強化した DMSF というプラグインがあります。
これを使うと階層構造で文書を管理したり、ファイルのバージョンを管理したりなどもできるようになります。 また、 Word や PDF ファイルなどの中身も検索できます。日本語には対応していませんが、 頑張れば日本語にも対応できるらしいです。

ファイル


[文書] が文書ファイルを管理するのに使うということになると、 じゃ、 [ファイル] は何に使うの? と思われるかも知れません。
[ファイル] は主に公開用の機能で、プログラムのリリースパッケージを登録して、 ここからダウンロードしてもらうことになります。
このため、ダウンロード数をカウントしたり、バージョンごとにカテゴライズして登録する機能があります。
このカテゴリに使っているバージョンはバージョンの説明へのリンクとなっています。 このバージョンの説明では、関連付けられたチケットの一覧も表示されますので、 ちょうどリリースノートのようにすることも出来ます。

さらに Download Buttton プラグインを使用するとダウンロード用に分かりやすいボタンをつけることが出来ます。

[ファイル] を社内用として使う場合には、プロジェクトの開発ツールなどを管理するのに使えるのではないかと思います。

ニュース


[ニュース] も主に公開用の機能で、プログラムの新しいバージョンをリリースした場合などにニュースを使ってお知らせを書きます。
このため、 Redmine のホームやプロジェクトの概要ページで最新ニュースが表示されるようになっています。
そういった場所でも表示するためか Wiki のプレビュー機能はあるのですが、添付ファイルの機能がなく画像を表示するといったことが出来ません。

この [ニュース] を社内プロジェクトで使う場合には、プロジェクトメンバーへのお知らせなどに使えると思います。 しかし、この場合には注意が必要になります。
というのも、 [ニュース] ではメール通知が行われない可能性があるからです。
前回書いたようにシステムの設定で新しいニュースを書いた場合にメール通知を行うように設定することは可能ですが、 個人設定のデフォルトでは関連のある事柄だけ受け取るようになっています。 そのため、プロジェクトメンバー全員がプロジェクトのすべての通知を受け取るように変更していないと、メールを受け取らない人が出てきます。

Notify News Every Member というプラグインをインストールしていると、 プロジェクトメンバー全員にメールで通知されるようになります。 社内用で [ニュース] を使いたい場合にはこのプラグインをインストールしておいた方がいいでしょう。

フォーラム


[フォーラム] はいわゆる掲示板の機能です。
公開用としてはユーザーからの質問や要望を書いてもらう場所として利用できます。 ただ、この用途として利用するためには少なくともプロジェクト管理者は そのプロジェクトのすべてのメール通知を受け取る設定にしておいた方がいいでしょう。

社内用として利用する場合には [ニュース] と同じメール通知の問題があります。
これを解決するために Board Watchers プラグインを使うことが出来ます。 これを使えば、フォーラムで何かを議論するときにウォッチャーを指定することができるようになります。

また、ユーザーの質問やメンバー同士の議論の中からチケットを発生させたい場合があります。 こういった場合には Issue from message プラグインを使えば、 フォーラムのメッセージからチケットを作成することができます。

プラグインによる管理データの追加


デフォルトで用意されているデータの他にもプラグインをインストールすることで管理データを増やすことが出来ます。

  • 用語集プラグイン
    • 私の作成した用語集のプラグインです。 プロジェクト内で使っている専門用語の用語集を作成して共有することができるようになります。 用語集を作るのは XP プログラム の視点からも重要ではないかと思います。
  • ezFAQ プラグイン
    • FAQ を追加します。 用語集を作るときにかなり参考にさせてもらいました。
  • Wiki Books
    • 以前、私は r-labs に 『プラグイン開発ガイド』 というドキュメントを書いたことがあります。 このときは目次や次章へのリンクといったものも Wiki でごりごり書いたのですが、 これを使うとそれらを自動で付けて、本っぽいのが書けるようになります。 サンプル


スポンサーサイト
 

Redmine入門 - Wiki 詳細

Redmine では、 [Wiki] はもちろんチケットなどいたるところで、 Wiki 記法でドキュメントを書くことが出来ます。
今回はこの Wiki についてもう少し詳しく書いてみます。

Wiki 記法

Wiki 記法では html の面倒なタグを書かなくても、簡単に修飾した(リッチな)ドキュメントが書けるようになっています。
また、 html を直接書けるようにしていると、 JavaScript などのコードも書くことができ、 悪意があれば、大抵のことは出来てしまいます。 不特定多数の人が記述するサイトなどではこういった問題を避ける意味もあります。

Wiki 記法はいろいろ種類があるのですが、 Redmine ではこのうち textile 記法 が使われています。

Redmine の Wiki 記法に関しては以下のページが参考になると思います。
  1. textile 記法 | Redmine.JP
  2. Redmine における wiki 記法 | Redmine.JP
  3. Redmine Wiki で本当に使える Textile 記法を全て試してみた

マークアップはいろいろありますが、とりあえず覚えておくと便利だなと思われるものをあげてみます。

ツールボタンで入力可能なもの
wiki テキスト入力エリアの上部にあるボタンで、キーワードの挿入します。 ただ挿入するだけでなく、置換や領域選択していた場所への挿入などもできます。
目次
{{toc}} または {{>toc}}(右よせ) と書くとそのページの目次を作成します。 使う場合は h1, h2 などで段落をつけて書いておきます。
テーブル
| で項目を区切ります。 テーブルのヘッダにしたい場合は |_. とします。
html リンク
http:// で始まるものは自動的にリンクを張ってくれます。 リンクの表示名を変えたい場合や http:// で始まらないものへのリンクを張りたい場合は以下のように記述します。
"表示名":アドレス
"プログラマーズ雑記帳":http://yohshiy.blog.fc2.com/
チケットへのリンク
#チケット番号 と書いているとチケットへのリンクとなります。

Redmine の Wiki では基本的に日本語では単語の区切りとしてみなされないため、 スペースをあけたり、() などの半角記号で囲っておく必要があります。
我が輩は*猫*である     (×)
我が輩は *猫* である   (○)
関連するチケット#256   (×)
関連するチケット(#256) (○)

あまり網羅されたものでは在りませんが、 ツールボタンのところにある [ヘルプ] で Wiki のヘルプも表示できます。これを日本語化することも出来ます。
  1. wiki のヘルプを日本語化したい | Redmine.JP
  2. プラグイン版

Wiki マクロ

目次の {{toc}} のような型式でマクロを記述することが出来ます。 この Wiki マクロは、デフォルトでもいくつかは用意されていますが toc 以外は私はあまり使ったことがありません。 主にプラグインなどで Wiki を拡張するためのものだと思います。

例えば、用語集プラグインでは次のように書くと用語へのリンクとなります。
{{term(用語)}}

プラグインで追加されていくので、 今のシステムでどんなものが使えるか見たくなります。 こういった場合、 Redmine インフォメーション プラグインでは [情報] → [Wiki マクロ] で使用できるマクロの一覧を表示することができます。
ただし、プラグインの提供している説明をそのまま表示しているだけなので、 英語ですし、説明の付いていないマクロは表示されません。

この Wiki マクロを追加するのは、意外と簡単です。(複雑なものを作ろうとすると当然難しくなりますが)
以前、この追加方法の記事を書いたので、 Wiki を少し拡張したくなった場合はそちらを参考に作ってみてはどうでしょうか。

画像

バグ報告のチケットなどを作成する場合、エラー状況のスクリーンショットを添付したいといったことがあります。
こういった場合は、チケットには添付ファイルを付ける機能があるので、これを利用して以下のような手順で画像を添付します。
  1. [Alt + PrintScreen] などで画面をクリップボードにコピー
  2. 画像ビューワーなどで画像ファイル(PNG など)に保存
  3. チケット作成時に添付(ファイルのアップロード)
  4. !filename.png! の形式で Wiki に記述 (画像を埋め込んで表示したい場合)

Redmine Attach Screenshot プラグイン を使うとクリップボードの画像を自動的に screenshot.png(変更可) という名前にして添付してくれます。
すなわち、 2, 3 の手順が簡単に行えるようになります。

また、 4. の埋め込んで表示しようした場合、 画像が大きすぎてはみ出して見づらくなってしまうといったこともよくあります。 このような場合には、 Thumbnails プラグイン が便利です。次のような Wiki を書くと、サムネイルを作成して表示してくれます。 サムネイルをクリックすると元画像が表示されるというようになっています。
{{thumb(example.png)}}

さらに Lightbox Plugin for image attachment をインストールしているとチケットに添付された画像、 PDF ファイルのサムネイル一覧を自動で作成してくれます。 つまり、 4. の手順とサムネイル化を自動化してくれます。
どういった表示になるかはリンク先のスクリーンショットを見てもらった方が早いと思います。 ページ移動もなく、かなりみやすくなります。

コードハイライト

Redmine を使用しているとコード片を Wiki 中に書きたくなることがよくあると思います。 Wiki 中にコードを書く場合、次のように書くとハイライトして表示することができます。
<pre><code class="cpp">
int main()
{
    std::cout << "Hello World!!" << std::endl;
    return 0;
}
</code></pre>

この class によってハイライトする言語を指定します。 ここ記述する値は基本的に C++ では cpp, Ruby なら rb といった言語の拡張子です。
対応していないものを書いたとしてもハイライトしないだけなので、とりあえず書いておくとよいでしょう。 指定可能な言語の一覧も以下のページに記載されています。
このコードハイライトには CodeRay という ruby プログラムが使用されているのですが、 いまだに(Redmine 1.3.0) C# に対応していません。 (ただ、 C++ として指定していると多少はハイライトしてくれます。 )
redmine_js_syntax_highlighter プラグインをインストールするとコードハイライトに JavaScript の SyntaxHighlighter を使うようになります。 SyntaxHighlighter では C# もハイライトすることが可能です。 ただし、かわりに json, rhtml といったコードをハイライトすることができなくなります。

Wiki Extensions プラグイン

Wiki の拡張プラグインといえば、 Wiki Extensions プラグイン ではないでしょうか。
このプラグインを使うといろいろな拡張ができるのですが、 タグ、投票、特定の Wiki ページのプロジェクトメニューへの追加 といった他のプラグインが行っているようなことがこのプラグイン一つで出来てしまいます。

また、 SideBar, Footer といった名前のページを作っておくと それらを Wiki ページのサイドバーやフッターとして挿入してくれます。
サイドバーなどと組み合わせると便利だと思われる機能もいろいろあるので、 以下にサンプルをあげておきます。 (ほとんど r-labs のページのコピーですが)

SideBar
{{new_page}}

h3. 最近の更新

{{recent(10)}}

h3. 本日のアクセス数TOP5

{{popularity(5, 1)}}

h3. アクセス数TOP10

{{popularity(10)}}

{{tagcloud}}

Footer
{{comments}}

{{comment_form}}

---
p>. Updated by {{lastupdated_by}} , {{lastupdated_at}}{{count}}
Access count: {{show_count}}



 

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

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

チケット

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

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

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

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

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


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

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

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

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

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

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

3. 添付ファイルの表示

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

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


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

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

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

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

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

登録する場合にはキーワードによる指定の後に @時間 を追加します。
refs #1234 @2:30
ただし、この機能は Redmine の設定で機能が有効になっていないと使えません。
設定ページは [管理] → [設定] → [リポジトリ] の順で開きます。
redmine_unknown_scm_time.png

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

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

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

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

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

[リポジトリ]の編集したいリビジョンのページを開いて、追加または削除を行います。
redmine_unknown_scm_link.png リビジョンへのリンクを 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_unknown_tooltip_date.png

なお、以下のプラグインを入れると日付の表示を変更することもできます。 Wiki などで #番号 と書くとチケットへのリンクとなります。
ただ、普通は番号でチケットを覚えたりしないと思います。 チケットの内容はリンク先をみないとよくわかりません。

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

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

Wiki

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

9. 簡易 pre

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

前後に空行をいれて、インデントしてみてください。 これで整形済みテキストとなります。
前の文章
(空行)
  インデントした行
整形済みテキスト内文章
  整形済みテキスト内文章
(空行)
後の文章
redmine_unknown_simple_pre.png

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(詳細...)
これは折りたたまれたテキストブロックです。
デフォルトでは折りたたまれ、リンクのクリックで開きます。
}}
redmine_unknown_wiki_fold_close.png redmine_unknown_wiki_fold_open.png
なお、こちらはテキスト限定ですが、 以前紹介した Cut Tag プラグインでは任意のものを折りたためます。

13. Wiki 記法のエスケープ

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

このような場合には <notextile> を使用します。
<notextile> エスケープする記述 </notextile>
あまりよく使う機能ではないですが、知らないと書けないものもでてきます。 頭の片隅にでも置いておくと役に立つときがくるかもしれません。

14. サイドバー

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

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

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

 
このページをシェア
アクセスカウンター
アクセスランキング
[ジャンルランキング]
コンピュータ
9位
アクセスランキングを見る>>

[サブジャンルランキング]
プログラミング
3位
アクセスランキングを見る>>
カレンダー(アーカイブ)
プルダウン 降順 昇順 年別

09月 | 2017年10月 | 11月
1 2 3 4 5 6 7
8 9 10 11 12 13 14
15 16 17 18 19 20 21
22 23 24 25 26 27 28
29 30 31 - - - -


はてな新着記事
はてな人気記事
ブロとも申請フォーム
プロフィール

yohshiy

Author:yohshiy
職業プログラマー。
仕事は主に C++ ですが、軽い言語マニアなので、色々使っています。

はてブ:yohshiy のブックマーク
Twitter:@yohshiy

サイト紹介
プログラミング好きのブログです。プログラミング関連の話題や公開ソフトの開発記などを雑多に書いてます。ただ、たまに英語やネット系の話になることも。
上記広告は1ヶ月以上更新のないブログに表示されています。新しい記事を書くことで広告を消せます。