add YAML::XS dep to Makefile.PL
[ikiwiki.git] / doc / ikiwiki-calendar.mdwn
1 # NAME
2
3 ikiwiki-calendar - create calendar archive pages
4
5 # SYNOPSIS
6
7 ikiwiki-calendar [-f] your.setup [pagespec] [startyear [endyear]]
8
9 # DESCRIPTION
10
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.
14
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").
18
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".
25
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.
29
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.
32
33 # CRONTAB
34
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.
39
40 An example crontab:
41
42         0 0 * * * ikiwiki-calendar ~/ikiwiki.setup 'posts/* and !*/Discussion'
43
44 # TEMPLATES
45
46 This command uses two [[templates]] to generate
47 the pages, `calendarmonth.tmpl` and `calendaryear.tmpl`.
48
49 # AUTHOR
50
51 Joey Hess <joey@ikiwiki.info>
52
53 Warning: this page is automatically made into ikiwiki-calendar's man page, edit with care