releasing version 2.31.1

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

diff --git a/doc/plugins/calendar.mdwn b/doc/plugins/calendar.mdwn
index 99e2ab12671dbca0958eefad8d46f09b66aea3f4..d429bde88b62fd913c68609d200964881598c78e 100644 (file)
--- a/doc/plugins/calendar.mdwn
+++ b/doc/plugins/calendar.mdwn
@@ -17,10 +17,11 @@ derives no code from it. This plugin is essentially a fancy front end
 to archives of previous pages, usually used for blogs. It can produce
 a calendar for a given month, or a list of months for a given year.
 
-The tricky part of this is that while calendar defaults to showing the
-current day and month, ikiwiki is a wiki compiler, which only rebuilds
-pages if they have changed. So to keep the calendar up-to-date, wikis that
-include it need to be periodically rebuilt, typically by cron at midnight.
+Since ikiwiki is a wiki compiler, to keep the calendar up-to-date,
+wikis that include it need to be preiodically refreshes, typically by cron
+at midnight. Example crontab:
+
+       0 0 * * * ikiwiki -setup ~/ikiwiki.setup -refresh
 
 The month format calendar simply links to any page posted on each
 day of the month. The year format calendar links to archive pages, with
@@ -33,7 +34,7 @@ the given time frame.
 
 * `type` - Used to specify the type of calendar wanted. Can be one of
   "month" or "year". The default is a month view calendar.
-* `pages` - Specifies the [[PageSpec]] of pages to link to from the
+* `pages` - Specifies the [[ikiwiki/PageSpec]] of pages to link to from the
   month calendar. Defaults to "*".
 * `archivebase` - Configures the base of the archives hierarchy. The
   default is "archives". Note that this default can also be overridden