Merge commit 'smcv/prefix'
[ikiwiki.git] / doc / plugins / calendar.mdwn
1 [[!template id=plugin name=calendar author="[[ManojSrivastava]]"]]
2 [[!tag type/chrome]]
3
4 This plugin displays a calendar, similar to the typical calendars shown on
5 some blogs.
6
7 # examples
8
9         \[[!calendar ]]
10
11         \[[!calendar type="month" pages="blog/* and !*/Discussion"]]
12
13         \[[!calendar type="year" year="2005" pages="blog/* and !*/Discussion"]]
14
15 This plugin is inspired by the calendar plugin for Blosxom, but
16 derives no code from it. This plugin is essentially a fancy front end
17 to archives of previous pages, usually used for blogs. It can produce
18 a calendar for a given month, or a list of months for a given year.
19
20 Since ikiwiki is a wiki compiler, to keep the calendar up-to-date,
21 wikis that include it need to be preiodically refreshes, typically by cron
22 at midnight. Example crontab:
23
24         0 0 * * * ikiwiki -setup ~/ikiwiki.setup -refresh
25
26 The month format calendar simply links to any page posted on each
27 day of the month. The year format calendar links to archive pages, with
28 names like `archives/2007` (for all of 2007)  and `archives/2007/01`
29 (for January, 2007). For this to work, you'll need to create these archive
30 pages. They typically use [[inline]] to display or list pages created in
31 the given time frame.
32
33 ## usage
34
35 * `type` - Used to specify the type of calendar wanted. Can be one of
36   "month" or "year". The default is a month view calendar.
37 * `pages` - Specifies the [[ikiwiki/PageSpec]] of pages to link to from the
38   month calendar. Defaults to "*".
39 * `archivebase` - Configures the base of the archives hierarchy. The
40   default is "archives". Note that this default can also be overridden
41   for the whole wiki by setting `archivebase` in ikiwiki's setup file.
42 * `year` - The year for which the calendar is requested. Defaults to the
43   current year.
44 * `month` - The numeric month for which the calendar is requested, in the
45   range 1..12. Used only for the month view calendar, and defaults to the
46   current month.
47 * `week_start_day` - A number, in the range 0..6, which represents the day
48   of the week that the month calendar starts with. 0 is Sunday, 1 is Monday,
49   and so on. Defaults to 0, which is Sunday.
50 * `months_per_row` - In the annual calendar, number of months to place in
51   each row. Defaults to 3.
52
53 ## CSS
54
55 The output is liberally sprinkled with classes, for fine grained CSS
56 customization.
57
58 * `month-calendar` - The month calendar as a whole.
59 * `month-calendar-head` - The head of the month calendar (ie,"March").
60 * `month-calendar-day-head` - A column head in the month calendar (ie, a
61   day-of-week abbreviation).
62 * `month-calendar-day-noday`, `month-calendar-day-link`, 
63   `month-calendar-day-nolink`, `month-calendar-day-future`,
64   `month-calendar-day-this-day` - The day squares on the month calendar,
65   for days that are not in the month (before or after the month itself), that
66   don't have links, that do have links, that are in the future, or are that
67   are the current day, respectively.
68 * `Sunday`, `Monday`, `Tuesday`, ... - Each day square is also given a class
69   matching its  (localised) day of week, this can be used to highlight
70   weekends.
71 * `year-calendar` - The year calendar as a whole.
72 * `year-calendar-head` - The head of the year calendar (ie, "2007").
73 * `year-calendar-subhead` - For example, "Months".
74 * `year-calendar-month-link`, `year-calendar-month-nolink`,
75   `year-calendar-month-future`, `year-calendar-this-month` - The month
76   squares on the year calendar, for months with stories,
77   without, in the future, and currently selected, respectively.