プロジェクト

全般

プロフィール

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

Tomohisa Kusukawa, 2017/07/29 10:45

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 29 Tomohisa Kusukawa
h1. <使い方>チケットリストの表示: ref_issues
29 1 Tomohisa Kusukawa
30
wikiやチケットの説明/注記の中にチケットの一覧を表示します。
31 19 Tomohisa Kusukawa
32 29 Tomohisa Kusukawa
h2. 書式: {{@ref_issues([option].., [column]..)@}}
33 8 Tomohisa Kusukawa
34 29 Tomohisa Kusukawa
h3. options 
35 8 Tomohisa Kusukawa
36 29 Tomohisa Kusukawa
以下のオプションを指定できます。
37
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 28 Tomohisa Kusukawa
  ※ 「=」等の両側にスペースが必要です。
66
  シングルクオートやダブルクオートは使えません。(今のところ端がスペースの文字をVALUEにできません)
67 19 Tomohisa Kusukawa
 
68
  [ATTRIBUTE]
69
<pre>
70 25 Tomohisa Kusukawa
issue_id,tracker_id,project_id,subject,description, 
71 12 Tomohisa Kusukawa
due_date,category_id,status_id,assigned_to_id,priority_id, 
72 1 Tomohisa Kusukawa
fixed_version_id,author_id,lock_version,created_on,updated_on, 
73
start_date,done_ratio,estimated_hours,parent_id,root_id, 
74 23 Tomohisa Kusukawa
lft,rgt,is_private,closed_on,
75 1 Tomohisa Kusukawa
cf_*,
76 25 Tomohisa Kusukawa
tracker,category,status,assigned_to,version,project,
77
treated,
78 19 Tomohisa Kusukawa
</pre>
79 28 Tomohisa Kusukawa
※ カスタムフィールド(cf_1等)を使う場合は-pでプロジェクトを限定するか、-iや-qでカスタムクエリを指定する必要があります。
80
 
81 19 Tomohisa Kusukawa
  [OPERATOR]
82
<pre>
83
=:等しい, !:等しくない, o:未完了, c:完了, !*:なし, 
84
*:すべて, >=:以上, <=:以下, ><:次の範囲内, 
85
>t+:今日から○日後以降, >w:今週, lw:先週, 
86
l2w:直近2週間, m:今月, lm:先月, 
87 1 Tomohisa Kusukawa
y:今年, >t-:今日より○日前以降, 
88
~:含む, !~:含まない, =p:次のプロジェクト内のチケット, 
89 19 Tomohisa Kusukawa
=!p:次のプロジェクト外のチケット, !p:次のプロジェクト内のチケットを除く
90
</pre>
91 29 Tomohisa Kusukawa
 
92 19 Tomohisa Kusukawa
絞り込み条件を複数記述した場合はAND条件となります。
93 29 Tomohisa Kusukawa
 
94
チケットでこのマクロを利用する場合、[](角括弧)内に下記 *column* を書くことで当該チケットの属性をVALUEとして参照利用できます。
95
→ [<column>]以外にも [id],[current_project_id],[current_user],[current_user_id],[<数字>days_ago] が利用できます。
96 1 Tomohisa Kusukawa
97
* -l[=column]
98 19 Tomohisa Kusukawa
  チケットの検索結果を表にせずにリンク付きテキストとして表示します。
99 1 Tomohisa Kusukawa
  カラムを指定することで題名以外のチケット属性を表示することができます。
100 19 Tomohisa Kusukawa
101 1 Tomohisa Kusukawa
* -t[=column]
102
  チケットの検索結果を表にせずに表示します。
103 19 Tomohisa Kusukawa
  マクロ等は再帰的に解釈されます。
104
105
* -c
106
  抽出されたチケットの数を表示します。
