Redmine Plugin: Wiki Lists ¶

• Table of contents
• • • This is the issue[#1389]'s description that explain 'ref_issues' wiki macro example.
• Redmine Plugin: Wiki Lists
  • リンク
  • インストール
• ＜使い方＞チケットリストの表示: ref_issues
  • 書式: {{ref_issues([option].., [column]..)}}
    • options
    • column
    • 例
  • 変更履歴

English page is here.

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

リンク¶

Redmine本家: http://www.redmine.org/plugins/redmine_wiki_lists
リポジトリ: https://github.com/tkusukawa/redmine_wiki_lists/
ダウンロード: https://github.com/tkusukawa/redmine_wiki_lists/releases

インストール¶

https://github.com/tkusukawa/redmine_wiki_lists/releases
から最新のzipファイルをダウンロードし
$REDMINE/plugins/
に展開します。

$ cd $REDMINE/plugins
$ unzip wiki_lists-～.zip

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

＜使い方＞チケットリストの表示: ref_issues¶

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

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

options¶

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

古いオプション ShowHide

• -i=CUSTOM_QUERY_ID
  -q=CUSTOM_QUERY_NAME
  カスタムクエリの結果を表示します。

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

• -f:<ATTRIBUTE>␣<OPERATOR>␣<[VALUE[|VALUE...]]>
  指定した条件でフィルタリングした結果を表示します。
  例 {{ref_issues(-f:tracker_id = 3)}}
  ※ 「＝」等の両側にスペースが必要です。
  　　シングルクオートやダブルクオートは使えません。(今のところ端がスペースの文字をVALUEにできません)
  　
  [ATTRIBUTE]
  

  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,
  

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

  =:等しい, !:等しくない, o:未完了, c:完了, !*:なし, 
  *:すべて, >=:以上, <=:以下, ><:次の範囲内, 
  >t+:今日から○日後以降, >w:今週, lw:先週, 
  l2w:直近2週間, m:今月, lm:先月, 
  y:今年, >t-:今日より○日前以降, 
  ~:含む, !~:含まない, =p:次のプロジェクト内のチケット, 
  =!p:次のプロジェクト外のチケット, !p:次のプロジェクト内のチケットを除く
  

  
  　
  絞り込み条件を複数記述した場合はAND条件となります。
  　
  チケットでこのマクロを利用する場合、[](角括弧)内に下記 column を書くことで当該チケットの属性をVALUEとして参照利用できます。
  → [<column>]以外にも [id],[current_project_id],[current_user],[current_user_id],[<数字>days_ago] が利用できます。

• -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番号)

例¶

例1. カスタムクエリをIDで指定して表示
表記	{{ref_issues(-i=9)}}
結果	# Status Subject Assignee Updated 1497 終了（Closed） filter by enum value of custom field: key value list Tomohisa Kusukawa 04/18/2021 08:35 AM Actions 1482 終了（Closed） want to use field reference of Issue in History part Tomohisa Kusukawa 04/18/2021 08:34 AM Actions 1446 終了（Closed） add [current_project_id] for value field Tomohisa Kusukawa 07/29/2017 09:51 AM Actions 1443 終了（Closed） can not use custom fields even when restrict the project Tomohisa Kusukawa 12/05/2016 01:09 AM Actions 1326 終了（Closed） ref_issues with custom fields not working Tomohisa Kusukawa 07/19/2015 07:29 PM Actions 1248 終了（Closed） use custom field to additional filter Tomohisa Kusukawa 07/22/2013 12:26 AM Actions 1063 終了（Closed） overwrite_sql_for_fieldをRedmine2.0に合わせる Tomohisa Kusukawa 09/09/2012 04:55 PM Actions 999 終了（Closed） ref_issues: Query with custom field. Haru Iida 10/20/2012 10:17 AM Actions

例2. カスタムクエリを名前で指定して表示
表記	{{ref_issues(-q=MyCustomQuery1)}}
結果	# Status Subject Assignee Updated 1497 終了（Closed） filter by enum value of custom field: key value list Tomohisa Kusukawa 04/18/2021 08:35 AM Actions 1482 終了（Closed） want to use field reference of Issue in History part Tomohisa Kusukawa 04/18/2021 08:34 AM Actions 1446 終了（Closed） add [current_project_id] for value field Tomohisa Kusukawa 07/29/2017 09:51 AM Actions 1443 終了（Closed） can not use custom fields even when restrict the project Tomohisa Kusukawa 12/05/2016 01:09 AM Actions 1326 終了（Closed） ref_issues with custom fields not working Tomohisa Kusukawa 07/19/2015 07:29 PM Actions 1248 終了（Closed） use custom field to additional filter Tomohisa Kusukawa 07/22/2013 12:26 AM Actions 1063 終了（Closed） overwrite_sql_for_fieldをRedmine2.0に合わせる Tomohisa Kusukawa 09/09/2012 04:55 PM Actions 999 終了（Closed） ref_issues: Query with custom field. Haru Iida 10/20/2012 10:17 AM Actions

