diff options
| author | Louis <spalax@gresille.org> | 2014-06-18 18:38:33 +0200 |
|---|---|---|
| committer | Louis <spalax@gresille.org> | 2014-06-24 15:17:51 +0200 |
| commit | 2a5e8e72a0dcefd0a5c0ca844ea108154f892d61 (patch) | |
| tree | 85460ff45eff220ce29291c76acb5d6ab9050af4 /doc/plugins | |
| parent | 236c63d5b68c2fe57a87b952bd9968ff685c86a2 (diff) | |
| download | ikiwiki-2a5e8e72a0dcefd0a5c0ca844ea108154f892d61.tar ikiwiki-2a5e8e72a0dcefd0a5c0ca844ea108154f892d61.tar.gz | |
calendar plugin: Autocreate archive pages if needed
Diffstat (limited to 'doc/plugins')
| -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 |