#### 14.9.3 Specifying properties of variant booklist components

In a general configuration file, create a section named for the booklist variant, with suffix BList. This is a variable-name, fixed-key section:

    [VariantNameBList]

If you omit any properties, their default values will be those of the corresponding properties in effect for a normal list or index.

Properties of a booklist variant named in [BookLists] include:

Identifiers: file name, suffix, reference ID

Output formats: for title, item, links, TOC entry

Output configuration: for index references

Alphabetic aids: for index navigation

Title: text of the title for the list

Identifiers: file name, suffix, reference ID

To specify file name, suffix, and a reference ID for the booklist variant:

    [VariantNameBList]
    ; FileName = Full name, no ext; if omitted, project base name + Suffix
    FileName = D:\MyProject\Output\SchematicsLOF
    ; Suffix = Suffix for base name if no FileName provided, with defaults
    ; for some types, as listed in Table 14-1
    Suffix = LOF
    ; RefID = ID to use for internal references such as "Rlof";
    ; default is R + variant name; for example:
    RefID = Rs_lof

Output formats: for title, item, links, TOC entry

To specify output formats for booklist components:

    [VariantNameBList]
    ; TitleFormat = block format to use for list title
    TitleFormat = LOFTitle
    ; UseHeading = Yes (default, put a title on the index) or No
    UseHeading = Yes
    ; ItemFormat = block format for items to include
    ItemFormat = FigureListItem
    ; XrefFormat = inline format for list-item xrefs (not for indexlists)
    XrefFormat = FigureListXref
    ; TOCFormat = block format to use for TOC entry for list
    TOCFormat = LOFTOC

If the booklist variant includes items at different levels, the value of ItemFormat provides a default format for any levels not specified; see §14.9.4 Defining properties of items in variant booklist components.

Output configuration: for index references

To specify an output configuration for index references (indexlist variants only):

    [IndexNameBList]
    ; CompactForm = Yes (default), page numbers (RTF) or icons (HTML);
    ; or No, full topic titles as index references
    CompactForm = Yes
    ; RefFormat = inline format for index references (indexlists only)
    RefFormat = IndexIconXref
    ; UseLeader = No (default) or Yes (RTF only) include a tab with
    ; a leader between index entry and first page number
    UseLeader = No

See §14.8.4 Configuring index references.

Alphabetic aids: for index navigation

To include heading letters to introduce each alphabetic section of the index, and an alphabet across the top of each index page with links to the heading letters (indexlist variants only):

    [IndexNameBList]
    ; UseLetters = Yes (default, insert heading letters) or No
    UseLetters = Yes
    ; UseTopLetters = Yes (default for RTF; for HTML, default only if
    ; IndexNavType=HTML: top-of-page alphabet with links to heading
    ; letters) or No
    UseTopLetters = Yes

See §14.8.5 Including heading letters in the index.

Title: text of the title for the list

To specify text for the title of the list or index: in a language configuration file, create a section named for the variant, with suffix BLText. This is a variable-name, fixed-key section where you specify the text string for the title of the list:

    [VariantNameBLText]
    ; ListTitle = title to use if no navtitle in bookmap
    ListTitle = Text of title

Previous Topic: 14.9.2 Naming variant booklist components

Next Topic: 14.9.4 Defining properties of items in variant booklist components

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.4 Defining properties of items in variant booklist components

14.9.5 Mapping indexterms to variant indexes

Table of Contents • Index