This section lists a number of macros that can be used to modify the looks of
your document. When used, these macros must appear before stating the
document type with article
, report
, book
, manpage
or
plainhtml
.
abstract(text)
: This macro is relevant for all output formats.
The text
is added to the document after the title, author and date
information, but before the table of contents. The abstract is usually set
as a quote, in italics font (though this depends on the output format).
Abstracts are supported in article
s and report
s, but not in
other document types. I.e., if you need introductory text in a book
,
you should start with a non-numbered chapter that holds this text.
affiliation(site)
: This macro is relevant for article
,
report
and book
documents. It defines the affiliation of the
author. The site
information appears in the title, below the author's
name.
htmlbodyopt(option)(value)
: This macro adds option="value"
to
the <body>
tag that will be generated for HTML output. The HTML
converter generates <body>
tags each time that a new file is started;
i.e., at the top of the document and at each chapter-file. Different HTML
browsers support different <body>
tag options, but useful ones may be
e.g.:
htmlbodyopt(fgcolor)(#000000) htmlbodyopt(bgcolor)(#FFFFFF)
This defines the foreground color as pure white (red/green/blue all 0) and
the background color as black (red/green/blue all hexadecimal FF, or 255).
Another useful option may be htmlbodyopt(background) (some.gif)
,
defining some.gif
as the page background.
See the documentation on HTML for more information.
Note that the value
is automatically surrounded by double quotes when
this macro is used. There is no need to type them.
latexdocumentstyle(style)
: This macro forces the
\documentstyle{...}
setting in LaTeX output to style
. E.g., at the ICCE
we have a local article
-derivate called artikel1
. Using
latexdocumentstyle(artikel1) article(..title..) (..author..) (..date..)
will start an article as far as Yodl is concerned, but will use artikel1
in
the LaTeX output.
latexlayoutcmds(commands)
: This macro can be used to specify your
own LaTeX layout commands. When present, the commands
are placed in
LaTeX output following the \documentstyle
stanza. (Thanks,
Bernhard Reiter <breiter@mathematik.Uni-Osnabrueck.DE>
).
latexoptions(options)
: This macro is only relevant for LaTeX
output formats, it is not expanded in other formats. The options
are
used in LaTeX's \documentstyle
preamble; e.g., useful options may be
dina4
or epsf
. To specify several options, separate them by a
comma (this is a LaTeX convention).
Backward compatibility note: At the ICCE, we've used Linuxdoc-SGML for some time. The modifier
latexoptions(linuxdoc-sgml,qwertz)
approximates the LaTeX output that this SGML variant produces. The style
files linuxdoc-sgml.sty
and qwertz.sty
must of course be in one of
the TEXINPUTS
directories.
mailto(email)
: The mailto
macro is only expanded in HTML
documents. It defines where mail about the document should go to.
nosloppyhfuzz()
: By default, the LaTeX output contains the text
\hfuzz=4pt
which is placed there by the macro package. This suppresses overfull hbox warnings of LaTeX when the overfull-ness is less than 4pt. I find this useful.
This macro has no consequences for non-LaTeX formats.
Use nosloppyhfuzz()
to get `plain' LaTeX warnings about overfull
hboxes.
notableofcontents()
: As the name suggests, this macro suppresses
the generation of the table of contents. For HTML that means that no
clickable index of sections appears after the document title.
The table of contents is by default suppressed in plainhtml
and
manpage
documents.
notitleclearpage()
: Normally, Yodl inserts a clearpage()
directive after typesetting title information in book
or report
documents, but not in article
documents. Use notitleclearpage
to
suppress this directive.
notocclearpage()
(Read as: no-toc-clearpage, read
toc
as table of contents.): In all document types, Yodl inserts a
clearpage()
directive following the table of contents. Use
notocclearpage()
to suppress that.
noxlatin()
: The LaTeX output contains by default the stanza to
include the file xlatin1.tex
, distributed with Yodl. This file maps
Latin-1 characters to LaTeX-understandable codes and makes sure that you
can type characters such as ü
, and still make them processable by
LaTeX. If you don't want this, put noxlatin()
in the preamble.
standardlayout()
: This is another LaTeX option. I like my
paragraph starts not to be indented, and I like more space between
paragraphs. Use standardlayout()
to get `vanilla' LaTeX layout.
This macro has no consequences for non-LaTeX formats.
titleclearpage()
: Forces the insertion of a clearpage()
directive after the title information has been typeset. This behavior is the
default in book
and report
documents. See also
notitleclearpage()
.
tocclearpage()
: Forces the insertion of a clearpage()
directive
following the table of contents. This behavior is default in all document
types; the macro is provided for consistency reasons with
(no)titleclearpage()
.
Note again that when present, the modifiers must appear before the document type definition.
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.