# SDM2HTM - An SDML to HTML Converter

## 5 - Usage

[next] [previous] [contents] [full-page]

The SDM2HTM utility accepts a single parameter, the source SDML file (a file type of `.SDML` is assumed if not supplied. Qualifiers control other behaviour. Default values are usually acceptable. Example usage:

      $ sdm2htm /framed /index sdm2htm.sdml
      %SDM2HTM-I-FILE, HT_ROOT:[DOC.SDM2HTM]SDM2HTM.SDML
      %SDM2HTM-I-PASS, 1
      [Processing HT_ROOT:[DOC.SDM2HTM]SDM2HTM.SDML]
      %SDM2HTM-I-PASS, 2
      [Created HT_ROOT:[DOC.SDM2HTM]SDM2HTM_0000.HTML]
      [Processing HT_ROOT:[DOC.SDM2HTM]SDM2HTM.SDML]
      [Created HT_ROOT:[DOC.SDM2HTM]SDM2HTM_0001.HTML]
      [Created HT_ROOT:[DOC.SDM2HTM]SDM2HTM_0002.HTML]
      [Created HT_ROOT:[DOC.SDM2HTM]SDM2HTM_0100.HTML]
      [Created HT_ROOT:[DOC.SDM2HTM]SDM2HTM_0200.HTML]
      [Created HT_ROOT:[DOC.SDM2HTM]SDM2HTM_0300.HTML]
      [Created HT_ROOT:[DOC.SDM2HTM]SDM2HTM_0301.HTML]
      [Created HT_ROOT:[DOC.SDM2HTM]SDM2HTM_0302.HTML]
      [Created HT_ROOT:[DOC.SDM2HTM]SDM2HTM_0400.HTML]
      [Created HT_ROOT:[DOC.SDM2HTM]SDM2HTM_0401.HTML]
      [Created HT_ROOT:[DOC.SDM2HTM]SDM2HTM_0500.HTML]
      [Created HT_ROOT:[DOC.SDM2HTM]SDM2HTM_0600.HTML]
      [Created HT_ROOT:[DOC.SDM2HTM]INDEX.HTML]
      $

###
Parameters and Qualifiers

/BODY [=string]
HTML <BODY> tag attributes can be specified. Default is no attributes. For example, /BODY="BGCOLOR=""#ff0000""".

/COMMENTS
/NOCOMMENTS (default)
SDML <COMMENT>s are included in the HTML source (between <!-- and -->).

/DIRECTORY
Directory into which to place the generated HTML files.

/FLAG_UNKNOWN_TAGS
/NOFLAG_UNKNOWN_TAGS (default)
SDML tags unknown to SDM2HTM are displayed as they are encountered.

/FRAMED
/NOFRAMED (default)
The generated document uses frames technology, dividing the page into a table-of-contents on the left and a document page on the right.

/HTML (default)
/NOHTML
HTML files are produced as output. The `/NOHTML` allows a pass of the source without generating any new files.

/INDEX [=name] (default)
By default the base document is "name_0000.HTML". If the /INDEX qualifier is used an additional file "INDEX.HTML", a copy of the base document, is generated providing a home page for the directory. An alternative name to the the default "INDEX.HTML" may be supplied if desired.

/SOURCE
When a buffer overflow occurs provides additional information useful for the developer to analyse any problem.

/UNKNOWN_TAGS
/NOUNKNOWN_TAGS (default)
SDML tags unknown to SDM2HTM are included as comments in the HTML output files.

/VERBOSE (default)
/NOVERBOSE
Display progress messages.

[next] [previous] [contents] [full-page]