X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/2a5e8e72a0dcefd0a5c0ca844ea108154f892d61..b199349ffddce2b8afd89567882e182f7ef9bff1:/doc/ikiwiki/directive/calendar.mdwn diff --git a/doc/ikiwiki/directive/calendar.mdwn b/doc/ikiwiki/directive/calendar.mdwn index 0b2b475fd..4c2b99ccb 100644 --- a/doc/ikiwiki/directive/calendar.mdwn +++ b/doc/ikiwiki/directive/calendar.mdwn @@ -25,8 +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 `calendar_autocreate` [[setup option|plugins/calendar]] can be used to -automatically generate the archive pages. +## 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" + + +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 @@ -39,7 +54,7 @@ automatically generate the archive pages. 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 - `calendar_autocreate` [[setup option|plugins/calendar]]. + `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