r-labs » Wiki Lists

h1. Redmine Plugin: Wiki Lists {{count}}

{{>toc}}

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

Redmineのwikiやチケットにチケット一覧を表示するマクロプラグインです。

h2. リンク

Redmine本家: http://www.redmine.org/plugins/redmine_wiki_lists

リポジトリ: https://github.com/tkusukawa/redmine_wiki_lists/

ダウンロード: https://github.com/tkusukawa/redmine_wiki_lists/releases

h2. インストール

https://github.com/tkusukawa/redmine_wiki_lists/releases

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

$REDMINE/plugins/

に展開します。

<pre>

$ cd $REDMINE/plugins

$ unzip wiki_lists-～.zip

</pre>

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

h1. 使い方

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

wikiやチケットの説明/注記の中にチケットの一覧を表示します。

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

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

古いオプション {{collapse

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

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

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

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

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

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

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

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

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

* -p[=IDENTIFIRE]

  表示するチケットのプロジェクトを限定します。

}}

* -i=CUSTOM_QUERY_ID

  -q=CUSTOM_QUERY_NAME

  カスタムクエリの結果を表示します。

* -0

  結果が0件の場合に表を表示しません。

* -f:<ATTRIBUTE>␣<OPERATOR>␣<[VALUE[|VALUE...]]>

  指定した条件でフィルタリングした結果を表示します。

  例 {<notextile>{ref_issues(-f:tracker_id = 3)}</notextile>}

  ※ 「＝」等の両側にスペースが必要です。

　　シングルクオートやダブルクオートは使えません。(今のところ端がスペースの文字をVALUEにできません)

  [ATTRIBUTE]

<pre>

issue_id,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_*,

tracker,category,status,assigned_to,version,project,

treated,

</pre>

※ カスタムフィールド(cf_1等)を使う場合は-pでプロジェクトを限定するか、-iや-qでカスタムクエリを指定する必要があります。

  [OPERATOR]

<pre>

=:等しい, !:等しくない, o:未完了, c:完了, !*:なし, 

*:すべて, >=:以上, <=:以下, ><:次の範囲内, 

>t+:今日から○日後以降, >w:今週, lw:先週, 

l2w:直近2週間, m:今月, lm:先月, 

y:今年, >t-:今日より○日前以降, 

~:含む, !~:含まない, =p:次のプロジェクト内のチケット, 

=!p:次のプロジェクト外のチケット, !p:次のプロジェクト内のチケットを除く

</pre>

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

チケットでこのマクロを利用する場合、[](角括弧)内に下記カラム名を書くことで当該チケットの属性をVALUEとして参照利用できます。

* -l[=column]

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

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

* -t[=column]

  チケットの検索結果を表にせずに表示します。

  マクロ等は再帰的に解釈されます。

* -c

  抽出されたチケットの数を表示します。

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

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

* project : プロジェクト

* tracker : トラッカー

* parent : 親チケット

* status : ステータス

* priority : 優先度

* subject : 題名

* author : 作成者

* assigned_to : 担当者

* updated_on : 更新日時

* category : カテゴリ

* fixed_version : 対象バージョン

* start_date : 開始日

* due_date : 期日

* estimated_hours : 予定工数

* done_ratio : 進捗％

* created_on : 作成日時

* closed_on : 終了日時

* relations : 関連チケット

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

h3. 例

|\2. *例1. カスタムクエリをIDで指定して表示*|

|表記|{{@ref_issues(-i=9)@}}|

|結果|{{ref_issues(-i=9)}}|

|\2. *例2. カスタムクエリを名前で指定して表示*|

|表記|{{@ref_issues(-q=MyCustomQuery1)@}}|

|結果|{{ref_issues(-q=MyCustomQuery1)}}|

|\2. *例3. 題名に「sorting」を含むチケットの一覧を表示*|

|表記|{{@ref_issues(-f:subject ~ sorting)@}}|

|結果|{{ref_issues(-f:subject ~ sorting)}}|

|\2. *例4. 題名に「sorting」を含むチケットを 題名、作成者、担当者、ステータスの形で表示*|

|表記|{{@ref_issues(-f:subject ~ sorting, subject, author, assigned_to, status)@}}|

|結果|{{ref_issues(-f:subject ~ sorting, subject, author, assigned_to, status)}}|

|\2. *例5. プロジェクトをWiki Listsに限定し、トラッカーIDが3(Support)か6(Question)のチケット一覧を表示*|

|表記|{<notextile>{ref_issues(-f:project = Wiki Lists, -f:tracker_id = 3 | 6)}</notextile>}|

|結果|{{ref_issues(-f:project = Wiki Lists, -f:tracker_id = 3 | 6)}}|

|\2. *例6. 題名が「Sample」のチケットへのリンクをチケットIDで表示*|

|表記|{{@ref_issues(-f:subject = Sample, -l=id)@}}|

|結果|{{ref_issues(-f:subject = Sample, -l=id)}}|

|\2. *例7. 題名が「Sample」のチケットの説明の内容を表示*|

|表記|{{@ref_issues(-f:subject = Sample, -t=description)@}}|

|結果|{{ref_issues(-f:subject = Sample, -t=description)}}|

|\2. *例8. 題名に「sorting」を含むチケットの数を表示*|

|表記|{{@ref_issues(-f:subject ~ sorting, -c)@}}|

|結果|{{ref_issues(-f:subject ~ sorting, -c)}}|

Ver 0.0.7

|\2. *例9. チケット番号でフィルタ*|

|表記|{<notextile>{ref_issues(-f:issue_id >< 1389|1390)}</notextile>}|

|結果|{{ref_issues(-f:issue_id >< 1389|1390)}}|

|\2. *例10. 検索結果が0件の場合に表を表示しない*|

|表記|{<notextile>{ref_issues(-0,-f:subject = Sample2)}</notextile>}|

|結果|{{ref_issues(-0,-f:subject = Sample2)}}|

|\2. *例11. 名称指定のOR検索*|

|表記|{<notextile>{ref_issues(-f:category = sample|error, subject, category)}</notextile>}|

|結果|{{ref_issues(-f:category = sample|error, subject, category)}}|

|\2. *例12. ユーザkusu(id:89)が2016-10-01から2016-10-31に作成または更新したチケットを検索*|

|表記|{<notextile>{ref_issues(-f:treated 89 2016-10-01|2016-10-31)}</notextile>}|

|結果|{{ref_issues(-f:treated 89 2016-03-01|2016-03-31)}}|

h2. 変更履歴

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