29.3.5 Understanding browse keyword scope and default values

Table 29-5 shows the scope of each browse-macro keyword with respect to file position, the macros each keyword defines, and the macro variables used in each default value.

Table 29-5 Scope of [NavigationMacros] keywords

Scope

Keyword (* = Macro or Button)

Defines:

Default value uses:

File name

Label

Very first file

StartingPrevFS*

None

None

At Start

Very last file

EndingNextFS*

None

None

At End

First split

PrevFS*
<$_seqprev>
<$$_seqprevfile>
<$$_seqprevtitle>

Last split

NextFS*
<$_seqnext>
<$$_seqnextfile>
<$$_seqnexttitle>

All other split files

Prev*
<$_prev>
<$$_prevfile>
<$$_prevtitle>
Next*
<$_next>
<$$_nextfile>
<$$_nexttitle>

Table 29-6 shows the default value DITA2Go uses for each browse-macro keyword when the navigation macros produce text links; Table 29-7 shows the default values when macros produce buttons (see §29.3.2 Choosing buttons versus text links for a browse sequence).

Table 29-6 Default values of text-link browse keywords

Keyword

Default value

PrevMacro
<a href="<$$_prevfile>"><$$_prevtitle></a>
NextMacro
<a href="<$$_nextfile>"><$$_nexttitle></a>
PrevFSMacro
<a href="<$$_seqprevfile>"><$$_seqprevtitle></a>
NextFSMacro
<a href="<$$_seqnextfile>"><$$_seqnexttitle></a>
StartingPrevFSMacro
At Start
EndingNextFSMacro
At End

Table 29-7 Default values of button browse keywords

Keyword

Default value

PrevButton
<button type="button" 
onclick="javascript:location.href='<$$_prevfile>'">

<$$_prevtitle></button>
NextButton
<button type="button" 
onclick="javascript:location.href='<$$_nextfile>'">

<$$_nexttitle></button>
PrevFSButton
<button type="button" 
onclick="javascript:location.href='<$$_seqprevfile>'">

<$$_seqprevtitle></button>
NextFSButton
<button type="button" 
onclick="javascript:location.href='<$$_seqnextfile>'">

<$$_seqnexttitle></button>
StartingPrevFSButton
<button type="button">At Start</button>
EndingNextFSButton
<button type="button">At End</button>

Previous Topic:  29.3.4.2 Redefining button browse macros

Next Topic:  29.3.6 Specifying where to invoke a browse macro

Parent Topic:  29.3 Creating a browse sequence

Sibling Topics:

29.3.1 Understanding how browse macros work

29.3.2 Choosing buttons versus text links for a browse sequence

29.3.3 Formatting browse-link labels

29.3.4 Modifying macros <$_prev>, <$_next>, and <$_top>

29.3.6 Specifying where to invoke a browse macro

29.3.7 Considering an example of browse navigation