5 | | The extended version plugin extends the capabilities of the ticket version. Milestones may be assigned to versions. Versions gain visible pages similar to milestones, and display their milestones similarly to the roadmap. |
| 5 | 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. |
| 6 | |
| 7 | * 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)]] |
| 8 | * The version roadmap looks very similar to the milestone roadmap. [[Image(version_roadmap.png)]] |
| 9 | * Milestones assigned to versions have the version noted beside the due date. [[Image(milestone_version.png)]] |
25 | | usage example? |
| 29 | The easiest way to install the ExtendedVersionPlugin is probably with easy_install: |
| 30 | {{{ |
| 31 | easy_install http://trac-hacks.org/svn/extendedversionplugin/0.11 |
| 32 | }}} |
| 33 | |
| 34 | Alternatively, download the source and run the usual |
| 35 | {{{ |
| 36 | python setup.py install |
| 37 | }}} |
| 38 | |
| 39 | After installing the plugin, enable it for the trac environment in the TracIni file: |
| 40 | {{{ |
| 41 | #!ini |
| 42 | [components] |
| 43 | extendedversionplugin.* = enabled |
| 44 | }}} |
| 45 | |
| 46 | == Configuration == |
| 47 | |
| 48 | The ExtendedVersionPlugin has several configuration options available in the `[extended_version]` section of TracIni. The default values are: |
| 49 | {{{ |
| 50 | #!ini |
| 51 | [extended_version] |
| 52 | ; whether to provide item in main navigation bar |
| 53 | roadmap_navigation = false |
| 54 | ; item in main navigation bar to highlight for version pages |
| 55 | navigation_item = roadmap |
| 56 | ; component to use to provide group ticket statistics for versions |
| 57 | version_stats_provider = DefaultTicketGroupStatsProvider |
| 58 | ; component to use to provide group ticket statistics for milestones in version page |
| 59 | milestone_stats_provider = DefaultTicketGroupStatsProvider |
| 60 | }}} |
| 61 | |
| 62 | 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: |
| 63 | {{{ |
| 64 | #!ini |
| 65 | [extended_version] |
| 66 | roadmap_navigation = true |
| 67 | navigation_item = roadmap |
| 68 | }}} |
| 69 | To add a Versions item in addition to the Roadmap item, also rename the navigation_item: |
| 70 | {{{ |
| 71 | #!ini |
| 72 | [extended_version] |
| 73 | roadmap_navigation = true |
| 74 | navigation_item = version |
| 75 | }}} |