Calendar Link Parameters

Calendar settings is where you configure your calendar. These settings apply to all users globally. What if the global settings are not quite right for all users? Calendar link parameters allow you to overwrite global settings. Currently, the following parameters are supported:

  • date: Overwrite the default start date of the calendar.
  • view: Overwrite the default view of the calendar.
  • sidepanel: Overwrite the visibility of the left side panel.
  • lang: Overwrite the default language of the calendar.
  • tz: Force the timezone of the calendar to a specific value.
  • refresh: Configure the calendar to automatically refresh.
  • showLogo: Show or hide the logo.
  • showTitle: Show or hide the calendar title.
  • title: Overwrites the default calendar title.

Example:

Please note that the preferred way to configure your calendar is to use the settings application. The link parameters described in this document are meant to be used for exceptional cases only.

DATE PARAMETER

Configures the date that is initially set when the calendar is loaded.

date=yyyy-mm-dd Sets start date to a specific date, e.g. date=2013-09-09. The is useful for calendars that are used to plan for a specific event, like a conference.
date=y1 Sets start date to January 1 of the current year.
date=q1 Sets start date to the first day of the current quarter.
date=m1 Sets start date to the first day of the current month.
date=+1day Sets start date to tomorrow.
date=+3days Sets start date to three days from now.
date=+2weeks Sets start date to two weeks from now.
date=+1month Sets start date to one month from now.
date=+3months Sets start date to three days from now.
date=-1month Sets start date to one month in the past.
date=-1week Sets start date to one week in the past.
date=+1year Sets start date to one year from now.

Examples:

VIEW PARAMETER

Configures the view that is initially shown when the calendar is loaded.

view=d Start with daily view.
view=md Start with multi-day view. The number of days is read from the settings.
view=md<n> Start with multi-day view showing <n> days. <n> takes values between 2 and 6, for example view=md6.
view=w Start with weekly view.
view=mw Start with multi-week view. The number of weeks is read from the settings.
view=mw<n> Start with multi-week view showing <n> weeks. <n> takes values from 1 to 12, for example view=mw2.
view=m Start with monthly view.
view=y<n>m Start with year view showing <n> months. <n> takes values between 1 and 12. Example: view=y6m
view=a Start with agenda view.
view=l Start with list view.
view=s Start with scheduler view.

Examples:

SIDE PANEL PARAMETER

Configures the visibility of the side panel when the calendar is initially started.

sidepanel=c Start with side panel collapsed.
sidepanel=v Start with side panel visible.

Example:

LANGUAGE PARAMETER

Configures the user interface language of the calendar.

lang=zh_TW Chinese (traditional)
lang=en English US
lang=en_GB English GB
lang=fr French
lang=de German
lang=hu Hungarian
lang=pt_PT Portuguese (Portugal)
lang=es Spanish

Example:

TIMEZONE PARAMETER

Forces the timezone of the calendar to a specific value.

Note that the preferred way to set the timezone is to use the timezone configuration dialog in the menu. This parameter is only needed for exceptional cases, for example when the calendar is run on a display screen.

tz=Asia/Tokyo Supported values for the tz parameter are the official timezone identifiers as defined in the timezone database maintained by IANA.
Note that the timezone database in many cases defines multiple identifiers for the same timezone. In those cases, only the main identifier is supported by Teamup. Furthermore, timezones that are not used anymore today are not supported.

Example:

REFRESH PARAMETER – Premium Feature

The refresh parameter can be used to activate a periodic refresh of the calendar. This parameter is only supported with the Premium plan.

Note that this parameter is only needed for exceptional use cases, for example when the calendar is run on an unattended display screen. In normal use, the calendar is automatically refreshed when the users interacts with the calendar.

refresh=n Where n is the number of minutes between refreshes of the calendar.

Example:

SHOWLOGO PARAMETER

Configures if the logo is hidden or shown.

Note: If both showLogo=0 and showTitle=0, then no header is shown at all. This is often the desired configuration if the calendar is embedded into a web page.

showLogo=1 Show logo
showLogo=0 Hide logo

Example:

SHOWTITLE PARAMETER

Configures if the title is hidden or shown.

Note: If both showLogo=0 and showTitle=0, then no header is shown at all. This is often the desired configuration if the calendar is embedded into a web page.

showTitle=1 Show title
showTitle=0 Hide title

Example:

TITLE PARAMETER

Configures the title used for the calendar. This settings is particularly useful if you are sharing only selected sub-calendars of your calendar and want to properly name the shared calendar.

title=My+custom+title Overwrites the default calendar title with the string “My custom title”. Note that + characters are turned in space characters.

Example:

http://teamup.com/ks48cf2135e7e080bc?title=My+custom+title

 

Examples with Multiple Parameters

 

Keywords: auto-refresh, auto refresh, disable header, reduce space, collapse, minimize, maximize

Tagged:

Rate This Article

Up Down
(33 out of 37 people found this article helpful)