Vorlage:Allgemein gültige Parameter/Doku

Verwendung

Diese Vorlage ergänzt die Dokumentation der Module, die das Submodul Check benutzen sowie die Vorlagen die wiederum das Modul nutzen um den Abschnitt Allgemein gültige Parameter. In der Moduldokumentation selbst ist kein Parameter zu übergeben, in der Vorlagendokumentation ist der Name des Moduls ohne Angabe des Namensraum zu übermitteln. Es dokumentiert die allgemeinen Parameter für die Parameterkontrolle und Fehlerbehandlung. Es folgt ein Beispiel: {{Allgemein gültige Parameter|Zeit}}

Allgemein gültige Parameter

Die allgemein gültigen Paramater kann man sowohl innerhalb der Vorlage in der Parserfunktion invoke benutzen, als auch innerhalb des Artikels der Vorlage selbst übergeben. Der Paramter, der bei der Einbindung der Vorlage benutzt wird, hat dabei Vorrang. So kann man bestimmte Funktionalitäten für den generellen Gebrauch der Vorlage aktivieren (über invoke) und im Einzelfall im Artikel abschalten (bei der Verwendung der Vorlage).

• |ignore_errors= auf 1 oder true gesetzt, werden die Ausgabe der Fehlermeldungen der Funktionen unterdrückt. Standardmäßig werden die Fehler angezeigt.
• |no_category= auf 1 oder true gesetzt, werden die Artikel bei Fehlermeldungen des Moduls einer Fehlerkategorie zugeordnet. Standardmäßig werden Fehlermeldungen in die Kategorie Fehlerberichte des Moduls Zeit eingefügt. Wurden unbekannte Parameter verwendet landen die Artikel zusätzlich in der Kategorie Vorlagen mit unbekannten Parametern.
• |error_category= gibt den Namen einer Fehlerkategorie an, in der der Artikel bei auftretenden Fehlern einsortiert wird. Standardmäßig ist das Fehlerberichte des Moduls Zeit.

Folgende Einstellungen werden in dieser Vorlage verwendet

• Hier wird eine Liste der aktuell verwendeten Einstellungen angezeigt...