Vorlage:Sem-InfBoxRow/Doku

Aus RPG-Dev-Basis
< Vorlage:Sem-InfBoxRow
Version vom 19. Juni 2010, 05:14 Uhr von Player140 (Diskussion | Beiträge)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Wechseln zu: Navigation, Suche
  Achtung: Du befindest dich in der RPG-Dev-Basis, diese Seite ist Teil der Kategorie RPG-Dev-Wiki:Basis. Änderungen an dieser Seite werden in viele RPG-Dev-Clients nach einem Update ebenfalls übernommen!
  Diese Seite ist die Dokumentations-Unterseite der Vorlage:Sem-InfBoxRow.

Diese Vorlage dient dazu, eine komplexe zweispaltige Zeile für eine Infobox zu erstellen, deren Aufgabe es ist (in erster Linie) semantische Daten anschaulich darzustellen. Für die linke Zelle der Spalte ist jeweils ein Bezeichner angedacht wie etwa Name, für die rechte Spalte der jeweilig dazu passende Wert, z.B. Thomas, wobei zusätzlich eine Semantische Wertzuweisung erfolgen würde wie [[Name::Thomas]]. Zusätzlich sind einige Zusatzfunktionen möglich wie das erlauben von Arrayattributen oder vom Bezeichnername der ersten Zelle abweichende Attributenamen für die Wertzuweisung.

Inhaltsverzeichnis

Kopiervorlage

Vereinfachte, in den meisten Fällen ausreichende Kopiervorlage:

{{Sem-InfBoxRow |Row1=Bezeichner |PropName= |PropVal={{{Wert|}}} |Array=n }}

Fast voller Funktionsumfang, speziell für Vorlage:NPC (Row2 wird fast nie benötigt):

{{Sem-InfBoxRow |Row1=Bezeichner |PropName= |PropVal={{{Wert|}}} |Array=n |Base=}}

Parameter

Fett markierte Parameter sind Pflichtangaben, die unbedingt einen Wert enthalten müssen, um die Vorlage sinnvoll verwenden zu können. An einige Parameter können mehrere Werte übergeben werden, in der Regel getrennt durch ein Komma. Diese Werte werden im Nachfolgenden durch eine Unterstreichung hervorgehoben.

Parameter Beschreibung
Row1 Bezeichner der Zeile in der linken Zelle. Wird standardmäßig auch als Attributname verwendet für die semantische Datenzuweisung.
PropName Wird diesem Parameter ein Wert übergeben, so wird für die Attributzuweisung dieser Wert als Attributname verwendet anstelle der in Row1 übergebene Wert.
PropVal Der Wert der Wertzuweisung und gleichzeitig der Text in der rechten Zelle. Wird kein Wert an den Parameter übergeben, so ist das Standardverhalten, die ganze Zeile nicht darzustellen. Besonderheiten werden mit dem Parameter Base erklärt.
Row2 Bietet die Möglichkeit einen Wert für die zweite spalte anzugeben der dort anstelle von PropVal angezeigt wird, wobei PropVal trotzdem als Attributwert zugewiesen wird. Ist PropVal leer, so wird die Zeile trotzdem nicht angezeigt, auch wenn Row2 einen Wert besitzt.
Array y wenn Attribut als Array verwendet werden soll. Das bedeutet dass dem Attribut mehrere Werte getrennt durch ein Komma (,) zugewiesen werden können. Wird kein Wert oder n übergeben, so werden Kommas als Teil der Wertzuweisung angesehen ohne dass ein Array generiert wird.
Base Dieser Parameter sollte in den meisten Fällen überflüssig sein, da er speziell für die Vorlage Vorlage:NPC mit eingebaut wurde. Über ihn ist es möglich, eine andere Seite innerhalb des Wikis anzugeben. Auf der angegebenen Seite wird dann zuerst geprüft, ob das Attribut das in PropName bzw. wenn leer das in Row1 angegeben wurde auf der Seite existiert. Falls ja, so wird der Attributwert dem gleichen Attribut auf der aktuellen Seite zugewiesen.

