JSONsprite/Dokumentation

Version vom 15. Juli 2020, 19:17 Uhr

Dies ist die Dokumentation, sie wird auf der Vorlagenseite eingebunden. Siehe Vorlage:Dokumentation für weitere Informationen.

Diese Vorlage dient zur Darstellen eines JSON-Symbols (Sprite) ohne weiteren Zusatz. Soll zusätzlich noch ein Text dargestellt werden, ist die Vorlage {{JSON}} zu verwenden.

Das Spritesheet

Parameter

Parameter	Verwendung
Name	Legt den Sprite fest, der angezeigt wird. Leerzeichen werden dabei durch Bindestriche ersetzt und alle Buchstaben werden in Kleinbuchstaben umgewandelt.
Tooltiptext	Optional. Legt den Text fest, der als Tooltip (beim Fahren mit dem Mauszeiger über das Symbol) angezeigt wird. Wird dieser Parameter nicht angegeben, dann wird der Name als Tooltiptext genommen (wobei der erste Buchstabe großgeschrieben wird)
`link`	Legt die Seite fest, auf die der Sprite verlinken soll. Falls dieser Parameter nicht festgelegt wurde oder `none` ist, wird kein Link erzeugt.
`text`	Dieser Wert wird hinter dem Sprite angezeigt.

Beispiele

Code	Ergebnis
`{{JSONsprite\|zahl}}`
`{{JSONsprite\|datei}}`
`{{JSONsprite\|boolean\|Wahrheitswert}}`

Alle Sprites

Hier findest du alle möglichen Sprites.

JSON

- bool
- boolean
- list
- liste
- number
- zahl
- object
- objekt
- string
- text

Ordnerstruktur

- datei
- file
- folder
- ordner

@@ Zeile 1: / Zeile 1: @@
 {{Dokumentationskopf}}
+Diese Vorlage dient zur Darstellen eines JSON-Symbols (Sprite) ohne weiteren Zusatz. Soll zusätzlich noch ein Text dargestellt werden, ist die Vorlage {{Vorlage|JSON}} zu verwenden.
-Mit der Vorlage '''JSONsprite''' wird ein kleines Symbol (Sprite) für die [[Vorlage:JSON]] erzeugt, das zur Darstellung eines [[JSON|JSON-Datentyps]] und von Ordnerstrukturen dient.
+[[Datei:JSONSprite.png|thumb|Das Spritesheet]]
-Die JSON- und Ordnerstruktur-Sprites sind in der '''Sprite-Datei''' [[:Datei:JSONsheet.png|JSONsheet.png]] zusammengefasst:
-[[Datei:JSONsheet.png]]
-== Anwendung ==
-<code><nowiki>{{JSONsprite|Symbolnummer|Tooltiptext}}</nowiki></code>
-=== Beispiel ===
-<code><nowiki>{{JSONsprite|1|Boolean}}</nowiki></code>
-'''ergibt'''
-<br>
-{{JSONsprite|1|Boolean}}
-<br>
-Der Tooltiptext wird sichtbar, wenn man mit dem Mauszeiger über das Symbol fährt.
 == Parameter ==
 {| class="wikitable"
-|-
 ! Parameter
+! Verwendung
-! Bedeutung
 |-
+| ''Name''
-| Symbolnummer
+| Legt den Sprite fest, der angezeigt wird. Leerzeichen werden dabei durch Bindestriche ersetzt und alle Buchstaben werden in Kleinbuchstaben umgewandelt.
-| Um ein bestimmtes Symbol anzuzeigen muss hier die ensprechende Nummer eingegeben werden.
 |-
-| Tooltiptext
+| ''Tooltiptext''
+| ''Optional.'' Legt den Text fest, der als Tooltip (beim Fahren mit dem Mauszeiger über das Symbol) angezeigt wird. Wird dieser Parameter nicht angegeben, dann wird der Name als Tooltiptext genommen (wobei der erste Buchstabe großgeschrieben wird)
-| Dieser optionale Parameter gibt einen Text an, der erscheint, wenn mit dem Mauspfeil auf das Symbol gezeigt wird. Wird er weggelassen, erscheint kein Text.
+|-
+| <code>link</code>
+| Legt die Seite fest, auf die der Sprite verlinken soll. Falls dieser Parameter nicht festgelegt wurde oder <code>none</code> ist, wird kein Link erzeugt.
+|-
+| <code>text</code>
+| Dieser Wert wird hinter dem Sprite angezeigt.
 |}
-=== Symbolnummern ===
+== Beispiele ==
+{| class="wikitable"
-Folgende Symbole können unter der Angabe der entsprechenden Nummer ausgegeben werden:
+! Code
+! Ergebnis
-= {{JSONsprite|1}}
+|-
-= {{JSONsprite|2}}
+| <code><nowiki>{{JSONsprite|zahl}}</nowiki></code> || {{JSONsprite|zahl}}
+|-
-= {{JSONsprite|3}}
+| <code><nowiki>{{JSONsprite|datei}}</nowiki></code> || {{JSONsprite|datei}}
+|-
+| <code><nowiki>{{JSONsprite|boolean|Wahrheitswert}}</nowiki></code> || {{JSONsprite|boolean|Wahrheitswert}}
-= {{JSONsprite|4}}
+|}
-= {{JSONsprite|5}}
+== Alle Sprites ==
-= {{JSONsprite|6}}
+Hier findest du alle möglichen Sprites.
+{{#invoke: Sprite | doc | JSONSprite }}
-= {{JSONsprite|7}}
 <includeonly>
 {{Navbox-Symbole+Grafiken}}

Code	Ergebnis
`{{JSONsprite\|zahl}}`
`{{JSONsprite\|datei}}`
`{{JSONsprite\|boolean\|Wahrheitswert}}`