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