diff options
Diffstat (limited to 'doc/plugins/calendar.mdwn')
| -rw-r--r-- | doc/plugins/calendar.mdwn | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/doc/plugins/calendar.mdwn b/doc/plugins/calendar.mdwn index 76e718a3b..efc8ee25c 100644 --- 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 |