Changes between Version 30 and Version 31 of TracHoursPlugin


Ignore:
Timestamp:
Nov 6, 2009, 8:16:11 PM (5 years ago)
Author:
k0s
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracHoursPlugin

    v30 v31  
    3030== Components ==
    3131
     32!TracHours consists of a number of components that work together to help track your time:
     33
    3234=== [source:trachoursplugin/0.11/trachours/hours.py TracHoursPlugin ] ===
     35
     36`TracHoursPlugin` is the core component of !TracHours.
     37 * API function
     38 * Navigation bar provider
     39 * Query view for `/hours`
     40 * Ticket hours view for `/hours/<ticket number>`
     41 * Stream filter for checking and rendering of estimated hours and total hours fields for tickets
     42 * RSS feeds at `/hours?format=rss` and `/hours/<ticket number>?format=rss`
     43
     44This component must be enabled to use any functionality from the TracHoursPlugin
    3345
    3446=== [source:trachoursplugin/0.11/trachours/setup.py SetupTracHours ] ===
    3547
     48`SetupTracHours` sets up the database and custom fields for the TracHoursPlugin.  You must enable this component for anything to work, including the `TracHoursPlugin` component.
     49
    3650=== [source:trachoursplugin/0.11/trachours/web_ui.py TracHoursRoadmapFilter] ===
     51
     52`TracHoursRoadmapFilter` adds hours information for milestones at `/roadmap` and `/milestone/<milestone name>`
    3753
    3854=== [source:trachoursplugin/0.11/trachours/web_ui.py TracHoursSidebarProvider] ===
    3955
    40 Uses the TicketSidebarProviderPlugin (if enabled) to
     56The `TracHoursSidebarProvider` component uses the TicketSidebarProviderPlugin (if enabled) to add a form to each ticket for direct addition of hours to the ticket.  Hours will be logged as the authenticated user and comments will not be made.
    4157
    4258=== [source:trachoursplugin/0.11/trachours/ticket.py TracHoursByComment] ===
     59
     60The `TracHoursByComment` component enables adding hours by ticket comments.  Comments containing snippets like `5 hours`, `1 hour`, `3.7 hours`, or `0:30 hours` will be added to the total hours for the ticket, if the commenter has the `TICKET_ADD_HOURS` permission.
    4361
    4462=== [source:trachoursplugin/0.11/trachours/multiproject.py MultiprojectHours] ===
     
    4664The TracHoursPlugin exports RSS from the `/hours` handler.  This has
    4765been utilized in consumption to provide hours reports across projects
    48 sharing the same parent directory.  If {{{trachours.multiproject}}} is
     66sharing the same parent directory.  If `trachours.multiproject` is
    4967enabled, then `/hours/multiproject` will become a handler front-ending
    5068hours reports throughout the project and a link to this will appear on
     
    7997 * you will need to run {{{trac-admin <env> upgrade}}} in order to create the correct database tables
    8098
    81 The TracHoursPlugin requires python at least 2.4
     99'''Note:''' The TracHoursPlugin requires python at least 2.4
     100
     101The TracHoursPlugin also requires the ComponentDependencyPlugin and the TicketSidebarPlugin to be installed and enabled in order to work properly.
     102
     103Download the [download:trachoursplugin zipped source], check out [/svn/trachoursplugin/0.11 using Subversion], or [source:trachoursplugin browse the source] with Trac.
     104
     105See also the trac plugin installation instructions at http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin
    82106
    83107
     
    88112[/newticket?component=TracHoursPlugin&owner=k0s new ticket].
    89113
    90 A preliminary path to 1.0 is outlined here:  http://www.openplans.org/projects/topp-engineering/lists/trac/archive/2009/01/1231168734645
    91 
    92 == Download ==
    93 
    94 '''Note:''' The TracHoursPlugin requires python version at least 2.4
    95 
    96 Download the [download:trachoursplugin zipped source], check out [/svn/trachoursplugin/0.11 using Subversion], or [source:trachoursplugin browse the source] with Trac.
    97 
    98 See also the trac plugin installation instructions at http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin
    99114
    100115== Recent Changes ==