Changes between Version 17 and Version 18 of TicketCalendarPlugin


Ignore:
Timestamp:
Apr 7, 2022, 6:10:23 AM (3 months ago)
Author:
figaro
Comment:

Move example to functional description

Legend:

Unmodified
Added
Removed
Modified
  • TicketCalendarPlugin

    v17 v18  
    55== Description
    66
    7 This plugin provides a ticket calendar as a box calendar and list view in page and wiki macro. The ticket calendar page can be searched similar to a wiki page. For examples, see below.
     7This plugin provides a ticket calendar: tickets are shown in a calendar, where they can be shown in both a calendar view (or box view) and a list view. The ticket calendar page can be searched similar to a wiki page.
     8
     9Click '''Ticket Calendar''' menu in the main navigation bar to show the calendar and associated start and due dates for tickets:
     10
     11[[Image(calendar-view.png, width=600, border=2)]]
     12
     13The calendar can also be displayed in a list view:
     14
     15[[Image(list-view.png, width=600, border=2)]]
     16
     17This plugin can be added to your wiki page as follows:
     18
     19`[[TicketCalendar(type=box, query=status!=closed, month=2013-05)]]`
     20
     21`[[TicketCalendar(type=list, query=status!=closed, duration=2013-05-16/P7D)]]`
     22
     23 * The `type` parameter determines how the tickets and milestones are presented:
     24   - `box`: display in calendar view (default)
     25   - `list`: display in list view
     26 * The `query` parameter is used to filter the tickets to display.
     27 * The `month` parameter can be specified as `YYYY-MM` and applies to the calendar view only. The default is current month.
     28 * The `duration` parameter can be specified as `YYYY-MM-DD/PnD` and applies to the list view only. The default is today and 7 days.
    829
    930== Bugs/Feature Requests
     
    3859 1. Configuration options can be found on the TracIni#ticketcalendar-section page after installation.
    3960
    40 == Example
    41 
    42 Click '''Ticket Calendar''' menu in the main navigation bar to show the calendar and associated start and due dates for tickets:
    43 
    44 [[Image(calendar-view.png, width=600, border=2)]]
    45 
    46 The calendar can also be displayed in a list view:
    47 
    48 [[Image(list-view.png, width=600, border=2)]]
    49 
    50 == Usage
    51 
    52 `[[TicketCalendar(type=box,query=status!=closed,month=2013-05)]]`
    53 
    54 `[[TicketCalendar(type=list,query=status!=closed,duration=2013-05-16/P7D)]]`
    55 
    56  * The `type` parameter determines how the tickets and milestones are presented:
    57    - `box`: display in calendar view (default)
    58    - `list`: display in list view
    59  * The `query` parameter is used to query the tickets to display.
    60  * The `month` parameter can be specified as `YYYY-MM` in only calendar view. The default is current month.
    61  * The `duration` parameter can be specified as `YYYY-MM-DD/PnD` in only list view. The default is today and 7 days.
    62 
    6361== Recent Changes
    6462