Wikipedia:Lua/Modul/Vorlage:VorlagendokumentationFlagIcon
| Vorlagenprogrammierung | Diskussionen | Lua | Unterseiten | ||
| Modul | Deutsch
|
Modul: | Dokumentation | ||
Vorlage:VorlagendokumentationFlagIcon – Modul zum Management von FlagIcons und ihrer Dokumentationen
Funktionen für Vorlagen
Die Funktionen wirken auf die aktuell dokumentierte Vorlage und beziehen sich auf deren Namen.
- first2
- Staatsnamen zu AA-FlagIcon ermitteln
- Parameter: Keine.
- Rückgabewert:
- Name des Staates (unverlinkt)
- Leere Zeichenkette, falls nicht identifiziert
- flag
- Beschreibung aus Bezeichner eines HDK-FlagIcon bilden
- Parameter: Keine.
- Rückgabewert: Leere Zeichenkette, falls nicht identifiziert; sonst Art der Flagge und ggf. Jahreszahl
- flat
- Linktitel aus FlagIcon auslesen
- Parameter:
#invoke-Parameter:pre(optional) im Erfolgsfall dem Objektnamen voranzustellende Zeichenkette
- Rückgabewert: Leere Zeichenkette, falls nicht identifiziert; sonst der unverlinkte Name des Objekts
- from
- Staatsname und Jahreszahl zu AAA-9999-FlagIcon ermitteln
- Parameter: Keine.
- Rückgabewert:
- Name des Staates (unverlinkt) sowie in eckigen Klammern „
abJahreszahl“ - Leere Zeichenkette, falls nicht identifiziert
- Name des Staates (unverlinkt) sowie in eckigen Klammern „
Verwendung
- Ausschließlich in der Vorlage:VorlagendokumentationFlagIcon und den diese unmittelbar einbindenden Vorlagendokumentationsvorlagen.
Allgemeine Hinweise zur Einbindung von Modulen
Eine Einbindung erfolgt jeweils im Format
{{#invoke: Vorlage:VorlagendokumentationFlagIcon | 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.
- Das gibt einem Programmierer Aufschluss, dass ein Lua-Modul benutzt wird, welche/s und ggf. welche Einzelfunktion daraus, und verlinkt auf die Dokumentation.
- Die Modul-Dokumentationen bekommen ein Link, in welchen Vorlagen sie eingesetzt werden, und wo bei eventuellen Funktionsänderungen Anpassungen erforderlich werden.
- 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.