Change Projects link to point to projects DB

[ikiwiki.git] / doc / plugins / contrib / jscalendar.mdwn

diff --git a/doc/plugins/contrib/jscalendar.mdwn b/doc/plugins/contrib/jscalendar.mdwn
index 5c4983a4490864afa572346844d579c79c78a609..8123b313243cb3657d878c3985767c31e088b547 100644 (file)
--- a/doc/plugins/contrib/jscalendar.mdwn
+++ b/doc/plugins/contrib/jscalendar.mdwn
@@ -1,23 +1,49 @@
-[[!meta title="Javascript equivalent of plugin 'calendar'"]]
+[[!meta author="spalax"]]
+[[!template id=plugin name=jscalendar author="[[Louis|spalax]]"]]
 
 # Jscalendar
 
-Jscalendar is a javascript equivalent to the [[calendar|plugins/calendar]] plugin. Here are some differences compared to this latter plugin.
+Jscalendar is a javascript equivalent to the [[calendar|plugins/calendar]] plugin.
+
+## Description
+
+Here are some differences compared to this latter plugin.
 
 * Pros
   * No need to rebuild the page containing the calendar each time day changes, or
     a page (indexed by the calendar) is added, changed or deleted. This is
     particularly useful if you want to have this calendar in the sidebar.
-  * Handles the case where several pages appear the same day: a popup appear to let user choose the day he wants.
   * Smooth navigation among months.
-* Neutral
-  * Most of options are defined in Ikiwiki's setup files instead of the options
-    of the directive.
 * Cons
-  * As a consequence, every calendar of the wiki must index the same set of pages.
   * Javascript :( .
 
-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.
+## Usage
+
+### Examples of directive
+
+    \[[!jscalendar type="month" ]]
+
+    \[[!jscalendar type="month" archivebase="calendar"]]
+
+    \[[!jscalendar type="month" year=2014 month=08 pages="posts/* and !posts/*"]]
+
+    \[[!jscalendar type="month" year=-1 month=08]]
+
+### Setup file
+
+This plugin uses the options used by the [[plugins/calendar]] plugin:
+
+    'archivebase' => "archive",
+    'archive_pagespec' => "posts/* and ! posts/*/*",
+    'week_start_day' => 1,
+    'month_link' => 1,
+
+The `archivebase` and `archive_pagespec` can be overloaded by the very same
+options of the directive.
+
+## Example
+
+You can see this plugin in action on [[our website|http://www.gresille.org]].
 
 Code and documentation can be found here : [[https://atelier.gresille.org/projects/gresille-ikiwiki/wiki/Jscalendar]]