r-labs » Issue Template

h1. Issue Template plugin

Please note: This documentation was closed. Please see: [[https://github.com/akiko-pusu/redmine_issue_templates/wiki]].

{{toc}}

This is a plugin to generate and use issue templates, and its objective is to *support user's issue creation work*. 

h2. Information page on Redmine.org

* http://www.redmine.org/plugins/issue_templates

h3. Demo site

Demo site: https://redmine-akiko.ruby.iijgio.com/ (For maintenance reason, this site may down irregularly.)

h2. Download

* "Github":https://github.com/akiko-pusu/redmine_issue_templates (https://github.com/akiko-pusu/redmine_issue_templates)

* Build Status !https://drone.io/github.com/akiko-pusu/redmine_issue_templates/status.png! (drone.io)

** https://drone.io/github.com/akiko-pusu/redmine_issue_templates

h2. Features

* Since 0.0.8, supported global issue templates.

** Now only Administrator can associated global templates with each project.

* It works as project module.

* Member who has "Manage Template" right can create issue templates *based on trackers*.

** Also add help message for templates, because the way to use templates may be different between projects.

* Member who has "Use Template" right can see the template and use them when creating new issue.

* Child project can use inherited templates from parent project. (Since ver 0.0.6)

h2. Plugin installation

# Copy the plugin into the vendor/plugins directory

# Migrate plugin: rake redmine:plugins:migrate RAILS_ENV=production

# Start Redmine

# Enable the module on the project setting page.

h2. Uninstall plugin

h3. Run rake task

** rake redmine:plugins:migrate NAME=redmine_issue_templates VERSION=0

Above rake task will remove the related records to redmine_issue_templates from schema_migration table.

In additon to this, issue_templates and issue_template_settings tables will be also removed.

h3. Manual uninstall

In some situation, rake task to uninstall may be failed. To uninstall plugin manually, please remove these records and tables from your database.

* Remove records from schema_migration table related to issue_templates.

** DELETE FROM schema_migrations WHERE version LIKE '%redmine_issue_templates';

* Drop issue_templates and issue_template settiongs.

** DROP TABLE issue_templates; DROP TABLE issue_template_settings; DROP TABLE global_issue_templates;

h2. Permission Settings (as Redmine Admin)

Now this plugin works as project module, and three permissions are defined.

# Show template

# Edit template

** Right to create/edit templates.

# Manage template

** Right to add help message for templates, such as usage of templates.

(!) Note: These templates are available only for its project.

(!) Note: Only Redmine administrator can set ermissions for issue templates.

> !permission.png!

h2. Enabled Issue Templates as Project Module

Now this plugin works as project module.

So, project manager needs to check this plugin at project module settings page for activation.

!set-as-project-module.png!

h2. Usage & Screen shots

h3. Use templates

User who has "show templates" permission can use templates when creating issue.

First, enable, selectable templates related with the tracker are shown as pulldown menu.

Select template from pulldown, ajax request is posted and template body is loaded into issue description field.

> !use_template1.png!

NOTE: Since templates are associated with a tracker, that template pulldown menu i changed if the tracker is changed at  then new issue page. And if selected tracker has no associated templates, issue template pulldown is blank. ( only "---" text is shown.) 

> !template-pulldown-is-blank.png!

h3. Create/Edit templates

To access create / edit templates menu, click "Issues" or "New Issue" project tab, and you can see the menu at the sidebar.

Click "Add template" and the form for creating template will be shown.

And each template is related to some tracker, so that if you change tracker of new issue, template pulldown is also reloaded and updated related to the tracker. 

> !gotomenu.png!

> !add-template.png!

(!) Note: This is not shown without "show templates" permission.

h3. Manage project templates

Now this is optional setting.

Who has manage template permission can set custom help message for template usage on his/her project.

This help message will be shown on the "New Issue" page, beside template pulldown.

> !manage-template.png!

Here is a screenshot of custome template help message.

> !template-help.png!

h3. Change Template order

In case a tracker has some related templates, you can reorder template on index page.

h3. Default template setting

If a template marked as default, template text will be loaded when tracker is changed on creating issue page.

For example, *Bug* tracker has 3 templates and "Bug3 default" template is marked as default.  

!template-list.png!

At the new issue page, when user selects Bug tracker, soon default template text is appended to description field.

!load-default-template.png!

h3. Global template setting

Administrator can make global templates from Admiistration menu, and associate global templates with each project.

!global-template.png!

h4. Known restrictions

* Global templates can not be associated with each project from project settings tab. (Now only Administrator do this work)

* Global template is not defined as a default template.

h2. Future plannning / Feedback

h3. Known issue

* Template loads every time Status is changed. This problem is fixed if you use Redmine 3.2 or higher and Issue Template v0.1.2.

** https://bitbucket.org/akiko_pusu/redmine_issue_templates/issue/36

** Only happned in case using default template.

h3. Plannning

* Template for note/journal. (Optional)

* Custom fields support. (Maybe this is implemented another way, such as copy from base issue) 

h3. Feedback

* Feedback would be appreciated. You can send from issue tracker on bitbucket or tracker on this project.

* Translations, ui idea, css are also appreciated.