Scribe to HTML: Labels, Cross References, and Anchors

Producing HTML Documents with Scribe

6. Labels, Cross References, and Anchors

Existing Scribe commands for doing cross-references include @Label, @Tag, @Ref, and @PageRef. These references can easily be converted to hypertext links, as follows:

Replace each occurrence of @Label or @Tag with @LinkLabel or @LinkTag. If an @Label command is used to identify a chapter or section, it should be removed, because @MakeChapter and @MakeSection automatically create the label.

For each usage of @Ref, replace it with @LinkRef. This is more complicated, because you have to identify the text to be the anchor of the hypertext link (i.e., the highlighted text). If you have the text

Chapter @ref(alice) discusses other aspects of
Alice's journey.

you could convert it to:

@LinkRef(tag=alice, text="Chapter @ref(alice)") discusses
other aspects of Alice's journey.

Both of these produce the same text, but in the HTML result, "Chapter 1" would be a hypertext link.

There is no analog to @PageRef, because HTML doesn't have page numbers. We suggest that you replace page references with section and chapter references.

You can insert hypertext links (anchors) using the @URLref command:

@URLref(url="file://nsl.pa.dec.com/pub/nsl-tools",
text="/pub/nsl-tools")

This command puts the text into the document as a hypertext link to the named file. The result is:


/pub/nsl-tools

Glenn Trewitt, trewitt@pa.dec.com