summaryrefslogtreecommitdiff
path: root/doc/plugins/calendar.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@kitenet.net>2007-12-08 23:54:34 -0500
committerJoey Hess <joey@kitenet.net>2007-12-08 23:54:34 -0500
commit5023f2301d42319cb552102c532452b8fb4744af (patch)
treedd784628597f5e1d8c882cac64f4e95da89cd09c /doc/plugins/calendar.mdwn
parentfa90bdf4bf44d108bd8c3d53104b48aa20dc18eb (diff)
* The calendar plugin stores state about when it needs to be updated,
and forces rebuilds of the pages that contain calendars. So running ikiwiki --refresh at midnight is now enough, no need for a full wiki rebuild each midnight. * calendar: Work around block html parsing bug in markdown 1.0.1 by enclosing the calendar in an extra div.
Diffstat (limited to 'doc/plugins/calendar.mdwn')
-rw-r--r--doc/plugins/calendar.mdwn11
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/plugins/calendar.mdwn b/doc/plugins/calendar.mdwn
index 784e949a0..e8c005306 100644
--- a/doc/plugins/calendar.mdwn
+++ b/doc/plugins/calendar.mdwn
@@ -1,6 +1,8 @@
[[template id=plugin name=calendar author="[[ManojSrivastava]]"]]
[[tag type/chrome]]
+[[calendar ]]
+
This plugin displays a calendar, similar to the typical calendars shown on
some blogs.
@@ -17,10 +19,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