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

Benutzung

Bearbeiten

Diese Vorlage markiert eine Diskussionsseite zur automatischen Archivierung. Sie muss am Anfang der Seite eingebunden werden, möglichst vor dem ersten Absatz. Dabei müssen die folgenden Parameter angegeben werden:

  • Alter: die Anzahl der Tage gezählt vom letzten Beitrag, nachdem ein Abschnitt archiviert werden soll:
    • Für Artikel-Diskussionsseiten sind allgemein 30 Tage ein guter Wert, bei sehr aktiven Diskussionen 14, und in sehr ruhigen Diskussionen 60 und eventuell auch mehr. Bei gesperrten Artikeln kann eine „Deaktivierung“ mit beispielsweise 999 sinnvoll sein, bis der Artikel wieder entsperrt ist.
    • Die Größe von den Archivseiten kann über „ Seite bearbeiten “ und „ Vorschau zeigen “ überprüft werden (ab 32 kB), wobei Größen zwischen 32 und 250 KiloByte am praktischsten sein dürften.
    • Siehe auch „Wikipedia:Diskussionsseiten#Diskussionsseiten aufräumen“.
  • Ziel: Die Seite, auf der die Abschnitte archiviert werden sollen. Dabei können die folgenden zeitabhängige Parameter beliebig kombiniert werden: (alle Zeitangaben beziehen sich auf das Datum des ersten Eintrags unter dem jeweiligen Abschnitt):
    • ((Tag)): Tag, 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
    • ((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
    • ((Woche)): Woche, z. B. 1, 43
    • ((Woche:##)): zweistelliges Woche, z. B. 01, 43
    • ((Jahr)): Jahr, z. B. 2006, 2007
Wichtig sind dabei die Hochkommata '' um den Zielpfad!

Beispiele

Bearbeiten
{{Autoarchiv|Alter=1|Ziel='Benutzer Diskussion:Sebmol/Archiv'}}
archiviert alle Abschnitte, deren letzter Beitrag mindestens ein 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/2024/Nov.
{{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/2024/Woche 47

Weitere Möglichkeiten

Bearbeiten

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, ...). Bei nur einer Archivseite empfiehlt sich die Verwendung der Vorlage:Archiv Tabelle.
    • Beispiel: Übersicht=[[Benutzer Diskussion:Sebmol/Archiv]]
  • 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 (die sogenannten Kackbalken am oberen Bildschirmrand) für den Benutzer erzeugt wird (Standardwert: Nein).
  • Kopfvorlage: Wenn bei der Autoarchivierung eine neue Archivseite erstellt wird, so wird die hier benannte Vorlage am Anfang automatisch eingebunden. Wird dieser Parameter nicht angegeben, wird Vorlage:Archiv benutzt.
  • 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).
  • Frequenz: Mit diesem Parameter kann festgelegt werden, wie oft der Bot auf der Seite aufräumen soll (Standardwert: ständig). Mögliche Werte sind:
    • ständig: die Seite wird bei jedem Botlauf ausgewertet
    • morgens, mittags: 3:01 oder 12:01 Uhr
    • montags, dienstags, mittwochs, donnerstags, freitags, samstags, sonntags: jeweils 3:01 an diesem Wochentag, mehrere Tage können mit Komma angegeben werden
    • halbmonatlich: 1. und 15. Tag des Monats
    • monatlich: 1. Tag des Monats
    • halbjährlich: 1. Januar und 1. Juli
    • jährlich: 1. Januar

Kopiervorlage

Bearbeiten

In folgender Kopiervorlage sind die ersten 3 Werte (MindestAlter der zu archivierenden Beiträge, das Ziel und die Übersicht) nur bewährte Empfehlungen, alle anderen Parameter sind mit den Standardwerten vorbelegt. Im „Normalfall“ kann die Kopiervorlage unverändert übernommen werden.

{{Autoarchiv
|Alter             =30
|Ziel              ='{{subst:FULLPAGENAME}}/Archiv'
|Übersicht         =[[{{subst:FULLPAGENAME}}/Archiv]]
|Klein             =Nein
|Kopfvorlage       =Vorlage:Archiv
|Mindestbeiträge   =2
|Zeigen            =Ja
|Mindestabschnitte =0
|Frequenz          =ständig
}}

(Unter-)Abschnitte zusammenhalten

Bearbeiten

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!) wie eine === übliche Überschrift === behandelt (auch wenn sie im Quelltext nicht am Zeilenanfang steht).

(Unter-)Abschnitte vor dem archivieren schützen

Bearbeiten

Um einen bestimmten Abschnitt und eventuell vorhandene Unterabschnitte nicht zu archivieren, kann die Vorlage {{nicht archivieren}} verwendet werden.

Signatur ohne Einfluss auf die Archivierung

Bearbeiten

Um einen Beitrag signieren zu können, der die Archivierung nicht beeinflusst (beispielsweise zeitabhängig laut Parameter „Alter=“), kann folgender Quelltext verwendet werden:  -- ~~~ {{subst:LOCALTIME}}, {{subst:LOCALDAY}}. {{subst:LOCALMONTHABBREV}} {{subst:LOCALYEAR}}
Entscheidend ist hier die fehlende Zeitzone(CET)“ bzw. „(CEST)“ am Ende des Zeitstempels:  -- Benutzername 11:01, 24. Nov. 2024

Signaturen vor der ersten Abschnittsüberschrift

Bearbeiten
Gültige Signaturen vor der ersten Abschnittsüberschrift können dazu führen, dass der „Abschnitt-Null“ ggf. komplett archiviert wird, inklusive der {{Autoarchiv|...}}-Einbindung. Um dies zu vermeiden siehe oben „Signatur ohne Einfluss auf die Archivierung“.

Häufige Fehler

Bearbeiten
  • 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.