Handbuch UDO: HTML (Hypertext Markup Language)

HTML (Hypertext Markup Language)

HTML ist eines der meistgenutzten Zielformate, die mit UDO erzeugt werden. Es ist zudem eines der meistgenutzten Formate für Online-Dokumentationen. Logischerweise gibt es zum HTML-Ausgabeformat auch die meisten Fragen. Hier sind die häufigsten als FAQ zusammengefasst.

Wie können Sie die Aufteilung in mehrere Dateien unterbinden?

Im Gegensatz zu den anderen Formaten erzeugt UDO standardmäßig mehrere Dateien, die miteinander verknüpft sind. Für jedes Kapitel, jeden Abschnitt und Unterabschnitt wird eine eigene Datei mit dem Suffix .htm[l] angelegt. Die Namen der einzelnen Dateien richten sich nach der Nummer und der Position des jeweiligen Kapitel. Inhaltsverzeichnis und Titelseite gelangen in die Datei, die Sie UDO per Kommandozeile als --outfile übergeben.

Mit den Schaltern !html_merge_nodes, !html_merge_subnodes, !html_merge_subsubnodes oder !html_merge_subsubsubnodes können Sie die Aufteilung in mehrere Dateien unterbinden.

Wird im Vorspann !html_merge_nodes benutzt, wird das gesamte Dokument in einer Datei gesichert. Dies empfiehlt sich nur bei kleinen Dokumenten, die kleiner als 16 KB sind.

!html_merge_subnodes sorgt dafür, dass alle Abschnitte eines Kapitels in der Datei angegeben werden, in dem sich auch das Kapitel selbst befindet.

Der Schalter !html_merge_subsubnodes sorgt dafür, dass alle Unterabschnitte in der gleichen Datei wie der übergeordnete Abschnitt untergebracht werden.

Der Schalter !html_merge_subsubsubnodes schließlich sorgt dafür, dass alle Paragraphen in der gleichen Datei wie der übergeordnete Unterabschnitt untergebracht werden.

Mir gefallen die Dateinamen bei der HTML-Ausgabe nicht!

Durch den Befehl !html_name können Sie einem Kapitel einen bestimmten Namen zuweisen, den UDO für die jeweilige Datei anstelle der etwas kryptischen Namen wie etwa 0a1009.htm benutzt.

Wie bekomme ich diese scheußlichen Kopfzeilen weg?

UDO erzeugt standardmäßig auf jeder HTML-Seite eine Kopfzeile, anhand derer Sie das Thema (gebildet aus den Daten von !docinfo [title] und !docinfo [program]) des Hypertextes erkennen können. Desweiteren werden Links zu der vorgehenden, nachfolgenden und/oder übergeordneten Seite angelegt. Dazu werden GIFs benutzt, die UDO automatisch erzeugt. Die Dateinamen dieser GIFs lauten udo_lf.gif, udo_rg.gif und udo_up.gif.

Durch den Schalter !no_headlines [html] kann die Ausgabe der Kopfzeilen und der Grafiken unterbunden werden.

Wie kann ich bequem eigene Kopf- und Fußzeilen erzeugen?

Um eigene Kopfzeilen und Fußzeilen zu erzeugen, können Sie Makros benutzen, die Sie jeweils am Anfang und Ende eines Kapitels angeben. Der Inhalt dieser Kapitel erscheint dabei jedoch unterhalb der Überschrift. Auf folgende Art und Weise wurden beispielsweise Kopf- und Fußzeilen meiner Website angelegt, in der es Kapitel namens Software, Kontaktadressen und Links gibt:

Hauptdatei:

!ifdest [html]
!define HR 
!macro  HEAD [ Software | Kontaktadressen | Links ] (!HR)
!macro  FOOT (!I)Letzte Änderung (!short_today)(!i)
!else
!define HR
!macro  HEAD
!macro  FOOT
!endif

software.ui:

!node Software
!html_name software
(!HEAD)
[...]
(!FOOT)

Wird nun nach HTML umgewandelt, werden die jeweiligen Kopf- und Fußzeilen ausgegeben. Durch die Referenzierung von UDO werden automatisch Links auf die anderen Kapitel angelegt.

Wandeln Sie nicht nach HTML um, werden leere Definitionen und Makros erzeugt, wodurch keine Kopf- und Fußzeilen ausgegeben werden.

Eine andere Möglichkeit, Kopf- bzw. Fußzeilen zu erzeugen, ist die Verwendung von !use_raw_header bzw. !use_raw_footer.

Mal wird eine Tabelle umrahmt dargestellt, mal nicht!?

Bei HTML können Sie leider nur angeben, ob die gesamte Tabelle umrahmt werden soll oder ob sie gar nicht mit einem Rahmen dargestellt werden soll.

Um eine Tabelle mit Rahmen darzustellen, müssen Sie bei !begin_table den Befehle !hline angeben. Fehlt !hline bei diesem Befehl, wird die Tabelle ohne Rahmen dargestellt.

Wie legt UDO die Suffixe der Dateien fest?

UDO benutzt als Suffix für die HTML-Dateien immer das Suffix des in der Kommandozeile mit der Option --outfile bzw. -o übergebenen Dateinamens:

`-o index.htm`	*`.htm`*
`-o index.html`	*`.html`*
`-o INDEX.HTML`	*`.HTML`*

Wenn Sie stattdessen die Option -o ! verwenden, benutzt UDO für 8+3-Dateisysteme immer das Suffix .htm, bei Dateisystemen, die lange Namen erlauben, hingegen immer das Suffix .html.

Die Dateinamen bei den Querverweisen stimmen nicht!?

Falls Sie HTML-Dateien auf einem Betriebssystem erstellen, das keine langen Namen zulässt, Sie als Suffix .html vorgegeben haben und Sie diese Dateien dann auf einem Web-Server ablegen, so müssen Sie folgendes beachten:

UDO versucht zwar, foo.html zu sichern, TOS und DOS sichern die Datei jedoch nur als foo.htm.
UDO benutzt für alle Querverweise das Suffix .html. Wenn nun ein HTML-Browser unter TOS und DOS versucht, foo.html zu öffnen, öffnet dieser anstandslos foo.htm.
Nach dem Kopieren der Dateien auf den Web-Server müssen die Suffix der Dateien von .htm auf .html angepasst werden. Hier wird foo.htm nicht geöffnet, wenn auf foo.html zugegriffen werden soll!

Wie kann ich Hintergrundmusik einbinden?

Hierfür steht das Kommando !html_bgsound zur Verfügung.