.TH "Yodl macros" "7" "1996\-2021" "yodl_4\&.03\&.02" "Your Own Document Language"

.PP 
.SH "NAME"
yodlmacros \- Macros for the Yodl converters
.PP 
.SH "SYNOPSIS"
This manual page lists the standard macros of the Yodl package\&.
.PP 
.SH "DESCRIPTION"
The following list shows the macros defined by the Yodl converters
define and which can be used in Yodl documents\&. Refer to the Yodl user
guide, distributed with the Yodl package, for a full description\&.
.PP 
The following list shows all macros of the package in alphabetical
order\&.
.PP 
.IP "`abstract(text)\(cq\&"
Defines an abstract for an article or report type of document\&. Abstracts are
not implemented for books or manpages\&. Must appear \fBbefore\fP starting the
document using the `article\(cq\& or `report\(cq\& macro\&.
.IP 
.IP "`addntosymbol(symbol)(n)(text)\(cq\&"
Adds `text\(cq\& `n\(cq\& times to `symbol\(cq\&\&. The value `n\(cq\& may also be the name
of a defined counter (which is not modified)\&.
.IP 
.IP "`affiliation(site)\(cq\&"
Defines an affiliation, to appear in the document titlepage below the author
field\&. Must appear \fBbefore\fP starting the document with `article\(cq\&,
`report\(cq\& or `book\(cq\&\&. The affiliation is only printed when the author field
is not empty\&. When converting to html the way the affiliation is displayed can
be tuned using CSS id selector specifications\&. The affiliation has
`id=\(dq\&affiliation\(dq\&\(cq\&\&. 
.IP 
.IP "`AfourEnlarged()\(cq\&"
Enlarges the usable height of A4 paper by 2 cm\&.: the top margin is reduced by
2 cm\&. This macro should be called in the preamble\&. The macro is available only
for LaTeX conversions\&.
.IP 
.IP "`appendix()\(cq\&"
Starts appendices
.IP 
.IP "`article(title)(author)(date)\(cq\&"
Starts an article\&. The top\-level sectioning command is `(n)sect\(cq\&\&. In HTML
conversions only one output file is written, while the way the headings are
displayed can be tuned using CSS id selector specifications: the title has
`id=\(dq\&title\(dq\&\(cq\&, the author `id=\(dq\&author\(dq\&\(cq\&, and the date `id=\(dq\&date\(dq\&\(cq\&\&.)
.IP 
.IP "`attrib(text)\(cq\&"
In html, pushes `text\(cq\& as an attribute for the next html tag supporting
`attrib\(cq\&\&.  E\&.g, to set a blue color and 30 pixel left\-hand side margin for a
section use
.nf 

    attrib(style=\(dq\&color:blue;margin\-left:30px;\(dq\&)\e 
    sect(Section name)
    
.fi 
This results in the html markup
.br 
.nf 

    <h1 style=\(dq\&color:blue;margin\-left:30px;\(dq\&>Section name</h1>
    
.fi 
This macro is only effective with html conversions\&. It is applied in a
stack\-wise fashion: when multiple `attrib\(cq\& calls are used, then the topmost
attrib\-string is added to the first macro calling the 
`attribinsert\(cq\& macro, with subsequent macros using subsequent elements on
the attrib\-stack\&. 
.IP 
Commonly used attributes are `id=\(dq\&idname\(dq\&\(cq\&, expecting a `#idname\(cq\& CSS
label in either internal or external CSS specifications, or `style=\(dq\&spec\(dq\&\(cq\&
(as shown in the example)\&. 
.IP 
Example: when using
.nf 

    attrib(width = \(dq\&100\(dq\& height = \(dq\&100\(dq\&)
    attrib(id = \(dq\&#fig\(dq\&)
    figure(imgfile)(Caption)(IMG)
    
.fi 
then the `#id\(cq\& attribute is applied to `<figure>\(cq\&, and the `width\(cq\&
and `height\(cq\& attributes are applied to `<img>\(cq\&, which html markup is
inserted by the `figure\(cq\& macro\&.
.IP 
The `attrib\(cq\& macro is supported by the following predefined macros (between
parentheses the number of attribute strings that are inserted by these macros;
if only 1 attribute string is inserted no number is shown): 
.IP 
`bf cell cells center chapter code dashes dit em figure(3) file htmltag
itdesc lchapter link lref lsect lsubsect lsubsubsect nchapter npart nsect
nsubsect nsubsubsect paragraph part quote row sc sect strong subs subsect
subsubsect subsubsubsect sups tableatt tbl tac tc tnac tnc tr tt ttbegin url
verb verborg verbinclude\(cq\&\&.
.IP 
.IP "`attribclear()\(cq\&"
Removes any existing contents from the attrib\-stack\&. This macro is only
active when converting to html
.IP 
.IP "`attribinsert()\(cq\&"
In html, if the attrib\-stack is not empty, 
inserts the value on top of the attrib\-stack and then pops the topmost value\&.
If the attrib\-stack is empty, nothing happens\&.
.IP 
.IP "`bf(text)\(cq\&"
Sets `text\(cq\& in boldface\&.
.IP 
.IP "`bind(text)\(cq\&"
Generate a binding character (non\-breaking space) after text\&.
.IP 
.IP "`book(title)(author)(date)\(cq\&"
Starts a book document\&. The top\-level sectioning command is `(n)chapter\(cq\&,
`(n)part\(cq\& being optional\&. In HTML output files are created for each
chapter, while the way the headings are displayed can be tuned using
CSS id selector specifications: the title has `id=\(dq\&title\(dq\&\(cq\&, the author
`id=\(dq\&author\(dq\&\(cq\&, and the date `id=\(dq\&date\(dq\&\(cq\&\&.)
.IP 
.IP "`cell(contents)\(cq\&"
Sets a table cell, i\&.e\&., one element in a row\&. With the man/ms converters
multiple blanks between `cell()\(cq\& macro calls are merged into a single blank
character\&.
.IP 
Instead of using `cell\(cq\& in `table\(cq\&, consider using `tc\(cq\& in `tbl\(cq\&\&.
.IP 
.IP "`cells(nColumns)(contents)\(cq\&"
Set a table cell over `nColumns\(cq\& columns\&. With LaTeX and xml the
information in the combined cells is centered\&. 
.IP 
With man/ms conversions the `cells()\(cq\& macro simply calls the `cell()\(cq\&
macro, but here the `setmanalign()\(cq\& macro can be used to determine the
alignment of multiple cells\&.
.IP 
With html the macro `attrib\(cq\& can be used, but when it contains a `style\(cq\&
specification the macro\(cq\&s default `style=\(dq\&text\-align: center\(dq\&\(cq\& is ignored
(but it can optionally be specified using the `attrib\(cq\& macro)\&.
.IP 
Instead of using `cells\(cq\& in `table\(cq\&, consider using `tnc\(cq\& in `tbl\(cq\&\&.
.IP 
.IP "`cellsline(from)(count)\(cq\&"
Sets a horizontal line starting at column number `from\(cq\& over `count\(cq\&
columns in a row\&. If `from\(cq\& is less then the number of columns already added
to a row then it is ignored\&. This macro must be embedded in a `row\(cq\& macro
defining a table row\&.  To put a line across the table\(cq\&s full width use
`rowline\(cq\&\&. To set horizontal lines across columns 1
until 2 and columns 4 until 5 table of a table use:
.nf 

    row(cellsline(1)(2)cellsline(4)(2))
        
.fi 
Combining `cellsline\(cq\& and `cell\(cq\& or `cells\(cq\& calls in one row produces
undefined results\&.
.IP 
Instead of using `cellsline\(cq\& in `table\(cq\&, consider using `tline\(cq\& in
`tbl\(cq\&\&.
.IP 
.IP "`center(text)\(cq\&"
Centers `text\(cq\&\&. Use `nl()\(cq\& in the text to break lines\&.  In html the
`attrib\(cq\& macro is not supported, but a division (`div\(cq\&) with style
definition `text\-align: center\(cq\& is used\&. To center a table in html use
the `tableatt\(cq\& macro\&. If a `table\(cq\& or `tableatt\(cq\& macro is used inside a
`center\(cq\& macro then the contents of columns are column\-wise centered\&.
.IP 
Inside a `center(\&.\&.\&.)\(cq\& context the counter `XXcenter\(cq\& is unequal 0\&.
.IP 
.IP "`chapter(title)\(cq\&"
Starts a new chapter in books or reports\&.
.IP 
.IP "`cindex()\(cq\&"
Generate an index entry for LaTex() or texinfo 
c\-indices\&. Its argument is the
index entry\&.  See also the `[fptv]index\(cq\& macro\&.
.IP 
.IP "`cite(text)\(cq\&"
Sets `text\(cq\& as a citation or quotation
.IP 
.IP "`clearpage()\(cq\&"
Starts a new page, when the output format permits\&. Under HTML a horizontal
line is drawn\&.
.IP 
.IP "`code(text)\(cq\&"
Sets `text\(cq\& in code font, and prevents it from being expanded\&.
For unbalanced parameter lists, use `CHAR(40)\(cq\& to get
`(\(cq\& and `CHAR(41)\(cq\& to get `)\(cq\&\&.
.IP 
.IP "`columnline(from)(through)\(cq\&"
Sets a horizontal line over some columns in a row\&. Note that `columnline\(cq\&
defines a row by itself, consisting of just a horizontal line spanning some of
its columns, rather than the table\(cq\&s full width, like `rowline\(cq\&\&. The two
arguments represent column numbers\&. It is the responsibility of the author to
make sure that the `from\(cq\& and `through\(cq\& values are sensible\&. I\&.e\&., 
.nf 

    1 <= from <= through <= ncolumns
        
.fi 
To set a horizontal line in just one column select `through\(cq\& equal to
`from\(cq\&\&.
.IP 
\fBNote\fP: this macro cannot be used if multiple lines must be set in one
row\&. In those cases the macros `tline, tskip\(cq\&, and `tendline\(cq\& should be
used\&. 
.IP 
Instead of using `columnline\(cq\& in `table\(cq\&, consider using `tline\(cq\& in
`tbl\(cq\&\&.
.IP 
.IP "`dashes()\(cq\&"
Inserts two dashes in teletype font, and prevents them from being
expanded\&.  
.IP 
In html the `attrib\(cq\& macro is recognized by the `<code>\(cq\& tag that is used
to embed the two dashes\&.
.IP 
.IP "`def(macroname)(nrofargs)(redefinition)\(cq\&"
Defines `macroname\(cq\& as a macro, having `nrofargs\(cq\& arguments, and
expanding to `redefinition\(cq\&\&. This macro is a shorthand for
`DEFINEMACRO\(cq\&\&. An error occurs when the macro is already defined\&. Use
`redef()\(cq\& to unconditionally define or redefine a macro\&.
.IP 
.IP "`description(list)\(cq\&"
Sets `list\(cq\& as a description list\&. Use `dit(item)\(cq\& to
indicate items in the list\&.
.IP 
.IP "`dit(itemname)\(cq\&"
Starts an item named `itemname\(cq\& in a description list\&. The list should be
used in `description\(cq\& macros\&. With `html\(cq\& conversions the
contents of a description item is separated from the item itself\&. The `dit\(cq\&
macro only defines the item, and not the description itself\&. This macro sets
the item in bold\-face (`strong\(cq\& font)\&. The macro `itdesc\(cq\&, available since
Yodl 3\&.05, can be used to defines an item \fIand\fP its description, using its
suggested format (i\&.e\&., indenting the description relative to the item)\&.
.IP 
.IP "`eit()\(cq\&"
Indicates an item in an enumerated list\&. The `eit\(cq\& macro should be used as
an argument in `enumeration\(cq\& macros\&.
.IP 
.IP "`ellipsis()\(cq\&"
Sets ellipsis (\&.\&.\&.)\&.
.IP 
.IP "`em(text)\(cq\&"
Sets `text\(cq\& as emphasized, usually italics\&.
.IP 
.IP "`email(address)\(cq\&"
In HTML, this macro sets the `address\(cq\& in a `<a href=\(dq\&mailto=\&.\&.\(dq\&>\(cq\&
locator\&. In other output formats, the `address\(cq\& is sent to the output\&. The
`email\(cq\& macro is a special case of `url\(cq\&\&.
.IP 
.IP "`enumeration(list)\(cq\&"
`enumeration()\(cq\& starts an enumerated list\&. Use `eit()\(cq\& in the list to 
indicate items in the list\&.
.IP 
.IP "`euro()\(cq\&"
Sets the euro currency symbol in latex, html, (and possibly sgml and xml)\&. In
all other conversions EUR which is the official textual abbreviation
(cf\&. http://ec\&.europa\&.eu/euro/entry\&.html) is written\&. Note that LaTeX
may require latexpackage()(eurosym)\&.
.IP 
.IP "`evalsymbol(symbol)(expression)\(cq\&"
Symbol \fIsymbol\fP receives the value resulting from evaluating
\fIexpression\fP\&. E\&.g\&., if `sym\(cq\& is a defined symbol, then
.nf 

    evalsymbol(sym)(SUBSTR(hello world)(3)(2))
        
.fi 
assigns the value `lo\(cq\& to `sym\(cq\&\&.
.IP 
.IP "`fig(label)\(cq\&"
This macro is a shorthand for `figure ref(label)\(cq\& and just makes the typing
shorter, as in `see fig(schematic) for \&.\&.\(cq\& See `getfigurestring()\(cq\& and
`setfigurestring()\(cq\& for the `figure\(cq\& text\&.
.IP 
.IP "`figure(file)(caption)(label)\(cq\&"
Sets the picture in `file\(cq\& as a figure in the current document, using the
descriptive text `caption\(cq\&\&. The `label\(cq\& is defined as a placeholder for
the figure number and can be used in a corresponding `ref\(cq\& statement\&. Note
that the `file\(cq\& must be the filename without extension: By default, Yodl
will supply `\&.gif\(cq\& when in HTML mode, or `\&.ps\(cq\& when in LaTeX mode\&. Figures
in other modes may not (yet) haven been implemented\&.
.IP 
When converting to html, this macro uses three attribute\-strings (if
available)\&. The string pushed first using an attrib\-call defines the
attributes for its `<figcaption>\(cq\& html\-markup; the string pushed next defines
the attributes for its `<img>\(cq\& html\-markup; the string pushed last defines
the attributes for its `<figure>\(cq\& html\-markup\&. The `figure\(cq\& macro\(cq\&s html
output is organized like this:
.nf 

    <figure \-attrib\-string pushed last (if any)>
        <img \&.\&.\&. \-attrib\-string pushed last but one>
        <figcaption \-attrib\-string pushed 2nd to last>
            \&.\&.\&.
        </figcaption>
    </figure>
    
.fi 
Starting with Yodl 3\&.07\&.00 no `alt=\(dq\&Figure # is shown here\&.\&.\&.\(dq\&\(cq\& attribute is
defined anymore for the `img\(cq\& markup: an `alt\(cq\&\-attribute can easily be
defined at the last attrib\-call, using `getfigurestring()\(cq\& to obtain
`Figure\(cq\& or its language\-specific translation, and
`COUNTERVALUE(XXfigurecounter)\(cq\& to obtain the order\-number of the figure
shown in the next `figure\(cq\&\-macro call\&.
.IP 
.IP "`file(text)\(cq\&"
Sets `text\(cq\& as filename, usually boldface\&.
In html `attrib\(cq\& macro applies to the `<strong>\(cq\& tag\&.
.IP 
.IP "`findex()\(cq\&"
Generate an index entry for LaTex() or texinfo 
f\-indices\&. Its argument is the
index entry\&.  See also the `[cptv]index\(cq\& macro\&.
.IP 
.IP "`footnote(text)\(cq\&"
Sets `text\(cq\& as a footnote, or between parentheses when the output format
does not allow footnotes\&.
.IP 
.IP "`gagmacrowarning(name name \&.\&.\&.)\(cq\&"
Prevents the `yodl\(cq\& program from printing \fIcannot expand possible user
macro\fP\&. E\&.g\&., if you have in your document `the file(s) are \&.\&.\(cq\& then you
might want to put before that: `gagmacrowarning(file)\(cq\&\&. Calls 
`NOUSERMACRO\(cq\&\&.
.IP 
.IP "`getaffilstring()\(cq\&"
Expands to the string that defines the name of \fIAffiliation Information\fP, by
default \fIAFFILIATION INFORMATION\fP\&. Can be redefined for national language
support by `setaffilstring()\(cq\&\&. Currently, it is relevant only for txt\&.
.IP 
.IP "`getauthorstring()\(cq\&"
Expands to the string that defines the name of \fIAuthor Information\fP, by
default \fIAUTHOR INFORMATION\fP\&. Can be redefined for national language
support by `setauthorstring()\(cq\&\&. Currently, it is relevant only for txt\&.
.IP 
.IP "`getchapterstring()\(cq\&"
Expands to the string that defines a `chapter\(cq\& entry, by default \fIChapter\fP\&.
Can be redefined for national language support by `setchapterstring()\(cq\&\&.
.IP 
.IP "`getdatestring()\(cq\&"
Expands to the string that defines the name of \fIDate Information\fP, by
default \fIDATE INFORMATION\fP\&. Can be redefined for national language
support by `setdatestring()\(cq\&\&. Currently, it is relevant only for txt\&.
.IP 
.IP "`getfigurestring()\(cq\&"
Returns the string that defines a `figure\(cq\& text, in captions or in the
`fig()\(cq\& macro\&. The string can be redefined using the `setfiguretext()\(cq\&
macro\&.
.IP 
.IP "`getpartstring()\(cq\&"
Expands to the string that defines a `part\(cq\& entry, by default \fIPart\fP\&. Can
be redefined for national language support by `setpartstring()\(cq\&\&.
.IP 
.IP "`gettitlestring()\(cq\&"
Expands to the string that defines the name of \fITitle Information\fP, by
default \fITITLE INFORMATION\fP\&. Can be redefined for national language
support by `settitlestring()\(cq\&\&. Currently, it is relevant only for txt\&.
.IP 
.IP "`gettocstring()\(cq\&"
Expands to the string that defines the name of the table of contents, by
default \fITable of Contents\fP\&. Can be redefined for national language
support by `settocstring()\(cq\&\&.
.IP 
.IP "`htmlcommand(cmd)\(cq\&"
Writes `cmd\(cq\& to the output when converting to html\&. The `cmd\(cq\& is not
further expanded by Yodl\&.
.IP 
.IP "`htmlheadfile(file)\(cq\&"
Adds the contents of `file\(cq\& to the `head\(cq\& section of an HTML
document\&. The contents of file are not interpreted and should contain plain
html text\&. This option can be useful when large bodies of text, like the
contents of `<script>\(cq\& sections, must be included into the head section of
html documents\&. This macro is only active in the preamble, should only
specified once, and is only interpreted for html conversions\&.
.IP 
.IP "`htmlheadopt(option)\(cq\&"
Adds the literal text `option\(cq\& to the current information in the `head\(cq\&
section of an HTML document\&. `Option\(cq\& may (or: should) contain plain html
text\&. A commonly occurring head option is `link\(cq\&, defining, e\&.g\&., a style
sheet\&. Since that option is frequently used, it has received a dedicated
macro: `htmlstylesheet\(cq\&\&. When large bodies of html\-text must be added to
html documents the macro `htmlheadfile\(cq\& should be used\&. This macro is only
active in the preamble and is only interpreted for html conversions\&.
.IP 
.IP "`htmlnewfile()\(cq\&"
In HTML output, starts a new file\&. All other formats are not affected\&. Note
that you must take your own provisions to access the new file; say via links\&.
Also, it\(cq\&s safe to start a new file just befoore opening a new section, since
sections are accessible from the clickable table of contents\&. The HTML
converter normally only starts new files prior to a `chapter\(cq\& definition\&.
.IP 
.IP "`htmlstyle(tag)(definition)\(cq\&"
Adds a `<style type=\(dq\&text/css\(dq\&> \&.\&.\&. </style>\(cq\& element to the head section
of an HTML document\&.
.br 
Use `htmlstyle\(cq\& to specify one or more CSS definitions which are eventually
inserted at the ellipsis (`\&.\&.\&.\(cq\&) in the generic `style\(cq\& definition shown
above\&. E\&.g\&., (using `#rrggbb\(cq\& to specify a color, where `rr\(cq\& are two
hexadecimal digits specifying the color\(cq\&s red component, `gg\(cq\& two
hexadecimal digits specifying the color\(cq\&s green component, and `bb\(cq\& two
hexadecimal digits specifying the color\(cq\&s blue component)  specifying
.nf 

    htmlstyle(body)(color: #rrggbb; background\-color: #rrggbb)
    htmlstyle(h1)(color: blue; text\-align: center)
    htmlstyle(h2)(color: green)
    
.fi 
results in the element
.nf 

    <style type=\(dq\&text/css\(dq\&>
        body {color: #rrggbb; background\-color: #rrggbb;}
        h1 {color: blue; text\-align: center;} 
        h2 {color: green;}
    </style>
    
.fi 
The macros `htmlheadopt\(cq\& and `htmlstylesheet\(cq\& could also be used to put
information into the head\-section of an HTML document, but `htmlheadopt\(cq\& is
of a much more general nature, while `htmlstylesheet\(cq\& refers to CSS elements
stored in an external file\&. The macro `attrib\(cq\& can be used to define
\fIinline styles\fP\&.
.IP 
The `htmlstyle\(cq\& macro is only active in the preamble and is only
interpreted for html conversions\&.
.br 
Refer to available CSS specifications (cf\&.,
http://www\&.w3schools\&.com/cssref/ for an overview of how CSS
specifications are used, and which CSS specifications are available)\&.
.IP 
By default the internal style specification
.br 
`figure {text\-align: center;} img {vertical\-align: center;}\(cq\&
.br 
is used\&. If this is not appropriate, specify `nohtmlimgstyle()\(cq\& in the
preamble\&. 
.IP 
.IP "`htmlstylesheet(url)\(cq\&"
Adds a `<link rel=\(dq\&stylesheet\(dq\& type=\(dq\&text/css\(dq\& \&.\&.\&.>\(cq\& element to the head
section of an HTML document, using `url\(cq\& in its `href\(cq\& field\&. The argument
`url\(cq\& is not expanded, and should be plain HTML text, without surrounding
quotes\&. The macro `htmlheadopt\(cq\& can also be used to put information in the
head\-section of an HTML document, but `htmlheadopt\(cq\& is of a much more
general nature\&.  This macro is only active in the preamble and is only
interpreted for html conversions\&.
.IP 
.IP "`htmltag(tagname)(start)\(cq\&"
Sets `tagname\(cq\& as a HTML tag, enclosed by `<\(cq\& and `>\(cq\&\&. When `start\(cq\&
is zero, the `tagname\(cq\& is prefixed with `/\(cq\&\&. As not all html tags are
available through predefined Yodl\-macros (there are too many of them, some are
used very infrequently, and you can easily define macros for the tags for
which Yodl doesn\(cq\&t offer predefined ones), the `htmltag\(cq\& macro can be used
to handle your own set of macros\&. In html the `attrib\(cq\& macro is
supported\&. E\&.g\&.,
.nf 

attrib(title=\(dq\&World Health Organization\(dq\&)\
    htmltag(abbr)()WHO+htmltag(abbr)(0)
    
.fi 

.IP 
.IP "`ifnewparagraph(truelist)(falselist)\(cq\&"
The macro `ifnewparagraph\(cq\& should be called from the `PARAGRAPH\(cq\& macro,
if defined\&. It will insert `truelist\(cq\& if a new paragraph is inserted,
otherwise `falselist\(cq\& is inserted (e\&.g\&., following two consecutive calls of
PARAGRAPH)\&. This macro can be used to prevent outputting multiple blank lines\&.
.IP 
.IP "`includefile(file)\(cq\&"
Includes `file\(cq\&\&. The default
extension `\&.yo\(cq\& is supplied if necessary\&.
.IP 
Since Yodl version 3\&.00\&.0 Yodl\(cq\&s default file inclusion behavior has
changed\&. The current working directory no longer remains fixed at the
directory in which Yodl is called, but is volatile, changing to the directory
in which a yodl\-file is located\&. This has the advantage that Yodl\(cq\&s file
inclusion behavior now matches the way \fBC\fP\(cq\&s `#include\(cq\& directive
operates\&. The originally implemented file inclusion behavior is used when 
Yodl\(cq\&s `\-L\(cq\& (`\-\-legacy\-include\(cq\&) option is used\&.
.IP 
.IP "`includeverbatim(file)\(cq\&"
Include `file\(cq\& into the output\&.  No processing is done, `file\(cq\& should
be in preformatted form, e\&.g\&.: 
.nf 
whenhtml(includeverbatim(foo\&.html))
.fi 

.IP 
.IP "`it()\(cq\&"
Indicates an item in an itemized list\&. Items in `it\(cq\& macros are
arguments of `itemization\(cq\& macros\&.
.IP 
.IP "`itdesc(itemname)(contents)\(cq\&"
Starts an item and its description in a description list\&. Its name is
`itemname\(cq\&, the contents of the item is defined by `contents\(cq\&\&. The
`itemname\(cq\& is defined by using the `dit\(cq\& macro\&. 
.IP 
With `html\(cq\& conversions the contents are surrounded by `<dd>\(cq\& and
`</dd>\(cq\& tags, resulting in contents which are indented relative to the
itemname\&. When the `attrib\(cq\& macro is used it is applied to the itemname
(`dt\(cq\&\-tags)\&. 
.IP 
With other conversions the `contents\(cq\& are quoted (as if using
`quote(contents)\(cq\&)\&.
.IP 
.IP "`itemization(list)\(cq\&"
Sets `list\(cq\& as an itemizationd list\&. Use `it()\(cq\& to indicate items in the
list\&.
.IP 
.IP "`kindex()\(cq\&"
Generate an index entry for LaTex() or texinfo k\-indices\&. Its argument is the
index entry\&.  See also the `[cfptv]vindex\(cq\& macro\&.
.IP 
.IP "`label(labelname)\(cq\&"
Defines `labelname\(cq\& as an anchor for a `link\(cq\&
command, or to stand for the last numbering of a section or figure in a
`ref\(cq\& command\&.
.IP 
.IP "`langle()\(cq\&"
Character <
.IP 
.IP "`languagedutch()\(cq\&"
Defines the Dutch\-language specific headers\&. Active this macro via
setlanguage(dutch)\&. 
.IP 
.IP "`languageenglish()\(cq\&"
Defines the English\-language specific headers\&. Active this macro via
setlanguage(english)\&. 
.IP 
.IP "`languageportugese()\(cq\&"
Defines the Portugese\-language specific headers\&. Active this macro via
setlanguage(portugese)\&. 
.IP 
.IP "`LaTeX()\(cq\&"
The LaTeX symbol\&.
.IP 
.IP "`latexaddlayout(arg)\(cq\&"
This macro is provided to add Yodl\-interpreted text to  your own LaTeX layout
commands\&. The command is terminated with an end\-of\-line\&.
See also the macro `latexlayoutcmds()\(cq\&
.IP 
.IP "`latexcommand(cmd)\(cq\&"
Writes `cmd\(cq\& plus a white space to the output when converting to LaTeX\&. The
`cmd\(cq\& is not further expanded by Yodl\&.
.IP 
.IP "`latexdocumentclass(class)\(cq\&"
Forces the LaTeX
`\edocumentclass{\&.\&.\&.}\(cq\& setting to `class\(cq\&\&. Normally the class is
defined by the macros `article\(cq\&, `report\(cq\& or `book\(cq\&\&.  This macro
is an escape route in case you need to specify your own document class
for LaTeX\&. This option is a \fImodifier\fP and must
appear \fIbefore\fP the `article\(cq\&, `report\(cq\& or `book\(cq\& macros\&.
.IP 
.IP "`latexlayoutcmds(NOTRANSs)\(cq\&"
This macro is provided in case you want to put your own LaTeX layout commands
into LaTeX output\&. The `NOTRANSs\(cq\& are pasted right after the
`\edocumentclass\(cq\& stanza\&. The default is, of course, no local LaTeX
commands\&. Note that this macro \fBdoes not\fP overrule my favorite LaTeX
layout\&. Use `nosloppyhfuzz()\(cq\& and `standardlayout()\(cq\& to disable my favorite
LaTeX layout\&.
.IP 
.IP "`latexoptions(options)\(cq\&"
Set latex options: `documentclass[options]\(cq\&\&.  
This command \fBmust\fP appear before the document type is
stated by `article\(cq\&, `report\(cq\&, etc\&.\&.
.IP 
.IP "`latexpackage(options)(name)\(cq\&"
Include latex package(s), a useful package is, e\&.g\&.,
`epsf\(cq\&\&. This command \fBmust\fP appear before the document type is
stated by `article\(cq\&, `report\(cq\&, etc\&.\&.
.IP 
.IP "`lchapter(label)(title)\(cq\&"
Starts a new chapter in books or reports, setting a label at the beginning
of the chapter\&.
.IP 
.IP "`letter(language)(date)(subject)(opening)(salutation)(author)\(cq\&"
Starts a letter written in the indicated language\&. The date of the letter is
set to `date\(cq\&, the subject of the letter will be `subject\(cq\&\&. The letter starts
with `opening\(cq\&\&. It is based on the `letter\&.cls\(cq\& document class definition\&.
The macro is available for LaTeX only\&. Preamble command suggestions:
.IP o 
`latexoptions(11pt)\(cq\&
.IP o 
`a4enlarged()\(cq\&
.IP o 
`letterreplyto(name)(address)(postalcode/city)\(cq\&
.IP o 
`letterfootitem(phone)(number)\(cq\&, maybe e\-mail too\&.
.IP o 
`letteradmin(yourdate)(yourref)\(cq\&
.IP o 
`letterto(addressitem)\(cq\&\&. Use a separate `letterto()\(cq\& macro call
for each new line of the address\&.

.IP 
.IP "`letteraddenda(type)(value)\(cq\&"
Adds an addendum at the end of a letter\&. `type\(cq\& should be `bijlagen\(cq\&,
`cc\(cq\& or `ps\(cq\&\&.
.IP 
.IP "`letteradmin(yourdate)(yourref)\(cq\&"
Puts `yourletterfrom\(cq\& and `yourreference\(cq\& elements in the letter\&. If left
empty, two dashes are inserted\&.
.IP 
.IP "`letterfootitem(name)(value)\(cq\&"
Puts a footer at the bottom of letter\-pages\&. Up to three will usually fit\&.
LaTeX only\&.
.IP 
.IP "`letterreplyto(name)(address)(zip city)\(cq\&"
Defines the `reply to\(cq\& address in LaTeX or txt\-letters\&.
.IP 
.IP "`letterto(element)\(cq\&"
Adds `element\(cq\& as an additional line to the address in LaTeX letters\&.
.IP 
.IP "`link(description)(labelname)\(cq\&"
In HTML output a clickable link with the text `description\(cq\& is created
that points to the place where `labelname\(cq\& is defined using the `label\(cq\&
macro, and `attrib\(cq\& macro applies to the `<a>\(cq\& tag\&.  Using
`link\(cq\& is similar to `url\(cq\&, except that a hyperlink is set pointing to a
location in the same document\&. For output formats other than HTML, only the
`description\(cq\& appears\&.
.IP 
.IP "`lref(description)(labelname)\(cq\&"
This macro is a combination of the `ref\(cq\& and `link\(cq\& macros\&. In HTML
output a clickable link with the text `description\(cq\& and the label value is
created that points to the place where `labelname\(cq\& is defined using the
`label\(cq\& macro, and `attrib\(cq\& macro applies to the `<a>\(cq\&
tag\&. For output formats other than HTML, only the `description\(cq\& and the
label value appears\&.
.IP 
.IP "`lsect(label)(title)\(cq\&"
Starts a new section, setting a label at the beginning of the section\&.
In html `attrib\(cq\& macro applies to the `<h2>\(cq\& tag\&.
.IP 
.IP "`lsubsect(label)(title)\(cq\&"
Starts a new subsection\&. Other sectioning commands are
`subsubsect\(cq\& and `subsubsubsect\(cq\&\&. A label is added just before the
subsection\&.
In html `attrib\(cq\& macro applies to the `<h3>\(cq\& tag\&.
.IP 
.IP "`lsubsubsect(label)(title)\(cq\&"
Starts a sub\-subsection, a label is added just before the section
In html `attrib\(cq\& macro applies to the `<h4>\(cq\& tag\&.
.IP 
.IP "`lsubsubsubsect(label)(title)\(cq\&"
Starts a sub\-sub\-sub section\&. This level of sectioning is not numbered, in
contrast to `higher\(cq\& sectionings\&. A label is added just before the
subsubsubection\&.
.IP 
.IP "`lurl(locator)\(cq\&"
An url described by its Locator\&.  For small urls with readable addresses\&.
.IP 
.IP "`mailto(address)\(cq\&"
Defines the default `mailto\(cq\& address for HTML output\&. Must appear
\fBbefore\fP the document type is stated by `article\(cq\&, `report\(cq\&, etc\&.\&.
.IP 
.IP "`makeindex()\(cq\&"
Make index for latex\&.
.IP 
.IP "`mancommand(cmd)\(cq\&"
Writes `cmd\(cq\& to the output when converting to man\&. The `cmd\(cq\& is not
further expanded by Yodl\&.
.IP 
.IP "`manpage(title)(section)(date)(source)(manual)\(cq\&"
Starts a manual page document\&. The `section\(cq\& argument must be a number,
stating to which section the manpage belongs to\&. Most often used are commands
(1), file formats (5) and macro packages (7)\&. The sectioning commands in a
manpage are \fBnot\fP `(n)sect\(cq\& etc\&., but `manpage\&.\&.\&.()\(cq\&\&. The first section
\fBmust\fP be the `manpagename\(cq\&, the last section \fBmust\fP be the
`manpageauthor\(cq\&\&. The standard manpage for section 1 contains the following
sections (in the given order): `manpagename\(cq\&, `manpagesynopsis\(cq\&,
`manpagedescription\(cq\&, `manpageoptions\(cq\&, `manpagefiles\(cq\&,
`manpageseealso\(cq\&, `manpagediagnostics\(cq\&, `manpagebugs\(cq\&,
`manpageauthor\(cq\&\&. Optional extra sections can be added with
`manpagesection\(cq\&\&. Standard manpageframes for several manpagesections
are provided in `/usr/local/share/yodl/manframes\(cq\&\&. YODL manual pages can be
converted to `groff, html\(cq\&, or plain ascii text formats\&.
.IP 
.IP "`manpageauthor()\(cq\&"
Starts the AUTHOR entry in a `manpage\(cq\& document\&. Must be the last section
of a `manpage\(cq\&\&.
.IP 
.IP "`manpagebugs()\(cq\&"
Starts the BUGS entry in a `manpage\(cq\& document\&.
.IP 
.IP "`manpagedescription()\(cq\&"
Starts the DESCRIPTION entry in a `manpage\(cq\& document\&.
.IP 
.IP "`manpagediagnostics()\(cq\&"
Starts the DIAGNOSTICS entry in a `manpage\(cq\& document\&.
.IP 
.IP "`manpagefiles()\(cq\&"
Starts the FILES entry in a `manpage\(cq\& document\&.
.IP 
.IP "`manpagename(name)(short description)\(cq\&"
Starts the NAME entry in a `manpage\(cq\& document\&. The short description is
used by, e\&.g\&., the `whatis\(cq\& database\&.
.IP 
.IP "`manpageoptions()\(cq\&"
Starts the OPTIONS entry in a `manpage\(cq\& document\&.
.IP 
.IP "`manpagesection(SECTIONNAME)\(cq\&"
Inserts a non\-required section named `SECTIONNAME\(cq\& in a `manpage\(cq\&
document\&. This macro can be used to augment `standard\(cq\& manual pages with extra
sections, e\&.g\&., EXAMPLES\&. \fBNote that\fP the name of the extra section should
appear in upper case, which is consistent with the normal typesetting of
manual pages\&.
.IP 
.IP "`manpageseealso()\(cq\&"
Starts the SEE ALSO entry in a `manpage\(cq\& document\&.
.IP 
.IP "`manpagesynopsis()\(cq\&"
Starts the SYNOPSIS entry in a `manpage\(cq\& document\&.
.IP 
.IP "`manttquoted(onOff)\(cq\&"
With man\-conversions arguments of tt macros are displayed as normal text\&. To
enhance their visibility arguments of tt macros may be quoted, in which case
they are surrounded by backtics and normal quotes\&. By default arguments of tt
macros are not quoted\&. Quotation is used after calling `manttquoted(1)\(cq\&, and
is suppressed after calling `manttquoted(0)\(cq\&\&. The macro is only active when
converting to man\&.
.IP 
.IP "`mbox()\(cq\&"
Unbreakable box in LaTeX\&. Other formats may have different opitions on
our unbreakable boxex\&.
.IP 
.IP "`metaC(text)\(cq\&"
Put a line comment in the output\&.
.IP 
.IP "`metaCOMMENT(text)\(cq\&"
Write format\-specific comment to the output\&.
.IP 
.IP "`mscommand(cmd)\(cq\&"
Writes `cmd\(cq\& to the output when converting to ms\&. The `cmd\(cq\& is not
further expanded by Yodl\&.
.IP 
.IP "`nbsp(count)\(cq\&"
Inserts `count\(cq\& `non\-breaking space\(cq\& characters into the generated output;
i\&.e\&., the space character is not optimized away\&. If the argument list is empty
one non\-breaking space is inserted\&.
.IP 
.IP "`nchapter(title)\(cq\&"
Starts a chapter (in a `book\(cq\& or `report\(cq\&) without generating a
number before the title and without placing an entry for the chapter in
the table of contents\&. 
In html `attrib\(cq\& macro applies to the `<h1>\(cq\& tag\&.
.IP 
.IP "`nemail(name)(address)\(cq\&"
Named email\&.
A more consistent naming for url, lurl, email and nemail would be
nice\&.
.IP 
.IP "`nl()\(cq\&"
Forces a newline; i\&.e\&., breaks the current line in two\&.
.IP 
.IP "`nodeprefix(text)\(cq\&"
Prepend text to node names, e\&.g\&. 
.nf 
nodeprefix(LilyPond) sect(Overview)
.fi 
Currently used in texinfo descriptions only\&.
.IP 
.IP "`nodeprefix(text)\(cq\&"
Prepend text to node names, e\&.g\&. 
.nf 
nodeprefix(LilyPond) sect(Overview)
.fi 
Currently used in texinfo descriptions only\&.
.IP 
.IP "`nodetext(text)\(cq\&"
Use text as description for the next node, e\&.g\&. 
.nf 
nodetext(The GNU Music Typesetter)chapter(LilyPond)
.fi 
Currently used in texinfo descriptions only\&.
.IP 
.IP "`nohtmlfive()\(cq\&"
Starting yodl 3\&.05 html\-conversions by default use html5\&. This can be
suppressed (in favor of using html4) by calling this macro\&. This macro merely
suppresses writing the initial `<!DOCTYPE html>\(cq\& to generated html
files; it is only active in the preamble and is only interpreted for
html conversions\&.
.IP 
.IP "`nohtmlimgstyle()\(cq\&"
By default html\-pages specify
.br 
`(<style type=\(dq\&text/css\(dq\& img {vertical\-align: bottom;}></style>)\(cq\&
.br 
This macro suppresses this `img\(cq\& CSS style specification\&. This macro is
only active in the preamble and is only interpreted for html conversions\&.
.IP 
.IP "`nop(text)\(cq\&"
Expand to text, to avoid spaces before macros e\&.g\&.: a\&. Although
a+sups(2) should have the same effect\&.
.IP 
.IP "`nosloppyhfuzz()\(cq\&"
By default, LaTeX output contains commands that cause it to shut up about
hboxes that are less than 4pt overfull\&. When `nosloppyhfuzz()\(cq\& appears
before stating the document type, LaTeX complaints are `vanilla\(cq\&\&.
.IP 
.IP "`notableofcontents()\(cq\&"
Prevents the generation of a table of contents\&. This is default in, e\&.g\&.,
`manpage\(cq\& and `plainhtml\(cq\& documents\&. When present, this option \fBmust\fP
appear before stating the document type with `article\(cq\&, `report\(cq\&
etc\&.\&.
.IP 
.IP "`notitleclearpage()\(cq\&"
Prevents the generation of a `clearpage()\(cq\& instruction after the typesetting
of title information\&. This instruction is default in all non `article\(cq\&
documents\&. When present, must appear \fBbefore\fP stating the document type with
`article\(cq\&, `book\(cq\& or `report\(cq\&\&.
.IP 
.IP "`notocclearpage()\(cq\&"
With the LaTeX converter, no `clearpage()\(cq\& instruction is inserted
immediately beyond the document\(cq\&s table of contents\&. The `clearpage()\(cq\&
instruction is default in all but the `article\(cq\& document type\&. When present,
must appear \fBbefore\fP stating the document type with `article\(cq\&, `book\(cq\& or
`report\(cq\&\&. With other converters than the LaTeX converter, it is ignored\&.
.IP 
.IP "`notransinclude(filename)\(cq\&"
Reads filename and inserts it literally in the text
not subject to macro expansion or character translation\&.
No information is written either before or after the file\(cq\&s contents, not even
a newline\&.
.IP 
.IP "`noxlatin()\(cq\&"
When used in the preamble, the LaTeX converter disables the inclusion of the
file `xlatin1\&.tex\(cq\&\&. Normally this file gets included in the LateX output
files to ensure the conversion of high ASCII characters (like e) to
LaTeX\-understandable codes\&. (The file `xlatin1\&.tex\(cq\& comes with the YODL
distribution\&.)
.IP 
.IP "`nparagraph(title)\(cq\&"
Starts a non\-numbered paragraph (duh, corresponds to subparagraph in latex)\&.
.IP 
.IP "`npart(title)\(cq\&"
Starts a part in a `book\(cq\& document, but without numbering it and without
entering the title of the part in the table of contents\&.
In html `attrib\(cq\& macro applies to the `<h1>\(cq\& tag\&.
.IP 
.IP "`nsect(title)\(cq\&"
Starts a section, but does not generate a number before the `title\(cq\& nor
an entry in the table of contents\&. Further sectioning commands are
`nsubsect\(cq\&, `nsubsubsect\(cq\& and `nsubsubsubsect\(cq\&\&.
In html `attrib\(cq\& macro applies to the `<h2>\(cq\& tag\&.
.IP 
.IP "`nsubsect(title)\(cq\&"
Starts a non\-numbered subsection\&.  In html the `attrib\(cq\& macro applies to
the `<h3>\(cq\& tag\&.
.IP 
.IP "`nsubsubsect(title)\(cq\&"
Starts a non\-numbered sub\-sub section\&. 
In html `attrib\(cq\& macro applies to the `<p>\(cq\& tag\&.
.IP 
.IP "`nsubsubsect(title)\(cq\&"
Starts a non\-numbered sub\-subsection\&.
.IP 
.IP "`paragraph(title)\(cq\&"
Starts a paragraph\&. This level of sectioning is not numbered, in
contrast to `higher\(cq\& sectionings (duh, corresponds to subparagraph in latex)\&.
In html `attrib\(cq\& macro applies to the `<p>\(cq\& tag\&.
.IP 
.IP "`part(title)\(cq\&"
Starts a new part in a `book\(cq\& document\&.
In html `attrib\(cq\& macro applies to the `<h1>\(cq\& tag\&.
.IP 
.IP "`pindex()\(cq\&"
Generate an index entry for LaTex() or texinfo 
p\-indices\&. Its argument is the
index entry\&.  See also the `[cftv]index\(cq\& macro\&.
.IP 
.IP "`plainhtml(title)\(cq\&"
Starts a document for only a plain HTML conversion\&. Not available in
other output formats\&. Similar to `article\(cq\&, except that an author\- and
date field are not needed\&.
.IP 
.IP "`printindex()\(cq\&"
Make index for texinfo (?)\&.
.IP 
.IP "`quote(text)\(cq\&"
Sets the text as a quotation\&. Usually, the text is indented, depending on
the output format\&. In html the `attrib\(cq\& macro is recognized by the
`<blockquote>\(cq\& tag\&.
.IP 
.IP "`rangle()\(cq\&"
Inserts the right angle character (>)\&.
.IP 
.IP "`redef(macro)(nrofargs)(redefinition)\(cq\&"
Defines macro `macro\(cq\& to expand to `redefinition\(cq\&\&.
Similar to `def\(cq\&, but any pre\-existing definition is overruled\&. Use
`ARG\(cq\&\fIx\fP in the redefinition part to indicate where the arguments should
be pasted\&. E\&.g\&., `ARG1\(cq\& places the first argument, `ARG2\(cq\& the second
argument, etc\&.\&.\&.
.IP 
.IP "`redefinemacro(macro)(nrofargs)(redefinition)\(cq\&"
Defines macro `macro\(cq\& to expand to `redefinition\(cq\&\&.
Similar to `def\(cq\&, but any pre\-existing definition is overruled\&. Use
`ARG\(cq\&\fIx\fP in the redefinition part to indicate where the arguments should
be pasted\&. E\&.g\&., `ARG1\(cq\& places the first argument, `ARG2\(cq\& the second
argument, etc\&.\&.\&. This commands is actually calling redef()\&. 
.IP 
.IP "`ref(labelname)\(cq\&"
Sets the reference for `labelname\(cq\&\&. Use `label\(cq\& to define a label\&.
.IP 
.IP "`report(title)(author)(date)\(cq\&"
Starts a report type document\&. The top\-level sectioning command in a report
is `chapter\(cq\&\&. In html the way the headings are displayed can be tuned using
CSS id selector specifications: the title has `id=\(dq\&title\(dq\&\(cq\&, the author
`id=\(dq\&author\(dq\&\(cq\&, and the date `id=\(dq\&date\(dq\&\(cq\&\&. 
.IP 
.IP "`roffcmd(dotcmd)(sameline)(secondline)(thirdline)\(cq\&"
Sets a t/nroff command that starts with a dot, on its own line\&. The
arguments are: `dotcmd\(cq\& \- the command itself, e\&.g\&., `\&.IP\(cq\&; `sameline\(cq\& \-
when not empty, `sameline\(cq\& is set on the same line, following the
`dotcmd\(cq\&; `secondline\(cq\& \- when not empty, is set on the next line;
`thirdline\(cq\& \- when not empty, is set on the third line\&. Note: `dotcmd\(cq\& and
`thirdline\(cq\& are not further expanded by YODL, the other arguments are\&.
.IP 
.IP "`row(contents)\(cq\&"
The argument `contents\(cq\& may contain a man\-page alignment specification
(only one specification can be entered per row), using `setmanalign()\(cq\&\&. If
omitted, the standard alignment is used\&. Furthermore it contains the contents
of the elements of the row, using `cell()\(cq\& or `cells()\(cq\& macros\&. If
`cells()\(cq\& is used, `setmanalign()\(cq\& should have been used too\&. In this
macro call only the `cell()\(cq\&, `cells()\(cq\& and `setmanalign()\(cq\& macros
should be called\&. Any other macro call may produce unexpected results\&.
.IP 
The `row\(cq\& macro defines a counter `XXcol\(cq\& that can be inspected and is
incremented by predefined macros adding columns to a row\&. The counter is
initially 0\&. Predefined macros adding columns to a row add the number of
columns they add to the row inserting the contents of those columns\&.  These
macros rely on the correct value of this counter and any user\-defined macros
adding columns to table rows should correctly update `XXcol\(cq\&\&.
In html `attrib\(cq\& macro applies to the `<tr>\(cq\& tag\&.
.IP 
Instead of using `row\(cq\& in `table\(cq\&, consider using `tr\(cq\& in `tbl\(cq\&\&.
.IP 
.IP "`rowline()\(cq\&"
Sets a horizontal line over the full width of the table\&. See also
the `columnline\(cq\& macro\&. Use `rowline\(cq\& instead of a `row\(cq\& macro call to
provide a table with a horizontal line\-separator\&.
.IP 
Instead of using `rowline\(cq\& consider using `tline\(cq\& in a `tbl\(cq\& argument\&.
.IP 
.IP "`sc(text)\(cq\&"
Set `text\(cq\& in the tt (code) font, using small caps\&.
In html the `attrib\(cq\& macro is not supported, while the code
section is embedded in a `<div style=\(dq\&font\-size: 90%\(dq\&>\(cq\& section\&.
.IP 
.IP "`sect(title)\(cq\&"
Starts a new section\&. In html the `attrib\(cq\& macro is recognized by the
`<h2>\(cq\& tag\&.
.IP 
.IP "`setaffilstring(name)\(cq\&"
Defines `name\(cq\& as the `affiliation information\(cq\& string, by default
\fIAFFILIATION INFORMATION\fP\&. E\&.g\&., after `setaffilstring(AFILIACION)\(cq\&,
YODL outputs this Spanish string to describe the affiliation information\&.
Currently, it is relevant only for txt\&.
.IP 
.IP "`setauthorstring(name)\(cq\&"
Defines `name\(cq\& as the `Author information\(cq\& string, by default
\fIAUTHOR INFORMATION\fP\&. E\&.g\&., after `setauthorstring(AUTOR)\(cq\&,
YODL outputs this portuguese string to describe the author information\&.
Currently, it is relevant only for txt\&.
.IP 
.IP "`setchapterstring(name)\(cq\&"
Defines `name\(cq\& as the `chapter\(cq\& string, by default \fIChapter\fP\&. E\&.g\&., after
`setchapterstring(Hoofdstuk)\(cq\&, YODL gains some measure of national language
support for Dutch\&. Note that LaTeX support has its own NLS, this macro doesn\(cq\&t
affect the way LaTeX output looks\&.
.IP 
.IP "`setdatestring(name)\(cq\&"
Defines `name\(cq\& as the `date information\(cq\& string, by default
\fIDATE INFORMATION\fP\&. E\&.g\&., after `setdatestring(DATA)\(cq\&,
YODL outputs this portuguese string to describe the date information\&.
Currently, it is relevant only for txt\&.
.IP 
.IP "`setfigureext(name)\(cq\&"
Defines the `name\(cq\& as the `figure\(cq\& extension\&. The extension should include
the period, if used\&. E\&.g\&., use setfigureext(\&.ps) if the extensions
of the figure\-images should end in `\&.ps\(cq\&
.IP 
.IP "`setfigurestring(name)\(cq\&"
Defines the `name\(cq\& as the `figure\(cq\& text, used e\&.g\&. in figure captions\&. E\&.g\&.,
after `setfigurestring(Figuur)\(cq\&, Yodl uses Dutch names for figures\&.
.IP 
.IP "`sethtmlfigureext(ext)\(cq\&"
Defines the filename extension for HTML figures, defaults to `\&.jpg\(cq\&\&. Note
that a leading dot must be included in `ext\(cq\&\&. The new extension takes effect
starting with the following usage of the `figure\(cq\& macro\&.  It is only active
in html, but otherwise acts identically as setfigureext()\&.
.IP 
See also the `setlatexfigureext\(cq\& macro\&.
.IP 
.IP "`htmlmetacharset(meta\-charset)\(cq\&"
Adds `<meta charset=\(dq\&meta\-charset\(dq\&>\(cq\& to the head of html documents\&. By
default `<meta charset=\(dq\&UTF\-8\(dq\&>\(cq\& is used\&. This macro is only active in the
preamble and is only interpreted for html conversions\&.
.IP 
.IP "`setincludepath(name)\(cq\&"
Sets a new value of the include\-path specification used when opening \&.yo
files\&. A warning is issued when the path specification does not include a \&.:
element\&. Note that the local directory may still be an element of the new
include path, as the local directory may be the only or the last element of
the specification\&. For these eventualities the new path specification is not
checked\&.  
.IP 
.IP "`setlanguage(name)\(cq\&"
Installs the headers specific to a language\&. The argument must be the name of
a language, whose headers have been set by a corresponding
languageXXX() call\&. For example: languagedutch()\&. The
language macros should set the names of the headers of the following elements:
table of contents, affiliation, author, chapter, date, figure, part and title
.IP 
.IP "`setlatexalign(alignment)\(cq\&"
This macro defines the table alignment used when setting tables in LaTeX\&.
Use as many `l\(cq\& (for left\-alignment), `r\(cq\& (for right alignment), and `c\(cq\&
(for centered\-alignment) characters as there are columns in the table\&. See
also `table()\(cq\&\&.
.IP 
Instead of using the `table\(cq\& macro consider using the `tbl\(cq\& macro\&.
.IP 
.IP "`setlatexfigureext(ext)\(cq\&"
Defines the filename extension for encapsulated PostScript figures in LaTeX,
defaults to `\&.ps\(cq\&\&. The dot must be included in t new extension `ext\(cq\&\&. The
new extension takes effect starting with a following usage of the `figure\(cq\&
macro\&. It is only active in LaTeX, but otherwise acts identically as
setfigureext()\&.
.IP 
See also the `sethtmlfigureext\(cq\& macro\&.
.IP 
.IP "`setlatexverbchar(char)\(cq\&"
Set the char used to quote LaTeX 
\f(CW\everb\fP
sequences
.IP 
.IP "`setmanalign(alignment)\(cq\&"
This macro defines the table alignment in the context of the `table\(cq\&
macro, and is used when setting tables in man\-pages (see \fBtbl\fP(1))\&.
.IP 
Use as many `l\(cq\& (for left\-alignment), `r\(cq\& (for right alignment), and `c\(cq\&
(for centered\-alignment) characters as there are columns in the
table\&. 
.IP 
Use `s\(cq\& to indicate that the column to its left is combined (spans into) the
current column\&. Use this specification when cells spanning multiple columns
must be defined\&. 
.IP 
Each row in a table which must be convertible to a manpage may be preceded by
its own `setmanalign\(cq\& call\&.  
.IP 
Note that neither `rowline\(cq\& nor `columnline\(cq\& requires `setmanalign\(cq\&
specifications, as these macros define rows by themselves\&. It is the
responsibility of the author to ensure that the number of alignment characters
is equal to the number of columns of the table\&.
.IP 
Instead of using the `table\(cq\& macro consider using the `tbl\(cq\& macro\&.
.IP 
.IP "`setpartstring(name)\(cq\&"
Defines `name\(cq\& as the `part\(cq\& string, by default \fIPart\fP\&. E\&.g\&., after
`setpartstring(Teil)\(cq\&, Yodl identifies parts in the German way\&. Note that
LaTeX output does its own national language support; this macro doesn\(cq\&t affect
the way LaTeX output looks\&.
.IP 
.IP "`setrofftab(x)\(cq\&"
Sets the character separating items in a line of input data of a `roff\(cq\&
(manpage) table\&. By default it is set to `~\(cq\&\&. This separator is used
internally, and needs only be changed (into some unique character) if the
table elements themselves contain `~\(cq\& characters\&.
.IP 
This macro can be used in the context of the `table\(cq\& and `tbl\(cq\& macros\&.
.IP 
.IP "`setrofftableoptions(optionlist)\(cq\&"
Set options used for man\-conversion, as used by the `tbl\(cq\& and `table\(cq\&
macros\&. By default no options are used\&. Multiple options should be separated
by blanks\&. From the \fBtbl\fP(1) manpage, the following options are available:
.IP o 
`center\(cq\& Centers the table; default is left\-justified\&. In the
context of the `tbl\(cq\& macro this is implied when the `tbl\(cq\& macro is
specified as argument of the `center\(cq\& macro\&.
.IP o 
`expand\(cq\& Makes the table as wide as the current line length
.IP o 
`box\(cq\& Encloses the table in a box
.IP o 
`allbox\(cq\& Encloses each item of the table in a box

.IP 
See also `setrofftab\(cq\& which is used to set the character separating
items in a line of input data\&. 
.IP 
.IP "`settitlestring(name)\(cq\&"
Defines `name\(cq\& as the `title information\(cq\& string, by default
\fITITLE INFORMATION\fP\&. E\&.g\&., after `settitlestring(TITEL)\(cq\&,
YODL outputs this Dutch string to describe the title information\&.
Currently, it is relevant only for txt\&.
.IP 
.IP "`settocstring(name)\(cq\&"
Defines `name\(cq\& as the `table of contents\(cq\& string, by default \fITable of
Contents\fP\&. E\&.g\&., after `settocstring(Inhalt)\(cq\&, YODL identifies the table
of contents in the German way\&. Note that LaTeX output does its own national
language support; this macro doesn\(cq\&t affect the way LaTeX output looks\&.
.IP 
.IP "`sgmlcommand(cmd)\(cq\&"
Writes `cmd\(cq\& to the output when converting to sgml\&. The `cmd\(cq\& is not
further expanded by Yodl\&.
.IP 
.IP "`sgmltag(tag)(onoff)\(cq\&"
Similar to `htmltag\(cq\&, but used in the SGML converter\&.
.IP 
.IP "`sloppyhfuzz(points)\(cq\&"
By default, LaTeX output contains commands that cause it to shut up about
hboxes that are less than 4pt overfull\&. When `sloppyhfuzz()\(cq\& appears
before stating the document type, LaTeX complaints occur only if hboxes are
overfull by more than `points\(cq\&\&.
.IP 
.IP "`standardlayout()\(cq\&"
Enables the default LaTeX layout\&. When this macro is absent, then the
first lines of paragraphs are not indented and the space between
paragraphs is somewhat larger\&. The `standardlayout()\(cq\& directive must appear
\fBbefore\fP stating the document type as `article\(cq\&, `report\(cq\&, etc\&.\&.
.IP 
.IP "`strong(contents)\(cq\&"
In html and xml the `contents\(cq\& are set between `<strong>\(cq\& and
`</strong>\(cq\& tags\&. 
In html `attrib\(cq\& macro applies to the `<strong>\(cq\& tag\&.
.IP 
.IP "`subs(text)\(cq\&"
Sets text in subscript in supporting formats\&.  
In html the `attrib\(cq\& macro is recognized by the `<sub>\(cq\& tag\&.
.IP 
For \fIsuper\fPscripting, the `sups\(cq\& macro can be used\&.
.IP 
.IP "`subsect(title)\(cq\&"
Starts a new subsection\&. Other sectioning commands are
`subsubsect\(cq\& and `subsubsubsect\(cq\&\&.
In html `attrib\(cq\& macro applies to the `<h3>\(cq\& tag\&.
.IP 
.IP "`subsubsect(title)\(cq\&"
Starts a sub\-subsection\&.
In html `attrib\(cq\& macro applies to the `<h4>\(cq\& tag\&.
.IP 
.IP "`subsubsubsect(title)\(cq\&"
Starts a sub\-sub\-sub\-subsection\&. This level of sectioning is not numbered, in
contrast to `higher\(cq\& sectionings\&.
.IP 
.IP "`sups(text)\(cq\&"
Sets text in superscript in supporting formats
In html the `attrib\(cq\& macro is recognized by the `<sup>\(cq\& tag\&.
.IP 
For \fIsub\fPscripting, the `subs\(cq\& macro can be used\&.
.IP 
.IP "`table(nColumns)(alignment)(Contents)\(cq\&"
Instead of using the `table\(cq\& macro, consider using the `tbl\(cq\& macro\&.
.IP 
The `table()\(cq\&\-macro defines a table\&. Its first argument specifies the number
of columns in the table\&.
.IP 
Its second argument specifies the (standard) alignment of the information
within the cells as used by LaTeX or man/ms\&. Use `l\(cq\& for left\-alignment,
`c\(cq\& for centered\-alignment and `r\(cq\& for right alignment\&.
.IP 
Its third argument defines the contents of the table which are the rows, each
containing column\-specifications and optionally man/ms alignment definitions
for this row\&.
.IP 
See also the `tableatt\(cq\& macro and the specialized `setmanalign()\(cq\& macro\&.
.IP 
.IP "`tableatt(nColumns)(alignment)(Contents)\(cq\&"
Instead of using the `tableatt\(cq\& macro, consider using the `tbl\(cq\& macro\&.
.IP 
The `tableatt()\(cq\&\-macro defines a table\&. The last `attrib\(cq\& call that was
specified before using the `tableatt()\(cq\&\-macro is used to specify html
attributes for the table\&. E\&.g\&., to center a table in html use
.nf 

    attrib(style=\(dq\&margin\-left:auto;margin\-right:auto;\(dq\&)
    tableatt(\&.\&.\&.)
        
.fi 
The macro\(cq\&s first argument specifies the number of columns in the table\&.
Its second argument specifies the (standard) alignment of the information
within the cells as used by LaTeX or man/ms\&. Use `l\(cq\& for left\-alignment,
`c\(cq\& for centered\-alignment and `r\(cq\& for right alignment\&. Its third argument
defines the contents of the table which are the rows, each containing
column\-specifications and optionally man/ms alignment definitions for this
row\&.
.IP 
See also the `table\(cq\& macro and the specialized `setmanalign()\(cq\& macro\&.
.IP 
.IP "`tac(alignment)(contents)\(cq\&"
This macro is one of the four macros that can be used to define column
contents of rows of tables defined by the `tbl\(cq\& macro\&. Alternatively, `tc,
tnc\(cq\&, and `tnac\(cq\& can be used\&.
.IP 
The `tac\(cq\& macro is used as argument of the `tr\(cq\& macro\&. The cell\(cq\&s
alignment is defined by the `alignment\(cq\& specification, containing at most
two alignment specifications: a horizontal alignment (one of c, l, r
(centered, left\-aligned, right\-aligned)) and a vertical alignment (one of t, b
(vertical top\- and bottom\-alignment)) (not all conversion types may support
all alignment types, e\&.g\&., man\-conversion does not support vertical bottom
alignment)\&. Specifications other than c, l, r, b, and t and specifications
beyond the second one are ignored\&. The result of specifying conflicting
alignment types (e\&.g\&., `lr\(cq\& or `tb\(cq\&) is not defined\&.
.IP 
When converting to `man\(cq\&, if the table\(cq\&s contents should span multiple rows,
then a \fBgroff/troff\fP(1) \fItext block\fP must be used\&. Since most tables do
not use this, a text block is not generated by default\&. To actually wrap the
contents of column elements in a text block while converting to `man\(cq\& prefix
the first text block requiring a text\-block wrapping by `twrap(1)\(cq\&, and end
the last text block requiring a text\-block wrapping by `wrap(0)\(cq\&\&.
.IP 
The `tao\(cq\& macro can be used to overrule the specified alignment for a
specific conversion type\&.
.IP 
The macro `tac\(cq\& recognizes `attrib\(cq\&\&.
.IP 
.IP "`tao(type)(specification)\(cq\&"
This macro is used inside the `tbl\(cq\& macro to override the alignment
specification that would otherwise be used for the next table element\&. It is
only active for the next `tc, tnc, tac,\(cq\& or `tnac\(cq\& call\&. Its first
argument defines the conversion type for which the override should be used,
its second argument defines the alignment specification to use\&.
.IP 
Here are some examples:
.nf 

tbl(lr)(
    tr(
        tc(left aligned)
        tc(right aligned)
    )
    tr(
        tao(html)(c)
          tc(left aligned, centered with html)
        tao(latex)(l)
        tao(man)(l)
          tac(c)(centered, latex and man: left aligned)
    )
)
        
.fi 

.IP 
Further details about the `tao\(cq\& macro are provided in the \fByodltables\fP(7)
man\-page\&.
.IP 
.IP "`tbl(align)(contents)\(cq\&"
The `tbl\(cq\& macro refines the more basic `table\(cq\& macro\&. It was named after
the \fBtbl\fP(1) table formatting program used with \fBtroff\fP(1) documents\&.
.IP 
The `tbl\(cq\& macro currently is available for `html, man/ms, latex\(cq\& and
`txt\(cq\& conversions\&.
.IP 
Its first argument defines the alignment of the information in the table\(cq\&s
columns, and is used by all conversions except `txt\(cq\&\&. Use `l\(cq\& for
left\-alignment, `c\(cq\& for centered\-alignment and `r\(cq\& for
right\-alignment\&. Individual cells of the table may override these default
settings using the macros `tac\(cq\& and `tnac\(cq\&\&.
.IP 
Its second argument defines the contents of the table consisting of rows
(using `tr\(cq\&), and horizontal lines (using `tline\(cq\&), which may extend over
the full table width or may cover one or more individual columns\&. With `txt\(cq\&
conversion rough approximations of horizontal lines are used\&.
.IP 
Tables defined by the `tbl\(cq\& macro are centered (pseudo centering (8 space
characters) is used for `txt\(cq\& conversion) when used as argument of the
`center\(cq\& macro\&.
.IP 
See also the `tao\(cq\& macro for information about how to realize specific
alignments for specific conversion types\&.
.IP 
When defining `tbl\(cq\& tables it is advised to clearly layout the table
specification\&. To avoid inadvertently introducing new lines lines should end
in a backslash (or 
The macro `tbl\(cq\& recognizes `attrib\(cq\&\&. 
.IP 
.IP "`tc(contents)\(cq\&"
This macro is one of the four macros that can be used to define column
contents of rows of tables defined by the `tbl\(cq\& macro\&. Alternatively,
`tnc, tac\(cq\&, and `tnac\(cq\& can be used\&.
.IP 
The `tc\(cq\& macro is used as argument of the `tr\(cq\& macro\&. Its order within a
row defines its type attribute, using the alignment specification defined by
the first argument of the `tbl\(cq\& call\&. E\&.g\&., if `tbl(clr)(\&.\&.\&.)\(cq\& was used,
then the contents of the first `tc\(cq\& call in a `tr\(cq\& is centered in the
table\(cq\&s first column; the contents of the second `tc\(cq\& call is left\-aligned
in the table\(cq\&s second column; and the contents of the third `tc\(cq\& call is
right\-aligned in the table\(cq\&s third column\&.
.IP 
When converting to `man\(cq\&, if the table\(cq\&s contents should span multiple rows,
then a \fBgroff/troff\fP(1) \fItext block\fP must be used\&. Since most tables do
not use this, a text block is not generated by default\&. To actually wrap the
contents of column elements in a text block while converting to `man\(cq\& prefix
the first text block requiring a text\-block wrapping by `twrap(1)\(cq\&, and end
the last text block requiring a text\-block wrapping by `wrap(0)\(cq\&\&.
.IP 
The `tao\(cq\& macro can be used to overrule the default alignment specification 
for a specific conversion type\&.
.IP 
The macro `tc\(cq\& recognizes `attrib\(cq\&\&. 
.IP 
.IP "`tcell(text)\(cq\&"
Roff helper to set a table text\-cell, i\&.e\&., a paragraph\&.  For LaTeX
special table formatting p{} should be used\&.
.IP 
When using the `tbl\(cq\& macro for defining tables the `twrap\(cq\& macro can be
used to set table elements in text\-blocks (i\&.e\&., enclosing text, possibly
containing newlines in `T{\(cq\& and `T}\(cq\& sequences)\&.
.IP 
.IP "`telycommand(cmd)\(cq\&"
Writes `cmd\(cq\& to the output when converting to tely\&. The `cmd\(cq\& is not
further expanded by Yodl\&.
.IP 
.IP "`TeX()\(cq\&"
The TeX symbol\&.
.IP 
.IP "`texinfocommand(cmd)\(cq\&"
Writes `cmd\(cq\& to the output when converting to texinfo\&. The `cmd\(cq\& is not
further expanded by Yodl\&.
.IP 
.IP "`tindex()\(cq\&"
Generate an index entry for LaTex() or texinfo 
t\-indices\&. Its argument is the
index entry\&.  See also the `[cfpv]index\(cq\& macro\&.
.IP 
.IP "`titleclearpage()\(cq\&"
Forces a new page (using `clearpage\(cq\&) following the title of a
document\&. This is already the default in books and reports, but can be
overruled using `notitleclearpage\(cq\&\&. When present, it must appear in the
\fIpreamble\fP, i\&.e\&., before the document type is stated as article, book or
report\&.
.IP 
.IP "`tline(beginNr)(endNr)\(cq\&"
This macro is used to insert a horizontal line spanning one or more columns
of a table defined by the `tbl\(cq\& macro\&.
.IP 
If `endNr\(cq\& is not specified, and the `tline\(cq\& call does not follow a
previous `line\(cq\& call in which `endNr\(cq\& \fIwas\fP specified, then a horizontal
line spanning the full width of the table is defined (except when converting
to plain text in which case a line of `beginNr\(cq\& \- (minus) characters is
written; if `beginNr\(cq\& is not specified then a line of 60 \- characters is
written)\&.
.IP 
If `endNr\(cq\& is not specified, but the `tline\(cq\& call follows previous `tline\(cq\&
calls that did specify `endNr\(cq\& then the current row is ended\&. 
.IP 
If `endNr\(cq\& is specified, then a horizontal line is set, starting at column
number `beginNr\(cq\& continuing through column number `endNr\(cq\&\&. Note that these
are \fInumbers\fP, not \fIoffsets\fP: `beginNr\(cq\& should be at least 1, `endNr\(cq\&
must at least be equal to `beginNr\(cq\& and should be at most equal to the
number of columns in the table\&. The `beginNr\(cq\& values of subsequent `tline\(cq\&
calls refer to the same row as the first `tline\(cq\& call, and must exceed
`endNr\(cq\& of the previous `tline\(cq\& call\&.
.IP 
Examples:
.nf 

    tline()()       sets a line spanning the full table width
    tline(1)(1)     sets a line in column 1
    tline(3)(4)     sets another line in column 3 and 4
    tline()()       ends the previous line
    tline()()       sets a line spanning the full table width
        
.fi 

.IP 
.IP "`tnac(nCells)(alignment)(contents)\(cq\&"
This macro is one of the four macros that can be used to define column
contents of rows of tables defined by the `tbl\(cq\& macro\&. Alternatively, `tc,
tac\(cq\&, and `tnc\(cq\& can be used\&.
.IP 
The `tnac\(cq\& macro is used as argument of the `tr\(cq\& macro\&. Its first argument
defines the number of columns spanned by the contents (2nd argument) 
of the `tnc\(cq\& macro\&. 
.IP 
The cell\(cq\&s alignment is defined by the macro\(cq\&s second (`alignment\(cq\&)
specification, containing at most two alignment specifications: a horizontal
alignment (one of c, l, r (centered, left\-aligned, right\-aligned)) and a
vertical alignment (one of t, b (vertical top\- and bottom\-alignment)) (not all
conversion types may support all alignment types)\&. Specifications other than
c, l, r, b, and t and specifications beyond the second one are ignored\&. The
result of specifying conflicting alignment types (e\&.g\&., `lr\(cq\& or `tb\(cq\&) is
not defined\&.
.IP 
When converting to `man\(cq\&, if the table\(cq\&s contents should span multiple rows,
then a \fBgroff/troff\fP(1) \fItext block\fP must be used\&. Since most tables do
not use this, a text block is not generated by default\&. To actually wrap the
contents of column elements in a text block while converting to `man\(cq\& prefix
the first text block requiring a text\-block wrapping by `twrap(1)\(cq\&, and end
the last text block requiring a text\-block wrapping by `wrap(0)\(cq\&\&.  Multiple
rows in a text block are top\-aligned with left and righ neighboring cells\&.
.IP 
The `tao\(cq\& macro can be used to overrule the default alignment specification 
for a specific conversion type\&.
.IP 
The macro `tnac\(cq\& recognizes `attrib\(cq\&\&.
.IP 
.IP "`tnc(nCells)(contents)\(cq\&"
This macro is one of the four macros that can be used to define the column
contents of rows of tables that are defined by the `tbl\(cq\&
macro\&. Alternatively, `tc, tac\(cq\&, and `tnac\(cq\& can be used\&.
.IP 
The `tnc\(cq\& macro is used as argument to the `tr\(cq\& macro\&. Its first argument
defines the number of columns spanned by the contents (2nd argument) 
of the `tnc\(cq\& macro\&. The contents are centered in the `nCells\(cq\& columns\&.
.IP 
When converting to `man\(cq\&, if the table\(cq\&s contents should span multiple rows,
then a \fBgroff/troff\fP(1) \fItext block\fP must be used\&. Since most tables do
not use this, a text block is not generated by default\&. To actually wrap the
contents of column elements in a text block while converting to `man\(cq\& prefix
the first text block requiring a text\-block wrapping by `twrap(1)\(cq\&, and end
the last text block requiring a text\-block wrapping by `wrap(0)\(cq\&\&.  Multiple
rows in a text block are top\-aligned with left and righ neighboring cells\&.
.IP 
The `tao\(cq\& macro can be used to overrule the default alignment specification 
for a specific conversion type\&.
.IP 
The macro `tc\(cq\& recognizes `attrib\(cq\&\&. 
.IP 
.IP "`tocclearpage()\(cq\&"
With the LaTeX converter, a `clearpage()\(cq\& directive if inserted,
immediately following the document\(cq\&s table of contents\&. This is already the
default in all but the `article\(cq\& document type, but it can be overruled by
`notocclearpage()\(cq\&\&. When present, it must appear in the \fIpreamble\fP; i\&.e\&.,
before the document type is stated with `article\(cq\&, `book\(cq\& or
`report\(cq\&\&. With other converters than the LaTeX converter, it is ignored\&.
.IP 
.IP "`tr(contents)\(cq\&"
This macro defines the rows of a table that is defined by the `tbl\(cq\& macro\&.
.IP 
The macro `tr\(cq\& expects one argument: the contents of the row, defining the
row\(cq\&s column elements\&. It is not used for defining a (partial) horizontal
line: to set horizontal lines in a table defined by the `tbl\(cq\& macro use the
macro `tline\(cq\&\&.
.IP 
Normally the contents of the columns in a (`tr\(cq\&) row is defined by 
of one or more calls to the macros `tc, tac, tnc,\(cq\& and/or `tnac\(cq\&\&.
.IP 
The macro `tr\(cq\& recognizes `attrib\(cq\&\&.
.IP 
.IP "`tt(text)\(cq\&"
Sets `text\(cq\& in teletype font, and prevents it from being expanded\&.
When converting to man, `text\(cq\& is surrounded by a backtick and a single
quote character\&.
.IP 
For unbalanced parameter lists, use `CHAR(40)\(cq\& to get
`(\(cq\& and `CHAR(41)\(cq\& to get `)\(cq\&\&.
.IP 
The `tt\(cq\& macro does interpret character tables as well as any `SUBST\(cq\&
definitions\&. This is usually what is intended\&. In situations where this is
unwelcome the `ttbegin\(cq\& and `ttend\(cq\& pair of macros can be used, between
which the builtin commands `PUSHSUBST, POPSUBST, NOEXPAND\(cq\& and/or
`NOTRANS\(cq\& can be used\&. E\&.g\&., to clearly show two hyphens in LaTeX 
teletype font use 
.nf 

    ttbegin()\-\-ttend()
    
.fi 
rather than
.nf 

    tt(\-\-)
    
.fi 
Likewise, use `ttbegin\(cq\& and `ttend\(cq\& if the teletype text contains
accented letters like e\&. To set this in teletype font use 
`ttbegin()\e\(dq\&\(cq\&`e+ttend()\(cq\&\&.
.IP 
With html conversions the `attrib\(cq\& macro applies to the `<code>\(cq\& tag\&.
.IP 
With man conversions the arguments of tt macros can be quoted\&. See the
`manttquoted\(cq\& macro for details\&.
.IP 
.IP "`ttbegin()\(cq\&"
Initiates text set in teletype font\&. Following the text to set in
teletype font a `ttend()\(cq\& macro should be called\&.
.IP 
Usually the `tt\(cq\& macro can be used instead of the `ttbegin\(cq\& \-\-
`ttend\(cq\& combination\&. However, `tt\(cq\& interprets character tables as well as
`SUBST\(cq\& definitions\&. In situations where this is unwelcome the `ttbegin\(cq\&
and `ttend\(cq\& pair of macros can be used, between which builtin commands like
`PUSHSUBST, POPSUBST, NOEXPAND\(cq\& and/or `NOTRANS\(cq\& can be used\&.
.IP 
In html the `attrib\(cq\& macro applies to the `<code>\(cq\& tag\&.
.IP 
.IP "`ttend()\(cq\&"
Ends text set in teletype font following `ttbegin\(cq\&\&. Refer to the
`ttbegin\(cq\& macro\(cq\&s description for details\&.
.IP 
.IP "`twrap(value)\(cq\&"
Used for man/ms conversions only: when called with a non\-zero argument
before using the `tc, tnc, tac\(cq\&, and `tnac\(cq\& macros then their contents are
wrapped in text blocks (`T{ \&.\&.\&. T}\(cq\& blocks)\&. To end the wrapping
`twrap(0)\(cq\& must be called\&. E\&.g\&., in the following row\-definition the
contents of columns three and four are set in T\-blocks when converting to
man/ms:
.nf 

    tr(tc(one)tc(two)twrap(1)tc(one)tc(two)twrap(0))
.fi 

.IP 
.IP "`txtcommand(cmd)\(cq\&"
Writes `cmd\(cq\& to the output when converting to txt\&. The `cmd\(cq\& is not
further expanded by Yodl\&.
.IP 
.IP "`url(description)(locator)\(cq\&"
In LaTeX documents the `description\(cq\& is sent to the output\&. For HTML,
a link is created with the descriptive text `description\(cq\& and pointing
to `locator\(cq\&\&. The `locator\(cq\& should be the full URL, including
service; e\&.g, `http://www\&.icce\&.rug\&.nl\(cq\&, but excluding the double
quotes that are necessary in plain HTML\&. Use the macro `link\(cq\& to create
links within the same document\&. For other formats, something like
\fIdescription [locator]\fP will appear\&.
In html `attrib\(cq\& macro applies to the `<a>\(cq\& tag\&.
.IP 
.IP "`verb(text)\(cq\&"
Sets `text\(cq\& in verbatim mode: not subject to macro expansion or character
table expansion, and starting with Yodl version 4\&.00\&.00: not using `SUBST\(cq\&
definitions\&. See also `verborg\(cq\&, which does not provide the protection
against `SUBST\(cq\& definitions\&.
.IP 
While converting Yodl\-documents to target document types Yodl frequently uses
the (not further documented) builtin function `XXSUBST\(cq\&\&. In the
unlikely event that the text `XXSUBST(\&.\&.\&.)\(cq\& must be written
in a document, the sequence
.nf 

    XXSUBST+CHAR(40)\&.\&.\&.CHAR(41)
    
.fi 
can be used\&.
.IP 
The text that is passed as argument to the `verb\(cq\&\-macro appears literally
on the output, usually in a teletype font (that depends on the output
format)\&. This macro is for larger chunks, e\&.g\&., listings\&. 
.IP 
When starting the `verb(\(cq\& macro on a line by itself and writing the
closing parenthesis on a line by itself then those newlines also appear in the
resulting verbatim text\&. To omit those lines immediately start the first line
of text after `verb\(cq\& and append the closing parenthesis to the last line of
verbatim text\&. E\&.g\&.,
.nf 
verb(    First line of indented literal text
    Last line of indented literal text)
.fi 

.IP 
When unbalanced parameter lists are required, use `CHAR(40)\(cq\& to get
`(\(cq\& and `CHAR(41)\(cq\& to get `)\(cq\&\&.
.IP 
.IP "`verbinclude(filename)\(cq\&"
Reads filename and inserts it literally in the text, set in verbatim mode\&.
not subject to macro expansion\&. The text appears literally on the output,
usually in a teletype font (that depends on the output format)\&. This macro is
an alternative to `verb(\&.\&.\&.)\(cq\&, when the text to set in verbatim mode is
better kept in a separate file\&.
.IP 
.IP "`verbinsert(args)\(cq\&"
Passes `args\(cq\& to \fByodlverbinsert\fP(1), inserting its output into the
converted file\&. This macro can be used to insert, e\&.g\&., a line\-numbered
indented file, or a labeled subsection of a file, into the file that\(cq\&s
currently being written by `yodl\(cq\&\&. E\&.g,
.nf 

verbinsert(\-ans4 file)       \-\- inserts file, showing line
                                numbers, using a 4 blank\-space
                                character wide indentation\&.

verbinsert(\-ns4 //SECT file) \-\- inserts the section of file, 
                                labeled //SECT file, showing 
                                line numbers, using a 4 
                                blank\-space character wide 
                                indentation\&.
    
.fi 

.IP 
.IP "`verborg(text)\(cq\&"
Sets `text\(cq\& in verbatim mode: not subject to macro expansion or character
table expansion, and starting with Yodl version 4\&.00\&.00: this macro replaces
the previously defined `verb\(cq\& macro\&. The current `verb\(cq\& macro surrounds
this macro by `PUSHSUBST\(cq\& and `POPSUBST\(cq\&\&.
.IP 
The text that is passed as argument to the `verborg\(cq\&\-macro appears
literally on the output, albeit that `SUBST\(cq\& definitions are processed,
usually in a teletype font (that depends on the
output format)\&. This macro is for larger chunks, e\&.g\&., listings\&.
.IP 
When unbalanced parameter lists are required, use `CHAR(40)\(cq\& to get
`(\(cq\& and `CHAR(41)\(cq\& to get `)\(cq\&\&.
.IP 
.IP "`verbpipe(command)(text)\(cq\&"
Pipe text through command, but don\(cq\&t expand the output\&.
.IP 
.IP "`vindex()\(cq\&"
Generate an index entry for LaTex() or texinfo v\-indices\&. 
Its argument is the index entry\&. 
See also the `[cfkpt]index\(cq\& macro\&.
.IP 
.IP "`whenhtml(text)\(cq\&"
Sends `text\(cq\& to the output when in HTML conversion mode\&. The text is
further expanded if necessary\&.
.IP 
.IP "`whenlatex(text)\(cq\&"
Sends `text\(cq\& to the output when in LATEX conversion mode\&. The text is
further expanded if necessary\&.
.IP 
.IP "`whenman(text)\(cq\&"
Sends `text\(cq\& to the output when in MAN conversion mode\&. The text is
further expanded if necessary\&.
.IP 
.IP "`whenms(text)\(cq\&"
Sends `text\(cq\& to the output when in MS conversion mode\&. The text is
further expanded if necessary\&.
.IP 
.IP "`whensgml(text)\(cq\&"
Sends `text\(cq\& to the output when in SGML conversion mode\&. The text is
further expanded if necessary\&.
.IP 
.IP "`whentely(text)\(cq\&"
Sends `text\(cq\& to the output when in TELY conversion mode\&. The text is
further expanded if necessary\&.
.IP 
.IP "`whentexinfo(text)\(cq\&"
Sends `text\(cq\& to the output when in TEXINFO conversion mode\&. The text is
further expanded if necessary\&.
.IP 
.IP "`whentxt(text)\(cq\&"
Sends `text\(cq\& to the output when in TXT conversion mode\&. The text is
further expanded if necessary\&.
.IP 
.IP "`whenxml(text)\(cq\&"
Sends `text\(cq\& to the output when in XML conversion mode\&. The text is
further expanded if necessary\&.
.IP 
.IP "`xit(itemname)\(cq\&"
Starts an xml menu item where the file to
which the menu refers to is the argument of the xit() macro\&. It
should be used as argument to xmlmenu(), which has a 3rd argument:
the default path prefixed to the xit() elements\&. 
.IP 
This macro is only available
within the xml\-conversion mode\&. The argument must be a full filename,
including \&.xml extension, if applicable\&.
.IP 
No \&.xml extension indicates a subdirectory, containing another sub\-menu\&.
.IP 
.IP "`xmlcommand(cmd)\(cq\&"
Writes `cmd\(cq\& to the output when converting to xml\&. The `cmd\(cq\& is not
further expanded by Yodl\&.
.IP 
.IP "`xmlmenu(order)(title)(menulist)\(cq\&"
Starts an xmlmenu\&. Use itemization() to define the items\&. Only
available in xml conversion\&. The menutitle appears in the menu as the heading
of the menu\&.  The menulist is a series of xit() elements, containing
the name of the file to which the menu refers as their argument (including a
final /)\&.  Prefixed to evert every xit()\-element is the value of
XXdocumentbase\&.
.IP 
Order is the the `order\(cq\& of the menu\&. If omitted, no order is defined\&.
.IP 
.IP "`xmlnewfile()\(cq\&"
In XML output, starts a new file\&. All other formats are not affected\&. Note
that you must take your own provisions to access the new file; say via links\&.
Also, it\(cq\&s safe to start a new file just befoore opening a new section, since
sections are accessible from the clickable table of contents\&. The XML
converter normally only starts new files prior to a `chapter\(cq\& definition\&.
.IP 
.IP "`xmlsetdocumentbase(name)\(cq\&"
Defines `name\(cq\& as the XML document base\&. No default\&.
Only interpreted with xml conversions\&. It is used with the figure and xmlmenu
macros\&.
.IP 
.IP "`xmltag(tag)(onoff)\(cq\&"
Similar to `htmltag\(cq\&, but used in the XML converter\&.
.IP 
.SH "OPTIONS"
No options are relevant in respect to the macros\&.
.PP 
.SH "FILES"
The files in \fBtmp/wip/macros\fP define the converter\(cq\&s macro packages\&. The
scripts \fByodl2tex\fP, \fByodl2html\fP, \fByodl2man\fP etc\&. perform the
conversions\&.
.PP 
.SH "SEE ALSO"

.PP 
\fByodl\fP(1), 
\fByodlbuiltins\fP(7), 
\fByodlconverters\fP(1), 
\fByodlletter\fP(7), 
\fByodlmanpage\fP(7),
\fByodlpost\fP(1), 
\fByodlstriproff\fP(1), 
\fByodltables\fP(7), 
\fByodlverbinsert\fP(1)\&.
.PP 
.SH "BUGS"

.PP 
\-
.PP 
.SH "AUTHOR"

.PP 
Frank B\&. Brokken (f\&.b\&.brokken@rug\&.nl),