r-labs » Wiki Lists

h1. Redmine Plugin: Wiki Lists 

{{>toc}}

English page is [[Wiki Lists en|here]].

Redmineのwikiに表を表示するプラグインです。

h2. ダウンロード

"butbucket":https://bitbucket.org/kusu/redmine_wiki_lists/downloads

h2. インストール

https://bitbucket.org/kusu/redmine_wiki_lists/downloads

から最新のzipファイルをダウンロードし

(redmine2.0の場合)$REDMINE/plugins/

(redmine1.*.*の場合)$REDMINE/vendor/plugins

に展開します。

<pre>

$ cd $REDMINE/plugins ← redmine2.0以降の場合

or

$ cd $REDMINE/vendor/plugins  ← redmine1.*.*の場合

$ unzip wiki_lists-～.zip

</pre>

これでRedmineを起動すると下記のマクロが使えるようになります。

h2. 変更履歴

→ "ロードマップ":/projects/wiki_lists/roadmap?completed=1

h1. 使い方

h2. チケットリストの表示

wikiやチケットの中にチケットの一覧を表示します。

①カスタムクエリーで抽出されたチケット、

②指定したワードを含むチケット、

③属性値がワードと一致するチケット

の何れかで表示するチケットを抽出します。

h3. 書式: {{@ref_issues([options].., [column]..)@}}

*options:* 以下のオプションを指定できます。

* -i=[CustomQueryID] 

  表示項目および絞り込み条件にカスタムクエリの内容を使用します。

* -q=[CustomQuery名]

  表示項目および絞り込み条件にカスタムクエリの内容を使用します。

* -p[=identifire]

  特定のプロジェクトのチケットのみ表示します。

* -s[=WORD[|WORD...]]

  題名(subject)にワードを含むチケットを表示を表示します。

  ワードを省略すると記述ページの題名を検索ワードとして使用します。

* -d[=WORD[|WORD...]]

  説明(description)にワードを含むチケットを表示します。。

  ワードを省略すると記述ページの題名を検索ワードとして使用します。

* -w[=WORD[|WORD...]]

  題名または説明にワードを含むチケットを表示します。

  ワードを省略すると記述ページの題名を検索ワードとして使用します。

* -f:ATTRIBUTE[=WORD[|WORD...]]

  指定した属性(ATTRIBUTE)がWORDと一致するチケットを表示します。

  ワードを省略すると記述ページの題名を検索ワードとして使用します。

  属性には以下のものが利用できます。

  tracker_id,project_id,subject,description, 

  due_date,category_id,status_id,assigned_to_id,priority_id, 

  fixed_version_id,author_id,lock_version,created_on,updated_on, 

  start_date,done_ratio,estimated_hours,parent_id,root_id, 

  lft,rgt,is_private,closed_on, cf_* }

絞り込み条件を複数記述した場合はAND条件となります。

WORDsは'|'で区切ることで複数のワードのOR条件を指定できます。

絞り込み条件の指定が無い場合は当該ページの題名が検索キーワードに使われます。

* -l[=column]

  チケットの検索結果をリンク付きテキストとして表示します。

  カラムを指定することで題名以外のチケット属性を表示することができます。

*column:* 表示する列を指定します。

省略した場合はカスタムクエリで指定した列が表示されます。

* project : プロジェクト

* tracker : トラッカー

* parent : 親チケット

* status : ステータス

* priority : 優先度

* subject : 題名

* author : 作成者

* assigned_to : 担当者

* updated_on : 更新日

* category : カテゴリ

* fixed_version : 対象バージョン

* start_date : 開始日

* due_date : 期日

* estimated_hours : 予定工数

* done_ratio : 進捗％

* created : 作成日

* cf_* : カスタムフィールド(*はID番号)

h3. 例

*例1. カスタムクエリをIDで指定*

{{@ref_issues(-i=9)@}}

{{ref_issues(-i=9)}}

*例2. カスタムクエリを名前で指定*

{{@ref_issues(-q=MyCustomQuery1)@}}

{{ref_issues(-q=MyCustomQuery1)}}

*例3. プロジェクトを指定し、題名に「config」を含むチケットの一覧*

{{@ref_issues(-p=codereview,-s=config)@}}

{{ref_issues(-p=codereview,-s=config)}}

*例4. カスタムクエリを利用し、特定ユーザが担当しているもの*

{{@ref_issues(-i=9,-f:assigned_to_id=3)@}}

{{ref_issues(-i=9,-f:assigned_to_id=3)}}

*例5. プロジェクトをwikiextに限定し、題名か本文にemoticonsかjenkisを含むチケットについて、題名のテーブル表示する*

{{@ref_issues(-p=wikiext,-w=emoticons|jenkins,subject)@}}

{{ref_issues(-p=wikiext,-w=emoticons|jenkins,subject)}}

*例6. プロジェクトをwikiextに限定し、題名か本文にemoticonsかjenkisを含むチケットをリンク文字列で表示する*

{{@ref_issues(-p=wikiext,-w=emoticons|jenkins,-l)@}}

{{ref_issues(-p=wikiext,-w=emoticons|jenkins,-l)}}

h2. Wikiページの一覧リストの表示

h3. 書式

<pre>

{{wiki_list}}

</pre>