Vorlage:Autoarchiv-Erledigt/Doku

Die Grundfunktionen der Vorlage Autoarchiv-Erledigt mit seinem Bot ähnelt der Vorlage:Autoarchiv.

Es sollte nur eine der beiden Archivvorlagen in einer Seite eingebunden werden.

FunktionsweiseBearbeiten

Einmal nachts[1] durchläuft der SpBot alle Seiten, auf denen diese Vorlage eingebunden ist. Finden sich dort Abschnitte, die nach den angegebenen Kriterien archivierbar sind, werden sie auf die entsprechenden Seiten verschoben.

Verwendung der VorlageBearbeiten

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

Bei der Einbindung ist nachfolgendes zu beachten:

  • Diese Vorlage sollte nicht im Artikelnamensraum benutzt werden, da die Seite ggf. völlig geleert wird.
  • Die Parameter „Ziel“ und „Alter“ müssen immer angegeben werden.
  • Die Vorlage muss immer auf der betreffenden Seite selbst stehen, siehe Kaskadierung.
  • Die Parameter „Alter“, „Ziel“, „Ebene“, „Zeitvergleich“, „Zeitbeschränkung“ und „Kopfvorlage“ 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. Wiki-Variablen, Funktionen, Links und Tags) verwendet werden.
  • Das Archivendvolumen ist von Zeit zu Zeit (ggf. nach Diskussion) an die Infrastrukturentwicklung anpassen, 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 Namen 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 „Alter“Bearbeiten

Bei Verwendung dieser Vorlage gibt der Parameter das Alter des Erledigt-Bausteins in Tagen an, nach wie vielen der entsprechende Abschnitt archiviert werden soll.

Es ist gleichgültig, wo {{Erledigt}} steht, sie bezieht sich jeweils auf die vorangegangene Überschrift der zu archivierenden Überschriftebene.

Parameter „Ziel“Bearbeiten

Die Seite, auf der die Abschnitte abgelegt werden sollen, wobei das Apostroph vorne und hinten optional ist.

In der Regel sollten die Archive eine Unterseite der aktuellen Seite sein. Um fehlerhafte Schreibweisen durch Tippfehler oder Fehler bei evtl. spätere Verschiebung der Seite auszuschließen, ist die Botvariable ((Lemma)), ((VOLLER_SEITENNAME)) oder ((FULLPAGENAME)) zu benutzen.

Eine explizite feste Angabe des Zieles ist nur in speziellen Fallen notwendig, wenn auf eine andere Seite oder Unterseite gesichert werden muss.

Eine relative Pfadangabe (erstes Zeichen "/" wie z. B. Ziel='/Archiv') ist nicht erlaubt.

Im Parameter können die folgenden Botvariablen mit nachstehenden Codes benutzt werden:

