aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorspalax <spalax@web>2012-06-07 19:38:12 -0400
committeradmin <admin@branchable.com>2012-06-07 19:38:12 -0400
commit5a1e11f4d6a886d75e1fd53f495dc7495d81a66c (patch)
treeb37b4cba7f16f6bdf04ea8afbc2e399b06a2b55a
parent6902dedb2b6b1172e2ea9df3ebb966059dfd5caa (diff)
downloadikiwiki-5a1e11f4d6a886d75e1fd53f495dc7495d81a66c.tar
ikiwiki-5a1e11f4d6a886d75e1fd53f495dc7495d81a66c.tar.gz
Contrib plugin jscalendar : a javascript calendar
-rw-r--r--doc/plugins/contrib/jscalendar.mdwn23
1 files changed, 22 insertions, 1 deletions
diff --git a/doc/plugins/contrib/jscalendar.mdwn b/doc/plugins/contrib/jscalendar.mdwn
index 5c4983a44..a320a0542 100644
--- a/doc/plugins/contrib/jscalendar.mdwn
+++ b/doc/plugins/contrib/jscalendar.mdwn
@@ -2,7 +2,11 @@
# 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
@@ -17,6 +21,23 @@ Jscalendar is a javascript equivalent to the [[calendar|plugins/calendar]] plugi
* As a consequence, every calendar of the wiki must index the same set of pages.
* Javascript :( .
+## Usage
+
+### Directive
+
+ \[[!jscalendar type="month" ]]
+
+### Setup file
+
+It being javascript rather than markdown, most of the configuration must be done in the IkiWiki configuration file rather than in the directive
+
+ 'archivebase' => "evenements/calendrier",
+ 'archive_pagespec' => "evenements/liste/* and ! evenements/liste/*/*",
+ 'week_start_day' => 1,
+ 'month_link' => 1,
+
+## Example
+
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.
Code and documentation can be found here : [[https://atelier.gresille.org/projects/gresille-ikiwiki/wiki/Jscalendar]]