Omni Systems, Inc. Mif2Go User's Guide, Version 55

<< Prev | Next >>

> 10 Generating OmniHelp > 10.12 Merging OmniHelp projects > 10.12.3 Providing TOC placeholders for OmniHelp subprojects

### 10.12.3 Providing TOC placeholders for OmniHelp subprojects

Place a HelpMerge marker in your main-project FrameMaker document for each subproject listed in the [HelpMerge] section, to:

• show where the subproject TOC should be merged into the main project TOC

• specify a contents level for the top TOC entry for the subproject.

Insert the HelpMerge marker between two main-project topics, in either of the following places:

• at the start of the main-project topic that should follow the subproject in the TOC, before any text

• at the end of the main-project topic that should precede the subproject in the TOC, after all text, in an otherwise empty paragraph.

Do not place the HelpMerge marker at the very beginning of the main project, and do not include duplicate HelpMerge markers for the same subproject.

The content of the HelpMerge marker consists of a single-digit contents level number (with respect to the main project TOC) for the top TOC entry of the subproject, followed by a space, followed by the path to the subproject. For example:

1 ../api/LibRef

Add subprojects before the fact

To include merge points for future subprojects that are not yet available, so that the main project does not even need to know whether they exist, at the end of the TOC add extra merge points with dummy subproject names. If you specify load-time merging:

[OmniHelpOptions]

MergeFirst=Yes

any subprojects that are present will be integrated, and any merge point for which a subproject is not present will be removed from the TOC.

Add subprojects after the fact

To provide the marker content after the fact, for a subproject that has already been built or was created without using Mif2Go, insert an entry in the *_ohc.js file for the master project, in the position where you want the subproject entry to appear in the master-project contents. The entry must look like this:

[n,"title","*name"],

where the components are as follows:

n | Contents level for the subproject entry in the master-project contents
title | Title of the subproject
name | Project name of the subproject

The last three items in the following example identify subprojects: that are in a directory different from the parent directory, so a relative path is prefixed to the project name:

var tocItems = [

[1,"Server","aa998290.htm#Xaa998290"],

[2,"Feature 1","aa998295.htm#Xaa998295"],

[2,"Feature 2","aa998300.htm#Xaa998300"],

[1,"Connectors","aa998313.htm#Xaa998313"],

[2,"Connector A","*ConnA/ConnA"],

[2,"Connector B","*ConnB/ConnB"],

[2,"Connector C","*ConnC/ConnC"]]

You would also need an item in _ohx.js like this:

var mergeProjects = [

["ConnA/ConnA",0,0,4,[]],

["ConnB/ConnB",0,0,5,[]],

["ConnC/ConnC",0,0,6,[]]]

where the 4, 5, 6 are the (zero-based) numbers of the TOC items. This example is for a set-up in which each secondary item is in a subdirectory that has the same name as the project.

See also:

§7.4.4 Setting contents levels for HTML-based Help

§10.12.2 Listing and mapping OmniHelp subprojects

§29.2 Adding custom marker types