プロジェクト

全般

プロフィール

Wiki Lists » 履歴 » バージョン 26

Tomohisa Kusukawa, 2016/12/09 06:58

1 15 Tomohisa Kusukawa
h1. Redmine Plugin: Wiki Lists {{count}}
2 1 Tomohisa Kusukawa
3 15 Tomohisa Kusukawa
{{>toc}}
4 1 Tomohisa Kusukawa
5
English page is [[Wiki Lists en|here]].
6
7 12 Tomohisa Kusukawa
Redmineのwikiやチケットにチケット一覧を表示するマクロプラグインです。
8 1 Tomohisa Kusukawa
9 19 Tomohisa Kusukawa
h2. リンク
10 1 Tomohisa Kusukawa
11 19 Tomohisa Kusukawa
Redmine本家: http://www.redmine.org/plugins/redmine_wiki_lists
12 20 Tomohisa Kusukawa
リポジトリ: https://github.com/tkusukawa/redmine_wiki_lists/
13
ダウンロード: https://github.com/tkusukawa/redmine_wiki_lists/releases
14 1 Tomohisa Kusukawa
15
h2. インストール
16
17 20 Tomohisa Kusukawa
https://github.com/tkusukawa/redmine_wiki_lists/releases
18 2 Tomohisa Kusukawa
から最新のzipファイルをダウンロードし
19 12 Tomohisa Kusukawa
$REDMINE/plugins/
20 2 Tomohisa Kusukawa
に展開します。
21
<pre>
22 12 Tomohisa Kusukawa
$ cd $REDMINE/plugins
23 2 Tomohisa Kusukawa
$ unzip wiki_lists-~.zip
24 11 Tomohisa Kusukawa
</pre>
25 1 Tomohisa Kusukawa
26
これでRedmineを起動すると下記のマクロが使えるようになります。
27 7 Tomohisa Kusukawa
28 1 Tomohisa Kusukawa
h1. 使い方
29
30 19 Tomohisa Kusukawa
h2. チケットリストの表示: ref_issues
31 1 Tomohisa Kusukawa
32 19 Tomohisa Kusukawa
wikiやチケットの説明/注記の中にチケットの一覧を表示します。
33 8 Tomohisa Kusukawa
34 19 Tomohisa Kusukawa
h3. 書式: {{@ref_issues([option].., [column]..)@}}
35 8 Tomohisa Kusukawa
36
*options:* 以下のオプションを指定できます。
37 1 Tomohisa Kusukawa
38 19 Tomohisa Kusukawa
古いオプション {{collapse
39
|* -s[=WORD[|WORD...]]
40 1 Tomohisa Kusukawa
  題名(subject)にワードを含むチケットを表示を表示します。
41
  ワードを省略すると記述ページの題名を検索ワードとして使用します。
42 19 Tomohisa Kusukawa
 
43
* -d[=WORD[|WORD...]]
44 1 Tomohisa Kusukawa
  説明(description)にワードを含むチケットを表示します。。
45
  ワードを省略すると記述ページの題名を検索ワードとして使用します。
46 19 Tomohisa Kusukawa
 
47
* -w[=WORD[|WORD...]]
48 1 Tomohisa Kusukawa
  題名または説明にワードを含むチケットを表示します。
49
  ワードを省略すると記述ページの題名を検索ワードとして使用します。
50
51 22 Tomohisa Kusukawa
* -p[=IDENTIFIRE]
52 1 Tomohisa Kusukawa
  表示するチケットのプロジェクトを限定します。
53 23 Tomohisa Kusukawa
}}
54 22 Tomohisa Kusukawa
55 1 Tomohisa Kusukawa
* -i=CUSTOM_QUERY_ID
56 22 Tomohisa Kusukawa
  -q=CUSTOM_QUERY_NAME
57 19 Tomohisa Kusukawa
  カスタムクエリの結果を表示します。
58 1 Tomohisa Kusukawa
59
* -0
60 26 Tomohisa Kusukawa
  結果が0件の場合に表を表示しません。
61
62
* -f:<ATTRIBUTE>␣<OPERATOR>␣<[VALUE[|VALUE...]]>
63
  指定した条件でフィルタリングした結果を表示します。
