Vorlagenprogrammierung Diskussionen Lua Unterseiten
Modul Deutsch English

Modul: Dokumentation

Modul zur Unterstützung der Vorlage:Standardfarbe

Funktionen für Vorlagen

f
Farbwert nach gegebenen Vorlagenparametern ermitteln

Funktionen für Lua-Module

Einbindung in andere Module:

local _, Standardfarbe = pcall( require, "Module:Standardfarbe" )
if type( Standardfarbe ) == "table" then
    Standardfarbe = Standardfarbe()
end

Danach steht zur Verfügung:

Standardfarbe.getColor(group, key, mode, ucase)
Farbwert beziehen
  • group
    Farbgruppe
  • key
    Schlüssel
  • mode
    Farbmodus, light oder dark, falls definiert
  • ucase
    Ausgabe des Farbwerts mit Großbuchstaben wenn true
Rückgabewert: Farbwert oder Fehlermeldung

Konfiguration

Die Konfiguration der Farbwerte ist auf Vorlage:Standardfarbe/colors.json möglich.

Abhängigkeiten

keine


Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

{{#invoke: Vorlage:Standardfarbe | Funktionsname | Wert1 | Wert2 | NameX=Wert … }}

Die Parameter können wie bei Vorlagen benannt oder unbenannt sein; deren Regeln gelten analog.

Wenn unbekannte Zeichenketten von außen kommen (als Vorlagenparameter), sollte immer mit der Form 1=Wert gearbeitet werden.

Zu allgemeinen Problemen beachte die Abhilfen wie bei Vorlagen.

Wenn in einer Vorlage ein Modul verwendet wird, sollte auch immer die Vorlage:Dokumentation/Lua in der Dokumentationsseite eingebunden werden.

  1. Das gibt einem Programmierer Aufschluss, dass ein Lua-Modul benutzt wird, welche/s und ggf. welche Einzelfunktion daraus, und verlinkt auf die Dokumentation.
  2. Die Modul-Dokumentationen bekommen ein Link, in welchen Vorlagen sie eingesetzt werden, und wo bei eventuellen Funktionsänderungen Anpassungen erforderlich werden.
  3. Die Vorlage wird zur Übersicht kategorisiert in Kategorie:Vorlage:mit Lua-Programmierung.

Zu weiteren Informationen siehe Hilfe:Lua.

Bei Problemen wende dich bitte an die Vorlagen-Werkstatt, in schweren Fällen hilft auch die Lua-Werkstatt.