ref

Name

ref -- Reference to another Story Element

Synopsis

Content Model
ref ::=
   EMPTY
Attributes

Name

Type

Default

idIDREFRequired
fmtNMTOKENNone
linkyes|noNone

Description

The ref tags are one of the most important features of the Story SGML. They allow the linking of one story element to the other. The linking can refer to different names, allowing seamless integration with the text on the output.

Processing expectations

The ref tags are used to create references, when producing output they are expanded to one or more names in the referred story element. What names will be used is governed by the fmt attribute. If the link attribute has a value of yes the expanded name will be made into a hyper-link.

Attributes

id

The id attribute must match the value of the same attribute on the story element. This value is the one that links the refence to the referred object.

fmt

fmt specifies the which name must be used when expanding the reference. If no value is used, the value of the fmt of the referred story element.

link

Determines if the tag should be transformed into a hiper-link during processing.

See Also

names

Examples

For the examples lets assume a story element link the following:

<persona id="P01" fmt="short">
  <names>
    <proper-name>Thomas Sant'Ana
    <short-name>Thomas
  </names>
</persona>

The following reference:

<ref id="P01" fmt="proper" link="yes">

Would be expanded to a hyper-link with the following text:

Thomas Sant'Ana

However the following reference:

<ref id="P01">

Will be expanded by the to the default format of the persona element (which is short) and will produce:

Thomas