 |
XMLmind Web Help Compiler Manual |
|
XMLmind Web Help Compiler Manual |
corporate" layout is similar to the
"classic" layout but is more streamlined. Hence it's easier
to give it corporate colors and fonts. More information in "Getting started -
Corporate fonts and colors".layout=simple;
responsive-ui=yes; small screen forcing the
navigation pane to be displayed as a popup. Clicking a page link found
using the Search field caused the search state to be lost.tablist, tab,
tabpanel, button, switch, to some
of the HTML elements generated by the classic and the
simple layouts (that is, to some of the HTML
elements found in templates whc_template/classic.html and
whc_template/simple.html).compiling", the Search
tool now highlights found "compiler",
compiled", "recompile", etc, while older
versions highlighted only "compil".The Web Help generated by XMLmind Web Help Compiler gets a fresh new look. Moreover:
responsive-ui.-p --navigation-background-color "#F6F8FA") may be
used to override most fonts and colors used in the generated Web
Help.ui-language may be used to specify the language used by
the messages of the generated Web Help (tab labels, button tool
tips, etc). The default is to use the language of the Web
browser.Incompatibilities:
jquery-css,
jquery-custom-theme, jquery-theme,
jquery-ui.Bug fix:
the Web Help having the classic layout did not work in Google
Chrome version 77+.
Bug fix: the code used to workaround FOUC (Flash Of Unstyled Content)
did not work properly because _wh/wh.css contained a typo
("visiblity: hidden;" instead of
"visibility: hidden;").
Enhancements:
Bug fixes:
script and style found in the
source HTML pages were not saved in the generated WebHelp pages as
CDATA (that is, their text contents were escaped). Now
these elements are saved for example as follows:<style>/*<![CDATA[*/
ol > li {
font-size: smaller;
}
/*]]>*/</style>Incompatibilities:
Minor
internal changes needed when whc is used to generate the
contextual help of XMLmind products. (Added to the IDs of
figures having a figcaption, tables
starting with a caption, blockquotes starting with
a h1,...,h6 to the ID map used to implement a
contextual help.)
Minor internal tweaks.
XMLmind Web Help Compiler, which passed all non-regression tests, is now officially supported on Java™ 10 platforms.
Bug fixes:
Upgraded jQuery to v3.3.1.
window.sessionStorage for
that.Unlike cookies, sessionStorage seem to work fine
for Web Helps accessed from local files (that is, when the Web Help
pages have "file:" URLs). This is the case with Chrome,
Firefox, Safari, Edge (only if you specify
"file://COMPUTER_NAME/c/" rather than
"file:///C:/"), but with not IE11.
Moreover the
sessionStorage keys used to store the internal state of a
Web Help are all given a suffix which is specific to this Web Help. This
allows to load different Web Helps into the same Web browser tab without
having one internal state interfere with another.
Added parameter
layout which may be used to select a layout for the generated
Web Help. Default layout is called classic. New layout is
called simple.
Added workaround for an Internet Explorer 11/Edge bug: expanding a collapsed TOC entry displayed subentries having two bullets instead of just one.
chapter.html#s.1.2") did
not work.jquery-custom-theme (alias
wh-jquery-custom-theme) which references a
.zip file created using JQueryUI ThemeRoller.
This parameter makes it very easy using custom JQueryUI themes.local-jquery (alias
wh-local-jquery) now works differently. It is now
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/. In previous version of
XMLmind Web Help Compiler, -p local-jquery yes caused
-p jquery-theme cupertino to be ignored.Bug fixes:
iframe element was saved as an empty element, that
is, as follows:
<iframe src="http://www.xmlmind.com" />. This is
interpreted by Web browsers as an iframe start tag with no
corresponding close tag. To fix this issue, an iframe
element is now saved as follows:
<iframe src="http://www.xmlmind.com"></iframe>.Minor internal tweaks.
Upgraded jQuery to v3.1.1, jQuery UI to v1.12.1. This major upgrade required making a number of changes in the JavaScript™ code of XMLmind Web Help Compiler, so this may have added minor bugs. If, in the generated Web Help, you find anything which does not work as expected, please be kind enough to file a bug report (mailto:ditac-support@xmlmind.com).
Upgraded jQuery to v2.2.4, which implies that the Web
Help generated by whc no longer supports Internet Explorer 8
and older versions.
Compiler.setTemplateManifest
and Compiler.getTemplateManifest by static methods Compiler.setTemplateManifestURL
and Compiler.getTemplateManifestURL.https://ajax.googleapis.com/", as recommended by
Google. In the previous versions of XMLmind Web Help Compiler, it was
downloaded from "http://ajax.googleapis.com/" which
caused the generated Web Help to be unusable when stored on an HTTPS
server.Minor internal tweaks.
XMLmind Web
Help Compiler now copies the background styles possibly found in the
body element of an input XHTML page. This is needed to support
the watermark feature implemented by ditac v2.5.6+.
Upgraded jQuery to v1.11.3, jQuery UI to v1.11.4.
Upgraded jQuery to v1.11.2, jQuery UI to v1.11.2.
Enhancements:
index-numbers which allows to index
words looking like numbers. Note that, by default, number-like words are
not indexed.user-resources now accepts the absolute
"file:" URI of a directory, as well as an absolute or
relative filename.Bug fixes:
Now requires Java™ 1.6+ in order to compile and run.
Upgraded jQuery to v1.11.0, jQuery UI to v1.10.4.
-p use-stemming no.Example: let's
suppose the Web Help contains word "Servlets", but not word
"Servlet". In previous versions of the Web Help, which did
not implement stemming, searching for "Servlet" failed to
find the page containing "Servlets". With stemming now
implemented and turned on by default, searching for
"Servlet" finds the page containing
"Servlets".
local-jquery allows to copy all jQuery
files to the directory containing the other Web Help files. By default,
the jQuery files are accessed from the Web (typically from a
CDN).Minor internal tweaks.
<!DOCTYPE html> or
has no DOCTYPE at all, the compiler now generates
<meta charset="UTF-8"/> rather than <meta
http-equiv="Content-Type" content="text/html;
charset=UTF-8"/>. This allows to better support Web Help
containing XHTML5 pages.svg and math root elements now use a default
namespace).Added message
translations to de, es, it,
ja, pl, ru, zh-CN,
zh-TW, thanks to a contribution made by Jirka Kosek (http://xmlguru.cz/).
Add a Print button to the toolbar found in the TOC pane.
Minor internal tweaks.
New
collapse-toc parameter specifies whether the TOC should be
initially collapsed.
Whc now accepts raw index files. A raw
index is an index were entries have not been merged and sorted. A example of
such file is found in whc_install_dir/sample/raw_index.xml.
(Compare this file with whc_install_dir/sample/index.xml.)
This enhancement was motivated by the fact that we have found that generating an index were entries are merged and sorted is almost impossible using XSLT 1. This task seems to require XSLT 2 features (e.g. grouping).
First release.