Typo.
[ikiwiki.git] / doc / plugins / calendar.mdwn
1 [[!template id=plugin name=calendar author="[[ManojSrivastava]]"]]
2 [[!tag type/chrome]]
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 Since ikiwiki is a wiki compiler, to keep the calendar up-to-date,
9 wikis that include it need to be periodically refreshes, typically by cron
10 at midnight. Example crontab:
11
12         0 0 * * * ikiwiki -setup ~/ikiwiki.setup -refresh
13
14 ## CSS
15
16 The output is liberally sprinkled with classes, for fine grained CSS
17 customization.
18
19 * `month-calendar` - The month calendar as a whole.
20 * `month-calendar-head` - The head of the month calendar (ie,"March").
21 * `month-calendar-day-head` - A column head in the month calendar (ie, a
22   day-of-week abbreviation).
23 * `month-calendar-day-noday`, `month-calendar-day-link`,
24   `month-calendar-day-nolink`, `month-calendar-day-future`,
25   `month-calendar-day-this-day` - The day squares on the month calendar,
26   for days that are not in the month (before or after the month itself), that
27   don't have links, that do have links, that are in the future, or are that
28   are the current day, respectively.
29 * `Sunday`, `Monday`, `Tuesday`, ... - Each day square is also given a class
30   matching its  (localised) day of week, this can be used to highlight
31   weekends.
32 * `year-calendar` - The year calendar as a whole.
33 * `year-calendar-head` - The head of the year calendar (ie, "2007").
34 * `year-calendar-subhead` - For example, "Months".
35 * `year-calendar-month-link`, `year-calendar-month-nolink`,
36   `year-calendar-month-future`, `year-calendar-this-month` - The month
37   squares on the year calendar, for months with stories,
38   without, in the future, and currently selected, respectively.