Vorlage:Autoarchiv-Erledigt/Doku

Diese Vorlage markiert eine Diskussionsseite zur automatischen Archivierung. Zu anderen Möglichkeiten des Archivierens siehe Hilfe:Archivieren.

Die Grundfunktionen dieser Vorlage mit seinem Bot ähnelt der Vorlage:Autoarchiv.
Es soll nur eine der beiden Archivvorlagen auf einer Seite eingebunden werden. Zur Entscheidungshilfe siehe diese Hilfeseite.

Funktionsweise des Bot

Einmal täglich ab 4:00 Uhr^[1] durchläuft der SpBot alle Seiten, auf denen diese Vorlage eingebunden ist.
Wenn die Archivseite (Ziel) nicht existiert, erstellt der Bot beim ersten Archivieren diese mit dem Inhalt {{Archiv}} um zu kennzeichnen, dass es sich um ein Archiv handelt.
Werden auf der Seite nach den angegebenen Kriterien archivierbare Abschnitte gefunden, werden sie auf die im Parameter Ziel angegebenen Seiten verschoben.

Kopiervorlagen

Info: Bei Einbindung im Namensraum "Diskussion" (Artikeldiskussion) ist der Parameter Zeitbeschränkung wegzulassen, da sonst die Diskussionsseite vollständig geleert wird.

alle Parameter

{{Autoarchiv-Erledigt
 | Alter            =
 | Zeitbeschränkung =
 | Ziel             =
 | Ebene            =
 | Zeitvergleich    =
 | Zeigen           =
 | Übersicht        =
 | aktuelles Archiv =
 | Icon             = 
}}

Mit Standardwerten (in allen Namensräumen einsetzbar)

{{Autoarchiv-Erledigt
 |Alter            = 7
 |Ziel             = ((Lemma))/Archiv/1
 |aktuelles Archiv = [[/Archiv/1]]
 |Übersicht        = [[Spezial:Präfixindex/{{VOLLER_SEITENNAME}}/Archiv|dieser Spezialseite]]
}}

Mögliche Einbindungen auf Namensräumen größer 1 (z. B. "Benutzer Diskussion")

{{Autoarchiv-Erledigt
 |Alter            = 7
 |Zeitbeschränkung = 365
 |Ziel             = ((Lemma))/Archiv
 |aktuelles Archiv = [[/Archiv]]
}}

Siehe auch: Beispiele

Verwendung der Vorlage

Die Verwendung der Vorlage funktioniert im Zusammenspiel mit der Vorlage:Erledigt sowie über Benutzung des Parameters Zeitbeschränkung auch ohne diese.

Das Layout der Kopfvorlage des Archivs {{Archiv}} kann für jede Seite über diese Möglichkeit angepasst werden!

Bei der Einbindung ist Nachfolgendes zu beachten:

Diese Vorlage muss möglichst am Anfang der Seite vor dem ersten Abschnitt eingebunden werden.
Die Parameter Ziel und Alter müssen immer angegeben werden.
Diese Vorlage sollte im Artikeldiskussionsnamensraum nicht mit dem Parameter Zeitbeschränkung benutzt werden, da die Seite ggf. völlig geleert wird.
Da der Bot den Seitentext unaufbereitetet und unabhängig von der Mediawiki-Software verarbeitet ist folgendes wichtig:
- Die Vorlage muss immer auf der betreffenden Seite selbst stehen, siehe Kaskadierung.
- Die Parameter Ziel, Alter, Ebene, Zeitbeschränkung und Zeitvergleich werden vom Bot ausgewertet.
- Damit die darin angegebenen Werte korrekt vom Bot verarbeitet werden, dürfen keine geschweiften, eckigen oder spitzen Klammern ({, }, [, ], <, > wie z. B. Vorlagen, Parserfunktionen, Links und Tags) innerhalb der Vorlage verwendet werden.
- Im gesamten Text der Seite werden Einbindungen und Zeitstempel vom Bot ignoriert, wenn diese in <nowiki>, <code>, <pre> oder <!-- eingeschlossen sind.
Das Archivendvolumen ist von Zeit zu Zeit (ggf. nach Diskussion) an die Infrastrukturentwicklung anzupassen, wobei Größen bis rund 250 kB praktikabel sein dürften.
- Wenn die maximale Größe der aktiven Archivseite erreicht ist, wird dies von der standardmäßigen {{Archiv}} in der Linkliste großes aktives Archiv angezeigt.
- Die Größe der Archivseiten kann auch über die Seiteninformationen, ansonsten auch Seite bearbeiten und Vorschau zeigen überprüft werden.
- Bei Angabe von festen Archivnamen im Parameter Ziel, wie z. B. Ziel=((Lemma))/Archiv/1, ist dann der Parameter auf das nächste Teilarchiv (Ziel=((Lemma))/Archiv/2) zu ändern und ggf. auch der Parameter aktuelles Archiv anzupassen.

