X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/bbb3a8aac760cf21ffb21a0bc779adc23de69943..1ff99b19ca3f9095f213dd8155191f8820dfbf51:/doc/ikiwiki/directive/calendar.mdwn diff --git a/doc/ikiwiki/directive/calendar.mdwn b/doc/ikiwiki/directive/calendar.mdwn index 198da9d51..412285c97 100644 --- a/doc/ikiwiki/directive/calendar.mdwn +++ b/doc/ikiwiki/directive/calendar.mdwn @@ -25,14 +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 `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: +## Generating archive pages + +If [[option|plugins/calendar]] `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" + 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 --setup ~/ikiwiki.setup --refresh ## usage @@ -45,16 +53,16 @@ An example crontab: for the whole wiki by setting `archivebase` in ikiwiki's setup file. Calendars link to pages under here, with names like "2010/04" and "2010". These pages can be automatically created using the - `ikiwiki-calendar` program. + `calendar_autocreate` [[setup option|plugins/calendar]]. * `year` - The year for which the calendar is requested. Defaults to the - current year. + current year. Can also use -1 to refer to last year, and so on. * `month` - The numeric month for which the calendar is requested, in the range 1..12. Used only for the month view calendar, and defaults to the - current month. + current month. Can also use -1 to refer to last month, and so on. * `week_start_day` - A number, in the range 0..6, which represents the day of the week that the month calendar starts with. 0 is Sunday, 1 is Monday, and so on. Defaults to 0, which is Sunday. -* `months_per_row` - In the annual calendar, number of months to place in +* `months_per_row` - In the year calendar, number of months to place in each row. Defaults to 3. [[!meta robots="noindex, follow"]]