calendar plugin: Autocreate archive pages if needed

[ikiwiki.git] / doc / plugins / calendar.mdwn

diff --git a/doc/plugins/calendar.mdwn b/doc/plugins/calendar.mdwn
index 76e718a3b231d70c3e1b8c28d608c49be225e4fc..efc8ee25c2aa9ad1c6d2cd4261434d9c92d8a542 100644 (file)
--- a/doc/plugins/calendar.mdwn
+++ b/doc/plugins/calendar.mdwn
@@ -1,11 +1,22 @@
-[[!template id=plugin name=calendar author="[[ManojSrivastava]]"]]
-[[!tag type/widget]]
 
 This plugin provides a [[ikiwiki/directive/calendar]] [[ikiwiki/directive]].
 The directive displays a calendar, similar to the typical calendars shown on
 some blogs. 
 
-The [[ikiwiki-calendar]] command is used to keep the calendar up-to-date.
+The [[ikiwiki-calendar]] command is used to force generating year and month
+pages from templates (overriding the existing ones).
+
+## Setup options
+
+* `archivebase` - Default value for [[ikiwiki/directive/calendar]] directive
+  option of the same name.
+* `archive_pagespec` - [[ikiwiki/PageSpec]] of pages to include in the
+  archives, if option `calendar_autocreate` is on. It defaults to `*`.
+* `calendar_autocreate` - Control whether new archive pages are created as
+  needed. It defaults to being done only if (at least) one of options
+  `archivebase` and `calendar_autocreate_commit` are set.
+* `calendar_autocreate_commit` -  If set, causes new archive pages to be
+  checked into version control. Defaults to 1.
 
 ## CSS