Revision [17045]

This is an old revision of CalendarLinkActionInfo made by MasinAlDujaili on 2007-06-01 06:56:28.

 

not included in Wikka

This is the documentation page for the calendar link action.
 


Documentation


Short description

This action creates relations between pages belonging to the same calendar or displays the next or previous entry of a specified calendar. If provided with a date, it will use this as origin for the parameter link. If provided with an offset, this will first be added (haven't tried negative offsets yet) to date (if provided) or the current day (if parameter date is not provided). After this, the relation will take effect.

Parameters

nametyperequired?defaultdescription
calendarnamestringoptionalcurrent calendar or current userThe calendar base name on which to operate.
linkstringoptionalnextThis can be either 'next' (the default), 'prev', 'following', 'latest' or 'today', where 'next' and 'prev' work only correct if the action is on a calendar entry page, displaying the entry next or previous to the current entry, while 'following' and 'latest' use the current or calculated date and and shows the next upcoming or latest entry in the calendar.
dateintegeroptionalcurrent dateThe relative origin for link mode
offsetintegeroptional0Offset for date calculation [days]


Long description

Place for a longer description.

Usage:
{{calendarlink [calendar="xxx"] [link="next|prev|following"] [date="yyyymmdd"] [offset="[number of days]"]}}


Example:
{{calendarlink calendar="ConCerts" link="following" date="20070601" offset="14"}}


Author
MasinAlDujaili
with code from JavaWoman and DennyShimkoski

To do

 

CategoryUserContributions
There are no comments on this page.
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki