Zum Inhalt springen

Modul:KategorieInfo/Doku

Aus Wikonia

Dies ist die Dokumentationsseite für Modul:KategorieInfo

Kategorie-Metadaten (strukturierte Darstellung)[Quelltext bearbeiten]

Diese Seite dokumentiert den Aufbau und die Verwendung von Kategorie-Metadaten im Wikonia-System. Die Informationen basieren auf einer zentralen JSON-Datei, die über ein Lua-Modul verarbeitet und auf Kategorieseiten angezeigt wird.

Ziel[Quelltext bearbeiten]

Kategorien sollen mit einer konsistenten Infobox versehen werden, die Beschreibung, Zugehörigkeit und verwandte Themen enthält. Die Daten werden zentral gepflegt, um Redundanz und manuelle Formatierungen zu vermeiden.

Bestandteile[Quelltext bearbeiten]

Modul:KategorieDaten.json[Quelltext bearbeiten]

Diese Datei enthält alle Kategoriedaten in strukturierter, maschinenlesbarer Form.

Pflichtfelder
  • description_de: Beschreibung der Kategorie auf Deutsch
  • description_en: Beschreibung der Kategorie auf Englisch
Optionale Felder
  • icon: Dateiname eines Icons, z. B. Wrench.svg
  • parent: Name einer übergeordneten Kategorie
  • related: Liste verwandter Kategorien (als Array)
  • namespace: Zugehöriger Namensraum (z. B. Help) oder false
  • status: Status der Kategorie, z. B. active, deprecated, draft
  • visible: Sichtbarkeit für Benutzer (Standard: true)
  • note_de: Redaktioneller Hinweis (Deutsch)
  • note_en: Redaktioneller Hinweis (Englisch)

Modul:KategorieInfo[Quelltext bearbeiten]

Das Lua-Modul erzeugt automatisch eine Infobox auf Basis der obigen JSON-Daten.

Funktionen:

  • Erkennt die aktuelle Kategorieseite automatisch
  • Ermittelt die Sprache des Benutzers (oder nutzt die Seiteninhaltssprache)
  • Lädt die passenden Texte aus der JSON-Datei
  • Erzeugt eine formatierte Box mit:
    • Titel (inkl. Icon)
    • Beschreibung
    • Übergeordnete Kategorie (falls definiert)
    • Verwandte Kategorien (falls vorhanden)
    • Hinweise (optional)

Einbindung[Quelltext bearbeiten]

Auf Kategorieseiten reicht folgende Zeile ganz oben:

{{#invoke:KategorieInfo|show}}

Pflege[Quelltext bearbeiten]

  • Die Datei Modul:KategorieDaten.json darf nur gültiges JSON enthalten.
  • Änderungen an der Datei wirken sofort auf alle betroffenen Kategorieseiten.
  • Die Bearbeitung ist nur für Administratoren (bzw. Interface-Admins) erlaubt.
  • Das Modul ist bewusst so gestaltet, dass fehlende Felder toleriert werden.

Erweiterungsmöglichkeiten[Quelltext bearbeiten]

  • Lokalisierung weiterer Felder (z. B. status_de, status_en)
  • Redaktionelles Gadget zum Editieren der JSON über ein Formular
  • Spezialseite mit tabellarischer Übersicht aller Kategorien
  • Visuelle Icons oder Farbcodes je nach Status