r-labs » Wiki Lists

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

{{>toc}}

日本語は [[Wiki Lists|こちら]].

This plugin adds wiki macros that display ticket lists.

h2. Links

redmine.org: http://www.redmine.org/plugins/redmine_wiki_lists

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

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

h2. Installation

# Download zip file from "GitHub":https://github.com/tkusukawa/redmine_wiki_lists/releases

# Unzip

# Move the unziped folder into the $REDMINE/plugins/

# Restart REDMINE

h1. <Usage> ref_issues

ref_issues macro displays list of issues.

h2. Syntax {{@ref_issues([option].., [column]..)@}}

h3. option

superseded {{collapse

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

  select issues that contain WORDs in subject. 

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

  select issues that contain WORDs in description. 

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

  select issues that contain WORDs in subject or description.

* -p[=IDENTIFIRE]

  Specify the project by identifire.

}}

* -i=CUSTOM_QUERY_ID

  Use custom query by id.

* -q=CUSTOM_QUERY_NAME

  Use custom query by query name.

* -0 

  Do not display the table If query result is 0.

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

  filter. Attributes are shown below.

  e.x. {<notextile>{ref_issues(-f:tracker_id = 3)}</notextile>} 

  [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, author

</pre>

  [OPERATOR]

<pre>

=:is, !:is not, o:open, c:closed, !*:none,

*:any, >=:>=, <=:<=, ><:between, >t+:in more than, 

>w:this week, lw:last week, l2w:last 2 weeks, m:this month, lm:last month,

y:this year, >t-:less than days ago, ~:contains, !~:doesn't contain, 

=p:any issues in project, =!p:any issues not in project, !p:no issues in project, 

</pre>

You can specify two or more select option, it affect AND condition.

If you use this macro in a Issue, you can use the field value of the issue as VALUE by writing to the following field(column) name in the [] (brackets).

-> Besides [<column>], You can use [id], [current_project_id], [current_user], [current_user_id], [<number> days_ago] .

* -l[=column]

  Put linked text.

* -t[=column]

  Put markup text.

* -c

  number of issues.

h3. column

You can choose columns that you want to display.

If you do not specify the columns, same columns with customquery are displayed.

* 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

h2. example

|\2. *1. use custom query by ID*|

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

|results|{{ref_issues(-i=9)}}|

|\2. *2. use custom query by name*|

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

|results|{{ref_issues(-q=MyCustomQuery1)}}|

|\2. *3. list up issues that contain 'sorting' in subject*|

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

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

|\2. *4. list up issues that author_id is 89(kusu) and status is not 'closed'. specify display column(project,subject,author,assigned_to,status)*|

|notation|{{@ref_issues(-f:author_id = 89, -f:status ! 終了（Closed）, project, subject, author, assigned_to, status)@}}|

|results|{{ref_issues(-f:author_id = 89, -f:status ! 終了（Closed）, project, subject, author, assigned_to, status)}}|

|\2. *5. list up tickets that tracker is Support(3) or Question(6), and restrict by project=Wiki Lists*|

|notation|{<notextile>{ref_issues(-f:tracker == Question | Support, -f:project = Wiki Lists)}</notextile>}|

|results|{{ref_issues(-f:tracker == Question | Support, -f:project = Wiki Lists)}}|

|\2. *6. pickup issues that have subject=Sample, and put linked ID*|

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

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

|\2. *7. pickup issues that have subject=Sample, and put markuped description*|

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

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

|\2. *8. put number of issues that contain 'sorting' in subject*|

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

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

|\2. *9-1. filter by issue_id (between)*| 

|notation|{<notextile>{ref_issues(-f:issue_id >< 1389|1391)}</notextile>}| 

|results|{{ref_issues(-f:issue_id >< 1389|1391)}}| 

|\2. *9-2. filter by issue_id (or)*| 

|notation|{<notextile>{ref_issues(-f:issue_id == 1389|1391)}</notextile>}| 

|results|{{ref_issues(-f:issue_id == 1389|1391)}}| 

|\2. *10. Do not display the table If query result is 0.*| 

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

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

|\2. *11. OR condition by name*| 

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

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

|\2. *12. created or updated by user kusu from 2017-05-01 to yesterday*| 

|notation|{<notextile>{ref_issues(-f:treated kusu 2017-05-01|[1days_ago])}</notextile>} |

|results|{{ref_issues(-f:treated kusu 2017-05-01|[1days_ago])}}|

h2. history

→ "Roadmap":/projects/wiki_lists/roadmap?completed=1