]> sipb.mit.edu Git - ikiwiki.git/blob - doc/ikiwiki-calendar.mdwn
3f5c6a29e529ffff0519ceeb84549c340dcb2212
[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 You will probably want to specify a [[ikiwiki/PageSpec]]
20 to control which pages are included on the calendars. The
21 default is all pages. To limit it to only posts in a blog,
22 use something like "posts/* and !*/Discussion".
23
24 It defaults to creating calendar pages for the current
25 year. If you specify a year, it will create pages for that year.
26 Specify a second year to create pages for a span of years.
27
28 Existing pages will not be overwritten by this command by default.
29 Use the `-f` switch to force it to overwrite any existing pages.
30
31 ## CRONTAB
32
33 While this command only needs to be run once a year to update
34 the archive pages for each new year, you are recommended to set up
35 a cron job to run it daily, at midnight. Then it will also update
36 the calendars to highlight the current day.
37
38 An example crontab:
39
40         0 0 * * * ikiwiki-calendar ~/ikiwiki.setup "posts/* and !*/Discussion"
41
42 # TEMPLATES
43
44 This command uses two [[template|wikitemplates]] to generate
45 the pages, `calendarmonth.tmpl` and `calendaryear.tmpl`.
46
47 # AUTHOR
48
49 Joey Hess <joey@ikiwiki.info>
50
51 Warning: this page is automatically made into ikiwiki-calendar's man page, edit with care