Wikipedia:Lua/Modul/Vorlage:lang

aus Wikipedia, der freien Enzyklopädie
Wechseln zu: Navigation, Suche
Vorlagenprogrammierung Diskussionen Lua Unterseiten
Modul Deutsch

Modul: Dokumentation

Vorlage:lang – Modul zur Unterstützung von Sprachen-Vorlagen.

Es werden unterstützt:

Funktionen für Vorlagen

flat
Basis-Vorlage
Parameter der umgebenden Vorlageneinbindung:
1
Sprachcode gemäß ISO 639 und weiterer Spezifikationen (RFC 5646)
(Pflichtparameter)
2
Textsequenz in der (Fremd-)sprache
(Pflichtparameter)
3
Transkription
(nur bei nichtlateinischen Schriften)
WP:NK oder freihändig
Audio
Titel einer Audio-Datei
IPA
Lautschrift
IAST
Umschrift gemäß International Alphabet of Sanskrit Transliteration
(nur bei geeignetem Sprachcode 1)
Weitere Sprachcodes
Übersetzungen
(nur wenn in Sprache oder Schrift von 1 abweichend)
Parameter des #invoke zur projektspezifischen Anpassung:
errCat
Titel einer Fehlerkategorie bei ungültigem Parameterwert etc.
errHide
1 – verstecke standardmäßig Fehlermeldungen
errNS
Leerzeichen-getrennte Liste von Namensraum-Nummern, auf die die errCat beschränkt sein soll.
Vorgabe: In allen Namensräumen errCat auswerfen.
Rückgabewert: Klassifizierte Textsequenz; und/oder Fehlermeldung, ggf. als class="error"
full
„Sprachnamen-Vorlage“ – Standard-Bereich
Parameter der umgebenden Vorlageneinbindung (alle optional):
1
Textsequenz in der (Fremd-)sprache
2
Transkription
(nur bei nichtlateinischen Schriften)
WP:NK oder freihändig
Audio
Titel einer Audio-Datei
IPA
Lautschrift
IAST
Umschrift gemäß International Alphabet of Sanskrit Transliteration
(nur bei geeignetem CODE)
Weitere Sprachcodes
Übersetzungen
(nur wenn in Sprache oder Schrift von CODE abweichend)
scripting
(nur bei nichtlateinischen Schriften)
Parametername ist Konfigurationswert SCRIPTING
Verschriftung statt Sprachname als Verlinkung verwenden
nachgestellt
Sprachnamen in Klammern nachstellen
Boolesch
style
CSS-Definition; überschreibt Standardformatierung
demo
1 – unterdrücke jede Ausblendung von Fehlermeldungen, etwa im Zusammenhang mit Dokumentationen; auch keine Wartungskategorien generieren
Parameter des #invoke zur projektspezifischen Anpassung:
CODE
Basis-Sprachcode gemäß ISO 639
(Pflichtparameter)
SCRIPTING
Verschriftung gemäß ISO 15924
(Quasi-Pflichtparameter)
SERVICE
Wikilink auf Artikel über Sprache
Formulierung adjektivisch, sofern möglich
SOLE
Alternativer Wikilink auf Artikel über Sprache, wenn bei Vorlageneinbindung keine Textsequenz angegeben
SUITABLE
Weiter erlaubte Parameternamen der Vorlageneinbindung
Leerzeichen-getrennte Liste
errCat
Titel einer Fehlerkategorie bei ungültigem Parameterwert etc.
errClasses
Klassen, in die eine Fehlermeldung eingeordnet werden soll, etwa error
errHide
1 – verstecke standardmäßig Fehlermeldungen
errNS
Leerzeichen-getrennte Liste von Namensraum-Nummern, auf die die errCat beschränkt sein soll.
Vorgabe: In allen Namensräumen errCat auswerfen.
Rückgabewert: Verlinkung, Zusätze; und/oder Fehlermeldung, ggf. als class="error".
failsafe
Versionsbezeichnung: 2018-01-15
1
optional: Mindestversionsbezeichnung
Rückgabewert: Leer, falls Mindestversionsbezeichnung nicht erfüllt

Verwendung


Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

{{#invoke: Vorlage:lang | Funktionsname | Wert1 | Wert2 | NameX=Wert … }}

Die Parameter können wie bei Vorlagen benannt oder unbenannt sein.

Wenn unbekannte Zeichenketten von außen kommen (als Vorlagenparameter), sollte immer mit der Form 1=Wert gearbeitet werden.

Wenn in einer Vorlage ein Modul verwendet wird, sollte auch immer {{Lua-Vorlage}} 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.