例3. 題名に「sorting」を含むチケットの一覧を表示
表記	{{ref_issues(-f:subject ~ sorting)}}
結果	# Project Tracker Status Priority Subject Assignee Updated Target version % Done 1235 Wiki Lists Defect 終了（Closed） 通常（Normal） Sorting of table of trackers is not compliant with custom query Tomohisa Kusukawa 06/05/2013 05:36 PM 0.0.2 Actions 1045 Wiki Extensions Defect 終了（Closed） 通常（Normal） Table sorting does not work. Haru Iida 10/20/2012 03:13 PM Wiki Extensions - 0.6.0 Actions 779 Wiki Extensions Defect 却下（Invalid） 通常（Normal） Problems with table sorting with redmine wiki extensions Haru Iida 06/14/2011 12:10 AM Wiki Extensions - 0.3.5 Actions

例4. 作成が 89(kusu) でステータスが '終了'でないチケットの(project,subject,author,assigned_to,status)を表示
表記	{{ref_issues(-f:author_id = 89, -f:status ! 終了（Closed）, project, subject, author, assigned_to, status)}}
結果	# Project Subject Author Assignee Status 1514 Work Time CKEditorプラグイン利用時にMemoの整形が機能しない Tomohisa Kusukawa Tomohisa Kusukawa 解決（Resolved） Actions 1513 Work Time エンターキーでSubmitしないようにしたい Tomohisa Kusukawa Tomohisa Kusukawa 解決（Resolved） Actions 1512 Wiki Lists 日本語の説明Wikiでエラー Tomohisa Kusukawa Tomohisa Kusukawa 解決（Resolved） Actions 1444 Wiki Lists SampleY Tomohisa Kusukawa 解決（Resolved） Actions 1430 Work Time 今更ですが埋め込みStyleの見直し Tomohisa Kusukawa Tomohisa Kusukawa 新規（New） Actions 1427 Work Time 開始日が入っていない期限切れ担当チケットを表示するようにしたい Tomohisa Kusukawa Tomohisa Kusukawa 新規（New） Actions 1389 Wiki Lists Sample Tomohisa Kusukawa Tomohisa Kusukawa 解決（Resolved） Actions 1374 Work Time 工数付け替えのAjaxの高速化 Tomohisa Kusukawa Tomohisa Kusukawa 新規（New） Actions 1346 Work Time anchor not work correct on Firefox Tomohisa Kusukawa Tomohisa Kusukawa 担当（Assigned） Actions

例5. プロジェクトをWiki Listsに限定し、トラッカー名がSupport(3)かQuestion(6)のチケット一覧を表示
表記	{{ref_issues(-f:project = Wiki Lists, -f:tracker = Support | Question)}}
結果	# Project Tracker Status Priority Subject Assignee Updated Target version % Done 1436 Wiki Lists Question 終了（Closed） 通常（Normal） How to specify current project but not to specify id or name. Toru Takahashi 10/10/2016 12:27 PM Actions 1432 Wiki Lists Support 新規（New） 通常（Normal） How can I use the plugin to sort the issues by some attribute? Steven Wong 09/23/2016 03:31 PM Actions 1431 Wiki Lists Support 終了（Closed） 通常（Normal） How can I use the plugin when I need to picked out the bug and new feature Steven Wong 10/10/2016 12:32 PM Actions 1399 Wiki Lists Question 終了（Closed） 通常（Normal） Option to bring only the number of lines Adriano Ceccarelli 03/22/2016 02:34 AM 0.0.7 Actions 1371 Wiki Lists Question 終了（Closed） 通常（Normal） IDを調べる良い方法はありますか？ Tatsuya Hisaki 05/20/2015 10:44 PM Actions 1370 Wiki Lists Question 終了（Closed） 通常（Normal） assigned_to_id が 「なし」のチケット一覧を表示するにはどうしたら良い？ Tatsuya Hisaki 07/21/2015 11:09 AM Actions 1358 Wiki Lists Question 終了（Closed） 通常（Normal） It shows error when I use "fixed_version_id" ? Tomohisa Kusukawa 04/19/2015 09:33 PM 0.0.5 Actions

例6. 題名が「Sample」のチケットへのリンクをチケットIDで表示
表記	{{ref_issues(-f:subject = Sample, -l=id)}}
結果	1389

