HomeOutput FormatsHP-Helptag-SGMLHTML markup with CSS
User Manual UDO > Output Formats Index

HTML (Hypertext Markup Language)

HTML is one of the most used target formats being created by UDO. It is also one of the most used formats for online documentations. Therefore, HTML output format generates the most questions, too. Here is the FAQ collection:

How can I tell UDO not make files for each chapter?

In contrast to the other formats UDO saves a separate HTML file for each chapter by default. UDO names these files by using the chapter numbers. The title page and the table of contents will be saved in the file you passed in the command line.

Using the switches !html_merge_nodes, !html_merge_subnodes, !html_merge_subsubnodes or !html_merge_subsubsubnodes you can tell UDO not to save a file for each chapter.

If you use !html_merge_nodes inside the preamble UDO will save only one HTML file that contains the whole text. You should use this option only for small source files.

If you use !html_merge_subnodes UDO will save separate files only for chapters. All sections, subsections and paragraphs of a chapter will be saved inside this file, too.

If you use !html_merge_subsubnodes UDO will save separate files for chapters and sections. The subsections and paragraphs of a section will be saved in the file that contains the text of the upper section.

Finally if you use !html_merge_subsubsubnodes the paragraphs of a subsection will be saved in the file that contains the text of the subsection. UDO will save separate files for chapters, sections and subsections.

I don't like the names of the HTML files!

Using the command !html_name inside a chapter, section, subsection or paragraph you can tell UDO which filename it shall use instead of using a filename like "01020304.html".

How can I suppress these ugly headlines?

UDO will print on every HTML page a headline that contains the title of the documentation and hypertext links to the previous, next and upper page. UDO uses GIFs for these links that are saved by UDO automatically. The filenames of these GIFs are udo_lf.gif, udo_rg.gif and udo_up.gif.

Using the switch !no_headlines [html] inside the preamble you can tell UDO not to generate these headlines.

How can I easily make my own headlines or bottomlines?

If you want to make your own headlines or bottomlines you can use macros at the beginning of each chapter. The following example shows how I added bottomlines to my WWW pages. These pages contain links to the chapters that contain my address, the descriptions of my software and links to other web sites.

Main file:

!ifdest [html]
!define HR 
!macro HEAD [ Software | Contact address | Links ] (!HR) !macro FOOT (!I)Last updated (!short_today)(!i) !else !define HR !macro HEAD !macro FOOT !endif

!node Software
!html_name software

If you convert the source file to HTML, UDO expands the macros that contain the text of the headlines and bottomlines. Because UDO insert links automatically you can jump to the other pages by clicking the entries of the bottomline.

If you don't convert to HTML empty macros are used so that nothing will appear when using !HEAD or !FOOT.

Sometimes a table has a frame, sometimes it hasn't!?

Unfortunately HTML only allows to use tables with or without frames. You cannot use table lines where you want to.

To print a table with a frame you have to add !hline to the line that contains !begin_table. If you don't want a frame don't use !hline. That's all.

Which suffixes does UDO use for HTML files?

By default UDO uses the suffix of the --outfile you used in the command line:

-o index.htm .htm
-o index.html .html

If you use the option (!code [-o !]) UDO uses .htm on operating systems with 8+3-filenames and .html on operating systems with long filenames.

The filenames of the URL's are wrong!?

If you use UDO on an operating system that doesn't support long filenames but you have used (!code [--outfile index.html]) and you copy the saved .htm files to a web server, remember this:

  1. UDO will try to save index.html but TOS and DOS will name it index.htm.
  2. UDO will use for all hypertext links the suffix .html because of the suffix of the outfile. If you use a HTML browser for TOS or DOS this browser will open index.html without any problems even if there's only a file named index.htm.
  3. When copying the files to a web server you have to change the suffixes from .htm to .html. If you will forget this all links will be wrong.
How can I include background music?

Use the command !html_bgsound.

Copyright © www.udo-open-source.org (Contact)
Last updated on May 19, 2014

HomeOutput FormatsHP-Helptag-SGMLHTML markup with CSS