 |
Linking primitives |
 |
| Operator |
Arity |
Accessible |
|
Process |
Usage |
|
|
border |
children |
|
|
| label |
1 |
Yes |
None |
Typesetting |
Logical |
| reference |
1 |
Yes |
None |
Typesetting |
Logical |
| pageref |
1 |
Yes |
None |
Typesetting |
Logical |
| hlink |
2 |
Yes |
First |
Typesetting |
Logical |
| include |
1 |
Yes |
None |
Typesetting |
Logical |
|
|
Table 1. Linking primitives
|
(reference target)
The operand must evaluate to a literal string, it is used as a
target name which can be referred to by reference,
pageref and hlink tags.
Label names should be unique in a document and in a project.
Examples in this section will make references to an example label named
“there”.
(reference to a name)
The operand must evaluate to a literal string, which is the name of
a label defined in the
current document or in another document of the current project.
The reference is typeset
as the value of the variable the-label
at the point of the target label.
The the-label variable is set by many
numbered structures: sections, figures, numbered equations, etc.
A reference
reacts to mouse clicks as an hyperlink.
(page reference to a name)
The operand must evaluate to a literal string, which is the name of
a label defined in the
current document or in another document of the current project.
The pageref is typeset as the number of the page
containing the target label.
Note that page numbers are only computed when the document is
typeset with page-breaking, that is not in “automatic”
or “papyrus” page type.
A pageref
reacts to mouse clicks as an hyperlink.
(inline hyperlink)
This primitive produces an hyperlink with the visible text content pointing to url.
The content is typeset as inline url. The url must
evaluate to a literal string in URL syntax and can
point to local or remote documents, positions inside documents can
be be specified with labels.
The following examples are typeset as hyperlinks pointing to the
label “there”, respectively in the same document, in a
document in the same directory, and on the web.
If the document is not editable, the hyperlink is
traversed by a simple click, if the document is editable, a
double-click is required.
(include another document)
The operand must be a literal string and is interpreted
as a file name. The content of this file is typeset in place of the
include tag, which must be
placed in block context
.
© 2004 David Allouche
Permission is
granted to copy, distribute and/or modify this document under the terms of
the GNU Free Documentation License, Version 1.1 or any later version
published by the Free Software Foundation; with no Invariant Sections,
with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the
license is included in the section entitled "GNU Free Documentation
License".