The Subdocument Link

Syntax: .SUBDOC URL= [Label=] [Target=]

Collections of web pages are often organized into structures that suggest a hierarchical relationship between the pages. When this is the case, you will probably want your readers to be able to "go up one level" in the collection, for example, from a single page to its chapter title page.

The Document Interface allows you to specify the document that is "one level up" from the one you are working on. It uses the subdocument link to establish this relationship. When you define the subdocument relationship for a document, the Document Interface adds a link to the parent document just below the banner at the top of the page, and also near the bottom of the page. This feature allows users to move "back up one level" in the structure.

Defining the subdocument link

You can specify the behavior of the Subdocument button with the following command:

.SUBDOC URL= [Label=]

For example:

<!--.SUBDOC URL="parent_page.shtml" Label="Table of Contents"-->

The optional Label parameter allows you to change the text of the link. The Document interface will display a link that looks like this:

Go to "title"

where title is the value you entered in the Label parameter. If you do not specify a title, the Document Interface will open the parent document, read its title, and place that text inside the double quotes. By leaving the title out, you can change the title of the parent document without having to edit all of its children, too.

The Target parameter creates a link that points to another window or frame. Use a value of _parent to break out of frames, _blank to open a new window with the link, or another name of your choice to refer to a particular window or frame.