Home arrow Documentation arrow Integration arrow Using the Calendar Publisher
Home
FAQ
Documentation
Forums
License Key
Using the Calendar Publisher Print
This tutorial covers the following topics:



Detailed Explanation of Each Option
  • General

    • Calendar
      Select the claendar you which Thyme to use.

    • View
      This tells Thyme what to display. Options are Day, Week, Month, Year and Mini Month.

    • Date
      This is the date Thyme will be set to. If 'set to current date' is checked, this date is ignored. If it is unchecked, Thyme will always display the selected date.

    • Week Starts On
      The weekday that our calendar will start on.

    • Hour Format
      The format of hours displayed by Thyme. 12 hour format displays an AM/PM or equivalent. 24 hr format displays time as the number of minutes/hours since the day began. E.g. 2:30 PM would be displayed as 14:30.

    • Static
      With this option checked, Thyme will not display any links that may change the view. For instance, when viewing a month from within Thyme, you may click on a day number of that month and Thyme will take you to the day view of that day. This option will disable such functionality.

    • Highlight Day
      This tells Thyme to highlight the selected or current day.

    • Highlight Week
      This tells Thyme to highlight the selected or current week. This option is normally only used when viewing a Mini Month calendar and navigating through weeks.

    • Width
      The width Thyme will not exceed. If left blank, Thyme will be set to 100% width.

  • Style Editor

    • Theme
      This tells Thyme which theme to use. If you plan on using the Style Editor to alter Thyme's appearance, it is recommended that you use the 'default' theme.

    • Apply Style From
      This tells Thyme where it should get it's style options from.

  • Events

    • Show Events
      This option tells Thyme that you wish it to display events. If using a Mini Month calendar, this means that days with events are displayed in bold.

    • Event Notes Popup
      This will display a tooltip like popup containing an event's notes when you hover your mouse over an event. This has no effect in a Mini Month calendar.

    • Event Links
      This will make event titles a clickable link. This option has no effect in a Mini Month calendar as actual event titles are never displayed.

    • Event Popup
      If 'Event Links' is selected, this will make the links a JavaScript popup which displays the event information. The style of this popup will be the same as the Guest User's theme. If this is undesireable, you may wish to change the 'Event Link URL' option and create your own event view page.

    • Event Link URL
      This is the URL Thyme will use for each Event Link and will be passed a query string containing eid and instance. eid is the ID of the event and instance is the date in YYYY-MM-DD format. These are noted by %eid and %inst. E.g.

      http://mysite.com/sales/view_sale.php?eid=%eid&instance=%inst

      entered here, may yield:

      http://mysite.com/sales/view_sale.php?eid=56&instance=2005-10-26

      for an event link. For more information on setting your own Event Link URL, see the Thyme Tutorial on custom event views.

  • Locale

    • Timezone
      This is the Timezone Thyme will use for determining it's date/time.

    • Daylight Savings Time
      This is the Daylight Savings Time Thyme will use to determin it's date/time.

  • Header

    • Show Header
      This tells Thyme that you wish it to display a header. If you wish to print things in your header that are beyond the scope of the Calendar Publisher, you may uncheck this option and create your own header.

    • Align Header Text
      Text alignment of the header.

    • Header Text
      Actual text of the header. The following strings are translated

      • %mday - day of the month, e.g. 1 - 31
      • %weekday - the weekday name, e.g. Friday
      • %month - month name, e.g. February
      • %mon - month number, e.g. 12
      • %year - year number, e.g. 2005
      So a header text set to 'Birthdays in %month' may yield "Birthdays in November"

    • Show Header Links
      This will display 'Previous' and 'Next' links in Thyme's header that will allow someone to navigate to the previous or next iteration of that time span.

    • 'Previous' Link
      This is the text or image url that you wish Thyme to display for the 'Previous' link in it's header. If you leave it blank, it will use the image from the currently selected theme.

    • 'Next' Link
      This is the text or image url that you wish Thyme to display for the 'Next' link in it's header. If you leave it blank, it will use the image from the currently selected theme.

  • Day View

    • Time Intervals
      This will esentially tell Thyme how many rows to display for each hour. If set to 15 minutes, Thyme will display 4 rows for every work hour. If set to 30, it will display 2 rows for every hour. etc..

    • Work Hours
      This is the Start and End time of the day view. If there is an event that starts before the selected start time or ends after the selected end time on that day, the day view will be stretched to fit it (or them).

  • Month VIews


    • Show Weeks
      Show week numbers next to weeks in a Month View. Note that this has no effect on a Mini Month as it will never show week numbers.

    • Row Height
      This is the default height of each day. If left blank, it will default to '90' for a Month, and '0' for a Mini Month. Mini Month days would then stretch to fit the day numbers.

    • Limit Weekday Names To
      The length of weekday names in the weekday header. The default is to not abbreviate weekday names.

    • Exclude Days Not In Month
      Do not print content for days that are outside of the current month

    • Event Size
      Size of events in the event view.

    • Collapse Events
      Collapse event titles that would extend the size of an event table. The event will extend to display the full title on-mouse-over.

    • Mini Month Date URL
      The link that clicking on a day in a mini month calendar will point to. This replaces the following strings:

      • %d - the day number
      • %m - the month number
      • %y - the year number


      E.g. if set to
      http://www.myserver.com/page.php?day=%d&month=%m&year=%y

      it may yield

      http://www.myserver.com/page.php?day=23&month=11&year=2004

      or you may even use a JavaScript function.

      E.g. javascript:myFunction(%y,%m,%d)

      The default is a link to the current page that sets:

      • m = %m
      • d = %d
      • y = %y
      E.g. index.php?d=23&m=11&y=2004

      Using this option, it is possible to create your own navigation calendar for your own custom site or calendar.



Using the Style Editor
There are very few things to note about using the Style Editor as it is self explanitory and intiutive. No HTML or programming experience is required, however, it is helpful.

Previews generated while editing the style of an element are as close as we could get to actual results. To view actual results, click the 'Update' button and view the 'Preview' section.

Note that when using the color picker, there is also a drop down select box of recently used colors that you may choose from. You may also note that when editing a color, clicking on '-' (minus) will cause a color to become darker, and clicking on '+' will cause a color to become lighter.