Changes between Version 24 and Version 25 of TracHoursHowto


Ignore:
Timestamp:
Mar 25, 2016, 8:05:53 AM (8 years ago)
Author:
figaro
Comment:

Further cosmetic changes and retagging from tutorial to usermanual

Legend:

Unmodified
Added
Removed
Modified
  • TracHoursHowto

    v24 v25  
    55== Introduction
    66
    7 The TracHoursPlugin is designed to help tally time which is spent working on Trac tickets. This tutorial explains how to use this plugin.
     7The TracHoursPlugin is designed to help track time that is spent working on Trac tickets. This tutorial explains how to use this plugin.
    88
    99After installing and enabling the TracHoursPlugin, you should be able to see its functionality by going to the '''Hours''' tab on the nav bar:
    1010
    11 [[Image(nav.png, border=1)]]
     11[[Image(nav.png, border=2)]]
    1212
    1313[wiki:TracHoursPlugin TracHours] introduces new screens, at `/hours` (the query view) and `/hours/<ticket number>` (the hours view for that ticket). [wiki:TracHoursPlugin TracHours] also modifies the ticket screen to display estimated and total hours (see below) and the roadmap view to compute the hours (if the `TracHoursRoadmapFilter` component is enabled):
    1414
    15 [[Image(milestone.png, border=1)]]
     15[[Image(milestone.png, border=2)]]
    1616
    1717== Adding Hours to a Ticket
     
    2020When you make a new ticket, `Total Hours` will be `0`.
    2121
    22 [[Image(newticket.png, border=1)]]
     22[[Image(newticket.png, border=2)]]
    2323
    2424For an existing ticket, the `Total Hours` field will be a link to the [wiki:TracHoursPlugin TracHours] screen for that ticket:
    2525
    26 [[Image(ticket.png, border=1)]]
     26[[Image(ticket.png, border=2)]]
    2727
    2828As an example for ticket 1, this will link to `/hours/1`. Going to this screen will allow you to verbosely see, add to, and edit the hours for a ticket:
    2929
    30 [[Image(ticket_hours.png, border=1)]]
     30[[Image(ticket_hours.png, border=2)]]
    3131
    3232If you have `TRAC_ADMIN` permission (as shown), you can add and edit hours for any user. Otherwise you will only be able to add and edit hours as yourself if you have the `TICKET_ADD_HOURS` permission). If you are not logged in, you can view hours but not add them. You can also edit existing hours from this screen (only your own, unless you're a `TRAC_ADMIN`). If you add hours with a description, the addition will be logged to the ticket comments and appropriate notifications will be sent.
     
    3636Clicking on the Hours tab in the navigation bar or going to `/hours` gives a screen where the hours for all tickets can be queried and tallied. The `/hours` screen is designed to mimic the Trac [/query custom query] screen in terms of look and feel, except that what is being queried over are hours addition events and not tickets. The hours (both estimated and tracked) are totaled above the ticket query results.
    3737
    38 [[Image(query_hours.png, border=1)]]
     38[[Image(query_hours.png, border=2)]]
    3939
    4040By default, hours accrued in the last week are shown with a convenience link to the previous week. Like the Trac [/query custom query], filters may be added over ticket reporter, owner, and other fields.
     
    4848The [source:trachoursplugin/0.11/trachours/web_ui.py TracHoursSidebarProvider] component adds a sidebar for on existing tickets for convenient posting of hours:
    4949
    50 [[Image(TracHoursPlugin:hours-ticket-sidebar.png, border=1)]]
     50[[Image(TracHoursPlugin:hours-ticket-sidebar.png, border=2)]]
    5151
    5252The TicketSidebarProviderPlugin will additionally have to be installed and enabled for the sidebar element to appear. It will also only show up if you have the `TICKET_ADD_HOURS` permission.