Vollständigkeitsprüfung
Sie können ein Dokument und bei Bedarf alle Unterkomponenten (z.B. Datei-Entities) eines Dokuments auf Vollständigkeit prüfen. Das Dokument wird von Arbortext Editor dahingehend überprüft, ob alle vom Dokumenttyp benötigten Komponenten vorhanden sind. Bei der Erstellung bzw. Bearbeitung eines Dokuments wird in Arbortext Editor permanent der Kontext der beabsichtigten Änderungen bzw. Hinzufügungen überprüft. Außerdem wird Feedback bereitgestellt, das Sie bei der Erstellung eines gültigen SGML- bzw. XML-Dokuments unterstützt. Bestimmte obligatorische Elemente fehlen unter Umständen jedoch auch nach dem Speichern und Schließen des Dokuments, da die Vollständigkeit des Dokuments in Arbortext Editor keine Voraussetzung für das Speichern ist. Wenn obligatorische Elemente fehlen, wird eine Liste der Probleme angezeigt.
Bei dieser Prüfung wird von
Arbortext Editor auch nach verschiedenen Problemen mit ID-Verweisen, Querverweisen, leeren Elementen und fehlenden erforderlichen Attributen gesucht. Ebenso wird die Gültigkeit der Grafik-Entities überprüft. Bei
DITA-Dokumenten wird von
Arbortext Editor nach Abschluss der regulären Vollständigkeitsprüfung eine zusätzliche verfeinerte Vollständigkeitsprüfung durchgeführt. Bei dieser verfeinerten Vollständigkeitsprüfung werden verschiedene zusätzliche Bereiche, die speziell in DITA-Dokumenten vorhanden sind, überprüft. Weitere Informationen finden Sie unter
Vollständigkeitsprüfung bei DITA-Dokumenten verwenden.
Vollständigkeitsprüfung durchführen
So suchen Sie nach Vollständigkeitsfehlern im Dokument:
Verwenden Sie den Befehl check_completeness mit der Option -full, um Entities einzuschließen.
Wenn das Dokument vollständig ist, wird die Meldung, dass keine Fehler gefunden wurden, in der Statusleiste angezeigt. Wenn das Feld UNV in der Statusleiste am unteren Rand des Bearbeitungsfensters hervorgehoben ist, ist Ihr Dokument unvollständig, und die Fehler werden im Fenster Vollständigkeitsprüfungsprotokoll angezeigt.
2. Doppelklicken Sie auf den Link neben dem ersten im Fenster Vollständigkeitsprüfungsprotokoll aufgeführten Fehler.
Der Cursor springt an die fehlerhafte Stelle im Dokument.
3. Falls erforderlich, beheben Sie den Fehler.
4. Wiederholen Sie den Vorgang für jeden Fehler in der Liste des Fensters.
Fenster "Vollständigkeitsprüfungsprotokoll"
Im Fenster Vollständigkeitsprüfungsprotokoll werden Meldungen der Vollständigkeitsprüfung angezeigt. Die Meldungen werden den folgenden Kategorien zugeordnet:
• Vollständigkeitsfehler – Bei der Kontextprüfung erkannte Fehler, z.B. Elemente, die nicht in den Kontext passen oder fehlende erforderliche Elemente.
• Markup-Fehler – Fehlerhaftes Markup, z.B. nicht deklarierte Tags oder Attribute, doppelte Attribute, ungültige Attributwerte, fehlende erforderliche Attribute, ungültige PI-Namen oder nicht aufgelöste Datei-Entities, leere Elemente usw.
• Entity-Verweis-Fehler – Verweise auf nicht deklarierte Entities und Notationen.
• ID- und ID-Verweis-Fehler – Gibt die Anzahl von fehlenden ID-Referenzen und mehrfach definierten IDs an.
Die Fehlermeldungen in dieser Kategorie enthalten einen Link für den Aufruf des Dialogfensters
IDs und ID-Verweise.
• Leere Elemente – Elemente, die Text enthalten können, aber leer sind. Die Warnhinweise in dieser Kategorie enthalten einen Link für den Aufruf des Dialogfensters
Leere Elemente. Warnhinweise über leere Elemente können in der
Dokumenttyp-Konfigurationsdatei deaktiviert werden.
• Schemafehler – Identitätsbeschränkungen für XML-Schema-Dokumenttypen.
• Tabellen-Markup-Fehler – Fehlerhaftes Tabellen-Markup, aufgrund dessen Arbortext Editor das Markup nicht als Tabelle erkennt, z.B. Zeilen ohne Zellen-Tags.
• Tabellen-Markup-Warnungen – Fehlerhaftes Tabellen-Markup, das Probleme mit der Tabelle verursachen kann, obwohl Arbortext Editor das Markup als Tabelle erkennt.
• Schematron-Warnungen – Warnmeldungen des Standard-Schematrons des Dokumenttyps.
DITA-Dokumente können weitere Kategorien aufweisen.
Das Fenster Vollständigkeitsprüfungsprotokoll enthält zwei Menüs und ein Kontextmenü.
Das Menü Datei enthält die folgenden Optionen:
• Speichern – Speichert den Inhalt des Nachrichtenfensters in einer .xml-Datei. Wenn dies die erste Speicherung seit dem Öffnen des Fensters ist, werden Sie zur Auswahl eines Namens für die Ausgabedatei aufgefordert.
• Speichern als – Speichert den Inhalt in einer Ausgabe mit einem anderen Namen.
• Speichern als HTML – Speichert den Inhalt in einer .htm-Datei.
• Drucken – Druckt eine veröffentlichte Version des Meldungsfensters. Der Ausdruck enthält die Informationen, die derzeit im Menü Ansicht angezeigt werden.
• Schließen – Schließt das Meldungsfenster.
Das Menü Ansicht enthält die folgenden Optionen:
• Anzeige – Legt den Inhaltstyp fest, der im Meldungsfenster angezeigt wird:
◦ Meldungen – Zeigt alle Informationen an (Meldungen, Warnungen und Fehler).
◦ Warnungen – Zeigt nur Warnungen und Fehler an. Dies ist die Standardeinstellung.
◦ Fehler – Zeigt nur Fehler an.
• Schriftgröße – Es stehen zwei Optionen zum Ändern der Schriftgröße im Meldungsfenster zur Verfügung:
◦ Vergrößern – Vergrößert die Schrift in der Anzeige.
◦ Verkleinern – Verkleinert die Schriftgröße in der Anzeige.
Das Kontextmenü wird angezeigt, wenn Sie im Meldungsfenster mit der rechten Maustaste klicken. Es enthält die folgenden Optionen:
• Kopieren – Kopiert den markierten Bereich in die Zwischenablage. Diese Option ist nur verfügbar, wenn Sie auf einen markierten Bereich klicken.
• Link folgen – Wenn Sie im Meldungsfenster mit der rechten Maustaste auf einen LINK klicken und diese Option auswählen, wird das verknüpfte Dokument angezeigt. Der Cursor befindet sich an der entsprechenden Position des Quelldokuments. Diese Option hat keine Auswirkungen, wenn das Meldungsfenster keine Links enthält.
• Ein-/Ausblenden – Blendet den aktuellen Eintrag ein oder aus.
Mögliche Probleme in Verbindung mit der Vollständigkeitsprüfung
Bei der Vollständigkeitsprüfung können folgende Probleme auftreten:
• Wenn Sie für Ihr Dokument eine
Aliaszuordnung verwenden, handelt es sich bei den Elementnamen im Feld um Aliase.
• Es kann vorkommen, dass ein Parser-Fehler angezeigt wird, wenn
Equation Editor für eine offenbar korrekte Gleichung verwendet wird. Dies liegt daran, dass bei der Einbindung des Fragments des Dokumenttyps "math" in einen anderen Dokumenttyp der Ziel-Dokumenttyp ein Inhaltsmodell aufwies, in dem leerer Inhalt zulässig ist. Weitere Informationen finden Sie unter
Equation Editor in eine DTD integrieren.
• Wenn Ihr Dokument Datei-Entities enthält, die nicht in Arbortext Editor erstellt bzw. in einem anderen Programm bearbeitet wurden, werden die Entities beim Speichern nicht normalisiert. Bei der Normalisierung werden fehlende Tags hinzugefügt, sodass Tag-Paare vollständig sind. Wenn keine Normalisierung der Datei-Entities durchgeführt wird, können Kontext- bzw. Vollständigkeitsfehler bei der Bearbeitung von Datei-Entities in Ihrem Dokument auftreten. Um sicherzustellen, dass ein Dokument normalisiert wurde und vollständig ist, wählen Sie die Lesen als-Option SGML importieren beim Öffnen des Dokuments im Dialogfenster Öffnen.