Vorlage:Archiv Übersicht/Doku

Aus Wikibooks
Zur Navigation springen Zur Suche springen

Zweck[Bearbeiten]

Diese Vorlage liefert auf einfache Art eine einheitliche Navigation zwischen Archivseiten:

  • die Hauptseite, zu der die Archive gehören
  • eine Übersichtsseite für die Archive
  • die einzelnen Archivseiten

Zurzeit berücksichtigt diese Navigation Archive, die nach Jahren aufgeteilt sind.

Verwendung[Bearbeiten]

Alle einzelnen Archivseiten sind Unterseiten einer Basisseite, deren Namen mit dem Begriff „Archiv“ endet. Als Trenner muss der Schrägstrich verwendet werden. Die Basisseite kann als Übersichtsseite verwendet werden, aber auch fehlen (also als „fiktive Seite“ angesehen werden). Beispiele:

Mit Übersichtsseite für Archive[Bearbeiten]

Zunächst wird die Basisseite als Übersichtsseite angelegt wie im ersten Beispiel, üblicherweise als Link auf der Hauptseite. Diese Seite besteht nur aus dem Aufruf der Vorlage mit zwei Parametern ohne Namen:

{{Archiv Übersicht| (1)| (2) }}

Im Beispiel sieht das so aus:

{{Archiv Übersicht| Wikibooks:Verbesserungsvorschläge/ Archiv| Wikibooks:Verbesserungsvorschläge }}

Damit wird folgende Anzeige erreicht:

Archiv-Übersicht über Wikibooks:Verbesserungsvorschläge

2006 •  2007 •  2008 •  2009 •  2010 •  2011 •  2012 •  2013 •  2014 •  2015 •  2016 •  2017 •  2018 •  2019 • 

Ohne Übersichtsseite für Archive[Bearbeiten]

Wenn auf eine Übersichtsseite für die Archive verzichtet wird, wird der Aufruf der Vorlage direkt in die betreffende Seite geschrieben, beispielsweise bei Benutzer Diskussion:Juetho am Ende des Abschnitts „Zuletzt archivierte Themen“:

{{Archiv Übersicht| Benutzer Diskussion:Juetho/ Archiv | {{FULLPAGENAME}} }}

Die einzelnen Archivseiten[Bearbeiten]

Am Anfang einer jeden dieser Seiten wird in gleicher Weise die Übersicht aufgerufen:

  • Mit einer Übersichtsseite wird diese eingebunden, beispielsweise so (beachte den Doppelpunkt am Anfang):
    {{:Wikibooks:Verbesserungsvorschläge/ Archiv}}
  • Ohne Übersichtsseite wird die Vorlage selbst aufgerufen, aber jetzt mit vollständigem Seitenttitel:
    {{Archiv Übersicht|Benutzer Diskussion:Juetho/ Archiv|Benutzer Diskussion:Juetho}}

Die Parameter[Bearbeiten]

Beide Parameter sind notwendig. Wenn einer fehlt, kann nichts Sinnvolles angezeigt werden – es gibt immer rote Links.

  1. die Basisseite für die Archive (gleichgültig, ob sie als Übersichtsseite vorhanden ist oder fiktiv ist)
    Beispiel: Wikibooks:Verbesserungsvorschläge/ Archiv
    Wichtig ist, dass zwischen dem Wort Archiv und dem folgenden Pipe-Zeichen kein Leerzeichen sein darf.
  2. die Hauptseite, deren Abschnitte archiviert werden
    Beispiel: Wikibooks:Verbesserungsvorschläge
    Wenn die Vorlage direkt in der Seite benutzt wird, kann stattdessen (wie im Beispiel ohne Übersichtsseite) die Kurzform {{FULLPAGENAME}} geschrieben werden.

Die Arbeitsweise[Bearbeiten]

Die Vorlage verwendet zur Anzeige die Vorlage:Box. Der Inhalt der Box enthält als Überschrift den Verweis auf die Hauptseite.

In der zweiten Zeile stehen Links auf alle Jahrgänge des Archivs ab 2004 – zurzeit bis 2016. Für die Prüfung, welche Jahrgänge existieren, wird die Vorlage:Archiv Übersicht Eintrag verwendet (siehe deren Dokumentation). Mit „rotem Link“ werden ggf. das aktuelle Jahr und das Vorjahr versehen; frühere und spätere Jahre werden nur angezeigt, wenn sie vorhanden sind.

Um die Archivierung für spätere Jahre zu ermöglichen, sind lediglich entsprechend viele Einträge zu kopieren (hier für das Jahr 2017):

{{Archiv Übersicht Eintrag | {{{1|}}}| 2017 }}

Weitere Hinweise[Bearbeiten]

Mit einem zusätzlichen Parameter kann auch durch nummerierte Archive navigiert werden. Das ist noch nicht eingebaut.

Theoretisch könnte auf die Parameter verzichtet werden. Das würde aber die Prüfung, in welcher Seite die Vorlage benutzt wird, viel zu kompliziert und unübersichtlich machen; deshalb wurde darauf verzichtet.


TemplateData[Bearbeiten]

Diese Vorlage liefert auf einfache Art eine einheitliche Navigation zwischen Archivseiten:

  • die Hauptseite, zu der die Archive gehören
  • eine Übersichtsseite für die Archive
  • die einzelnen Archivseiten
Zurzeit berücksichtigt diese Navigation Archive, die nach Jahren aufgeteilt sind.

Vorlagenparameter

ParameterBeschreibungTypStatus
Basisseite1

Diejenige Seite, zu der die Archivseiten als Unterseiten gehören (gleichgültig, ob sie als Übersichtsseite vorhanden ist oder fiktiv ist)

Seitennameerforderlich
Hauptseite2

Hauptseite, deren Abschnitte archiviert werden. Wenn die Vorlage direkt in der Seite benutzt wird, kann stattdessen (wie im Beispiel ohne Übersichtsseite) die Kurzform {{FULLPAGENAME}} geschrieben werden.

Seitennameerforderlich