aboutsummaryrefslogtreecommitdiff
path: root/doc/ikiwiki
diff options
context:
space:
mode:
authorLouis <spalax@gresille.org>2014-07-05 12:52:21 +0200
committerLouis <spalax@gresille.org>2014-07-05 12:58:50 +0200
commit7a92444e56fe023cea3b074dc5e6b5c4acdb6114 (patch)
tree9c33d556cb5d3cca6e00dfd9ff4710622a0a211b /doc/ikiwiki
parent7f18c1ce48630507b744fa56b83999e8ca684606 (diff)
downloadikiwiki-7a92444e56fe023cea3b074dc5e6b5c4acdb6114.tar
ikiwiki-7a92444e56fe023cea3b074dc5e6b5c4acdb6114.tar.gz
Clarifying documentation
Thanks to review http://ikiwiki.info/todo/calendar_autocreate/
Diffstat (limited to 'doc/ikiwiki')
-rw-r--r--doc/ikiwiki/directive/calendar.mdwn18
1 files changed, 16 insertions, 2 deletions
diff --git a/doc/ikiwiki/directive/calendar.mdwn b/doc/ikiwiki/directive/calendar.mdwn
index 0b2b475fd..2969d1c37 100644
--- 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.
-The `calendar_autocreate` [[setup option|plugins/calendar]] can be used to
-automatically generate the archive pages.
+## Generating archive pages
+
+If option `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 ~/ikiwiki.setup --refresh
## usage