#### 14.9.4 Defining properties of items in variant booklist components

For booklist variants other than indexlist: in a general configuration file, create a section named for the booklist variant, with suffix BLItems. This is a variable-name, variable-key section where you list the document formats of the items to be included in the list, and assign each a level number:

    [VariantNameBLItems]
    ; DocFormatName = level in list, default 1
    SomeTitle = 1

For example:

    [OverviewBLItems]
    ChapterTitle = 1
    Heading1SC = 2
    Heading1C = 2

The formats you list here are not the formats to be used to render the items as part of the generated list. You specify those formats in [VariantNameBList]; see §14.9.3 Specifying properties of variant booklist components. Instead, this section enumerates the formats used in your document to render the content of the items. In other words, DITA2Go uses the format names you list here as selectors; see §7.1 Understanding the purpose of output formats.

For example, a <figurelist> would include figure titles as list items; so you would include in [VariantNameBLItems] the format used to render the <title> elements of <fig>s where they appear with images in output:

    [AssembliesBLItems]
    FigureTitle = 1

Note: Do not use [VariantNameBLItems] for indexlist variants; selectors for indexterms are derived from outputclass values rather than format names. See §14.9.5 Mapping indexterms to variant indexes.

Formats for list items other than in indexes

For booklist variants that contain items at more than one level, such as TOC and index variants: in a general configuration file, create a section named for the booklist variant, with suffix BLForms. This is a variable-name, variable-key section where you list the levels, and associate an output format with each level:

    [VariantNameBLForms]
    ; level number = item format

The formats you assign to levels here are the formats to be used to render the items as part of the generated list. For example:

    [OverviewBLForms]
    1 = Heading1TOC
    2 = TOCItem

Typically, items at each successive level would be assigned a format that indents the content relative to the previous level.

Formats for list items in indexes

You do not need to assign formats to index entries, except to override the default formats; see§14.8.2 Overriding formats for index entries and references. For unusual cases, you can assign formats to levels for the references from index entries to content:

    [VariantNameBLRefForms]
    ; level number = reference format

For example:

    [RTF_IXBLRefForms]
    1 = MyIndexRef1
    2 = MyIndexRef2
    3 = MyIndexRef3

See also §14.9.5 Mapping indexterms to variant indexes.

Previous Topic: 14.9.3 Specifying properties of variant booklist components

Next Topic: 14.9.5 Mapping indexterms to variant indexes

Parent Topic: 14.9 Configuring variant booklist components

Sibling Topics:

14.9.1 Differentiating variant booklist components

14.9.2 Naming variant booklist components

14.9.3 Specifying properties of variant booklist components

14.9.5 Mapping indexterms to variant indexes

Table of Contents • Index