Wikipedia:Lua/Modul/Vorlage:Anker

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

Modul: Dokumentation

Vorlage:Anker – Modul zur Unterstützung der Vorlage:Anker.

Funktionen für Vorlagen

f
Sprungziele generieren.
Parameter der Vorlageneinbindung: gemäß Vorlage:Anker
Parameter des #invoke zur projektspezifischen Anpassung; optional:
errCat
Titel einer Wartungskategorie für den Fehlerfall
errNS
Leerzeichen-getrennte Liste von Namensraum-Nummern, auf die die Wartungskategorie beschränkt sein soll.
Vorgabe: In allen Namensräumen auswerfen.
errClasses
Leerzeichen-getrennte Liste von zusätzlich zuzuordnenden Klassen der Fehlermeldung
errHide
1 – Fehlermeldung ausblenden
forbidden
Zu Dokumentationszwecken Liste unerlaubter Bezeichner anzeigen.
Ergebnis: antispam-container, bodyContent, catlinks, centralNotice, content, contentSub, contentSub2, editform, editpage-copywarn, firstHeading, footer, fundraising, jump-to-nav, language-settings-dialog, languagesettings-panels, page-actions, siteNotice, siteSub, toc, toctitle, top, wikiPreview
failsafe
Versionsbezeichnung (lokal): 2020-04-10
Optionaler Zusatzparameter:
  • 1 – Mindestversionsbezeichnung oder wikidata oder ~
{{#invoke:Vorlage:Anker|failsafe}} ergibt 2020-04-10
Mit Angabe eines Parameters als Datum im ISO-Format wird verglichen, ob das aktuelle Modul diese Version oder später erfüllt.
  • {{#invoke:Vorlage:Anker|failsafe|2001-01-01}} ergibt: »2020-04-10«
  • {{#invoke:Vorlage:Anker|failsafe|2099-01-01}} ergibt: »« – leer, falls Mindestversionsbezeichnung nicht erfüllt
Ist dieser Zusatzparameter das Schlüsselwort wikidata, so ist der Wert die auf Wikidata registrierte Versionsbezeichnung (2020-04-10) oder lokal, falls dort keine gefunden.
  • Ist der Zusatzparameter das Zeichen ~, so ist das Ergebnis leer, falls Übereinstimmung der lokalen mit der auf Wikidata registrierten Versionsbezeichnung besteht ().
Rückgabewert:
  • Leer, falls Mindestversionsbezeichnung nicht erfüllt, oder Übereinstimmung mit Wikidata
  • Versionsbezeichnung (auf Wikidata registriert:2020-04-10) bei wikidata, oder lokal falls dort keine gefunden, bzw. leer wenn synchronisiert


Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

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