summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/calendar.mdwn
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2010-10-14 13:38:27 +0200
committerJonas Smedegaard <dr@jones.dk>2010-10-14 13:38:27 +0200
commit46d295eff558e247b05e61038bd82d5c5b8155a7 (patch)
tree13d82b647d5fb5e7f67ba4e7fde9f9206acce302 /ikiwiki/directive/calendar.mdwn
Sync with ikiwiki 3.20100926.HEADmasterikiwiki
Diffstat (limited to 'ikiwiki/directive/calendar.mdwn')
-rw-r--r--ikiwiki/directive/calendar.mdwn62
1 files changed, 62 insertions, 0 deletions
diff --git a/ikiwiki/directive/calendar.mdwn b/ikiwiki/directive/calendar.mdwn
new file mode 100644
index 0000000..6dfd3c4
--- /dev/null
+++ b/ikiwiki/directive/calendar.mdwn
@@ -0,0 +1,62 @@
+Die `calendar`-Anweisung wird durch die [[!iki plugins/calendar
+desc=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.
+
+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"
+
+## Verwendung
+
+* `type` - Hiermit wird die Art des zu erzeugenden Kalenders angegeben. Kann
+ entweder "month" oder "year" sein. Vorgeingestellt ist die Monatsansicht.
+* `pages` - Gibt die [[ikiwiki/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
+ `ikiwiki-calendar` program.
+* `year` - The year for which the calendar is requested. Defaults to the
+ current year. Can also use -1 to refer to last year, and so on.
+* `month` - The numeric month for which the calendar is requested, in the
+ range 1..12. Used only for the month view calendar, and defaults to the
+ current month. Can also use -1 to refer to last month, and so on.
+* `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` - In the year calendar, number of months to place in each
+ row. Defaults to 3.
+
+[[!meta robots="noindex, follow"]]