Vorlagenprogrammierung Diskussionen Lua Test Unterseiten
Modul Deutsch English

Modul: Dokumentation

Vorlage:bibcode – Modul zum Generieren betitelter Weblinks auf Ressourcen im Bibcode-System.

Es werden unterstützt:

  • {{Bibcode}}
  • Zitationsvorlagen aller Art.

Funktionen für Vorlagen

f
Generiere Verlinkung im URI-Stil
Parameter der Vorlageneinbindung:
1
bibcode – 19 Zeichen; führende und schließende Leerzeichen werden ignoriert
(Pflichtparameter)
full
Zusätzlich zum Abstract ist ein Volltext verfügbar.
Die Angabe des leeren Parameterwerts löst bereits den Hinweis aus.
Der Parameterwert kann außerdem Angaben zum Dokumentformat (PDF; Größe) enthalten.
demo
1 – unterdrücke jede Ausblendung von Fehlermeldungen, etwa im Zusammenhang mit Dokumentationen; auch keine Wartungskategorien generieren
(optional)
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.
showArticle
Seitenname der verlinkten Erläuterung zum bibcode-System
Leere Angabe: Schema nicht verlinken
Rückgabewert: Verlinkung; oder Fehlermeldung, ggf. als class="error".
failsafe
Versionsbezeichnung: 2019-05-16
Optionaler Zusatzparameter 1 – Mindestversionsbezeichnung oder wikidata
Rückgabewert:
  • Leer, falls Mindestversionsbezeichnung nicht erfüllt
  • Auf Wikidata registrierte Versionsbezeichnung (2019-05-16) bei wikidata, oder lokal falls dort keine gefunden

Verwendung


Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

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