Zusätzlich gilt, dass über PropVal verschiedene Präfixe angegeben werden können, um den geerbten Wert von der Basis entweder zu ignorieren oder zu erweitern.

  • Ist der Wert von PropVal leer, so ist das Standardverhalten der Vorlage, dass das Attribut - falls auf der Basis-Seite vorhanden - geerbt wird.
  • Ist dem übergebenen Wert von PropVal ein + vorangestellt, so wird der Wert der Basis-Seite verwendet falls vorhanden, zusätzlich werden aber auch alle Werte zugewiesen die hinter dem + folgen. Macht nur Sinn wenn beim Parameter Array y übergeben wurde und es sich somit um ein Array-Attribut handelt, da ansonsten ohnehin nur ein Wert übergeben werden kann.
  • Ist dem übergebenen Wert von PropVal ein - vorangestellt, so wird der Wert der Basis-Seite nicht verwendet, es wird aber auch kein neuer Wert zugewiesen. Das Verhalten wäre also genau so wie wenn der Parameter Basis der Seite keine Basisseite zugewiesen bekommen hätte.

Das jeweilige Verhalten wird sinnvoll mit Icons unterstützt die anzeigen, wo ein Wert vererbt wurde und wo zur Vererbung zusätzliche Parameter angegeben wurden, falls es sich um ein Array-Attribut handelt.

CList Wird hier eine Angabe gemacht, so wird das Ergebnis nicht ausgegeben sondern in die angegebene Liste zur Individualisierung der Vorlage mit aufgenommen. Entspricht dem Parameter List der Vorlage Vorlage:CustomTemplate:AddItem.
CKey Wenn der Parameter CList angegeben wird, so kann über diesen Parameter der Key definiert werden, über den der Eintrag in der Liste verfügbar sein soll. Wird nichts angegeben, so entspricht der Key automatisch dem in Row1 bzw. falls vorhanden dem in PropName angegebenen Wert. Entspricht dem Parameter Key der Vorlage Vorlage:CustomTemplate:AddItem.
DataAssignTemplate Ermöglicht die Angabe einer Vorlage die die Darstellung der Attribute übernimmt. Nutzt den Parameter ArrayVorlage von Vorlage:ArrayAttribut.
DataAssignPara Ermöglicht die Übergabe eines Parameter-Wertes der von der in DataAssignTemplate angegebenen Vorlage verarbeitet werden kann falls diese Möglichkeit dort unterstützt wird. Entspricht dem Parameter ArrayVorlageParameter von Vorlage:ArrayAttribut.
lClass Ermöglicht es für die linke Spalte zusätzliche CSS-Klassen (getrennt durch Leerzeichen) anzugeben.
rClass Ermöglicht es für die rechte Spalte zusätzliche CSS-Klassen (getrennt durch Leerzeichen) anzugeben.
HidePictures Wahrheitswert der es mit true ermöglicht die kleinen icons zu verbergen, die Info darüber geben ob die Werte dahinter geerbt oder direkt von der aktuellen Seite übergeben sind. Standardmäßig false
AssignValues Wahrheitswert der es mit false ermöglicht die Attributewerte die eigentlich zugewiesen werden sollen nicht zuzuweisen. Standardmäßig true.

Anwendungsbeispiel

Die Vorlage ist natürlich zur Templateprogrammierung gedacht. Von daher werden in den Meisten Fällen wohl einfach nur Werte durchgereicht, die im Hauptartikel über eine andere Vorlage definiert werden.

{{Sem-InfBoxRow |Row1=Name |PropName= |PropVal={{{Name|}}} |Array=n]] |Basis={{{Basis|}}} }}

Siehe auch

Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
RPG-Dev-Wiki
RPG-Dev-Basis
Werkzeuge