Changes between Version 12 and Version 13 of TracChecklistMacro


Ignore:
Timestamp:
Feb 19, 2023, 12:52:26 PM (13 months ago)
Author:
figaro
Comment:

Harmonise order of sections, typo

Legend:

Unmodified
Added
Removed
Modified
  • TracChecklistMacro

    v12 v13  
    33= Use wiki pages as checklist templates within tickets
    44
    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.
     5This 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.
    96
    10 This prevents people from forgetting something (e.g. tag a new version), and
    11 allows for ongoing process improvements by updating the checklist whenever gaps
    12 in the existing process are discovered.
     7This 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.
    138
    149{{{#!html
     
    2116----
    2217
    23 == Installation
     18=== Usage
    2419
    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:
     20Create 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:
    7521{{{
    7622    wiki:ChecklistTemplates
     
    8329}}}
    8430
    85 Then use the dropdown menu at the top-right of any ticket description entry
    86 box when in edit mode to select & insert a template. The preview will show the
    87 checklist in your ticket.
     31Then 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.
    8832
    8933
    90 == Revisions
     34=== Revisions
    9135
    92360.1 - Initial upload to PyPI / TracHacks \\ 
     
    11458You can check out TracChecklistMacro from [/svn/tracchecklistmacro here] using Subversion, or [source:tracchecklistmacro browse the source] with Trac.
    11559
     60== Installation
     61
     62A plugin can either be deployed globally, or only for a specific environment.
     63Global deployment is done by installing the plugin:
     64{{{
     65 $ cd /path/to/pluginsource
     66 $ python setup.py install
     67}}}
     68
     69The plugin is also available on PyPI and can be installed globally using pip:
     70{{{
     71 $ pip install TracChecklist
     72}}}
     73
     74To 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
     83The plugin requires a new database table; update the environment to create it:
     84{{{
     85 $ trac-admin /path/to/env upgrade
     86}}}
     87
     88The plugin uses static resources (CSS, JS).  If you mapped static resources so
     89they are served by the web server, the resources need to be deployed to the
     90location on the filesystem that is served by the web server. Execute the deploy
     91command, as is done during install and upgrade:
     92{{{
     93 $ trac-admin /path/to/env deploy /deploy/path
     94}}}
     95
     96The plugin creates a {{{wiki:ChecklistTemplates}}} page as the {{{root}}} below which all
     97checklist definitions are located. If you move the page, update the entry in your
     98{{{trac.ini}}} file:
     99{{{#!ini
     100[checklist]
     101template_root = /path/to/ChecklistTemplates
     102}}}
     103
     104Restart the server once fully configured.
     105 
    116106== Recent Changes
    117107