ikiwiki (3.20130711) unstable; urgency=low
[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 keep the calendar up-to-date.
9
10 ## CSS
11
12 The output is liberally sprinkled with classes, for fine grained CSS
13 customization.
14
15 * `month-calendar` - The month calendar as a whole.
16 * `month-calendar-head` - The head of the month calendar (ie,"March").
17 * `month-calendar-arrow` - Arrow pointing to previous/next month.
18 * `month-calendar-day-head` - A column head in the month calendar (ie, a
19   day-of-week abbreviation).
20 * `month-calendar-day-noday`, `month-calendar-day-link`,
21   `month-calendar-day-nolink`, `month-calendar-day-future`,
22   `month-calendar-day-this-day` - The day squares on the month calendar,
23   for days that are not in the month (before or after the month itself), that
24   don't have links, that do have links, that are in the future, or are that
25   are the current day, respectively.
26 * `Sunday`, `Monday`, `Tuesday`, ... - Each day square is also given a class
27   matching its  (localised) day of week, this can be used to highlight
28   weekends.
29 * `year-calendar` - The year calendar as a whole.
30 * `year-calendar-head` - The head of the year calendar (ie, "2007").
31 * `year-calendar-arrow` - Arrow pointing to previous/next year.
32 * `year-calendar-subhead` - For example, "Months".
33 * `year-calendar-month-link`, `year-calendar-month-nolink`,
34   `year-calendar-month-future`, `year-calendar-this-month` - The month
35   squares on the year calendar, for months with stories,
36   without, in the future, and currently selected, respectively.