Vorlage:Duobox/Doku

Beschreibung

Die Vorlage:Duobox ist für die Verwendung auf Beschreibungs- und Hilfeseiten gedacht, um Wikiquelltext und tatsächliches Aussehen neben- oder untereinander zu stellen. Die Vorlage stellt bei ausreichender Fensterbreite zwei Kästen nebeneinander dar. Bei nicht ausreichender Fensterbreite (z. B. mobil) werden die Kästen untereinander dargestellt. Dies stellt den Vorteil gegenüber Verwendung einer Tabelle dar. Es können darüber hinaus auch andere Zusammenhänge neben-/untereinander dargestellt werden.

Die Vorlage basiert auf der Vorlage:Kasten und deren Stile (siehe Beschreibung dort: Vorlage:Kasten#Der style Paramter) können verwendet werden um das Aussehen – sowohl der einzelnen Kästen als auch, bei entsprechender Auswahl, den Umfassenden Kasten – anzupassen.

Achtung: Um die Vorlage zu verkleinern und eine bessere Wartbarkeit der Vorlage zu erreichen wurde die Vorlage Kasten nicht direkt eingebunden, sondern deren Eigenschaften im Quelltext kopiert! Zukünftige Änderungen der Vorlage:Kasten (Stand Quartal 2 2017) werden sich nicht in den Wahlmöglichkeiten für die Stile des umfassenden Kastens niederschlagen. Die Kästen innerhalb der Vorlage nutzen die Vorlage:Kasten direkt, hier können zukünftige Änderungen gewählt werden.

Parameter

notwendig

|Text=… – Der darzustellende Text. Handelt es sich um einfache Wiki-Syntax ist nichts weiter erforderlich.

Beispiel:

{{Duobox|Text=
* Aufzählung 1
** Aufzählung 2}}

Wird zu:

Was man schreibt

* Aufzählung 1
** Aufzählung 2

Wie es aussieht

Aufzählung 1
- Aufzählung 2

Anm. 1: Es können keine Vorlagen und sollten keine Überschriften hier Verwendung finden. Die Vorlage Duobox funktioniert dann nicht wie erwartet oder gewünscht. Falls Vorlagen oder Überschriften verwendet werden sollen, bitte den Abschnitt #1 – einfache Beeinflussung der Vorlage lesen.

Anm. 2 (wahlfreie Angabe): Wird ein Text über diesen Parameter eingegeben, werden Syntaxhighlight Möglichkeiten eines Plugins der Mediawiki-Software genutzt. In diesem Fall kann über

|Sprache=… – die darzustellende Programmiersprache gewählt werden. Eine Liste der verfügbaren Sprachen findet sich hier: http://pygments.org/languages/

wahlfrei

Art

|1=… oder |… – Ein nicht benannter Parameter, legt fest, wie sich die Einbindung in die Webseite verhält. Es gibt drei Varianten:

Als fließende Objekte (Standard, ohne Wahl einer der beiden folgenden Paramter wird diese Konfiguration gewählt, Parameterwert: fließend oder float)
Als Kasten (siehe Vorlage:Kasten für die Erläuterung der Parameter), hierbei umgibt die beiden Kästen ein weiterer Kasten, der entsprechend den vorhandenen Stilen für die Vorlage:Kasten gestaltet werden kann. (Parameterwert: Kasten)
Im Spaltenformat im umgebenden Kasten, hierbei wird ergänzend der Parameter Spaltenbreite ausgewertet. (Parameterwert: Spalten oder column)

Beispiel:

{{Duobox|Spalten
|Text=
* Aufzählung 1
** Aufzählung 2}}

Wird zu:

Was man schreibt

* Aufzählung 1
** Aufzählung 2

Wie es aussieht

Aufzählung 1
- Aufzählung 2

Anm.: Durch Veränderung der Fensterbreite kann der unterschiedliche Effekt beobachtet werden, falls eine entsprechende Browserunterstützung vorliegt, siehe http://caniuse.com/#feat=multicolumn; Das ist der Grund, warum die Spaltenkonfiguration noch nicht die Standardeinstellung ist, was sie in Zukunft werden soll.

Einfache Beeinflussung der Vorlage

|Stilpreset=… – Es können voreingestellte Ansichten gewählt werden:

dezent – einfache Boxdekoration, Standardwert
schlicht – nur der Inhalt wird abgehoben
deutlich – die Stilvorlagen Info und Hinweis der Vorlage:Kasten werden als Dekoration benutzt

Beispiel:

{{Duobox
|Stilpreset=deutlich
|Text=
* Aufzählung 1
** Aufzählung 2}}

Wird zu:

Was man schreibt

* Aufzählung 1
** Aufzählung 2

Wie es aussieht

Aufzählung 1
- Aufzählung 2

|Titel=… – Um einen gemeinsamen Titel darzustellen, oder beide Titel auszuschalten (hierfür aus, kein oder ohne angeben)

|Linkstitel=… – Um einen Titel für den linken/oberen Teil einzugeben

|Rechtstitel=… – Um einen Titel für den rechten/unteren Teil einzugeben

Beispiel:

{{Duobox
|Linkstitel=
=====Aufzählungen ''sind'' prima=====
|Rechtstitel=kein
|Text=
* Aufzählung 1
** Aufzählung 2}}

Wird zu:

Aufzählungen sind prima

* Aufzählung 1
** Aufzählung 2

Aufzählung 1
- Aufzählung 2

Anm. 1: Die Standard-Titel sind Was man schreibt – Wie es aussieht oder (bei gesetztem |Format=switch… oder |Format=blankswitch…, s. u.) Um folgendes zu erhalten… – …schreibt man.

Anm. 2: Die Standard-Titel sind fett formatiert. Sie können frei formatiert oder auch als Überschrift angelegt werden, die dann im Inhaltsverzeichnis auftaucht (falls dieses die Verzeichnisebenen tief genug darstellt, s. o.). Bei Überschriften ist auf einen Zeilenumbruch zu achten (siehe Beispiel).

Anm. 3: Die Einzeltitel für links und rechts haben Vorrang vor einem gemeinsamen Titel.

|Linkstext=… und

|Rechtstext=… – ermöglichen die Eingabe eigener Texte für beide Boxen.

Dies wird zwingend erforderlich, falls Vorlagen erklärt werden sollen, denn bei Verwendung des Syntaxhighlights würde die Vorlage eingebunden dargestellt (bei Bedarf mit der Vorschau ausprobieren).

Beispiel:

{{Duobox
|Linkstext=
=== Dies ist eine Überschrift ===

<nowiki>{{Kasten|style=blauer Rahmen|Inhalt}}</nowiki> und das war eine Vorlage
|Rechtstext= 
{{Überschriftensimulation 3|Dies ist eine Überschrift}}

{{Kasten|style=blauer Rahmen|Inhalt}} und das war eine Vorlage
}}

Wird zu:

Was man schreibt

=== Dies ist eine Überschrift ===

{{Kasten|style=blauer Rahmen|Inhalt}} und das war eine Vorlage

Wie es aussieht

Dies ist eine Überschrift

Inhalt

und das war eine Vorlage

Anm. 1: In diesem Fall müssen im Linkstext (oder auf der Seite auf der der „Quelltext“ steht) angemessen <nowiki>-Markierungen verwendet werden.

Anm. 2: Es ist ratsam im Rechtstext (oder auf der Seite auf der die „Anzeige“ steht) Vorlage:Überschriftensimulation 2 und Verwandte einzusetzen, falls nicht erwünscht ist, dass diese Überschriften im Inhaltsverzeichnis auftauchen.

|Format=…,

|Linksformat=… und

|Rechtsformat=…

Der Parameter Format hat zwei Aufgaben:

mit der Eingabe von |Format=switch (als Kasten dekoriert) oder |Format=blankswitch (ohne Kastendekoration) werden die beiden Boxen getauscht. Per Standard steht links oder oben was man eingibt und rechts oder unten, wie es aussieht. Die Angabe switch/blankswitch tauscht diese Darstellung. Der Tausch wirkt sich auch auf die Kastendekoration bei |Stilpreset=deutlich aus.
Es können übergreifend für beide Boxen Darstellungsvorgaben angewählt werden. Diese Möglichkeit ist ein Nebeneffekt zur gerade beschriebenen Switch-Funktionalität. Da die Vorlage überwiegend für den Vergleich von Wikiquelltext und Ausgabe geschrieben wurde, sind die Standardeinstellungen Wikiquelltext und normale Anzeige. Dies kann entweder für beide Kästen gemeinsam oder für jeden Kasten einzeln über die beiden Parameter:
|Linksformat=… und
|Rechtsformat=…
eingestellt werden. Zur Auswahl stehen:
- Syntax – Es wird das Plugin Syntaxhighlight-Plugin(Seite auf englisch) zur Darstellung benutzt (hier ist der Parameter
  |Sprache=…
  verfügbar, s. o.)
- normal – Es wird normaler Text in einem Kasten angezeigt
- mono – Darstellung in einem Kasten als Schriftart mit gleich-breiten Buchstaben. Das kann von Vorteil sein, weil das oben beschriebene Plugin keinen Zeilenumbruch beherrscht. Langer Wikiquelltext ist so besser darstellbar.
- kein/ohne/aus – Es wird der eingegebene blanke Text ohne Kasten dargestellt.
- blank – Es wird der Inhalt in einem Kasten ohne Rahmen dargestellt.
- blankmono – Es wird der Inhalt in einem Kasten ohne Rahmen mit gleich-breiten Buchstaben dargestellt.

Anm. 1: Bei Verwendung von Syntax wird immer ein Kasten um den Quelltext dargestellt, da das Syntaxhighlight-Plugin einen formatierten Kasten benutzt, der mit dieser Vorlage nicht beeinflussbar ist.

Anm. 2: Bei Tausch des Zwecks der beiden Kästen sind natürlich auch Angaben von <nowiki> und/oder Vorlage:Überschriftensimulation 2 u. a. zu tauschen.

Beispiel:

{{Duobox
|Stilpreset=schlicht
|Format=blankswitch
|Linkstext=
{{Überschriftensimulation 3|Dies ist eine Überschrift}}

{{Kasten|style=blauer Rahmen|Inhalt}} und das war eine Vorlage
|Rechtstext= 
<nowiki>===</nowiki> Dies ist eine Überschrift ===

<nowiki>{{Kasten|style=blauer Rahmen|Inhalt}}</nowiki> und das war eine Vorlage
}}

Wird zu:

Um folgendes zu erhalten...

Dies ist eine Überschrift

Inhalt

und das war eine Vorlage

...schreibt man

=== Dies ist eine Überschrift ===
{{Kasten|style=blauer Rahmen|Inhalt}} und das war eine Vorlage

|Linkskopf=…

|Linksfuß=…

|Rechtskopf=…

|Rechtsfuß=… – Diese vier Angaben können dazu verwendet werden Kopf- und Fußabsätze und Texte zu formulieren und z. B. weitere Angaben zu den Kasteninhalten zu machen. Eine besondere Formatierung ist hier nicht möglich, jedoch können zu diesem Zweck auch weitere Vorlagen verwendet werden.

Ein Beispiel für die Verwendung findet sich unten im Abschnitt #Komplexes Beispiel.

Tiefere Beeinflussung der Vorlage

|Linksstil=… und

|Rechtsstil=… – können verwendet werden, um den beiden Kästen Style-Vorgaben der Vorlage:Kasten zu übergeben. Welche verwendbar sind, siehe Vorlage:Kasten#Der style Paramter.

|Linksbreite-min=… und

|Rechtsbreite-min=… – definieren die minimale Breite des linken und rechten Kastens. Der Standardwert liegt bei 22em (siehe https://www.w3.org/Style/Examples/007/units.de.html für eine Erklärung der Einheiten). Falls ein Text eine bestimmte Mindestbreite haben sollte, kann das hiermit spezifiziert werden. Eine Verringerung der Mindestbreite ist im Normalfall nicht sinnvoll. Für eine Ausnahme, siehe Abschnitt #Kaskadierung.

Ein Beispiel für die Verwendung findet sich unten im Abschnitt #Komplexes Beispiel.

|Linksstil-innen=… und

|Rechtsstil-innen=… – können verwendet werden, um den beiden inneren Text-Kästen Style-Vorgaben der Vorlage:Kasten zu übergeben. Welche verwendbar sind, siehe Vorlage:Kasten#Der style Paramter

Ein Beispiel für die Verwendung findet sich unten im Abschnitt #Komplexes Beispiel.

Anm.: Diese Parameter stehen im Visual Editor und mobil nicht einfach zur Verfügung.

|Linkscss-innen=… und

|Rechtscss-innen=… – können verwendet werden, um den beiden inneren Text-Kästen weitere CSS-Angaben zu übergeben. Hierzu siehe Vorlage:HTMLTag#Der_Parameter_css

Ein Beispiel für die Verwendung findet sich unten im Abschnitt #Komplexes Beispiel.

Anm.: Dieser Parameter steht im Visual Editor und mobil nicht einfach zur Verfügung.

Einfluss auf den äußeren Kasten

Die folgende Parameter-Liste gibt Einflussmöglichkeiten auf den Äußeren Kasten an, wenn der unbenannte Parameter aus dem Abschnitt #Art mit dem Wert Spalten oder Kasten bedient wird. Achtung, die Vorlage Kasten ist hier nicht direkt eingebunden, sondern es werden nur die Parameter identisch verwendet (Stand Quartal 2 – 2017).

Da die Verwendung dieser Parameter auf der Vorlage:Kasten und diese auf der Vorlage:HTMLTag basieren, können Einzelheiten dazu dort nachgelesen werden.

|float-objekte-beachten=…
|clear=…
|style=…
|position=…
|außenabstand=…
|max-width=…
|width=…
|min-width=…
|nomobile=…
|noprint=…
|id=…
|mf-id=…
|inline=…
|css=…

Anm.: Diese Parameter stehen im Visual Editor und mobil nicht einfach zur Verfügung.

Einfluss auf das Spaltenlayout

|spaltenbreite=… – Wenn der unbenannte Parameter aus dem Abschnitt #Art mit dem Wert Spalten oder column bedient wird, kann mit diesem Parameter die Spaltenbreite der beiden Spalten festgelegt werden. Der Standard-Wert liegt bei 75ex. Kleinere Werte können dazu führen, dass die Spalten nicht mehr die volle Seitenbreite füllen (dieser Effekt ist auch bei sehr breiten Monitoren im Vollbild zu beobachten). Größere Werte können dazu führen, dass die beiden Kästen grundsätzlich untereinander dargestellt werden.

Anm.: Dieser Parameter steht im Visual Editor und mobil nicht einfach zur Verfügung.

Verwendung

Kopiervorlage – einfach

{{Duobox
|text=…
}}

Kopiervorlage – standard

Die folgende Kopiervorlage bildet den Standardnutzungsfall (links: längerer Wikiquelltext – rechts: Ausgabe) ab. Titel und komplexere Parameter wurden hier weggelassen.

{{Duobox
|Linksformat=Mono <!-- Hiermit wird ein Umbruch bei der 
Codeangabe ermöglicht -->
|Linkskopf=
|Linkstext=
|Linksfuß=
|Rechtskopf=
|Rechtstext=
|Rechtsfuß=
}}

Die folgende Kopiervorlage bildet den getauschten Standardnutzungsfall (links: Ausgabe – rechts: längerer Wikiquelltext) ab. Alle komplexeren Parameter wurden hier weggelassen.

{{Duobox
|Format=switch
|Linkskopf=
|Linkstext=
|Linksfuß=
|Rechtsformat=Mono <!-- Hiermit wird ein Umbruch bei der 
Codeangabe ermöglicht -->
|Rechtskopf=
|Rechtstext=
|Rechtsfuß=
}}

Kopiervorlage – komplex

Anm.: Achtung, einige Paramter erzeugen in unterschiedlichen Kombinationen die gleichen Ergebnisse. Bspw. erzeugt die Angabe von |Linkstitel=Titel 1|Rechtstitel=aus Das gleiche Ergebnis, wie |Linkstitel=Titel 1|Titel=aus, da die dedizierten Parameter für die Einzeltitel Vorrang vor dem Gesamtparameter haben. Dieser kann aber verwendet werden, um beide gleichzeitig auszuschalten.

{{Duobox
|
|float-objekte-beachten=
|clear=
|style=
|position=
|außenabstand=
|max-width= 
|width=
|min-width=
|spaltenbreite=
|nomobile=
|noprint=
|id=
|mf-id=
|inline=
|Stilpreset=
|Linksstil= 
|Linksbreite-min=
|Linkstitel=
|Titel=
|Format=
|Linkskopf=
|Linksformat=
|Linkstext=
|Linksstil-innen=
|Linkscss-innen=
|Text=
|sprache=
|Linksfuß=
|Rechtsstil=
|Rechtsbreite-min=
|Rechtstitel=
|Rechtskopf=
|Rechtsformat=
|Rechtstext=
|Rechtsfuß=
|Rechtsstil-innen=
|Rechtscss-innen=
}}

Einfache Beispiele, mehrfache Verwendung

Ein einfaches Beispiel von Hilfe:Seiten bearbeiten. Schaue in den Quelltext, wie die Parameter für dieses Ergebnis eingesetzt sind.

Was man schreibt

Eine einfache neue Zeile (Zeilenumbruch)
wirkt sich nicht auf das Layout aus. 
Zeilenumbrüche können benutzt werden, um
Sätze innerhalb eines Absatzes zu trennen.
Einige Redakteure finden, dass dies das Editieren erleichtert.

Einen neuen Absatz beginnt man mit einer leeren Zeile.

Wie es aussieht

Eine einfache neue Zeile (Zeilenumbruch) wirkt sich nicht auf das Layout aus. Zeilenumbrüche können benutzt werden, um Sätze innerhalb eines Absatzes zu trennen. Einige Redakteure finden, dass dies das Editieren erleichtert.

Einen neuen Absatz beginnt man mit einer leeren Zeile.

Was man schreibt

Man kann auch Zeilen umbrechen,<br />
ohne einen neuen Absatz zu beginnen.

Das fällt aber im fortlaufenden Text nicht auf und ist
nur in Tabellen und Aufzählungen üblich.

Wie es aussieht

Man kann auch Zeilen umbrechen,
ohne einen neuen Absatz zu beginnen.

Das fällt aber im fortlaufenden Text nicht auf und ist nur in Tabellen und Aufzählungen üblich.

Was man schreibt

* Auflistungen sind sehr einfach:
** Beginne jede Zeile mit einem Stern
*** Mit mehr Sternen bekommt man tiefere Einrückungen

Wie es aussieht

Auflistungen sind sehr einfach:
- Beginne jede Zeile mit einem Stern
  - Mit mehr Sternen bekommt man tiefere Einrückungen

Was man schreibt

# Nummerierte Listen sind auch einfach
## sehr organisiert
## einfach zu folgen

Wie es aussieht

Nummerierte Listen sind auch einfach
1. sehr organisiert
2. einfach zu folgen

Was man schreibt

* Man kann auch gemischte Aufzählungen erstellen
*# die man wie
*#* die einrücken kann

Wie es aussieht

Man kann auch gemischte Aufzählungen erstellen
1. die man wie
  - die einrücken kann

Komplexes Beispiel

Verwendung vieler verschiedener Parameter im Zusammenspiel. Schaue in den Quelltext, wie die Parameter für dieses Ergebnis eingesetzt sind.

Eine so umfassend verschachtelte Verwendung ist keinesfalls empfohlen und nur im Ausnahme-/Einzelfall sinnvoll. Sie ist hier nur aus Gründen der Vollständigkeit als Beispiel angeführt. Beachte, dies ist kein realistisches Beispiel und dient in erster Linie dazu das Zusammenspiel der Parameter aufzuzeigen.

Dies ist eine breite Box

Das hier ist die zweite Zeile des Titels: die minimale Breite wird aber nur offensichtlich, wenn man sich dies hier mobil anschaut, oder die Fensterbreite variiert.

Auch Striche können gezogen werden ↓

Aloha – hier ist eine Kopfzeile für den linken Kasten mit

einer Aufzählung
von zwei Punkten

Obiger Text hätte auch hier stehen können.

Hier steht aber nur Blindtext drin: 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.

Aloha – hier ist eine Fußzeile mit einem Kasten in dem steht eine

Definition: einer Definition in einem Kasten

Kein Titel – aber noch eine Kopfzeile

Hier steht noch nicht mal {{Blindtext}}
Ist aber Monospace und mit 'nem dicken Rahmen.
Und selbst hier, im Kasten des Kastens vom Kasten, kann man noch einen Kasten aufrufen!

Viel Spaß bei der komplexen Gestaltung

Besonderheiten

Kaskadierung

Auch wenn es möglich ist, sollte die Vorlage nicht kaskadiert werden. Davon abgesehen, dass dadurch noch mehr HTML-div-Objekte verschachtelt würden und vermutlich eine andere Darstellung angemessener wäre, funktionieren die Breitendefinitionen nicht mehr ordnungsgemäß. Dies kann bei folgendem Beispiel durch vergrößern oder verkleinern des Fensters beobachtet werden kann.

Was man schreibt

{{Duobox}}

Wie es aussieht

Was man schreibt

Es wurde kein Text eingegeben. 
Mögliche Parameternamen: 
Linkstext oder Text
Verwendung: |Linkstext=„Inhalt“ oder |Text=„Inhalt“.
Hier kann z. B. stehen, wie man im Editor schreibt. Bei komplexeren Funktionen, wie der Erklärung von Vorlagen <nowiki>-Tags benutzen, sodass die tatsächliche Eingabe angezeigt wird. (siehe auch Dokumentation Vorlage:Duobox).

Wie es aussieht

Es wurde kein Text eingegeben.

Mögliche Parameternamen:

Rechtstext oder Text
Verwendung: |Rechtstext=„Inhalt“ oder |Text=„Inhalt“.
Hier kann z. B. stehen, wie es hinterher auf der Seite aussieht. Hier sollte die Vorlage:Überschriftensimulation 2 u.  a. benutzt werden, da verwendete Überschriften sonst im Inhaltsverzeichnis auftauchen (siehe auch Dokumentation Vorlage:Duobox).

Umgangen werden kann dies mit einer Spezifizierung von minimalen Breiten der inneren Verwendung durch |Rechtsbreite-min=20em ebenso Rechtsbreite-min=20em, falls die minimalen Breiten der äußeren Verwendung nicht verändert wurden. Für den Fall, dass diese Verwedung gewünscht sein sollte, kann als Faustformel min. breite innen = min. breite außen - 2em verwendet werden.

Größe der Vorlage

Eine überschlägige Rechnung lässt vermuten, dass die Vorlage aufgrund ihrer Größe etwa 50 Mal pro Seite einsetzbar ist, ohne die maximale Einbindungsgröße zu überschreiten.

Besonderheiten des Spaltenlayouts

Je nach Monitor und Fensterbreite (insbesondere bei sehr großen Monitoren oder kleiner Darstellung) kann es dazu kommen, dass im Spaltenlayout nicht die volle verfügbare Breite genutzt wird. Siehe auch Abschnitt #Einfluss auf das Spaltenlayout.