Quelltext der Seite Vorlage:Erledigt/Doku

<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
{{Tausendfach verwendet}}
{{TemplateData|JSON=
{ "description": "Baustein, der eine Diskussion als „erledigt“ kennzeichnet<noexport>\n\nDas ermöglicht eine automatische Archivierung einzelner Diskussionsabschnitte im Zusammenspiel mit weiteren Vorlagen und [[Wikipedia:Bots|Bots]].</noexport>",
  "params": {
     "1":
        { "label":       "Standard&shy;signatur",
          "description": "[[Hilfe:Signatur|Signatur]] (muss ein gültiges Datum enthalten)",
          "type":        "content",
          "required":    true,
          "example":     "--{{Char|126|*=4}}" },
     "2":
        { "label":       "Extras",
          "description": "Individuelle nachgestellte Zusatzangaben zur Signatur",
          "type":        "content",
          "suggested":   false }
  },
  "format": "inline"
}
|TOC=1}}

== Funktion ==
Diese Vorlage erzeugt einen Baustein, der eine Diskussion als erledigt kennzeichnet. Sie ermöglicht eine automatische Archivierung einzelner Diskussionsabschnitte im Zusammenspiel mit {{Vorlage|Autoarchiv-Erledigt}} oder {{Vorlage|Autoarchiv}} und sollte auch nur im Zusammenspiel mit diesen Vorlagen verwendet werden. Die Abarbeitung der Archivierung wird durch [[Benutzer:SpBot|SpBot]] bzw. [[Benutzer:TaxonBot|TaxonBot]] durchgeführt.

Gegebenenfalls ist ein zusätzlicher Erledigt-Hinweis in der Abschnittsüberschrift mit der Vorlage {{Vorlage|Erl}} hilfreich.

{{Info|Für andere Zwecke eignet sich die Vorlage {{Vorlage|Erl.}}.}}

== Verwendung ==
Man verwendet diese Vorlage mit:
; ohne Extras
: <code><nowiki>{{Erledigt|1=--~~~~}}</nowiki></code>
: <small>Beachte: '''4''' Tilden, äquivalent zur normalen Unterschrift</small>
So sieht es dann aus:
{{Erledigt/Standard-Baustein|1=--[[Benutzer:Beispielnutzer|Beispielnutzer]] 13:45, {{LOKALER_KALENDERTAG}}. {{LOKALER_MONATSNAME_KURZ}} {{LOKALES_JAHR}} (CET)}}

; mit Zusatzangaben:
: <code><nowiki>{{Erledigt|1=--~~~~|2=Ist inzwischen im Artikel korrigiert.}}</nowiki></code>
ergibt
{{Erledigt/Standard-Baustein|1=--[[Benutzer:Beispielnutzer|Beispielnutzer]] 13:45, {{LOKALER_KALENDERTAG}}. {{LOKALER_MONATSNAME_KURZ}} {{LOKALES_JAHR}} (CET)|2=Ist inzwischen im Artikel korrigiert.}}

; Bei angepassten [[Hilfe:Signatur|Signaturen]] ist zu beachten
* Wenn diese Gleichheitszeichen beinhalten, am Anfang die Zeichenfolge {{„}}<code>1=</code>{{“}} verwendet werden muss. Das trifft regelmäßig zu, wenn die Signatur ein [[Hypertext Markup Language|HTML]]-Element mit Attributen enthält. (Siehe dazu auch [[Hilfe:Vorlagen#Problem: Gleichheitszeichen in Parameterwerten|Hilfe:Vorlagen]].)
* Befindet sich in der persönlichen Signatur eine Pipe {{!}}, so ist sie durch <code><nowiki>{{!}}</nowiki></code> zu ersetzen. Andernfalls wird alles, was vor dieser Pipe steht, nicht angezeigt. (Siehe dazu auch [[Hilfe:Vorlagen#Problem: Sonderzeichen in Parameterwerten|Hilfe:Vorlagen]].)

== Eigenes Design ==
Wem das Design des Bausteins nicht gefällt, kann ihn auch nach eigenen Wünschen umgestalten. Dazu muss ausgehend von der [[Stammverzeichnis|Wurzel]] der jeweiligen Seite eine Unterseite "''/Erledigt-Baustein''" angelegt werden. Unter der Wurzel wird hierbei grundsätzlich die übergeordnete Seite verstanden, die keine Unterseite oder Diskussionsseite ist:
: Für "''Wikipedia:WikiProjekt Beispiel/Unterseite A/Unterunterseite AB''" ist die Wurzel "''Wikipedia:WikiProjekt Beispiel''".
: Für "''Benutzer Diskussion:Beispiel''" ist die Wurzel "''Benutzer:Beispiel''" ('''ohne''' "Diskussion").

Für die Verwendung in Artikeldiskussionen muss die Unterseite der Diskussionsseite zugeordnet werden, da der Textbaustein ansonsten direkt im Artikelnamensraum stehen würde:
: Für "''Diskussion:COVID-19-Pandemie''" lautet die Unterseite "''Diskussion:COVID-19-Pandemie/Erledigt-Baustein''".

Für die individuelle Gestaltung des Textes und zur Abgrenzung vom 1.&nbsp;Parameter gibt es ergänzend einen '''2.&nbsp;optionalen Parameter'''.

: Als Beispiel kann die [[Wikipedia:Redaktion Chemie|Redaktion Chemie]] oder [[Wikipedia:Dritte Meinung|Dritte Meinung]] herangezogen werden. Diese verwenden [[Wikipedia:Redaktion Chemie/Erledigt-Baustein]] bzw. [[Wikipedia:Dritte Meinung/Erledigt-Baustein]] als [[Vorlage:Erledigt/Standard-Baustein|Erledigt-Baustein]].

== Bearbeitungshilfen ==
Für die Ein-Klick-Bearbeitung kann [[Benutzer:Schnark/js/autoantraege]] benutzt werden.

== Wartung ==
Seiten mit Parameterfehlern werden angezeigt in der
[[Spezial:Linkliste/Vorlage:Erledigt/Fehler in Parametern|Linkliste "Fehler in Parametern"]].

== Nicht zu verwechseln ==
* [[Vorlage:Nicht archivieren]] – diese Vorlage verhindert die automatische Archivierung bei Nutzung von {{Vorlage|Autoarchiv}} und je nach Nutzung auch bei {{Vorlage|Autoarchiv-Erledigt}}
* [[Vorlage:Erl.]] und [[Vorlage:Erl]] – diese Vorlagen haben nichts mit der automatischen Archivierung zu tun

<includeonly>
[[Kategorie:Vorlage:Diskussionsbaustein]]
[[Kategorie:Wikipedia:Diskussionsarchivierung|Vorlage:Erledigt]]
[[Kategorie:Vorlage:für Bots]]
[[Kategorie:Vorlage:Piktogramm]]
</includeonly>