.TH "Yodl macros" "7" "1996\-2014" "yodl_3\&.04\&.00\&.tar\&.gz" "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 \fBNOTE:\fP Starting with 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 \f(CW#include\fP directive operates; it has the disadvantage that it may break some current documents\&. Conversion, however is simple but can be avoided altogether if Yodl\(cq\&s \f(CW\-L\fP (\f(CW\-\-legacy\-include\fP) option is used\&. This affects the \f(CW(l)includefile, includeverbatim, notransinclude\fP and \f(CWverbinclude\fP macros (see below)\&. .PP The following list shows all macros of the package in alphabetical order\&. .PP .IP "\f(CWabstract(text)\fP" Defines an abstract for an \f(CWarticle\fP or \f(CWreport\fP document\&. Abstracts are not implemented for \f(CWbook\fPs or \f(CWmanpage\fPs\&. Must appear \fBbefore\fP starting the document with the \f(CWarticle\fP or \f(CWreport\fP macro\&. .IP .IP "\f(CWaddntosymbol(symbol)(n)(text)\fP" Adds \f(CWtext\fP \f(CWn\fP times to \f(CWsymbol\fP\&. The value \f(CWn\fP may also be the name of a defined counter (which itself will not be modified)\&. .IP .IP "\f(CWaffiliation(site)\fP" Defines an affiliation, to appear in the document titlepage below the author field\&. Must appear \fBbefore\fP starting the document with \f(CWarticle\fP, \f(CWreport\fP or \f(CWbook\fP\&. The affiliation is only printed when the author field is not empty\&. .IP .IP "\f(CWAfourEnlarged()\fP" 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 "\f(CWappendix()\fP" Starts appendices .IP .IP "\f(CWarticle(title)(author)(date)\fP" Starts an article\&. The top\-level sectioning command is \f(CW(n)sect\fP\&. In HTML conversions only one output file is written\&. .IP .IP "\f(CWbf(text)\fP" Sets \f(CWtext\fP in boldface\&. .IP .IP "\f(CWbind(text)\fP" Generate a binding character after text\&. .IP .IP "\f(CWbook(title)(author)(date)\fP" Starts a book document\&. The top\-level sectioning command is \f(CW(n)chapter\fP, \f(CW(n)part\fP being optional\&. In HTML output files are created for each chapter\&. .IP .IP "\f(CWcell(contents)\fP" Sets a table cell, i\&.e\&., one element in a row\&. With the man/ms converters multiple blanks between \f(CWcell()\fP macro calls are merged into a single blank character\&. .IP .IP "\f(CWcells(nColumns)(contents)\fP" Set a table cell over \f(CWnColumns\fP columns\&. In html, LaTeX and xml formats the information in the combined cells will be centered\&. With man/ms conversions the \f(CWcells()\fP macro simply calls the \f(CWcell()\fP macro, but here the \f(CWsetmanalign()\fP macro can be used to determine the alignment of multiple cells\&. .IP .IP "\f(CWcellsline(from)(count)\fP" Sets a horizontal line starting at column number \f(CWfrom\fP over \f(CWcount\fP columns in a row\&. If \f(CWfrom\fP is less then the number of columns already added to a row then it is ignored\&. This macro must be embedded in a \f(CWrow\fP macro defining a table row\&. To put a line across the table\(cq\&s full width use \f(CWrowline\fP\&. 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 \f(CWcellsline\fP and \f(CWcell\fP or \f(CWcells\fP calls in one row produces undefined results\&. .IP .IP "\f(CWcenter(text)\fP" Sets \f(CWtext\fP centered, when the output format permits\&. Use \f(CWnl()\fP in the text to break lines\&. .IP .IP "\f(CWchapter(title)\fP" Starts a new chapter in \f(CWbook\fPs or \f(CWreport\fPs\&. .IP .IP "\f(CWcindex()\fP" Generate an index entry for index c\&. .IP .IP "\f(CWcite(1)\fP" Sets a citation or quotation .IP .IP "\f(CWclearpage()\fP" Starts a new page, when the output format permits\&. Under HTML a horizontal line is drawn\&. .IP .IP "\f(CWcode(text)\fP" Sets \f(CWtext\fP in code font, and prevents it from being expanded\&. For unbalanced parameter lists, use \f(CWCHAR(40)\fP to get \f(CW(\fP and \f(CWCHAR(41)\fP to get \f(CW)\fP\&. .IP .IP "\f(CWcolumnline(from)(to)\fP" Sets a horizontal line over some columns in a row\&. Note that \f(CWcolumnline\fP 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 \f(CWrowline\fP\&. The two arguments represent column numbers\&. It is the responsibility of the author to make sure that the \f(CWfrom\fP and \f(CWto\fP values are sensible\&. I\&.e\&., .nf 1 <= from <= to <= ncolumns .fi \fBNote\fP: this macro cannot be used if multiple lines must be set in one row\&. In those cases the macro \f(CWcolsline\fP should be used\&. .IP .IP "\f(CWdef(macroname)(nrofargs)(redefinition)\fP" Defines \f(CWmacroname\fP as a macro, having \f(CWnrofargs\fP arguments, and expanding to \f(CWredefinition\fP\&. This macro is a shorthand for \f(CWDEFINEMACRO\fP\&. An error occurs when the macro is already defined\&. Use \f(CWredef()\fP to unconditionally define or redefine a macro\&. .IP .IP "\f(CWdescription(list)\fP" Sets \f(CWlist\fP as a description list\&. Use \f(CWdit(item)\fP to indicate items in the list\&. .IP .IP "\f(CWdit(itemname)\fP" Starts an item named \f(CWitemname\fP in a descriptive list\&. The list is either enclosed by \f(CWstartdit()\fP and \f(CWenddit()\fP, or is an argument to \f(CWdescription()\fP\&. .IP .IP "\f(CWeit()\fP" Indicates an item in an enumerated list\&. The \f(CWeit()\fP macro should be an argument in \f(CWenumerate()\fP\&. .IP .IP "\f(CWellipsis()\fP" Sets ellipsis (\&.\&.\&.)\&. .IP .IP "\f(CWem(text)\fP" Sets \f(CWtext\fP as emphasized, usually italics\&. .IP .IP "\f(CWemail(address)\fP" In HTML, this macro sets the \f(CWaddress\fP in a \f(CW\fP locator\&. In other output formats, the \f(CWaddress\fP is sent to the output\&. The \f(CWemail\fP macro is a special case of \f(CWurl\fP\&. .IP .IP "\f(CWendcenter()\fP" DEPRECATED\&. Use center()\&. .IP .IP "\f(CWenddit()\fP" DEPRECATED\&. Use description()\&. .IP .IP "\f(CWendeit()\fP" DEPRECATED\&. Use enumeration()\&. .IP .IP "\f(CWendit()\fP" DEPRECATED\&. Use itemization()\&. .IP .IP "\f(CWendmenu()\fP" DEPRECATED\&. Use menu()\&. .IP .IP "\f(CWendtable()\fP" DEPRECATED\&. Use table()\&. .IP .IP "\f(CWenumerate(list)\fP" DEPRECATED\&. Use enumeration()\&. .IP .IP "\f(CWenumeration(list)\fP" \f(CWenumeration()\fP starts an enumerated list\&. Use \f(CWeit()\fP in the list to indicate items in the list\&. .IP .IP "\f(CWeuro()\fP" 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 "\f(CWfig(label)\fP" This macro is a shorthand for \f(CWfigure ref(label)\fP and just makes the typing shorter, as in \f(CWsee fig(schematic) for \&.\&.\fP See \f(CWgetfigurestring()\fP and \f(CWsetfigurestring()\fP for the \f(CWfigure\fP text\&. .IP .IP "\f(CWfigure(file)(caption)(label)\fP" Sets the picture in \f(CWfile\fP as a figure in the current document, using the descriptive text \f(CWcaption\fP\&. The \f(CWlabel\fP is defined as a placeholder for the figure number and can be used in a corresponding \f(CWref\fP statement\&. Note that the \f(CWfile\fP must be the filename without extension: By default, Yodl will supply \f(CW\&.gif\fP when in HTML mode, or \f(CW\&.ps\fP when in LaTeX mode\&. Figures in other modes may not (yet) haven been implemented\&. .IP .IP "\f(CWfile(text)\fP" Sets \f(CWtext\fP as filename, usually boldface\&. .IP .IP "\f(CWfindex()\fP" Generate an index entry for index f\&. .IP .IP "\f(CWfootnote(text)\fP" Sets \f(CWtext\fP as a footnote, or in parentheses when the output format does not allow footnotes\&. .IP .IP "\f(CWgagmacrowarning(name name \&.\&.\&.)\fP" Prevents the \f(CWyodl\fP program from printing \fIcannot expand possible user macro\fP\&. E\&.g\&., if you have in your document \f(CWthe file(s) are \&.\&.\fP then you might want to put before that: \f(CWgagmacrowarning(file)\fP\&. Calls \f(CWNOUSERMACRO\fP\&. .IP .IP "\f(CWgetaffilstring()\fP" 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 \f(CWsetaffilstring()\fP\&. Currently, it is relevant only for txt\&. .IP .IP "\f(CWgetauthorstring()\fP" 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 \f(CWsetauthorstring()\fP\&. Currently, it is relevant only for txt\&. .IP .IP "\f(CWgetchapterstring()\fP" Expands to the string that defines a `chapter\(cq\& entry, by default \fIChapter\fP\&. Can be redefined for national language support by \f(CWsetchapterstring()\fP\&. .IP .IP "\f(CWgetdatestring()\fP" 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 \f(CWsetdatestring()\fP\&. Currently, it is relevant only for txt\&. .IP .IP "\f(CWgetfigurestring()\fP" Returns the string that defines a `figure\(cq\& text, in captions or in the \f(CWfig()\fP macro\&. The string can be redefined using the \f(CWsetfiguretext()\fP macro\&. .IP .IP "\f(CWgetpartstring()\fP" Expands to the string that defines a `part\(cq\& entry, by default \fIPart\fP\&. Can be redefined for national language support by \f(CWsetpartstring()\fP\&. .IP .IP "\f(CWgettitlestring()\fP" 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 \f(CWsettitlestring()\fP\&. Currently, it is relevant only for txt\&. .IP .IP "\f(CWgettocstring()\fP" 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 \f(CWsettocstring()\fP\&. .IP .IP "\f(CWhtmlbodyopt(option)(value)\fP" Adds \f(CWoption=\(dq\&value\(dq\&\fP to the options of the \f(CW\fP tag in HTML files\&. Useful options are, e\&.g\&., \f(CWfgcolor\fP and \f(CWbgcolor\fP, whose values are expressed as \f(CW#rrggbb\fP, where \f(CWrr\fP are two hexadecimal digits of the red component, \f(CWgg\fP two hexadecimal digits of the green component, and \f(CWbb\fP two hexadecimal digits of the blue component\&. .IP .IP "\f(CWhtmlcommand(cmd)\fP" Writes \f(CWcmd\fP to the output when converting to html\&. The \f(CWcmd\fP is not further expanded by Yodl\&. .IP .IP "\f(CWhtmlheadopt(option)\fP" Adds the literal text \f(CWoption\fP to the current information in the \f(CWhead\fP section of an HTML document\&. \f(CWOption\fP may (or: should) contain plain html text\&. A commonly occurring head option is \f(CWlink\fP, defining, e\&.g\&., a style sheet\&. Since that option is frequently used, it has received a dedicated macro: \f(CWhtmlstylesheet\fP\&. Like \f(CWhtmlbodyopt\fP this macro should be placed in the document\(cq\&s preamble\&. .IP .IP "\f(CWhtmlnewfile()\fP" 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 \f(CWchapter\fP definition\&. .IP .IP "\f(CWhtmlstylesheet(url)\fP" Adds a \f(CW\fP element to the head section of an HTML document, using \f(CWurl\fP in its \f(CWhref\fP field\&. The argument \f(CWurl\fP is not expanded, and should be plain HTML text, without surrounding quotes\&. The macro \f(CWhtmlheadopt\fP can also be used to put information in the head\-section of an HTML document, but \f(CWhtmlheadopt\fP is of a much more general nature\&. Like \f(CWhtmlbodyopt\fP this macro should be placed in the document\(cq\&s preamble\&. .IP .IP "\f(CWhtmltag(tagname)(start)\fP" Sets \f(CWtagname\fP as a HTML tag, enclosed by \f(CW<\fP and \f(CW>\fP\&. When \f(CWstart\fP is zero, the \f(CWtagname\fP is prefixed with \f(CW/\fP\&. .IP .IP "\f(CWifnewparagraph(truelist)(falselist)\fP" The macro \f(CWifnewparagraph\fP should be called from the \f(CWPARAGRAPH\fP macro, if defined\&. It will insert \f(CWtruelist\fP if a new paragraph is inserted, otherwise \f(CWfalselist\fP is inserted (e\&.g\&., following two consecutive calls of PARAGRAPH)\&. This macro can be used to prevent the output of multiple blank lines\&. .IP .IP "\f(CWincludefile(file)\fP" Includes \f(CWfile\fP\&. The default extension \f(CW\&.yo\fP is supplied if necessary\&. .IP \fBNOTE:\fP Starting with 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 \f(CW#include\fP directive operates; it has the disadvantage that it may break some current documents\&. Conversion, however is simple but can be avoided altogether if Yodl\(cq\&s \f(CW\-L\fP (\f(CW\-\-legacy\-include\fP) option is used\&. .IP Furthermore, the \f(CWincludefile\fP macro no longer defines a label\&. To define a label just before the file\(cq\&s inclusion use \f(CWlincludefile\fP\&. .IP .IP "\f(CWincludeverbatim(file)\fP" Include \f(CWfile\fP into the output\&. No processing is done, \f(CWfile\fP should be in preformatted form, e\&.g\&.: .nf whenhtml(includeverbatim(foo\&.html)) .fi .IP \fBNOTE:\fP Starting with 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 \f(CW#include\fP directive operates; it has the disadvantage that it may break some current documents\&. Conversion, however is simple but can be avoided altogether if Yodl\(cq\&s \f(CW\-L\fP (\f(CW\-\-legacy\-include\fP) option is used\&. .IP .IP "\f(CWit()\fP" Indicates an item in an itemized list\&. The list is either surrounded by \f(CWstartit()\fP and \f(CWendit()\fP, or it is an argument to \f(CWitemize()\fP\&. .IP .IP "\f(CWitemization(list)\fP" Sets \f(CWlist\fP as an itemizationd list\&. Use \f(CWit()\fP to indicate items in the list\&. .IP .IP "\f(CWitemize(list)\fP" DEPRECATED\&. Use itemization()\&. .IP .IP "\f(CWkindex()\fP" Generate an index entry for index k\&. .IP .IP "\f(CWlabel(labelname)\fP" Defines \f(CWlabelname\fP as an anchor for a \f(CWlink\fP command, or to stand for the last numbering of a section or figure in a \f(CWref\fP command\&. .IP .IP "\f(CWlangle()\fP" Character < .IP .IP "\f(CWlanguagedutch()\fP" Defines the Dutch\-language specific headers\&. Active this macro via setlanguage(dutch)\&. .IP .IP "\f(CWlanguageenglish()\fP" Defines the English\-language specific headers\&. Active this macro via setlanguage(english)\&. .IP .IP "\f(CWlanguageportugese()\fP" Defines the Portugese\-language specific headers\&. Active this macro via setlanguage(portugese)\&. .IP .IP "\f(CWLaTeX()\fP" The LaTeX symbol\&. .IP .IP "\f(CWlatexaddlayout(arg)\fP" 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 \f(CWlatexlayoutcmds()\fP .IP .IP "\f(CWlatexcommand(cmd)\fP" Writes \f(CWcmd\fP plus a white space to the output when converting to LaTeX\&. The \f(CWcmd\fP is not further expanded by Yodl\&. .IP .IP "\f(CWlatexdocumentclass(class)\fP" Forces the LaTeX \f(CW\edocumentclass{\&.\&.\&.}\fP setting to \f(CWclass\fP\&. Normally the class is defined by the macros \f(CWarticle\fP, \f(CWreport\fP or \f(CWbook\fP\&. This macro is an escape route incase you need to specify your own document class for LaTeX\&. This option is a \fImodifier\fP and must appear \fIbefore\fP the \f(CWarticle\fP, \f(CWreport\fP or \f(CWbook\fP macros\&. .IP .IP "\f(CWlatexlayoutcmds(NOTRANSs)\fP" This macro is provided in case you want to put your own LaTeX layout commands into LaTeX output\&. The \f(CWNOTRANSs\fP are pasted right after the \f(CW\edocumentclass\fP stanza\&. The default is, of course, no local LaTeX commands\&. Note that this macro \fBdoes not\fP overrule my favorite LaTeX layout\&. Use \f(CWnosloppyhfuzz()\fP and \f(CWstandardlayout()\fP to disable my favorite LaTeX layout\&. .IP .IP "\f(CWlatexoptions(options)\fP" Set latex options: \f(CWdocumentclass[options]\fP\&. This command \fBmust\fP appear before the document type is stated by \f(CWarticle\fP, \f(CWreport\fP, etc\&.\&. .IP .IP "\f(CWlatexpackage(options)(name)\fP" Include latex package(s), a useful package is, e\&.g\&., \f(CWepsf\fP\&. This command \fBmust\fP appear before the document type is stated by \f(CWarticle\fP, \f(CWreport\fP, etc\&.\&. .IP .IP "\f(CWlchapter(label)(title)\fP" Starts a new chapter in \f(CWbook\fPs or \f(CWreport\fPs, setting a label at the beginning of the chapter\&. .IP .IP "\f(CWletter(language)(date)(subject)(opening)(salutation)(author)\fP" 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 \f(CWlatexoptions(11pt)\fP .IP o \f(CWa4enlarged()\fP .IP o \f(CWletterreplyto(name)(address)(postalcode/city)\fP .IP o \f(CWletterfootitem(phone)(number)\fP, maybe e\-mail too\&. .IP o \f(CWletteradmin(yourdate)(yourref)\fP .IP o \f(CWletterto(addressitem)\fP\&. Use a separate \f(CWletterto()\fP macro call for each new line of the address\&. .IP .IP "\f(CWletteraddenda(type)(value)\fP" Adds an addendum at the end of a letter\&. `type\(cq\& should be `bijlagen\(cq\&, `cc\(cq\& or `ps\(cq\&\&. .IP .IP "\f(CWletteradmin(yourdate)(yourref)\fP" Puts `yourletterfrom\(cq\& and `yourreference\(cq\& elements in the letter\&. If left empty, two dashes are inserted\&. .IP .IP "\f(CWletterfootitem(name)(value)\fP" Puts a footer at the bottom of letter\-pages\&. Up to three will usually fit\&. LaTeX only\&. .IP .IP "\f(CWletterreplyto(name)(address)(zip city)\fP" Defines the `reply to\(cq\& address in LaTeX or txt\-letters\&. .IP .IP "\f(CWletterto(element)\fP" Adds `element\(cq\& as an additional line to the address in LaTeX letters\&. .IP .IP "\f(CWlink(description)(labelname)\fP" In HTML output a clickable link with the text \f(CWdescription\fP is created that points to the place where \f(CWlabelname\fP is defined using the \f(CWlabel\fP macro\&. Using \f(CWlink\fP is similar to \f(CWurl\fP, except that a hyperlink is set pointing to a location in the same document\&. For output formats other than HTML, only the \f(CWdescription\fP appears\&. .IP .IP "\f(CWlref(description)(labelname)\fP" This macro is a combination of the \f(CWref\fP and \f(CWlink\fP macros\&. In HTML output a clickable link with the text \f(CWdescription\fP and the label value is created that points to the place where \f(CWlabelname\fP is defined using the \f(CWlabel\fP macro\&. For output formats other than HTML, only the \f(CWdescription\fP and the label value appears\&. .IP .IP "\f(CWlsect(label)(title)\fP" Starts a new section, setting a label at the beginning of the section\&. .IP .IP "\f(CWlsubsect(label)(title)\fP" Starts a new subsection\&. Other sectioning commands are \f(CWsubsubsect\fP and \f(CWsubsubsubsect\fP\&. A label is added just before the subsection\&. .IP .IP "\f(CWlsubsubsect(label)(title)\fP" Starts a sub\-subsection, a label is added just before the section .IP .IP "\f(CWlsubsubsubsect(label)(title)\fP" 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 "\f(CWlurl(locator)\fP" An url described by its Locator\&. For small urls with readable addresses\&. .IP .IP "\f(CWmailto(address)\fP" Defines the default \f(CWmailto\fP address for HTML output\&. Must appear \fBbefore\fP the document type is stated by \f(CWarticle\fP, \f(CWreport\fP, etc\&.\&. .IP .IP "\f(CWmakeindex()\fP" Make index for latex\&. .IP .IP "\f(CWmancommand(cmd)\fP" Writes \f(CWcmd\fP to the output when converting to man\&. The \f(CWcmd\fP is not further expanded by Yodl\&. .IP .IP "\f(CWmanpage(title)(section)(date)(source)(manual)\fP" Starts a manual page document\&. The \f(CWsection\fP 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 \f(CW(n)sect\fP etc\&., but \f(CWmanpage\&.\&.\&.()\fP\&. The first section \fBmust\fP be the \f(CWmanpagename\fP, the last section \fBmust\fP be the \f(CWmanpageauthor\fP\&. The standard manpage for section 1 contains the following sections (in the given order): \f(CWmanpagename\fP, \f(CWmanpagesynopsis\fP, \f(CWmanpagedescription\fP, \f(CWmanpageoptions\fP, \f(CWmanpagefiles\fP, \f(CWmanpageseealso\fP, \f(CWmanpagediagnostics\fP, \f(CWmanpagebugs\fP, \f(CWmanpageauthor\fP\&. Optional extra sections can be added with \f(CWmanpagesection\fP\&. Standard manpageframes for several manpagesections are provided in \f(CW/usr/local/share/yodl/manframes\fP\&. .IP .IP "\f(CWmanpageauthor()\fP" Starts the AUTHOR entry in a \f(CWmanpage\fP document\&. Must be the last section of a \f(CWmanpage\fP\&. .IP .IP "\f(CWmanpagebugs()\fP" Starts the BUGS entry in a \f(CWmanpage\fP document\&. .IP .IP "\f(CWmanpagedescription()\fP" Starts the DESCRIPTION entry in a \f(CWmanpage\fP document\&. .IP .IP "\f(CWmanpagediagnostics()\fP" Starts the DIAGNOSTICS entry in a \f(CWmanpage\fP document\&. .IP .IP "\f(CWmanpagefiles()\fP" Starts the FILES entry in a \f(CWmanpage\fP document\&. .IP .IP "\f(CWmanpagename(name)(short description)\fP" Starts the NAME entry in a \f(CWmanpage\fP document\&. The short description is used by, e\&.g\&., the \f(CWwhatis\fP database\&. .IP .IP "\f(CWmanpageoptions()\fP" Starts the OPTIONS entry in a \f(CWmanpage\fP document\&. .IP .IP "\f(CWmanpagesection(SECTIONNAME)\fP" Inserts a non\-required section named \f(CWSECTIONNAME\fP in a \f(CWmanpage\fP 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 "\f(CWmanpageseealso()\fP" Starts the SEE ALSO entry in a \f(CWmanpage\fP document\&. .IP .IP "\f(CWmanpagesynopsis()\fP" Starts the SYNOPSIS entry in a \f(CWmanpage\fP document\&. .IP .IP "\f(CWmbox()\fP" Unbreakable box in LaTeX\&. Other formats may have different opitions on our unbreakable boxex\&. .IP .IP "\f(CWmenu(list)\fP" DEPRECATED\&. .IP .IP "\f(CWmetaC(text)\fP" Put a line comment in the output\&. .IP .IP "\f(CWmetaCOMMENT(text)\fP" Write format\-specific comment to the output\&. .IP .IP "\f(CWmit()\fP" DEPRECATED\&. .IP .IP "\f(CWmscommand(cmd)\fP" Writes \f(CWcmd\fP to the output when converting to ms\&. The \f(CWcmd\fP is not further expanded by Yodl\&. .IP .IP "\f(CWnchapter(title)\fP" Starts a chapter (in a \f(CWbook\fP or \f(CWreport\fP) without generating a number before the title and without placing an entry for the chapter in the table of contents\&. .IP .IP "\f(CWnemail(name)(address)\fP" Named email\&. A more consistent naming for url, lurl, email and nemail would be nice\&. .IP .IP "\f(CWnl()\fP" Forces a newline; i\&.e\&., breaks the current line in two\&. .IP .IP "\f(CWnode(previous)(this)(next)(up)\fP" \fBDEPRECATED\fP Defines a node with name \f(CWthis\fP, and links to nodes \f(CWprevious\fP, \f(CWnext\fP and (up), for the \f(CWnode\fP command\&. .IP .IP "\f(CWnodeprefix(text)\fP" Prepend text to node names, e\&.g\&. .nf nodeprefix(LilyPond) sect(Overview) .fi Currently used in texinfo descriptions only\&. .IP .IP "\f(CWnodeprefix(text)\fP" Prepend text to node names, e\&.g\&. .nf nodeprefix(LilyPond) sect(Overview) .fi Currently used in texinfo descriptions only\&. .IP .IP "\f(CWnodetext(text)\fP" 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 "\f(CWnop(text)\fP" Expand to text, to avoid spaces before macros e\&.g\&.: a\&. Although a+sups(2) should have the same effect\&. .IP .IP "\f(CWnosloppyhfuzz()\fP" By default, LaTeX output contains commands that cause it to shut up about hboxes that are less than 4pt overfull\&. When \f(CWnosloppyhfuzz()\fP appears before stating the document type, LaTeX complaints are `vanilla\(cq\&\&. .IP .IP "\f(CWnotableofcontents()\fP" Prevents the generation of a table of contents\&. This is default in, e\&.g\&., \f(CWmanpage\fP and \f(CWplainhtml\fP documents\&. When present, this option \fBmust\fP appear before stating the document type with \f(CWarticle\fP, \f(CWreport\fP etc\&.\&. .IP .IP "\f(CWnotitleclearpage()\fP" Prevents the generation of a \f(CWclearpage()\fP instruction after the typesetting of title information\&. This instruction is default in all non \f(CWarticle\fP documents\&. When present, must appear \fBbefore\fP stating the document type with \f(CWarticle\fP, \f(CWbook\fP or \f(CWreport\fP\&. .IP .IP "\f(CWnotocclearpage()\fP" With the LaTeX convertor, no \f(CWclearpage()\fP instruction is inserted immediately beyond the document\(cq\&s table of contents\&. The \f(CWclearpage()\fP instruction is default in all but the \f(CWarticle\fP document type\&. When present, must appear \fBbefore\fP stating the document type with \f(CWarticle\fP, \f(CWbook\fP or \f(CWreport\fP\&. With other convertors than the LaTeX convertor, it is ignored\&.) .IP .IP "\f(CWnotransinclude(filename)\fP" 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 \fBNOTE:\fP Starting with 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 \f(CW#include\fP directive operates; it has the disadvantage that it may break some current documents\&. Conversion, however is simple but can be avoided altogether if Yodl\(cq\&s \f(CW\-L\fP (\f(CW\-\-legacy\-include\fP) option is used\&. .IP .IP "\f(CWnoxlatin()\fP" When used in the preamble, the LaTeX converter disables the inclusion of the file \f(CWxlatin1\&.tex\fP\&. 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 \f(CWxlatin1\&.tex\fP comes with the YODL distribution\&.) .IP .IP "\f(CWnparagraph(title)\fP" Starts a non\-numbered paragraph (duh, corresponds to subparagraph in latex)\&. .IP .IP "\f(CWnpart(title)\fP" Starts a part in a \f(CWbook\fP document, but without numbering it and without entering the title of the part in the table of contents\&. .IP .IP "\f(CWnsect(title)\fP" Starts a section, but does not generate a number before the \f(CWtitle\fP nor an entry in the table of contents\&. Further sectioning commands are \f(CWnsubsect\fP, \f(CWnsubsubsect\fP and \f(CWnsubsubsubsect\fP\&. .IP .IP "\f(CWnsubsect(title)\fP" Starts a non\-numbered subsection\&. .IP .IP "\f(CWnsubsubsect(title)\fP" Starts a non\-numbered sub\-sub section\&. .IP .IP "\f(CWnsubsubsect(title)\fP" Starts a non\-numbered sub\-subsection\&. .IP .IP "\f(CWparagraph(title)\fP" Starts a parapgraph\&. This level of sectioning is not numbered, in contrast to `higher\(cq\& sectionings (duh, corresponds to subparagraph in latex)\&. .IP .IP "\f(CWpart(title)\fP" Starts a new part in a \f(CWbook\fP document\&. .IP .IP "\f(CWpindex()\fP" Generate an index entry for index p\&. .IP .IP "\f(CWplainhtml(title)\fP" Starts a document for only a plain HTML conversion\&. Not available in other output formats\&. Similar to \f(CWarticle\fP, except that an author\- and date field are not needed\&. .IP .IP "\f(CWprintindex()\fP" Make index for texinfo (?)\&. .IP .IP "\f(CWquote(text)\fP" Sets the text as a quotation\&. Usually, the text is indented, depending on the output format\&. .IP .IP "\f(CWrangle()\fP" Inserts the right angle character (>)\&. .IP .IP "\f(CWredef(macro)(nrofargs)(redefinition)\fP" Defines macro \f(CWmacro\fP to expand to \f(CWredefinition\fP\&. Similar to \f(CWdef\fP, but any pre\-existing definition is overruled\&. Use \f(CWARG\fP\fIx\fP in the redefinition part to indicate where the arguments should be pasted\&. E\&.g\&., \f(CWARG1\fP places the first argument, \f(CWARG2\fP the second argument, etc\&.\&.\&. .IP .IP "\f(CWredefinemacro(macro)(nrofargs)(redefinition)\fP" Defines macro \f(CWmacro\fP to expand to \f(CWredefinition\fP\&. Similar to \f(CWdef\fP, but any pre\-existing definition is overruled\&. Use \f(CWARG\fP\fIx\fP in the redefinition part to indicate where the arguments should be pasted\&. E\&.g\&., \f(CWARG1\fP places the first argument, \f(CWARG2\fP the second argument, etc\&.\&.\&. This commands is actually calling redef()\&. .IP .IP "\f(CWref(labelname)\fP" Sets the reference for \f(CWlabelname\fP\&. Use \f(CWlabel\fP to define a label\&. .IP .IP "\f(CWreport(title)(author)(date)\fP" Starts a report type document\&. The top\-level sectioning command in a report is \f(CWchapter\fP\&. .IP .IP "\f(CWroffcmd(dotcmd)(sameline)(secondline)(thirdline)\fP" Sets a t/nroff command that starts with a dot, on its own line\&. The arguments are: \f(CWdotcmd\fP \- the command itself, e\&.g\&., \f(CW\&.IP\fP; \f(CWsameline\fP \- when not empty, set following the \f(CWdotcmd\fP on the same line; \f(CWsecondline\fP \- when not empty, set on the next line; \f(CWthirdline\fP \- when not empty, set on the third line\&. Note that \f(CWdotcmd\fP and \f(CWthirdline\fP are not further expanded by YODL, the other arguments are\&. .IP .IP "\f(CWrow(contents)\fP" The argument \f(CWcontents\fP may contain a man\-page alignment specification (only one specification can be entered per row), using \f(CWsetmanalign()\fP\&. If omitted, the standard alignment is used\&. Furthermore it contains the contents of the elements of the row, using \f(CWcell()\fP or \f(CWcells()\fP macros\&. If \f(CWcells()\fP is used, \f(CWsetmanalign()\fP should have been used too\&. In this macro call only the \f(CWcell()\fP, \f(CWcells()\fP and \f(CWsetmanalign()\fP macros should be called\&. Any other macro call may produce unexpected results\&. .IP The \f(CWrow\fP macro defines a counter \f(CWXXcellnr\fP 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 \f(CWXXcellnr\fP\&. .IP .IP "\f(CWrowline()\fP" Sets a horizontal line over the full width of the table\&. See also \f(CWcolumnline()\fP\&. Use \f(CWrowline()\fP instead of a \f(CWrow()\fP macro call to obtain a horizontal line\-separator\&. .IP .IP "\f(CWsc(text)\fP" Set \f(CWtext\fP in small caps (or tt)\&. .IP .IP "\f(CWsect(title)\fP" Starts a new section\&. .IP .IP "\f(CWsetaffilstring(name)\fP" Defines \f(CWname\fP as the `affiliation information\(cq\& string, by default \fIAFFILIATION INFORMATION\fP\&. E\&.g\&., after \f(CWsetaffilstring(AFILIACION)\fP, YODL outputs this Spanish string to describe the affiliation information\&. Currently, it is relevant only for txt\&. .IP .IP "\f(CWsetauthorstring(name)\fP" Defines \f(CWname\fP as the `Author information\(cq\& string, by default \fIAUTHOR INFORMATION\fP\&. E\&.g\&., after \f(CWsetauthorstring(AUTOR)\fP, YODL outputs this portuguese string to describe the author information\&. Currently, it is relevant only for txt\&. .IP .IP "\f(CWsetchapterstring(name)\fP" Defines \f(CWname\fP as the `chapter\(cq\& string, by default \fIChapter\fP\&. E\&.g\&., after \f(CWsetchapterstring(Hoofdstuk)\fP, 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 "\f(CWsetdatestring(name)\fP" Defines \f(CWname\fP as the `date information\(cq\& string, by default \fIDATE INFORMATION\fP\&. E\&.g\&., after \f(CWsetdatestring(DATA)\fP, YODL outputs this portuguese string to describe the date information\&. Currently, it is relevant only for txt\&. .IP .IP "\f(CWsetfigureext(name)\fP" Defines the \f(CWname\fP 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 \f(CW\&.ps\fP .IP .IP "\f(CWsetfigurestring(name)\fP" Defines the \f(CWname\fP as the `figure\(cq\& text, used e\&.g\&. in figure captions\&. E\&.g\&., after \f(CWsetfigurestring(Figuur)\fP, Yodl uses Dutch names for figures\&. .IP .IP "\f(CWsethtmlfigureext(ext)\fP" Defines the filename extension for HTML figures, defaults to \f(CW\&.jpg\fP\&. Note that a leading dot must be included in \f(CWext\fP\&. The new extension takes effect starting with the following usage of the \f(CWfigure\fP macro\&. It is only active in html, but otherwise acts identically as setfigureext()\&. .IP .IP "\f(CWsetincludepath(name)\fP" 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 "\f(CWsetlanguage(name)\fP" 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 "\f(CWsetlatexalign(alignment)\fP" This macro defines the table alignment used when setting tables in LaTeX\&. Use as many \f(CWl\fP (for left\-alignment), \f(CWr\fP (for right alignment), and \f(CWc\fP (for centered\-alignment) characters as there are columns in the table\&. See also \f(CWtable()\fP .IP .IP "\f(CWsetlatexfigureext(ext)\fP" Defines the filename extension for encapsulated PostScript figures in LaTeX, defaults to \f(CW\&.ps\fP\&. The dot must be included in t new extension \f(CWext\fP\&. The new extension takes effect starting with a following usage of the \f(CWfigure\fP macro\&. It is only active in LaTeX, but otherwise acts identically as setfigureext()\&. .IP .IP "\f(CWsetlatexverbchar(char)\fP" Set the char used to quote LaTeX \f(CW\everb\fP sequences .IP .IP "\f(CWsetmanalign(alignment)\fP" This macro defines the table alignment used when setting tables used in man\-pages (see \fBtbl\fP(1))\&. Use as many \f(CWl\fP (for left\-alignment), \f(CWr\fP (for right alignment), and \f(CWc\fP (for centered\-alignment) characters as there are columns in the table\&. Furthermore, \f(CWs\fP can be used to indicate that the column to its left is combined (spans into) the current column\&. Use this specification when cells spanning multiple columns are defined\&. Each row in a table which must be convertable to a manpage may contain a separate \f(CWsetmanalign()\fP call\&. Note that neither \f(CWrowline\fP nor \f(CWcolumnline\fP requires \f(CWsetmanalign()\fP 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 .IP "\f(CWsetpartstring(name)\fP" Defines \f(CWname\fP as the `part\(cq\& string, by default \fIPart\fP\&. E\&.g\&., after \f(CWsetpartstring(Teil)\fP, 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 "\f(CWsetrofftab(x)\fP" Sets the character separating items in a line of input data of a \f(CWroff\fP (manpage) table\&. By default it is set to \f(CW~\fP\&. This separator is used internally, and needs only be changed (into some unique character) if the table elements themselves contain \f(CW~\fP characters\&. .IP .IP "\f(CWsetrofftableoptions(optionlist)\fP" Set the options for tbl table, default: none\&. Multiple options should be separated by blanks, by default no option is used\&. From the \fBtbl\fP(1) manpage, the following options are selected for consideration: .IP o \f(CWcenter\fP Centers the table (default is left\-justified) .IP o \f(CWexpand\fP Makes the table as wide as the current line length .IP o \f(CWbox\fP Encloses the table in a box .IP o \f(CWallbox\fP Encloses each item of the table in a box Note that starting with Yodl V 2\&.00 no default option is used anymore\&. See also \f(CWsetrofftab()\fP which is used to set the character separating items in a line of input data\&. .IP .IP "\f(CWsettitlestring(name)\fP" Defines \f(CWname\fP as the `title information\(cq\& string, by default \fITITLE INFORMATION\fP\&. E\&.g\&., after \f(CWsettitlestring(TITEL)\fP, YODL outputs this Dutch string to describe the title information\&. Currently, it is relevant only for txt\&. .IP .IP "\f(CWsettocstring(name)\fP" Defines \f(CWname\fP as the `table of contents\(cq\& string, by default \fITable of Contents\fP\&. E\&.g\&., after \f(CWsettocstring(Inhalt)\fP, 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 "\f(CWsgmlcommand(cmd)\fP" Writes \f(CWcmd\fP to the output when converting to sgml\&. The \f(CWcmd\fP is not further expanded by Yodl\&. .IP .IP "\f(CWsgmltag(tag)(onoff)\fP" Similar to \f(CWhtmltag\fP, but used in the SGML converter\&. .IP .IP "\f(CWsloppyhfuzz(points)\fP" By default, LaTeX output contains commands that cause it to shut up about hboxes that are less than 4pt overfull\&. When \f(CWsloppyhfuzz()\fP appears before stating the document type, LaTeX complaints occur only if hboxes are overfull by more than \f(CWpoints\fP\&. .IP .IP "\f(CWstandardlayout()\fP" 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 \f(CWstandardlayout()\fP directive must appear \fBbefore\fP stating the document type as \f(CWarticle\fP, \f(CWreport\fP, etc\&.\&. .IP .IP "\f(CWstartcenter()\fP" DEPRECATED\&. center() should be used\&. .IP .IP "\f(CWstartdit()\fP" DEPRECATED\&. Use description()\&. .IP .IP "\f(CWstarteit()\fP" DEPRECATED\&. Use enumeration()\&. .IP .IP "\f(CWstartit()\fP" DEPRECATED\&. Use itemization()\&. .IP .IP "\f(CWstartmenu()\fP" DEPRECATED\&. Use menu()\&. .IP .IP "\f(CWstarttable()\fP" DEPRECATED\&. Use table()\&. .IP .IP "\f(CWsubs(text)\fP" Sets text in subscript in supporting formats .IP .IP "\f(CWsubsect(title)\fP" Starts a new subsection\&. Other sectioning commands are \f(CWsubsubsect\fP and \f(CWsubsubsubsect\fP\&. .IP .IP "\f(CWsubsubsect(title)\fP" Starts a sub\-subsection\&. .IP .IP "\f(CWsubsubsubsect(title)\fP" Starts a sub\-sub\-sub\-subsection\&. This level of sectioning is not numbered, in contrast to `higher\(cq\& sectionings\&. .IP .IP "\f(CWsups(text)\fP" Sets text in superscript in supporting formats .IP .IP "\f(CWtable(nColumns)(alignment)(Contents)\fP" The \f(CWtable()\fP\-macro defines a table\&. Its 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 \f(CWl\fP for left\-alignment, \f(CWc\fP for centered\-alignment and \f(CWr\fP 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 specialized \f(CWsetmanalign()\fP macro\&. .IP .IP "\f(CWtcell(text)\fP" Roff helper to set a table textcell, i\&.e\&., a paragraph\&. For LaTeX special table formatting p{} should be used\&. .IP .IP "\f(CWtelycommand(cmd)\fP" Writes \f(CWcmd\fP to the output when converting to tely\&. The \f(CWcmd\fP is not further expanded by Yodl\&. .IP .IP "\f(CWTeX()\fP" The TeX symbol\&. .IP .IP "\f(CWtexinfocommand(cmd)\fP" Writes \f(CWcmd\fP to the output when converting to texinfo\&. The \f(CWcmd\fP is not further expanded by Yodl\&. .IP .IP "\f(CWtindex()\fP" Generate an index entry for index t\&. .IP .IP "\f(CWtitleclearpage()\fP" Forces the generation of a \f(CWclearpage()\fP directive following the title of a document\&. This is already the default in \f(CWbook\fPs and \f(CWreport\fPs, but can be overruled with \f(CWnotitleclearpage()\fP\&. When present, must appear in the \fIpreamble\fP; i\&.e\&., before the document type is stated with \f(CWarticle\fP, \f(CWbook\fP or \f(CWreport\fP\&. .IP .IP "\f(CWtocclearpage()\fP" With the LaTeX convertor, a \f(CWclearpage()\fP directive if inserted, immediately following the document\(cq\&s table of contents\&. This is already the default in all but the \f(CWarticle\fP document type, but it can be overruled by \f(CWnotocclearpage()\fP\&. When present, it must appear in the \fIpreamble\fP; i\&.e\&., before the document type is stated with \f(CWarticle\fP, \f(CWbook\fP or \f(CWreport\fP\&. With other convertors than the LaTeX convertor, it is ignored\&. .IP .IP "\f(CWtt(text)\fP" Sets \f(CWtext\fP in teletype font, and prevents it from being expanded\&. For unbalanced parameter lists, use \f(CWCHAR(40)\fP to get \f(CW(\fP and \f(CWCHAR(41)\fP to get \f(CW)\fP\&. .IP .IP "\f(CWtxtcommand(cmd)\fP" Writes \f(CWcmd\fP to the output when converting to txt\&. The \f(CWcmd\fP is not further expanded by Yodl\&. .IP .IP "\f(CWurl(description)(locator)\fP" In LaTeX documents the \f(CWdescription\fP is sent to the output\&. For HTML, a link is created with the descriptive text \f(CWdescription\fP and pointing to \f(CWlocator\fP\&. The \f(CWlocator\fP should be the full URL, including service; e\&.g, \f(CWhttp://www\&.icce\&.rug\&.nl\fP, but excluding the double quotes that are necessary in plain HTML\&. Use the macro \f(CWlink\fP to create links within the same document\&. For other formats, something like \fIdescription [locator]\fP will appear\&. .IP .IP "\f(CWverb(text)\fP" Sets \f(CWtext\fP in verbatim mode: not subject to macro expansion or character table expansion\&. The text 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\&. For unbalanced parameter lists, use \f(CWCHAR(40)\fP to get \f(CW(\fP and \f(CWCHAR(41)\fP to get \f(CW)\fP\&. .IP .IP "\f(CWverbinclude(filename)\fP" 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 \f(CWverb(\&.\&.\&.)\fP, when the text to set in verbatim mode is better kept in a separate file\&. .IP \fBNOTE:\fP Starting with 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 \f(CW#include\fP directive operates; it has the disadvantage that it may break some current documents\&. Conversion, however is simple but can be avoided altogether if Yodl\(cq\&s \f(CW\-L\fP (\f(CW\-\-legacy\-include\fP) option is used\&. .IP .IP "\f(CWverbpipe(command)(text)\fP" Pipe text through command, but don\(cq\&t expand the output\&. .IP .IP "\f(CWvindex()\fP" Generate an index entry for index v\&. .IP .IP "\f(CWwhenhtml(text)\fP" Sends \f(CWtext\fP to the output when in HTML conversion mode\&. The text is further expanded if necessary\&. .IP .IP "\f(CWwhenlatex(text)\fP" Sends \f(CWtext\fP to the output when in LATEX conversion mode\&. The text is further expanded if necessary\&. .IP .IP "\f(CWwhenman(text)\fP" Sends \f(CWtext\fP to the output when in MAN conversion mode\&. The text is further expanded if necessary\&. .IP .IP "\f(CWwhenms(text)\fP" Sends \f(CWtext\fP to the output when in MS conversion mode\&. The text is further expanded if necessary\&. .IP .IP "\f(CWwhensgml(text)\fP" Sends \f(CWtext\fP to the output when in SGML conversion mode\&. The text is further expanded if necessary\&. .IP .IP "\f(CWwhentely(text)\fP" Sends \f(CWtext\fP to the output when in TELY conversion mode\&. The text is further expanded if necessary\&. .IP .IP "\f(CWwhentexinfo(text)\fP" Sends \f(CWtext\fP to the output when in TEXINFO conversion mode\&. The text is further expanded if necessary\&. .IP .IP "\f(CWwhentxt(text)\fP" Sends \f(CWtext\fP to the output when in TXT conversion mode\&. The text is further expanded if necessary\&. .IP .IP "\f(CWwhenxml(text)\fP" Sends \f(CWtext\fP to the output when in XML conversion mode\&. The text is further expanded if necessary\&. .IP .IP "\f(CWxit(itemname)\fP" 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 "\f(CWxmlcommand(cmd)\fP" Writes \f(CWcmd\fP to the output when converting to xml\&. The \f(CWcmd\fP is not further expanded by Yodl\&. .IP .IP "\f(CWxmlmenu(order)(title)(menulist)\fP" 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 "\f(CWxmlnewfile()\fP" 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 \f(CWchapter\fP definition\&. .IP .IP "\f(CWxmlsetdocumentbase(name)\fP" Defines \f(CWname\fP as the XML document base\&. No default\&. Only interpreted with xml conversions\&. It is used with the figure and xmlmenu macros\&. .IP .IP "\f(CWxmltag(tag)(onoff)\fP" Similar to \f(CWhtmltag\fP, 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 \fByodlstriproff\fP(1), \fByodl\fP(1), \fByodlbuiltins\fP(7), \fByodlconverters\fP(1), \fByodlletter\fP(7), \fByodlmanpage\fP(7), \fByodlpost\fP(1), \fByodlverbinsert\fP(1)\&. .PP .SH "BUGS" .PP \- .PP .SH "AUTHOR" .PP Frank B\&. Brokken (f\&.b\&.brokken@rug\&.nl),