Merge branch 'master' into autoconfig

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

diff --git a/doc/plugins/calendar.mdwn b/doc/plugins/calendar.mdwn
index 784e949a0f0576e6b09183bf849eeb883e56e4ef..20da26400b2426e92167047f39a35885a25c74d4 100644 (file)
--- a/doc/plugins/calendar.mdwn
+++ b/doc/plugins/calendar.mdwn
@@ -1,26 +1,27 @@
-[[template id=plugin name=calendar author="[[ManojSrivastava]]"]]
-[[tag type/chrome]]
+[[!template id=plugin name=calendar author="[[ManojSrivastava]]"]]
+[[!tag type/chrome]]

 
 This plugin displays a calendar, similar to the typical calendars shown on
 some blogs.
 
 # examples
 
 
 This plugin displays a calendar, similar to the typical calendars shown on
 some blogs.
 
 # examples
 

-       \[[calendar ]]
+       \[[!calendar ]]

 
 

-       \[[calendar type="month" pages="blog/* and !*/Discussion"]]
+       \[[!calendar type="month" pages="blog/* and !*/Discussion"]]

 
 

-       \[[calendar type="year" year="2005" pages="blog/* and !*/Discussion"]]
+       \[[!calendar type="year" year="2005" pages="blog/* and !*/Discussion"]]

 
 This plugin is inspired by the calendar plugin for Blosxom, but
 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.
 
 
 This plugin is inspired by the calendar plugin for Blosxom, but
 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
 
 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