calendar: add calendar_autocreate option, with which "ikiwiki --refresh" can mostly...

[git.ikiwiki.info.git] / doc / ikiwiki / directive / calendar.mdwn

diff --git a/doc/ikiwiki/directive/calendar.mdwn b/doc/ikiwiki/directive/calendar.mdwn
index 0b2b475fd4fef46d3b905227852a9ca9ce9e4ab5..412285c9799a6ac87115a4c7f17e2a7245be912c 100644 (file)
--- a/doc/ikiwiki/directive/calendar.mdwn
+++ b/doc/ikiwiki/directive/calendar.mdwn
@@ -25,8 +25,22 @@ 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.
 
 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 [[option|plugins/calendar]] `calendar_autocreate` is not set, 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"
+
+
+With [[setup option|plugins/calendar]] `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
 
 
 ## usage