blob: e2cc612f31c806e02d32a2a9cb4a87bdc571e6da (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
# NAME
ikiwiki-calendar - create calendar archive pages
# SYNOPSIS
ikiwiki-calendar [-f] your.setup [pagespec] [year]
# DESCRIPTION
`ikiwiki-calendar` creates pages that use the [[ikiwiki/directive/calendar]]
directive, allowing the archives to be browsed one month
at a time, with calendar-based navigation.
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,
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.
Existing pages will not be overwritten by this command by default.
Use the `-f` switch to force it to overwrite any existing pages.
## 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
a cron job to run it daily, at midnight. Then it will also update
the calendars to highlight the current day.
An example crontab:
0 0 * * * ikiwiki-calendar ~/ikiwiki.setup "posts/* and !*/Discussion"
# TEMPLATES
This command uses two [[template|wikitemplates]] to generate
the pages, `calendarmonth.tmpl` and `calendaryear.tmpl`.
# AUTHOR
Joey Hess <joey@ikiwiki.info>
Warning: this page is automatically made into ikiwiki-calendar's man page, edit with care
|