### 8.7 Defining cross-reference output formats

Cross-reference formats are associated with cross-reference links to different types of text formats in your document. As a convention, the name of any cross-reference format should end in Xref.

The following cross-reference formats are defined in subformat configuration files:

Referenced content | Cross-reference format | With page number (RTF only)
Numbered list item |
    NumXref
    NumPageXref
Unnumbered item |
    TextXref
    TextPageXref
Footnote |
    FtnXref
    FtnPageXref
Heading |
    TitleXref
    TitlePageXref
Figure number |
    FigureXref
    FigurePageXref
Table number |
    TableXref
    TablePageXref
Figure title |
    FigureTitleXref
    FigureTitlePageXref
Table title |
    TableTitleXref
    TableTitlePageXref
Equation |
    EquationXref
    EquationPageXref
Step |
    StepXref
    StepPageXref
TOC item |
    TOCTitleXref

These are the default cross-reference formats. You can add other cross-reference formats of your own, and you can change the default names. However, if you change a default name, you must change it in every place that name is referenced; notably in general configuration section [ElementOptions]; see §6.3.3 Mapping cross-reference outputclass attributes to formats.

You define properties of cross-reference formats by assigning building blocks to form, the sole cross-reference format property:

    [TypeOfXref]
    form = <building-block1> <building-block2> ...

Table 8-5 lists the building blocks you can assign to property form to define a cross-reference format. Table 8-6 shows the default values for the form property that are assigned to the default cross-reference format names.

Table 8-5 Building blocks for cross-reference formats

Building block | Description
    <paratext/>
| Paragraph content, usually of the following title element
    <autonum/>
| Entire autonumber of the referenced item, except for any tabs
    <numonly/>
| Just the number part of the autonumber, without anything before the first counter or after the last counter
    <tab/>
| (RTF only) Each tab advances by the amount in [WordOptions]AnumTabWidth (see §15.3.3 Converting autonumbered formats) (HTML only) Adds a space Any tab present in the referenced autonumber is dropped
    <format>
| Character format, reset at the end of the cross reference, or earlier by a </format>; typographic element names valid; any character format in the referenced autonumber format is dropped Note: if the format is for footnote references, do not close it, or the tag will be ignored
    <u+NNNN/>
| Unicode character, where NNNN is the hexadecimal code point, as in <u+2020/> for a dagger
    <spc/>
| A fixed-width nonbreaking space
    <page/>
| (RTF only) The target page number
    <tag/>
| (HTML only) The tag to get text from

You can use character format tags and typographic tags around the format definitions; however, do not use tags that have the same names as building blocks: paratext, autonum, numonly, or tab. See §8.1.5 Including typographic tags and character formats.

Note: Do not try to assign more than one <format> tag to a cross-reference subformat.

Some default cross-reference formats are defined as follows:

    [TitleXref]
    form = <autonum/> <paratext/>

    [NumXref]
    form = <autonum/>

    [FtnXref]
    form = <sup><numonly/>

    [TextXref]
    form = <paratext/>

To apply these cross-reference formats to the paragraph formats they reference (see §7.6.5 Specifying block properties for paragraph formats):

    [Heading1]
    number = Head1Num
    xref = TitleXref

    [NumberedFirst]
    number = ListFirstNum
    xref = NumXref

    [Numbered]
    number = ListNum
    xref = NumXref

    [Footnote]
    number = FootnoteNum
    xref = FtnXref

The default cross-reference format names listed in Table 8-6 are used only when no cross-reference format name is specified in the xref element outputclass attribute.

Table 8-6 Default cross-reference format names and definitions

Format name | Cross reference to: | Default format (form property)
    TitleXref
| Numbered formats; typically includes the title of the referenced item; default for formats assigned to topic, section, fig, and table elements |
    <autonum/> <paratext/>
    NumXref
| Items in ordered lists; typically includes only the number; default for formats assigned to li elements |
    <autonum/>
    FtnXref
| Footnotes, that typically include only the superscript number; default for formats assigned to fn elements |
    <sup><numonly/>
    FigureXref
| Figures, using only the figure number |
    Figure <numonly/>
    TableXref
| Tables, using only the table number |
    Table <numonly/>
    FigureTitleXref
| Figures, using the figure title |
    <autonum/> <i><paratext/></i>
    TableTitleXref
| Tables, using the table title |
    <autonum/> <i><paratext/></i>
    StepXref
| Steps |
    Step <numonly/>
    MapTitleXref
| TOC items |
    <autonum/> <paratext/>
    TextXref
| Text elements without numbers or titles; default for anything else |
    <paratext/>

Previous Topic: 8.6 Configuring run-in headings for text formats

Next Topic: 8.8 Configuring index see and see-also entries

Parent Topic: 8. Configuring format components

Sibling Topics:

8.1 Managing format components

8.2 Defining border subformats

8.3 Defining shading subformats

8.4 Overriding border and shading properties

8.5 Configuring output numbering properties

8.6 Configuring run-in headings for text formats

8.8 Configuring index see and see-also entries

8.9 Configuring trademark formats

8.10 Localizing output headings, labels, and names