Changes between Version 4 and Version 5 of TracChecklistMacro


Ignore:
Timestamp:
Jan 26, 2022, 4:48:45 PM (2 years ago)
Author:
Ralph Ewig
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracChecklistMacro

    v4 v5  
    44''Use wiki pages as checklist templates within tickets''
    55
    6 This plugin allows you to define checklists as a wiki page, and then embed them in tickets as templates for recurring tasks. This prevents people from forgetting something (e.g. tag a new version), and allows for ongoing process improvements by updating the checklist whenever gaps in the existing process are discovered.
     6This plugin allows you to define checklists as a wiki page, and then embed
     7them in tickets as templates for recurring tasks. For example, if your workflow
     8for a bug ticket includes steps for fix/test/release, each of these can be defined
     9as a step and checked off as the assignee works on the ticket.
     10
     11This prevents people from forgetting something (e.g. tag a new version), and
     12allows for ongoing process improvements by updating the checklist whenever gaps
     13in the existing process are discovered.
    714
    815[[Image(wiki.jpg, 100%)]]
    916[[Image(macro.jpg, 100%)]]
    1017
     18----
     19
     20== Install
     21
     22A plugin can either be deployed globally, or only for a specific environment.
     23Global deployment is done by installing the plugin:
     24{{{
     25 $ cd /path/to/pluginsource
     26 $ python setup.py install
     27}}}
     28
     29The plugin is also available on PyPI and can be installed globally using pip:
     30{{{
     31 $ pip install TracChecklist
     32}}}
     33
     34To deploy a plugin only to a specific Trac environment, copy the egg file into
     35the plugins directory of that environment:
     36{{{
     37 $ cd /path/to/pluginsource
     38 $ python setup.py bdist_egg
     39 $ cp dist/*.egg /path/to/projenv/plugins
     40}}}
     41
     42== Setup
     43
     44The plugin requires a new database table; update the environment to create it:
     45{{{
     46 $ trac-admin /path/to/env upgrade
     47}}}
     48
     49The plugin uses static resources (CSS, JS).  If you mapped static resources so
     50they are served by the web server, the resources need to be deployed to the
     51location on the filesystem that is served by the web server. Execute the deploy
     52command, as is done during install and upgrade:
     53{{{
     54 $ trac-admin /path/to/env deploy /deploy/path
     55}}}
     56
     57The plugin creates a {{{wiki:ChecklistTemplates}}} page as the {{{root}}} below which all
     58checklist definitions are located. If you move the page, update the entry in your
     59{{{trac.ini}}} file:
     60{{{
     61[checklist]
     62template_root = /path/to/ChecklistTemplates
     63}}}
     64
     65Restart the server once fully configured.
     66 
    1167 
    1268== Use
    1369
    14 Create at least one checklist as a sub-page below the {{{ChecklistTemplate}}} wiki page using the provided template. You can create pages below non-existing parents, which will be treated as category headers. For example:
     70Create at least one checklist as a sub-page below the {{{wiki:ChecklistTemplates}}} page
     71using the template provided. You can also create pages below non-existing parents, which
     72will then be treated as category headers. For exmaple:
     73{{{
     74    wiki:ChecklistTemplates
     75    |- CatOne (not a page)
     76           |- wiki:ChecklistTemplates/CatOne/Checklist One
     77           |- wiki:ChecklistTemplates/CatOne/Checklist Two
     78    |- CatTwo (not a page)
     79           |- wiki:ChecklistTemplates/CatTwo/Checklist Three
     80           |- wiki:ChecklistTemplates/CatTwo/Checklist Four
     81}}}
    1582
    16 {{{
    17     ChecklistTemplates
    18     |- Category One
    19            |- Checklist One-1
    20            |- Checklist One-2     
    21     |- Category Two
    22            |- Checklist Two-1
    23            |- Checklist Two-2     
    24 }}}
    25            
    26 Then use the dropdown menu at the top-right of any ticket description entry box when in edit mode to select & insert a template. The preview will show the checklist in your ticket.
     83Then use the dropdown menu at the top-right of any ticket description entry
     84box when in edit mode to select & insert a template. The preview will show the
     85checklist in your ticket.
    2786
    2887
    29 == !Bugs/Feature Requests
     88== Revisions
     89
     900.1.1 - Initial upload to PyPI / TracHacks 
     910.1.2 - fixed URL's in setup.py to point to TrackHacks page 
     92
     93----
     94
     95== !Bugs/Features
    3096
    3197Existing bugs and feature requests for TracChecklistMacro are
    … …  
    37103[[TicketQuery(component=TracChecklistMacro&group=type,format=progress)]]
    38104
    39 == Download
    40 
    41 Download the zipped source from [export:tracchecklistmacro here].
    42 
    43105== Source
    44106
     107Download the zipped source from [export:tracchecklistmacro here]. \\
    45108You can check out TracChecklistMacro from [/svn/tracchecklistmacro here] using Subversion, or [source:tracchecklistmacro browse the source] with Trac.
    46 
    47 == Installation
    48 
    49 General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page. \\
    50 The plugin is available on PyPI https://pypi.org/project/TracChecklist:
    51 {{{pip install TracChecklist}}}
    52 
    53109
    54110
    … …  
    59115== !Author/Contributors
    60116
     117This plugin was developed and is maintained by https://sydereal.space
     118
    61119**Author:** [wiki:SydRa] [[BR]]
    62120**Maintainer:** [[Maintainer]] [[BR]]