HTML-Dateien

Doc-O-Matic unterstützt sowohl HTML-Dateien als auch Word-Dokumente, die als Webseiten gespeichert sind, als externe Quelle für Sourcecodekommentare. Doc-O-Matic stellt mehrere Möglichkeiten zur Verfügung, wie Information in HTML-Dateien verwendet werden kann. Um Informationen, die in HTML-Dateien gespeichert ist, zu verwenden:

Fügen Sie die HTML-Dateien zu Ihrem Projekt hinzu. Der Text wird in mehrere Themen aufgeteilt. Diese werden in der Themen-Vorschau angezeigt.
Extrahieren Sie die Hierarchieinformation, die in Form einer HTML-Liste gespeichert ist mit der Funktionalität Hierarchieinformation entnehmen.
Oder wandeln Sie HTML-Dateien in DTX-Dateien um. DTX-Dateien werden automatisch zu Ihrem Projekt hinzugefügt. Der Text in HTML-Dateien kann im Editor bearbeitet werden.
Inkludieren Sie HTML-Dateien in Ihrer HTML-Ausgabe. HTML-Dateien werden als externe Quelle für ein bestimmtes Thema verwendet und in der Ausgabe wiedergegeben. Alle Formatierungen wie Styles, Rahmen und alle Bilder werden in der Ausgabe wie in der HTML-Datei definiert wiedergegeben.

HTML-Dateien mit diesen Dateierweiterungen könne zu Ihrem Projekt hinzugefügt werden:

.html
.htm

Diese Tags werden von Doc-O-Matic unterstützt

Doc-O-Matic unterstützt nur einfache Formatierungen in HTML-Dateien; Sie können die Tags <b>, <i>, <em>, <strong>, <div>, <pre>, <br>, <li>, <ul>, <ol> und <p> verwenden. Text, der von den Tags <pre> und </pre> umschlossen ist, wird als Sourcecode interpretiert und mit einer Festbreitenschrift gerendert.
Von dem Tag <img scr = "...../.../Filename.extension> (zum Beispiel <img scr = "http://www.html/images/logo.gif>) wird nur der Dateiname (logo) extrahiert und von Doc-O-Matic verwendet. Stellen Sie sicher, dass die Pfade der Grafikdateien, die Sie in Ihrem Projekt verwenden zum image path hinzugefügt sind.
Die Tags <table>, <tr>, <td> werden von Doc-O-Matic unterstützt. Diese können aber nicht verschachtelt werden.
Der Tag <title> wird als Titel des Themas verwendet, das Doc-O-Matic aus dem Dateinamen erzeugt.
Die Tags <h1-h6> werden als Themen-IDs und Titel für Teile der HTML-Datei verwendet.
Alle anderen Tags werden nicht unterstützt.

Tags

Da < und > als Beginn- und Endzeichen sowohl in HTML als auch in Doc-O-Matic verwendet werden, besteht eine mögliche Verwechslungsgefahr. Wenn Sie DTX-Tags in eine HTML-Datei einfügen möchten, müssen Sie jedes Beginn- und Endzeichen zweimal im Referenzstil verwenden:

<<FLAG new in version 2>>

dies wird in einem WYSIWYG HTML-Editor so wiedergegeben:

<<FLAG new in version 2>>

Um HTML-Dateien zu Ihrem Projekt hinzuzufügen

Klicken Sie auf der Registerkarte Project in der Gruppe Add auf Add Files .
Blättern Sie zur Datei, die Sie hinzufügen möchten.
Klicken Sie auf Open.
Sie haben folgende Möglichkeiten:
- Klicken Sie No, wenn Sie die Dateien nicht in Doc-O-Matic bearbeiten. Der Inhalt der Datei wird im Topic Preview angezeigt. Sie können den Inhalt in allen Ausgabeformaten ausgeben, aber Sie können Ihn nicht im Editor bearbeiten.
- Sie Yes, wenn Sie die Dateien im Editor bearbeiten möchte. Wenn Sie die Dateien umwandeln werden lediglich die umgewandelten DTX Dateien zu Ihrem Projekt hinzugefügt. Sie können den Text im Editor bearbeiten. Die Textdatei selbst wird nicht verändert.

Um andere Dateierweiterungen mit HTML-Dateien zu assoziieren

Klicken Sie auf Symbolleiste für den Schnellzugriff Settings .
Klicken Sie auf die Registerkarte General Settings.
Wählen Sie dort die Seite [General Settings] > General > File Types aus.
Wählen Sie in der Dateien-Liste, HTML-Datei aus.
Klicken Sie auf Change.
Geben Sie in Extensions die Dateierweiterung, die Sie hinzufügen möchten ein.
Beachten Sie bitte: Sie können auch Word-Dateien, die als HTML-Datei gespeichert sind, so zu Ihrem Projekt hinzufügen.

Um HTML-Dateien als externe Quelle zu benutzen

Sie können HTML-Dateien auch als externe Quelle für ein bestimmtes Thema in Ihrer HTML-Ausgabe verwenden. Auf diese Art und Weise können Sie eine oder mehrere komplett formatierte HTML-Seiten in Ihrem Thema ausgeben. Sie können zum Beispiel Word-Dokumente oder Visio Diagramme als HTML-Dateien gespeichert in Ihre Dokumentation integrieren.
Wählen Sie in der Hierarchie das Thema aus in dem Sie die HTML-Datei wiedergeben möchten.
Geben Sie in External Topics/HTML Files in den Topic Properties den Namen der HTML-Datei ohne Pfad ein.
Sie werden gefragt, ob Sie wollen, dass Doc-O-Matic den Pfad zu Ihren Include-Pfaden für Themen hinzufügt.
Klicken Sie Yes, wenn Sie fortfahren möchten. Der Include-Pfade für Themen wird im Projekt-Manager angezeigt.

Um eine externe Datei im Contents Manager zu öffnen

Wählen Sie das Thema in der Hierarchie aus und klicken Sie mit der rechten Maustaste.
Wählen Sie Open External Topic aus.

Für fortgeschrittene Benutzer

Zusätzlich können Sie Dateien hinzufügen, indem Sie die Befehle Import Folder oder Add Folder auf der Registerkarte Project oder der Registerkarte Manage des Projekt-Managers verwenden. Wenn Sie Dokumentationsdateien importieren, extrahiert Doc-O-Matic alle relevanten Dateien aus dem Verzeichnis und fügt sie zum Projekt hinzu. Wenn Sie ein Verzeichnis hinzufügen, versucht Doc-O-Matic jedesmal beim Parsen relevante Dateien im Verzeichnis zu finden. Mit diesem Feature können Sie sicherstellen, dass alle Dateien die aktuell in einem Verzeichnis sind für Ihr Projekt berücksichtigt werden.

Verwandte Einstellungen

HTML-Dateien