<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>ikiwiki-calendar</title> <meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="stylesheet" href="style.css" type="text/css" /> <link rel="stylesheet" href="local.css" type="text/css" /> </head> <body> <div class="page"> <div class="pageheader"> <div class="header"> <span> <span class="parentlinks"> <a href="./index.html">ikiwiki</a>/ </span> <span class="title"> ikiwiki-calendar </span> </span> </div> </div> <div id="pagebody"> <div id="content" role="main"> <h1>NAME</h1> <p>ikiwiki-calendar - create calendar archive pages</p> <h1>SYNOPSIS</h1> <p>ikiwiki-calendar [-f] your.setup [pagespec] [startyear [endyear]]</p> <h1>DESCRIPTION</h1> <p><code>ikiwiki-calendar</code> creates pages that use the <a href="./ikiwiki/directive/calendar.html">calendar</a> directive, allowing the archives to be browsed one month at a time, with calendar-based navigation.</p> <p>You must specify the setup file for your wiki. The pages will be created inside its <code>srcdir</code>, beneath the <code>archivebase</code> directory used by the calendar plugin (default "archives").</p> <p>To control which pages are included on the calendars, a <a href="./ikiwiki/pagespec.html">PageSpec</a> can be specified. The default is all pages, or the pages specified by the <code>comments_pagespec</code> setting in the config file. A pagespec can also be specified on the command line. To limit it to only posts in a blog, use something like "posts/* and !*/Discussion".</p> <p>It defaults to creating calendar pages for the current year. If you specify a year, it will create pages for that year. Specify a second year to create pages for a span of years.</p> <p>Existing pages will not be overwritten by this command by default. Use the <code>-f</code> switch to force it to overwrite any existing pages.</p> <h1>CRONTAB</h1> <p>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.</p> <p>An example crontab:</p> <pre><code>0 0 * * * ikiwiki-calendar ~/ikiwiki.setup 'posts/* and !*/Discussion' </code></pre> <h1>TEMPLATES</h1> <p>This command uses two <a href="./templates.html">templates</a> to generate the pages, <code>calendarmonth.tmpl</code> and <code>calendaryear.tmpl</code>.</p> <h1><a href="./plugins/calendar.html">calendar</a> setup option</h1> <p>Most of the goals of this command can be replaced by setting up <code>calendar_autocreate</code> setup option (of plugin <a href="./plugins/calendar.html">calendar</a>), and running <code>ikiwiki --setup you.setup</code>. The only thing that <code>ikiwiki-calendar</code> can do and that <code>ikiwiki</code> cannot is forcing page generation (using <code>-f</code> switch).</p> <h1>AUTHOR</h1> <p>Joey Hess <a href="mailto:joey@ikiwiki.info">joey@ikiwiki.info</a></p> <p>Warning: this page is automatically made into ikiwiki-calendar's man page, edit with care</p> </div> </div> <div id="footer" class="pagefooter" role="contentinfo"> <div id="pageinfo"> <div id="backlinks"> Links: <a href="./examples/blog.html">examples/blog</a> <a href="./plugins/calendar.html">plugins/calendar</a> </div> <div class="pagedate"> Last edited <span class="date">Tue Feb 26 23:01:54 2019</span> <!-- Created <span class="date">Tue Feb 26 23:01:54 2019</span> --> </div> </div> <!-- from ikiwiki --> </div> </div> </body> </html>