Changes between Version 17 and Version 18 of TicketCalendarPlugin

Timestamp:

Apr 7, 2022, 6:10:23 AM (2 years ago)

Author:

figaro

Comment:

Move example to functional description

TicketCalendarPlugin

@@ -5 +5 @@
 == Description
 
-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.
+This 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.
+
+Click '''Ticket Calendar''' menu in the main navigation bar to show the calendar and associated start and due dates for tickets:
+
+[[Image(calendar-view.png, width=600, border=2)]]
+
+The calendar can also be displayed in a list view:
+
+[[Image(list-view.png, width=600, border=2)]]
+
+This plugin can be added to your wiki page as follows:
+
+`[[TicketCalendar(type=box, query=status!=closed, month=2013-05)]]`
+
+`[[TicketCalendar(type=list, query=status!=closed, duration=2013-05-16/P7D)]]`
+
+ * The `type` parameter determines how the tickets and milestones are presented:
+   - `box`: display in calendar view (default)
+   - `list`: display in list view
+ * The `query` parameter is used to filter the tickets to display.
+ * The `month` parameter can be specified as `YYYY-MM` and applies to the calendar view only. The default is current month.
+ * 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.
 
 == Bugs/Feature Requests
@@ -38 +59 @@
  1. Configuration options can be found on the TracIni#ticketcalendar-section page after installation.
 
-== Example
-
-Click '''Ticket Calendar''' menu in the main navigation bar to show the calendar and associated start and due dates for tickets:
-
-[[Image(calendar-view.png, width=600, border=2)]]
-
-The calendar can also be displayed in a list view:
-
-[[Image(list-view.png, width=600, border=2)]]
-
-== Usage
-
-`[[TicketCalendar(type=box,query=status!=closed,month=2013-05)]]`
-
-`[[TicketCalendar(type=list,query=status!=closed,duration=2013-05-16/P7D)]]`
-
- * The `type` parameter determines how the tickets and milestones are presented:
-   - `box`: display in calendar view (default)
-   - `list`: display in list view
- * The `query` parameter is used to query the tickets to display.
- * The `month` parameter can be specified as `YYYY-MM` in only calendar view. The default is current month.
- * The `duration` parameter can be specified as `YYYY-MM-DD/PnD` in only list view. The default is today and 7 days.
-
 == Recent Changes