close

[git.ikiwiki.info.git] / doc / ikiwiki / directive / calendar.mdwn

diff --git a/doc/ikiwiki/directive/calendar.mdwn b/doc/ikiwiki/directive/calendar.mdwn
index b2ac75b11694eed8cc67178cf2508814ee30f96d..cb40f884e38f7ec0bedede405981c268b2526522 100644 (file)
--- a/doc/ikiwiki/directive/calendar.mdwn
+++ b/doc/ikiwiki/directive/calendar.mdwn
@@ -28,7 +28,7 @@ to display or list pages created in the given time frame.
 The `ikiwiki-calendar` command can be used to automatically generate the
 archive pages. It also refreshes the wiki, updating the calendars to
 highlight the current day. This command is typically run at midnight from
 The `ikiwiki-calendar` command can be used to automatically generate the
 archive pages. It also refreshes the wiki, updating the calendars to
 highlight the current day. This command is typically run at midnight from

-cron. An example crontab:
+cron.

 
 An example crontab:
 
 
 An example crontab:
 


@@ -40,18 +40,21 @@ An example crontab:
   "month" or "year". The default is a month view calendar.
 * `pages` - Specifies the [[ikiwiki/PageSpec]] of pages to link to from the
   month calendar. Defaults to "*".
   "month" or "year". The default is a month view calendar.
 * `pages` - Specifies the [[ikiwiki/PageSpec]] of pages to link to from the
   month calendar. Defaults to "*".

-* `archivebase` - Configures the base of the archives hierarchy. The
-  default is "archives". Note that this default can also be overridden
+* `archivebase` - Configures the base of the archives hierarchy. 
+  The default is "archives". Note that this default can also be overridden

   for the whole wiki by setting `archivebase` in ikiwiki's setup file.
   for the whole wiki by setting `archivebase` in ikiwiki's setup file.

+  Calendars link to pages under here, with names like "2010/04" and
+  "2010". These pages can be automatically created using the
+  `ikiwiki-calendar` program. 

 * `year` - The year for which the calendar is requested. Defaults to the
 * `year` - The year for which the calendar is requested. Defaults to the

-  current year.
+  current year. Can also use -1 to refer to last year, and so on.

 * `month` - The numeric month for which the calendar is requested, in the
   range 1..12. Used only for the month view calendar, and defaults to the
 * `month` - The numeric month for which the calendar is requested, in the
   range 1..12. Used only for the month view calendar, and defaults to the

-  current month.
+  current month. Can also use -1 to refer to last month, and so on.

 * `week_start_day` - A number, in the range 0..6, which represents the day
   of the week that the month calendar starts with. 0 is Sunday, 1 is Monday,
   and so on. Defaults to 0, which is Sunday.
 * `week_start_day` - A number, in the range 0..6, which represents the day
   of the week that the month calendar starts with. 0 is Sunday, 1 is Monday,
   and so on. Defaults to 0, which is Sunday.

-* `months_per_row` - In the annual calendar, number of months to place in
+* `months_per_row` - In the year calendar, number of months to place in

   each row. Defaults to 3.
 
 [[!meta robots="noindex, follow"]]
   each row. Defaults to 3.
 
 [[!meta robots="noindex, follow"]]