Wikipedia:Lua/Modul/Vorlage:Infobox Sendeanlage

Vorlagenprogrammierung Diskussionen Lua Test Unterseiten
Modul Deutsch

Modul: Dokumentation

Das Modul:Vorlage:Infobox Sendeanlage dient in erster Linie zum Anzeigen der namengebenden Vorlage:Infobox Sendeanlage.

Funktionen für Vorlagen

Infobox
Diese Funktion dient zur Anzeige der Infobox. Sie benötigt keine weiteren Parameter. Zurückgegeben wird die Infobox mit dazugehörigen Kategorien.
Nebenbox
Diese Funktion zeigt ebenfalls die Infobox, allerdings ohne die Kategorie-Sortierung und der Lagekarte. Die Koordinaten werden in einer Zeile der Infobox angezeigt anstatt im Artikelkopf.
Weiterleitung
Diese Funktion erzeugt den Link zu den Koordinaten mittels der Vorlage:Coordinate. Des Weiteren erfolgt die Kategorie-Sortierung entsprechend derer der Infobox.
Dokumentation
Bereitstellung von Informationen zur Dokumentation der Vorlage, insbesondere in der Vorlagen-Dokumentations-Unterseite.
kein 1. Parameter
Bereitstellung von Daten in der Vorlagen-Dokumentations-Unterseite: die Vorlage:TemplateData, einer Kopiervorlage und der Wiki-Tabelle im Kapitel „Parameter-Details“.
Parameter JSON
Angabe der Werte für die Verarbeitung in der Wiki-Vorlage:TemplateData
Im Unterschied zu dem in der „Vorlage:TemplateData“ verwendeten Parameter enthält dieser den für die Grammatik benötigten Platzhalter $1, $2, $3, $4 und $MZ. Diese werden bei der weiteren Bearbeitung durch das Modul ersetzt.
Zurückgegeben wird die komplette Dokumentation für den Parameter JSON der „Vorlage:TemplateData“, eine Kopiervorlage sowie eine komplette Wiki-Tabelle mit den verwendeten Werten der Parameter-Details.
1. Parameter = „DokuDaten“
Bereitstellung einer Wiki-Tabelle mit den Parametern, die für jeden Datensatz („NAME“, „VERW“, „T_HOCH_GES“, usw.) generiert werden.
Um Informationen in die Spalte „Bemerkung“ zu schreiben werden als Parameter dieselben wie diejenigen des Datensatzes verwendet.


Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

{{#invoke: Vorlage:Infobox Sendeanlage | 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.