Vorlage:Autoarchiv/Doku

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

Diese Vorlage markiert eine Diskussionsseite zur automatischen Archivierung. Sie muss am Anfang der Seite eingebunden werden, möglichst vor dem ersten Abschnitt. Zu anderen Möglichkeiten des Archivierens siehe manuelle Archivierung.

Inhaltsverzeichnis

1 Kopiervorlagen
2 Einbindung
- 2.1 Beispiele
- 2.2 Weitere Möglichkeiten
3 (Unter-)Abschnitte zusammenhalten
4 (Unter-)Abschnitte vor dem Archivieren schützen
- 4.1 Signatur ohne Einfluss auf die Archivierung
5 Häufige Fehler
6 Technische Details
7 Siehe auch

Übrigens: Die PlusPedia ist NICHT die Wikipedia.
Wir sind ein gemeinnütziger Verein, PlusPedia ist werbefrei. Wir freuen uns daher über eine kleine Spende!

1 Kopiervorlagen

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

{{Autoarchiv
|Alter             =365
|Ziel              ='((Lemma))/Archiv/1'
|Übersicht         =[[Spezial:Präfixindex/{{ers:VOLLER_SEITENNAME}}/Archiv|Archiv]]
|Mindestbeiträge   =1
|Mindestabschnitte =3
|Frequenz          =monatlich
}}

Diese Kopiervorlage bewirkt Folgendes: ((Lemma)) erzeugt den kompletten Titel der Seite, auf der dieser Befehl eingebunden ist, z. B. Benutzer Diskussion:Enzyklopädist. ArchivBot wird auf der Unterseite ((Lemma))/Archiv/1 alle archivierten Abschnitte einlagern. Das Archivieren erfolgt an jedem Monatsersten (1. Januar, 1. Februar usw.) mit allen Abschnitten, die seit mehr als 365 Tagen mindestens 1 signierten Beitrag enthalten. Jedoch verbleiben 3 Abschnitte auf der Diskussionsseite.

Wird eine Diskussionsseite sehr häufig benutzt, sollte man das Archiv aufteilen und gegebenenfalls Jahresarchive verwenden. Dies ist mit folgender Vorlage möglich:

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

Diese Kopiervorlage bewirkt Folgendes: ((Lemma)) erzeugt den kompletten Titel der Seite, auf der dieser Befehl eingebunden ist, zum Beispiel Benutzer Diskussion:Enzyklopädist. ArchivBot wird auf der Unterseite ((Lemma))/Archiv/2020 alle archivierten Abschnitte einlagern, die im Jahr 2020 eröffnet wurden. Falls diese Seite noch nicht angelegt wurde, tut ArchivBot dies automatisch. Gleiches gilt beim Jahreswechsel 2021 und bei Abschnitten, die in einem früheren Jahr begonnen wurden.
Das Archivieren erfolgt 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 3 Abschnitte auf der Diskussionsseite.
Beide Kopiervorlagen mit unterschiedlicher Anzahl an Mindestbeiträgen können auch parallel verwendet werden, sodass dann die beantworteten Abschnitte schneller archiviert werden als die unbeantworteten.

2 Einbindung

Bei der Einbindung müssen die folgenden Parameter angegeben werden:

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öVorlage:SSen 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öVorlage:SSe der Archivseiten kann über „ Seite bearbeiten “ und „ Vorschau zeigen “ überprüft werden, wobei GröVorlage:SSen zwischen 32 und 250 kB am praktischsten sein dürften.
Siehe auch Wikipedia:Diskussionsseiten#Diskussionsseiten aufräumen.

Ziel: Die Seite, auf der die Abschnitte abgelegt werden sollen.
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:

((Lemma))/Archiv/

