About en » 履歴 » バージョン 54
Akiko Takano, 2015/01/04 15:07
1 | 1 | Akiko Takano | h1. Issue Template plugin |
---|---|---|---|
2 | 47 | Akiko Takano | |
3 | 48 | Akiko Takano | {{toc}} |
4 | 1 | Akiko Takano | |
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 | 40 | Akiko Takano | h2. Information page on Redmine.org |
8 | |||
9 | 1 | Akiko Takano | * http://www.redmine.org/plugins/issue_templates |
10 | 49 | Akiko Takano | |
11 | h3. Demo site |
||
12 | |||
13 | 50 | Akiko Takano | Demo site: http://redmine-akiko.ruby.iijgio.com/ (For maintenance reason, this site may down irregularly.) |
14 | 40 | Akiko Takano | |
15 | 2 | Akiko Takano | h2. Download |
16 | |||
17 | 21 | Akiko Takano | * "bitbucket":https://bitbucket.org/akiko_pusu/redmine_issue_templates/ |
18 | 38 | Akiko Takano | ** "https://bitbucket.org/akiko_pusu/redmine_issue_templates/downloads (You can download zip/tgz) |
19 | 53 | Akiko Takano | * Build Status !https://drone.io/bitbucket.org/akiko_pusu/redmine_issue_templates/status.png! (drone.io) |
20 | 54 | Akiko Takano | ** https://drone.io/bitbucket.org/akiko_pusu/redmine_issue_templates |
21 | 2 | Akiko Takano | |
22 | 1 | Akiko Takano | h2. Features |
23 | 2 | Akiko Takano | |
24 | 41 | Akiko Takano | * Since 0.0.8, supported global issue templates. |
25 | ** Now only Administrator can associated global templates with each project. |
||
26 | 2 | Akiko Takano | * It works as project module. |
27 | * Member who has "Manage Template" right can create issue templates *based on trackers*. |
||
28 | ** Also add help message for templates, because the way to use templates may be different between projects. |
||
29 | * Member who has "Use Template" right can see the template and use them when creating new issue. |
||
30 | 39 | Akiko Takano | * Child project can use inherited templates from parent project. (Since ver 0.0.6) |
31 | 1 | Akiko Takano | |
32 | h2. Plugin installation |
||
33 | 3 | Akiko Takano | |
34 | # Copy the plugin into the vendor/plugins directory |
||
35 | # Migrate plugin: rake db:migrate_plugins RAILS_ENV=production |
||
36 | # Start Redmine |
||
37 | # Enable the module on the project setting page. |
||
38 | 1 | Akiko Takano | |
39 | 28 | Akiko Takano | h2. Uninstall plugin |
40 | |||
41 | 29 | Akiko Takano | h3. Run rake task |
42 | 28 | Akiko Takano | |
43 | ** rake redmine:plugins:migrate NAME=redmine_issue_templates VERSION=0 |
||
44 | |||
45 | Above rake task will remove the related records to redmine_issue_templates from schema_migration table. |
||
46 | In additon to this, issue_templates and issue_template_settings tables will be also removed. |
||
47 | |||
48 | 29 | Akiko Takano | h3. Manual uninstall |
49 | 28 | Akiko Takano | |
50 | In some situation, rake task to uninstall may be failed. To uninstall plugin manually, please remove these records and tables from your database. |
||
51 | |||
52 | * Remove records from schema_migration table related to issue_templates. |
||
53 | 52 | Akiko Takano | ** DELETE FROM schema_migrations WHERE version LIKE '%redmine_issue_templates'; |
54 | 28 | Akiko Takano | |
55 | * Drop issue_templates and issue_template settiongs. |
||
56 | 30 | Akiko Takano | ** DROP TABLE issue_templates; DROP TABLE issue_template_settings; |
57 | 28 | Akiko Takano | |
58 | 31 | Akiko Takano | h2. Permission Settings (as Redmine Admin) |
59 | 1 | Akiko Takano | |
60 | 4 | Akiko Takano | Now this plugin works as project module, and three permissions are defined. |
61 | |||
62 | # Show template |
||
63 | # Edit template |
||
64 | ** Right to create/edit templates. |
||
65 | # Manage template |
||
66 | ** Right to add help message for templates, such as usage of templates. |
||
67 | |||
68 | (!) Note: These templates are available only for its project. |
||
69 | 7 | Akiko Takano | (!) Note: Only Redmine administrator can set ermissions for issue templates. |
70 | |||
71 | |||
72 | 1 | Akiko Takano | > !permission.png! |
73 | 31 | Akiko Takano | |
74 | h2. Enabled Issue Templates as Project Module |
||
75 | |||
76 | Now this plugin works as project module. |
||
77 | So, project manager needs to check this plugin at project module settings page for activation. |
||
78 | 1 | Akiko Takano | |
79 | 32 | Akiko Takano | !set-as-project-module.png! |
80 | 4 | Akiko Takano | |
81 | 11 | Akiko Takano | h2. Usage & Screen shots |
82 | 5 | Akiko Takano | |
83 | h3. Use templates |
||
84 | |||
85 | 6 | Akiko Takano | User who has "show templates" permission can use templates when creating issue. |
86 | 16 | Akiko Takano | First, enable, selectable templates related with the tracker are shown as pulldown menu. |
87 | 6 | Akiko Takano | |
88 | 16 | Akiko Takano | Select template from pulldown, ajax request is posted and template body is loaded into issue description field. |
89 | |||
90 | 6 | Akiko Takano | |
91 | 16 | Akiko Takano | > !use_template1.png! |
92 | |||
93 | 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.) |
94 | |||
95 | 37 | Akiko Takano | > !template-pulldown-is-blank.png! |
96 | 35 | Akiko Takano | |
97 | 5 | Akiko Takano | h3. Create/Edit templates |
98 | 12 | Akiko Takano | |
99 | 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. |
100 | |||
101 | 13 | Akiko Takano | Click "Add template" and the form for creating template will be shown. |
102 | |||
103 | 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. |
104 | |||
105 | 16 | Akiko Takano | > !gotomenu.png! |
106 | 13 | Akiko Takano | |
107 | 16 | Akiko Takano | > !add-template.png! |
108 | 12 | Akiko Takano | |
109 | (!) Note: This is not shown without "show templates" permission. |
||
110 | 5 | Akiko Takano | |
111 | 14 | Akiko Takano | h3. Manage project templates |
112 | 1 | Akiko Takano | |
113 | 14 | Akiko Takano | Now this is optional setting. |
114 | Who has manage template permission can set custom help message for template usage on his/her project. |
||
115 | 1 | Akiko Takano | |
116 | 14 | Akiko Takano | This help message will be shown on the "New Issue" page, beside template pulldown. |
117 | |||
118 | 16 | Akiko Takano | > !manage-template.png! |
119 | 15 | Akiko Takano | |
120 | Here is a screenshot of custome template help message. |
||
121 | |||
122 | 16 | Akiko Takano | > !template-help.png! |
123 | 18 | Akiko Takano | |
124 | 25 | Akiko Takano | h3. Change Template order |
125 | 18 | Akiko Takano | |
126 | 25 | Akiko Takano | In case a tracker has some related templates, you can reorder template on index page. |
127 | 19 | Akiko Takano | |
128 | 25 | Akiko Takano | h3. Default template setting |
129 | |||
130 | If a template marked as default, template text will be loaded when tracker is changed on creating issue page. |
||
131 | |||
132 | 26 | Akiko Takano | For example, *Bug* tracker has 3 templates and "Bug3 default" template is marked as default. |
133 | |||
134 | 25 | Akiko Takano | !template-list.png! |
135 | 26 | Akiko Takano | |
136 | At the new issue page, when user selects Bug tracker, soon default template text is appended to description field. |
||
137 | |||
138 | 25 | Akiko Takano | !load-default-template.png! |
139 | |||
140 | 44 | Akiko Takano | h3. Global template setting |
141 | |||
142 | 46 | Akiko Takano | Administrator can make global templates from Admiistration menu, and associate global templates with each project. |
143 | |||
144 | 44 | Akiko Takano | !global-template.png! |
145 | 46 | Akiko Takano | |
146 | h4. Known restrictions |
||
147 | |||
148 | * Global templates can not be associated with each project from project settings tab. (Now only Administrator do this work) |
||
149 | * Global template is not defined as a default template. |
||
150 | |||
151 | 44 | Akiko Takano | |
152 | 19 | Akiko Takano | h2. Future plannning / Feedback |
153 | 20 | Akiko Takano | |
154 | 43 | Akiko Takano | h3. Known issue |
155 | 42 | Akiko Takano | |
156 | * Template loads every time Status is changed |
||
157 | 51 | Akiko Takano | ** https://bitbucket.org/akiko_pusu/redmine_issue_templates/issue/36 |
158 | ** Only happned in case using default template. |
||
159 | 42 | Akiko Takano | |
160 | 18 | Akiko Takano | h3. Plannning |
161 | 1 | Akiko Takano | |
162 | 42 | Akiko Takano | * Template for note/journal. (Optional) |
163 | * Custom fields support. (Maybe this is implemented another way, such as copy from base issue) |
||
164 | 27 | Akiko Takano | |
165 | 18 | Akiko Takano | |
166 | h3. Feedback |
||
167 | |||
168 | 1 | Akiko Takano | * Feedback would be appreciated. You can send from issue tracker on bitbucket or tracker on this project. |
169 | 25 | Akiko Takano | * Translations, ui idea, css are also appreciated. |