About en » 履歴 » バージョン 27
Akiko Takano, 2013/01/31 00:45
1 | 10 | Akiko Takano | {{>toc}} |
---|---|---|---|
2 | |||
3 | 1 | Akiko Takano | h1. Issue Template plugin |
4 | |||
5 | 2 | Akiko Takano | This is a plugin to generate and use issue templates, and its objective is to *support user's issue creation work*. |
6 | 1 | Akiko Takano | |
7 | 2 | Akiko Takano | h2. Download |
8 | |||
9 | 21 | Akiko Takano | * "bitbucket":https://bitbucket.org/akiko_pusu/redmine_issue_templates/ |
10 | 24 | Akiko Takano | ** "bitbucket":https://bitbucket.org/akiko_pusu/redmine_issue_templates/downloads (zip) |
11 | 2 | Akiko Takano | |
12 | 1 | Akiko Takano | h2. Features |
13 | 2 | Akiko Takano | |
14 | * It works as project module. |
||
15 | * Member who has "Manage Template" right can create issue templates *based on trackers*. |
||
16 | ** Also add help message for templates, because the way to use templates may be different between projects. |
||
17 | * Member who has "Use Template" right can see the template and use them when creating new issue. |
||
18 | 1 | Akiko Takano | |
19 | h2. Plugin installation |
||
20 | 3 | Akiko Takano | |
21 | # Copy the plugin into the vendor/plugins directory |
||
22 | # Migrate plugin: rake db:migrate_plugins RAILS_ENV=production |
||
23 | # Start Redmine |
||
24 | # Enable the module on the project setting page. |
||
25 | 1 | Akiko Takano | |
26 | 5 | Akiko Takano | h2. Permission Settings |
27 | 1 | Akiko Takano | |
28 | 4 | Akiko Takano | Now this plugin works as project module, and three permissions are defined. |
29 | |||
30 | # Show template |
||
31 | # Edit template |
||
32 | ** Right to create/edit templates. |
||
33 | # Manage template |
||
34 | ** Right to add help message for templates, such as usage of templates. |
||
35 | |||
36 | (!) Note: These templates are available only for its project. |
||
37 | 7 | Akiko Takano | (!) Note: Only Redmine administrator can set ermissions for issue templates. |
38 | |||
39 | |||
40 | 16 | Akiko Takano | > !permission.png! |
41 | 4 | Akiko Takano | |
42 | |||
43 | 11 | Akiko Takano | h2. Usage & Screen shots |
44 | 5 | Akiko Takano | |
45 | h3. Use templates |
||
46 | |||
47 | 6 | Akiko Takano | User who has "show templates" permission can use templates when creating issue. |
48 | 16 | Akiko Takano | First, enable, selectable templates related with the tracker are shown as pulldown menu. |
49 | 6 | Akiko Takano | |
50 | 16 | Akiko Takano | Select template from pulldown, ajax request is posted and template body is loaded into issue description field. |
51 | |||
52 | 6 | Akiko Takano | |
53 | 16 | Akiko Takano | > !use_template1.png! |
54 | |||
55 | 5 | Akiko Takano | h3. Create/Edit templates |
56 | 12 | Akiko Takano | |
57 | 1 | Akiko Takano | To access create / edit templates menu, click "Issues" or "New Issue" project tab, and you can see the menu at the sidebar. |
58 | |||
59 | 13 | Akiko Takano | Click "Add template" and the form for creating template will be shown. |
60 | |||
61 | 17 | Akiko Takano | 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. |
62 | |||
63 | 16 | Akiko Takano | > !gotomenu.png! |
64 | 13 | Akiko Takano | |
65 | 16 | Akiko Takano | > !add-template.png! |
66 | 12 | Akiko Takano | |
67 | (!) Note: This is not shown without "show templates" permission. |
||
68 | 5 | Akiko Takano | |
69 | 14 | Akiko Takano | h3. Manage project templates |
70 | 1 | Akiko Takano | |
71 | 14 | Akiko Takano | Now this is optional setting. |
72 | Who has manage template permission can set custom help message for template usage on his/her project. |
||
73 | 1 | Akiko Takano | |
74 | 14 | Akiko Takano | This help message will be shown on the "New Issue" page, beside template pulldown. |
75 | |||
76 | 16 | Akiko Takano | > !manage-template.png! |
77 | 15 | Akiko Takano | |
78 | Here is a screenshot of custome template help message. |
||
79 | |||
80 | 16 | Akiko Takano | > !template-help.png! |
81 | 18 | Akiko Takano | |
82 | 25 | Akiko Takano | h3. Change Template order |
83 | 18 | Akiko Takano | |
84 | 25 | Akiko Takano | In case a tracker has some related templates, you can reorder template on index page. |
85 | 19 | Akiko Takano | |
86 | 25 | Akiko Takano | h3. Default template setting |
87 | |||
88 | If a template marked as default, template text will be loaded when tracker is changed on creating issue page. |
||
89 | |||
90 | 26 | Akiko Takano | For example, *Bug* tracker has 3 templates and "Bug3 default" template is marked as default. |
91 | |||
92 | 25 | Akiko Takano | !template-list.png! |
93 | 26 | Akiko Takano | |
94 | At the new issue page, when user selects Bug tracker, soon default template text is appended to description field. |
||
95 | |||
96 | 25 | Akiko Takano | !load-default-template.png! |
97 | |||
98 | 19 | Akiko Takano | h2. Future plannning / Feedback |
99 | 20 | Akiko Takano | |
100 | 18 | Akiko Takano | h3. Plannning |
101 | |||
102 | * Use global templates. |
||
103 | 27 | Akiko Takano | |
104 | 18 | Akiko Takano | |
105 | h3. Feedback |
||
106 | |||
107 | 1 | Akiko Takano | * Feedback would be appreciated. You can send from issue tracker on bitbucket or tracker on this project. |
108 | 25 | Akiko Takano | * Translations, ui idea, css are also appreciated. |