Changes between Version 1 and Version 2 of ExtendedVersionPlugin


Ignore:
Timestamp:
Jan 23, 2010, 7:03:18 AM (5 years ago)
Author:
mestudd
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ExtendedVersionPlugin

    v1 v2  
    33== Description ==
    44
    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.
     5The 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)]]
    610
    711== Bugs/Feature Requests ==
     
    1317[http://trac-hacks.org/newticket?component=ExtendedVersionPlugin&owner=mestudd new ticket].
    1418
    15 == Download ==
     19== Installation & Configuration ==
     20
     21=== Download ===
    1622
    1723Download the zipped source from [download:extendedversionplugin here].
    1824
    19 == Source ==
    20 
    2125You can check out ExtendedVersionPlugin from [http://trac-hacks.org/svn/extendedversionplugin here] using Subversion, or [source:extendedversionplugin browse the source] with Trac.
    2226
    23 == Example ==
     27=== Installation ===
    2428
    25 usage example?
     29The easiest way to install the ExtendedVersionPlugin is probably with easy_install:
     30{{{
     31easy_install http://trac-hacks.org/svn/extendedversionplugin/0.11
     32}}}
     33
     34Alternatively, download the source and run the usual
     35{{{
     36python setup.py install
     37}}}
     38
     39After installing the plugin, enable it for the trac environment in the TracIni file:
     40{{{
     41#!ini
     42[components]
     43extendedversionplugin.* = enabled
     44}}}
     45
     46== Configuration ==
     47
     48The 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
     53roadmap_navigation = false
     54; item in main navigation bar to highlight for version pages
     55navigation_item = roadmap
     56; component to use to provide group ticket statistics for versions
     57version_stats_provider = DefaultTicketGroupStatsProvider
     58; component to use to provide group ticket statistics for milestones in version page
     59milestone_stats_provider = DefaultTicketGroupStatsProvider
     60}}}
     61
     62The 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]
     66roadmap_navigation = true
     67navigation_item = roadmap
     68}}}
     69To add a Versions item in addition to the Roadmap item, also rename the navigation_item:
     70{{{
     71#!ini
     72[extended_version]
     73roadmap_navigation = true
     74navigation_item = version
     75}}}
    2676
    2777== Recent Changes ==