10.2. Parameters of the XSLT stylesheets used to convert an ebook specification to Web Help

Parameters starting with "wh-" are pseudo-parameters. They may or may not be passed to the XSLT stylesheets, but the important thing to remember is that they are also interpreted by ebookc itself. Consequently you cannot specify them in an XSLT stylesheet which customizes the stock ones.

Parameter Value Default Value Description
omit-toc-root 'no' | 'yes' 'yes' Specify 'yes' if you want the title of the book to be the root of the Web Help TOC.
wh-collapse-toc 'no' | 'yes' 'no' Specifies whether the Web Help TOC should be initially collapsed.
wh-index-numbers 'no' | 'yes' '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-jquery Relative or absolute URI. A relative URI is relative to the URI of a page of the Web Help. 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.2.1.min.js
.

Specifying an "https:" URL is recommended when the generated Web Help is stored on an HTTPS server.

wh-jquery-css Relative or absolute URI. A relative URI is relative to the URI of a page of the Web Help. Absolute URI of the corresponding file found on the Google CDN. Specifies the location of the CSS stylesheet of jQuery UI.

Example: https://code.jquery.com/ui/¬
1.12.1/themes/redmond/jquery-ui.css
.

Specifying an "https:" URL is recommended when the generated Web Help is stored on an HTTPS server.

wh-jquery-custom-theme Filename or absolute URI of a .zip file created using JQueryUI ThemeRoller. A relative filename is relative to the current working directory. None. Specifies a .zip file created using JQueryUI ThemeRoller containing a custom JQueryUI theme. Example: jquery-ui-1.12.1.custom.zip.

The files comprising the custom theme are copied to _wh/jquery/, where _wh/ is the directory containing the other Web Help files.

Ignored if parameter jquery-css has been used to specify the CSS stylesheet of jQuery UI.

wh-jquery-theme The name of a theme. Examples: 'redmond', 'cupertino'. 'smoothness' Specifies the name of the jQuery UI theme used by the compiler.

Ignored if parameter jquery-css or jquery-custom-theme have been used to specify the CSS stylesheet of jQuery UI.

wh-jquery-ui Relative or absolute URI. A relative URI is relative to the URI of a page of the Web Help. Absolute URI of the corresponding file found on the Google CDN. Specifies the location of the JavaScript file containing jQuery UI .

Example: https://code.jquery.com/ui/¬
1.12.1/jquery-ui.min.js
.

Specifying an "https:" URL is recommended when the generated Web Help is stored on an HTTPS server.

wh-local-jquery 'no' | 'yes' '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 and JQueryUI have been possibly customized using parameters jquery, jquery-ui, jquery-css, jquery-theme and jquery-custom-theme. For example, "-p jquery-theme cupertino -p local-jquery yes" copies the Cupertino CSS files to _wh/jquery/.

wh-layout The name of a layout. 'classic' Selects a layout for the generated Web Help.

For now, only 2 layouts are supported: 'classic' and 'simple'.

wh-use-stemming 'no' | 'yes' 'yes' Specifies whether stemming should be used to implement the search facility.

By default, stemming is used whenever possible, that is,

  1. when the main language of the XHTML pages to be compiled can be determined;
  2. 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 the ebook specification being compiled; 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. None. Specifies the user's CSS stylesheet which is to be added to an XHTML page decorated by the compiler.

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. None. Specifies the user's footer which is to be added to each page of the Web Help.

The content of the body element of 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 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
wh-user-header Filename or absolute URI of an XHTML file. A relative filename is relative to the current working directory. None. Specifies the user's header which is to be added to each page of the Web Help.

The content of the body element of 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 user-resources must be specified.

Example:

  • The user's resource directory is called header_footer_files/ and contains header_footer_files/logo100x50.png.
  • ebookc is passed parameters -p user-resources PATH_TO/header_footer_files and -p user-header PATH_TO/header.html.
  • header.html looks like this:
    <html>
    ...
    <body>
    ...
    <img
    src="_wh/user/header_footer_files/¬
    logo100x50.png" />
    ...
    </body>
    </html>

    Notice the path used to reference logo100x50.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
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. None. 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

System parameters

Such system parameters are not intended to be specified by the end-user. Such system parameters are documented here only because the end-user may see them referenced in some dialog boxes, in some configuration files or in the source code of the XSLT stylesheets.

Parameter Value Default Value Description
whc-index-basename URL basename '__tmp__index.whc_ndx' Basename of the Index XML input file of XMLmind Web Help Compiler.
whc-toc-basename URL basename '__tmp__toc.whc_toc' Basename of the TOC XML input file of XMLmind Web Help Compiler.