Added plugin infobox
[ikiwiki.git] / doc / plugins / contrib / jscalendar.mdwn
1 [[!template id=plugin name=jscalendar author="Louis Paternault"]]
2
3 # Jscalendar
4
5 Jscalendar is a javascript equivalent to the [[calendar|plugins/calendar]] plugin.
6
7 ## Description
8
9 Here are some differences compared to this latter plugin.
10
11 * Pros
12   * No need to rebuild the page containing the calendar each time day changes, or
13     a page (indexed by the calendar) is added, changed or deleted. This is
14     particularly useful if you want to have this calendar in the sidebar.
15   * Handles the case where several pages appear the same day: a popup appear to let user choose the day he wants.
16   * Smooth navigation among months.
17 * Neutral
18   * Most of options are defined in Ikiwiki's setup files instead of the options
19     of the directive.
20 * Cons
21   * As a consequence, every calendar of the wiki must index the same set of pages.
22   * Javascript :( .
23
24 ## Usage
25
26 ### Directive
27
28     \[[!jscalendar type="month" ]]
29
30 ### Setup file
31
32 It being javascript rather than markdown, most of the configuration must be done in the IkiWiki configuration file rather than in the directive
33
34     'archivebase' => "evenements/calendrier",
35     'archive_pagespec' => "evenements/liste/* and ! evenements/liste/*/*",
36     'week_start_day' => 1,
37     'month_link' => 1,
38
39 ## Example
40
41 You can see this plugin in action on [[our website|http://www.gresille.org]]. To see what happens when several pages happens on the same day, check the 15th of March 2012.
42
43 Code and documentation can be found here : [[https://atelier.gresille.org/projects/gresille-ikiwiki/wiki/Jscalendar]]
44
45 -- Louis