37.1.4 Using predefined macros

DITA2Go provides several predefined macros for HTML, listed in Table 37-1, and for RTF, listed in Table 37-2.

Predefined macro names are reserved

Avoid giving any of your own macros a name that starts with an underscore; the DITA2Go definition takes precedence. The “$” says “this is a DITA2Go construct”; the “_” says “the name is reserved, not one of yours”.

Table 37-1 Predefined macros for HTML output

Macro

Description

­Ref.

<$_next>

Link to, and title of, following file

29.3

<$_prev>

Link to, and title of, preceding file

29.3

<$_seqnext>

Link to, and title of, following file in the book

29.3

<$_seqprev>

Link to, and title of, preceding file in the book

29.3

<$_TopicStartCode>

Macros from marker type TopicStartCode

38.2

<$_trail>

Inserts a “breadcrumb trail” of links

29.2

The predefined macros for RTF output, listed in Table 37-2, are intended for use in defining RTF output formats; see §7.4.6 Assigning content-adding properties to formats.

Table 37-2 Predefined macros for RTF output

Macro

Description

<$_style(stylename)>

RTF start code for a paragraph or character format

<$_colornum(colorref)>

Color number, after \\cf or \\cb

<$_fontnum(fontname)>

Font number, after \\f

<$_stylenum(stylename)>

Style number; after \\s i

<$_styleref(stylename)>

STYLEREF field with the named style

<$_pageref>

PAGEREF field referencing last bookmark used

Previous Topic:  37.1.3 Nesting macros

Next Topic:  37.2 Accessing DITA2Go macro libraries

Parent Topic:  37.1 Defining and invoking macros

Sibling Topics:

37.1.1 Defining macros

37.1.2 Invoking a macro

37.1.3 Nesting macros