Variable Erklärung
((Lemma)),
((VOLLER_SEITENNAME)),
((FULLPAGENAME))
Namensraum und Titel der momentanen Seite. Wie bei {{VOLLER_SEITENNAME}}, aber mit normaler Klammer.
((Jahr)) Das Jahr z. B. 2022
((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

Beispiele:

  1. Ziel='((Lemma))/Archiv1'
  2. Ziel='((Lemma))/Archiv/1'
  3. Ziel='((Lemma))/Archiv/((Jahr))'
  4. Ziel='((Lemma))/Archiv/((Jahr))/((Quartal))'

Parameter „Ebene“Bearbeiten

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

Beim Weglassen wird Ebene=2 angenommen.

Beispiele:

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

Parameter „Zeitvergleich“Bearbeiten

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.

  • erledigt: Zeitstempel im {{Erledigt}}-Baustein wird benutzt.
  • Andere Werte oder weggelassen: Ältester Zeitstempel des Abschnitts wird benutzt.

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

Parameter „Zeitbeschränkung“Bearbeiten

Gibt an, nach wie vielen Tagen ein Abschnitt automatisch archiviert wird, wenn kein {{Erledigt}}-Baustein gesetzt wurde. Archiviert wird nach Ablauf der Zeit nur, wenn dieser Parameter größer als 0 gesetzt wurde. Archiviert wird, wenn mindestens ein Beitrag im Abschnitt ist. In diesem Fall wird auch {{Nicht archivieren}} beachtet.

Hinweis: Soll ausschließlich nach Zeitablauf archiviert, so muss der Parameter „Alter“ auf einen sehr hohen Wert gesetzt werden (z. B. 999999).

Parameter „Kopfvorlage“ (veraltet)Bearbeiten

Standardmäßig wird Vorlage: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 „Übersicht“Bearbeiten

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.

Beispiele:

  1. Übersicht=[[Spezial:Präfixindex/{{ers:VOLLER_SEITENNAME}}/Archiv|Übersicht]] um zu einer „automatischen Übersicht“ aller Archivseiten zu verlinken.
  2. Übersicht=[[{{VOLLER_SEITENNAME}}/Archiv|Übersicht]] um zu einer Seite zu verlinken, wo sich das Archivverzeichnis mit den Links zu den einzelnen Teilarchiven befindet. Diese Seite muss manuell gepflegt werden.

Parameter „aktuelles Archiv“Bearbeiten

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: aktuelles Archiv=[[{{VOLLER_SEITENNAME}}/Archiv/1|Archiv/1]], wenn als Ziel='((Lemma))/Archiv/1))' verwendet wird.

Parameter „Zeigen“Bearbeiten

Der Parameter gibt an, ob der Bausteintext angezeigt (Zeigen=Ja) oder nicht angezeigt (Zeigen=Nein) werden soll.

Standardmäßig wird der Text angezeigt.

Zeigen=Nein ist nur dann sinnvoll, wenn er auf einer Seite verwendet wird, auf der ohnehin im Kopf steht wann und wie archiviert wird (z. B. wie bei Wikipedia:Redaktion Chemie).

Parameter „Icon“Bearbeiten

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

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

KaskadierungBearbeiten

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

Beispiele:

  1. {{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.
  2. {{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 Tags <noinclude> eingehüllt werden.

Abschnitte vor dem Archivieren schützenBearbeiten

Die Vorlage {{Nicht archivieren}} wird nur beachtet, wenn die Archivierung aufgrund des Ablaufes der in Parameter „Zeitbeschränkung“ angegebenen Zeit erfolgen soll.

Ist die Vorlage {{Erledigt}} im Abschnitt eingebunden und die Zeit in Parameter „Alter“ abgelaufen, wird eine Vorlage {{Nicht archivieren}} ignoriert.

Erkennung von Zeitstempeln bzw. SignaturenBearbeiten

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 (Winterzeit): 16:10, 14. Aug. 2021 (CET)
{{ers:LOKALE_UHRZEIT}}, {{ers:LOKALER_KALENDERTAG}}. {{ers:LOKALER_MONATSNAME_KURZ}} {{ers:LOKALES_JAHR}} (CET)

BeispieleBearbeiten

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

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

Ergebnis:

Automatische Archivierung
Auf dieser Seite werden Abschnitte ab Überschriftebene 2 automatisch archiviert, die seit 7 Tagen mit dem Baustein {{Erledigt|1=--~~~~}} versehen sind oder deren jüngster Beitrag 365 Tage alt ist. Das aktuelle Archiv befindet sich unter Archiv/1.
Stark frequentierte Diskussionsseite

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. Archiviert wird also beispielsweise nach Wikipedia:Redaktion Chemie/Archiv/2014/Januar, sofern der erste Beitrag im Abschnitt im Januar erstellt wurde. Die Seite mit dem manuell gepflegtem Archivverzeichnis befindet sich unter Wikipedia:Redaktion Chemie/Archiv.

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

Ergebnis:

Automatische Archivierung
Auf dieser Seite werden Abschnitte ab Überschriftebene 2 automatisch archiviert, die seit 7 Tagen mit dem Baustein {{Erledigt|1=--~~~~}} versehen sind. Die Archivübersicht befindet sich unter Übersicht.
äußerst stark frequentierte Diskussionsseite

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

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

Ergebnis:

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

WartungslistenBearbeiten

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

  • Fehlermeldungen des Bots werden aufgelistet in der Kategorie:Wikipedia:Fehlerhafte Autoarchiv-Parameter/SpBot – aktuell keine
  • Fehlerhafte Einbindungen werden aufgelistet in der Kategorie:Wikipedia:Vorlagenfehler/Vorlage:Autoarchiv-Erledigt – aktuell keine  
  • Fehlerhafte Einbindungen werden aufgelistet in der Kategorie:Wikipedia:Vorlagenfehler/Vorlage:Autoarchiv-Erledigt/Ziel – aktuell keine     (5. Juli 2022 03:44) Aktualisieren
  • Vorlage:Autoarchiv-Erledigt/Wartung/BeideVorlagen - Liste aller Seiten, die sowohl {{Autoarchiv-Erledigt}} als auch {{Autoarchiv}} verwenden.

Infolisten:

Siehe auchBearbeiten

AnmerkungenBearbeiten

  1. ab 3:00 UTC

CommonsBearbeiten

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