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
  23 ## CSS
  24
  25 The output is liberally sprinkled with classes, for fine grained CSS
  26 customization.
  27
  28 * `month-calendar` - The month calendar as a whole.
  29 * `month-calendar-head` - The head of the month calendar (ie,"March").
  30 * `month-calendar-arrow` - Arrow pointing to previous/next month.
  31 * `month-calendar-day-head` - A column head in the month calendar (ie, a
  32   day-of-week abbreviation).
  33 * `month-calendar-day-noday`, `month-calendar-day-link`,
  34   `month-calendar-day-nolink`, `month-calendar-day-future`,
  35   `month-calendar-day-this-day` - The day squares on the month calendar,
  36   for days that are not in the month (before or after the month itself), that
  37   don't have links, that do have links, that are in the future, or are that
  38   are the current day, respectively.
  39 * `Sunday`, `Monday`, `Tuesday`, ... - Each day square is also given a class
  40   matching its  (localised) day of week, this can be used to highlight
  41   weekends.
  42 * `year-calendar` - The year calendar as a whole.
  43 * `year-calendar-head` - The head of the year calendar (ie, "2007").
  44 * `year-calendar-arrow` - Arrow pointing to previous/next year.
  45 * `year-calendar-subhead` - For example, "Months".
  46 * `year-calendar-month-link`, `year-calendar-month-nolink`,
  47   `year-calendar-month-future`, `year-calendar-this-month` - The month
  48   squares on the year calendar, for months with stories,
  49   without, in the future, and currently selected, respectively.