wiki:MilestoneTemplatePlugin

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:

Select a template when creating a new milestone

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:

Preview of milestone description

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 here.

If you have any issues, create a new ticket.

defect

2 / 2

enhancement

2 / 2

Download

Download the zipped source from here.

Source

You can check out MilestoneTemplatePlugin from here using Subversion, or browse the source with Trac.

For Trac 0.12 and 1.0, use version 0.1.2. For Trac 1.2+, install from the trunk.

Installation

General instructions on installing Trac plugins can be found on the TracPlugins page.

Enable the plugin by going to the plugin admin page or by adding the following to your trac.ini configuration file:

[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

17779 by Cinc-th on 2020-06-23 18:52:58
Corrected year in copyright file.
17778 by Cinc-th on 2020-06-23 18:45:44
  • Don't use filter_stream() from ITemplateStreamFilter anymore.
  • Disable preview for milestone description for Trac>1.2 because Trac 1.4 comes with a preview implementation

Plugin is now compatible with Trac >=1.2 without using Genshi.

Closes #13833

17777 by Cinc-th on 2020-06-22 05:44:23
No longer use Genshi templates when creating HTML fragments. Add a few test cases for checking fragments.

Closes #13832

(more)

Author/Contributors

Author: Cinc-th
Maintainer: Cinc-th
Contributors:

Last modified 4 years ago Last modified on Jun 23, 2020, 6:49:32 PM

Attachments (2)

Download all attachments as: .zip