Vorlage:Autoarchiv/Doku

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

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

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

Diese Vorlage ist vielfach eingebunden. Wenn du die Auswirkungen genau kennst, kannst du sie bearbeiten. Meist ist es jedoch sinnvoll, Änderungswünsche erst auf Vorlage Diskussion:Autoarchiv abzustimmen.

Sollte es zu Problemen mit dem TaxonBot kommen, hinterlasse bitte einen Hinweis auf der Benutzerdiskussionsseite. Bei Bedarf sollte der TaxonBot auch gesperrt werden, melde ihn dazu unter Wikipedia:Vandalismusmeldung.

Funktionsweise

Zweimal pro Tag (ab 0:00 Uhr und ab 12.00 Uhr) durchläuft der TaxonBot 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.

Technische Details

Der Bot läuft für jede Diskussionsseite die folgenden Schritte durch:

1. Die Seite wird in ihre Abschnitte zerlegt.
2. Für jeden Abschnitt werden der Entstehungszeitpunkt (Datum des ersten Beitrags) und das Alter (Datum des letzten Beitrags) ermittelt.
3. Alle Abschnitte, die nicht das angegebene Alterskriterium erfüllen, bleiben unverändert auf der ursprünglichen Seite bestehen.
4. Der Rest wird unter Auswertung des Zielparameters an das Ende der jeweils entsprechenden Archivierungsseite gestellt.

Einbindung

Diese Vorlage muss am Anfang der Seite eingebunden werden, möglichst vor dem ersten Abschnitt.

Die Vorlage muss immer auf der betreffenden Seite selbst stehen, sie kann also nicht über einen anderen Baustein oder eine ausgelagerte /Intro eingebunden werden.

Kopiervorlagen

alle Parameter

{{Autoarchiv
 | Alter             =
 | Ziel              =
 | Modus             =
 | Mindestabschnitte =
 | Mindestbeiträge   =
 | Klein             =
 | Frequenz          =
 | Zeigen            =
 | clear             =
 | Übersicht         =
 | aktuelles Archiv  =
 | Icon              =
 | Kommentar         =
}}

Beispiele

Die folgenden Beispiele können auch als Kopiervorlagen verwendet werden.

 Info: Die beiden folgenden Beispiele können auch parallel mit unterschiedlicher Anzahl an Mindestbeiträgen verwendet werden, dass dann die beantworteten Abschnitte schneller archiviert werden als die unbeantworteten.

1. Für durchschnittlich frequentierte Diskussionsseiten eignet sich folgende Beispiele mit bewährten Einstellungen, die individuell angepasst werden können:

{{Autoarchiv
 |Alter             =365
 |Ziel              ='((Lemma))/Archiv/1'
 |aktuelles Archiv  =[[/Archiv/1]]
 |Mindestabschnitte =8
 |Frequenz          =monatlich
}}

Dieses Beispiel bewirkt Folgendes:
((Lemma)) erzeugt bei der Abarbeitung durch Taxonbot den Titel der Seite, auf der dieser Wert eingebunden ist, z. B. Benutzer Diskussion:Enzyklopädist. Der TaxonBot wird also auf der Unterseite ((Lemma))/Archiv/1 alle archivierten Abschnitte einlagern.
Archiviert wird an jedem Monatsersten (1. Januar, 1. Februar usw.) mit allen Abschnitten, die seit mehr als 365 Tagen mindestens 2 signierte Beiträge enthalten. Jedoch verbleiben 8 Abschnitte auf der Diskussionsseite.

2. Wird eine Diskussionsseite sehr häufig benutzt, dann sollte man das Archiv aufteilen und gegebenenfalls Jahresarchive verwenden:

{{Autoarchiv
 |Alter             =90
 |Ziel              ='((Lemma))/Archiv/((Jahr))'
 |Übersicht         =[[Spezial:Präfixindex/{{ers:VOLLER_SEITENNAME}}/Archiv|dieser Seite]]
 |Mindestabschnitte =5
 |Frequenz          =montags
}}

