Using include options

Navigation:  More Advanced Procedures > Command Line Options >

Using include options

 Previous pageReturn to chapter overviewNext page

Show/Hide Hidden Text

You can use conditional output include options in the command line. These options control what is included in your published output on the basis of the selected output format or user-defined include option conditions. Setting them is equivalent to setting the include options in the Publish dialog when you publish manually.

Specifying include options is optional. If you don't specify this switch Help & Manual will use the default include options, which are the options you used the last time you published to the current output format manually.

See the Syntax reference for details on all the available switches and parameters.

 

flag_green        Key Information

Note that include options do not select the output format! Include options only control what is included in or excluded from your project, not the output format of your project.
Click to expand/collapseHow to use include options

When you use this switch you should always also specify an include option for the current output format as the first option. If you leave out the /I= switch the include options set the last time you published the project manually will be used.

Add the /I= include options switch after the output format switch. Follow it with all the include options you want to use, separated by commas. Don't use quotes or spaces (a space would identify a new switch).

Examples:

HELPMAN.EXE D:\Projects\widgethelp.hmxz /CHM /I=CHM,FINALBUILD,USVERSION

HELPMAN.EXE D:\Projects\widgethelp.hmxp /CHM /I=CHM,PDF,DEMO

Both these examples output to HTML Help files (CHM). Note that the CHM include option is included in both cases. The output format itself should always be included as the first include option.

The second example also includes items specifically tagged for PDF in the HTML Help output, which would normally only be included when you publish to PDF.

Click to expand/collapseOutput format and user-defined include options

Output format include options (i.e. for the output formats supported by Help & Manual) and user-defined include options are both used in exactly the same way. Just type the options after the /I= switch, separated by commas. The examples below show the user-defined options in red.

Examples:

HELPMAN.EXE D:\Projects\widgethelp.hmxz /CHM /I=CHM,FINALBUILD,USVERSION

HELPMAN.EXE D:\Projects\widgethelp.hmxp /CHM /I=CHM,PDF,DEMO

See also:

Conditions and Customized Output