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

To specify the name of the archive file:

    [Automation]
    ; ArchiveName = name for archive to be created, without extension
    ArchiveName=MyProj
    ; ArchiveVer = version number if any to be appended to ArchiveName
    ArchiveVer=1
    ; ArchiveExt = the correct extension to be added for the archive type,
    ; usually .zip
    ArchiveExt=zip

Archive base file name

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

    ArchiveName = UGrtf

The value you specify for ArchiveName cannot include 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 file. For most Help systems, this is the Help project file name; for other output types, it is the DITA2Go project file name. 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 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.5
Eclipse Help |
    plugin (literally)
    21.8.3
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.

Archive file extension

ArchiveExt is the file extension for the type of archive to be created, without the preceding period; usually this is 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.

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