Skip to content
This repository has been archived by the owner on Jan 23, 2021. It is now read-only.

Home

Jump to bottom
Akiko Takano edited this page Apr 5, 2020 · 11 revisions

Issue Template plugin

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

Information page on Redmine.org

Install / Uninstall

Please see README.md.

Permission Settings (as Redmine Admin)

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

  1. Show template

  2. Edit template

    • Right to create/edit templates.

  3. 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 permissions for issue templates.

!permission.png!

Enabled Issue Templates as Project Module

Now, this plugin works as a project module. So, the project manager needs to check this plugin at the project module settings page for activation.

!set-as-project-module.png!

Usage & Screenshots

Use templates

User who has "show templates" permission can use templates when creating an issue. First, enable, selectable templates related to the tracker are shown as a pulldown menu.

Select template from pulldown, ajax request is posted and template body is loaded into the 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 the new issue page. And if the selected tracker has no associated templates, issue template pulldown is blank. ( only "---" text is shown.)

!template-pulldown-is-blank.png!

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.

Manage project templates

Now, this is optional setting. Who has manage template permission can set custom help messages 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 custom template help message.

!template-help.png!

Change Template order

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

Default template setting

If a template marked as default, template text will be loaded when the tracker is changed on creating the 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 the user selects Bug tracker, soon default template text is appended to the description field.

!load-default-template.png!

Global template setting

Administrators can make global templates from Administration menu, and associate global templates with each project.

!global-template.png!

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.
Clone this wiki locally