diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ikiwiki-calendar.mdwn | 7 | ||||
-rw-r--r-- | doc/ikiwiki/directive/calendar.mdwn | 12 | ||||
-rw-r--r-- | doc/plugins/calendar.mdwn | 17 |
3 files changed, 24 insertions, 12 deletions
diff --git a/doc/ikiwiki-calendar.mdwn b/doc/ikiwiki-calendar.mdwn index d311a1859..fd3244694 100644 --- a/doc/ikiwiki-calendar.mdwn +++ b/doc/ikiwiki-calendar.mdwn @@ -46,6 +46,13 @@ An example crontab: This command uses two [[templates]] to generate the pages, `calendarmonth.tmpl` and `calendaryear.tmpl`. +# [[plugins/calendar]] setup option + +Most of the goals of this command can be replaced by setting up +`calendar_autocreate` setup option (of plugin [[plugins/calendar]]), and +running `ikiwiki -setup you.setup`. The only thing that `ikiwiki-calendar` can +do and that `ikiwiki` cannot is forcing page generation (using `-f` switch). + # AUTHOR Joey Hess <joey@ikiwiki.info> diff --git a/doc/ikiwiki/directive/calendar.mdwn b/doc/ikiwiki/directive/calendar.mdwn index cb40f884e..0b2b475fd 100644 --- a/doc/ikiwiki/directive/calendar.mdwn +++ b/doc/ikiwiki/directive/calendar.mdwn @@ -25,14 +25,8 @@ in the sidebar, you'll also need to create these archive pages. They typically use this directive to display a calendar, and also use [[inline]] to display or list pages created in the given time frame. -The `ikiwiki-calendar` command can be used to automatically generate the -archive pages. It also refreshes the wiki, updating the calendars to -highlight the current day. This command is typically run at midnight from -cron. - -An example crontab: - - 0 0 * * * ikiwiki-calendar ~/ikiwiki.setup "posts/* and !*/Discussion" +The `calendar_autocreate` [[setup option|plugins/calendar]] can be used to +automatically generate the archive pages. ## usage @@ -45,7 +39,7 @@ An example crontab: for the whole wiki by setting `archivebase` in ikiwiki's setup file. Calendars link to pages under here, with names like "2010/04" and "2010". These pages can be automatically created using the - `ikiwiki-calendar` program. + `calendar_autocreate` [[setup option|plugins/calendar]]. * `year` - The year for which the calendar is requested. Defaults to the current year. Can also use -1 to refer to last year, and so on. * `month` - The numeric month for which the calendar is requested, in the 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 |