Parameter

Ziel

Dieser Pflichtparameter gibt die Seite an, auf der die Abschnitte abgelegt werden sollen.

In der Regel sollten die Archive eine Unterseite der aktuellen Seite sein
Der Name der Unterseite oder das Archiv muss mit Archiv beginnen.
Die Namensbereiche Benutzer und Benutzer Diskussion sind diesbezüglich ausgenommen.
Um fehlerhafte Schreibweisen durch Tippfehler oder Fehler bei evtl. spätere Verschiebung der Seite auszuschließen, sind die Seiten-Botvariablen zu benutzen.
Eine explizite feste Angabe des Zieles ist nur in sehr wenigen speziellen Fallen notwendig, z. B. in den Namensräumen größer 3 - wie Wikipedia und Portal - wenn die Zeichenkette /Archiv nirgends im Wert des Parameters auftritt und dieses Ziel in Ausnahmen eingetragen ist.
Eine relative Pfadangabe (erstes Zeichen "/" wie z. B. Ziel=/Archiv ist nicht erlaubt.

Zur Kompatibilität mit älteren Einbindungen werden den Parameterwert einschließende Apostrophe (Ziel='…') vom Bot ignoriert.

Botvariablen

Im Parameter können die folgenden Botvariablen mit nachstehenden Codes benutzt werden.
Beachte, dass die Botvariablen zwei runde Klammern haben.

Seitenvariablen
Variable	Erklärung	Beispiel für diese Seite
((Lemma))	Der volle Seitenname der momentanen Seite. (bei Einbindung in der Hauptseite der Diskussionsseiten ist das der Namensraum und Titel der Seite.)	Vorlage:Autoarchiv-Erledigt/Doku
((VOLLER_SEITENNAME))
((FULLPAGENAME))

Zeitvariablen
Variable	Erklärung	Beispiel für den 4. Februar 2022	Beispiel für den 9. November 2023
((Jahr))	Jahr	2022	2023
((Monat:Lang))	Monatsname	Februar	November
((Monat:Kurz))	verkürzter Monatsname	Feb	Nov
((Monat:##))	Monatsname als zweistellige Zahl	02	11
((Woche))	Kalenderwoche als Zahl	5	45
((Woche:##))	Kalenderwoche als zweistellige Zahl	05	45
((Tag:##))	Tag des Monats als zweistellige Zahl	04	09
((Quartal))	Quartal als Zahl	1	4
((Quartal:##))	Quartal als zweistellige Zahl	01	04
((Quartal:i))	Quartal als kleine römische Zahl	i	iv
((Quartal:I))	Quartal als große römische Zahl	I	IV
((Halbjahr))	Halbjahr als Zahl	1	2
((Halbjahr:##))	Halbjahr als zweistellige Zahl	01	02
((Halbjahr:i))	Halbjahr als kleine römische Zahl	i	ii
((Halbjahr:I))	Halbjahr als große römische Zahl	I	II

Beispiele

Ziel=((Lemma))/Archiv1
Ziel=((Lemma))/Archiv/1
Ziel=((Lemma))/Archiv/((Jahr))
Ziel=((Lemma))/Archiv/((Jahr))/((Quartal))

Alter

Der Pflichtparameter gibt das Alter des Erledigt-Bausteins in Tagen an, nach wie vielen der entsprechende Abschnitt archiviert werden soll.
Der Wert darf nicht kleiner 0 und kann mit einer Dezimalstelle angegeben werden.^[2]

Zur besseren Übersichtlichkeit sollte {{Erledigt|1=--~~~~}} jeweils am Ende des Abschnittes eingebunden werden.
Info: Es ist jedoch gleichgültig, wo diese Vorlage steht, sie bezieht sich jeweils auf die vorangegangene Überschrift der zu archivierenden Überschriftebene.

Zeitbeschränkung

Gibt an, nach wie vielen Tagen nach dem Zeitstempel des jüngsten Beitrags ein Abschnitt automatisch archiviert wird.
Der Wert muss größer 0 und kann mit einer Dezimalstelle angegeben werden.^[2] Hinweis: Soll ausschließlich nach Zeitablauf archiviert, so muss der Parameter Alter auf einen sehr hohen Wert gesetzt werden (z. B. 999999 = 2.739 Jahre).

Ebene

Der Parameter gibt an, welche Überschriftebene archiviert werden soll. Alle tieferen Ebenen eines markierten Abschnitts werden mit archiviert.

Der Wert muss im Bereich 2-9 liegen.
Beim Weglassen wird Ebene=2 angenommen.

Beispiele:

Wird Ebene=3 angegeben, so werden die Überschriften der Ebene 2 (== Überschrift Ebene 2 ==) nicht archiviert.
Die Überschriften der Ebene 4 (==== Überschrift Ebene 4 ====) werden bei Angabe von Ebene=2, Ebene=3 oder Ebene=4 archiviert.

Zeitvergleich

Dieser Parameter gibt an, nach welchem Zeitstempel der Bot die Einsortierung in Archive vornehmen soll, wenn im Parameter Ziel Variablen in Bezug auf das Datum benutzt werden.

• `Zeitvergleich=erledigt`:	Zeitstempel im Erledigt-Baustein wird benutzt.
• Andere Werte oder weggelassen:	Ältester Zeitstempel des Abschnitts wird benutzt.

Zeigen

Mit diesem Parameter kann man die Anzeige des Bausteintext unterdrücken.

• `Zeigen=Nein` oder `Zeigen=nein`:	Der Baustein wird nicht angezeigt.
• Andere Werte oder weggelassen:	Der Baustein wird angezeigt.

Wird der Baustein nicht angezeigt, so sind die Parameter Übersicht, aktuelles Archiv und Icon wegzulassen!

Es ist nur dann sinnvoll den Baustein nicht anzuzeigen, wenn auf der Seite im Kopf für alle Archivierungsoptionen angegeben wird, unter welchen Bedingungen archiviert wird (z. B. wie bei Wikipedia:WikiProjekt Vorlagen/Werkstatt).

Im Namensraum "Diskussion" (Artikeldiskussionsseiten) ist es jeher nicht üblich die Anzeige des Bausteins zu unterdrücken.

Übersicht

Wenn mehrere Archive angelegt worden, gibt man mit diesem Parameter eine Seite an, in der sich das Archivverzeichnis befindet.

Dadurch wird im Kasten der Satz „Die Archivübersicht befindet sich unter [Link auf Archivübersicht].“ eingefügt.

Bei nur einer Archivseite empfiehlt es sich, diesen Parameter wegzulassen und nur den Parameter aktuelles Archiv zu benutzen.

Beispiele:

Vorzugsweise ist zu einer „automatischen Übersicht“ aller Archivseiten zu verlinken.
Folgendes Beispiel gilt bei "Ziel=((Lemma))/Archiv…", "Ziel=((FULLPAGENAME))/Archiv..." bzw. "Ziel=((VOLLER_SEITENNAME))/Archiv...":
Übersicht=[[Spezial:Präfixindex/{{VOLLER_SEITENNAME}}/Archiv|dieser Spezialseite]] oder
Übersicht=[[Spezial:Präfixindex/{{FULLPAGENAME}}/Archiv|dieser Spezialseite]]
Um zu einer manuell gepflegten Unterseite "/Archivliste" zu verlinken, wo sich das Archivverzeichnis mit den Links zu den einzelnen Teilarchiven befindet nutze:
Übersicht=[[/Archivliste]]

aktuelles Archiv

Mit diesem Parameter fügt man einen Verweis auf die einzige bzw. aktuelle Archivseite ein. Es wird im Kasten der Satz „Das aktuelle Archiv befindet sich unter [Link auf Archiv].“ eingefügt.

Beispiel, wenn Ziel=((Lemma))/Archiv/1)) verwendet wird: aktuelles Archiv=[[/Archiv/1]]

Icon

Mit diesem Parameter kann das Bild vorn im Kasten geändert werden.

Standardmäßig wird Filing cabinet icon.svg verwendet.

Kaskadierung

Diese Vorlage darf nicht per Vorlage eingebunden werden. Der Bot wird auf der betroffenen Seite einen Fehler melden.

Beispiele:

{{Autoarchiv-Erledigt}} wird nach Wikipedia:Testprojekt/Intro verlagert, welches dann in Wikipedia:Testprojekt eingebunden wird.
Die Vorlage wird zwar korrekt angezeigt, aber der Bot wird zur scheinbaren Einbindung auf Wikipedia:Testprojekt keine Vorlage im Quelltext finden.
{{Autoarchiv-Erledigt}} wird in Wikipedia:Testprojekt/Arbeitsliste genutzt, welches dann in Wikipedia:Testprojekt zwecks Zusammenfassung eingebunden wird.
Die Vorlage wird zwar korrekt angezeigt, der Bot wird auch hier zur scheinbaren Einbindung auf Wikipedia:Testprojekt keine Vorlage im Quelltext finden.
Da auf Wikipedia:Testprojekt selber aber auch nicht archiviert werden soll, muss {{Autoarchiv-Erledigt}} auf der Seite Wikipedia:Testprojekt/Arbeitsliste in Tags <noinclude> eingehüllt werden.

Abschnitte vor dem Archivieren schützen

Um einen bestimmten Abschnitt und eventuell vorhandene Unterabschnitte nicht zu archivieren (oder das Archivieren zu verhindern), kann die Vorlage:Nicht archivieren verwendet werden.
Diese Vorlage sollte dabei stets direkt unterhalb der Überschrift des betreffenden Abschnitts eingefügt werden.

Erkennung von Zeitstempeln bzw. Signaturen

Der Bot nutzt das von der MediaWiki-Software vorgegebene Zeitstempelformat (Datum und Uhrzeit von Signaturen).

Um vom Bot zuverlässig erkannt zu werden, müssen Zeitstempel einer der beiden folgenden Konstruktionen entsprechen:

Sommerzeit: 16:10, 14. Aug. 2021 (CEST)
{{ers:LOKALE_UHRZEIT}}, {{ers:LOKALER_KALENDERTAG}}. {{ers:LOKALER_MONATSNAME_KURZ}} {{ers:LOKALES_JAHR}} (CEST)

Normalzeit: 16:10, 14. Aug. 2021 (CET)
{{ers:LOKALE_UHRZEIT}}, {{ers:LOKALER_KALENDERTAG}}. {{ers:LOKALER_MONATSNAME_KURZ}} {{ers:LOKALES_JAHR}} (CET)

Beispiele

Sie können als Kopiervorlage verwendet werden, ggf. können die Parameter noch angepasst werden.

Normal frequentierte Diskussionsseite

Alle markierten Beiträge der Überschriftsebene 2 (also alle Überschriften mit ==) werden sieben Tage nach Setzen der Vorlage {{Erledigt}} ins Archiv verschoben.

{{Autoarchiv-Erledigt
 |Alter=7
 |Ziel=((Lemma))/Archiv/1
 |aktuelles Archiv=[[/Archiv/1]]
}}

Ergebnis:

Auf dieser Seite werden Abschnitte ab Überschriftenebene 2 automatisch archiviert, die seit 7 Tagen mit dem Baustein {{Erledigt|1=--~~~~}} versehen sind. Das aktuelle Archiv befindet sich unter /Archiv/1.

Stark frequentierte Diskussionsseite

Alle markierten Beiträge der Überschriftsebene 2 (also alle Überschriften mit ==) werden sieben Tage nach Setzen der Vorlage {{Erledigt}} ins Archiv verschoben. Archiviert wird also beispielsweise nach "Wikipedia:Redaktion Chemie/Archiv/2014", sofern der erste Beitrag im Abschnitt im Jahr 2014 erstellt wurde. Die Seite mit dem manuell gepflegtem Archivverzeichnis befindet sich unter "Wikipedia:Redaktion Chemie/Archivliste".

{{Autoarchiv-Erledigt
 |Alter=7
 |Ziel=((Lemma))/Archiv/((Jahr))
 |Übersicht=[[/Archivliste]]
}}

Ergebnis:

Automatische Archivierung

Auf dieser Seite werden Abschnitte ab Überschriftenebene 2 automatisch archiviert, die seit 7 Tagen mit dem Baustein {{Erledigt|1=--~~~~}} versehen sind. Die Archivübersicht befindet sich unter Archivliste.

Äußerst stark frequentierte Diskussionsseite

Weiteres Beispiel für eine stärker frequentierte Benutzerdiskussionsseite, gekennzeichnete Beiträge werden hier nach einem Tag quartalsweise archiviert. Die automatisch erzeugte Archivübersicht ist unter dieser Spezialseite verlinkt.

{{Autoarchiv-Erledigt
 |Alter=1
 |Ziel=((FULLPAGENAME))/Archiv/((Jahr))/((Quartal:I))
 |Übersicht=[[Spezial:Präfixindex/{{FULLPAGENAME}}/Archiv|dieser Spezialseite]]
 |Zeitvergleich=erledigt
}}

Ergebnis:

Automatische Archivierung

Auf dieser Seite werden Abschnitte ab Überschriftenebene 2 automatisch archiviert, die seit einem Tag mit dem Baustein {{Erledigt|1=--~~~~}} versehen sind. Die Archivübersicht befindet sich unter dieser Spezialseite. Archiviert wird hier gemäß Zeitstempel im Erledigt-Baustein.