Vorlage:Klappbox/Doku

Aus Wikibooks
Zur Navigation springen Zur Suche springen

Diese Vorlage erzeugt bei aktiven JavaScript eine Klappbox die ein- und ausgeblendet werden kann. Als Argumente werden zwingend ein Titel und der Inhalt benötigt. Der Titel wird dauerhaft angezeigt und kann als erstes Argument oder explizit mit dem Argumentnamen „Titel“ übergeben werden. Der Inhalt wird ohne JavaScript immer angezeigt. Bei aktivem JavaScript wird er standardmäßig eingeblendet, außer man schaltet ihn durch Setzen des Parameters „verborgen“ explizit ab.

Parameter[Bearbeiten]

Der erste Parameter wird als Überschrift mit einem Anzeigelink (kleines Dreieck) auf der rechten Seite dargestellt. Der zweite Parameter wird durch einen Klick auf diesen Link als Inhalt der Box eingeblendet. Zusätzlich können auch explizit die folgenden Parameternamen verwendet werden:

Titel
Der Titel der Box (z. B. Box 1.1). Kann auch als erster namenloser Parameter übergeben werden.
Inhalt
Der Inhalt der Box. Kann auch als zweiter namenloser Parameter übergeben werden.

Übliche CSS-Parameter[Bearbeiten]

fw1
font-weight des Titels
fw2
font-weight des Inhalts
tc1
text-color des Titels
bg
background-color der umschließenden Box
bg1
background-color des Titels (Vorgabe: transparent)
bg2
background-color des Inhalts
ta1
text-align des Titels (Vorgabe: center)
ta2
text-align des Inhalts (Vorgabe: left)
float
float Eigenschaft (left, right, none)
width
Breite der Box
style
Weitere CSS-Eigenschaften für die umschließende Box
Hinweis: Der Wert des Parameters darf nicht in Gänsefüßchen eingeschlossen werden, denn diese stehen schon in der Vorlage.

Spezielle Parameter[Bearbeiten]

verborgen
Aus irgendeinen Text (z. B. „verborgen=true“) setzten um den Inhalt standardmäßig auszublenden
TitelTyp
Zeichnet den Titel als Überschrift (h1-h6) aus, so dass er im Inhaltsverzeichnis auftaucht.
VorTitel
Text der über dem Titel (in der umschließenden Box) eingefügt wird.
dropClass
(Standardwert = collapsible) Die CSS-Klasse der Klappbox, welche das Klappverhalten spezifiziert. (Derzeit keine anderen Werte zulässig.)
gibt man nur "dropClass=" an, wird eine nicht einklappbare Box mit Titel und Inhalt angezeigt (verborgen wird ignoriert)
boxClass
(Standardwert = PrettyTextBox) Die CSS-Klasse der Klappbox, welche das allgemeine Aussehen spezifiziert.
noprint
Wenn noprint einen Wert zugewiesen bekommt bspw. noprint=1, dann wird der Inhalt der Klappbox auf keinen Fall in die Druckversion aufgenommen.

Beispiele[Bearbeiten]

Das einfachste Beispiel ist

{{Klappbox|Box 1.1|{{Blindtext}}}}

Sieht so aus:

Box 1.1

Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat. Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.


Um den Inhalt standardmäßig auszublenden, muss der Parameter „verborgen“ gesetzt werden.

{{Klappbox|Box 1.2|{{Blindtext}}|verborgen=true}}

Sieht so aus:

Box 1.2

Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat. Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.


Ein anderes Beispiel, das den Titel als Überschrift dritter Ordnung (h3) darstellt und ihn somit ins Inhaltsverzeichnis (TOC) einblendet, sieht so aus:

{{Klappbox|Box 1.3|{{Blindtext}}
|TitelTyp=h3
|float=left
|bg=#999999
|width=33%
}}

Sieht so aus:

Box 1.3

Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat. Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.



Noch ein anderes Beispiel dieser Art, welches den Inhalt standardmäßig ausgeblendet:

{{Klappbox|Box 1.4|{{Blindtext}}
|TitelTyp=h3
|float=right
|ta1=right
|bg=#BBBBFF
|bg1=#BBBBFF
|bg2=white
|verborgen=true
}}

Sieht so aus:

Box 1.4

Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat. Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Beispiel 1.3 mit TitelType="div"[Bearbeiten]

Box 1.3

Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat. Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Beispiel 1.3 mit TitelType="p"[Bearbeiten]

Box 1.3

Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat. Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Beispiel 1.3 mit TitelType="h2"[Bearbeiten]

Box 1.3

Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat. Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Beispiel 1.3 mit TitelType="h5"[Bearbeiten]

Box 1.3

Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat. Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Beispiel 1.3 ohne TitelTyp[Bearbeiten]

Box 1.3

Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat. Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Wichtige Hinweise[Bearbeiten]

Klappbox innerhalb nummerierter Listen[Bearbeiten]

Innerhalb von Listen (zumindest von nummerierten) funktioniert Klappbox nicht. Beispiel:
#{{Klappbox|Box 1.3|{{Blindtext}}|verborgen=true}}:

  1. Box 1.3

Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat. Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Alternativ (bis jemand der sich auskennt etwas vornimmt) kann man die HTML Darstellung von Listen benutzen z.B.
<ol><li>{{Klappbox|Box 1.3|{{Blindtext}}|verborgen=true}}</li></ol>:

  1. Box 1.3

    Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat. Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Tabellen in einer Klappbox[Bearbeiten]

Das Trennzeichen | innerhalb der Vorlage Klappbox kann nicht für andere Zwecke benutzt werden. Stattdessen muss man Vorlagen wie {{!}} benutzen. Da auch das Gleichheitszeichen Probleme machen kann, sollte der zweite Parameter mit Namen Inhalt= verwendet werden. Hier ist ein Beispiel mit einer Tabelle in einem Klappbox:

{{Klappbox|Tabelle in Klappbox|Inhalt =
{{(!}} class="wikitable"
{{!}}erste Zeile
{{!-}}
{{!}} zweite Zeile
{{!)}}
|verborgen=true}}

Dieser Wiki-Quelltext wird wie folgt dargestellt:

Tabelle in Klappbox
erste Zeile
zweite Zeile