44.11.2 Supplying parameters for the archiving command

To provide values for parameters (other than the archive file name) required by the archiving program:

[Automation]
; ArchiveStartParams = parameters preceding name of archive file
ArchiveStartParams=-add
; ArchiveEndParams = parameters following name of archive file
ArchiveEndParams=*.*

For parameters that are to be passed to an archiving program, observe the following:

Starting parameters

ArchiveStartParams specifies any parameters to ArchiveCommand that must precede the name of the archive file, such as command option -add for pkzip or -a (the default) for wzzip. For example, the starting-parameter setting for the DITA2Go User's Guide is simply:

ArchiveStartParams =

Ending parameters

ArchiveEndParams specifies any parameters to ArchiveCommand that must follow the name of the archive file, such as *.* for pkzip or wzzip. For example, the ending-parameter setting for the Eclipse Help version of the DITA2Go User's Guide is:

ArchiveEndParams = doc.zip *.xml

Archiving directly from the project directory

If you are archiving from the project directory instead of from a separate directory designated by WrapPath (see §44.6 Assembling files for distribution), it is better to enumerate the files (at least by extension) to include in the archive. If you specify ArchiveEndParams=*.*, you might end up with .ref, .ini, .grx, and other unwanted files in the archive. For example, for an HTML project to be archived from the project directory you might specify the following:

ArchiveEndParams = *.htm *.css *.gif *.jpg *.png

For the HTML Help version of the DITA2Go User's Guide, which does not use a WrapPath directory, the setting specifies each file to be included:

ArchiveEndParams = ugdita2go.chm

Previous Topic:  44.11.1 Specifying an archiving command

Next Topic:  44.11.3 Specifying archive file name and optional version

Parent Topic:  44.11 Archiving deliverables

Sibling Topics:

44.11.1 Specifying an archiving command

44.11.3 Specifying archive file name and optional version

Table of ContentsIndex