Zum Inhalt springen

Vorlage:Box/Doku

Aus Wikibooks

Beschreibung

[Bearbeiten]

Diese Vorlage dient dazu, eine Box einzubinden. Der Parameter inhalt gibt den Inhalt der Box an und muss immer angegeben werden. Mit dem optionalen Parameter icon kann ein Icon angegeben werden, welches neben der Box angezeigt wird. Dabei dient der optionale Parameter icon-size dazu, die Breite des Icons zu bestimmen (der Defaultwert ist 24px).

Beispiel:

{{Box
 |icon=Qsicon Achtung.svg
 |icon-size=30px
 |inhalt={{Blindtext}}
}}

Ergebnis:

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.

Verwendung dieser Vorlage als Basis für andere Vorlagen

[Bearbeiten]

Um diese Vorlage als Basis für andere Box-Vorlagen zu verwenden, kannst du folgenden Code verwenden:

<onlyinclude>{{Box
 |style=<dein Style>
 |icon=<Name des Icons>
 |icon-size=<Breite des Icons in Pixel>
 |inhalt=
... Dein Inhalt ...
}}</onlyinclude>

<noinclude>{{Dokumentation}}</noinclude>

Die Parameter

[Bearbeiten]

Der Parameter style

[Bearbeiten]

Mit Hilfe des style Parameters kann das Design der Box gesteuert werden. Folgende Designstile sind vordefiniert:

Wert für style Ergebnis
Info

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.

Hinweis

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.

Fehlermeldung

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.

Systemnachricht

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.

grauer Rahmen

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.

blauer Rahmen

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.

blauer Kasten

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.

grauer Kasten

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.

dezenter grauer Kasten

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.

keine Wert für style

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.

Es können einfach auch weitere Styles definiert werden. Wenn du für deine Arbeit weitere Styles brauchst, dann melde dich bitte bei Benutzer:Stephan Kulla.

Der Parameter icon-noprint

[Bearbeiten]

Da in der Wikibook-Druckversion von Pediapress CSS-Anweisungen ignoriert werden, ist für das Icon class="noprint" gesetzt. Man muss icon-noprint explizit auf „nein“ setzen (also icon-noprint=nein), wenn man die Icons in der Druckversion angezeigt haben möchte.

Der Parameter icon-vertical-align

[Bearbeiten]

Für das Icon ist vertical-align auf middle gesetzt. Mit icon-vertical-align kann dieser Wert verändert werden.

Der Parameter inhalt-vertical-align

[Bearbeiten]

Für den Inhalt (zweite Spalte) ist vertical-align auf middle gesetzt. Mit inhalt-vertical-align kann dieser Wert verändert werden.

Weitere Parameter

[Bearbeiten]

Diese Vorlage basiert auf Vorlage:Mehrspaltenlayout und damit auf Vorlage:Kasten. Folgende Parameter von Vorlage:Kasten können mitverwendet werden:

  • position
  • width
  • max-width
  • min-width
  • außenabstand

Von der Vorlage:HTMLTag können folgende Parameter verwendet werden:

  • nomobile
  • noprint
  • id
  • clear
  • html-tag
  • css
  • float-objekte-beachten

Vorlagen-Spezifikation

Diese Vorlage bindet eine Box ein.

Vorlagenparameter[Vorlagendaten bearbeiten]

ParameterBeschreibungTypStatus
Inhaltinhalt

Inhalt der Box.

Beispiel
Diese Vorlage funktioniert derzeit nicht.
Wikitexterforderlich
Icon-Dateinameicon

Dateiname des Icons, welches in der Box angezeigt werden soll.

Beispiel
Achtung.svg
Dateierforderlich
Icon-Breiteicon-size

Breite des Icons.

Standard
24px
Beispiel
10em
Einzeiliger Textoptional
Icon-Verticalalignicon-vertical-align

Wert für den Parameter von der CSS-Eigenschaft „vertical-align“ für das Icon.

Standard
middle
Beispiel
left
Einzeiliger Textoptional
Inhalt-Verticalaligninhalt-vertical-align

Wert für den Parameter von der CSS-Eigenschaft „vertical-align“ für den Inhalt.

Standard
middle
Beispiel
right
Einzeiliger Textoptional
Icon-Noprinticon-noprint

Setze diesen Wert auf „nein“, wenn das Icon in der Druckversion erscheinen soll.

Standard
ja
Beispiel
nein
Einzeiliger Textoptional
Icon-Linkicon-link

Wenn ein Wert gesetzt ist, wird das Bild zu ihm verlinkt

Beispiel
Hauptseite
Einzeiliger Textoptional
Stylestyle

Das Design des Kastens.

Beispiel
Hinweis
Einzeiliger Textvorgeschlagen
Positionposition

Die Positionierung und Ausrichtung des Kastens.

Standard
ganze Breite
Beispiel
mittig
Einzeiliger Textoptional
Breitewidth

Die Breite des Kastens.

Beispiel
100ch
Einzeiliger Textoptional
Maximale Breitemax-width

Die maximale Breite des Kastens.

Beispiel
500px
Einzeiliger Textoptional
Minimale Breitemin-width

Die minimale Breite des Kastens.

Beispiel
20em
Einzeiliger Textoptional
Außenabstandaußenabstand

Außenabstand bei mittig zentrierten Kästen.

Einzeiliger Textoptional
Clearclear

Wert der CSS-Eigenschaft „clear“.

Beispiel
left
Einzeiliger Textoptional
Kasten-Tag-Namehtml-tag

Name des HTML-Tag-Namens für den Kasten

Standard
div
Beispiel
span
Einzeiliger Textoptional
Float-Objekte beachten?float-objekte-beachten

Sollen andere gefloatete Objekte für die Breitenbestimmung berücksichtigt werden? Wenn nein, setze einen leeren Wert!

Standard
ja
Beispiel
Einzeiliger Textoptional
Weiteres CSScss

Weiteres CSS für den Kasten

Beispiel
border-style:solid;border-width:1px;
Einzeiliger Textoptional
IDid

Setzt das HTML-Attribut id des HTML-Elements.

Einzeiliger Textoptional
No-Mobile?nomobile

Setze diesen Parameter auf „ja“, wenn der Inhalt auf mobilen Seiten versteckt werden soll.

Beispiel
ja
Einzeiliger Textoptional
No-Print?noprint

Setze diesen Parameter auf „ja“, wenn der Inhalt in der Druckversion der Seite versteckt werden soll.

Beispiel
ja
Einzeiliger Textoptional

Hinweis: Diese Vorlagen-Spezifikation wurde mit Hilfe der Parsererweiterung <templatedata> erstellt. Siehe Vorlage:TemplateData für eine Erklärung, wie du <templatedata> auf Wikibooks verwenden kannst.

<templatedata> wird unter anderem vom VisualEditor verwendet. Eine ausführliche Hilfe zu dieser Parsererweiterung findest auf der Seite Help:TemplateData.