はじめてのRedmine使いこなし術(2):Wikiページへのリンク記法

2018-09-30 23:50  •  分類:  •  石原佑季子

Redmine初心者の方向けのシリーズ記事「はじめてのRedmine使いこなし術」では、知っていると便利で簡単なテクニックを紹介します。第2回はWikiページへのリンク記法についてです。


Wikiはマニュアルや議事録などプロジェクトのメンバーで共有したい情報の掲載ページを、複数人で共同作成できる機能です。

Wikiページはいずれかのプロジェクトの中に作成しますが、プロジェクトをまたいでチケットやプロジェクトの概要画面などから作成したWikiページへリンクすることができます

(例)「Webサイト更新」プロジェクトのWiki

プロジェクト内のWikiページへのリンク記法

プロジェクト内でWikiページへのリンクをする場合は以下のように書きます。

[[Wikiページ名]]

[[]]はツールバーのアイコンをクリックすると簡単に入力できます。

リンク先はURLではなく日本語のタイトルでOK

入力結果

チケットの注記にWikiページへのリンクを記述できた

他のプロジェクトのWikiページへのリンク記法

他のプロジェクトのWikiページへリンクすることもできます。例えば、複数のプロジェクトでマニュアルを共有したい場合や、過去の同じようなプロジェクトのWikiを参照するときなどに便利です。

以下のような記法で書きます。

[[プロジェクト名:Wiki名]]

チケットに他プロジェクトのWikiページへのリンクを追加

Wikiページの見出しへのリンク記法

見出しとは

見出しは、チケットやWikiなどでレベル1〜6まで表示できます。

Textile Markdown

テキスト書式を TextileMarkdown どちらを選択しているかによって記法が異なります。(テキスト書式の設定:「管理」→「設定」→「全般」→「テキスト書式」)


入力結果

同じプロジェクトにあるチケットなどからWikiページの見出しへリンクするときの記法です(記法はTextile・Markdown共通)。

[[Wikiページ名#見出し名]]

プロジェクトが異なる場合は、プロジェクトを指定します。

[[プロジェクト名:Wikiページ名#見出し名]]

入力結果


※Redmine 4.0以降では、同一Wikiページ内の見出しへのリンクの場合、Wikiページ名を省略して書くことができます。

[[#見出し名]]

入力結果

Wikiページへのリンクを別の名前で表示

WikiページへのリンクをWikiページ名ではなく、好きな名前で表示することができます(記法はTextile・Markdown共通)。

[[Wikiページ名|表示するテキスト]] 

プロジェクトが異なる場合は、プロジェクトを指定します。

[[プロジェクト名:Wikiページ名|表示するテキスト]]

入力結果

その他の記法

ツールバーのヘルプアイコンをクリックすると、以下のウィンドウ「Wiki記法クリックリファレンス」が表示され、主な記法を確認できます。


Wiki記法クリックリファレンス

より詳しい記法はRedmineにおけるwiki記法 (Redmine.JP)をご覧ください。

チケットやWikiでは専用の書式「Markdown」または「Textile」を使用できますが、本記事で紹介したWikiページへのリンクはMarkdownとTextileで共通の記述です。書式はRedmine全体の設定なので、2つの書式を併用することはできません(デフォルトの設定はTextile)。後から設定を変更すると、それまでに入力した表示が崩れてしまうので初めにどちらを使うか決めましょう。

関連情報

バックナンバー

この連載は毎月下旬に掲載します。「Redmine News」に登録いただくと新着記事をメールでお知らせします。
最新情報お知らせメール「Redmine News」 (Redmine.JP)


さらに使いこなすためのワンポイントチェック

Redmineをより便利に、効率よく使いこなすためのチェックポイントを紹介。こちらもあわせてご覧ください。

Redmineワンポイントチェック最終回・全11回総集編

作成: 2018-09-30 23:50  •  分類: