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