Wikipedia:Lua/Modul/Hiero/Cartouche

Vorlagenprogrammierung	Diskussionen	Lua			Unterseiten
		Modul	Deutsch	English	Modul:	Dokumentation

Modul zur Generierung von Kartuschen und Serechs

Mit diesem Modul können Kartuschen und Serechs generiert werden. Verwendung findet es bereits in der Vorlage:PharaoName, die allerdings allein die bisherige Möglichkeit der Darstellung auf Basis eines einfachen Hiero-Codes nutzt und somit weitere (künftige) Möglichkeiten des Moduls unberücksichtigt lässt.

Die Funktion name in einer Vorlage

In eine Vorlage kann die Funktion name mit

<templatestyles src="Ägyptologie/styles.css" />
<includeonly>{{#invoke:Hiero/Cartouche|name|kind={{{TypPar| }}}|codePar={{{code| }}}|symbolPar={{{symbol| }}}|borderPar={{{border| }}}}}</includeonly>

eingebunden werden. Dabei ist die Angabe des Stylesheets notwendig und natürlich gegebenenfalls auch für die Vorlagendokumentation angemessen, kann also außerhalb von <includeonly>stehen. Die Bezeichner "TypPar", "codePar", "symbolPar" und "borderPar" sind die Namen der Parameter, die die Autoren als Verwender der Vorlage zum Aufruf der Vorlage angeben. Sie sind entsprechend in für die Autoren verständlicher Sprache zu wählen.

Die Funktion Title in einer Vorlage

Die Funktion Title liefert einen Bezeichner für den Namenstyp und kann mit

{{#invoke:Hiero/Cartouche|Title|NameType={{{TypPar| }}}|language=de}}

eingebunden werden. Der Bezeichner "TypPar"ist der Name des Parameters, den die Autoren als Verwender der Vorlage zum Aufruf der Vorlage angeben. Er ist entsprechend in für die Autoren verständlicher Sprache zu wählen. Beispielsweise: Templates designed for English Wikipedia should implement with

{{#invoke:Hiero/Cartouche|Title|NameType={{{NameType| }}}|language=en}}

Aufruf der Vorlage:PharaoName

Die Vorlage kann mit

{{PharaoName|Typ=<Namenstyp>
            |code=<Hiero-Code>
           [|symbol=[default|none|<Hiero-Code>]]?
           [|border=[default|none|ltr|ltd]]?
}}

also beispielsweise mit

{{PharaoName|Typ=Thron|code=A1-X1:Z1*Z1*Z1-B1-C1|symbol=none|border=ltr}}

oder mit

{{PharaoName|Typ=Thron|code=A1-X1:Z1*Z1*Z1-B1-C1}}

eingebunden werden. Sie wird jedoch auch beispielsweise vom Vorlagenmeister unterstützt.

Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

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

Das gibt einem Programmierer Aufschluss, dass ein Lua-Modul benutzt wird, welche/s und ggf. welche Einzelfunktion daraus, und verlinkt auf die Dokumentation.
Die Modul-Dokumentationen bekommen ein Link, in welchen Vorlagen sie eingesetzt werden, und wo bei eventuellen Funktionsänderungen Anpassungen erforderlich werden.
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.