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.

Archiv-Seiten erzeugen

Wenn die Option calendar_autocreate nicht gesetzt ist, kann der Befehl ikiwiki-calendar verwendet werden, um die Archiv-Seiten automatisch zu erzeugen. Er aktualisiert auch das Wiki und hebt in den Kalendern den aktuellen Tag hervor. Dieser Befehl wird typischerweise um Mitternacht von cron ausgeführt.

Ein Beispiel-Eintrag in crontab:

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

Mit der Setup-Option calendar_autocreate wird diese ganze Arbeit von ikiwiki selbst erledigt. Deshalb kann der Crontab-Befehl ersetzt werden durch:

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 - Konfiguriert die Basis der Archiv-Hierarchie. Voreingestellt ist "archives". Dies kann auch für das gesamte Wiki geändert werden, indem archivebase in der Setup-Datei von ikiwiki gesetzt wird. Kalender verlinken auf Unterseiten hiervon, etwa "2010/04" oder "2010". Diese Seiten können mit der Setup-Option calendar_autocreate automatisch erzeugt werden.
  • 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.