Zum Inhalt springen

Modul:Lizenzhinweis/Doku

Aus Wikonia

Dies ist die Dokumentationsseite für Modul:Lizenzhinweis

Zweck[Quelltext bearbeiten]

Dieses Modul dient der standardisierten Darstellung von Lizenzhinweisen auf Dateiseiten im Wikonia-Wiki. Es erzeugt eine visuell formatierte Box mit Lizenzinformationen, basierend auf intern definierten Datensätzen. Die Ausgestaltung (Icons, Farben, Textstruktur) folgt dem CI von Wikonia.

Verwendung[Quelltext bearbeiten]

Das Modul wird ausschließlich über sogenannte „Wrapper-Vorlagen“ (z. B. Vorlage:Cc-by-sa-4.0) auf Dateiseiten eingebunden. Diese Vorlagen rufen das Modul mit einem festen Lizenztyp auf, z. B.:

{{#invoke: Lizenzhinweis | zeige | typ=cc-by-sa-4.0 }}

Eine direkte Nutzung im Artikelnamensraum oder durch freie Parameter ist nicht vorgesehen.

Funktion[Quelltext bearbeiten]

Das Modul rendert die Ausgabe auf Basis einer Lua-Tabelle mit vordefinierten Lizenzobjekten. Jede Lizenz besitzt:

  • titel: Anzeigetitel der Lizenz
  • icon: eingebundenes Icon (Commons-Dateiname)
  • farbklasse: Farbschema der Box (z. B. cc, pd, copyright)
  • beschreibung: Einleitungstext
  • erlaubt: Liste der erlaubten Nutzungen
  • verboten: Liste der verbotenen Nutzungen
  • bedingung: Liste verpflichtender Bedingungen
  • hinweis: zusätzliche Hinweise (z. B. Markenrecht)
  • link: externer Link zur Lizenz (optional)

Alle Einträge sind optional, nur der Lizenzschlüssel muss eindeutig sein.

Darstellung[Quelltext bearbeiten]

Die generierte Box besteht aus:

  • einem farblich markierten Rahmen (je nach Lizenztyp),
  • einem Icon links,
  • strukturiertem Text rechts (inkl. Bulletpoints),
  • einem abschließenden Link („Details zur Lizenz“) mit FontAwesome-Icon.

Kategorien[Quelltext bearbeiten]

Die Kategorisierung erfolgt ausschließlich über die Wrapper-Vorlage per <includeonly>. Das Modul selbst setzt keine Kategorien.

Hinweise[Quelltext bearbeiten]

  • Die Lizenzdaten sind zentral im Modul gepflegt und sollten nicht in der Vorlage überschrieben werden.
  • Bei neuen Lizenztypen ist ein neuer Tabelleneintrag im Modul anzulegen sowie eine passende Wrapper-Vorlage zu erstellen.
  • Änderungen am Farbsystem oder Icon-Stil müssen mit dem Projektstil von Wikonia abgestimmt werden.

Beispiele[Quelltext bearbeiten]

Typische Wrapper-Vorlagen:

Siehe auch