5 | | This plugin allows you to define checklists as a wiki page, and then embed |
6 | | them in tickets as templates for recurring tasks. For example, if your workflow |
7 | | for a bug ticket includes steps for fix/test/release, each of these can be defined |
8 | | as a step and checked off as the assignee works on the ticket. |
| 5 | This plugin allows you to define checklists as a wiki page, and then embed them in tickets as templates for recurring tasks. For example, if your workflow for a bug ticket includes steps for fix/test/release, each of these can be defined as a step and checked off as the assignee works on the ticket. |
25 | | A plugin can either be deployed globally, or only for a specific environment. |
26 | | Global deployment is done by installing the plugin: |
27 | | {{{ |
28 | | $ cd /path/to/pluginsource |
29 | | $ python setup.py install |
30 | | }}} |
31 | | |
32 | | The plugin is also available on PyPI and can be installed globally using pip: |
33 | | {{{ |
34 | | $ pip install TracChecklist |
35 | | }}} |
36 | | |
37 | | To deploy a plugin only to a specific Trac environment, copy the egg file into |
38 | | the plugins directory of that environment: |
39 | | {{{ |
40 | | $ cd /path/to/pluginsource |
41 | | $ python setup.py bdist_egg |
42 | | $ cp dist/*.egg /path/to/projenv/plugins |
43 | | }}} |
44 | | |
45 | | == Setup |
46 | | |
47 | | The plugin requires a new database table; update the environment to create it: |
48 | | {{{ |
49 | | $ trac-admin /path/to/env upgrade |
50 | | }}} |
51 | | |
52 | | The plugin uses static resources (CSS, JS). If you mapped static resources so |
53 | | they are served by the web server, the resources need to be deployed to the |
54 | | location on the filesystem that is served by the web server. Execute the deploy |
55 | | command, as is done during install and upgrade: |
56 | | {{{ |
57 | | $ trac-admin /path/to/env deploy /deploy/path |
58 | | }}} |
59 | | |
60 | | The plugin creates a {{{wiki:ChecklistTemplates}}} page as the {{{root}}} below which all |
61 | | checklist definitions are located. If you move the page, update the entry in your |
62 | | {{{trac.ini}}} file: |
63 | | {{{#!ini |
64 | | [checklist] |
65 | | template_root = /path/to/ChecklistTemplates |
66 | | }}} |
67 | | |
68 | | Restart the server once fully configured. |
69 | | |
70 | | == Use |
71 | | |
72 | | Create at least one checklist as a sub-page below the {{{wiki:ChecklistTemplates}}} page |
73 | | using the template provided. You can also create pages below non-existing parents, which |
74 | | will then be treated as category headers. For exmaple: |
| 20 | Create at least one checklist as a sub-page below the {{{wiki:ChecklistTemplates}}} page using the template provided. You can also create pages below non-existing parents, which will then be treated as category headers. For example: |
| 60 | == Installation |
| 61 | |
| 62 | A plugin can either be deployed globally, or only for a specific environment. |
| 63 | Global deployment is done by installing the plugin: |
| 64 | {{{ |
| 65 | $ cd /path/to/pluginsource |
| 66 | $ python setup.py install |
| 67 | }}} |
| 68 | |
| 69 | The plugin is also available on PyPI and can be installed globally using pip: |
| 70 | {{{ |
| 71 | $ pip install TracChecklist |
| 72 | }}} |
| 73 | |
| 74 | To deploy a plugin only to a specific Trac environment, copy the egg file into the plugins directory of that environment: |
| 75 | {{{ |
| 76 | $ cd /path/to/pluginsource |
| 77 | $ python setup.py bdist_egg |
| 78 | $ cp dist/*.egg /path/to/projenv/plugins |
| 79 | }}} |
| 80 | |
| 81 | == Configuration |
| 82 | |
| 83 | The plugin requires a new database table; update the environment to create it: |
| 84 | {{{ |
| 85 | $ trac-admin /path/to/env upgrade |
| 86 | }}} |
| 87 | |
| 88 | The plugin uses static resources (CSS, JS). If you mapped static resources so |
| 89 | they are served by the web server, the resources need to be deployed to the |
| 90 | location on the filesystem that is served by the web server. Execute the deploy |
| 91 | command, as is done during install and upgrade: |
| 92 | {{{ |
| 93 | $ trac-admin /path/to/env deploy /deploy/path |
| 94 | }}} |
| 95 | |
| 96 | The plugin creates a {{{wiki:ChecklistTemplates}}} page as the {{{root}}} below which all |
| 97 | checklist definitions are located. If you move the page, update the entry in your |
| 98 | {{{trac.ini}}} file: |
| 99 | {{{#!ini |
| 100 | [checklist] |
| 101 | template_root = /path/to/ChecklistTemplates |
| 102 | }}} |
| 103 | |
| 104 | Restart the server once fully configured. |
| 105 | |