calendar plugin: Autocreate archive pages if needed

[ikiwiki.git] / doc / ikiwiki-calendar.mdwn

diff --git a/doc/ikiwiki-calendar.mdwn b/doc/ikiwiki-calendar.mdwn
index c1f4d72670c92cc0bc79aafb40ec4dcb3aa76089..fd32446944f4b1ee0e40465b9f09e7c5ce5b283c 100644 (file)
--- a/doc/ikiwiki-calendar.mdwn
+++ b/doc/ikiwiki-calendar.mdwn
@@ -39,13 +39,20 @@ the calendars to highlight the current day.
 
 An example crontab:
 
-       0 0 * * * ikiwiki-calendar ~/ikiwiki.setup "posts/* and !*/Discussion"
+       0 0 * * * ikiwiki-calendar ~/ikiwiki.setup 'posts/* and !*/Discussion'
 
 # TEMPLATES
 
-This command uses two [[template|wikitemplates]] to generate
+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>