The following list shows all macros of the package in alphabetical order.
abstract(text)
: article
or report
document. Abstracts are
not implemented for book
s or manpage
s. Must appear before
starting the document with the article
or report
macro.
affiliation(site)
: article
, report
or book
. The affiliation is only printed when the
author field is not empty.
appendix()
: article(title)(author)(date)
: (n)sect
. In HTML
conversions only one output file is written.
bind(text)
: bf(text)
: text
in boldface.
book(title)(author)(date)
: (n)chapter
,
(n)part
being optional. In HTML output files are created for each
chapter.
center(text)
: text
centered, when the output format permits. Use nl()
in the
text to break lines.
chapter(title)
: book
s or report
s.
lchapter(label)(title)
: book
s or report
s, setting a label at
the beginning of the chapter.
cite(1)
: clearpage()
: setlatexverbchar(char)
: \verb
sequences
setrofftableoptions(optionlist)
: allbox
code(text)
: text
in code font, and prevents it from being expanded.
For unbalanced parameter lists, use CHAR(40)
to get
(
and CHAR(41)
to get )
.
def(macroname)(nrofargs)(redefinition)
: macroname
as a macro, having nrofargs
arguments, and
expanding to redefinition
. This macro is a shorthand for
DEFINEMACRO
.
An error occurs when the macro is already defined. Use
redef()
to unconditionally define or redefine a macro.
description(list)
: list
as a description list. Use dit(item)
to
indicate items in the list.
dit(itemname)
: itemname
in a descriptive list. The list is either
enclosed by startdit()
and enddit()
, or is an argument to
description()
.
ellipsis()
: eit()
: starteit()
and endeit()
, or is an argument to enumerate()
.
em(text)
: text
as emphasized, usually italics.
email(address)
: address
in a <a href="mailto=..">
locator. In
other output formats, the address
is sent to the output. The email
macro
is a special case of url
.
nemail(name)(address)
: endcenter()
: startcenter()
.
enddit()
: startdit()
.
endeit()
: starteit()
.
endit()
: startit()
.
endmenu()
: startmenu()
.
enumerate(list)
: list
as an enumerated list. Use eit()
to indicate items in
the list.
fig(label)
: figure ref(label)
and just makes the typing
shorter, as in see fig(schematic) for ..
See getfigurestring()
and
setfigurestring()
for the figure
text.
figure(file)(caption)(label)
: file
as a figure in the current document, using the
descriptive text caption
. The label
is defined as a placeholder for the
figure number and can be used in a corresponding ref
statement. Note that
the file
must be the filename without extension: YODL will supply .gif
when in HTML mode, or .ps
when in LaTeX mode. Figures in other modes are
not (yet) implemented.
file(text)
: text
as filename, usually boldface.
footnote(text)
: text
as a footnote, or in parentheses when the output format
does not allow footnotes.
gagmacrowarning(name name ...)
: yodl
program from printing cannot expand possible user
macro. E.g., if you have in your document the file(s) are ..
then you
might want to put before that: gagmacrowarning(file)
. Synonym for
NOUSERMACRO
.
getaffilstring()
: setaffilstring()
. Currently, it is relevant only for txt.
getauthorstring()
: setauthorstring()
. Currently, it is relevant only for txt.
getchapterstring()
: setchapterstring()
.
getdatestring()
: setdatestring()
. Currently, it is relevant only for txt.
getfigurestring()
: fig()
macro. The string can be redefined using the setfiguretext()
macro.
getpartstring()
: setpartstring()
.
gettitlestring()
: settitlestring()
. Currently, it is relevant only for txt.
gettocstring()
: settocstring()
.
htmlbodyopt(option)(value)
: option="value"
to the options of the <body ...>
tag in HTML
files. Useful options are, e.g., fgcolor
and bgcolor
, whose values
are expressed as #rrggbb
, where rr
are two hexadecimal digits of
the red component, gg
two hexadecimal digits of the green component,
and bb
two hexadecimal digits of the blue component.
htmlcommand(cmd)
: cmd
when converting to HTML. The cmd
is not further parsed
by YODL.
htmlnewfile()
: chapter
definition.
htmltag(tagname)(start)
: tagname
as a HTML tag, enclosed by <
and >
. When
start
is zero, the tagname
is prefixed with /
.
includefile(file)
: file
and defines a label with the same name. The default
extension .yo
is supplied if necessary.
includeverbatim(file)
: file
into the output. No processing is done, file
should
be in preformatted form, e.g.: whenhtml(includeverbatim(foo.html)).
cindex()
:
findex()
:
kindex()
:
pindex()
:
tindex()
:
vindex()
:
it()
: startit()
and endit()
, or it is an argument to itemize()
.
mit()
: startmenu()
and endmenu()
.
itemize(list)
: list
as an itemized list. Use it()
to indicate items in the
list.
label(labelname)
: labelname
as an anchor for a link
command, or to stand for the last numbering of a section or figure in a
ref
command.
LaTeX()
:
latexcommand(cmd)
: cmd
to the output when converting to LaTeX. The cmd
is not
further expanded by YODL.
latexdocumentclass(class)
: \documentclass{...}
setting to class
. Normally the class is
defined by the macros article
, report
or book
. This macro
is an escape route incase you need to specify your own document class
for LaTeX. This option is a modifier and must
appear before the article
, report
or book
macros.
latexpackage(options)(name)
: epsf
. This command must appear before the document type is
stated by article
, report
, etc..
latexoptions(options)
: documentclass[options]
. Junk this?
This command must appear before the document type is
stated by article
, report
, etc..
latexlayoutcmds(latexcommands)
: latexcommands
are pasted right after the
\documentclass
stanza. The default is, of course, no local LaTeX
commands. Note that this macro does not overrule my favorite LaTeX
layout. Use nosloppyhfuzz()
and standardlayout()
to disable my favorite
LaTeX layout.
langle()
:
rangle()
:
link(description)(labelname)
: description
is created that
points to the place where labelname
is defined using the label
macro.
Using link
is similar to url
, except that a hyperlink
is set pointing to a location in the same document. For output formats other
than HTML, only the description
appears.
lref(description)(labelname)
: ref
and link
macros. In HTML
output a clickable link with the text description
and the label value
is created that points to the place where labelname
is defined using
the label
macro. For output formats other than HTML, only the
description
and the label value appears.
mailto(address)
: mailto
address for HTML output. Must appear
before the document type is stated by article
, report
, etc..
mancommand(cmd)
: cmd
to the output when converting to man. The cmd
is not
further expanded by YODL.
manpage(title)(section)(date)(source)(manual)
: section
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 not (n)sect
etc., but manpage...()
. The first section
must be the manpagename
, the last section must be the
manpageauthor
. The standard manpage for section 1 contains the following
sections (in the given order): manpagename
, manpagesynopsis
,
manpagedescription
, manpageoptions
, manpagefiles
,
manpageseealso
, manpagediagnostics
, manpagebugs
,
manpageauthor
. Optional extra sections can be added with
manpagesection
. Standard manpageframes for several manpagesections
are provided in /usr/local/share/yodl/manframes
.
manpageauthor()
: manpage
document. Must be the last section
of a manpage
.
manpagebugs()
: manpage
document.
manpagedescription()
: manpage
document.
manpagediagnostics()
: manpage
document.
manpagefiles()
: manpage
document.
manpagename(name)(short description)
: manpage
document. The short description is
used by, e.g., the whatis
database.
manpageoptions()
: manpage
document.
manpagesection(SECTIONNAME)
: SECTIONNAME
in a manpage
document. This macro can be used to augment `standard' manual pages with extra
sections, e.g., EXAMPLES. Note that the name of the extra section should
appear in upper case, which is consistent with the normal typesetting of
manual pages.
manpageseealso()
: manpage
document.
manpagesynopsis()
: manpage
document.
makeindex()
:
mbox()
:
menu(list)
: list
as a menu.
metaCOMMENT(text)
:
metalC(text)
:
mscommand(cmd)
: cmd
to the output when converting to ms. The cmd
is not
further expanded by YODL.
nchapter(title)
: book
or report
) without generating a
number before the title and without placing an entry for the chapter in
the table of contents.
nl()
:
node(previous)(this)(next)(up)
: this
, and links to nodes previous
, next
and (up), for the node
command.
nodename(text)
: nodename(Options)manpagesynopsis()Currently used in texinfo descriptions only.
nodeprefix(text)
: nodeprefix(LilyPond) sect(Overview)Currently used in texinfo descriptions only.
nodetext(text)
: nodetext(The GNU Music Typesetter)chapter(LilyPond)Currently used in texinfo descriptions only.
nop(text)
:
nosloppyhfuzz()
: nosloppyhfuzz()
appears
before stating the document type, LaTeX complaints are `vanilla'.
notableofcontents()
: manpage
and plainhtml
documents. When present, this option must
appear before stating the document type with article
, report
etc..
notitleclearpage()
: clearpage()
instruction after the typesetting
of title information. This instruction is default in all non article
documents. When present, must appear before stating the document type with
article
, book
or report
.
notocclearpage()
: clearpage()
instruction after the typesetting
of a table of contents. This instruction is default in all
documents. When present, must appear before stating the document type with
article
, book
or report
.
noxlatin()
: xlatin1.tex
. Normally this file gets included in the LateX output
files to ensure the conversion of high ASCII characters (like é) to
LaTeX-understandable codes. (The file xlatin1.tex
comes with the YODL
distribution.)
nparagraph(title)
:
npart(title)
: book
document, but without numbering it and without
entering the title of the part in the table of contents.
nsect(title)
: title
nor
an entry in the table of contents. Further sectioning commands are
nsubsect
, nsubsubsect
and nsubsubsubsect
.
nsubsect(title)
:
nsubsubsect(title)
:
nsubsubsubsect(title)
:
paragraph(title)
:
part(title)
: book
document.
plainhtml(title)
: article
, except that an author- and
date field are not needed.
printindex()
:
quote(text)
:
redef(macro)(nrofarguments)(redefinition)
: macro
to expand to redefinition
.
Similar to def
, but any pre-existing definition is overruled. This command
is a shorthand for redefinemacro
.
redefinemacro(nrofargs)(redefinition)
: macro
to expand to redefinition
.
Similar to def
, but any pre-existing definition is overruled. Use
ARG
x in the redefinition part to indicate where the arguments should
be pasted. E.g., ARG1
places the first argument, ARG2
the second
argument, etc..
ref(labelname)
: labelname
. Use label
to define a label.
report(title)(author)(date)
: chapter
.
roffcmd(dotcmd)(sameline)(secondline)(thirdline)
: dotcmd
- the command itself, e.g., .IP
; sameline
- when not
empty, set following the dotcmd
on the same line; secondline
- when
not empty, set on the next line; thirdline
- when not empty, set on the
third line. Note that dotcmd
and thirdline
are not further expanded by
YODL, the other arguments are.
sc(text)
: text
in small caps (or tt).
sect(title)
:
lsect(label)(title)
:
setaffilstring(name)
: name
as the `affiliation information' string, by default
AFFILIATION INFORMATION. E.g., after setaffilstring(AFILIAÇÃO)
,
YODL outputs this portuguese string to describe the affiliation information.
Currently, it is relevant only for txt.
setauthorstring(name)
: name
as the `Author information' string, by default
AUTHOR INFORMATION. E.g., after setauthorstring(AUTOR)
,
YODL outputs this portuguese string to describe the author information.
Currently, it is relevant only for txt.
setchapterstring(name)
: name
as the `chapter' string, by default Chapter. E.g., after
setchapterstring(Hoofdstuk)
, YODL gains some measure of national language
support for Dutch. Note that LaTeX support has its own NLS, this macro doesn't
affect the way LaTeX output looks.
setdatestring(name)
: name
as the `date information' string, by default
DATE INFORMATION. E.g., after setdatestring(DATA)
,
YODL outputs this portuguese string to describe the date information.
Currently, it is relevant only for txt.
setfigurestring(name)
: name
as the `figure' text, used e.g. in figure captions. E.g.,
after setfigurestring(Figuur)
, YODL uses Dutch names for figures.
sethtmlfigureext(ext)
: .gif
. Note
that a leading dot must be included in ext
. The new extension takes effect
starting with the following usage of the figure
macro.
sethtmlfigurealign(alignment)
: bottom
. Other
options depend on the client browser, but top
and center
should be
universal.
setlanguage(language)
:
setlatexfigureext(ext)
: .ps
. The dot must be included in t new extension ext
. The
new extension takes effect starting with a following usage of the figure
macro.
setpartstring(name)
: name
as the `part' string, by default Part. E.g., after
setpartstring(Teil)
, YODL identifies parts in the German way. Note that
LaTeX output does its own national language support; this macro doesn't affect
the way LaTeX output looks.
settitlestring(name)
: name
as the `title information' string, by default
TITLE INFORMATION. E.g., after settitlestring(TÍTULO)
,
YODL outputs this portuguese string to describe the title information.
Currently, it is relevant only for txt.
settocstring(name)
: name
as the `table of contents' string, by default Table of
Contents. E.g., after settocstring(Inhalt)
, YODL identifies the table
of contents in the German way. Note that LaTeX output does its own national
language support; this macro doesn't affect the way LaTeX output looks.
sgmlcommand(cmd)
: cmd
to the output when converting to SGML. The cmd
is not
further expanded by YODL.
sgmltag(tag)(onoff)
: htmltag
, but used in the SGML converter.
standardlayout()
: standardlayout()
directive must appear
before stating the document type as article
, report
, etc..
startcenter()
: endcenter()
to stop centering text.
startdit()
: dit(item)
to set items in the list, and
use enddit()
to end the list.
starteit()
: eit()
in the list to indicate items, and
use endeit()
to end the list.
startit()
: it()
in the list to indicate items, and use
endit()
to end the list.
startmenu()
: mit()
in the menu to indicate menu items, and use
endmenu()
to end the menu.
sups(text)
:
subs(text)
:
subsect(title)
: subsubsect
and subsubsubsect
.
lsubsect(label)(title)
: subsubsect
and subsubsubsect
. A label is added just before the
subsection.
subsubsect(title)
:
lsubsubsect(label)(title)
:
subsubsubsect(title)
:
lsubsubsubsect(label)(title)
:
texinfocommand(cmd)
: cmd
to the output when converting to Texinfo. The cmd
is not
further expanded by YODL.
TeX()
:
titleclearpage()
: clearpage()
directive following the title of a
document. This is already the default in book
s and report
s, but can be
overruled with notitleclearpage()
. When present, must appear in the
preamble; i.e., before the document type is stated with article
,
book
or report
.
tocclearpage()
: clearpage()
directive following the table of
contents in a
document. This is already the default in all document types, but can be
overruled with notocclearpage()
. When present, must appear in the
preamble; i.e., before the document type is stated with article
,
book
or report
.
tt(text)
: text
in teletype font, and prevents it from being expanded.
For unbalanced parameter lists, use CHAR(40)
to get
(
and CHAR(41)
to get )
.
txtcommand(cmd)
: cmd
to the output when converting to ASCII. The cmd
is not further expanded by YODL.
url(description)(locator)
: description
is sent to the output. For HTML,
a link is created with the descriptive text description
and pointing
to locator
. The locator
should be the full URL, including
service; e.g, http://www.icce.rug.nl
, but excluding the double
quotes that are necessary in plain HTML. Use the macro link
to create
links within the same document. For other formats, something like
description [locator] will appear.
lurl(locator)
:
verb(text)
: text
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 CHAR(40)
to get (
and CHAR(41)
to get )
.
verbinclude(filename)
: verb(...)
, when the text to set in verbatim mode is
better kept in a separate file.
verbpipe(command)(text)
:
whenhtml(text)
: text
to the output when in HTML conversion mode. The text is
further expanded if necessary.
whenlatex(text)
: text
to the output when in LaTeX conversion mode. The text is
further expanded if necessary.
whenman(text)
: text
to the output when in man conversion mode. The text is
further expanded if necessary.
whenms(text)
: text
to the output when in ms conversion mode. The text is further
expanded if necessary.
whensgml(text)
: text
to the output when in SGML conversion mode. The text is
further expanded if necessary.
whentexinfo(text)
: text
to the output when in Texinfo conversion mode. The text is
further expanded if necessary.
whentxt(text)
: text
to the output when in ASCII conversion mode. The text is
further expanded if necessary.
starttable(nColumns)(LaTexAllignment)
: nColumns
characters (l
, r
, or c
). It is used internally by table()
endtable()
: table()
table(nColumns)(LaTeXallignment)(Contents)
: table()
-macro defines a table. Its first argument specifies
the number of columns in the table. Its second argument specifies
the LaTeX-alignment
specifications: use l
for left-alignment, r
for right alignment, c
for centered-alignment. The third argument defines the contents of the table
which are the rows, each containing column-specifications.
row(Cells)
: Cells
contains the cells of one row of the table
cell(element)
:
tcell(text)
:
cells(nColumns)(element)
: nColumns
columns. See also
leftcells()
and rightcells()
.
columnline(from)(to)
: rowline()
.
rowline()
: cellsline()
.
Please send Yodl questions and comments to yodl@icce.rug.nl.
Please send comments on these web pages to (address unknown)
Copyright (c) 1997, 1998, 1999 Karel Kubat and Jan Nieuwenhuizen.
Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.