Welcome to 2019
[ikiwiki.git] / doc / plugins / contrib / jscalendar.mdwn
1 [[!meta author="spalax"]]
2 [[!template id=plugin name=jscalendar author="[[Louis|spalax]]"]]
3
4 # Jscalendar
5
6 Jscalendar is a javascript equivalent to the [[calendar|plugins/calendar]] plugin.
7
8 ## Description
9
10 Here are some differences compared to this latter plugin.
11
12 * Pros
13   * No need to rebuild the page containing the calendar each time day changes, or
14     a page (indexed by the calendar) is added, changed or deleted. This is
15     particularly useful if you want to have this calendar in the sidebar.
16   * Smooth navigation among months.
17 * Cons
18   * Javascript :( .
19
20 ## Usage
21
22 ### Examples of directive
23
24     \[[!jscalendar type="month" ]]
25
26     \[[!jscalendar type="month" archivebase="calendar"]]
27
28     \[[!jscalendar type="month" year=2014 month=08 pages="posts/* and !posts/*"]]
29
30     \[[!jscalendar type="month" year=-1 month=08]]
31
32 ### Setup file
33
34 This plugin uses the options used by the [[plugins/calendar]] plugin:
35
36     'archivebase' => "archive",
37     'archive_pagespec' => "posts/* and ! posts/*/*",
38     'week_start_day' => 1,
39     'month_link' => 1,
40
41 The `archivebase` and `archive_pagespec` can be overloaded by the very same
42 options of the directive.
43
44 ## Example
45
46 You can see this plugin in action on [[our website|http://www.gresille.org]].
47
48 Code and documentation can be found here : [[https://atelier.gresille.org/projects/gresille-ikiwiki/wiki/Jscalendar]]
49
50 -- Louis