From cd8fefb0ef4d45b9113e09cf42998c7d1fbe7541 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Thu, 21 Sep 2017 12:15:45 +0200 Subject: Sync with ikiwiki 3.20150107. --- ikiwiki/directive/calendar.mdwn | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) (limited to 'ikiwiki') diff --git a/ikiwiki/directive/calendar.mdwn b/ikiwiki/directive/calendar.mdwn index cb40f88..4c2b99c 100644 --- a/ikiwiki/directive/calendar.mdwn +++ b/ikiwiki/directive/calendar.mdwn @@ -25,14 +25,23 @@ 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. +## Generating archive pages + +If [[!iki plugins/calendar desc=option]] `calendar_autocreate` is not set, the +[[!iki 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" + 0 0 * * * ikiwiki-calendar ~/ikiwiki.setup "posts/* and !*/Discussion" + + +With [[!iki plugins/calendar desc="setup option"]] `calendar_autocreate`, +all this work is done by `ikiwiki` itself. Thus, the crontab command can be +replaced by: + + 0 0 * * * ikiwiki --setup ~/ikiwiki.setup --refresh ## usage @@ -45,7 +54,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` [[!iki plugins/calendar desc="setup option"]]. * `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 -- cgit v1.2.3