10.2.7.2 Letting Mif2Go set up the folder structure and copy files

To have Mif2Go set up the JavaHelp or Oracle Help folder structure for you, specify a path to the top-level folder. For example:

[Automation]

WrapAndShip = Yes

; WrapPath = for JavaHelp or Oracle Help, path to top-level dir, ;  default is output dir

WrapPath = ./help

WrapPath can be an absolute path or a path relative to the project folder; the default value of WrapPath is the project folder itself.

Folders are created

When you specify a value for WrapPath, Mif2Go creates the WrapPath folder if it is not already present, and also creates the two required subfolders, if they are not already present.

To specify names for the subfolders:

[JavaHelpOptions]

; HTMLSubdir = subdirectory of WrapPath for *.htm, *.css, and *.js

;  files, default "html"

HTMLSubdir = html

; GraphSubdir = subdirectory of WrapPath for *.gif, *.jpg, and *.png

;  files, default "graphics"

GraphSubdir = graphics

Unless you are creating a proprietary folder structure, just accept the default names.

The folder designated by HTMLSubdir is the default setting for MapFilePrefix, with "/" appended; see §10.2.7.5 Specifying a path for search-index links.

The folder designated by GraphSubdir is the default JavaHelp and Oracle Help setting for [Graphics]GraphPath, with "../" prepended; see §10.2.7.4 Locating graphics files for JavaHelp and Oracle Help.

Folders can be emptied before copying

To empty the subfolders before copying:

[JavaHelpOptions]

; EmptyJavaHTMLSubdir = Yes (default, empty HTMLSubdir directory

;  before copying) or No (leave HTML files in place)

EmptyJavaHTMLSubdir = Yes

; EmptyJavaGraphSubdir = No (default, leave graphics files in place)

; or Yes (empty GraphSubdir directory before copying)

EmptyJavaGraphSubdir = Yes

Files are copied from the project folder

When you specify a value for [Automation]WrapPath, Mif2Go automatically populates the folder structure. After generating HTML files and optionally creating a full-text search index, Mif2Go copies files that have the following extensions, from the project folder to the folder specified by WrapPath, or to the appropriate subfolder. For example, with WrapPath=./help and default names for the subfolders:

Folder	File extensions
.\help	*.xml *.hs *.jhm
.\help\html	*.htm *.css *.js
.\help\graphics	*.gif *.jpg *.png

Note: Files are automatically copied from the project folder only if you specify a value for WrapPath.

List files to copy to the top folder

To specify what files to copy to the top folder:

[JavaHelpOptions]

; JavaRootFiles = list of files to copy to WrapPath

JavaRootFiles = *.hs *.jhm *.xml

You can use JavaRootFiles to list files to be copied to the folder designated by WrapPath. The file specifications you assign to JavaRootFiles must be separated by spaces, and no spaces are allowed within a file specification. You can use wildcards in file specifications, and include absolute or relative paths to indicate where files should be copied from; the default is from the project folder. By default, the following files are copied:

*.hs *.jhm *.xml

Any file list you assign to JavaRootFiles overrides these defaults.

Graphics can be copied from a different folder

To have Mif2Go copy graphics files from a location other than the project folder:

[Automation]

WrapAndShip = Yes

; CopyGraphicsFrom = path to dir containing the graphics files,

;  relative OK

CopyGraphicsFrom = ../MyGraphics

When you specify a value for CopyGraphicsFrom, GIF, JPEG, and PNG files are copied from the CopyGraphicsFrom folder to the folder specified by GraphSubdir.

See also:

§6.2.4 Compiling and distributing Help systems.

§33 Producing deliverable results

---

> 10 Generating JavaHelp or Oracle Help  > 10.2 Setting up a JavaHelp or Oracle Help project > 10.2.7 Creating a folder structure for JavaHelp / Oracle Help > 10.2.7.2 Letting Mif2Go set up the folder structure and copy files