Welcome to 2019
[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 option `archivebase` is set.
19 * `calendar_fill_gaps` - If set (and `calendar_autocreate` is set as well),
20   build calendar pages of empty years and months (but does not build pages older
21   than the older page, and younger than the younger page of the pagespec). If
22   not, those empty calendar pages will be skipped. *Please note:*
23   * The archive pages will not be automatically updated if this option changes.
24     It is up to the user to delete relevant pages, and rebuild the wiki.
25   * When `calendar_fill_gaps` is set, and a post is deleted, making the
26     corresponding year/month empty, the corresponding page is left, and shows
27     an empty calendar. This is on purpose, not to break any external link
28     pointing to this particular page. If you do not like it, delete the
29     relevant pages, and rebuild the wiki.
30
31 ## CSS
32
33 The output is liberally sprinkled with classes, for fine grained CSS
34 customization.
35
36 * `month-calendar` - The month calendar as a whole.
37 * `month-calendar-head` - The head of the month calendar (ie,"March").
38 * `month-calendar-arrow` - Arrow pointing to previous/next month.
39 * `month-calendar-day-head` - A column head in the month calendar (ie, a
40   day-of-week abbreviation).
41 * `month-calendar-day-noday`, `month-calendar-day-link`,
42   `month-calendar-day-nolink`, `month-calendar-day-future`,
43   `month-calendar-day-this-day` - The day squares on the month calendar,
44   for days that are not in the month (before or after the month itself), that
45   don't have links, that do have links, that are in the future, or are that
46   are the current day, respectively.
47 * `Sunday`, `Monday`, `Tuesday`, ... - Each day square is also given a class
48   matching its  (localised) day of week, this can be used to highlight
49   weekends.
50 * `year-calendar` - The year calendar as a whole.
51 * `year-calendar-head` - The head of the year calendar (ie, "2007").
52 * `year-calendar-arrow` - Arrow pointing to previous/next year.
53 * `year-calendar-subhead` - For example, "Months".
54 * `year-calendar-month-link`, `year-calendar-month-nolink`,
55   `year-calendar-month-future`, `year-calendar-this-month` - The month
56   squares on the year calendar, for months with stories,
57   without, in the future, and currently selected, respectively.