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 e9216e11fd5f8b8e691db473b92a2d1b05e88f10..412285c9799a6ac87115a4c7f17e2a7245be912c 100644 (file)
--- a/doc/ikiwiki/directive/calendar.mdwn
+++ b/doc/ikiwiki/directive/calendar.mdwn
@@ -25,14 +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.
 
-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:
+## 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"
+    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
 
@@ -45,7 +53,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