Die calendar-Anweisung wird durch die calendar-Erweiterung bereitgestellt.

Diese Anweisung zeigt einen Kalender, ähnlich denen, die auf manchen Blogs angezeigt werden.

Beispiele

[[!calendar  ]]

[[!calendar  type="month" pages="blog/* and !*/Discussion"]]

[[!calendar  type="year" year="2005" pages="blog/* and !*/Discussion"]]

Einrichtung

Der Kalender ist im Wesentlichen eine schicke Schnittstelle zu einem Archiv mit früheren Seiten und wird normalerweise für Blogs verwendet. Er kann einen Kalender für einen angegebenen Monat erzeugen, oder eine Liste der Monate eines angegebenen Jahres. Der Kalender im Jahresformat enthält einfach Links zu den Archivseiten mit Namen wie archiv/2007 (für ganz 2007) und archiv/2007/01 (für Januar 2007).

Während calendar-Anweisungen überall im Wiki verwendet werden können, auch in der Sidebar, muss man auch die Archiv-Seiten anlegen. Dort wird typischerweise diese Anweisung verwendet, um einen Kalender anzuzeigen, und außerdem die Seiten aus dem entsprechenden Zeitraum über inline eingebunden.

Generating archive pages

If option calendar_autocreate is not set, the ikiwiki-calendar command can be used to automatically generate the archive pages. It also refreshes the wiki, updating the calendars to highlight the current day. This command is typically run at midnight from cron.

Ein Beispiel-Eintrag in crontab:

0 0 * * * ikiwiki-calendar ~/ikiwiki.setup "posts/* and !*/Discussion"

With setup option calendar_autocreate, all this work is done by ikiwiki itself. Thus, the crontab command can be replaced by:

0 0 * * * ikiwiki --setup ~/ikiwiki.setup --refresh

Verwendung

  • type - Hiermit wird die Art des zu erzeugenden Kalenders angegeben. Kann entweder "month" oder "year" sein. Vorgeingestellt ist die Monatsansicht.
  • pages - Gibt die PageSpec der Seiten an, auf die aus dem Monatskalender verwiesen werden soll. Voreingestellt ist "*".
  • archivebase - Configures the base of the archives hierarchy. The default is "archives". Note that this default can also be overridden for the whole wiki by setting archivebase in ikiwiki's setup file. Calendars link to pages under here, with names like "2010/04" and "2010". These pages can be automatically created using the calendar_autocreate setup option.
  • year - Das Jahr, für das der Kalender angezeigt werden soll. Voreingestellt ist das aktuelle Jahr. Es kann auch -1 für das letzte Jahr verwendet werden und so weiter.
  • month - Der Monat, für den der Kalender angezeigt werden soll, als Zahl von 1 bis 12. Wird nur für Monatskalender verwendet. Voreingestellt ist der aktuelle Monat. Es kann auch -1 für den letzten Monat verwendet werden und so weiter.
  • week_start_day - Eine Zahl aus dem Bereich 0 bis 6, die den Wochentag angibt, mit dem ein Monatskalender anfängt. 0 ist Sonntag, 1 ist Montag, und so weiter. Voreingestellt ist 0, also Sonntag.
  • months_per_row - Anzahl der Monate, die in einem Jahreskalender in einer Zeile platziert werden. Voreingestellt ist 3.