summaryrefslogtreecommitdiff
path: root/doc/ikiwiki-calendar.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ikiwiki-calendar.mdwn')
-rw-r--r--doc/ikiwiki-calendar.mdwn18
1 files changed, 10 insertions, 8 deletions
diff --git a/doc/ikiwiki-calendar.mdwn b/doc/ikiwiki-calendar.mdwn
index e2cc612f3..03cbdd86c 100644
--- a/doc/ikiwiki-calendar.mdwn
+++ b/doc/ikiwiki-calendar.mdwn
@@ -4,7 +4,7 @@ ikiwiki-calendar - create calendar archive pages
# SYNOPSIS
-ikiwiki-calendar [-f] your.setup [pagespec] [year]
+ikiwiki-calendar [-f] your.setup [pagespec] [startyear [endyear]]
# 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").
-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
-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.
-## 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
@@ -41,7 +43,7 @@ An example crontab:
# TEMPLATES
-This command uses two [[template|wikitemplates]] to generate
+This command uses two [[templates]] to generate
the pages, `calendarmonth.tmpl` and `calendaryear.tmpl`.
# AUTHOR