[[PageOutline(2-5,Contents,pullout)]]

= TracChecklist
''Use wiki pages as checklist templates within tickets''

== Description

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. 

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.

 
== Use

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:

{{{
    ChecklistTemplates
    |- Category One
	   |- Checklist One-1
	   |- Checklist One-2	   
    |- Category Two
	   |- Checklist Two-1
	   |- Checklist Two-2	   
}}}
	   
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. 


== !Bugs/Feature Requests

Existing bugs and feature requests for TracChecklistMacro are 
[report:9?COMPONENT=TracChecklistMacro here].

If you have any issues, create a 
[/newticket?component=TracChecklistMacro new ticket].

[[TicketQuery(component=TracChecklistMacro&group=type,format=progress)]]

== Download

Download the zipped source from [export:tracchecklistmacro here].

== Source

You can check out TracChecklistMacro from [/svn/tracchecklistmacro here] using Subversion, or [source:tracchecklistmacro browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page. \\
The plugin is available on PyPI https://pypi.org/project/TracChecklist:
{{{pip install TracChecklist}}}



== Recent Changes

[[ChangeLog(tracchecklistmacro, 3)]]

== !Author/Contributors

**Author:** [wiki:SydRa] [[BR]]
**Maintainer:** [[Maintainer]] [[BR]]
**Contributors:**