[Bps-public-commit] rtx-calendar branch multiple-days-events-2 updated. 1.05-21-g76eb665

[BPS Git Server]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "rtx-calendar".

The branch, multiple-days-events-2 has been updated
       via  76eb665b10a97383b82c1625c487fe6c197065b6 (commit)
      from  8b28a35ec32be1d0fc1e8b41ae0621125a6b59b0 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 76eb665b10a97383b82c1625c487fe6c197065b6
Author: Ronaldo Richieri <ronaldo at bestpractical.com>
Date:   Mon Nov 6 15:40:07 2023 -0300

    Update POD with new features
    
    Add information about custom field based events, multiple days events
    and new calendar portlets.
    
    Also bring the help section information from the UI to the POD in the
    usage section.
    
    Add image that shows new features in the POD.

diff --git a/docs/images/calendar.png b/docs/images/calendar.png
new file mode 100644
index 0000000..766a0a6
Binary files /dev/null and b/docs/images/calendar.png differ
diff --git a/lib/RTx/Calendar.pm b/lib/RTx/Calendar.pm
index be2486b..8201ae5 100644
--- a/lib/RTx/Calendar.pm
+++ b/lib/RTx/Calendar.pm
@@ -329,8 +329,23 @@ Date fields in the search results are displayed/used in the calendar,
 for example if you have a ticket with a due date, it won't be displayed on
 that date unless the Due field is included in the search result format.
 
-There's a portlet to put on your home page (see Prefs/MyRT.html), see the
-CONFIGURATION section below for details on adding it.
+You can also display events based on Date or DateTime custom fields on the
+Calendar.
+
+It can also show multiple-day events, such as a maintenance window that
+starts on one day and ends on another.
+
+Finally, you can see event details by hovering over the event in the
+calendar.
+
+=for html <img alt="Calendar" src="../../docs/images/calendar.png">
+
+=for :text [Calendar F<docs/images/general-status-chart.png>]
+
+=for :man [Calendar F<docs/images/calendar.png>]
+
+There are also special calendar portlets that you can add to your home
+page. See the CONFIGURATION section below for details on adding them.
 
 =head1 RT VERSION
 
@@ -375,12 +390,15 @@ RT dashboards:
 
 =over
 
-=item C<MyCalendar>, a summary of the events for the current week.
+=item C<MyCalendar>
+A summary of the events for the current week.
 
-=item C<Calendar>, a full month of the calendar view, without sidebar.
+=item C<Calendar>
+A full-month view of the calendar.
 
-=item C<CalendarWithSidebar>, a full month of the calendar view, with
-sidebar which includes an extra status filter and legends of the calendars.
+=item C<CalendarWithSidebar>
+A full-month view of the calendar, with a sidebar that includes an extra
+status filter and legends of the calendars.
 
 =back
 
@@ -471,7 +489,32 @@ Format in order the event to be displayed on the calendar.
 
 =head1 USAGE
 
-A small help section is available in /Search/Calendar.html
+=head2 Displaying reminders
+
+Reminders are displayed on the calendar only if you explicitly add the
+following clause to your query:
+
+    AND ( Type = 'ticket' OR Type = 'reminder' )
+
+=head2 Displaying other kind of dates
+
+By default, RTx::Calendar displays Due and Starts dates. You can select other
+date fields with the Display Columns section in the Query Builder.
+The following format will display the two additional date fields, LastUpdated and a
+custom field called Maintenance Date:
+
+    '<small>__Due__</small>',
+    '<small>__Starts__</small>',
+    '<small>__LastUpdated__</small>',
+    '<small>__CustomField.{Maintenance Date}__</small>'
+
+=head2 Changing the default query
+
+You can change the default query used by Calendar.html and Calendar portlets,
+by saving a query with the name C<calendar> in the Query Builder.
+
+Note that, first, the calendar will check for a user-level saved search,
+then a group-level saved search, and finally, a system-level saved search.
 
 =head1 AUTHOR
 

-----------------------------------------------------------------------

Summary of changes:
 docs/images/calendar.png | Bin 0 -> 101603 bytes
 lib/RTx/Calendar.pm      |  57 +++++++++++++++++++++++++++++++++++++++++------
 2 files changed, 50 insertions(+), 7 deletions(-)
 create mode 100644 docs/images/calendar.png


hooks/post-receive
-- 
rtx-calendar