|
|
|
|
|
There are many pages that can be called to display calendars from your website. These pages are named View.html, ViewCal.html, ViewDay.html, ViewList.html, ViewWeek.html, ViewYear.html, and OutputCurrentWeek.html.
OutputCurrentWeek is similar to ViewWeek, but it only writes out the table of events. It provides no navigation facilities. OutputCurrentWeek is provided so that you can include the current week in your HTML using Server Side Includes.
You can add arguments or parameters to your URL when you create links to the calendar. For example, if you want to create a link that will display the Denver Broncos calendar on our website, then you would write:
http://www.mhsoftware.com/caldemo/View.html?calendar_id=2
The ?calendar_id=2 is the argument portion of the link. You can include more than one argument. If you wanted to link to the same calendar but turn off the calendar selection dropdown then you could write the URL as:
http://www.mhsoftware.com/caldemo/View.html?calendar_id=2&dropdown=0
All these pages accept the following arguments.
Parameter Name |
Description |
|---|---|
approved |
If this parameter is not present then all events, approved and unapproved, will be displayed. If this parameter is present and 1, then only approved events will be displayed. If this parameter is present and 0, then only unapproved events will be displayed. |
calendar_id |
ID of Calendar to display. You can find the ID for the calendar on the edit calendar page. |
cal_item_id |
ViewItem.html only, the item ID to view. |
detail |
ViewItem.html only. If 1, additional details are displayed about the event. If 0, fewer details. |
dropdown |
If this parameter is not present, or has a value of 1, then ViewCal and ViewWeek will display a dropdown list of all calendars the operator has permissions to. The set of calendars displayed in the dropdown is the set of calendars the “GUEST User” has permissions for. Set this argument to 0 to hide the dropdown. This argument only works if you are not logged in. |
dtwhen |
ViewItem.html only. Specific date (Julian format) for an event to be displayed in the ViewItem.html page. |
integral |
If this value is 1, the user will be required to login before viewing the calendar. If 0 or not present, Users can anonymously view the calendar. |
item_type_id |
ID of Event Type to display a calendar for. |
offset |
Number of weeks or months to offset the calendar display by. For example, if you call ViewCal with no month and year specified, the calendar for the current month will be displayed. If you call ViewCal with offset=1, then the calendar for the next month will be displayed. Negative values are allowed. |
resource_type_id |
ID of Resource Type to display a calendar for. |
resource_id |
ID of Resource to display a calendar for. |
show_resources |
If this value is 1, then resources associated with the event will be displayed along with the title of the event. |
show_stop |
If this value is 1, then an alternate display format, showing the stop times as part of the event will be displayed. |
style_sheet |
Name of the cascading style sheet to use for the web pages. You can use this to override the default style sheet or the per calendar style sheet. |
If a criteria parameter (calendar_id, resource_id, or resource_type_id), is specified and the value is invalid or the User has no permissions to that Object, then the software will attempt to locate an Object of the same type the User has "View" permissions to, and display it.
If no criteria parameter is specified then the software will find the default calendar value for the User and display it. If at this point nothing is still specified, the page will display a blank calendar.