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---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
For example, the main NNtheme.css template file: body { ... --navigation-width: 33%; ... } The #wh-navigation { ... width: var(--navigation-width); ... } Therefore parameter More examples in "XMLmind Web Help Compiler Manual, Getting started". |
wh-collapse-toc |
'no' | 'yes' |
'no' |
Specifies whether the Web Help TOC should be initially collapsed. |
wh-favicon |
Filename or absolute URI of an image file. A relative filename is relative to the current working directory. | None. | Specifies the favicon
which is to be added to each page of the Web Help. This file is
copied to |
wh-index-numbers |
'no' | 'yes' |
'no' |
Specifies whether words looking like numbers are to be
indexed. Examples of such number-like words: |
wh-inherit-font-and-colors |
'no' | 'yes' |
'yes' |
When Setting
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. | Absolute URI of the corresponding file found on the Google CDN. | Specifies the location of the JavaScript file containing jQuery. Example:
Specifying
an " |
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 has been possibly customized using parameter
|
wh-layout |
The name of a layout. | 'classic' |
Selects a layout for the generated Web Help. For now, only 3
layouts are supported: |
wh-responsive-ui |
'no' | 'yes' |
'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 . |
'browser' |
Specifies which language should be used for the messages (tab labels, button tool tips, etc) of the generated Web Help. Default value " Value " A language code such
as |
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,
The main language of the document is specified by the
|
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
Sample user's
CSS -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 Same remark as for parameter
Sample user's footer -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. | None. | Specifies the user's header which is to be added to each page of
the Web Help. The content of the 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 Example:
Sample user's header -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. |
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 -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". |
§ 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.