Vorlagenprogrammierung Diskussionen Lua Test Unterseiten
Modul Deutsch English

Modul: Dokumentation

Data – Modul mit zentralem Zugriff auf externe Tabellendaten oder auf seine datenbereitstellenden Untermodule

Funktionen für Vorlagen

importData
liefert Daten aus Commons-Tabellen.
Parameter:
  • 1 oder object – wählt Daten von einem Objekt (zum Beispiel: DE-081280131 für Wertheim) aus.
  • 2 oder selection – wählt Daten von einer thematischen Auswahl des ausgewählten Objekts numerisch oder nichtnumerisch aus.
  • selectionName – wählt Daten von einer thematischen Auswahl des ausgewählten Objekts nichtnumerisch aus.
  • 3 oder version – wählt Daten von einer (zeitlichen) Version der ausgewählten Auswahl numerisch oder nichtnumerisch aus.
  • versionDate – wählt Daten von einer (zeitlichen) Version der ausgewählten Auswahl nichtnumerisch aus.
  • current – wählt Daten von der aktuellen Version der ausgewählten Auswahl aus.
  • 4 oder key – wählt Daten der ausgewählten Version über einem Schlüssel aus.
  • tryOther – stellt für den Schlüssel Daten aus älteren Versionen bereit.
  • 5 oder field – wählt eine Angabe von der durch die auswählenden Argumente getroffen Auswahl aus.
  • objectError – stellt eine benutzerdefinierte Meldung für ein inkorrekt ausgewähltes Objekt bereit.
  • selectionError – stellt eine benutzerdefinierte Meldung für eine inkorrekt ausgewählte thematische Auswahl bereit.
  • versionError – stellt eine benutzerdefinierte Meldung für eine inkorrekt ausgewählte (zeitliche) Version bereit.
  • keyError – stellt eine benutzerdefinierte Meldung für einen inkorrekt ausgewählten Schlüssel bereit.
  • fieldError – stellt eine benutzerdefinierte Meldung für eine inkorrekt ausgewählte Angabe bereit.
  • keyAddition – stellt eine benutzerdefinierte Meldung für einen Schlüssel auf addierte Daten bereit.
  • arg1 – stellt einen benutzerdefinierten Wert bereit.
invokeData
ruft getData im Untermodul auf oder erstellt eine Fehlermeldung bzw. einen Link zur Erstellung des Untermoduls.
Parameter:
  • 1 oder object – wählt das Untermodul (zum Beispiel: CH-AG für Kanton Aargau) aus.
  • 2 oder selection – übergibt das Argument selection an das Untermodul.
  • 3 oder version – übergibt das Argument version an das Untermodul.
  • 4 oder key – übergibt das Argument key an das Untermodul.
  • 5 oder field – übergibt das Argument field an das Untermodul.
  • Weitere Parameter werden wie angegeben als Argumente an das Untermodul übergeben.
evaluate
wertet Ausdrücke aus.
Parameter:
  • 1 – stellt das nichtnumerische Ergebnis oder den numerischen Wert, der in Parameter 2 eingesetzt werden kann, bereit.
  • 2 – stellt den Ausdruck, in dem alle # durch den numerischen Wert aus Parameter 1 ersetzt werden und der dann für das Ergebnis ausgewertet wird, bereit.


Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

{{#invoke: Data | 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.