Dieses Beispiel bewirkt Folgendes:
((Lemma)) erzeugt wie bei der ersten Kopiervorlage den Titel der Seite, auf der dieser Wert eingebunden ist, zum Beispiel Benutzer Diskussion:Enzyklopädist. Der TaxonBot wird auf der Unterseite ((Lemma))/Archiv/2024 alle archivierten Abschnitte einlagern, die im Jahr 2024 eröffnet wurden. Falls diese Seite noch nicht angelegt wurde, tut TaxonBot dies automatisch. Gleiches gilt beim Jahreswechsel 2025 und bei Abschnitten, die in einem früheren Jahr begonnen wurden.
Die Passage {{ers:VOLLER_SEITENNAME}} für den Link zur Übersichtsseite wird dagegen bereits beim Speichern der Seite in den Titel der Seite umgewandelt.
Archiviert wird jeden Montag mit allen Abschnitten, die seit mehr als 90 Tagen mindestens 2 signierte Beiträge enthalten; es werden also nur Abschnitte archiviert, auf die geantwortet wurde. Jedoch verbleiben 5 Abschnitte auf der Diskussionsseite.

Parameter

Bei der Einbindung müssen die Parameter Alter und Ziel immer angegeben werden. (Auch wenn sie nicht durch den Bot verarbeitet werden!)
Mit den optionalen Parametern ist das Verhalten des Archivbots und die Darstellung individuell einstellbar.
Die Parameter Zeigen, Übersicht, aktuelles Archiv, Icon, clear und Kommentar werden vom Bot nicht verarbeitet und wirken nur auf die Darstellung des Blockes.

Alter

Die Anzahl der Tage gezählt vom letzten Beitrag, nach dem ein Abschnitt archiviert werden soll:

• Für Artikel-Diskussionsseiten sind allgemein 90 Tage ein guter Wert, bei sehr aktiven Diskussionen können auch 14 Tage und in sehr ruhigen Diskussionen 180 und mehr sinnvolle Größen sein. Bei gesperrten Artikeln kann eine „Deaktivierung“ mit beispielsweise 999 sinnvoll sein, bis der Artikel wieder entsperrt ist. Alternativ kann die Vorlage auch mit <nowiki>-Tags deaktiviert werden.
• Die Größe der Archivseiten kann über die Seiteninformationen, ansonsten auch Seite bearbeiten und Vorschau zeigen überprüft werden, wobei Größen bis rund 250 kB praktikabel sein dürften.
• Siehe auch Wikipedia:Diskussionsseiten #Diskussionsseiten aufräumen.

Ziel

Die Seite, auf der die Abschnitte abgelegt werden sollen.

Wichtig sind dabei die Hochkommata '' um den Zielpfad!

Botvariablen

• ((Lemma)): Aktuelle Seite

Alle Zeitangaben beziehen sich auf das Datum des ersten Eintrags unter dem jeweiligen Abschnitt, dabei können die folgenden zeitabhängigen Parameter beliebig kombiniert werden:

