Cross-Reference format building blocks

Understand cross-references building blocks in Adobe FrameMaker.

In this topic

Introduction
Source file information building blocks
Source paragraph
Paragraph preceding the source paragraph
Cross-Reference building blocks in structured documents

Introduction

When you add or edit cross-reference format, you can choose to use building blocks to display contextual information in the cross-reference.

The following sections describe the building blocks that you can use to create cross-reference formats.

Source file information building blocks

The following building blocks provide information about the source file of the document containing the cross-reference:

Building block	Description
`<$filename>`	The file name of the source document.
`<$fullfilename>`	The full path and file name of the source document.
`<$volnum>`	The volume number of the document that includes the source paragraph.
`<$chapnum>`	The chapter number of the document that includes the source paragraph.

Source paragraph

The following building blocks provide information about the source paragraph referenced by the cross-reference:

Building block	Description
`<$pagenum>`	The page number of the source paragraph.
`<$paratext>`	The text of the source paragraph, excluding its autonumber. If the character style of text in the source paragraph was changed by applying a character style, the font family, superscript, and subscript properties are preserved in the text of the cross-reference.
`<$paratag>`	The paragraph style name (tag) of the source paragraph.
`<$paranum>`	The source paragraph’s entire autonumber, including any text in the autonumber format.
`<$paranumonly>`	The source paragraph’s autonumber counters, including any characters between them.

Paragraph preceding the source paragraph

A cross-reference to a subsection often identifies the section that contains it. For example, this cross-reference to a subheading identifies the main heading under which it is found: See “Types of Plate Boundaries” in “Plate Tectonics.” In the example, Types of Plate Boundaries is the source paragraph, and Plate Tectonics is the main heading under which the source paragraph appears.

In each of the building blocks, replace tag with the paragraph style name (tag) of the paragraph to which you want to refer, but don’t delete the brackets “[ ]”. For example, if you want to refer to the text of the preceding paragraph with the style Head1, use <$paratext[Head1]>.

Building block	Description
`<$pagenum[tag]>`	The page number of the preceding paragraph with the specified pargraph style name (tag).
`<$paratext[tag]>`	The text of the preceding paragraph with the specified pargraph style name (tag), excluding its autonumber.
`<$paratag[tag]>`	The paragraph style name (tag) of the preceding paragraph with the specified tag.
`<$paranum[tag]>`	The entire autonumber of the preceding paragraph with the specified pargraph style name (tag), including any text in the autonumber format,
`<$paranumonly[tag]>`	The autonumber counters of the preceding paragraph with the specified pargraph style name (tag), including any characters between them.

Important: Don’t use paragraph style names that includes brackets ([ ]).

Cross-Reference building blocks in structured documents

Use the following building blocks to create cross-reference formats that refer to structured document elements

Building block	Description
`<$elempagenum>`	The page number of the source element.
`<$elemtext>`	The text of the source element, excluding its autonumber, but including any prefix and suffix specified in the element definition.
`<$elemtextonly>`	The text of the source element, excluding its autonumber and any prefix and suffix specified in the element definition.
`<$elemtag>`	The name of the source element.
`<$elemparanum>`	The entire autonumber of the source element paragraph (or of the paragraph containing the source element), including any text in the autonumber format.
`<$elemparanumonly>`	The autonumber counters of the source element’s first paragraph (or of the paragraph containing the source element), including any characters between the counters.
`<$attribute[name]>`	The value of the attribute with the specified name (or, if no value is specified, the default value).