Next Up Previous Contents
Next: C.1.58 Element routinelist
Up: C.1 Element listing
Previous: C.1.56 Element quote
[ID index][Keyword index]

C.1.57 Element ref

C.1.57.1 Description

A reference to another point in the same document. If the element has any content, this will be used as the link text, but if it has no content, the link text will be generated, based on the link target. Note, by the way, that the link is to a complete element of the document, rather than a point of the document.

The list of elements you can use as the target of a reference is the same as the list of elements which have `id' attributes, and is currently abstract, sect, subsect, subsubsect, subsubsubsect, appendices, figure, table, mlabel, routine, dt, and li. You can also refer to p elements, though in this case the reference will actually be to the section which contains the paragraph. The fact that you can refer to routine elements using this means only that you can do cross-references within programcode documents.

When you give the element no content, the generated text will be of the form `section XXX', or `equation XXX'. That is, the generated texts should be grammatically consistent with each other. Note, however, that this mechanism for generating text is intended to be a shorthand, with pretensions to no more than being correct most of the time; sometimes you will need to help it out. You may prefer, on the other hand, to specify the link text (almost) every time; in this case, I'm sure you don't need me to remind you that link text like `more details <ref id="somewhere" >here</ref>' is unlikely to be terrifically useful in a paper version of the document.

Should you want to include different link text depending on the target medium, you will have to have more than one ref element, each inside a suitable span element.

You cannot link to code prologues using this mechanism. For that, see the coderef element.

Example:

See also <ref id=other.ref/> for more details.
There's yet more information 
<ref id=even.more>elsewhere</ref>

C.1.57.2 Parents

attribution, cite, code, dt, em, entry, foreign, kbd, line, p, px, quote, span, strong, verbatim

C.1.57.3 Content

( #pcdata | em | strong | quote | code | kbd | cite | m | angle | foreign) *

ref
 |_(#PCDATA |
 |__em |
 |__strong |
 |__quote |
 |__code |
 |__kbd |
 |__cite |
 |__m |
 |__angle |
 |__foreign)*

C.1.57.4 Attribute ref/valueref

C.1.57.5 Attribute ref/rflocsrc

C.1.57.6 Attribute ref/hynames

C.1.57.7 Attribute ref/loctype

C.1.57.8 Attribute ref/text

C.1.57.9 Attribute ref/hytime

C.1.57.10 Attribute ref/id

The ID of the element to link to.

C.1.57.11 Attribute ref/ref-title


Next Up Previous Contents
Next: C.1.58 Element routinelist
Up: C.1 Element listing
Previous: C.1.56 Element quote
[ID index][Keyword index]
The Starlink SGML Set
Starlink System Note 70
Norman Gray, Mark Taylor
21 April 1999. Release DR-0.7-13. Last updated 24 August 2001