PT Calendar Version 4.0 Install - Revision history

Gcronkright at 23:15, 17 February 2022

2022-02-17T23:15:42Z

Ssmith: /* Rendering and Display Tab */

2017-03-09T04:17:24Z

‎Rendering and Display Tab

Ssmith: /* Calendar View Pages */

2016-08-12T20:50:35Z

‎Calendar View Pages

Ssmith: /* Calendar Modules and Widgets (Narrow Content Area) - Optional Items */

2016-08-12T20:45:59Z

‎Calendar Modules and Widgets (Narrow Content Area) - Optional Items

Ssmith: /* Manage Event Categories Datasheet */

2016-08-12T01:09:54Z

‎Manage Event Categories Datasheet

Ssmith: /* CCAPI Configuration */

2016-08-12T00:12:17Z

‎CCAPI Configuration

Ssmith: /* App Configuration */

2016-08-11T19:45:04Z

‎App Configuration

Ssmith: /* Verify Imports */

2016-08-11T00:56:19Z

‎Verify Imports

Gcronkright: /* Site Configuration */

2016-05-05T15:59:21Z

‎Site Configuration

Gcronkright: /* Styles */

2016-05-05T15:58:27Z

‎Styles

@@ Line 4: / Line 4: @@
 == Download ==
-Download the Calendar Application from the [http://community.paperthin.com/projects/pt_calendar/index.cfm Community Site Project] or from the SVN Repository.
+Download the Calendar Application from the [http://community.paperthin.com/projects/pt_calendar2/index.cfm Community Site Project] or from the SVN Repository.
 Extract the zip files into the following directory:

@@ Line 107: / Line 107: @@
 # '''Calendar Large Grid Cell Width ''' - (Default: 130)
 # '''Calendar Large Grid Cell Height''' - (Default: 150)
-# '''ColdFusion Date Mask''' - ColdFusion Date Mask used for the display of dates. [http://www.cfquickdocs.com/cf9/#DateFormat DateFormat on cfquickdocs.com] (Default: M/D/YYYY)
+# '''ColdFusion Date Mask''' - ColdFusion Date Mask used for the display of dates. [https://cfdocs.org/dateformat DateFormat on cfdocs.com] (Default: M/D/YYYY)
-# '''ColdFusion Time Mask''' - ColdFusion Time Mask used for the display of times. [http://www.cfquickdocs.com/cf9/#TimeFormat TimeFormat on cfquickdocs.com] (Default: h:mm tt)
+# '''ColdFusion Time Mask''' - ColdFusion Time Mask used for the display of times. [https://cfdocs.org/timeformat TimeFormat on cfdocs.com] (Default: h:mm tt)
-# '''ColdFusion Long Date Mask''' - ColdFusion Date Mask used for the display of long or full dates. [http://www.cfquickdocs.com/cf9/#DateFormat DateFormat on cfquickdocs.com] (Default:  yyyy)
+# '''ColdFusion Long Date Mask''' - ColdFusion Date Mask used for the display of long or full dates. [https://cfdocs.org/dateformat DateFormat on cfdocs.com] (Default:  yyyy)
 # '''Broken Recurrence Event Suffix''' - Text that is appended to the end of the title of a broken recurrence event that was created from a recurrence pattern. (Default: ''blank'')
 # '''Copy Event Suffix''' - Text that is appended to the end of the title of a copied event.  (Default: - Copy)

@@ Line 619: / Line 619: @@
 # Create a CommonSpot page with a name '''index''' and the page title of '''Events Calendar''' using the '''Calendar Template''' and place it in the Calendar subsite.
 #* Since the this page is being created from the '''Calender Template''' which already contains all of the needed calendar elements, widgets and modules this '''All Events''' calendar page is complete.
-#* If you are making a sub-calendar which will have filtered events by organization or by category, then select the organization or category to filter by from the options is the '''Calendar Display Properties''' as described in the [[#Calendar Display Views (Wide Content Area)|Calendar Display Views (Wide Content Area)]] section.
+#* If you are making a sub-calendar which will have filtered events by organization or by category, then select the organization or category to filter by from the options in the '''Calendar Display Properties''' element as described in the [[#Calendar Display Views (Wide Content Area)|Calendar Display Views (Wide Content Area)]] section.
 # Submit the Page.

@@ Line 233: / Line 233: @@
 ## Submit the Custom Script Element form.
 # '''Event Category Checkbox Filters'''  - Optional
-## Next in the '''NARROW''' column container, add the '''Calendar Display Properties''' Local Custom Element.
+## Next in the '''NARROW''' column container, add the '''Calendar Event Categories''' Global Custom Element.
 ## Click '''Render Mode''' in the element interface.
 ## Select '''Display existing element data (content reuse)''' on the '''Rendering Mode''' tab.

@@ Line 456: / Line 456: @@
 ##Click Finish or Save.
 ##In the Header field, switch the text to 'Notify Users'
 ##Click Finish or Save
 # Close the Edit Column window.

@@ Line 276: / Line 276: @@
 ##[[Calendar Event Categories]]
 ##[[Calendar Organizations]]
 # For each element that was added, click on the element indicator and go to 'more...'.  Select 'Name' from the menu.
 # In the Element Name field, enter the appropriate name for each element:
@@ Line 284: / Line 283: @@
 ## ccapiCalendarEventCategoriesElement
 ## ccapiCalendarOrganizationsElement
 # Publish this page and view in read mode.
 # Edit the 'ccapi.cfm' file for the site and add the following xml blocks into the <elements> section:

@@ Line 73: / Line 73: @@
 == App Configuration ==
-The Calendar App uses a custom element to store site specific configurations.
+The Calendar App uses a custom element, "ptCalendar Configuration", to store site specific configurations.
 <!-- Most of these configuration fields will not need to be modified from their default values. Although, there are a few fields that the values will need to be customized for your specific install of the application. These fields are be listed below.-->
@@ Line 82: / Line 82: @@
 # '''New Event URL''' - Site relative URL for a public facing form page for submitting a new Event requests. (Example: /new-event-form.cfm)
 # '''CS USERS DSN''' - Where the Calendar will get the Users info for event category notifications. (Default: commonspot-users)
-# '''Send New Event Emails to Category Notification Users''' -
+# '''Send New Event Emails to Category Notification Users''' - a checkbox (Default: unchecked)
-# '''Event Notification From Address''' - The 'From' email address of the notification email sent to event category users
+# '''Event Notification From Address''' - The 'From' email address of the notification email sent to event category users (Default: events@ptcalendar.com)
-# '''Event Notification Email Subject''' - The subject of the notification email sent to event category users
+# '''Event Notification Email Subject''' - The subject of the notification email sent to event category users (Default: Event Submission Notification)
-# '''Event Notification Email Message''' - The standard message for the notification email sent to event category users
+# '''Event Notification Email Message''' - The standard message for the notification email sent to event category users (Default: A calendar event was submitted and the following Event Categories were selected: [EventCats])
-# '''Send Event Approved Email to Contact''' -
+# '''Send Event Approved Email to Contact''' -  a checkbox (Default: unchecked)
-# '''Event Approved Label''' -
+# '''Event Approved Label''' - (Default: Approved)
-# '''Event Approved Email Message''' -
+# '''Event Approved Email Message''' - (Default: This event has been approved.)
-# '''Send Event Denied Email to Contact''' -
+# '''Send Event Denied Email to Contact''' -  a checkbox (Default: unchecked)
-# '''Event Denied Label''' -
+# '''Event Denied Label''' - (Default: Denied)
-# '''Event Denied Email Message''' -
+# '''Event Denied Email Message''' - (Default: This event has been Denied.)
 ===View Page===
-# '''calendarViewPageMode''' -
+# '''calendarViewPageMode''' - radio buttons (Default: Single)
-# '''calenderViews''' -
+# '''calenderViews''' - multiple checkboxes (Default: empty)
-# '''defaultCalendarView''' -
+# '''defaultCalendarView''' - selection list (Default: empty)
-# '''calendarViewParamName''' -
+# '''calendarViewParamName''' - text field (Default: calview)
 ===Rendering and Display Tab===
-# '''App UI Theme''' - The Calendar app utilizes [http://jqueryui.com/themeroller/ jQueryUI Themes] for styling of buttons, etc. There are some pre-installed themes that come with the ADF in the Thirdparty folder.
+# '''App UI Theme''' - The Calendar app utilizes [http://jqueryui.com/themeroller/ jQueryUI Themes] for styling of buttons, etc. There are some pre-installed themes that come with the ADF in the Thirdparty folder. (Default: no default selected)
 # '''Use Event Details Tooltip''' - The Calendar app utilizes [http://craigsworks.com/projects/qtip/ jQuery qTip] for event detail tooltips. (Default: Yes)
 # '''Event Details ToolTip Theme''' -  If using event detail tooltips, select one of the 6 pre-packed themes. (Default: Cream)
@@ Line 114: / Line 114: @@
 ===Performance and Debugging Tab===
-# '''Enable Event Cache''' - (Default: No)
+# '''Calendar Cache Type''' - selection list:(memory, file, database) (Default: no default selected)
-# '''Calendar Cache Type''' - (Default: ''blank'')
+# '''Enable Event Cache''' - checkbox (Default: unchecked)
-# '''Calendar Cache DSN''' - (Default: ''blank'')
+# '''Enable Event Cache for Events Management''' - checkbox (Default: No)
-# '''Enable Verbose Output''' - (Default: No)
+# '''Calendar Cache DSN''' - (Default: ''the name of the current site's content datasource')
 Note: The app configuration fields not listed here should NOT need to be modified from their default values.

@@ Line 64: / Line 64: @@
 Review and update these paths to reference the ADF path.  In most cases, this will just require to be unlocked and a change in the path from the site name to 'ADF'.  Check the paths for the custom field types that were imported with the custom elements by unlocking them and fixing the explicit paths to point to "/ADF/extensions/".
 If the custom elements that are imported contain custom field types that are already in the site, the naming convention for the custom field type will be unique.  To resolve this, unlock the field types and elements, and reassign the element field type to the pre-existing field type.
 Example: The Calendar Event Categories custom element contains the General Chooser field type, if the General Chooser field type is already installed on the site then the import process will attempt to import another General Chooser but with a new name such as "General Chooser_import_1250003208472." To resolve this issue, open the custom element and assign the field type (General Chooser_import_1250003208472) to the field type with the simple name General Chooser. After reassigning the field type, delete the new imported field from the list of custom field types.
 * [[Reset ADF|Reset the ADF]] for the server and site.

@@ Line 10: / Line 10: @@
 == Site Configuration ==
-The Calendar Application is built within the ADF.  The ADF 2.0 or greater must be installed in the site to run the Calendar Application, follow the ADF [[Installation]] instructions.
+The Calendar Application is built within the ADF.  The ADF 2.0 or greater must be installed in the site to run the Calendar 4.0 Application, follow the ADF [[Installation]] instructions.
 * Make sure the ADF is setup and running on the site. If the ADF is not setup, then follow the instructions for ADF [[Installation]].

@@ Line 24: / Line 24: @@
 You have two options: you can either load them into your Base Plus One (recommended) or your can load them into the Calendar Templates you create.
-  '''Note''': the classes and styles defined for the Calendar app are targeted tightly for the layout generated by the Calendar application
+  '''Note''': The classes and styles defined for the Calendar app are targeted tightly for the layout generated by the Calendar application
   and should not interfere with your site styles.  However, it is a good idea to give these styles sheets higher precedence in your
   style definitions.