Help:Eventcalendar format

From semantic-mediawiki.org
(Redirected from Eventcalendar)
Jump to: navigation, search
Eventcalendar format
Has description::An event calendar with different views of displaying days and events
Available languages
Expression error: Unrecognized punctuation character "{".
Scenarios, examples, demos
Example: Demo:Event calendar, SMWCon Fall 2012/Calendar
Image collection
{{#ask: has image collection::eventcalendar|?has description|widths=220|heights=220|format=gallery|order=random|widget=slideshow|overlay=yes|class=demo-center|navigation=auto|autocaptions=no}}
{{#subobject:|Has video url=https://vimeo.com/57123588%7CHas description=Short video how to use the event calendar|Has video type=informational|Has video provider=Vimeo|Has video id=57123588 }}
Further Information
Provided by: Semantic Result Formats
Added: Has minimum version::1.8.0
Removed: Has maximum version::still supported
Requirements: Has further requirements::none
Format name: Has format name::eventcalendar
Enabled by default: {{#info:Indicates whether the result format is enabled by default upon installation of the respective extension.}} Is enabled by default::Yes
Authors: {{#set:Has author=James Hong Kong}}James Hong Kong
Categories: {{#ask: Has category::time Docinfo status::effective[[Docinfo language::{{#show:Help:Eventcalendar format|?Docinfo language|link=none|format=list}}]] ?Has description format=broadtable headers=show link=all class=sortable wikitable smwtable offset= searchlabel=time limit=0

}}

Group: {{#set:Has group=events}}{{#ask:Has group::events|?Has description|limit=0|searchlabel=events|format=datatables}} , {{#set:Has group=interaction}}{{#ask:Has group::interaction|?Has description|limit=0|searchlabel=interaction|format=datatables}} , {{#set:Has group=smwapi}}{{#ask:Has group::smwapi|?Has description|limit=0|searchlabel=smwapi|format=datatables}} , {{#set:Has group=ajax}}{{#ask:Has group::ajax|?Has description|limit=0|searchlabel=ajax|format=datatables}}
Class: SRFEventCalendar
Folder: Commit history
Folder tree
Table of Contents

↓ INFO ↓

The result format eventcalendar makes use of the jquery.fullcalendar plugin to generate an event calendar with different views ('month', 'basicweek', 'basicday', 'agendaweek', 'agendaday') to choose from.

Parameters

General

{{#smwdoc:eventcalendar|parameters=base}}

Format specific

{{#smwdoc:eventcalendar|parameters=specific}}

NoteNote:  Available values for the parameters:

  • defaultview: month, basicweek, basicday, agendaweek, agendaday
  • firstday: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
  • start: current, earliest, latest
  • legend: none, top, bottom, tooltip, pane
  • theme: basic, vector

Usage

Data model

It is recommended that an event entity is represented by an subobject to allow individual events to be placed within the same page source and to separate source from data.

An event is specified as a single entity represented by a title, start date, end date (optional), color (optional), icon (optional), and/or description (optional). This data model stipulates that a subject (page) contains one event or in case it contains several events those events are represented as individual subobjects within the same page.

If you want to generate recurring events, please have a look at the #set_recurring_event function.

Column 0 Column 1 Column 2 Column 3 Column 4 Column 5 Column N
Purpose Event Start date/time End date/time Icon Color Description ...
Datatype text/page date date page text text/page ...
Role data (mandatory) data (mandatory) data (optional) data (optional) data (optional) data (optional) ...
Example Lorem ipsum dolor 10 Aug 2012 06:00 10 Aug 2012 14:00 File:event-schedule.jpg #f00, #ff0000, rgb(255,0,0), or red Lorem ipsum dolor ... ...
Note Color properties should be of type text to avoid any potential issues caused by color definitions such as #ff0000

Styling

A property can describe a color or icon and be assigned to an individual event.

Icon

Icons are expected to be uploaded and available within the wiki itself. The event calendar will not make any transformations of icons and therefore any icon uploaded should have an appropriated size to enable a normal display behavior.

Properties that carry a special meaning can be variable within a query while its identifier remain fixed without the need for extra parameters (Fixed identifiers are title, icon, color) resulting in a query like

...
|?Has event icon=icon
|?Has color=color
|?Event=title
...
Height
/* Event calendar help class */ 
.smw-eventcalendar {
  width:100%;
  height:350px;
}
{{#ask:
...
|class=smw-eventcalendar
...
}}

Calendar start

"current" (default) determines the initial calendar start as the current year/month/day.

"earliest" can be used where planned events are outside of the current month and the calendar display should reflect the earliest event within those selected events. This option allows to show events beyond the current month without having to browse its earliest entity.

SRF 1.9

Changes deployed with SRF 1.9 are far reaching both internally and visual therefore it might happen that some "glitches" sustained after testing but we don't expect major interruptions.

If I have time I will write some more otherwise this is a wiki, please help to enhance the documentation.

Filtering option

In case the calendar uses the color option to indicate different typological content (events), a filtering option can be used to filter events through a property (location, type etc.) that is semantically linked by its color.

The parameter |legend is responsible for the positioning of the portlet that is used to display the content. Available options are top, bottom, tooltip, pane, or none.

{{#ask ...
|?Has Location
|format=eventcalendar
|legend=top

User preferences

Event calendar user preferences are described here.

Examples

{{#ask:|?Has description|headers=hide|format=ul}}

{{#subobject:|has category=User preferences|has release=SRF 1.9.0|has context=Help:Eventcalendar format|has description=Enable automatic updates during a page refresh|has url=N/A|has user preference=srf-prefs-eventcalendar-options-update-default|Is default=no }}
{{#subobject:|has category=User preferences|has release=SRF 1.9.0|has context=Help:Eventcalendar format|has description=Enable the pane view by default|has url=N/A|has user preference=srf-prefs-eventcalendar-options-paneview-default|Is default=no }}
{{#subobject:jquery.fullcalendar.js|Has group=Plugin|has title=jquery.fullcalendar.js|Has URL=http://arshaw.com/fullcalendar/%7CHas description=provides a full-sized, interactive drag & drop calendar }}{{#subobject:jquery.fullcalendar.js|Has license=MIT}}, {{#subobject:jquery.fullcalendar.js|Has license=GPL Version 2 licenses}}


{{#set: |docinfo status=effective }}{{#set: |worn by =Template:Docinfo |warning =Master page updated }}{{#set:

|worn by =Template:Docinfo
|warning =No description
}}{{#set:

|revision id=46897 |namespace=Help |docinfo progress =100 |docinfo priority =3 }}{{#set:docinfo master page=Help:Eventcalendar format }}{{#set:docinfo master rev =46897 }}{{#set:docinfo category=-}}{{#set:docinfo author=User:MWJames}}{{#set:docinfo editor=User:Kghbln}}{{#set:docinfo support=-}}{{#set:docinfo language=en}}

This documentation page applies to all SMW versions from 1.8.0 to the most current version.
Other versions: {{#ask: Docinfo master page::Help:Eventcalendar format Docinfo language::en from version::!1.8.0|
   ?from version = |
   ?to version = |
   sort = from version|
   order = desc|
   link=none|
   format=list|
   sep=, |
   template=versionlink|
   limit = 3|
   searchlabel = […]
  }}       Other languages: {{#ask: Docinfo master page::Help:Eventcalendar format from version::1.8.0 Docinfo language::!en|
  ?Docinfo language =|
  link=none|
  format=list|
  sep=, |
  template=languagelink|
  sort = Docinfo language|
  order = asc|
  limit = 10|
  searchlabel = […]
}}

Docinfo master page::Help:Eventcalendar format Docinfo language::en from version::1.8.0

{{#set:Release status=current}}

{{#set:Is master page=true}}