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

= Use templates from the wiki when creating a new milestone

== Description

This plugin allows you to create a new milestone using styling and information from a given template. For example your template may contain a predefined TicketQuery.

Additionally there is a preview of the milestone description (where you may use WikiFormatting) for Trac 1.0 and 1.2. Note that Trac 1.4 implements a preview out of the box.

=== Milestone Templates
Any wiki page with a name starting with ''MilestoneTemplates/'' can be used as a template. This works in a similar way as wiki page templates work, see PageTemplates.

Examples for milestone template names:

* MilestoneTemplates/MyMilestoneTemplate
* MilestoneTemplates/Sprint
* MilestoneTemplates/Release

When creating a new milestone you may use a dropdown list for selecting a template:

[[Image(milestone_select.png, border=1, width=50%)]]

The contents of the template is used for the milestone description on creation. Note that the dropdown list is only available after creation of one or more template pages.

Milestone templates may use the variable `$MILESTONE` for inserting the chosen milestone name into the description. This may be useful if the template contains a TracQuery with milestone parameter.

Add the following to your template page to create a list of tickets for the new milestone:

{{{
[[TicketQuery(max=5,status=closed,milestone=$MILESTONE,format=table,col=resolution|summary|milestone)]]
}}}

Parameters:
 max:: the maximum number of tickets to display
 status:: show only tickets with the given status
 milestone:: show tickets for the milestone with the given name. {{{$MILESTONE}}} will be replaced with the actual name.
 format:: use the given format to display the tickets
 col:: control what columns to display for each ticket

=== Preview Milestone Description
You may use WikiFormatting in a milestone description. This plugin shows a preview of the description:

[[Image(milestone_preview.png, border=1, width=60%)]]

In this example a TicketQuery is inserted in the description and the result shown in the preview area.

== !Bugs/Feature Requests

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

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

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

== Download

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

== Source

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

For Trac 0.12 and 1.0, use [source:milestonetemplateplugin/tags/milestonetemplate-0.1.2 version 0.1.2]. For Trac 1.2+, install from the [source:milestonetemplateplugin/trunk trunk].

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

Enable the plugin by going to the plugin admin page or by adding the following to your `trac.ini` configuration file:
{{{#!ini
[components]
milestonetemplate.web_ui.* = enabled
}}}

There are no default templates after installation. You need to create wiki pages with prefix ''!MilestoneTemplates/'' by yourself.

== Recent Changes

[[ChangeLog(milestonetemplateplugin, 3)]]

== !Author/Contributors

**Author:** [wiki:Cinc-th] [[BR]]
**Maintainer:** [[Maintainer]] [[BR]]
**Contributors:**