wiki:ExtendedVersionPlugin

Version 8 (modified by Ryan J Ollos, 5 years ago) (diff)

Fixed typo in previous edit.

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.

  • 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/0.11

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 provide item in main navigation bar
roadmap_navigation = false
# item in main navigation bar to highlight for version pages
navigation_item = roadmap
# 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 does not add any item to the main navigation bar. Version pages will highlight the Roadmap item. To replace the Roadmap item with Versions, turn on the roadmap_navigation:

[extended_version]
roadmap_navigation = true
navigation_item = roadmap

To add a Versions item in addition to the Roadmap item, also rename the navigation_item:

[extended_version]
roadmap_navigation = true
navigation_item = versions

Recent Changes

16610 by rjollos on 2017-05-24 04:00:42
TracExtendedVersion 1.0dev: Make compatible with Trac 1.2+

The plugin now only supports Trac 1.0+. The package
name has been changed from ExtendedVersionPlugin to
TracExtendedVersion, in preparation for publishing to
PyPI. You may want to explicitly uninstall the old package
if you use pip:

$ pip uninstall ExtendedVersionPlugin
$ pip install TracExtendedVersion

Fixes #13187.

16136 by rjollos on 2016-12-21 20:44:59
1.0dev: Allow milestone version edits from Milestone admin

Patch by Cinc-th. Fixes #12707.

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

Patch by benkovsk.

Fixes #10349.

(more)

Author/Contributors

Author: mestudd
Maintainer: See #10353
Contributors: dcernea

Attachments (3)

Download all attachments as: .zip