summaryrefslogtreecommitdiff
path: root/underlays/basewiki/directive
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-09-11 17:21:14 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-11 17:21:14 -0400
commitc3d77f9ce9d0f183e4d115b6a696dd8eb4530b51 (patch)
tree17ab5093cee2f7678768d0faaca17626b554dbc4 /underlays/basewiki/directive
parentb85ea3f37d3725b549b97ed361528dcd15d718bc (diff)
reorg from will's changes
The info about the cron job was lost (!), as was a paragraph about what pages the calendar links to. The CSS docs seems to fit better in the plugin page than the directive page, moved it back.
Diffstat (limited to 'underlays/basewiki/directive')
-rw-r--r--underlays/basewiki/directive/calendar.mdwn41
1 files changed, 10 insertions, 31 deletions
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.