Vorlage:Codebox/Doku

Sälli Sitte isch d'Dokumentations-Undersitte vu de Vorlage:Codebox.

Diese Vorlage erzeugt eine formatierte Codebox, wie sie etwa in Kopiervorlagen auf Dokumentationsseiten von Infobox-Vorlagen verwendet wird. Im Gegensatz zu einfachen <pre>…</pre>-Tags überlappt sich diese Box jedoch nicht mit benachbarten Infoboxen und überlange Zeilen werden automatisch umbrochen.

Kopiervorlage

{{Codebox|<nowiki>
…
</nowiki>}}

Parameter

Einziger unbenannter Parameter ist der zu formatierende Code. Dieser muss aus technischen Gründen in <nowiki>…</nowiki>-Tags eingeschlossen werden.

Beispiele

{{Codebox|<nowiki>
{{Infobox …
| Überlanger Text = 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.
}}
</nowiki>}}

ergibt

Infobox …
foo
bar
baz

{{Infobox …
| Überlanger Text = 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.
}}

Zum Vergleich:

<pre>
{{Infobox …
| Überlanger Text = 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.
}}
</pre>

ergibt

Infobox …
foo
bar
baz

{{Infobox …
| Überlanger Text = 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.
}}

Technische Erklärung

Die CSS-Eigenschaft overflow:hidden erzeugt einen neuen Blockformatierungskontext und sorgt so dafür, dass die Boxen sich nicht überlappen.

Die Eigenschaft white-space:pre-wrap lässt überlange Zeilen an den gewöhnlichen Umbruchstellen umbrechen.

Die Eigenschaft overflow-wrap:break-word mit dem veralteten Synonym word-wrap:break-word bewirkt, dass überlange Zeilen notfalls auch mitten in einem Wort umbrechen, falls keine besser geeigneten Umbruchstellen vorhanden sind.