Vollständigkeitsprüfung bei DITA-Dokumenten verwenden
Arbortext Editor erweitert die reguläre Vollständigkeitsprüfung um die Vollständigkeitsprüfung für DITA-Dokumente. Wenn Sie beim Erstellen eines DITA-Dokuments die Befehlsfolge > wählen oder auf die Symbolleisten-Schaltfläche Vollständigkeit prüfen klicken, wird zuerst eine reguläre Vollständigkeitsprüfung für das Dokument durchgeführt. Nach der regulären Vollständigkeitsprüfung führt Arbortext Editor eine verfeinerte Vollständigkeitsprüfung auf DITA-spezifische Probleme durch. Probleme werden dann im Vollständigkeitsprüfungsprotokoll aufgeführt. Wenn die verfeinerte Vollständigkeitsprüfung länger als einige Sekunden dauert, wird eine Statusanzeige angezeigt.
Bei der regulären Vollständigkeitsprüfung werden Aspekte untersucht, die mithilfe des dem Dokument zugeordneten Dokumenttyps validiert werden können. Bei der verfeinerten Vollständigkeitsprüfung werden Aspekte untersucht, die im DITA-Standard beschrieben sind, jedoch nicht anhand des DTD- oder XML-Schemas validiert werden können. Die verfeinerte Vollständigkeitsprüfung sucht z.B. nach fehlenden Dateien, falschen oder ungewöhnlichen URL-Formaten, ungewöhnlichen format- und type-Attributwerten, nach der Verwendung verworfener Elemente oder Attribute usw.
Sie können eine verfeinerte Vollständigkeitsprüfung an einem DITA-Topic oder an einer DITA Map ausführen. Bei einem DITA-Topic wird die verfeinerte Vollständigkeitsprüfung nur für das Topic durchgeführt. Bei einer DITA Map wird die verfeinerte Vollständigkeitsprüfung nicht nur für die Map, sondern auch für alle anderen DITA-Maps oder -Topics durchgeführt, auf die von der Map verwiesen wird, je nach der Einstellung der erweiterten Einstellung ditacheckreferences. Die verfeinerte Vollständigkeitsprüfung gilt auch für DITA-Inhalte, auf die DITA-Maps verweisen, auf die die ursprüngliche Map verweist. Sie können auch einen Teil einer DITA Map auswählen und die verfeinerte Vollständigkeitsprüfung nur für diesen Map-Teil ausführen. In diesem Fall wird die reguläre Vollständigkeitsprüfung für die gesamte Map durchgeführt, die verfeinerte Vollständigkeitsprüfung jedoch nur für den ausgewählten Map-Teil.
Wenn die verfeinerte Vollständigkeitsprüfung beginnt, wird die Meldung Verfeinerte Vollständigkeitsprüfung gestartet… im Meldungsbereich unten im Arbortext Editor Fenster angezeigt. Mit dem Fortschritt der Prüfung zeigt diese Meldung den Status der verfeinerten Vollständigkeitsprüfung an. Wenn die Prüfung abgeschlossen ist, wird entweder die Meldung Verfeinerte Vollständigkeitsprüfung abgeschlossen: Keine Fehler/Warnungen oder die Meldung Verfeinerte Vollständigkeitsprüfung abgeschlossen: Siehe Nachrichtenfenster für weitere Details angezeigt. In letzterem Fall werden im Fenster Vollständigkeitsprüfungsprotokoll alle DITA-bezogenen Warnungen oder Fehler aufgelistet, die im Dokument erkannt wurden. Auf jeden Fehler und jede Warnung folgt ein Link auf die zugehörige Meldung. Wenn Sie auf den Link doppelklicken, wird der Cursor im zugeordneten Dokument an der Stelle platziert, an der der Fehler oder die Warnung gefunden wurde. Wenn der Fehler oder die Warnung sich auf ein Dokument bezieht, auf das eine DITA Map verweist, wird dieses Dokument in einem neuen Arbortext Editor Fenster geöffnet.
Bei der verfeinerten Vollständigkeitsprüfung werden die folgenden Kategorien von DITA-bezogenen Problemen überprüft:
• DITA-Markup-Probleme – Hierzu zählen u.a. Probleme wie die Verwendung von veraltetem Markup, nicht vom Dokumenttyp geprüfte ungültige Attributwerte und Verwendung von Tags, die der Spezialisierung dienen.
• DITA-Referenz-Probleme – Hierzu zählen Probleme wie ungültige Werte für das Attribut href, ungewöhnliche oder falsche Werte für die Attribute format und type usw.
Die Werte, anhand deren das Attribut format überprüft wird, werden durch die erweiterte Einstellung ditaexpectedformats bestimmt.
• DITA-Schlüssel- und -Schlüsselreferenzprobleme – Hierzu zählen Probleme, die sich auf Schlüssel und Schlüsselreferenzen beziehen, z.B. nicht definierte Schlüsselreferenzen, ungültige Schlüsseldefinitionsnamen und Probleme bei der Auflösung von conkeyref-Referenzen.
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.
Die verfeinerte Vollständigkeitsprüfung unterliegt folgenden Einschränkungen:
• Bei einer DITA Map wird die reguläre Vollständigkeitsprüfung nur für die Map ausgeführt, jedoch nicht für DITA-Topics oder -Maps, auf die von der ursprünglichen Map verwiesen wird.
• DITA-Topics, auf die andere Topics verweisen, werden von der verfeinerten Vollständigkeitsprüfung nicht erfasst.
• Bei DITA-Maps mit zahlreichen Topic-Referenzen dauert die verfeinerte Vollständigkeitsprüfung unter Umständen länger als die reguläre Vollständigkeitsprüfung.