calendar plugin: Autocreate archive pages if needed
[ikiwiki.git] / doc / plugins / calendar.mdwn
1
2 This plugin provides a [[ikiwiki/directive/calendar]] [[ikiwiki/directive]].
3 The directive displays a calendar, similar to the typical calendars shown on
4 some blogs. 
5
6 The [[ikiwiki-calendar]] command is used to force generating year and month
7 pages from templates (overriding the existing ones).
8
9 ## Setup options
10
11 * `archivebase` - Default value for [[ikiwiki/directive/calendar]] directive
12   option of the same name.
13 * `archive_pagespec` - [[ikiwiki/PageSpec]] of pages to include in the
14   archives, if option `calendar_autocreate` is on. It defaults to `*`.
15 * `calendar_autocreate` - Control whether new archive pages are created as
16   needed. It defaults to being done only if (at least) one of options
17   `archivebase` and `calendar_autocreate_commit` are set.
18 * `calendar_autocreate_commit` -  If set, causes new archive pages to be
19   checked into version control. Defaults to 1.
20
21 ## CSS
22
23 The output is liberally sprinkled with classes, for fine grained CSS
24 customization.
25
26 * `month-calendar` - The month calendar as a whole.
27 * `month-calendar-head` - The head of the month calendar (ie,"March").
28 * `month-calendar-arrow` - Arrow pointing to previous/next month.
29 * `month-calendar-day-head` - A column head in the month calendar (ie, a
30   day-of-week abbreviation).
31 * `month-calendar-day-noday`, `month-calendar-day-link`,
32   `month-calendar-day-nolink`, `month-calendar-day-future`,
33   `month-calendar-day-this-day` - The day squares on the month calendar,
34   for days that are not in the month (before or after the month itself), that
35   don't have links, that do have links, that are in the future, or are that
36   are the current day, respectively.
37 * `Sunday`, `Monday`, `Tuesday`, ... - Each day square is also given a class
38   matching its  (localised) day of week, this can be used to highlight
39   weekends.
40 * `year-calendar` - The year calendar as a whole.
41 * `year-calendar-head` - The head of the year calendar (ie, "2007").
42 * `year-calendar-arrow` - Arrow pointing to previous/next year.
43 * `year-calendar-subhead` - For example, "Months".
44 * `year-calendar-month-link`, `year-calendar-month-nolink`,
45   `year-calendar-month-future`, `year-calendar-this-month` - The month
46   squares on the year calendar, for months with stories,
47   without, in the future, and currently selected, respectively.