Wikka Documentation: CalendarActionInfo

[1861] Latest edit on 2009-01-31 02:04:48 by DarTar [Removed carriage return]

No Differences

[1312] Edited on 2008-11-01 23:23:06 by DarTar [Removed HomePage link]

Deletions:
~~HomePage~~

[994] Edited on 2008-03-19 09:34:59 by DarTar [layout]

Additions:
This is the documentation page for the calendar action.
Development: JwCalendar (with source code, and some background and discussion).

NOTE

This feature is available since:
WikkaWiki 1.1.6.0

Deletions:
~~Development: JwCalendar (with source code, and some background and discussion).~~

This is the documentation page for the Calendar action.

[993] Edited on 2008-03-19 08:40:34 by DarTar [layout]

Additions:

Usage

{{calendar [year="yyyy"] [month="mm"]}}

Deletions:

Parameters
name	type	required?	default	description
year	integer	optional	current year	4-digit year of the month to be displayed; the default can be overridden by providing a URL parameter 'year'
month	integer	optional	current month	number of month (1 or 2 digits) to be displayed; the default can be overridden by providing a URL parameter 'month'

Once the planned 'autodoc' feature for actions is "live", this page will contain the automatically-generated documentation by just including an action; for now, I've just manually created the text.

Parameters

name	type	required?	default	description
year	integer	optional	current year	4-digit year of the month to be displayed; the default can be overridden by providing a URL parameter 'year'
month	integer	optional	current month	number of month (1 or 2 digits) to be displayed; the default can be overridden by providing a URL parameter 'month'

Usage:

{{calendar [year="yyyy"] [month="mm"]}}

[788] Edited on 2008-02-21 13:07:04 by NilsLindenberg [clarification on supported date range]

Additions:
Display a calendar face for a specified or the current month. Currently, only years between 1970 and 2037 are supported - earliest timestamp PHP can handle (Windows and some others - to be safe).
Deletions:
~~Display a calendar face for a specified or the current month.~~

[787] Edited on 2008-02-21 13:01:34 by DarTar [adding examples]

Additions:

Credits

Examples

{{calendar}}

February 2012
Sun	Mon	Tue	Wed	Thu	Fri	Sat
			1	2	3	4
5	6	7	8	9	10	11
12	13	14	15	16	17	18
19	20	21	22	23	24	25
26	27	28	29
<<	=	>>

{{calendar month="12" year="1982"}}

December 1982
Sun	Mon	Tue	Wed	Thu	Fri	Sat
			1	2	3	4
5	6	7	8	9	10	11
12	13	14	15	16	17	18
19	20	21	22	23	24	25
26	27	28	29	30	31

Deletions:
~~Credit:~~

[292] Edited on 2006-11-19 09:02:29 by YanB [updated links + cat.]

Additions:
HomePage
Development: JwCalendar (with source code, and some background and discussion).

This is the documentation page for the Calendar action.

GmBowen (first draft)
JavaWoman (more modifications)
CategoryEN
Deletions:
Wikka Documentation
Note: this action is included in Wikka as of version 1.1.6.0.
Development: JwCalendar (with source code, and some background and discussion).

This is the documentation page for the Calendar action.

GmBowen (first draft)
JavaWoman (more modifications)
CategoryDocumentation

[56] The oldest known version of this page was created on 2005-03-02 14:52:49 by NilsLindenberg [layout]

History of recent changes for CalendarActionInfo

Wikka Documentation

Calendar Action Documentation

Note: this action is included in Wikka as of version 1.1.6.0.

Documentation

Short description

Display a calendar face for a specified or the current month.

Parameters

name	type	required?	default	description
year	integer	optional	current year	4-digit year of the month to be displayed; the default can be overridden by providing a URL parameter 'year'
month	integer	optional	current month	number of month (1 or 2 digits) to be displayed; the default can be overridden by providing a URL parameter 'month'

Long description

Specifying a month and/or year in the action itself results in a "static" calendar face without navigation; conversely, providing no parameters in the action results in a calendar face with navigation links to previous, current and next month, with URL parameters determining which month is shown (with the current month as default).

You can have one "dynamic" (navigable) calendar on a page (multiple ones would just be the same) and any number of "static" calendars.

The current date (if visible) gets a special class to allow a different styling with CSS.

Usage:

{{calendar [year="yyyy"] [month="mm"]}}

Credit:
This action was inspired mainly by the "Calendar Menu" code written by Marcus Kazmierczak (© 1998-2002 Astonish Inc.) which we traced back as being the ultimate origin of this code although our starting point was actually a (probably second-hand) variant found on the web which did not contain any attribution.
However, not much of the original code is left in this version. Nevertheless, credit to Marcus Kazmierczak for the original that inspired this, however indirectly: Thanks!

Author

GmBowen (first draft)
JavaWoman (more modifications)

CategoryDocumentation