• ((Tag)): Kalendertag, z. B. 1, 24
  • ((Tag:##)): zweistelliger Tag, z. B. 01, 24
  • ((Tag:kurz)): abgekürzter Tagesname (kleingeschrieben), z. B. mo, fr
  • ((Tag:Kurz)): abgekürzter Tagesname, z. B. Mo, Fr
  • ((Tag:KURZ)): abgekürzter Tagesname (großgeschrieben), z. B. MO, FR
  • ((Tag:lang)): Tagesname (kleingeschrieben), z. B. montag, freitag
  • ((Tag:Lang)): Tagesname, z. B. Montag, Freitag
  • ((Tag:LANG)): Tagesname (großgeschrieben), z. B. MONTAG, FREITAG
• ((Woche)): Woche, z. B. 1, 43
  • ((Woche:##)): zweistellige Woche, z. B. 01, 43
• ((Monat)): Monat, z. B. 1, 10
  • ((Monat:##)): zweistelliger Monat, z. B. 01, 10
  • ((Monat:kurz)): abgekürzter Monatsname (kleingeschrieben), z. B. jan, okt
  • ((Monat:Kurz)): abgekürzter Monatsname, z. B. Jan, Okt
  • ((Monat:KURZ)): abgekürzter Monatsname (großgeschrieben), z. B. JAN, OKT
  • ((Monat:lang)): Monatsname (kleingeschrieben), z. B. januar, oktober
  • ((Monat:Lang)): Monatsname, z. B. Januar, Oktober
  • ((Monat:LANG)): Monatsname (großgeschrieben), z. B. JANUAR, OKTOBER
• ((Quartal)): Quartal, z. B. 1, 3
  • ((Quartal:##)): zweistelliges Quartal, z. B. 01, 03
  • ((Quartal:i)): Quartal (kleine römische Ziffern), z. B. i, iv
  • ((Quartal:I)): Quartal (große römische Ziffern), z. B. I, IV

((Halbjahr)): Halbjahr, z. B. 1, 2 ((Halbjahr:##)): zweistelliges Halbjahr, z. B. 01, 02 ((Halbjahr:i)): Halbjahr (kleine römische Ziffern), z. B. i, ii ((Halbjahr:I)): Halbjahr (große römische Ziffern), z. B. I, II

oder

((Semester)): Semester, z. B. 1, 2 ((Semester:##)): zweistelliges Semester, z. B. 01, 02 ((Semester:i)): Semester (kleine römische Ziffern), z. B. i, ii ((Semester:I)): Semester (große römische Ziffern), z. B. I, II

• ((Jahr)): Jahr, z. B. 2006, 2007

Beispiele

• {{Autoarchiv |Alter=30 |Ziel='((Lemma))/Archiv'}}

archiviert alle Abschnitte, die mindestens zwei signierte Beiträge enthalten und deren letzter Beitrag mindestens 30 Tage zurückliegt, in der Unterseite /Archiv der aktuellen Seite.

• {{Autoarchiv |Alter=0 |Ziel='((Lemma))/Archiv'}}

archiviert alle Abschnitte, die mindestens zwei signierte Beiträge enthalten und deren letzter Beitrag mindestens 0 Tage zurückliegt, in der Unterseite /Archiv der aktuellen Seite.

• {{Autoarchiv |Modus=Erledigt |Alter=0 |Ziel='((Lemma))/Archiv'}}

archiviert alle Abschnitte, die mit der Vorlage {{Erledigt}} markiert wurden, in der Unterseite /Archiv der aktuellen Seite.

• {{Autoarchiv |Alter=1 |Ziel='Benutzer Diskussion:Sebmol/Archiv'}}

archiviert alle Abschnitte, die mindestens zwei signierte Beiträge enthalten und deren letzter Beitrag mindestens einen Tag zurückliegt, in der Unterseite Benutzer Diskussion:Sebmol/Archiv

• {{Autoarchiv |Alter=7 |Ziel='Benutzer Diskussion:Sebmol/Archiv/((Jahr))/((Monat:Kurz))'}}

archiviert alle Abschnitte, die mindestens zwei signierte Beiträge enthalten und deren letzter Beitrag mindestens sieben Tage zurückliegt, in der Unterseite Benutzer Diskussion:Sebmol/Archiv/2024/Dez.

• {{Autoarchiv |Alter=2 |Ziel='Benutzer Diskussion:Sebmol/Archiv/((Jahr))/Woche ((Woche:##))'}}

archiviert alle Abschnitte, die mindestens zwei signierte Beiträge enthalten und deren letzter Beitrag mindestens zwei Tage zurückliegt, in der Unterseite Benutzer Diskussion:Sebmol/Archiv/2024/Woche 51

Modus

Standardwert: Alter

Mit diesem Parameter kann die Arbeitsweise des Bots festgelegt werden. Folgende Werte sind möglich:

• Alter: Abschnitte werden nur archiviert, wenn sie das eingestellte Alter erreicht haben.
• Erledigt: Abschnitte werden nur archiviert, wenn sie mit {{Erledigt}} markiert sind. Der Parameter Alter=0 muss in diesem Fall zwingend angegeben werden, obwohl er bei der Auswertung ignoriert wird.
• Alter, Erledigt: Abschnitte werden nur archiviert, wenn sie das eingestellte Alter erreicht haben und sie mit {{Erledigt}} markiert sind.

Klein

Standardwert: Nein

Wird dieser Parameter auf Ja gesetzt, werden Archivierungen als kleine Bearbeitungen markiert. Bei Benutzerdiskussionsseiten führt das dazu, dass bei der Archivierung keine Nachricht für den Benutzer erzeugt wird.

Mindestbeiträge

Standardwert: 2

Die Anzahl der Beiträge, die ein Abschnitt haben muss, bevor er archiviert wird. Damit können zum Beispiel alle nicht-beantworteten Beiträge von der Archivierung ausgeschlossen werden.

Dieser Parameter wird nur im Modus=Alter (Standard) vom Bot verarbeitet und darf im Modus=Alter, Erledigt oder Modus=Erledigt nicht angegeben werden.

Mindestabschnitte

Standardwert: 0

Legt fest, wie viele Abschnitte auf einer Seite nach einer Archivierung noch erhalten bleiben müssen, um leere Diskussionsseiten zu vermeiden (sinnvolle Größen: 5–10).

Frequenz

Standardwert: ständig:morgens (d. h. täglich morgens)

Mit diesem Parameter kann festgelegt werden, wie oft der Bot auf der Seite aufräumen soll.

Frequenzen können mittels Doppelpunkt auf eine Botlaufzeit eingeschränkt werden. (Beispiel 2, 3 und 6)
Wird der Parameter Frequenz ohne Einschränkung angegeben, so wird :morgens angenommen. (Beispiel 1)

Mehrere Frequenz-Angaben können kombiniert werden. Dazu müssen sie durch Komma und folgendem Leerzeichen (, ) getrennt werden. (Beispiel 4 und 5)

Gültige Parameterwerte:

• montags, dienstags, mittwochs, donnerstags, freitags, samstags, sonntags - an diesem Wochentag
• halbmonatlich - 1. und 15. Tag des Monats
• monatlich - 1. Tag des Monats
• halbjährlich - 1. Januar und 1. Juli
• jährlich - 1. Januar
• ständig - folgt nicht o. g. Regel, siehe diesen Kasten

Gültige Einschränkungen:

• :morgens - archiviert nur am frühen Morgen.
• :mittags - archiviert nur nachmittags.
• :ständig - archiviert am frühen Morgen und nachmittags.
  Diese Einschränkung folgt nicht immer den o. g. Regeln, siehe folgenden Kasten)

Der Parameterwert ständig und die Einschränkung folgt nicht den oben genannten Regeln!

• |Frequenz=ständig - die Seite wird täglich am frühen Morgen und nachmittags ausgewertet.
• |Frequenz=ständig:ständig ist nicht definiert und damit verboten.
• Bitte diesen selten notwendigen Fall regelkonform und verständlicher als |Frequenz=ständig:morgens, ständig:mittags einbinden.

Beispiele:

1. |Frequenz=montags archiviert jeden Montag am Morgen.
2. |Frequenz=monatlich:mittags archiviert nachmittags des ersten Monatstages.
3. |Frequenz=sonntags:ständig archiviert jeden Sonntag am frühen Morgen und nachmittags.
4. |Frequenz=montags, monatlich:mittags archiviert jeden Montag am frühen Morgen und am ersten Tag des Monats auch nachmittags.
5. |Frequenz=dienstags:mittags, sonntags:mittags archiviert jeden Dienstag und Sonntag nachmittags.
6. |Frequenz=ständig:mittags archiviert täglich nachmittags.

Kopfvorlage (veraltet)

Standardwert: Vorlage:Archiv

Angabe der Vorlage, die der Bot beim Anlegen einer neuen Archivseite am Seitenanfang einbindet.

Da bei weggelassenen Parameter {{Archiv}} eingebunden wird, kann auch die Möglichkeit genutzt werden, ein eigenes Design über diese Vorlage zu setzen.

Der Parameter sollte nicht mehr verwendet werden.

Zeigen

Standardwert: Ja

Wird dieser Parameterwert auf Nein gesetzt, dann wird der gesamte Block nicht dargestellt und damit ist auch die Angabe der Vorlagenparameter Übersicht, aktuelles Archiv, clear, Icon und Kommentar sinnfrei.

Diese Option ist nur sinnvoll, wenn

• der Aufbau der Vorlage beispielsweise das optische Design der zu archivierenden Seite stört und
• auf der Seite im Kopf für alle Archivierungsoptionen angegeben wird, unter welchen Bedingungen archiviert wird (z. B. wie bei Wikipedia:Redaktion Chemie).

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

Übersicht

Fügt in den eingebundenen Baustein den Satz „Die Archivübersicht befindet sich unter [Link auf Übersichtseite].“ ein.
Dieser Parameter ist sinnvoll bei Aufteilung des Archivs auf mehrere Seiten (z. B. /2006, /2007, …).
Bei nur einer Archivseite empfiehlt es sich, diesen Parameter wegzulassen und nur den Parameter aktuelles Archiv zu benutzen.
Es ist auch möglich, an das Ende des Bausteins mittels des Parameters Kommentar, weiteren Inhalt einzufügen.
Es dürfen keine Wiki-Variablen verwendet werden.

Beispiele:

• Vorzugsweise, um zu einer „automatischen Übersicht“ aller Archivseiten zu verlinken:
  Übersicht=[[Spezial:Präfixindex/{{ers:VOLLER_SEITENNAME}}/Archiv|dieser Seite]]
• Alternativ, um zu einer manuell gepflegten Seite mit allen Archivlinks zu verzweigen:
  Übersicht=[[{{ers:VOLLER_SEITENNAME}}/Archiv|Archiv]]

aktuelles Archiv

Dem Text des Bausteins wird der Satz „Das aktuelle Archiv befindet sich unter aktuelles Archiv.“ hinzugefügt.

Beispiele

Wenn als Ziel='((Lemma))/Archiv/1'	verwendet wird:	aktuelles Archiv=[[/Archiv/1]]
Wenn als Ziel='((Lemma))/Archiv/((Jahr))'	verwendet wird:	aktuelles Archiv=[[/Archiv/{{LOCALYEAR}}]]

Icon

Standardwert: Filing cabinet icon.svg

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

clear

Wenn angegeben, wird Umfließen des Blockes mit Text beendet und die Position in einer neuen Zeile angegeben.
Mögliche Werte sind left, right oder both.

Kommentar

Dieser Text wird am Ende des Bausteins ausgegeben.

(Unter-)Abschnitte zusammenhalten

Damit der TaxonBot Unterabschnitte zusammen mit einem Basis-Abschnitt archiviert, darf der Basis-Abschnitt nicht leer sein (leere Basis-Abschnitte werden nicht archiviert, sondern ignoriert). Der TaxonBot betrachtet Unterabschnitte als Teil eines nicht-leeren Basis-Abschnitts, wobei der TaxonBot auch nicht-leere Basis-Abschnitte ohne einen gültigen Zeitstempel nicht als Basis-Abschnitt erkennt, sondern als „leer“ ignoriert.

Weil der TaxonBot Diskussionsabschnitte nur anhand von == Überschriften in Wiki-Syntax == erkennt, besteht die Möglichkeit, Unterabschnittsüberschriften in HTML-Syntax zu verwenden, um sicherzustellen, dass ein ganzer Abschnittszweig auf jeden Fall vom TaxonBot auch als Ganzes betrachtet wird. Dennoch wird beispielsweise <h3> Überschrift in HTML-Syntax </h3> von der MediaWiki-Software fast wie eine === übliche Überschrift === behandelt. Näheres siehe Hilfe:Überschrift #HTML.

(Unter-)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.

Häufige Fehler

Die Archivseite lautet „Benu+1er Di0ku00ion:Benu8zer/Arc2iv 2007“ oder ähnlich: beim Parameter Ziel liegt ein Fehler vor, wichtig sind die Hochkommata (') um den Zielpfad! „Ungültiges Archivierungsziel – Die Zielangabe bei der automatischen Archivierung dieser Seite ist ungültig. …“: kann auftreten, wenn die Seite verschoben wurde. Der Parameter Ziel muss entsprechend angepasst, bereits vorhandene Archive sollten auch verschoben werden, der Parameter Ziel Unterstriche enthält, der Benutzer in den Einstellungen sein Geschlecht geändert hat (Benutzer vs. Benutzerin). Es wird nicht archiviert, obwohl die Zeit eigentlich dafür gekommen ist. Dies kann daran liegen, dass auf der Diskussionsseite ein Paar geschweifte Klammern ({{) keine schließende Klammer hat. Das Problem kann umgangen werden, wenn die geschweiften Klammern in <nowiki>-Tags geschrieben werden. (<nowiki>{{</nowiki>). Des Weiteren ist auch die Zeichenkette {{}} für den TaxonBot problematisch. Diese sollte auch in <nowiki>-Tags geschrieben werden. (<nowiki>{{}}</nowiki>).

Siehe auch

• Hilfe:Archivieren
  • Unterschiede der beiden Autoarchiv-Vorlagen
• Vorlage:Autoarchiv-Erledigt

Weitere Vorlagen um Archivlinks ohne Benutzung der Parameter Übersicht und aktuelles Archiv dieser Vorlage anzuzeigen:

• Vorlage:Autoarchiv-Archive um Archivlinks ohne Autoarchivierung anzuzeigen
• Vorlage:Archiv-Tabelle für nummerierte Archive und Einzelarchiv
• Vorlage:Archivübersicht für Archivübersicht und alle anderen Archive

Wartung

Die Prüfung auf fehlerhafte Einbindungen dieser Vorlage wurde 2021 "vorerst" deaktiviert!
Da auch der seit März 2017 bewährte LUA-Modul Autoarchiv deaktiviert wurde, können bei ungültigen Werten bzw. Parametern Fehlarchivierungen auftreten!

Fehlerhafte Einbindungen werden je nach falscher Verwendung aufgelistet …

• … in der Liste aller Seiten, in welcher sowohl Vorlage:Autoarchiv-Erledigt als auch Vorlage:Autoarchiv eingebunden wurde und damit die Systemlast unnötig erhöhen.
   Info: Diese Liste funktioniert noch!

Weitere Infos in der Wartungsseite.