Referenz
Cleaner
Die vier Cleaner von Brevier, jeweils mit Eingabe und Ausgabe, und dass noch keine Vorlage sie setzt.
Auf dieser Seite
Ein Cleaner entfernt unerwünschte Teile aus einem Wert, bevor er eingesetzt wird: verirrte Tags, Entitäten und überflüssige Leerzeichen. Cleaner laufen in der Reihenfolge, in der sie aufgelistet sind, und vor dem Feldtyp.
| Cleaner | Eingabe | Ausgabe | Wirkung |
|---|---|---|---|
stripHtml |
"<p>Hello <b>world</b></p>" |
Hello world |
Entfernt jedes Tag und behält den Text. Entitäten wie bleiben. Ein <br> verbindet die Wörter davor und danach. |
decodeEntities |
"Tom & Jerry <3" |
Tom & Jerry <3 |
Wandelt HTML-Entitäten in ihre Zeichen um. |
collapseSpaces |
"a b\r\n c" |
a b c |
Macht aus jeder Folge von Leerzeichen, Tabs und Zeilenumbrüchen ein Leerzeichen. |
trim |
" hi " |
hi |
Entfernt Leerzeichen, Tabs und Zeilenumbrüche an beiden Enden. |
In einem multiline-Feld macht collapseSpaces aus \r\n ein \n und
behält die Zeilenumbrüche.
Ein unbekannter Name schlägt fehl. Die Meldung nennt die vier bekannten Namen.
Eine typische Liste für Text aus einer Datenbank:
[stripHtml, decodeEntities, collapseSpaces, trim].
In Vorlagen noch nicht verfügbar
Weder eine Vorlage noch ein Schema noch ein Befehl setzt heute einen
Cleaner. Kein Rendern über brevier pdf, brevier html, die Clients oder
brevier serve führt einen aus.
Die Engine liest Cleaner aus einem Funktionsargument:
bind_template(html, data, cleaners={"note": ["stripHtml", "trim"]}).
Die PRD (Abschnitt E) beschreibt eine Angabe im Schema oder im Front Matter. Sie wird bisher nicht gelesen.