References such as see ... for more information are very common in documents. The Yodl package supports three mechanisms to accomplish such references:

Labels and references:
Labels can be defined in a document as a placeholder for the last number that was used in a sectioning command. At other points in the document, references to those labels are used. The reference expands to the number, as in see section 1.3. This mechanism is available in all but the most primitive output formats (e.g, the ASCII converter will ignore the requests). Furthermore, the numeric reference (1.3 in the example of the previous paragraph) is in HTML a clickable reference that leads to the mentioned section.

Labels and links:
This mechanism can be used to set links in a document without using the number of a sectioning command, as in see the introduction for more information, with the introduction being a clickable link to some label. This mechanism of course only leads to a clickable link in HTML: in other formats the text see the etc. is just typeset as is.

URLs:
Universal Resource Locators (URLs) are used to create links to other HTML documents or services, à la the HTML <a href=..> method. The URLs of course only lead to clickable links in HTML output; in other output formats only some descriptive text appears.
The following macros implement the above mechanisms:

Always keep in mind that the name of a label must be exactly identical in both the label macro and in the ref or link macro. Other than that, the name is irrelevant.

Note also the macro package also implements a macro includefile, that includes a file and automatically creates a label. That means that a Yodl file like:

chapter(Introduction)
    sect(Welcome)
    includefile(welcome)

chapter(Technical information)
includefile(techinfo)

implicitly creates two labels, named welcome and techinfo.

Below are some randoms dont's about labels and references:

undef(x)


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

Dmitry V. Levin <(address unknown)>, Mon Oct 21 20:34:42 2002 MSD.