diff options
| -rw-r--r-- | doc/plugins/calendar.mdwn | 34 | ||||
| -rw-r--r-- | underlays/basewiki/directive/calendar.mdwn | 41 |
2 files changed, 43 insertions, 32 deletions
diff --git a/doc/plugins/calendar.mdwn b/doc/plugins/calendar.mdwn index dd60fa3b3..c9e95ce7e 100644 --- a/doc/plugins/calendar.mdwn +++ b/doc/plugins/calendar.mdwn @@ -1,6 +1,38 @@ [[!template id=plugin name=calendar author="[[ManojSrivastava]]"]] [[!tag type/chrome]] -This plugin implements the [[ikiwiki/directive/calendar]] [[ikiwiki/directive]]. +This plugin provides a [[ikiwiki/directive/calendar]] [[ikiwiki/directive]]. The directive displays a calendar, similar to the typical calendars shown on some blogs. + +Since ikiwiki is a wiki compiler, to keep the calendar up-to-date, +wikis that include it need to be preiodically refreshes, typically by cron +at midnight. Example crontab: + + 0 0 * * * ikiwiki -setup ~/ikiwiki.setup -refresh + +## CSS + +The output is liberally sprinkled with classes, for fine grained CSS +customization. + +* `month-calendar` - The month calendar as a whole. +* `month-calendar-head` - The head of the month calendar (ie,"March"). +* `month-calendar-day-head` - A column head in the month calendar (ie, a + day-of-week abbreviation). +* `month-calendar-day-noday`, `month-calendar-day-link`, + `month-calendar-day-nolink`, `month-calendar-day-future`, + `month-calendar-day-this-day` - The day squares on the month calendar, + for days that are not in the month (before or after the month itself), that + don't have links, that do have links, that are in the future, or are that + are the current day, respectively. +* `Sunday`, `Monday`, `Tuesday`, ... - Each day square is also given a class + matching its (localised) day of week, this can be used to highlight + weekends. +* `year-calendar` - The year calendar as a whole. +* `year-calendar-head` - The head of the year calendar (ie, "2007"). +* `year-calendar-subhead` - For example, "Months". +* `year-calendar-month-link`, `year-calendar-month-nolink`, + `year-calendar-month-future`, `year-calendar-this-month` - The month + squares on the year calendar, for months with stories, + without, in the future, and currently selected, respectively. diff --git a/underlays/basewiki/directive/calendar.mdwn b/underlays/basewiki/directive/calendar.mdwn index a2ead8a82..4688af920 100644 --- a/underlays/basewiki/directive/calendar.mdwn +++ b/underlays/basewiki/directive/calendar.mdwn @@ -1,4 +1,5 @@ The `calendar` directive is supplied by the [[!iki plugins/calendar]] plugin. +This plugin requires extra setup. See the plugin documentation for details. This directive displays a calendar, similar to the typical calendars shown on some blogs. @@ -11,12 +12,16 @@ some blogs. \[[!calendar type="year" year="2005" pages="blog/* and !*/Discussion"]] -This plugin is inspired by the calendar plugin for Blosxom, but -derives no code from it. This plugin is essentially a fancy front end -to archives of previous pages, usually used for blogs. It can produce -a calendar for a given month, or a list of months for a given year. +The calendar is essentially a fancy front end to archives of previous +pages, usually used for blogs. It can produce a calendar for a given month, +or a list of months for a given year. -This plugin requires extra setup. See the plugin documentation for details. +The month format calendar simply links to any page posted on each +day of the month. The year format calendar links to archive pages, with +names like `archives/2007` (for all of 2007) and `archives/2007/01` +(for January, 2007). For this to work, you'll need to create these archive +pages. They typically use [[inline]] to display or list pages created in +the given time frame. ## usage @@ -37,29 +42,3 @@ This plugin requires extra setup. See the plugin documentation for details. and so on. Defaults to 0, which is Sunday. * `months_per_row` - In the annual calendar, number of months to place in each row. Defaults to 3. - -## CSS - -The output is liberally sprinkled with classes, for fine grained CSS -customization. - -* `month-calendar` - The month calendar as a whole. -* `month-calendar-head` - The head of the month calendar (ie,"March"). -* `month-calendar-day-head` - A column head in the month calendar (ie, a - day-of-week abbreviation). -* `month-calendar-day-noday`, `month-calendar-day-link`, - `month-calendar-day-nolink`, `month-calendar-day-future`, - `month-calendar-day-this-day` - The day squares on the month calendar, - for days that are not in the month (before or after the month itself), that - don't have links, that do have links, that are in the future, or are that - are the current day, respectively. -* `Sunday`, `Monday`, `Tuesday`, ... - Each day square is also given a class - matching its (localised) day of week, this can be used to highlight - weekends. -* `year-calendar` - The year calendar as a whole. -* `year-calendar-head` - The head of the year calendar (ie, "2007"). -* `year-calendar-subhead` - For example, "Months". -* `year-calendar-month-link`, `year-calendar-month-nolink`, - `year-calendar-month-future`, `year-calendar-this-month` - The month - squares on the year calendar, for months with stories, - without, in the future, and currently selected, respectively. |