]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/ikiwiki-calendar.mdwn
(no commit message)
[git.ikiwiki.info.git] / doc / ikiwiki-calendar.mdwn
1 # NAME
3 ikiwiki-calendar - create calendar archive pages
5 # SYNOPSIS
7 ikiwiki-calendar [-f] your.setup [pagespec] [startyear [endyear]]
9 # DESCRIPTION
11 `ikiwiki-calendar` creates pages that use the [[ikiwiki/directive/calendar]]
12 directive, allowing the archives to be browsed one month
13 at a time, with calendar-based navigation.
15 You must specify the setup file for your wiki. The pages will
16 be created inside its `srcdir`, beneath the `archivebase`
17 directory used by the calendar plugin (default "archives").
19 To control which pages are included on the calendars,
20 a [[ikiwiki/PageSpec]] can be specified. The default is
21 all pages, or the pages specified by the `comments_pagespec`
22 setting in the config file. A pagespec can also be specified
23 on the command line. To limit it to only posts in a blog,
24 use something like "posts/* and !*/Discussion".
26 It defaults to creating calendar pages for the current
27 year. If you specify a year, it will create pages for that year.
28 Specify a second year to create pages for a span of years.
30 Existing pages will not be overwritten by this command by default.
31 Use the `-f` switch to force it to overwrite any existing pages.
33 # CRONTAB
35 While this command only needs to be run once a year to update
36 the archive pages for each new year, you are recommended to set up
37 a cron job to run it daily, at midnight. Then it will also update
38 the calendars to highlight the current day.
40 An example crontab:
42         0 0 * * * ikiwiki-calendar ~/ikiwiki.setup 'posts/* and !*/Discussion'
44 # TEMPLATES
46 This command uses two [[templates]] to generate
47 the pages, `calendarmonth.tmpl` and `calendaryear.tmpl`.
49 # [[plugins/calendar]] setup option
51 Most of the goals of this command can be replaced by setting up
52 `calendar_autocreate` setup option (of plugin [[plugins/calendar]]), and
53 running `ikiwiki --setup you.setup`. The only thing that `ikiwiki-calendar` can
54 do and that `ikiwiki` cannot is forcing page generation (using `-f` switch).
56 # AUTHOR
58 Joey Hess <joey@ikiwiki.info>
60 Warning: this page is automatically made into ikiwiki-calendar's man page, edit with care