ht-ml.flt < file > file.html
The \fiht-ml.flt is a filter that may be used to produce documents with a tag set extending basic HTML. Actually, due to its history, it combines features of HTML, Latex and troff (as well). The ht-ml.flt is used in the documentation of hush and the DejaVu framework, together with man-t(8), cc-t(8) and html-latex(8).
<document> ... </document>default
<document style=NAME opt=OPTIONS> ... </document>latex
<document class=NAME opt=OPTIONS> ... </document>latex2e
<include file=FILES>
<include ext=EXT file=FILES>
<include dir=DIRS>
<include dir=DIR file=FILE>
In the latter two cases, the filter recurses in the directories
and includes by default the file (with dot-tee) with
the name of the directory.
This default is overridden by explicitly naming the file,
as in the last schematic example.
The abbreviated form of the commands above is:
<so FILES>
<cd DIRS>
The conventions can then not be overridden, however.
<ignore> ... </ignore>This allows you to skip portions of the text.
<navigate up=STRING root=STRING fwd=STRING bwd=STRING>
<select mode=MODE options=OPTIONS>
The navigate tag allows you to give the local reference structure.
The select tag relies on utilities defined in sources/util/html
and gives a listing of the current directory.
As modes you are advided to use ls or echo.
In the later case, you must provide the to be echod files or directories in
the options.
For example
<select mode=ls options="-bar -loc">
<select mode=echo options="*.c *.h">
<select mode=dirs options="-bar">
give respectively, a listing of the current directory, omitting specific
file types that were considered (by me) to be not relevant,
a listing of the dot-cee and dot-ache files and a
listing of the directories located under the current one.
The "-bar" and "-loc" option mean that, if set, a bar containing
a menu of the contents in the directory and the (relative) location
of the directory is displayed.
BTW, these features have not been tested outside the scope
of documenting hush itself
<ref file=URL>LABEL</ref>These tags and shorthand have been introduced to facilitate the use of labels and references, in a latex style. The LABELS may consist of one KEY, see below, or an arbitrary number of KEYS, of which only the first one must be preceded by an underscore.reference to label
<cite file=URL>LABELS</cite>bibliographic reference
[_LABELS]idem -- shorthand
<bibliography>
\ %K KEY ordinary reference
\ %A AUTHORS
\ %T TITLE
\ %O PUBLISHER
\ %K KEY book reference
\ %A AUTHORS
\ %B TITLE
\ %O PUBLISHER
</bibliography>
Those that have grown up in a troff environment will recognize
the format, which we refer to as the KATO format.
It is most simple and convenient for cut and paste
insertion.
There are more advanced schemes of doing this:
mailto:jrvosse@cs.vu.nl or mailto:frankn@cs.vu.nl.
An additional feature of the ht-ml filter is it support for slides, which are declared as
<slide id=support-dot-tee captions="Supporting the <i>dot-tee</i> format"> <h4>The <i>dot-tee</i> format</h4> Historically, the <i>dot-tee</i> format has grown out of merging the troff formatting macros with \LaTeX. Later on, HTML was added and ... </slide>In combination with a stylesheet support package that originated from the netscape developers (see help(1)) this allows for having a presentational facility in your documents. Just click on the caption to see what it looks like.
|
Hush Online Technology
hush@cs.vu.nl
09/24/99 |
|
|