Modul:UI/Doku

Dokumentation für Modul:UI

Dieses Modul stellt ein zentrales UI-Rendering-Backend für Wikonia bereit. Es dient als Setzkasten zur Darstellung von Box-Elementen, unabhängig von deren Kontext oder Platzierung.

Hinweis: Das Modul ist positionsagnostisch. Die semantische Einordnung (z. B. „oben auf der Seite anzeigen“) erfolgt in Middleware-Modulen wie Modul:Hinweisbox.

Funktionen

box(args)

Erzeugt eine visuelle Box mit optionalen Bereichen (Icon, Titel, Kommentar etc.).

Parameter

Name	Typ	Beschreibung
type	Zeichenkette	Farbtyp der Box, z. B. warn, info, neutral → erzeugt CSS-Klasse wikonia-box--type
class	Zeichenkette	Zusätzliche CSS-Klassen (z. B. tight, shadow)
id	Zeichenkette	Optionaler id-Wert zur gezielten Verlinkung
icon	Zeichenkette	Dateiname eines Commons-Bildes (ohne Datei:)
iconsize	Zeichenkette	Größe des darzustellenden Icons (Standard: 24px)
title	Zeichenkette	Überschrift innerhalb der Box
content	Zeichenkette	Hauptinhalt der Box – Pflichtfeld
comment	Zeichenkette	Optionaler Zusatzkommentar
link	Zeichenkette	Weiterführender Link oder Aktion
signature	Zeichenkette	Angabe zur Herkunft (Autor, Zeitstempel o. ä.)

Ausgabe (HTML-Struktur)

<div class="wikonia-box wikonia-box--[type] [class]" id="[id]">
  <div class="wikonia-box__icon">…</div>
  <div class="wikonia-box__title">…</div>
  <div class="wikonia-box__content">…</div>
  <div class="wikonia-box__comment">…</div>
  <div class="wikonia-box__link">…</div>
  <div class="wikonia-box__signature">…</div>
</div>

Nur die tatsächlich gesetzten Parameter führen zu Ausgabe-Elementen. Nicht verwendete Bereiche bleiben ungerendert.

Sonderfall: type = hilfe

Bei type = hilfe wird eine kompakte, einzeilige Box ausgegeben, die speziell für kurze Hilfetipps gedacht ist. Der Titel und der Inhalt erscheinen direkt nebeneinander, ergänzt um ein Icon (z. B. Glühbirne). Ein optionaler Kommentar wird eingerückt darunter dargestellt.

<div class="wikonia-box wikonia-box--type-hilfe wikonia-box--inline [class]" id="[id]">
  <span class="wikonia-box__icon">…</span>
  <strong class="wikonia-box__title">…</strong>
  <span class="wikonia-box__content">…</span>
  <div class="wikonia-box__comment">…</div>
</div>

Diese Variante wird automatisch aktiviert, sobald type = hilfe gesetzt ist – typischerweise durch Module wie Modul:UIBox in Verbindung mit {{Hilfetipp}}.

Hinweis: Die visuelle Darstellung hängt von den definierten Farben in der Wikonia-Farbwelt (--color-hilfe) ab.

Verwendung

Typischerweise wird dieses Modul von Wrapper-Modulen wie Modul:Hinweisbox oder Modul:Baustein aufgerufen, nicht direkt in Vorlagen.