X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/a27f4a47ba0435233ed272e2541feab4e0868b32..4691a2ad39cce273231fddd9a589b4f8fdc1b063:/doc/plugins/calendar.mdwn diff --git a/doc/plugins/calendar.mdwn b/doc/plugins/calendar.mdwn index 99e2ab126..20da26400 100644 --- 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 - \[[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. -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