r-labs » Wiki Lists

h1. Redmine Plugin: Wiki Lists 

{{>toc}}

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

This plugin adds wiki macros that display ticket lists.

h2. Downloads

bitbucket: https://bitbucket.org/kusu/redmine_wiki_lists/downloads

h2. Installation

# Download zip file from "bitbucket":https://bitbucket.org/kusu/redmine_wiki_lists/downloads

# Unzip

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

# Restart REDMINE

h1. Usage

h2. ref_issues

ref_issues macro displays list of issues.

h3. Syntax

{{@ref_issues([options].., [column]..)@}}

*options:* 

* -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.

* -f:ATTRIBUTE[=WORD[|WORD...]]

  Additional filter. Attributes are shown below.

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

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

WORDs is one or more search words divided by '|', and multiple words affect OR condition.

If you specify no select condition, page name of wiki or number of issue is used for search word.

*columns:* 

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

h3. example

|\2. *1. list up tickets that contain 'sorting' in subject*|

|notation|{{@ref_issues(-s=sorting)@}}|

|results|{{ref_issues(-s=sorting)}}|

|\2. *2. list up tickets that contain 'sorting' in subject. and specify display column(subject,author,assigned_to,status)*|

|notation|{{@ref_issues(-s=sorting,subject,author, assigned_to, status)@}}|

|results|{{ref_issues(-s=sorting,subject,author, assigned_to, status)}}|

|\2. *3. list up tickets that contain 'sorting' in subject, and restrict by project=wiki_lists*|

|notation|{{@ref_issues(-p=wiki_lists,-s=sorting)@}}|

|results|{{ref_issues(-p=wiki_lists,-s=sorting)}}|

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

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

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

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

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

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

|\2. *6. use custom query and restrict by usr_id=89*|

|notation|{{@ref_issues(-i=9,-f:assigned_to_id=89)@}}|

|results|{{ref_issues(-i=9,-f:assigned_to_id=89)}}|

|\2. *7. display linked string that is results of custom query*|

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

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

|\2. *8. display linked string(=ticket id) that is results of custom query*|

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

|results|{{ref_issues(-i=9,-l=id)}}|