((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 (groVorlage:SSgeschrieben), z. B. MO, FR
- ((Tag:lang)): Tagesname (kleingeschrieben), z. B. montag, freitag
- ((Tag:Lang)): Tagesname, z. B. Montag, Freitag
- ((Tag:LANG)): Tagesname (groVorlage:SSgeschrieben), 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 (groVorlage:SSgeschrieben), z. B. JAN, OKT
- ((Monat:lang)): Monatsname (kleingeschrieben), z. B. januar, oktober
- ((Monat:Lang)): Monatsname, z. B. Januar, Oktober
- ((Monat:LANG)): Monatsname (groVorlage:SSgeschrieben), 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 (groVorlage:SSe 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 (groVorlage:SSe römische Ziffern), z. B. I, II
((Jahr)): Jahr, z. B. 2006, 2007

32px Anmerkungen:

Wichtig sind dabei die Hochkommata '' um den Zielpfad!
Die Vorlage muss immer auf der betreffenden Seite selbst stehen, sie kann also nicht über einen anderen Baustein (Einbindung) eingebunden werden.

2.1 Beispiele

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

archiviert alle Abschnitte, deren letzter Beitrag mindestens einen Tag zurückliegt, nacheinander unter

Benutzer Diskussion:Sebmol/Archiv

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

archiviert alle Abschnitte, deren letzter Beitrag mindestens sieben Tage zurückliegt, auf Unterseiten nach dem Muster

Benutzer Diskussion:Sebmol/Archiv/2020/Jul.

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

archiviert alle Abschnitte, deren letzter Beitrag mindestens zwei Tage zurückliegt, auf Unterseiten nach dem Muster

Benutzer Diskussion:Sebmol/Archiv/2020/Woche 29

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

archiviert alle Abschnitte, die mit der Vorlage {{Erledigt}} markiert wurden, auf einer Unterseite nach dem Muster

Benutzer Diskussion:DeinBenutzername/Archiv

2.2 Weitere Möglichkeiten

Mit den folgenden optionalen Parametern ist die Darstellung und das Verhalten der automatischen Archivierung individuell einstellbar:

Übersicht: Fügt in den eingebundenen Baustein den Satz „Die Archivübersicht befindet sich unter [Link auf Archiv].“ ein. Dieser Parameter ist sinnvoll bei Aufteilung des Archivs auf mehrere Seiten (z. B. /2006, /2007, …). Es ist auch möglich, an das Ende des Bausteins weiteren Inhalt einzufügen. Bei nur einer Archivseite empfiehlt sich die Verwendung der Vorlage:Archiv-Tabelle. Achtung Es dürfen keine Wiki-Variablen verwendet werden.
- Beispiel: Übersicht=[[{{ers:VOLLER_SEITENNAME}}/Archiv]]
- Alternativ, um mit einem einzigen Link zu einer „automatischen Übersicht“ aller Archivseiten zu verlinken:
  Übersicht=[[Spezial:Präfixindex/{{ers:VOLLER_SEITENNAME}}/Archiv|Archiv]]
aktuelles Archiv: Dem Text des Bausteins wird der Satz „Das aktuelle Archiv befindet sich unter aktuelles Archiv.“ hinzugefügt.
Klein: Wird dieser Parameter auf Ja gesetzt, werden Archivierungen als kleine Bearbeitungen markiert. Bei Benutzerdiskussionsseiten führt das dazu, dass bei der Archivierung keine Nachricht (der sogenannte Kackbalken am oberen Bildschirmrand) für den Benutzer erzeugt wird (Standardwert: Nein).
Kopfvorlage (veraltet): StandardmäVorlage:SSig wird {{Archiv}} gesetzt. Daher kann auch die Möglichkeit genutzt werden, ein eigenes Design über diese Vorlage zu setzen. Dieser Parameter war die vorherige Lösung, wo die benannte Vorlage am Anfang automatisch eingebunden wurde. Der Parameter sollte nicht mehr verwendet werden.
Mindestbeiträge: 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 (Standardwert: 2).
Zeigen: Wird dieser Parameter auf Nein gesetzt, dann wird der Autoarchiv-Hinweis nicht dargestellt. Diese Option ist sinnvoll, wenn der Aufbau der Vorlage beispielsweise das optische Design der zu archivierenden Seite stört (Standardwert: Ja).
Mindestabschnitte: Legt fest, wie viele Abschnitte auf einer Seite nach einer Archivierung noch erhalten bleiben müssen, um leere Diskussionsseiten zu vermeiden (Standardwert: 0; sinnvolle GröVorlage:SSen: 5–10).
Frequenz: Mit diesem Parameter kann festgelegt werden, wie oft der Bot auf der Seite aufräumen soll (Standardwert: ständig, morgens und mittags). Mögliche Werte sind:
- ständig: die Seite wird bei jedem Botlauf ausgewertet
- montags, dienstags, mittwochs, donnerstags, freitags, samstags, sonntags: jeweils 3:01 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
- Frequenzen können mittels Doppelpunkt auf eine Tageszeit eingeschränkt werden. Wird keine Einschränkung angegeben, so wird morgens angenommen.
  Beispiele:
  
  montags:morgens archiviert jeden Montag morgen.
  
  monatlich:mittags archiviert immer am Mittag des ersten Monatstages.
  
  sonntags:ständig archiviert jeden Sonntag am Morgen und gegen Mittag.
- Mehrere Frequenz-Angaben können kombiniert werden. Dazu müssen sie durch Komma getrennt werden.
  Beispiele:
  
  montags, monatlich:mittags archiviert jeden Montag morgens und am ersten Tag des Monats auch mittags.
  
  dienstag:mittags, sonntag:mittags archiviert jeden Dienstag und Sonntag mittags.
Modus: Mit diesem Parameter kann die Arbeitsweise des Bots festgelegt werden (Standardwert: Alter). 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.
  Achtung Der Parameter Alter=n 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.

3 (Unter-)Abschnitte zusammenhalten

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

Weil der ArchivBot 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 ArchivBot auch als ganzes betrachtet wird. Dennoch wird beispielsweise <h3> Überschrift in HTML-Syntax </h3>[1] von der MediaWiki-Software (innerhalb einer Seite, aber nicht in der Zusammenfassung und Versionsgeschichte!) fast wie eine === übliche Überschrift === behandelt (auch wenn sie im Quelltext nicht am Zeilenanfang steht). Hilfe:Textgestaltung/HTML-Hn-Header und MediaWiki

4 (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.

4.1 Signatur ohne Einfluss auf die Archivierung

Um einen Beitrag signieren zu können, der die Archivierung nicht beeinflusst (beispielsweise zeitabhängig laut Parameter „Alter=“), kann folgender Quelltext verwendet werden: --~~~ {{ers:LOKALE_UHRZEIT}}, {{ers:LOKALER_KALENDERTAG}}. {{ers:LOKALER_MONATSNAME_KURZ}} {{ers:LOKALES_JAHR}}
Entscheidend ist hier die fehlende Zeitzone „(CET)“ bzw. „(CEST)“ am Ende des Zeitstempels: --Benutzername 06:28, 17. Jul. 2020

5 Häufige Fehler

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 erfolgt keine Archivierung, obwohl die Zeit eigentlich dafür gekommen ist. Dies kann daran liegen, das auf der Diskussionsseite ein Paar geschweifte Klammern ({{) keine schlieVorlage:SSende 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 ArchivBot problematisch. Diese sollte auch in <nowiki>-Tags geschrieben werden. (<nowiki>{{}}</nowiki>).

6 Technische Details

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

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