14.2 Naming generated HTML list and index files

For HTML output, you can specify base names and identifying suffixes for generated list and index files. However, unless you need to match an external convention, it is best to use the default values.

By default, all generated list and index files for a project get the same base name, followed by a three-letter suffix that identifies the file type, followed by a file extension that is the value of [Setup]FileSuffix specified for your project (see §4.1.6 Checking output type and file extension). Table 14-1 lists the generated file types and their default suffixes, and shows the keywords available for specifying alternate values for base name or suffix.

Table 14-1 Default file name suffixes for generated files

 

Generated file

Default

suffix

Configuration

section

Base name

keyword

Suffix

keyword

 

Ref.

Table of contents

TOC

[Contents]

TOCFile

TOCSuffix

14.3.1

List of figures

LOF

[ListOfFigures]

LOFFile

LOFSuffix

14.4

List of tables

LOT

[ListOfTables]

LOTFile

LOTSuffix

14.5

Index

IDX

[Index]

IDXFile

IDXSuffix

14.8.6.2

Glossary

GLS

[Glossary]

GLSFile

GLSSuffix

14.7

If you specify a value for one of the base-name keywords listed in Table 14-1, DITA2Go ignores the value of the corresponding suffix keyword, and just uses the base name as specified, followed by the extension. If you specify a base name, no suffix is added.

The default base name for generated files depends on whether you are running a conversion from the DITA2Go Project Manager, or from a command prompt, using the command-line version of DITA2Go:

Via DITA2Go Project Manager

Via DITA2Go DCL.

Via DITA2Go Project Manager

If you are using the DITA2Go Project Manager, the default base name for generated files is the base name of the top-level map file in your project. For example, if you set neither TOCFile nor TOCSuffix, the default file name for the table of contents generated from mydoc.bookmap would be mydocTOC.htm.

Via DITA2Go DCL

If you are running DITA2Go DCL from a command line, the default base name is the base name of the value specified for the -o argument; see §2.7.2 Understanding how to run DITA2Go DCL. For example, for the following command:

dcl -f html -o somename.htm mydoc.bookmap

the default name of the table of contents file would be somenameTOC.htm.

If you omit the -o argument, the default base name is the name of the map file. For example, for the following command:

dcl -f html mydoc.bookmap

the default name of the TOC file would be mydocTOC.htm, just as it would be if you were using the DITA2Go Project Manager.

Previous Topic:  14.1 Understanding how DITA2Go produces lists

Next Topic:  14.3 Generating a table of contents

Parent Topic:  14. Generating lists and indexes

Sibling Topics:

14.1 Understanding how DITA2Go produces lists

14.3 Generating a table of contents

14.4 Generating a list of figures

14.5 Generating a list of tables

14.6 Treating figure titles as table titles

14.7 Producing a glossary

14.8 Producing an index

14.9 Configuring variant booklist components

Table of ContentsIndex