Quelltext der Seite Hilfe:Lua

<noinclude>{{Hilfe}}
'''Lua''' ist eine Skriptsprache, die <!-- im März --> 2013 in der deutschsprachigen Wikipedia verfügbar wurde.
</noinclude>
* Die Funktionen werden über eine neue Parserfunktion <code><nowiki>{{#invoke:}}</nowiki></code> in eine umgebende klassische [[Hilfe:Vorlagen|Vorlage]] eingefügt und ergänzen diese um allgemeine Hilfsfunktionen, die bislang schwer zu realisieren waren.
* Gegenüber Wikisyntax-[[Hilfe:Vorlagen/Programmierung|Vorlagenprogrammierung]] bietet Lua vor allem bislang kaum mögliche Techniken im Zusammenhang mit Zeichenketten und größeren Mengen an numerischen Daten; nebst Analyse des Wikitextes der dargestellten Seite.
* In [[MediaWiki]] wird sie über die [[mw:Extension:Scribunto]] angebunden, die auch weitere Skriptsprachen ermöglichen würde.
{{Hilfeseite-Projektseite|1=
Organisationsfragen der deutschsprachigen Simpsonspedia werden unter '''[[Simpsonspedia:Lua]]''' zusammengestellt.
}}
Die Darstellung auf diesen Hilfeseiten trifft dagegen im Prinzip auf jedes beliebige Wiki zu.<noinclude>
<div style="float:left">__TOC__</div>  {{Projekt-Logo |icon=Lua |Pixel=150 |style=padding-left:50px}}
<div style="clear:left"></div></noinclude>
== {{Anker|invoke}} Vorlagenprogrammierung ==
{{Hilfe/Wikitext-Parserfunktion|invoke|#=1|Pflicht=1 2|Optional=beliebig|class=float-right}}
Aufruf (in der Regel innerhalb einer Vorlage):<br /> <code style="white-space:nowrap"><nowiki>{{</nowiki>#invoke: Modul-Titel | Funktionsname | Wert1 | Wert2 | NameX=Wert ... }}</code><br /> Die Parameter können wie bei Vorlagen benannt oder unbenannt sein; es gelten prinzipiell analoge Regeln.
* Bei unbekannt von außen kommenden Inhalten sollten keine unbenannten Parameter verwendet werden, bzw. <code>1=Wert1</code> wie bei Vorlagen (verschärftes [[Hilfe:Vorlagen#Problem: Gleichheitszeichen in Parameterwerten|Gleichheitszeichen-Problem]]; kann zum Syntaxfehler führen).
* Der Rückgabewert der aufgerufenen Funktion ist eine Zeichenkette mit Wikitext, der entsprechend an dieser Stelle in den Artikel eingebettet wird.
* ''Beispiel:'' [[Modul:Hello]] – Demonstration: ''{{#invoke:Hello|hello}}''
* Zum Zeitpunkt des Funktionsaufrufes hat der Parser mehrere wichtige Schritte bereits abgeschlossen, insbesondere die Vorlagenexpansion und die Verarbeitung von [[Hilfe:Tags#ext|Extension-Tags]] (<code>&lt;ref></code>, <code>&lt;pre></code>, <code>&lt;nowiki></code>,&nbsp;…). So würde eine direkte Ausgabe von <code><nowiki>{{Vorlage}}</nowiki></code> also nur zur Ausgabe des Textes <code><nowiki>{{Vorlage}}</nowiki></code> ohne die tatsächliche Vorlagenexpansion führen. Bei Bedarf kann das aber alles innerhalb der Modul-Programmierung erfolgen.
* Die Ausführungsumgebung wird bei jedem Aufruf von <code>#invoke</code> zurückgesetzt. Eine direkte Übernahme von Variablen zwischen zwei Aufrufen ist nicht möglich.
* Innerhalb der aufrufenden Vorlage erfolgen die einzelnen Aufrufe von <code>#invoke</code> sequentiell und unter Verwendung der gleichen (nur wenig auswertbaren) [[Hilfe:Lua/Modul im Wiki#Elternumgebung|Elternumgebung]].
* Verschiedene Einbindungen der Vorlage selbst (z.&nbsp;B. in einem Artikel) werden dagegen parallel abgearbeitet und teilen auch keine Elternumgebung.
Ein Aufruf von <code>#invoke</code> unmittelbar in einem enzyklopädischen [[Hilfe:Namensräume#ANR|Artikel]] oder einer allgemeinen Projektseite ist absolut unerwünscht. Diese Aufrufe sollen immer in [[Hilfe:Vorlagen|Vorlagen]] verpackt sein; ausgenommen sind solche Projektseiten, die sich spezifisch mit Lua beschäftigen ([[WP:Lua]]/***).

== Begrenzungen ==
* Schachtelungstiefe und Größe (Expansion) werden durch Lua zwangsläufig reduziert. Seiten, die bislang nicht dargestellt werden konnten, lassen sich nun ohne Sprengung der Limits anzeigen.
* Der Zeitverbrauch für die Gesamtdarstellung einer Seite mit Nutzung komplexer Vorlagenprogrammierung lässt sich auf etwa ein Drittel reduzieren, wenn die Vorlagensyntax durch gleichwertige Lua-Module ersetzt wird.
* Bei einer Seite mit vielen sehr einfachen Vorlagen könnte die Performance dagegen verschlechtert werden, falls jede einfache Vorlage durch eine Lua-Benutzung ersetzt würde: Jeder Start einer Lua-Funktion kostet ein gewisses Eintrittsgeld, das durch Ersatz einer bisher komplizierten Vorlagenprogrammierung erst einmal erwirtschaftet werden muss. Wird nur eine einfache Vorlage ersetzt, so war diese möglicherweise effizienter gewesen.
* Alle Lua-Module einer Seite sind auf eine kumulierte Prozessor-Zeit von 10&nbsp;Sekunden begrenzt. Diese Zeit wird wie die Nutzung anderer Ressourcen im HTML-Quellcode als PP-Report des Präprozessors ausgewiesen. In Zeiten hoher Serverbelastung kann die Ausführungszeit bis auf das Vierfache steigen. Deshalb sollte, wenn in günstigen Zeiten eine Gesamtzeit von 2&nbsp;Sekunden erreicht wird, eine Code-Optimierung (kaum signifikant zu erwarten) oder eine Aufteilung übergroßer Seiten überlegt werden.
* Ein weiterer Flaschenhals können die „teuren“ Funktionen sein. Ihre Anzahl pro dargestellter Gesamt-Seite ist auf 500 begrenzt. Dazu zählt unter anderem die Abfrage nach der Existenz von Seiten und Dateien.
''Siehe auch:'' [[Hilfe:Vorlagenbeschränkungen]].

== {{Anker|Modul:}} Modul-Namensraum ==

=== Organisation der Seiten ===
* Die Quellcodes stehen in einem eigenen Namensraum [{{fullurl:Special:Prefixindex|namespace=828}} <span style="font-family:monospace; font-size:1.25em;">Modul:</span>] auf Seiten, die „Modul“ genannt werden.
** Jedes Modul enthält eine oder mehrere Funktionen in Lua.
** Mittels <code>[[#Vorlagenprogrammierung|#invoke]]</code>, <code>[[Hilfe:Lua/Modul im Wiki#require()|require()]]</code> oder in geeigneten Fällen <code>[[Hilfe:Lua/Modul im Wiki#mw.loadData()|mw.loadData()]]</code> kann eine komplette Modulseite geladen werden.
* Ausschließlich Seiten aus dem Namensraum <code>Modul:</code> können für die Auswertung benutzt werden.
** Benutzer-Unterseiten sind nicht möglich; ausgenommen solche in Hierarchie der [[Hilfe:Vorlagenspielwiese|Vorlagenspielwiese]].
** Auch alle Unterseiten im Modul-Namensraum gelten als Lua-Quellcode und werden nicht als Wikitext dargestellt. Nur die Unterseiten gemäß dem [[#Dokumentationsseite|vereinbarten Schema für die Dokumentation]] gelten als Wikitext.
** Eine Seite mit Lua-Quellcode hat das [[Simpsonspedia:Technik/MediaWiki/Content Model|''Content Model'']] "<code>Scribunto</code>".
* {{Anker|Dokumentationsseite}} An jede Quellcode-Seite ist eine Dokumentationsseite angebunden, die auch genutzt werden soll. Sie bildet sich aus dem Seitennamen als [[Hilfe:Unterseiten|Unterseite]] <code>/Doku</code>.
* Seit Oktober 2022 <!-- Phab:T217500 2022-11 MW 1.40.0-wmf.6 --> sind auch [[    JavaScript Object Notation|JSON]]-Seiten möglich; typischerweise mit <code>.json</code> am Schluss des Seitennamens.
* Vorlagen sind im Lua-Quellcode nicht wirksam; SLA müssten auf [[Simpsonspedia:Administratoren/Anfragen|WP:A/A]] gestellt werden oder mit Verweis auf die Oberseite (Modul) in der Dokumentationsseite. Eine unmittelbare Kategorisierung ist ebenfalls nicht möglich.
* Module werden verwaltet wie Vorlagen (Einbindung von Seiten). Sie erscheinen auch unter „{{int:whatlinkshere}}“, selbst wenn sie nicht mittels <code>#invoke</code> eingebunden sind, sondern durch <code>[[Hilfe:Lua/Modul im Wiki#require()|require()]]</code> usw. aufgerufen werden. Werkzeuge zählen etwa die Zahl der Einbindungen.

=== {{Anker|redirect.move}} Weiterleitungen und Verschiebungen ===
Weiterleitungen von einer Modulseite zu einer anderen sind nicht möglich. Eine „Weiterleitung“ würde Wikisyntax statt Lua-Quellcode erzeugen und (anders als im Fall von Vorlagen) alle Einbindungen und <code>[[Hilfe:Lua/Modul im Wiki#require()|require()]]</code> des Moduls zum Auswerfen von Syntaxfehlern bringen; deshalb könnte eine Weiterleitung noch nicht einmal ohne Weiteres abgespeichert werden.

Wenn der Name eines Moduls nicht mehr geeignet erscheint, muss die Existenz von Lua-Quellcode unter den programmierten Namen gesichert bleiben. „Normale“ Verschiebungen sind nicht möglich. Bei produktiv genutzten Modulen, die bereits von sehr vielen Seiten eingebunden sind, ist die Prozedur recht umständlich; insbesondere wenn bereits mehrere Entwickler mitgewirkt hatten.
* Zuerst ist ein neues Modul unter dem künftigen Namen anzulegen und mit dem Quellcode zu füllen.
* Wenn mehrere Benutzer an der Programmierung beteiligt waren, ist auf [[Simpsonspedia:Importwünsche|WP:IMP]] Versionsimport innerhalb desselben Projekts zu beantragen.
* Dann sind alle Nutzungen auf den neuen Namen umzusetzen.
* Die Verwendung in den dargestellten Seiten einschließlich <code>[[Hilfe:Lua/Modul im Wiki#Mehrere Module|require()]]</code> wird auf [[Spezial:Linkliste]] angezeigt. Diese Liste muss schließlich leer sein.
* Zuletzt ist das veraltete Modul zu löschen.
Allerdings kann bis zur Auflösung aller Nutzungen eine einheitliche Funktionalität erreicht werden, indem als einzige Zeile vorgehalten wird: <code style="white-space: nowrap">return require( "Modul:NeuerName" )</code>

Solange das Modul noch nicht produktiv genutzt wird, kann es jedoch einfach verschoben werden.

=== Seiten-Bearbeitung ===
* Bei Bearbeitung der Quellcode-Seite wird der [[Simpsonspedia:Technik/Text/Edit/CodeEditor|CodeEditor]] zugeschaltet.
* Eine Debugging-Konsole wird angezeigt.
* Module können in einer Vorlagen-Umgebung (innerhalb einer anderen Seite) getestet werden.
Siehe dazu: [[Hilfe:Lua/Quellcode und Vorschau]]

Das Speichern von syntaktisch fehlerhaften Lua-Modulen ist seit Oktober 2014 nicht mehr möglich.<!-- 1.25wmf2 Gerrit:160367 -->

=== Syntaxhervorhebung und Zeilennummern ===
Bis zu einer gewissen Maximalgröße der Seite werden die Syntaxelemente in unterschiedlichen Farben dargestellt.
Seit Anfang 2021 werden auf Code-Seiten auch Zeilennummern angezeigt.<!-- 2021-01 Task:29531 -->
* Eine Verlinkung auf eine bestimmte Zeile ist möglich mit dem [[Fragmentbezeichner]] <code style="white-space:nowrap">#L-1</code>, <code style="white-space:nowrap">#L-2</code>, <code style="white-space:nowrap">#L-3</code> usw.
* Ein Klick auf die Zeilennummer hebt die aktuelle Zeile hervor, und in der Adresszeile des Browsers wird die geeignete Verlinkung auf diese Zeile dargestellt.
* In aktuellen Diskussionen kann auf die momentane Version verlinkt werden.
* Weil sich der vorangehende Code im Lauf der Zeit ändern kann, wäre ggf. ein [[Hilfe:Permanentlink|PermaLink]] ratsam.
Die Maximalgröße von Seiten mit Syntaxhervorhebung, die eine farbige Auszeichnung bei zu großen Seiten unterbindet, verhindert dann auch die Generierung der Zeilennummern.

== Erprobung ==
{{Simpsonspedia:Lua/Erprobung}}

== Programmieren in Lua ==
Siehe dazu [[Hilfe:Lua/Programmierung]] mit den Spezialthemen
* [[Hilfe:Lua/Modul im Wiki|Modul im Wiki]] – Modul im Kontext einer Wiki-Seite
* [[Hilfe:Lua/Modul für eine bestimmte Vorlage|Modul für eine bestimmte Vorlage]]
* [[Hilfe:Lua/Zeichenketten|Zeichenketten]]
* [[Hilfe:Lua/mw|mw-Objekt]] – Funktionsbibliotheken
* [[Hilfe:Lua/Links|Links]] – Seiten und URL
* [[Hilfe:Lua/Umgebung|Umgebung]] – aktuelles Wiki-Projekt
* [[Hilfe:Lua/Daten|Konzept der Trennung von Programm und Daten]]
* [[Hilfe:Lua/Internationalisierung|Internationalisierung]]
Zur Sprache Lua allgemein siehe die als [[#more|Weblinks]] angegebenen Handbücher.

== {{Anker|syntaxhighlight}} Darstellung von Quellcode ==
* Quellcode kann in Textseiten mittels <code style="white-space: nowrap">[[Hilfe:Syntaxhighlight|&lt;syntaxhighlight lang="lua">]]</code> dargestellt werden.
* Der Inhalt eines ganzen Moduls kann farbig angezeigt werden mit:
** <code><nowiki>{{#tag:syntaxhighlight |{{Modul:Hello}}| lang=lua}}</nowiki></code>

{{Hilfe/Weitere Informationen|id=more|Liste=
{{MediaWiki|Extension:Scribunto/Lua reference manual|suffix=Technische Dokumentation (englisch)}}
* Ursprüngliches Lua-Handbuch; enthält Teile, die auf einem Wiki-Server nicht möglich sind:
** [http://www.lua.org/manual/5.1/ Lua 5.1 Reference Manual] – lua.org (englisch, portugiesisch)
** [https://www.lua.org/manual/5.1/de/manual.html deutsche Übersetzung] der Version 5.1 des Handbuchs
* [[mw:Manual:Coding conventions/Lua|Coding conventions]] – Kodierungsstandard (englisch)
* [[mw:User:Sumanah/Lua vs Javascript|Lua vs Javascript]] – Warum wurde Lua und nicht [[JavaScript]] gewählt? (englisch)
* Code-Beispiele:
** [http://lua-users.org/wiki/SampleCode lua-users.org] (englisch)
* {{Phab|project=ELUA}} – Implementierung auf dem Wiki-Server
}}
<noinclude>
{{Simpsonspedia-Namensräume}}

[[Kategorie:Hilfe:Lua| ]]
[[Kategorie:Hilfe:MediaWiki-Erweiterung]]
[[Kategorie:Simpsonspedia:Lua|!]]
</noinclude>