Wikipedia:Lua/Modul/Hello

aus Wikipedia, der freien Enzyklopädie
Zur Navigation springen Zur Suche springen
Vorlagenprogrammierung Diskussionen Lua Test Unterseiten
Modul Deutsch English

Modul: Dokumentation

Hello – Modul zur Demonstration der Verwendung von Lua im Wiki-Projekt.

Funktionen für Vorlagen

hello
Gibt eine Zeichenkette wie Hello, world! This is Lua! zurück.
  • 1(optional) Name des Angesprochenen
    • Vorgabe: world

Beispieleinbindung

Für eine Vorlage bedeutet das:

  • ohne Parameter: {{#invoke:Hello|hello}}
    • ergibt: Hallo, Welt! Dies ist Lua!
  • mit Parameter: {{#invoke:Hello|hello|Mustermann}}
    • ergibt: Hallo, Mustermann! Dies ist Lua!

Das Beispiel zeigt den Aufruf eines Moduls, dessen Quellcode unter Modul:Hello gespeichert ist. Dieses Modul enthält nur eine Funktion mit dem Namen "hello". Die zweite Angabe zeigt an, dass diese Funktion "hello" in diesem Modul aufgerufen werden soll. Durch weitere Angaben können der genannten Funktion Parameter übergeben werden. In diesem Fall wird in dem Modul "Hello" also die Funktion "hello" aufgerufen und ihr der Parameter "Mustermann" übergeben.

Funktionen für Lua-Module

(Keine durch require einzubinden)

Lokale Umsetzung

hello(frame)
Gibt die Zeichenkette zurück.
frame – Aufrufumgebung
  • frame.args[ 1 ](optional) Übergebener erster unbenannter Parameter: Name des Angesprochenen

Abhängigkeiten

(Keine Module werden für require etc. benötigt)

Verwendung

Jedes Test-Szenario.

Herkunft

  • Zur vollständigen Dokumentation siehe oben das Link „Deutsch“.
  • Der nachstehende Abschnitt wird automatisch in jede Dokumentation zur Vorlagenprogrammierung eingebunden.

Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

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