About en » 履歴 » バージョン 37
Akiko Takano, 2013/09/03 16:41
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 | 34 | Akiko Takano | ** "bitbucket":https://bitbucket.org/akiko_pusu/redmine_issue_templates/tags/ (You can download zip/tgz) |
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 | 28 | Akiko Takano | h2. Uninstall plugin |
27 | |||
28 | 29 | Akiko Takano | h3. Run rake task |
29 | 28 | Akiko Takano | |
30 | ** rake redmine:plugins:migrate NAME=redmine_issue_templates VERSION=0 |
||
31 | |||
32 | Above rake task will remove the related records to redmine_issue_templates from schema_migration table. |
||
33 | In additon to this, issue_templates and issue_template_settings tables will be also removed. |
||
34 | |||
35 | 29 | Akiko Takano | h3. Manual uninstall |
36 | 28 | Akiko Takano | |
37 | In some situation, rake task to uninstall may be failed. To uninstall plugin manually, please remove these records and tables from your database. |
||
38 | |||
39 | * Remove records from schema_migration table related to issue_templates. |
||
40 | ** DELETE FROM schema_migration WHERE version LIKE '%redmine_issue_templates'; |
||
41 | |||
42 | * Drop issue_templates and issue_template settiongs. |
||
43 | 30 | Akiko Takano | ** DROP TABLE issue_templates; DROP TABLE issue_template_settings; |
44 | 28 | Akiko Takano | |
45 | 31 | Akiko Takano | h2. Permission Settings (as Redmine Admin) |
46 | 1 | Akiko Takano | |
47 | 4 | Akiko Takano | Now this plugin works as project module, and three permissions are defined. |
48 | |||
49 | # Show template |
||
50 | # Edit template |
||
51 | ** Right to create/edit templates. |
||
52 | # Manage template |
||
53 | ** Right to add help message for templates, such as usage of templates. |
||
54 | |||
55 | (!) Note: These templates are available only for its project. |
||
56 | 7 | Akiko Takano | (!) Note: Only Redmine administrator can set ermissions for issue templates. |
57 | |||
58 | |||
59 | 1 | Akiko Takano | > !permission.png! |
60 | 31 | Akiko Takano | |
61 | h2. Enabled Issue Templates as Project Module |
||
62 | |||
63 | Now this plugin works as project module. |
||
64 | So, project manager needs to check this plugin at project module settings page for activation. |
||
65 | 1 | Akiko Takano | |
66 | 32 | Akiko Takano | !set-as-project-module.png! |
67 | 4 | Akiko Takano | |
68 | 11 | Akiko Takano | h2. Usage & Screen shots |
69 | 5 | Akiko Takano | |
70 | h3. Use templates |
||
71 | |||
72 | 6 | Akiko Takano | User who has "show templates" permission can use templates when creating issue. |
73 | 16 | Akiko Takano | First, enable, selectable templates related with the tracker are shown as pulldown menu. |
74 | 6 | Akiko Takano | |
75 | 16 | Akiko Takano | Select template from pulldown, ajax request is posted and template body is loaded into issue description field. |
76 | |||
77 | 6 | Akiko Takano | |
78 | 16 | Akiko Takano | > !use_template1.png! |
79 | |||
80 | 35 | Akiko Takano | 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.) |
81 | |||
82 | 37 | Akiko Takano | > !template-pulldown-is-blank.png! |
83 | 35 | Akiko Takano | |
84 | 5 | Akiko Takano | h3. Create/Edit templates |
85 | 12 | Akiko Takano | |
86 | 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. |
87 | |||
88 | 13 | Akiko Takano | Click "Add template" and the form for creating template will be shown. |
89 | |||
90 | 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. |
91 | |||
92 | 16 | Akiko Takano | > !gotomenu.png! |
93 | 13 | Akiko Takano | |
94 | 16 | Akiko Takano | > !add-template.png! |
95 | 12 | Akiko Takano | |
96 | (!) Note: This is not shown without "show templates" permission. |
||
97 | 5 | Akiko Takano | |
98 | 14 | Akiko Takano | h3. Manage project templates |
99 | 1 | Akiko Takano | |
100 | 14 | Akiko Takano | Now this is optional setting. |
101 | Who has manage template permission can set custom help message for template usage on his/her project. |
||
102 | 1 | Akiko Takano | |
103 | 14 | Akiko Takano | This help message will be shown on the "New Issue" page, beside template pulldown. |
104 | |||
105 | 16 | Akiko Takano | > !manage-template.png! |
106 | 15 | Akiko Takano | |
107 | Here is a screenshot of custome template help message. |
||
108 | |||
109 | 16 | Akiko Takano | > !template-help.png! |
110 | 18 | Akiko Takano | |
111 | 25 | Akiko Takano | h3. Change Template order |
112 | 18 | Akiko Takano | |
113 | 25 | Akiko Takano | In case a tracker has some related templates, you can reorder template on index page. |
114 | 19 | Akiko Takano | |
115 | 25 | Akiko Takano | h3. Default template setting |
116 | |||
117 | If a template marked as default, template text will be loaded when tracker is changed on creating issue page. |
||
118 | |||
119 | 26 | Akiko Takano | For example, *Bug* tracker has 3 templates and "Bug3 default" template is marked as default. |
120 | |||
121 | 25 | Akiko Takano | !template-list.png! |
122 | 26 | Akiko Takano | |
123 | At the new issue page, when user selects Bug tracker, soon default template text is appended to description field. |
||
124 | |||
125 | 25 | Akiko Takano | !load-default-template.png! |
126 | |||
127 | 19 | Akiko Takano | h2. Future plannning / Feedback |
128 | 20 | Akiko Takano | |
129 | 18 | Akiko Takano | h3. Plannning |
130 | |||
131 | * Use global templates. |
||
132 | 27 | Akiko Takano | |
133 | 18 | Akiko Takano | |
134 | h3. Feedback |
||
135 | |||
136 | 1 | Akiko Takano | * Feedback would be appreciated. You can send from issue tracker on bitbucket or tracker on this project. |
137 | 25 | Akiko Takano | * Translations, ui idea, css are also appreciated. |