1ikiwiki-calendar(1)         General Commands Manual        ikiwiki-calendar(1)
2
3
4

NAME

6       ikiwiki-calendar - create calendar archive pages
7

SYNOPSIS

9       ikiwiki-calendar [-f] your.setup [pagespec] [startyear [endyear]]
10

DESCRIPTION

12       ikiwiki-calendar  creates pages that use the ikiwiki/directive/calendar
13       directive, allowing the archives to be browsed one  month  at  a  time,
14       with calendar-based navigation.
15
16       You  must  specify the setup file for your wiki. The pages will be cre‐
17       ated inside its srcdir, beneath the archivebase directory used  by  the
18       calendar plugin (default "archives").
19
20       To  control  which pages are included on the calendars, a ikiwiki/Page‐
21       Spec can be specified. The default is all pages, or the pages specified
22       by  the  comments_pagespec  setting  in the config file. A pagespec can
23       also be specified on the command line. To limit it to only posts  in  a
24       blog, use something like "posts/* and !*/Discussion".
25
26       It  defaults  to  creating  calendar pages for the current year. If you
27       specify a year, it will create pages for that year.  Specify  a  second
28       year to create pages for a span of years.
29
30       Existing pages will not be overwritten by this command by default.  Use
31       the -f switch to force it to overwrite any existing pages.
32

CRONTAB

34       While this command only needs to be run once a year to update  the  ar‐
35       chive pages for each new year, you are recommended to set up a cron job
36       to run it daily, at midnight. Then it will also update the calendars to
37       highlight the current day.
38
39       An example crontab:
40
41        0 0 * * * ikiwiki-calendar ~/ikiwiki.setup 'posts/* and !*/Discussion'
42

TEMPLATES

44       This  command  uses  two  templates  to  generate  the pages, calendar‐
45       month.tmpl and calendaryear.tmpl.
46

plugins/calendar setup option

48       Most of the goals of this command can be replaced by setting up  calen‐
49       dar_autocreate  setup  option (of plugin plugins/calendar), and running
50       ikiwiki --setup you.setup. The only thing that ikiwiki-calendar can  do
51       and that ikiwiki cannot is forcing page generation (using -f switch).
52

AUTHOR

54       Joey Hess <joey@ikiwiki.info>
55
56                                                           ikiwiki-calendar(1)
Impressum