Help:Calendar format

From semantic-mediawiki.org
Jump to: navigation, search
Calendar format
Displays time-associated pages on a calendar
Available languages
deenzh-hans
Scenarios, examples, demos
Example: Calendar
Further Information
Provided by: Semantic Result Formats
Added: 1.4.0
Removed: still supported
Requirements: none
Format name: calendar
Enabled by default: Indicates whether the result format is enabled by default upon installation of the respective extension. yes
Authors: Yaron Koren
Categories: time
Group:
Table of Contents

↓ INFO ↓

The result format calendar, part of the Semantic MediaWiki extension, can be used to display pages that have an associated time, for example events, on a calendar.

In SRF 1.8 the event calendar format was introduced as an furhter alternative.

Parameters

Parameter Type Default Description
lang text no The code for the language in which to display the calendar
template text empty <srf-paramdesc-template>
userparam text empty <srf-paramdesc-userparam>
color text empty <srf-paramdesc-color>
colors text empty The color to display for each date property (example: "Start date=>green,End date=>#09c")

Usage

A query in calendar format should be called in the following way:

{{#ask:
  [[Category:Events]]
  [[Has date::>{{#calendarstartdate:}}]]
  [[Has date::<{{#calendarenddate:}}]]
  |? Has date
  |format=calendar
}}

...in other words, the date property being queried against should also be used to filter dates: #calendarstartdate and #calendarenddate will return the first and last date (actually, the day after the last date), respectively, for any specific month. This is done so that only those dates that are within the current month, instead of all of them, are passed in to be displayed by the calendar.

Some notes on creating such queries:

  • Make sure to include the colon, ':', in the #calendarstartdate and #calendarenddate parser function calls; otherwise, they won't work.
  • Don't worry that the comparison operators are '<' and '>' instead of '<=' and '>='; the return values of the parser functions are set so that this will not be an issue
  • You can also add a "sort=" parameter, like "sort=Has date", so that events within each day will be sorted according to the time they take place (assuming the "Has date" property in this case also includes a time value.)

Display options

You can set the color the entries are marked with by adding the color option in the query:

| color=red

Different colors for each set of events can be displayed by using Semantic Compound Queries.

The option template = <template name>, can be used to alter the display of a calendar item/event display:

| format=calendar
| template= ''<...>''

For more information about the template used, see the help page on the template format

As of SRF 1.6.0, you can also set the day of the week on which weeks begin (by default it's Sunday), across the entire wiki, by setting the variable $srfgFirstDayOfWeek in LocalSettings.php, after the inclusion of Semantic Result Formats. To change it to Monday, for instance, you would add the following, if using an English-language wiki:

$srfgFirstDayOfWeek = 'monday';
Note: The day has to be set in the language of the wiki. Depending on the language this value may also be capitalised, e.g. for German installations.

Changing the results limit

The default limit of results displayed by an inline query is 20. If you have more than 20 events in any month, you should add a 'limit=' parameter to the query, with a number greater than the maximum number you have. An example is:

{{#ask:
  [[Category:Events]]
  [[Has date::>{{#calendarstartdate:}}]]
  [[Has date::<{{#calendarenddate:}}]]
  |? Has date
  |format=calendar
  |limit=300
}}
If the number of events you have in any month is greater than 500, though, you will need to take a second step - add the following line to your LocalSettings.php file, after the inclusion of Semantic MediaWiki:
$smwgQMaxInlineLimit = 1000;
Note: The value can be any number greater than the maximum number of events you have per month.

Example

  • News items displayed using the calendar format

See also


This documentation page applies to all SMW versions from 1.6.0 to the most current version.
Other versions: 1.4.0 – 1.5.6       Other languages: defrzh-hans

Help:Calendar format en 1.6.0