From: Michael Smith Date: Mon, 17 Dec 2001 07:43:26 +0000 (+0000) Subject: Fixed broken link to HTML Help workshop download file. X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=18a4db0eab2f39b60d64d980af60edca1e1a4dea;p=docbook-dsssl Fixed broken link to HTML Help workshop download file. Made some light edits, mostly just English grammar fixes. --- diff --git a/xsl/htmlhelp/doc/htmlhelp.xml b/xsl/htmlhelp/doc/htmlhelp.xml index 1d7c4a3ba..c96f78b42 100644 --- a/xsl/htmlhelp/doc/htmlhelp.xml +++ b/xsl/htmlhelp/doc/htmlhelp.xml @@ -13,67 +13,67 @@ $Id$ -Using XSL stylesheets to generate HTML Help +Using the XSL stylesheets to generate HTML Help -HTML Help (HH) is help-format used in newer versions of MS -Windows and applications written for this platform. This format allows -to pack several HTML files together with images, table of contents and -index into single file. Windows contains browser for this file-format -and full-text search is also supported on HH files. If you want know -more about HH and its capabilities look at HTML Help (HH) is a help format used in newer versions of Microsoft +Windows and applications written for that platform. The HTML Help format allows +you to pack several HTML files together with images, a table of contents, and +an index into a single file. Windows contains a browser for this file format +and full-text search is also supported on HH files. If you want to know +more about HH and its capabilities, visit the Microsoft HTML -Help pages. +Help Start Page.
-How to generate first HTML Help file from DocBook sources +How to generate your first HTML Help file from DocBook sources -Working with HH stylesheets is same as with other XSL DocBook +Working with the HH stylesheets is the same as with other XSL DocBook stylesheets. Simply run your favorite XSLT processor on your document -with stylesheet suited for HH: +with the HH stylesheet: saxon yourfile /path/to/stylesheets/contrib/htmlhelp/htmlhelp.xsl -If you are using XT processor, you should use stylesheet +If you are using the XT processor, you should use the stylesheet xthtmlhelp.xsl instead of htmlhelp.xsl. -Stylesheet imports standard chunking stylesheet, thus set of -HTML files is created in usual way. Other files are also created -– htmlhelp.hhp is project file for HTML -Help Compiler and toc.hhc holds structure of your +The stylesheet imports the standard chunking stylesheet, so a set of +HTML files is created in the usual way. Other files are also created +– htmlhelp.hhp is the project file for the HTML +Help Compiler and toc.hhc holds the structure of your document. -Language identifier for whole HH file is taken from the top most -element with lang attribute in +The language identifier for the overall HH file is taken from the top-most +element with a lang attribute in your DocBook source. This is perfectly legal for documents in only one -language. If language is not specified in the document, US English is -defaulted. There is one problem – MS language codes are country -sensitive, and this information is not available in DocBook source. If -the stylesheet selects bad code for you, edit +language. If a language is not specified in the document, US English is +used. There is one problem – MS language codes are country-sensitive, +and this information is not available in the DocBook source. If +the stylesheet selects a bad code for you, edit langcodes.xml, and remove all entries which have -yours language code, but are located in inappropriate country. +your language code, but are located in an inappropriate country. -Title of whole HH file is taken from first title element in your -document. Fulltext searching is automatically on. If your document +The title for the overall HH file is taken from the first title element in your +document. Full-text searching is automatically on. If your document contains index terms, they are automatically converted to HH ActiveX -objects, which are recognized by HTML Help compiler. +objects, which are recognized by the HTML Help compiler. -Stylesheet creates couple of files which are then used as an -input for HTML Help Compiler (HHC) which is part of HTML -Help Workshop. If you have HHC in your path, you can start -conversion to HH format by running command: +The stylesheet creates couple other files which are then used as an +input for the HTML Help Compiler (HHC), which is part of HTML Help Workshop. If you have HHC in your path, you can +start conversion to the HH format by running this command: hhc htmlhelp.hhp -If you can not stand without your mouse, there is alternative -way. Just double-click on If you cannot stand to work without using your mouse, there is alternative +way. Just double-click on the htmlhelp.hhp file. HH Workshop will be -launched automaticaly. Generation of HH file can be started by selecting +launched automatically. Generation of the HH file can be started by selecting File Compile from application's +moreinfo="none">Compile from the application's menu.
@@ -84,15 +84,15 @@ menu.
Enabling navigation links -By default, HTML Help stylesheet disables navigation links at -the start and the bottom of each page. If you want to enable this -feature, start your XSLT processor with parameter By default, the HTML Help stylesheet disables navigation links at +the start and the bottom of each page. If you want to enable the +links instead, start your XSLT processor with the parameter suppress.navigation set to 0. saxon yourfile /path/to/stylesheets/contrib/htmlhelp/htmlhelp.xsl "suppress.navigation=0" -Another approach is to create driver file, which overrides -default parameter value. +Another approach is to create a driver file, which overrides +the default parameter value. @@ -110,9 +110,9 @@ default parameter value. Generating HTML Help for non-Western European languages If you are generating HTML Help for non-Western Europe -languages, you should change output encoding of your files, because -HTML Help compiler improperly handles UTF-8 and even character -entities in TOC file and index entries. This can be easily done by +languages, you should change the output encoding of your files, because +the HTML Help compiler improperly handles UTF-8 and even character +entities in the TOC file and index entries. This can be easily done using a driver file like this: Feedback -If you have any comments and suggestion about HTML Help +If you have any comments and suggestions about the HTML Help stylesheet feel free to contact me at following address jirka@kosek.cz.