64
  例 {<notextile>{ref_issues(-f:tracker_id = 3)}</notextile>}
65 19 Tomohisa Kusukawa
 
66
  [ATTRIBUTE]
67
<pre>
68 25 Tomohisa Kusukawa
issue_id,tracker_id,project_id,subject,description, 
69 12 Tomohisa Kusukawa
due_date,category_id,status_id,assigned_to_id,priority_id, 
70 1 Tomohisa Kusukawa
fixed_version_id,author_id,lock_version,created_on,updated_on, 
71
start_date,done_ratio,estimated_hours,parent_id,root_id, 
72 23 Tomohisa Kusukawa
lft,rgt,is_private,closed_on,
73 1 Tomohisa Kusukawa
cf_*,
74 25 Tomohisa Kusukawa
tracker,category,status,assigned_to,version,project,
75
treated,
76 19 Tomohisa Kusukawa
</pre>
77
  [OPERATOR]
78
<pre>
79
=:等しい, !:等しくない, o:未完了, c:完了, !*:なし, 
80
*:すべて, >=:以上, <=:以下, ><:次の範囲内, 
81
>t+:今日から○日後以降, >w:今週, lw:先週, 
82
l2w:直近2週間, m:今月, lm:先月, 
83
y:今年, >t-:今日より○日前以降, 
84
~:含む, !~:含まない, =p:次のプロジェクト内のチケット, 
85
=!p:次のプロジェクト外のチケット, !p:次のプロジェクト内のチケットを除く
86
</pre>
87 1 Tomohisa Kusukawa
88
絞り込み条件を複数記述した場合はAND条件となります。
89 19 Tomohisa Kusukawa
チケットでこのマクロを利用する場合、[](角括弧)内に下記カラム名を書くことで当該チケットの属性をVALUEとして参照利用できます。
90 1 Tomohisa Kusukawa
91
* -l[=column]
92 19 Tomohisa Kusukawa
  チケットの検索結果を表にせずにリンク付きテキストとして表示します。
93 1 Tomohisa Kusukawa
  カラムを指定することで題名以外のチケット属性を表示することができます。
94
95 19 Tomohisa Kusukawa
* -t[=column]
96
  チケットの検索結果を表にせずに表示します。
97
  マクロ等は再帰的に解釈されます。
98
99
* -c
100
  抽出されたチケットの数を表示します。
