#### 44.11.3 Specifying archive file name and optional version

To specify a name for the archive file:

    [Automation]
    ; ArchiveName = base name for archive to be created
    ArchiveName = MyProj
    ; ArchiveVer = version number (if any) to be appended to ArchiveName,
    ; default is the system configuration output-type identifier
    ArchiveVer = beta
    ; ArchiveExt = file extension to be appended, usually zip
    ArchiveExt = zip

The full name of the archive file is a concatenation of the following:

Archive file base name

Archive version

A period (dot)

Archive file extension.

Archive file base name

ArchiveName is the base file name of the archive to be created. For example, the base name for the archive of the RTF version of the DITA2Go User's Guide is:

    ArchiveName = UGrtf

The value you specify for ArchiveName must not contain spaces. The default value of ArchiveName depends on the output type. The default base name of any deliverable (archive or compiled Help system) is the base name of the project. For most Help systems, this is the Help project file name; for other output types, it is the base name of the map file. Table 44-5 shows the source of the default base file name of the archive for each output type.

Table 44-5 Default base file name for deliverables archive

Output type | Source of default base file name for archive | Ref.
HTML Help |
    [MSHtmlHelpOptions]HHPFileName
    18.3.6
JavaHelp, Oracle Help |
    [JavaHelpOptions]HSFileName
    20.3.7
OmniHelp |
    [OmniHelpOptions]ProjectName (without prefix or
    suffix)
    19.3.2
WinHelp |
    [HelpOptions]HPJFileName
    17.2.6
Eclipse Help |
    plugin (literally)
    21.8.3
All other output types |
    Base name of project map file
    2.3.5
All other output types | Base name of the map |

Archive version

ArchiveVer is an optional version identifier to be appended to ArchiveName, and may include any alphanumeric characters allowed in file names; see §1.1.2 File, directory, and path names. If you do not specify a value for ArchiveVer, DITA2Go uses a default output-type identifier as the value; for example, OH for OmniHelp. Output-type identifier values are located in system configuration files for each output type.

Archive file extension

ArchiveExt is the file extension for the type of archive to be created (without the leading period); usually zip or jar. The default depends on the value of ArchiveCommand (see §44.11.1 Specifying an archiving command). If ArchiveCommand contains jar, the default extension is .jar; otherwise the default extension is .zip. DITA2Go provides the leading period.

Previous Topic: 44.11.2 Supplying parameters for the archiving command

Next Topic: 44.12 Placing deliverables in a shipping directory

Parent Topic: 44.11 Archiving deliverables

Sibling Topics:

44.11.1 Specifying an archiving command

44.11.2 Supplying parameters for the archiving command

Table of Contents • Index