Redmine入門 - Wiki 詳細 | プログラマーズ雑記帳

Redmine入門 - Wiki 詳細

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

Wiki 記法

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

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

Redmine の Wiki 記法に関しては以下のページが参考になると思います。

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

ツールボタンで入力可能なもの

wiki テキスト入力エリアの上部にあるボタンで、キーワードの挿入します。ただ挿入するだけでなく、置換や領域選択していた場所への挿入などもできます。

目次

{{toc}} または {{>toc}}(右よせ) と書くとそのページの目次を作成します。使う場合は h1, h2 などで段落をつけて書いておきます。

テーブル

| で項目を区切ります。テーブルのヘッダにしたい場合は |_. とします。

html リンク

http:// で始まるものは自動的にリンクを張ってくれます。リンクの表示名を変えたい場合や http:// で始まらないものへのリンクを張りたい場合は以下のように記述します。

"表示名":アドレス
"プログラマーズ雑記帳":http://yohshiy.blog.fc2.com/

チケットへのリンク

#チケット番号 と書いているとチケットへのリンクとなります。

Redmine の Wiki では基本的に日本語では単語の区切りとしてみなされないため、スペースをあけたり、() などの半角記号で囲っておく必要があります。

我が輩は*猫*である     (×)
我が輩は *猫* である   (○)
関連するチケット#256   (×)
関連するチケット(#256) (○)

あまり網羅されたものでは在りませんが、ツールボタンのところにある [ヘルプ] で Wiki のヘルプも表示できます。これを日本語化することも出来ます。

Wiki マクロ

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

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

{{term(用語)}}

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

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

Wiki マクロの追加方法

画像

バグ報告のチケットなどを作成する場合、エラー状況のスクリーンショットを添付したいといったことがあります。
こういった場合は、チケットには添付ファイルを付ける機能があるので、これを利用して以下のような手順で画像を添付します。

[Alt + PrintScreen] などで画面をクリップボードにコピー
画像ビューワーなどで画像ファイル(PNG など)に保存
チケット作成時に添付(ファイルのアップロード)
!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 といった言語の拡張子です。
対応していないものを書いたとしてもハイライトしないだけなので、とりあえず書いておくとよいでしょう。指定可能な言語の一覧も以下のページに記載されています。

http://blog.redmine.jp/articles/syntax-hilight/

このコードハイライトには CodeRay という ruby プログラムが使用されているのですが、いまだに(Redmine 1.3.0) C# に対応していません。 (ただ、 C++ として指定していると多少はハイライトしてくれます。例 )
redmine_js_syntax_highlighter プラグインをインストールするとコードハイライトに JavaScript の SyntaxHighlighter を使うようになります。 SyntaxHighlighter では C# もハイライトすることが可能です。ただし、かわりに json, rhtml といったコードをハイライトすることができなくなります。

SyntaxHighlighter の対応言語

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}}

関連記事

Prev. Category Next

trackback

新規トラックバック

この記事にトラックバックする(FC2ブログユーザー)

Facebook コメント

日	月	火	水	木	金	土
-	-	-	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	-

プログラマーズ雑記帳