The following is a list of commands that don't fall in one of the above categories.
  • clearpage(): This macro starts a new page in LaTeX. For HTML, a horizontal rule is shown. (Note that the macro package sometimes inserts new pages by itself; e.g., following a table of contents. See also section ?? for a discussion of (no)titleclearpage() and (no)tocclearpage().)
  • def(macro)(nrofarguments)(definition): This defines a new macro macro having nrofarguments arguments, and expanding to definition. The markers ARGx, where x is 1, 2, etc., can be used in the definition part to indicate where arguments should be pasted in. This macro is a shorthand for DEFINEMACRO, see section ??.
  • footnote(text): This macro sets text as a footnote when the output format allows it. When not, the text is set in parentheses.
  • gagmacrowarning(name name ...): This macro suppresses yodl's warnings cannot expand possible user macro name, where name is a candidate macro name. gagmacrowarning is a synonym for NOUSERMACRO, described in section ??. E.g., if your document contains "as for manpages, see sed(1), tr(1) and awk(1)", and if you get tired of warnings about possible user macros sed, tr and awk, try the following:
    gagmacrowarning(sed tr awk)
    .
    .
    As for manpages, see sed(1), tr(1) and awk(1).
    

  • htmlnewfile(): Starts a new subfile in HTML output. This stanza as also automatically generated when the HTML converter encounters a chapter() directive. Using htmlnewfile(), the output can be split at any point. However make sure that the subfile is still reachable; e.g., by creating a clickable link with label and ref, or label and link.

  • includefile(file): Includes file and defines a label (see the label macro) with the same name. Furthermore, a message about the inclusion is shown on the screen. The file is searched for relative to the directory where the yodl run was started and in the system-wide include directory. The default extension .yo is supplied if necessary.

    This macro is handy in the following situation:

    chapter(Introduction)
    includefile(intro)
    

    This fragment starts a chapter and includes a file. The label name intro can also be used to refer to the chapter. The includefile stanza should therefore appear immediately following the corresponding sectioning command.

  • nl(): Forces a new line. Some output formats may produce an error upon the usage of nl() in `unexpected' places; e.g., LaTeX won't allow new lines in the footnote text (as defined in the footnote macro). Using nl() in running text should however be ok.

    Example:

    This line is nl()
    broken in two.
    

    This line is
    broken in two.

  • redefinemacro(macro)(nrofargs)(redef): This command (re)defines a macro, expecting nrofargs arguments, to redef. If a previous definition of the macro existed, it is overruled.

    Example:

    redefinemacro(clearpage)(0)(\ 
        em(---New page starts here---))
    

    Use ARGx in the redef part to indicate where all arguments should occur, as in the following imaginary macro to typeset a literature reference:

    redefinemacro(litref)(3)(\ 
        Title: bf(ARG1) nl()\ 
        Author(s): em(ARG2) nl()\ 
        Published by: ARG3)
    .
    .
    .
    litref(Java in a Nutshell)
          (David Flanagan)
          (O'Reilly & Associates, Inc.)
    

    The redefinemacro statement also has a shorthand called redef.


  • Go back to index of Yodl.

    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.


    This page was built from Yodl-1.31.18 by

    <(address unknown)>, Thu Apr 9 11:00:27 2009 EDT.