Deutsch
Über dieses Handbuch

Dieses Handbuch gehört zum Quartz-Plugin quartz-layout-box. Und es ist mit ihm gebaut: Diese Box hier ist eine Layout-Box.

Sie kommt aus einer Markdown-Datei, nicht aus der Konfiguration — welcher Weg wann der bessere ist, steht in Der Schnipsel.

2.1 – Datei oder Konfiguration

Der Inhalt einer Box kommt aus einer Datei oder direkt aus der Konfiguration:

options:
  file: snippet.html   # -> snippets/snippet.html
options:
  html: "<p>Notizen aus einer kleinen Stadt.</p>"

html gewinnt immer

Stehen beide da, wird file nicht einmal gelesen. Das ist keine Fehlermeldung wert, aber eine häufige Verwirrung: Wer eine Datei anlegt und sie nicht erscheint, hat oft noch ein html aus einem früheren Versuch im Eintrag stehen.

Wann welcher Weg

Datei (file)Konfiguration (html)
Umfangmehr als zwei, drei ZeilenEinzeiler
Bearbeitenim Editor, mit Syntaxhervorhebungin der YAML-Datei, mit ihren Ausweichregeln
Im Serve-ModusÄnderung wirkt beim NeuladenÄnderung braucht einen Neustart
Im Vorlagenpaketreist über den Baustein Statische Dateien mitreist im Eintrag selbst mit

Der letzte Punkt ist der, der am häufigsten überrascht — und er ist der Grund, warum die Example-Vorlage für QuartzControl sechs ihrer sieben Boxen mit html bestückt: Ein Vorlagenpaket ohne den Baustein Statische Dateien nimmt Schnipsel-Dateien nicht mit, und im Zielprojekt zeigte eine file:-Box dann ins Leere.

YAML und Markup vertragen sich mäßig

Mehrzeiliges HTML in YAML braucht einen Blockskalar. | behält die Zeilenumbrüche, >- faltet sie zu Leerzeichen und schluckt den letzten:

options:
  html: |
    <p>Erste Zeile.</p>
    <p>Zweite Zeile.</p>

Sobald Anführungszeichen, Doppelpunkte und Rautenzeichen im Markup vorkommen — also fast immer —, ist eine Datei der ruhigere Weg.