Omni Systems, Inc.

  

Mif2Go User's Guide, Version 55

  

Valid HTML 4.01!

 

Made with Mif2Go

35 Producing deliverable results > 35.11 Archiving deliverables > 35.11.3 Specifying archive file name and optional version


35.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 Mif2Go 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 Mif2Go project file name. Table 35-5 shows the source of the default base file name of the archive for each output type.

Table 35-5 Default base file name for deliverables archive

Output type

Source of default base file name for archive

Ref.

HTML Help

[MSHtmlHelpOptions]HHPFileName

9.3.7

JavaHelp, Oracle Help

[JavaHelpOptions]HSFileName

11.3.8

OmniHelp

[OmniHelpOptions]ProjectName (without prefix or suffix)

10.3.3

WinHelp

[HelpOptions]HPJFileName

8.2.8

Eclipse Help

plugin (literally)

12.8.5

All other output types

[Setup]PrjFileName (without path)

C.3

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, Mif2Go 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 §35.11.1 Specifying an archiving command). If ArchiveCommand contains jar, the default extension is .jar; otherwise the default extension is .zip. Mif2Go provides the leading period.



35 Producing deliverable results > 35.11 Archiving deliverables > 35.11.3 Specifying archive file name and optional version