107
108 29 Tomohisa Kusukawa
h3. column
109 1 Tomohisa Kusukawa
110 29 Tomohisa Kusukawa
表示する列を指定します。省略した場合はカスタムクエリで指定した列が表示されます。
111
112 18 Tomohisa Kusukawa
* project : プロジェクト
113 1 Tomohisa Kusukawa
* tracker : トラッカー
114
* parent : 親チケット
115
* status : ステータス
116
* priority : 優先度
117
* subject : 題名
118
* author : 作成者
119 18 Tomohisa Kusukawa
* assigned_to : 担当者
120
* updated_on : 更新日時
121
* category : カテゴリ
122 1 Tomohisa Kusukawa
* fixed_version : 対象バージョン
123 6 Tomohisa Kusukawa
* start_date : 開始日
124 10 Tomohisa Kusukawa
* due_date : 期日
125 1 Tomohisa Kusukawa
* estimated_hours : 予定工数
126 11 Tomohisa Kusukawa
* done_ratio : 進捗%
127
* created_on : 作成日時
128
* closed_on : 終了日時
129 1 Tomohisa Kusukawa
* relations : 関連チケット
130
* cf_* : カスタムフィールド(*はID番号)
131 11 Tomohisa Kusukawa
132
h3. 例
133
134 19 Tomohisa Kusukawa
|\2. *例1. カスタムクエリをIDで指定して表示*|
135
|表記|{{@ref_issues(-i=9)@}}|
136
|結果|{{ref_issues(-i=9)}}|
137 11 Tomohisa Kusukawa
138
139 19 Tomohisa Kusukawa
|\2. *例2. カスタムクエリを名前で指定して表示*|
140
|表記|{{@ref_issues(-q=MyCustomQuery1)@}}|
141
|結果|{{ref_issues(-q=MyCustomQuery1)}}|
142 11 Tomohisa Kusukawa
143
144 19 Tomohisa Kusukawa
|\2. *例3. 題名に「sorting」を含むチケットの一覧を表示*|
145
|表記|{{@ref_issues(-f:subject ~ sorting)@}}|
146
|結果|{{ref_issues(-f:subject ~ sorting)}}|
147 1 Tomohisa Kusukawa
148 11 Tomohisa Kusukawa
149 30 Tomohisa Kusukawa
|\2. *例4. 作成が 89(kusu) でステータスが '終了'でないチケットの(project,subject,author,assigned_to,status)を表示*|
150
|表記|{{@ref_issues(-f:author_id = 89, -f:status ! 終了(Closed), project, subject, author, assigned_to, status)@}}|
151
|結果|{{ref_issues(-f:author_id = 89, -f:status ! 終了(Closed), project, subject, author, assigned_to, status)}}|
152 1 Tomohisa Kusukawa
153 11 Tomohisa Kusukawa
154 21 Tomohisa Kusukawa
|\2. *例5. プロジェクトをWiki Listsに限定し、トラッカーIDが3(Support)か6(Question)のチケット一覧を表示*|
155
|表記|{<notextile>{ref_issues(-f:project = Wiki Lists, -f:tracker_id = 3 | 6)}</notextile>}|
156
|結果|{{ref_issues(-f:project = Wiki Lists, -f:tracker_id = 3 | 6)}}|
157 11 Tomohisa Kusukawa
158
159 19 Tomohisa Kusukawa
|\2. *例6. 題名が「Sample」のチケットへのリンクをチケットIDで表示*|
160
|表記|{{@ref_issues(-f:subject = Sample, -l=id)@}}|
161 8 Tomohisa Kusukawa
|結果|{{ref_issues(-f:subject = Sample, -l=id)}}|
162
163 19 Tomohisa Kusukawa
164
|\2. *例7. 題名が「Sample」のチケットの説明の内容を表示*|
165
|表記|{{@ref_issues(-f:subject = Sample, -t=description)@}}|
166 8 Tomohisa Kusukawa
|結果|{{ref_issues(-f:subject = Sample, -t=description)}}|
167 12 Tomohisa Kusukawa
168 19 Tomohisa Kusukawa
169 1 Tomohisa Kusukawa
|\2. *例8. 題名に「sorting」を含むチケットの数を表示*|
170
|表記|{{@ref_issues(-f:subject ~ sorting, -c)@}}|
171 23 Tomohisa Kusukawa
|結果|{{ref_issues(-f:subject ~ sorting, -c)}}|
172
173 1 Tomohisa Kusukawa
|\2. *例9. チケット番号でフィルタ*|
174
|表記|{<notextile>{ref_issues(-f:issue_id >< 1389|1390)}</notextile>}|
175 23 Tomohisa Kusukawa
|結果|{{ref_issues(-f:issue_id >< 1389|1390)}}|
176
177
|\2. *例10. 検索結果が0件の場合に表を表示しない*|
178 27 Tomohisa Kusukawa
|表記|{<notextile>{ref_issues(-0,-f:subject = Sample2)}</notextile>}|
179 23 Tomohisa Kusukawa
|結果|{{ref_issues(-0,-f:subject = Sample2)}}|
180
181
|\2. *例11. 名称指定のOR検索*|
182 27 Tomohisa Kusukawa
|表記|{<notextile>{ref_issues(-f:category = sample|error, subject, category)}</notextile>}|
183 24 Tomohisa Kusukawa
|結果|{{ref_issues(-f:category = sample|error, subject, category)}}|
184
185 29 Tomohisa Kusukawa
|\2. *例12. ユーザkusuが2017-05-01から昨日までに作成または更新したチケットを検索*|
186
|表記|{<notextile>{ref_issues(-f:treated kusu 2017-05-01|[1days_ago])}</notextile>}|
187
|結果|{{ref_issues(-f:treated kusu 2017-05-01|[1days_ago])}}|
188 1 Tomohisa Kusukawa
189
190
h2. 変更履歴
191
192
→ "ロードマップ":/projects/wiki_lists/roadmap?completed=1