start fleshing out "things that make zoned ikiwiki hard"

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

diff --git a/doc/ikiwiki-calendar.mdwn b/doc/ikiwiki-calendar.mdwn
index e2cc612f31c806e02d32a2a9cb4a87bdc571e6da..d311a1859f66261a16b8296a4fdd7f05156fbca0 100644 (file)
--- a/doc/ikiwiki-calendar.mdwn
+++ b/doc/ikiwiki-calendar.mdwn
@@ -4,7 +4,7 @@ ikiwiki-calendar - create calendar archive pages
 
 # SYNOPSIS
 
 
 # SYNOPSIS
 

-ikiwiki-calendar [-f] your.setup [pagespec] [year]
+ikiwiki-calendar [-f] your.setup [pagespec] [startyear [endyear]]

 
 # DESCRIPTION
 
 
 # DESCRIPTION
 


@@ -16,19 +16,21 @@ You must specify the setup file for your wiki. The pages will
 be created inside its `srcdir`, beneath the `archivebase`
 directory used by the calendar plugin (default "archives").
 
 be created inside its `srcdir`, beneath the `archivebase`
 directory used by the calendar plugin (default "archives").
 

-You will probably want to specify a [[ikiwiki/PageSpec]]
-to control which pages are included on the calendars. The
-default is all pages. To limit it to only posts in a blog,
+To control which pages are included on the calendars,
+a [[ikiwiki/PageSpec]] can be specified. The default is
+all pages, or the pages specified by the `comments_pagespec`
+setting in the config file. A pagespec can also be specified
+on the command line. To limit it to only posts in a blog,

 use something like "posts/* and !*/Discussion".
 
 It defaults to creating calendar pages for the current
 use something like "posts/* and !*/Discussion".
 
 It defaults to creating calendar pages for the current

-year, as well as the previous year, and the next year.
-If you specify a year, it will create pages for that year.
+year. If you specify a year, it will create pages for that year.
+Specify a second year to create pages for a span of years.

 
 Existing pages will not be overwritten by this command by default.
 Use the `-f` switch to force it to overwrite any existing pages.
 
 
 Existing pages will not be overwritten by this command by default.
 Use the `-f` switch to force it to overwrite any existing pages.
 

-## CRONTAB
+# CRONTAB

 
 While this command only needs to be run once a year to update
 the archive pages for each new year, you are recommended to set up
 
 While this command only needs to be run once a year to update
 the archive pages for each new year, you are recommended to set up


@@ -37,11 +39,11 @@ the calendars to highlight the current day.
 
 An example crontab:
 
 
 An example crontab:
 

-       0 0 * * * ikiwiki-calendar ~/ikiwiki.setup "posts/* and !*/Discussion"
+       0 0 * * * ikiwiki-calendar ~/ikiwiki.setup 'posts/* and !*/Discussion'

 
 # TEMPLATES
 
 
 # TEMPLATES
 

-This command uses two [[template|wikitemplates]] to generate
+This command uses two [[templates]] to generate

 the pages, `calendarmonth.tmpl` and `calendaryear.tmpl`.
 
 # AUTHOR
 the pages, `calendarmonth.tmpl` and `calendaryear.tmpl`.
 
 # AUTHOR