101
102 1 Tomohisa Kusukawa
*column:* 表示する列を指定します。
103
省略した場合はカスタムクエリで指定した列が表示されます。
104
105 18 Tomohisa Kusukawa
* project : プロジェクト
106 1 Tomohisa Kusukawa
* tracker : トラッカー
107
* parent : 親チケット
108
* status : ステータス
109
* priority : 優先度
110
* subject : 題名
111
* author : 作成者
112 18 Tomohisa Kusukawa
* assigned_to : 担当者
113
* updated_on : 更新日時
114
* category : カテゴリ
115 1 Tomohisa Kusukawa
* fixed_version : 対象バージョン
116 6 Tomohisa Kusukawa
* start_date : 開始日
117 10 Tomohisa Kusukawa
* due_date : 期日
118 1 Tomohisa Kusukawa
* estimated_hours : 予定工数
119 11 Tomohisa Kusukawa
* done_ratio : 進捗%
120
* created_on : 作成日時
121
* closed_on : 終了日時
122 1 Tomohisa Kusukawa
* relations : 関連チケット
123
* cf_* : カスタムフィールド(*はID番号)
124 11 Tomohisa Kusukawa
125
h3. 例
126
127 19 Tomohisa Kusukawa
|\2. *例1. カスタムクエリをIDで指定して表示*|
128
|表記|{{@ref_issues(-i=9)@}}|
129
|結果|{{ref_issues(-i=9)}}|
130 11 Tomohisa Kusukawa
131
132 19 Tomohisa Kusukawa
|\2. *例2. カスタムクエリを名前で指定して表示*|
133
|表記|{{@ref_issues(-q=MyCustomQuery1)@}}|
134
|結果|{{ref_issues(-q=MyCustomQuery1)}}|
135 11 Tomohisa Kusukawa
136
137 19 Tomohisa Kusukawa
|\2. *例3. 題名に「sorting」を含むチケットの一覧を表示*|
138
|表記|{{@ref_issues(-f:subject ~ sorting)@}}|
139
|結果|{{ref_issues(-f:subject ~ sorting)}}|
140 1 Tomohisa Kusukawa
141 11 Tomohisa Kusukawa
142 19 Tomohisa Kusukawa
|\2. *例4. 題名に「sorting」を含むチケットを 題名、作成者、担当者、ステータスの形で表示*|
143
|表記|{{@ref_issues(-f:subject ~ sorting, subject, author, assigned_to, status)@}}|
144
|結果|{{ref_issues(-f:subject ~ sorting, subject, author, assigned_to, status)}}|
145 1 Tomohisa Kusukawa
146 11 Tomohisa Kusukawa
147 21 Tomohisa Kusukawa
|\2. *例5. プロジェクトをWiki Listsに限定し、トラッカーIDが3(Support)か6(Question)のチケット一覧を表示*|
148
|表記|{<notextile>{ref_issues(-f:project = Wiki Lists, -f:tracker_id = 3 | 6)}</notextile>}|
149
|結果|{{ref_issues(-f:project = Wiki Lists, -f:tracker_id = 3 | 6)}}|
150 11 Tomohisa Kusukawa
151
152 19 Tomohisa Kusukawa
|\2. *例6. 題名が「Sample」のチケットへのリンクをチケットIDで表示*|
153
|表記|{{@ref_issues(-f:subject = Sample, -l=id)@}}|
154
|結果|{{ref_issues(-f:subject = Sample, -l=id)}}|
155 8 Tomohisa Kusukawa
156
157 19 Tomohisa Kusukawa
|\2. *例7. 題名が「Sample」のチケットの説明の内容を表示*|
158
|表記|{{@ref_issues(-f:subject = Sample, -t=description)@}}|
159
|結果|{{ref_issues(-f:subject = Sample, -t=description)}}|
160 8 Tomohisa Kusukawa
161 12 Tomohisa Kusukawa
162 19 Tomohisa Kusukawa
|\2. *例8. 題名に「sorting」を含むチケットの数を表示*|
163 1 Tomohisa Kusukawa
|表記|{{@ref_issues(-f:subject ~ sorting, -c)@}}|
164
|結果|{{ref_issues(-f:subject ~ sorting, -c)}}|
165 23 Tomohisa Kusukawa
166
Ver 0.0.7
167
|\2. *例9. チケット番号でフィルタ*|
168
|表記|{<notextile>{ref_issues(-f:issue_id >< 1389|1390)}</notextile>}|
169
|結果|{{ref_issues(-f:issue_id >< 1389|1390)}}|
170
171
|\2. *例10. 検索結果が0件の場合に表を表示しない*|
172
|表記|{<notextile>{ref_issues(-0,-f:subject = Sample2}</notextile>}|
173
|結果|{{ref_issues(-0,-f:subject = Sample2)}}|
174
175
|\2. *例11. 名称指定のOR検索*|
176 1 Tomohisa Kusukawa
|表記|{<notextile>{ref_issues(-f:category = sample|error, subject, category}</notextile>}|
177 24 Tomohisa Kusukawa
|結果|{{ref_issues(-f:category = sample|error, subject, category)}}|
178
179 25 Tomohisa Kusukawa
|\2. *例12. ユーザkusu(id:89)が2016-10-01から2016-10-31に作成または更新したチケットを検索*|
180 24 Tomohisa Kusukawa
|表記|{<notextile>{ref_issues(-f:treated 89 2016-10-01|2016-10-31}</notextile>}|
181 23 Tomohisa Kusukawa
|結果|{{ref_issues(-f:treated 89 2016-03-01|2016-03-31)}}|
182 1 Tomohisa Kusukawa
183
184
h2. 変更履歴
185
186
→ "ロードマップ":/projects/wiki_lists/roadmap?completed=1