Dokumentation AEM Guides Dokumentation zu AEM Guides

Kontrollieren der Qualität von Inhalten im Web-Editor

Last update: Sun Jul 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Themen:

Erstellt für:

Benutzende
Admin

Dieser Artikel gibt einen Überblick über Validierungsmöglichkeiten im AEM Guides-Web-Editor.
Der Design-Web-Editor nutzt das DITA-Schema-Setup im System, um Benutzer dazu zu zwingen, DITA-konforme Inhalte zu erstellen. Dadurch ist der gesamte im System gespeicherte Inhalt strukturiert, wiederverwendbar und gültig.

Neben der Unterstützung für DITA-Regeln unterstützt der Web-Editor auch die Validierung von Inhalten, die auf "Schematron"-Regeln basieren.

"Schematron" bezieht sich auf eine regelbasierte Validierungssprache, mit der Tests für eine XML-Datei definiert werden. Sie können die Schemadateien importieren und sie auch im Web-Editor bearbeiten. Mithilfe einer Schematron-Datei können Sie bestimmte Regeln definieren und sie dann für ein DITA-Thema oder eine Zuordnung validieren. Schemaregeln können die Konsistenz der XML-Struktur sicherstellen, indem als Regeln definierte Einschränkungen auferlegt werden. Diese Beschränkungen werden von KMU getragen, die die Qualität und Konsistenz der Inhalte besitzen.

HINWEIS: Der Webeditor unterstützt ISO-Schemata.

Funktionsweise von "Schema"im Web-Editor

Konfigurieren von Schemaregeln

Siehe Abschnitt "Unterstützung für Schematron-Dateien"im Benutzerhandbuch

Validierungsregeln beim Speichern von Dateien durchsetzen

Mit den Webeditor-Einstellungen können Power-User Schemaregeln/-Dateien einrichten, die jedes Mal ausgeführt werden, wenn ein Benutzer den Inhalt aktualisiert. Weitere Informationen finden Sie im Abschnitt "Validierung"im Benutzerhandbuch

Festlegen von Regeln aus den Einstellungen des Web-Editors

Können Sie die Validierung manuell ausführen?

Ja, als Autor/Benutzer können Sie beim Erstellen von Inhalten das Bedienfeld "Schematron"im Webeditor verwenden, um eine Schematrator-Datei hochzuladen und Überprüfungen für die im Editor geöffnete Datei durchzuführen.

Damit dies funktioniert, muss der Ordnerprofiladministrator allen Benutzern erlauben, Schemadateien im Überprüfungsbedienfeld hinzuzufügen. Siehe Editor-Einstellungen (Screenshot oben)

Schematron-Datei auswählen
Ausführen der Validierung

Unterstützte Regeln

Die aktuelle Version von AEM Guides unterstützt die Validierung nur mit auf "Zusicherung"basierenden Regeln. (siehe Asset vs. Bericht)
Auf "Berichten"basierende Regeln werden noch nicht unterstützt.

Beispiele und weitere Hilfe zu Schemakontrollen-Regeln

Anwendungsbeispiele

Überprüfen Sie, ob ein Link extern ist und den Bereich "extern"aufweist.

code language-none

code language-none
`<sch:pattern> <sch:rule context="xref[contains(@href, 'http') or contains(@href, 'https')]"> <sch:assert test="@scope = 'external' and @format = 'html'"> All external xref links must be with scope='external' and format='html' </sch:assert> </sch:rule> </sch:pattern>`

<sch:pattern>
    <sch:rule context="xref[contains(@href, 'http') or contains(@href, 'https')]">
        <sch:assert test="@scope = 'external' and @format = 'html'">
            All external xref links must be with scope='external' and format='html'
        </sch:assert>
    </sch:rule>
</sch:pattern>

Überprüfen Sie, ob mindestens eine "topicref"in einer Zuordnung oder mindestens ein "li"unter einer "ul"vorhanden ist.

code language-none

code language-none
`<sch:pattern> <sch:rule context="map"> <sch:assert test="count(topicref) > 0"> There should be atleast one topicref in map </sch:assert> </sch:rule> <sch:rule context="ul"> <sch:assert test="count(li) > 1" > A list must have more than one item. </sch:assert> </sch:rule> </sch:pattern>`

<sch:pattern>
    <sch:rule context="map">
        <sch:assert test="count(topicref) > 0">
            There should be atleast one topicref in map
        </sch:assert>
    </sch:rule>

    <sch:rule context="ul">
        <sch:assert test="count(li) > 1" >
            A list must have more than one item.
        </sch:assert>
    </sch:rule>
</sch:pattern>

Das Element "indexterm"sollte immer in einem "prolog"vorhanden sein

code language-none

code language-none
`<sch:pattern> <sch:rule context="*[contains(@class, ' topic/indexterm ')]"> <sch:assert test="ancestor::node()/local-name() = 'prolog'"> The indexterm element should be in a prolog. </sch:assert> </sch:rule> </sch:pattern>`

<sch:pattern>
    <sch:rule context="*[contains(@class, ' topic/indexterm ')]">
        <sch:assert test="ancestor::node()/local-name() = 'prolog'">
            The indexterm element should be in a prolog.
        </sch:assert>
    </sch:rule>
</sch:pattern>

Ressourcen

Grundlegendes zu Schematron-Grundlagen
Weitere Informationen zu Zuweisungsregeln in Schematron
Beispielschema-Datei

recommendation-more-help

11125c99-e1a1-4369-b5d7-fb3098b9b178