29.3.1.3 Understanding how browse macros employ macro variables

The definition of each browse macro includes predefined macro variables for a destination for the link and for a label. Table 29-3 shows the default values of the link destination and link label used in <$_prev> and <$_next> for each file position.

Table 29-3 Default destination and label values for browse macros

Macro

File position in sequence

Destination value

Label value

<$_prev>

First file split from first DITA file in sequence

None (no destination code)

At Start

First file split from: - each non-first DITA file - all non-first unsplit files

<$$_seqprevfile>

<$$_seqprevtitle>

All other split files

<$$_prevfile>

<$$_prevtitle>
<$_next>

Last file split from last DITA file in sequence

None (no destination code)

At End

Last file split from: - each non-last DITA file - all non-last unsplit files

<$$_seqnextfile>

<$$_seqnexttitle>

All other split files

<$$_nextfile>

<$$_nexttitle>

Table 29-4 shows the meanings of the macro variables used in browse-macro definitions.

Table 29-4 Component macro variables for browse macros

Macro

Macro variable

Description

<$_prev>
<$$_seqprevfile>

Name of preceding file in sequence, with extension .htm

<$$_seqprevtitle>

Title listed in sequence for preceding DITA file

<$$_prevfile>

File name of preceding split file

<$$_prevtitle>

Title of preceding split file

<$_next>
<$$_seqnextfile>

Name of following file in sequence, with extension .htm

<$$_seqnexttitle>

Title listed in sequence for following DITA file

<$$_nextfile>

File name of following split file

<$$_nexttitle>

Title of following split file

Either macro 

<$$_seqcurrfile>

Name of current file in sequence, with extension .htm

<$$_seqcurrtitle>

Title listed in sequence for current DITA file

<$$_currfile>

File name of current split file

<$$_currtitle>

Title of current split file (the one used in HTML <title> element)

See §27.7 Referencing split and extract files for additional macro variables that refer to file names and titles of split and extracted files.

Previous Topic:  29.3.1.2 Understanding equivalent browse macros and macro variables

Next Topic:  29.3.2 Choosing buttons versus text links for a browse sequence

Parent Topic:  29.3.1 Understanding how browse macros work

Sibling Topics:

29.3.1.1 Understanding how browse macros vary by file position

29.3.1.2 Understanding equivalent browse macros and macro variables