Open Source Dokumentenmanagement
Dokumentation

Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core JavaScript-API


JavaScript-Bibliothek common/html

Diese Bibliothek bietet Funktionen zum Parsen und Konvertieren von HTML-Dateien.

Verwendung


Binden Sie die Bibliothek stets am Anfang eines Skripts ein:

let html = require('common/html');

html.text('<p>Text to convert</p>');

Funktionen


text(html)

Konvertiert HTML in Plain Text.

Übergeben Sie entweder einen String oder ein agorum core-Objekt.


Syntax


agorum core-Objekt

html.text(objects.find('agorum core-Objekt'));


String

html.text('string');


Beispiel

let objects = require('common/objects');
let html = require('common/html');

// per agorum core-Objekt
let text = html.text(objects.find('agorum-id'));

// oder als String
text = html.text('<p>Text to convert</p>');

// oder als Stream
text = html.text(objects.find('agorum-id').contentStream);


Rückgabewerte

Sie erhalten einen String.

clean(html)

Säubert ein HTML.


Beispiel

let html = require('common/html');

let cleanHtml = html.clean('<p>Guter Inhalt</p><script>alert("Böser Inhalt");</script><p>Weiterer guter Inhalt</p>');


Ergebnis

<p>Guter Inhalt</p>
<p>Weiterer guter Inhalt</p>


Rückgabewerte

Sie erhalten einen String.

parse(html)

Analysiert ein HTML und greift direkt auf die DOM-Struktur zu.

Übergeben Sie einen String oder ein agorum core-Objekt.


Beispiel

let objects = require('common/objects');
let html = require('common/html');

let document = html.parse(objects.find('agorum-id'));

// zum Beispiel alle A-Tags (Links) aus dem Dokument herausholen:
let links = html.parse(objects.find('1218952')).body().getElementsByTag('a');


Rückgabewerte

Sie erhalten ein Document-Objekt aus der jsoup-Bibliothek zurück.

escape(text)

Kodiert den Text, sodass ein Browser ihn unverändert anzeigen kann.

Übergeben Sie einen String.


Beispiel

let html = require('common/html');

let escaped = html.escape('<test>');


Ergebnis

&lt;test&gt;


Rückgabewerte

Sie erhalten einen String.

Beispiele


Umlaute/ Sonderzeichen in HTML-Entitys umwandeln

let html = require('common/html');

let htmlDoc = html.parse('täüsßt');
let settings = htmlDoc.outputSettings();
settings.escapeMode(Packages.org.jsoup.nodes.Entities.EscapeMode.extended);
settings.charset("ASCII");
let html = htmlDoc.body().html();