Vorlagenprogrammierung Diskussionen Lua Unterseiten
Modul Deutsch English

Modul: Dokumentation

Modul zur Generierung von Tabellenteilen mit Hieroglyphen

Bearbeiten

Dieses Modul soll die Gestaltung von Infoboxen in einheitlicher Form unterstützen. Insbesondere dient es zur weitgehenden Überarbeitung der Infobox Pharao. Die Unterstützung in diesem Modul legt ihren Schwerpunkt auf eine einheitliche Reihenfolge der Titulatur-Elemente. In späteren Ausbaustufen des Moduls mag es weitere, dann von Pharaonen unabhängige Listenelemente geben, die einer Sortierung bedürfen. Zellformen, die in ihrer Darstellung immer gleich sind, sind ebenfalls Gegenstand dieser Vorlage.

Die Funktion simple in einer Vorlage

Bearbeiten

Die Funktion name in einer Vorlage

Bearbeiten

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 list

Bearbeiten

Die Funktion list dient der Einbindung sortierter Tabellenzeilen, die (unsortiert) als logische Struktur angegeben werden. Derzeit beherrscht diese Funktion die Sortierung von Namenstypen, die nun in horizontalen, oder auch vertikalen Kartuschen dargestellt werden können.

Die Funktion list in einer Vorlage

Bearbeiten

In einer Vorlage kann eine Funktion list mit

<templatestyles src="Ägyptologie/styles.css" />
<includeonly>{{#invoke:Hiero/Cell|list|{{{Namensliste| }}}|de}}</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. Dabei bezeichnet "Namensliste" einen Parameter, den Autoren als Verwender der Vorlage dann angeben müssen. Daher gilt für eine englischsprachige Vorlage: Within a template a function list can be implemented with

<templatestyles src="Ägyptologie/styles.css" />
<includeonly>{{#invoke:Hiero/Cell|list|{{{nameList| }}}|en}}</includeonly>

Der Rückgabewert der Funktion list

Bearbeiten

Die Funktion list gibt als Rückgabewert einen Tabellenbereich bestehend aus einer, oder mehreren Tabellenzeilen mit (je nach Eingabe) zwei, oder drei Spalten. Die Vorlage muss also entweder selbst den Rahmen aus Tabellenbeginn und -ende bereitstellen, oder in eine Tabelle eingebunden werden.

Der Listen-Parameter der Funktion list

Bearbeiten

Der Listenparameter der Funktion list besteht aus Leerzeichen-separierten Typ-Elementen, die jeweils eine Tabelle aufnehmen: [<Namenstyp>{...} ]+
z. B.
Thron{...} Eigen{...}

Jedes dieser Typ-Elemente enthält dann wiederum Darstellungs- und Beschreibungselemente, wie folgt: