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

= Extending the concept of a 'version' in Trac

{{{#!NewsFlash
**Development status** There is on-going work to provide similar features in the Trac core. See trac:#1233 and trac:#11409.
}}}

== Description

This plugin extends the concept of a version in Trac. While the Trac ticket module has the concept of a version, it is only visible as a name in a drop-down on a ticket and offers no further functionality. 

This plugin adds the following features to the concept of version:
 * version description pages
 * a roadmap-like view of versions
 * the ability to assign milestones to versions. 

Most features are optional. 

'''Note:''' This plugin is for Trac 0.12 and later.

=== Screenshot: version page

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:

[[Image(version_page.png, 50%, border=2)]]

=== Screenshot: version roadmap

The version roadmap looks very similar to the milestone roadmap:

[[Image(version_roadmap.png, 50%, border=2)]]

=== Screenshot: milestones page

Milestones assigned to versions have the version noted alongside the due date:

[[Image(milestone_version.png, border=2)]]

== Bugs/Feature Requests

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

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

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

== Download

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

== Source

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

== Installation

The easiest way to install the ExtendedVersionPlugin is probably with easy_install:
{{{#!sh
easy_install https://trac-hacks.org/svn/extendedversionplugin/trunk
}}}

Alternatively, download the source and run the usual:
{{{#!sh
python setup.py install
}}}

After installing the plugin, enable it for the Trac environment in the TracIni file:
{{{#!ini
[components]
extendedversion.* = enabled
}}}

This plugin requires some database changes, so upgrade the environment. Trac will prompt you to if you don't.
{{{#!sh
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:
{{{#!ini
[extended_version]
# 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`.

The `roadmap_navigation` option has been removed in r13314. The equivalent of `roadmap_navigation = true` can be obtained by setting `trac.ticket.roadmap.RoadmapModule = disabled`. Prior to r13314, the following option is available:
{{{#!ini
# whether to replace the roadmap navigation link or add a versions navigation link
roadmap_navigation = false
}}}

== Recent Changes

[[ChangeLog(extendedversionplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:mestudd] [[BR]]
'''Maintainer:''' [[Maintainer]][[BR]]
'''Contributors:''' [wiki:dcernea], jun66j5 [[BR]]