X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/8a8e54f3f61721b40c60712c4c5c0cefd049502e..2b1857135def154369e4ee33a565861272643b43:/doc/plugins/contrib/jscalendar.mdwn diff --git a/doc/plugins/contrib/jscalendar.mdwn b/doc/plugins/contrib/jscalendar.mdwn index a320a0542..8123b3132 100644 --- a/doc/plugins/contrib/jscalendar.mdwn +++ b/doc/plugins/contrib/jscalendar.mdwn @@ -1,4 +1,5 @@ -[[!meta title="Javascript equivalent of plugin 'calendar'"]] +[[!meta author="spalax"]] +[[!template id=plugin name=jscalendar author="[[Louis|spalax]]"]] # Jscalendar @@ -12,33 +13,37 @@ Here are some differences compared to this latter plugin. * 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 :( . ## Usage -### Directive +### 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 -It being javascript rather than markdown, most of the configuration must be done in the IkiWiki configuration file rather than in the directive +This plugin uses the options used by the [[plugins/calendar]] plugin: - 'archivebase' => "evenements/calendrier", - 'archive_pagespec' => "evenements/liste/* and ! evenements/liste/*/*", + '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]]. To see what happens when several pages happens on the same day, check the 15th of March 2012. +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]]