##### 29.3.4.1 Redefining text-link browse macros

When UseNavButtons=No (the default) you can redefine browse macros for text links by changing the code assigned to the keywords listed in this section.

Do not try to duplicate <$_prev> and <$_next> logic by using the predefined macro variable components outside of the definitions for <$_prev> and <$_next>. The browse sequence would fail on inter-file links, because you would be missing some critical internal code that is required to handle such links.

Note: In your configuration file each code assignment must be all on one line, even if it does not look that way here.

To redefine macros for text links between HTML files split from a DITA file, change the following default definitions:

    [NavigationMacros]
    ; PrevMacro = content to put out for <$_prev>
    PrevMacro = <a href="<$$_prevfile>"><$$_prevtitle></a>
    ; NextMacro = content to put out for <$_next>
    NextMacro = <a href="<$$_nextfile>"><$$_nexttitle></a>

For a previous text “link” in the first and a next text “link” in the last HTML file in the entire sequence, change the following default definitions:

    [NavigationMacros]
    ; StartingPrevFSMacro = <$_prev> to use at start of first file in book
    StartingPrevFSMacro = <$$_seqstarttitle>
    ; EndingNextFSMacro = <$_next> to use at end of last file in book
    EndingNextFSMacro = <$$_seqendtitle>

For a text link to the top of the current page, change the following default definition:

    [NavigationMacros]
    ; TopMacro = content to put out for <$_top>,
    ; link to top of current file
    TopMacro = <a href="<$$_currfile>"><$$_toptitle></a>

To change a macro definition, modify or replace the macro code assigned to the appropriate keyword. For example, to add a title attribute to the <$_prev> link for WAI purposes (the definition must be all on the same line):

    PrevMacro =
      <a href="<$$_prevfile>" title="<$$prevtitle>"><$$_prevtitle></a>

For the first and last HTML files in the entire sequence, <$_prev> and <$_next> do not use links at all, but only label content. If you want static labels for the other links, you could redefine the text-link macros as follows:

    [NavigationMacros]
    PrevMacro = <a href="<$$_prevfile>">Prev</a>
    NextMacro = <a href="<$$_nextfile>">Next</a>
    PrevFSMacro = <a href="<$$_prevfile>">Prev</a>
    NextFSMacro = <a href="<$$_nextfile>">Next</a>

To make the first and last links to reference places outside the document (for example):

    [NavigationMacros]
    StartingPrevFSMacro = <a href="<$$HomeURL>">Home</a>
    EndingPrevFSMacro =< a href="<$$Plan2URL>">Plan 2</a>

    [MacroVariables]
    HomeURL = http://www.oursite.org/index.htm
    Plan2URL = http://www.oursite.org/greatplans/plan2.htm

Previous Topic: 29.3.4 Modifying macros <$_prev>, <$_next>, and <$_top>

Next Topic: 29.3.4.2 Redefining button browse macros

Parent Topic: 29.3.4 Modifying macros <$_prev>, <$_next>, and <$_top>

Sibling Topics:

29.3.4.2 Redefining button browse macros

Table of Contents • Index