例7. 題名が「Sample」のチケットの説明の内容を表示
表記	{{ref_issues(-f:subject = Sample, -t=description)}}
結果	This is the issue[#1389]'s description that explain 'ref_issues' wiki macro example.¶ refer issue's field value notation {{ref_issues(-f:issue_id = 1389, -t = cf_2 )}} results SampleY use field value for filter condition notation {{ref_issues(-f:subject = [cf_2])}} results # Project Tracker Status Priority Subject Assignee Updated Target version % Done 1444 Wiki Lists Feature 解決（Resolved） 通常（Normal） SampleY 12/07/2016 07:36 AM Actions

例8. 題名に「sorting」を含むチケットの数を表示
表記	{{ref_issues(-f:subject ~ sorting, -c)}}
結果	3

例9-1. チケット番号でフィルタ (次の範囲内)
表記	{{ref_issues(-f:issue_id >< 1389|1391)}}
結果	# Project Tracker Status Priority Subject Assignee Updated Target version % Done 1391 Wiki Lists Defect 終了（Closed） 急いで（Urgent） Error Ismael Morales 12/05/2016 11:38 PM Actions 1390 r-labs Defect 新規（New） 通常（Normal） Testlink Plugin Issue 09/03/2015 05:34 PM Actions 1389 Wiki Lists Feature 解決（Resolved） 通常（Normal） Sample Tomohisa Kusukawa 01/08/2017 02:30 AM Actions

例9-2. チケット番号でフィルタ (OR)
表記	{{ref_issues(-f:issue_id == 1389|1391)}}
結果	# Project Tracker Status Priority Subject Assignee Updated Target version % Done 1391 Wiki Lists Defect 終了（Closed） 急いで（Urgent） Error Ismael Morales 12/05/2016 11:38 PM Actions 1389 Wiki Lists Feature 解決（Resolved） 通常（Normal） Sample Tomohisa Kusukawa 01/08/2017 02:30 AM Actions

例10. 検索結果が0件の場合に表を表示しない
表記	{{ref_issues(-0,-f:subject = Sample2)}}
結果

例11. 名称指定のOR検索
表記	{{ref_issues(-f:category == sample|error, subject, category)}}
結果	# Subject Category 1516 Fixed version-name of ticket/issue can not be shown with -t or -l option error Actions 1391 Error error Actions 1389 Sample sample Actions

例12. ユーザkusuが2017-05-01から昨日までに作成または更新したチケットを検索
表記	{{ref_issues(-f:treated kusu 2017-05-01|[1days_ago])}}
結果	# Project Tracker Status Priority Subject Assignee Updated Target version % Done 1514 Work Time Defect 解決（Resolved） 通常（Normal） CKEditorプラグイン利用時にMemoの整形が機能しない Tomohisa Kusukawa 12/12/2021 06:10 PM Actions 1513 Work Time Feature 解決（Resolved） 通常（Normal） エンターキーでSubmitしないようにしたい Tomohisa Kusukawa 12/26/2021 04:50 PM Actions 1512 Wiki Lists Defect 解決（Resolved） 通常（Normal） 日本語の説明Wikiでエラー Tomohisa Kusukawa 04/18/2021 12:00 PM 0.0.11 Actions 1511 Wiki Lists Defect 終了（Closed） 通常（Normal） Ruby2.7でエラーになる Tomohisa Kusukawa 04/18/2021 08:33 AM 0.0.10 Actions 1507 Work Time Defect 解決（Resolved） 高め（High） Work Time cannot be saved with Redmine-trunk(r19944) Tomohisa Kusukawa 11/03/2020 11:05 AM Work Time - 0.4.1 Actions 1504 Work Time Defect 新規（New） 通常（Normal） 日毎工数入力時、工数の書き込みに失敗しても、メモは追記される Tomohisa Kusukawa 08/05/2020 09:10 AM Work Time - 0.4.0 Actions 1502 Work Time Defect 終了（Closed） 通常（Normal） redmine work time plugin fails Tomohisa Kusukawa 10/04/2020 05:24 PM Work Time - 0.4.1 Actions 1501 r-labs Defect 終了（Closed） 通常（Normal） redmine work time plugin fails 06/23/2019 06:19 PM Actions 1499 Work Time Support 終了（Closed） 通常（Normal） support Redmine4.0 (Rails5) Tomohisa Kusukawa 10/04/2020 05:25 PM Work Time - 0.4.0 Actions 1497 Wiki Lists Feature 終了（Closed） 通常（Normal） filter by enum value of custom field: key value list Tomohisa Kusukawa 04/18/2021 08:35 AM 0.0.10 Actions 1482 Wiki Lists Feature 終了（Closed） 通常（Normal） want to use field reference of Issue in History part Tomohisa Kusukawa 04/18/2021 08:34 AM 0.0.10 Actions 1477 Work Time Question 新規（New） 通常（Normal） チケットに関連づいてない作業時間の集計について 07/27/2017 12:28 AM Actions 1476 Wiki Lists Defect 終了（Closed） 高め（High） Mysql2::Error: Not unique table/alias: 'users' Tomohisa Kusukawa 11/24/2023 07:06 AM 0.0.9 Actions 1447 Wiki Lists Feature 終了（Closed） 通常（Normal） recognize login name by filter attribute 'treated' Tomohisa Kusukawa 07/29/2017 09:51 AM 0.0.8 Actions 1446 Wiki Lists Feature 終了（Closed） 通常（Normal） add [current_project_id] for value field Tomohisa Kusukawa 07/29/2017 09:51 AM 0.0.8 Actions 1428 Work Time Feature 終了（Closed） 通常（Normal） CKEditorプラグイン利用時にmemoが正しく読み書きできるようにしたい Tomohisa Kusukawa 08/27/2016 11:15 PM Work Time - 0.3.3 Actions 872 Work Time Defect 終了（Closed） 通常（Normal） 権限設定の項目順序変更 Tomohisa Kusukawa 11/26/2023 05:35 PM Work Time - 0.1.5 Actions

変更履歴¶

→ ロードマップ