Vorlage:Autoarchiv-Erledigt/Doku

Diese Seite ist die Dokumentations-Unterseite der Vorlage:Autoarchiv-Erledigt.

Die Syntax für die Vorlage Autoarchiv-Erledigt ähnelt durchweg der für Autoarchiv.
Abgearbeitet wird Autoarchiv-Erledigt durch SpBot.

Verwendung der Vorlage

Die Verwendung der Vorlage funktioniert ausschließlich im Zusammenspiel mit der Vorlage:Erledigt. Die „normale“ Archivierung mit Vorlage:Autoarchiv kann aber parallel dazu verwendet werden.

Es ist gleichgültig, wo der Erledigt-Baustein steht. Er bezieht sich jeweils auf die vorangegangene Überschrift der zu archivierenden Überschriftsebene.

Es kann automatisch eine Liste mit den vorhandenen Archivseiten erstellt werden:

Parameter „Alter“

Bei Verwendung dieser Vorlage gibt der Parameter „Alter“ das Alter des Erledigt-Bausteins in Tagen an. Nach dieser Zeit wird der entsprechende Abschnitt archiviert.

Parameter „Ziel“

Zur „Ziel“-Angabe können folgende Variablen verwendet werden:

Variable	Erklärung
((Jahr))	Das Jahr z. B. 2024
((Monat:Lang))	Monatsname z. B. Februar
((Monat:Kurz))	verkürzter Monatsname z. B. Feb
((Monat:##))	Monatsname als zweistellige Zahl z. B. 02
((Woche))	Kalenderwoche als Zahl z. B. 15, 4
((Woche:##))	Kalenderwoche als zweistellige Zahl z. B. 15, 04
((Tag:##))	Datum als zweistellige Zahl z. B. 31, 07
((Quartal))	Quartal als Zahl z. B. 3
((Quartal:##))	Quartal als zweistellige Zahl z. B. 03
((Quartal:i))	Quartal als kleine römische Zahl z. B. iii
((Quartal:I))	Quartal als große römische Zahl z. B. III
((Halbjahr))	Halbjahr als Zahl z. B. 2
((Halbjahr:##))	Halbjahr als zweistellige Zahl z. B. 02
((Halbjahr:i))	Halbjahr als kleine römische Zahl z. B. ii
((Halbjahr:I))	Halbjahr als große römische Zahl z. B. II
((VOLLER_SEITENNAME)), ((Lemma)), ((FULLPAGENAME))	Namensraum und Titel der momentanen Seite. Wie bei `{{VOLLER_SEITENNAME}}`, aber mit normaler Klammer.

Beispiel: Ziel='Wikipedia:Redaktion Bilder/Archiv/((Jahr))/((Quartal))', wobei das Apostroph vorne und hinten optional ist.

Parameter „Übersicht“

Mit dem Parameter „Übersicht“ lässt sich ein Hinweis geben, wo sich die Archivseite befindet. So wird mit Übersicht=[[Wikipedia:Redaktion Chemie/Archiv]] im Baustein der folgende Text generiert:

„Die Archivübersicht befindet sich unter Wikipedia:Redaktion Chemie/Archiv.“

Parameter „aktuelles Archiv“

Mit dem Parameter „aktuelles Archiv“ kann man einen Verweis auf die aktuelle Archivseite einfügen. Mit aktuelles Archiv=[[Wikipedia Diskussion:Bots/Anfragen/Archiv 2009]] wird der folgende Text erzeugt:

„Das aktuelle Archiv befindet sich unter Wikipedia Diskussion:Bots/Anfragen/Archiv 2009.“

Parameter „Kopfvorlage“ (veraltet)

Standardmäßig wird {{Archiv}} gesetzt. Daher kann auch die Möglichkeit genutzt werden, ein eigenes Design über diese Vorlage zu setzen. Der Parameter „Kopfvorlage“ war die vorherige Lösung, bei der die benannte Vorlage am Anfang automatisch eingebunden wurde, um zu kennzeichnen, dass es sich um ein Archiv handelt. Der Parameter sollte nicht mehr verwendet werden. Folge stattdessen dieser Möglichkeit!

Parameter „Zeigen“

Der Parameter „Zeigen“ gibt an, ob der Bausteintext angezeigt (Zeigen=Ja oder Zeigen=Nein) werden soll. Dies ist sinnvoll, wenn er auf einer Seite verwendet wird, auf der ohnehin im Kopf steht, wohin und wie archiviert wird, zum Beispiel wie bei Wikipedia:Redaktion Chemie. Standardmäßig wird der Text angezeigt.

Parameter „Ebene“

Der Parameter „Ebene“ gibt an, welche Überschriftsebene archiviert werden soll (ausdrücklich empfohlener Standardwert ist „2“). Bei Weglassen wird Wert „2“ angenommen. Alle tieferen Ebenen eines markierten Abschnitts werden mit-archiviert.

Beispiel

==== Diskussionsüberschrift Ebene IV ====

wird angezeigt als

Diskussionsüberschrift Ebene IV

Derlei würde archiviert bei Markierung von „Ebene=2“ oder „Ebene=3“ oder „Ebene=4“.

Parameter „Zeitvergleich“

Dieser Parameter gibt an, nach welchem Zeitstempel der Bot die Einsortierung in Archive vornehmen soll. Im Parameter Ziel können Variablen in Bezug auf das Datum benutzt werden. „Zeitvergleich“ definiert, welcher Zeitstempel dafür herangezogen wird.

Zeitvergleich = erledigt: Zeitstempel im {{Erledigt}}-Baustein wird benutzt.
Andere Werte oder bei Weglassen: Ältester Zeitstempel des Abschnitts wird benutzt.

Beispielseite: Wikipedia Diskussion:Hauptseite/Artikel des Tages/Vorschläge

Parameter „Zeitbeschränkung“

Gibt an, nach wie vielen Tagen ein Abschnitt ohne neue Beträge automatisch erledigt ist, auch wenn kein {{Erledigt}}-Baustein gesetzt wurde. Archiviert wird nach Ablauf der Zeit nur, wenn dieser Parameter gesetzt wurde (und ungleich 0 ist). In diesem Fall wird auch {{Nicht archivieren}} beachtet. Mit Setzen des Parameters lässt sich das Verhalten der {{Autoarchiv}} erreichen, wobei - analog dazu - die Parameter „Mindestbeiträge=1“, „Mindestabschnitte=0“ und „Frequenz=ständig“ (=nächtlich) impliziert werden. In diesem Fall ist es auch nicht mehr nötig diese Vorlage und zusätzlich {{Autoarchiv}} einzubinden, die von zwei verschiedenen Bots abgearbeitet werden, sondern nur noch {{Autoarchiv-Erledigt}} für SpBot.

Nicht unterstützt

Parameter „Mindestbeiträge“, „Modus“ und „Klein“

Die Parameter „Mindestbeiträge“, „Modus“ und „Klein“ haben in Verwendung mit dieser Vorlage keine Funktion, sondern nur bei Vorlage:Autoarchiv.

Parameter „Frequenz“

Der Parameter „Frequenz“ wird von dieser Vorlage nicht unterstützt. Der Bot kontrolliert zurzeit einmal pro Nacht alle Seiten, die diese Vorlage einbinden.

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 C]] genutzt, welches dann in [[Wikipedia:Testprojekt]] zwecks Zusammenfassung eingebunden wird. 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 /Arbeitsliste C in <noinclude>-Tags eingehüllt werden.

Beispiel

Folgendes Beispiel ist der Wikipedia:Redaktion Chemie entnommen. Alle markierten Beiträge der Überschriftsebene 2 (also alle Überschriften mit ==) werden sieben Tage nach Setzen der {{Erledigt}} ins Archiv verschoben. Das Archiv befindet sich unter Wikipedia:Redaktion Chemie/Archiv. Archiviert wird also beispielsweise nach Wikipedia:Redaktion Chemie/Archiv/2014/Januar, sofern der erste Beitrag im Abschnitt im Januar erstellt wurde.

{{Autoarchiv-Erledigt
 |Alter=7
 |Ziel='((VOLLER_SEITENNAME))/Archiv/((Jahr))/((Monat:Lang))'
 |Übersicht=[[Spezial:Präfixindex/{{ers:VOLLER_SEITENNAME}}/Archiv|Archiv]]
}}

Das sieht dann beispielsweise wie folgt aus:

Automatische Archivierung

Auf dieser Seite werden Abschnitte automatisch archiviert, die seit 7 Tagen mit dem Baustein {{Erledigt|1=~~~~}} versehen sind. Die Archivübersicht befindet sich unter Wikipedia:Redaktion Chemie/Archiv.

Weiteres Beispiel für eine frequentiertere Benutzerdiskussionsseite – gekennzeichnete Beiträge werden nach einem Tag quartalsweise archiviert:

{{Autoarchiv-Erledigt
 |Alter=1
 |Ziel='((VOLLER_SEITENNAME))/Archiv/((Jahr))/((Quartal:I))'
}}

Ergebnis:

Automatische Archivierung

Auf dieser Seite werden Abschnitte automatisch archiviert, die seit einem Tag mit dem Baustein {{Erledigt|1=~~~~}} versehen sind.

Mittels {{Archivübersicht|[[Spezial:Präfixindex/{{VOLLER_SEITENNAME}}/Archiv|Archivübersicht]]}} lässt sich alternativ zum Parameter „Übersicht“ eine Archivübersicht mit Durchsuchfunktion des Archivs in die Seite einbauen – Ergebnis beispielsweise:

Archiv

Archivübersicht
Wie wird ein Archiv angelegt?

`{{Nicht archivieren}}`

Diese Vorlage wird nur beachtet, wenn der Parameter Zeitbeschränkung verwendet wird. Ansonsten nicht, weil die Archivierung ohnehin nicht ohne ein {{Erledigt}} im Abschnitt ausgeführt wird.

Erkennung von Zeitstempeln bzw. Signaturen

Der Bot nutzt das von der MediaWiki-Software vorgegebene Zeitstempelformat (Datums- und Uhrzeitsteil von Signaturen, beispielsweise 09:33, 5. Nov. 2024). Um vom Bot zuverlässig erkannt zu werden, müssen Zeitstempel einer der beiden folgenden Konstruktionen entsprechen:

Sommerzeit (CEST):

{{ers:LOKALE_UHRZEIT}}, {{ers:LOKALER_KALENDERTAG}}. {{ers:LOKALER_MONATSNAME_KURZ}} {{ers:LOKALES_JAHR}} (CEST)

Winterzeit (CET):

{{ers:LOKALE_UHRZEIT}}, {{ers:LOKALER_KALENDERTAG}}. {{ers:LOKALER_MONATSNAME_KURZ}} {{ers:LOKALES_JAHR}} (CET)

Wartungslisten

Diskussionsseiten mit Fehlern in den Parametern dieser Vorlage und der Vorlage {{Erledigt}} werden in den folgenden Listen und auf der Diskussionsseite selbst angezeigt.

Fehlerlisten

Fehlermeldungen des Bots (bitte die letzte Zeile anschließend entfernen)
Fehler in Parametern der Vorlage:Erledigt
Alter ist leer
Ziel ist fehlerhaft

Infolisten

Commons

Commons: Template:Autoarchive resolved section – Diese Vorlage auf Commons