PDF-Vorlagen in HTML oder Markdown

Markdown oder HTML

Brevier liest zwei Arten von Vorlagen. Beide nutzen dieselben {{ }}-Tags.

Format	Gut für	Datei
Markdown	Briefe, einfache Rechnungen, Text mit wenigen Tabellen	`rechnung.md`
HTML	volle Kontrolle: mehrere Kopfzeilen, Raster, eigene Blöcke	`rechnung.html`

Fangen Sie mit Markdown an. Wenn Sie mehr Kontrolle brauchen, machen Sie mit brevier compile (siehe unten) eine HTML-Datei daraus und arbeiten dort weiter.

Front Matter

Eine Markdown-Vorlage kann mit einem YAML-Block zwischen zwei ----Zeilen beginnen. Brevier liest dort seine Einstellungen.

angebot.md

---
theme: print-base
style: angebot.css
page:
  size: A4
---

Text des Dokuments …

Schlüssel	Bedeutung
`theme`	Ein eingebautes Theme: `print-base`, `web` oder `din5008`.
`style`	Eine CSS-Datei neben der Vorlage.
`page`	Papierformat, Ränder, Kopf- und Fußzeilen. Siehe Seitenlayout.
`table`	Eine Tabelle aus einer Liste in Ihren Daten. Siehe Tabellen.

Eine HTML-Vorlage hat kein Front Matter. Sie nennt ihr Theme in einem <meta>-Tag im <head>:

<meta name="brevier-theme" content="print-base">

Für ihr eigenes CSS legen Sie eine Datei mit demselben Namen daneben: rechnung.css neben rechnung.html.

Welches CSS gilt

Brevier sucht CSS in dieser Reihenfolge. Der erste Treffer gilt.

--theme und --style auf der Kommandozeile
theme und style im Front Matter
eine CSS-Datei mit dem Namen der Vorlage: rechnung.css neben rechnung.md

Das Theme kommt zuerst, Ihr eigenes Stylesheet danach. Ihre Regeln gewinnen also gegen die Regeln des Themes. Sie können --style mehrmals angeben; eine spätere Datei gewinnt gegen eine frühere.

Eingebaute Themes

Theme	Einsatz
`print-base`	Schlichte Regeln für gedruckte Seiten. Der Standard für neue Vorlagen.
`web`	Stile für die Ausgabe von `brevier html` in einer Webseite.
`din5008`	Das Layout eines deutschen Briefs oder einer Rechnung: Ränder, Anschriftfeld für den Fensterumschlag, Infoblock, Falz- und Lochmarke. Die Schrift gehört zum Theme. Siehe die DIN-5008-Werte.

Markdown zu HTML übersetzen

compile schreibt das HTML, das aus einer Markdown-Vorlage entsteht:

brevier compile rechnung.md

Das legt rechnung.html neben die Markdown-Datei. Die {{ }}-Tags bleiben darin stehen, und aus dem Front Matter werden <link>- und <meta>-Tags. Gibt es die Datei schon, bricht der Befehl ab; mit --force wird sie ersetzt.

Der Schritt geht nur in eine Richtung. Danach bearbeiten Sie die HTML-Datei, und die Markdown-Datei wird nicht mehr benutzt.

Vorschau im Browser

Vorlagen direkt im Browser mit automatischem Neuladen ansehen:

brevier preview rechnung.html --data rechnung.json --open

preview beobachtet Vorlage, Stylesheet und JSON-Daten und lädt die Ansicht bei jedem Speichern automatisch neu.

Vorlagen importieren

Bestehende Word-Dokumente (.docx), JasperReports (.jrxml) oder BIRT-Berichte (.rptdesign) wandelt import in eine Brevier-Vorlage, ein CSS-Stylesheet und ein JSON-Schema um:

brevier import rechnung.docx -o templates/rechnung

Vorlage importieren listet, was der Import umwandelt und nennt, und zeigt, wie Sie Ihren Aufruf ersetzen.