Merge branch 'fancypodcast' of github.com:schmonz/ikiwiki into fancypodcast

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

diff --git a/doc/ikiwiki/directive/calendar.mdwn b/doc/ikiwiki/directive/calendar.mdwn
index 8a257d6ebe2ee5bdc4c74e58c9dff206381d4555..cb40f884e38f7ec0bedede405981c268b2526522 100644 (file)
--- a/doc/ikiwiki/directive/calendar.mdwn
+++ b/doc/ikiwiki/directive/calendar.mdwn
@@ -1,5 +1,4 @@
 The `calendar` directive is supplied by the [[!iki plugins/calendar desc=calendar]] plugin.
 The `calendar` directive is supplied by the [[!iki plugins/calendar desc=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.
 
 This directive displays a calendar, similar to the typical calendars shown on
 some blogs.


@@ -12,16 +11,28 @@ some blogs.
 
        \[[!calendar type="year" year="2005" pages="blog/* and !*/Discussion"]]
 
 
        \[[!calendar type="year" year="2005" pages="blog/* and !*/Discussion"]]
 

+## setup
+

 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,
 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.
+or a list of months for a given year. 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).
+
+While you can insert calendar directives anywhere on your wiki, including
+in the sidebar, you'll also need to create these archive pages. They
+typically use this directive to display a calendar, and also use [[inline]]
+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
+cron.
+
+An example crontab:

 
 

-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.
+       0 0 * * * ikiwiki-calendar ~/ikiwiki.setup "posts/* and !*/Discussion"

 
 ## usage
 
 
 ## usage
 


@@ -29,18 +40,21 @@ the given time frame.
   "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"]]