wiki:ExtendedVersionPlugin

Version 16 (modified by rjollos, 3 years ago) (diff)

Time to take this one over, but 0.11 won't be supported.

Extended Version Plugin

Description

The Trac ticket module has the concept of a version, but it is only visible as a name in a drop-down on a ticket. This plugin adds version description pages, a roadmap-like view of versions, and the ability to assign milestones to versions. Most features are optional. This plugin is for Trac 0.12 and later.

  • The version page shows the name, date, description and any assigned milestones. If milestones are assigned, it shows the overall progress for the version and the progress on each milestone.

  • The version roadmap looks very similar to the milestone roadmap.

  • Milestones assigned to versions have the version noted beside the due date.

Bugs/Feature Requests

Existing bugs and feature requests for ExtendedVersionPlugin are here.

If you have any issues, create a new ticket.

Installation & Configuration

Download

Download the zipped source from [download:extendedversionplugin here].

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

Installation

The easiest way to install the ExtendedVersionPlugin is probably with easy_install:

easy_install http://trac-hacks.org/svn/extendedversionplugin/trunk

Alternatively, download the source and run the usual

python setup.py install

After installing the plugin, enable it for the trac environment in the TracIni file:

[components]
extendedversion.* = enabled

This plugin requires some database changes, so upgrade the environment. Trac will prompt you to if you don't.

trac-admin /path/to/trac upgrade

Configuration

The ExtendedVersionPlugin has several configuration options available in the [extended_version] section of TracIni. The default values are:

[extended_version]
# whether to replace the roadmap navigation link or add a versions navigation link
roadmap_navigation = false
# component to use to provide group ticket statistics for versions
version_stats_provider = DefaultTicketGroupStatsProvider
# component to use to provide group ticket statistics for milestones in version page
milestone_stats_provider = DefaultTicketGroupStatsProvider
# whether to show milestone description for version pages
show_milestone_description = false

The default configuration adds a Versions item to the main navigation bar. To instead change the Roadmap item to link to the versions page, set the roadmap_navigation to true.

Recent Changes

15067 by rjollos on 2015-11-19 15:09:54
1.0dev: Make total element on progress bar a link

Patch by benkovsk.

Fixes #10349.

15034 by rjollos on 2015-11-05 21:05:29
1.0dev: Don't populate release date field unless it's enabled

Add roadmap.css to the version edit page and adjust markup
added in [15033], for consistency with the Trac 1.0 milestone
edit page.

This change is not compatible with Trac < 1.0. If you require
Trac 0.12 compatibility, please comment in ticket #12567.

Fixes #12567.

15033 by rjollos on 2015-11-05 20:38:40
1.0dev: Adjust styling of date format hint

Refs #12567.

(more)

Author/Contributors

Author: mestudd
Maintainer: rjollos
Contributors: dcernea
License: BSD 3-Clause

Attachments (3)

Download all attachments as: .zip