Heraldik-Wiki:Lua/Modul/Vorlage:URN

Aus Heraldik-Wiki
Zur Navigation springen Zur Suche springen
Vorlagenprogrammierung Diskussionen LuaW-Logo.png Unterseiten
Modul Deutsch English

Modul: Dokumentation
Zentrale Diskussionsseite fehlt

Vorlage:URN – Modul zum Generieren betitelter Weblinks auf Ressourcen im URNW-Logo.png-System mittels {{URN}}.

Funktionen für Vorlagen

f
Formatieren.
Parameter der Vorlageneinbindung; außer 1 alle optional:
1
  • Kompletter Bezeichner.
  • Namensraum-Spezifikation vor dem Doppelpunkt, wenn 2 gegeben: nbn
Pflichtparameter
2
  • Spezifikation nach dem Doppelpunkt, wenn 1 als nbn gegeben.
(veraltet)
3
resolver
Alternativer Resolver
Konfiguration in: Modul:URIutil/urn
demo
1 – unterdrücke jede Ausblendung von Fehlermeldungen, etwa im Zusammenhang mit Dokumentationen; auch keine Wartungskategorien generieren
Parameter des #invoke zur projektspezifischen Anpassung; alle optional:
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; oder Fehlermeldung, ggf. als class="error".
failsafe
Versionsbezeichnung: 2018-02-15

Verwendung

Ausschließlich in:


Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

{{#invoke: Vorlage:URN | 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:LuaW-Logo.png.