Web Help Parameters

The table below lists the parameters specific to the stylesheets that generate Web Help.

Parameters marked using this icon

are pseudo-parameters. They may or may not be passed to the XSLT stylesheets, but it is important thing to remember that they are also interpreted by ditac itself. As a consequence, you cannot specify them in an XSLT stylesheet which customizes the stock ones.

Parameter	Value	Description
wh---CSS_VAR_NAME	String. A valid CSS property value. No default.	This kind of parameter may be used to override any of the default values of the CSS variables specified in any of the `NNtheme.css` template files (all found in ditac_install_dir/whc_template/_wh/). For example, the main `NNtheme.css` template file: body { ... --navigation-width: 33%; ... } The `wh---navigation-width` CSS variable is used as follows in `NNcommon.css`, another CSS template file: #wh-navigation { ... width: var(--navigation-width); ... } Therefore parameter `wh---navigation-width` may be used to give the navigation side of the generated Web Help a different initial width. Example: `-p wh---navigation-width "25%"`. More examples in "XMLmind Web Help Compiler Manual, Getting started".
wh-collapse-toc	Allowed values are: 'yes' and 'no'. Default value: 'no'.	Specifies whether the TOC should be initially collapsed.
wh-index-numbers	Allowed values are: 'yes' and 'no'. Default value: 'no'.	Specifies whether words looking like numbers are to be indexed. Examples of such number-like words: 3.14, 3,14, 3times4equals12, +1, -1.0, 3px, 1,2cm, 100%, 1.0E+6, 1,000.00$.
wh-inherit-font-and-colors	Allowed values are: 'yes' and 'no'. Default value: 'yes'.	When wh-inherit-font-and-colors is set to 'no', the navigation pane of the generated Web Help uses fonts and colors of its own, which will generally differ from those used for the content of the Web Help. Setting wh-inherit-font-and-colors to 'yes' lets you use for the navigation pane the same fonts and colors as those used for the content of the Web Help. So basically this parameter is a shorthand for: -p wh---navigation-font-family inherit¬ -p wh---navigation-font-size inherit¬ -p wh---navigation-color inherit¬ -p wh---navigation-background-color inherit See above wh---CSS_VAR_NAME parameters.
wh-jquery	Relative or absolute URI. A relative URI is relative to the URI of a page of the Web Help. Default value: absolute URI of the corresponding file found on the Google CDN.	Specifies the location of the JavaScript file containing jQuery . Example: https://code.jquery.com/¬ jquery-3.4.1.slim.min.js Specifying an "https:" URL is recommended when the generated Web Help is stored on an HTTPS server.
wh-local-jquery	Allowed values are: 'yes' and 'no'. Default value: 'no'.	Specifies whether all jQuery files should be copied to `_wh/jquery/`, where `_wh/` is the directory containing the other Web Help files. By default, the jQuery files are accessed from the Web (typically from a CDN). Note that this parameter is applied after jQuery has been possibly customized using parameter wh-jquery. For example, "`-p wh-jquery https://code.jquery.com/jquery-3.4.1.js`" copies a file downloaded from https://code.jquery.com/ to _wh/jquery/.
wh-layout	The name of a layout. Default value: classic.	Selects a layout for the generated Web Help. For now, only two layouts are supported: classic and simple.
wh-responsive-ui	Allowed values are: 'yes' and 'no'. Default value: 'yes'.	Specifies whether the generated Web Help should be “responsive”, that is, whether it should adapt its layout to the size of the screen.
wh-ui-language	"browser" or "document" or a language code conforming RFC 3066. Examples: de, fr-CA. Default value: 'browser'.	Specifies which language should be used for the messages (tab labels, button tool tips, etc) of the generated Web Help. Default value "browser" means that this language is the one used by the Web browser for its own messages. This language may often be specified in the user preferences of the Web browser. Value "document" means that the language of the document should be used. A language code such as en, en-US, es, es-AR, etc, may be used to explicitly specify which language should be used.
wh-use-stemming	Allowed values are: 'yes' and 'no'. Default value: 'yes'.	Specifies whether stemming⁽¹⁾ should be used to implement the search facility. By default, stemming is used whenever possible, that is, when the main language of the document can be determined; when this main language is one of: Danish, Dutch, English, Finnish, French, German, Hungarian, Italian, Norwegian, Portuguese, Russian, Spanish, Swedish, Romanian, Turkish. The main language of the document is specified by the `@xml:lang` attribute found on the root element of DITA map being converted; otherwise using the -lang command-line option; otherwise, it is assumed to be "en".
wh-user-css	Filename or absolute URI of a CSS file. A relative filename is relative to the current working directory.	Specifies the user's CSS stylesheet which is to be added to each page of the Web Help. This file is copied to output_directory/_wh/user/. Sample user's CSS wh_resources/header_footer.css as used in the following example: -p wh-user-header¬ wh_resources/header.html -p wh-user-footer¬ wh_resources/footer.html -p wh-user-css¬ wh_resources/header_footer.css -p wh-user-resources¬ wh_resources/header_footer_files
wh-user-footer	Filename or absolute URI of an XHTML file. A relative filename is relative to the current working directory.	Specifies the user's footer which is to be added to each page of the Web Help. The content of the `<body>` element of wh-user-footer is inserted as is in the <div id="wh-footer"> found in each page of the Web Help. Same remark as for parameter wh-user-header about the resources referenced by a user's footer. Sample user's footer wh_resources/footer.html as used in the following example: -p wh-user-header¬ wh_resources/header.html -p wh-user-footer¬ wh_resources/footer.html -p wh-user-css¬ wh_resources/header_footer.css -p wh-user-resources¬ wh_resources/header_footer_files More examples in "XMLmind Web Help Compiler Manual, Getting started".
wh-user-header	Filename or absolute URI of an XHTML file. A relative filename is relative to the current working directory.	Specifies the user's header which is to be added to each page of the Web Help. The content of the `<body>` element of wh-user-header is inserted as is in the <div id="wh-header"> found in each page of the Web Help. If a user's header references resources (e.g. image files), then these resources must either be referenced using absolute URLs or these resources must be found in a user's resource directory and parameter wh-user-resources must be specified. Example: The user's resource directory is called header_footer_files/ and contains header_footer_files/200x100.png. `ditac` is passed parameters: -p wh-user-resources PATH_TO/header_footer_files and -p wh-user-header PATH_TO/header.html. header.html looks like this: <html> ... <body> ... <img src="_wh/user/header_footer_files/¬ logo200x100.png" /> ... </body> </html> Notice the path used to reference logo200x100.png. Sample user's header wh_resources/header.html as used in the following example: -p wh-user-header¬ wh_resources/header.html -p wh-user-footer¬ wh_resources/footer.html -p wh-user-css¬ wh_resources/header_footer.css -p wh-user-resources¬ wh_resources/header_footer_files More examples in "XMLmind Web Help Compiler Manual, Getting started".
wh-user-resources	Filename or absolute "file:" URI of a directory. URI schemes other than "file" (e.g. "http") are not supported for this parameter. A relative filename is relative to the current working directory.	Specifies a user's resource directory which is to be recursively copied to output_directory/_wh/user/. This directory typically contains image files referenced by the user's header, footer or CSS stylesheet. Sample user's resource directory wh_resources/header_footer_files/ as used in the following example: -p wh-user-header¬ wh_resources/header.html -p wh-user-footer¬ wh_resources/footer.html -p wh-user-css¬ wh_resources/header_footer.css -p wh-user-resources¬ wh_resources/header_footer_files More examples in "XMLmind Web Help Compiler Manual, Getting started".
whc-index-basename	URL basename. Default value: 'whc_index.xml'.	Basename of the Index XML input file of XMLmind Web Help Compiler. In principle, there is no need for an end-user to specify this parameter.
whc-toc-basename	URL basename. Default value: 'whc_toc.xml'.	Basename of the TOC XML input file of XMLmind Web Help Compiler. In principle, there is no need for an end-user to specify this parameter.

⁽¹⁾	In linguistic morphology and information retrieval, stemming is the process of reducing inflected (or sometimes derived) words to their word stem, base or root form—generally a written word form.