Modul:Versionsschutz/Doku

Dies ist die Dokumentationsseite für Modul:Versionsschutz

Beschreibung

Dieses Modul erzeugt automatisch eine Anzeige des aktiven Seitenschutzes – bestehend aus:

einem Padlock-Icon (oben rechts auf der Seite),
einer Hinweisbox im Seiteninhalt,
sowie einer zugehörigen Kategorie.

Es funktioniert vollständig ohne manuelle Parameter und ermittelt Schutzstufe, Ablaufdatum und Benutzergruppe aus der aktuellen Seite. Optional kann ein Grund übergeben werden.

Aufbau

Das Modul besteht aus einem Hauptmodul und mehreren Submodulen, es nutzt zudem weitere allgemeine Hilfsmodule:

Submodule

Modul	Funktion
Modul:Versionsschutz	Hauptmodul, erzeugt Padlock, Box und Kategorie
Modul:Versionsschutz/Konfig	Konfigurationsdaten (Icons, Texte, Farben, Kategorien)
Modul:Versionsschutz/Level	Ermittelt aktivste Schutzstufe (nach Priorität)
Modul:Versionsschutz/Ablauf	Ermittelt das Ablaufdatum eines Schutzes (falls gesetzt)

Hilfsmodule

Modul	Funktion
Modul:Dateilink	Gibt formatierte Dateilinks mit Titel, Größe etc. zurück
Modul:DateFormat	Gibt ISO-Zeitstempel im lesbaren Format aus

Verwendung

Einbindung per Vorlage

Empfohlen über die Wrapper-Vorlage {{Versionsschutz}}, z. B.:

{{Versionsschutz|Vandalismus}}

Siehe auch

Dokumentation der Vorlage

Direktaufruf per #invoke (nicht empfohlen)

{{#invoke:Versionsschutz|main}}

Parameter

Nur ein Parameter ist vorgesehen (optional):

Grund=: Gibt einen individuellen Hinweistext zum Schutzgrund an (wird als Text unterhalb der Hinweisbox angezeigt).

Funktionsweise

Das Modul ruft alle bekannten Schutzarten (z. B. edit, move, upload) über PROTECTIONLEVEL ab.
Die aktivste Schutzstufe wird aus einer vordefinierten Prioritätenliste ermittelt.
Ist ein Schutz aktiv, wird abhängig von der Konfiguration:
1. das passende Icon gewählt (inkl. Unterscheidung bei temporären Schutzarten),
2. das Ablaufdatum formatiert,
3. ein Tooltip generiert,
4. eine Hinweisbox mit erklärendem Text eingeblendet,
5. eine Kategorie zugewiesen.

Temporäre Schutzarten

Das Modul erkennt temporäre Schutzarten anhand des Ablaufdatums (`expiry ≠ infinity`) In diesem Fall werden spezielle Icons mit Uhrsymbol genutzt (z. B. Protection-temp-sysop.svg).

Icons

Das Modul unterstützt differenzierte Icons für:

Aktionen: edit, move, create, upload
Schutzstufen: sysop, autoconfirmed, confirmed, templateprotection, policyprotection
temporäre Varianten: eigene Icons mit -temp- im Dateinamen

Kategorisierung

Wird automatisch gesetzt auf Basis der Konfiguration. Beispiele:

[[Kategorie:Bearbeitungsgeschützte Inhalte]]
[[Kategorie:Vorlagengeschützte Inhalte]]

Einschränkungen

Es wird immer nur eine Schutzstufe pro Seite angezeigt – die mit der höchsten Priorität.
Kaskadierende Schutzstufen (cascade) werden derzeit nicht ausgewertet.
Der Schutzgrund kann nicht automatisch ausgelesen werden – nur manuell übergeben.

To-Do / Ausblick

Automatische Integration per Hook (statt manuelle Einbindung)
Kaskadenerkennung für eingebundene Seiten
Mehrsprachigkeit über zentrale JSON-Datei
Konfigurierbare Textbausteine

Siehe auch