About en » 履歴 » バージョン 29
Akiko Takano, 2013/02/07 19:42
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 | 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 | |||
44 | 5 | Akiko Takano | h2. Permission Settings |
45 | 1 | Akiko Takano | |
46 | 4 | Akiko Takano | Now this plugin works as project module, and three permissions are defined. |
47 | |||
48 | # Show template |
||
49 | # Edit template |
||
50 | ** Right to create/edit templates. |
||
51 | # Manage template |
||
52 | ** Right to add help message for templates, such as usage of templates. |
||
53 | |||
54 | (!) Note: These templates are available only for its project. |
||
55 | 7 | Akiko Takano | (!) Note: Only Redmine administrator can set ermissions for issue templates. |
56 | |||
57 | |||
58 | 16 | Akiko Takano | > !permission.png! |
59 | 4 | Akiko Takano | |
60 | |||
61 | 11 | Akiko Takano | h2. Usage & Screen shots |
62 | 5 | Akiko Takano | |
63 | h3. Use templates |
||
64 | |||
65 | 6 | Akiko Takano | User who has "show templates" permission can use templates when creating issue. |
66 | 16 | Akiko Takano | First, enable, selectable templates related with the tracker are shown as pulldown menu. |
67 | 6 | Akiko Takano | |
68 | 16 | Akiko Takano | Select template from pulldown, ajax request is posted and template body is loaded into issue description field. |
69 | |||
70 | 6 | Akiko Takano | |
71 | 16 | Akiko Takano | > !use_template1.png! |
72 | |||
73 | 5 | Akiko Takano | h3. Create/Edit templates |
74 | 12 | Akiko Takano | |
75 | 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. |
76 | |||
77 | 13 | Akiko Takano | Click "Add template" and the form for creating template will be shown. |
78 | |||
79 | 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. |
80 | |||
81 | 16 | Akiko Takano | > !gotomenu.png! |
82 | 13 | Akiko Takano | |
83 | 16 | Akiko Takano | > !add-template.png! |
84 | 12 | Akiko Takano | |
85 | (!) Note: This is not shown without "show templates" permission. |
||
86 | 5 | Akiko Takano | |
87 | 14 | Akiko Takano | h3. Manage project templates |
88 | 1 | Akiko Takano | |
89 | 14 | Akiko Takano | Now this is optional setting. |
90 | Who has manage template permission can set custom help message for template usage on his/her project. |
||
91 | 1 | Akiko Takano | |
92 | 14 | Akiko Takano | This help message will be shown on the "New Issue" page, beside template pulldown. |
93 | |||
94 | 16 | Akiko Takano | > !manage-template.png! |
95 | 15 | Akiko Takano | |
96 | Here is a screenshot of custome template help message. |
||
97 | |||
98 | 16 | Akiko Takano | > !template-help.png! |
99 | 18 | Akiko Takano | |
100 | 25 | Akiko Takano | h3. Change Template order |
101 | 18 | Akiko Takano | |
102 | 25 | Akiko Takano | In case a tracker has some related templates, you can reorder template on index page. |
103 | 19 | Akiko Takano | |
104 | 25 | Akiko Takano | h3. Default template setting |
105 | |||
106 | If a template marked as default, template text will be loaded when tracker is changed on creating issue page. |
||
107 | |||
108 | 26 | Akiko Takano | For example, *Bug* tracker has 3 templates and "Bug3 default" template is marked as default. |
109 | |||
110 | 25 | Akiko Takano | !template-list.png! |
111 | 26 | Akiko Takano | |
112 | At the new issue page, when user selects Bug tracker, soon default template text is appended to description field. |
||
113 | |||
114 | 25 | Akiko Takano | !load-default-template.png! |
115 | |||
116 | 19 | Akiko Takano | h2. Future plannning / Feedback |
117 | 20 | Akiko Takano | |
118 | 18 | Akiko Takano | h3. Plannning |
119 | |||
120 | * Use global templates. |
||
121 | 27 | Akiko Takano | |
122 | 18 | Akiko Takano | |
123 | h3. Feedback |
||
124 | |||
125 | 1 | Akiko Takano | * Feedback would be appreciated. You can send from issue tracker on bitbucket or tracker on this project. |
126 | 25 | Akiko Takano | * Translations, ui idea, css are also appreciated. |