Vorlage:Autoarchiv/Doku

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

Vorlage:Dokumentation/Wartung/Doku verwaist

Benutzung

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ängigen 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
  • ((Lemma)): komplettes Lemma der Ursprungsseite

Wichtig sind dabei die Hochkommata '' um den Zielpfad!

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/2024/Dez.

{{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 51

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.
  • Beispiel: Übersicht=[[{{subst:FULLPAGENAME}}/Archiv]]
  • Alternativ, um mit einem einzigen Link zu einer „automatischen Übersicht“ aller Archivseiten zu verlinken:
    Übersicht=[[Spezial:Präfixindex/{{subst:FULLPAGENAME}}/Archiv|Archiv]]
  • Weiterer Inhalt kann durch einfaches Anhängen realisiert werden: (Siehe hierzu auch die Vorlagenprogrammierung)
    Übersicht=[[Spezial:Präfixindex/{{subst:FULLPAGENAME}}/Archiv|Archiv]].</b> Das momentan verwendete Archiv ist das [[{{subst:FULLPAGENAME}}/Archiv-{{#time:Y}}|Archiv vom Jahr {{#time:Y}}]]
• 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 (veraltet): Standardmäßig 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).
• Frequenz: Mit diesem Parameter kann festgelegt werden, wie oft der Bot auf der Seite aufräumen soll (Standardwert: ständig, morgens und abends). 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 Sontag 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.
  • Alter, Erledigt: Abschnitte werden nur archiviert, wenn sie das eingestellte Alter erreicht haben und sie mit {{erledigt}} markiert sind.

Kopiervorlage

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. Lediglich beim Parameter Ziel kann es sinnvoll sein, wie oben beschrieben, die Pfadangabe zu präzisieren, damit z.B. für jedes Jahr oder jeden Monat eine Unterseite angelegt wird. Wird die Kopiervorlage unverändert eingesetzt, wird lediglich eine globale Archivseite angelegt.

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

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

Seit der neue Parser am 22. Februar 2008 live gegangen ist, hat sich die Funktion von mittels <h1><h2><h3>... erzeugten Überschriften geändert: Übersetzung: Abschnittsüberschriften welche mit <h1><h2><h3>... usw. erzeugt wurden, haben keinen Link zur Abschnittsbearbeitung mehr. Solche Überschriften werden weiterhin zum Inhaltsverzeichnis (TOC) einer Seite hinzugefügt, und enthalten weiterhin einen Sprunganker. Dies ermöglicht das Mischen von direkt und nicht direkt bearbeitbaren Abschnitten innerhalb einer Seite (auch über Vorlagen), was mittels __NOEDITSECTION__ nicht möglich ist. Original: „Headers created with <h1><h2><h3>... etc no longer create an editable section. They also do not create a section divide when editing sections. They do however add a level to the TOC as well as an anchor for linking. This allows you to add uneditable sections to a template, and still have editable sections on the page, which isn't possible with __NOEDITSECTION__“.

(Unter-)Abschnitte vor dem Archivieren schützen

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

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:  -- ~~~ {{subst:LOCALTIME}}, {{subst:LOCALDAY}}. {{subst:LOCALMONTHABBREV}} {{subst:LOCALYEAR}}
Entscheidend ist hier die fehlende Zeitzone „(CET)“ bzw. „(CEST)“ am Ende des Zeitstempels:  -- Benutzername 12:42, 22. Dez. 2024

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. 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 schließende Klammer hat. Das Problem kann umgangen werden, wenn die geschweiften Klammern in <nowiki>-tags geschrieben werden. (<nowiki>{{</nowiki>)