chmProcessor
<!-- If the browser does not support frames put the first topic content here --> <div class="Section1"> <h1><a name="node0" id="node0"></a><span lang="EN-GB" xml:lang= "EN-GB">chmProcessor. A Html / Word converter to Compiled HTML Help / Java Help (v 1.7.2)</span></h1> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">chmProcessor is a tool for creating HTML help (CHM files) from MS Word or HTML files. If the file is a Word document, the section titles must use the “Title 1”, “Title 2”, etc styles that offers by default Word. If the file is a HTML file, the titles must use the <H1>, <H2>, etc. tags.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">From this original file, each section of the document is split to different HTML files. Each of these files will be a topic page at the help. From the original document, you can generate:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal" style= 'margin-left:36.0pt;text-indent:-18.0pt'><span lang="EN-GB" style= 'font-family:Symbol' xml:lang="EN-GB">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-GB" xml:lang="EN-GB">A Microsoft Help Workshop project.</span></p> <p class="MsoNormal" style= 'margin-left:36.0pt;text-indent:-18.0pt'><span lang="EN-GB" style= 'font-family:Symbol' xml:lang="EN-GB">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-GB" xml:lang="EN-GB">A compiled HTML help (CHM file).</span></p> <p class="MsoNormal" style= 'margin-left:36.0pt;text-indent:-18.0pt'><span lang="EN-GB" style= 'font-family:Symbol' xml:lang="EN-GB">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-GB" xml:lang="EN-GB">A web site.</span></p> <p class="MsoNormal" style= 'margin-left:36.0pt;text-indent:-18.0pt'><span lang="EN-GB" style= 'font-family:Symbol' xml:lang="EN-GB">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-GB" xml:lang="EN-GB">An Adobe PDF file.</span></p> <p class="MsoNormal" style= 'margin-left:36.0pt;text-indent:-18.0pt'><span lang="EN-GB" style= 'font-family:Symbol' xml:lang="EN-GB">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-GB" xml:lang="EN-GB">A Microsoft XPS file.</span></p> <p class="MsoNormal" style= 'margin-left:36.0pt;text-indent:-18.0pt'><span lang="EN-GB" style= 'font-family:Symbol' xml:lang="EN-GB">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-GB" xml:lang="EN-GB">A Java Help JAR file.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <h1><a name="node1" id="node1"></a><span lang="EN-GB" xml:lang= "EN-GB">Requirements</span></h1> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">To use this program, you must to have installed the following software:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <ul style='margin-top:0cm' type="disc"> <li class="MsoNormal"><b><span lang="EN-GB" xml:lang= "EN-GB">Microsoft Windows</span></b><span lang="EN-GB" xml:lang= "EN-GB">. Tested versions: Windows 2000 (32 bits), Windows XP (32 bits), Windows 7 (32 and 64 bits), Windows 8. Console interface will not work over windows 2000. Versions 1.4 and earlier of chmProcessor do not work on 64 bits operating systems.</span></li> <li class="MsoNormal"><b><span lang="EN-GB" xml:lang= "EN-GB">Microsoft .NET Framework 2.0</span></b><span lang="EN-GB" xml:lang="EN-GB">. You can download the runtime version here: <a href= "http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=19"> http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=19</a></span></li> <li class="MsoNormal"><b><span lang="EN-GB" xml:lang="EN-GB">HTML Help Workshop</span></b><span lang="EN-GB" xml:lang="EN-GB">. If you don’t have it, you cannot compile the help, you can generate a web site only. You can it download from here: <a href= "http://msdn2.microsoft.com/en-us/library/ms669985.aspx" target= "_blank">http://msdn2.microsoft.com/en-us/library/ms669985.aspx</a></span></li> <li class="MsoNormal"><b><span lang="EN-GB" xml:lang= "EN-GB">Microsoft Word</span></b> <span lang="EN-GB" xml:lang= "EN-GB">if you will work with Word files. Ms Word 2003, 2007 and 2013 has been tested. <b>Starter versions will not work</b>, they don’t support automation.</span></li> </ul> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">Optionally, you can generate PDF and XPS files. To generate a PDF, there is two ways: PDFCreator or the Microsoft Office 2007 Add-in to generate PDF and XPS. <b>The last one is the recommended</b>. To generate a XPS file, the MS Office 2007 Add-in is mandatory:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <ul style='margin-top:0cm' type="disc"> <li class="MsoNormal"><b><span lang="EN-GB" xml:lang= "EN-GB">PDFCreator</span></b><span lang="EN-GB" xml:lang="EN-GB">. <b><u>Version 1.2</u></b> <u><b>ONLY</b></u>. You can download it from here: <a href= "http://www.pdfforge.org/products/pdfcreator/download">http://www.pdfforge.org/products/pdfcreator/download</a>. <b>This kind of generation will not be supported on the future</b>.</span></li> <li class="MsoNormal"><b><span lang="EN-GB" xml:lang= "EN-GB">Microsoft Office 2007 Add-in</span></b><span lang="EN-GB" xml:lang="EN-GB">. It’s an optional tool of the Office suite to generate PDF / XPS files. It’s not needed with Office 2013. You can download it from <a href= "http://www.microsoft.com/downloads/details.aspx?FamilyID=4D951911-3E7E-4AE6-B059-A2E79ED87041&displaylang=en"> http://www.microsoft.com/downloads/details.aspx?FamilyID=4D951911-3E7E-4AE6-B059-A2E79ED87041&displaylang=en</a>.</span></li> </ul> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If you want to generate a Java Help, you will need the following software:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <ul style='margin-top:0cm' type="disc"> <li class="MsoNormal"><b><span lang="EN-GB" xml:lang="EN-GB">Sun JDK</span></b><span lang="EN-GB" xml:lang="EN-GB">. 1.4 or upper. Only 1.6 has been tested. You can download it from here: <a href= "http://www.oracle.com/technetwork/java/javase/downloads/index.html"> http://www.oracle.com/technetwork/java/javase/downloads/index.html</a>.</span></li> <li class="MsoNormal"><b><span lang="EN-GB" xml:lang="EN-GB">Java Help</span></b> <span lang="EN-GB" xml:lang="EN-GB">2.0 or upper. You can download from here: <a href= "http://javahelp.java.net/">http://javahelp.java.net/</a>.</span></li> </ul> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If you are going to generate CHM files with a character codepage different than your system default, for example if you live on Spain and your help will be written in Cyrillic, you will need this:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <ul style='margin-top:0cm' type="disc"> <li class="MsoNormal"><b><span lang="EN-GB" xml:lang= "EN-GB">Microsoft AppLocale</span></b><span lang="EN-GB" xml:lang= "EN-GB">. Can be downloaded from here: <a href= "http://www.microsoft.com/download/en/details.aspx?id=13209">http://www.microsoft.com/download/en/details.aspx?id=13209</a></span></li> </ul> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <h1><a name="node2" id="node2"></a><span lang="EN-GB" xml:lang= "EN-GB">Limitations</span></h1> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <ul style='margin-top:0cm' type="disc"> <li class="MsoNormal"><span lang="EN-US" xml:lang="EN-US">Versions 1.5 and older will not work generating CHM files with source files with encodings different than</span> <span lang="EN-GB" xml:lang= "EN-GB">Windows-1252.</span> <span lang="EN-US" xml:lang= "EN-US"> Version 1.6 and higher should work.</span></li> <li class="MsoNormal"><b><span lang="EN-US" xml:lang="EN-US">Not all</span></b> <span lang="EN-US" xml:lang="EN-US">kind of documents will be well formatted, especially HTML documents. Try to avoid put titles into tables, put images with title styles, and such kind of things, because the application will be confused about how to split and index the document. Avoid Javascript.</span></li> <li class="MsoNormal"><span lang="EN-US" xml:lang="EN-US">Keep in mind that if you use more than one Word source files, the text styles used should be equal on all documents. So, if some style is different on some document, it can be overwritten by the definition of other document.</span></li> <li class="MsoNormal"><span lang="EN-US" xml:lang="EN-US">JavaHelp generation will not work if “</span><span lang="EN-GB" xml:lang="EN-GB">Use Tidy over the split HTML files” is not checked on <a href="start.htm#_Settings">settings</a> window.</span> <span lang="EN-US" xml:lang="EN-US">JavaHelp seems to need 100% standard HTML input files to work.</span></li> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">To generate CHM files with a character codepage (character set) different than your system default will only work if the source file is a Unicode encoded HTML file. MS Word 2003 / 2007 source files will not work.</span></li> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If you have a MS Office starter version, this application cannot make the HTML conversion automatically. You can do it manually using “Save as…” option and using the HTML file as source. <b>Make sure you save it as filtered HTML</b> (no HTML), and add the directory with the document images on “Additional files”</span></li> </ul> <h1><a name="node3" id="node3"></a><span lang="EN-GB" xml:lang= "EN-GB">Interface</span></h1> <h2><a name="node4" id="node4"></a><span lang="EN-GB" xml:lang= "EN-GB">Win Interface</span></h2> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">This is the main window:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal" align="center" style='text-align:center'> <span lang="EN-GB" xml:lang="EN-GB"><img border="0" width="578" height="420" src="chmProcessor_archivos/image001.gif" alt= "image" /></span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <h3><a name="node5" id="node5"></a><span lang="EN-GB" xml:lang= "EN-GB">Source files</span></h3> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Here are stored the source document files to generate the help: A single HTML file, or a list of Word files. If there is more than one Word document, they will be joined to create the help.</span></p> <h3><a name="node6" id="node6"></a><span lang="EN-GB" xml:lang= "EN-GB">General</span></h3> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <table class="MsoNormalTable" border="1" cellspacing="0" cellpadding="0" width="100%" style= 'width:100.0%;border-collapse:collapse;border:none'> <tr> <td width="231" valign="top" style= 'width:173.15pt;border:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Help Title</span></p> </td> <td width="751" valign="top" style= 'width:563.3pt;border:solid windowtext 1.0pt; border-left:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Title of the generated help.</span></p> </td> </tr> <tr> <td width="231" valign="top" style= 'width:173.15pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Cut level</span></p> </td> <td width="751" valign="top" style= 'width:563.3pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Level of sections that is used to split the document on topics. As example, if a level 2 is set, the document will be split on many topics as paragraphs with “Title 1” or “Title 2” ( or tags <H1> / <H2> if the document is HTML) are found. If is zero, only a topic page will be generated for the entire document.</span></p> </td> </tr> <tr> <td width="231" valign="top" style= 'width:173.15pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Table of contents max. level</span></p> </td> <td width="751" valign="top" style= 'width:563.3pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Maximum level of the sections that will appear on the table of contents of the help. If is zero, all the titles will appear on the table. As example, if a level 3 is set, Titles 1, 2 and 3 will appear on the table of contents.</span></p> </td> </tr> <tr> <td width="231" valign="top" style= 'width:173.15pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Index topics max. level</span></p> </td> <td width="751" valign="top" style= 'width:563.3pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Maximum level of the sections that will appear on the index of the help. If is zero, all the titles will appear on the index. As example, if a level 3 is set, Titles 1, 2 and 3 will appear on the index.</span></p> </td> </tr> <tr> <td width="231" valign="top" style= 'width:173.15pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Source files</span></p> </td> <td width="751" valign="top" style= 'width:563.3pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">List of HTML or Word file sources to generate the help. Only one HTML file can be used as source, but multiple Word documents can be used. No HTML and Word documents can be mixed on the list.</span></p> </td> </tr> <tr> <td width="231" valign="top" style= 'width:173.15pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Additional files</span></p> </td> <td width="751" valign="top" style= 'width:563.3pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">List of other files / directories that must be included on the compiled help. For example if the source file is an HTML, and it contains images, these images, or the directory with the images must be included in this list.</span></p> </td> </tr> <tr> <td width="231" valign="top" style= 'width:173.15pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Execute this command line after generate</span></p> </td> <td width="751" valign="top" style= 'width:563.3pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If you need to make something after the generation, as copy the CHM to other place, put it on a web site by ftp…, you can do it by a command line here.</span></p> </td> </tr> <tr> <td width="231" valign="top" style= 'width:173.15pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Generate button</span></p> </td> <td width="751" valign="top" style= 'width:563.3pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If the source file is a word document, <b>you MUST NOT be editing the file</b> when you press this button. When this button is pressed, the project / help generation will start and a new window will be opened, logging the generation process:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal" align="center" style='text-align:center'> <img border="0" width="372" height="291" src= "chmProcessor_archivos/image002.jpg" alt="image" /></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> </td> </tr> </table> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <h3><a name="node7" id="node7"></a><span lang="EN-GB" xml:lang= "EN-GB">Additional files</span></h3> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Here is stored the list of additional files that are reference by the help document: Images referenced on the header / footers, text files, etc. You can include single files or directories. If you include a directory, all files and subdirectories into the directory will be added. All the additional files and directories will be included at the same directory than the document source files. So, if a hyperlink on the source files needs to reference to some of these files, the URL should be relative to the current directory (= “</span><span class="CodeCar"><span lang="EN-GB" xml:lang= "EN-GB">./theadditionalfiletoreference.txt</span></span><span lang= "EN-GB" xml:lang="EN-GB">”)</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><b><u><span lang="EN-GB" xml:lang= "EN-GB">Important</span></u></b><span lang="EN-GB" xml:lang= "EN-GB">: By default, when MS Word saves a Word document as HTML, all relative links are rewritten. The application does a save as HTML into a temporal directory of the Word file to create the help. So, if you include a relative link “</span><span class= "CodeCar"><span lang="EN-GB" xml:lang= "EN-GB">./file.txt</span></span><span lang="EN-GB" xml:lang= "EN-GB">”, it will be replaced by a “</span><span class= "CodeCar"><span lang="EN-GB" xml:lang= "EN-GB"><temporaldirectory>/file.txt</span></span><span lang= "EN-GB" xml:lang="EN-GB">”. To avoid this, there is a MS Word setting called “Update links on save”. You <b>must</b> to disable this option to use relative links to additional files. <a href= "http://support.microsoft.com/kb/903163" target="_blank">This article</a> explains where it is located and how to disable it.</span></p> <h3><a name="node8" id="node8"></a><span lang="EN-GB" xml:lang= "EN-GB">Menu File</span></h3> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Here you can load and save the current help generation configuration from / to a “project” file, to access to the last open projects, and edit the settings of the application.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal" align="center" style='text-align:center'> <span lang="EN-GB" xml:lang="EN-GB"><img border="0" width="381" height="167" src="chmProcessor_archivos/image003.jpg" alt= "image" /></span></p> <h3><a name="node9" id="node9"></a><span lang="EN-GB" xml:lang= "EN-GB">Compiled Help</span></h3> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <table class="MsoNormalTable" border="1" cellspacing="0" cellpadding="0" width="100%" style= 'width:100.0%;border-collapse:collapse;border:none'> <tr> <td width="309" valign="top" style= 'width:232.0pt;border:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Compile help / Dst. File</span></p> </td> <td width="931" valign="top" style= 'width:697.95pt;border:solid windowtext 1.0pt; border-left:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If it’s checked, the help will be compiled on a CHM file, on the path selected at the Dst. File field.</span></p> </td> </tr> <tr> <td width="309" valign="top" style= 'width:232.0pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Generate help project</span></p> </td> <td width="931" valign="top" style= 'width:697.95pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If it’s checked, a help project for the Microsoft Help Workshop will be generated at the directory selected on Dst. Directory, and it will not be compiled.</span></p> </td> </tr> <tr> <td width="309" valign="top" style= 'width:232.0pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Generate web / Dst. Web directory / Description meta / Keywords meta</span></p> </td> <td width="931" valign="top" style= 'width:697.95pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If “Generate” it’s checked, a simple web with the help content will be generated on the Dst. directory. The description and meta fields are the values of this “meta” tags at the index of the web page generated.</span></p> </td> </tr> <tr> <td width="309" valign="top" style= 'width:232.0pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">HTML Header File</span></p> </td> <td width="931" valign="top" style= 'width:697.95pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Can be null. If not, the content of this file will be added to the start of each topic page as header. The content must be HTML code. As example, this file can contain an IMG tag with the banner of the application title.</span></p> </td> </tr> <tr> <td width="309" valign="top" style= 'width:232.0pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">HTML Footer File</span></p> </td> <td width="931" valign="top" style= 'width:697.95pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Can be null. If not, the content of this file will be added to the end of each topic page as footer. The content must be HTML code. As example it can be a <BR> tag to add an end bar to the page or a script to count visits at the generated web.</span></p> </td> </tr> <tr> <td width="309" valign="top" style= 'width:232.0pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">Language</span></p> </td> <td width="931" valign="top" style= 'width:697.95pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Language of the CHM contents. If you select a language with a <a href= "http://en.wikipedia.org/wiki/Code_page">character codepage</a> distinct of the system default, you <b>must</b> to install Microsoft AppLocale and check “Use Microsoft AppLocale to comple CHM files” on the <a href="start.htm#_Settings">Settings</a> window.</span></p> </td> </tr> </table> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <h3><a name="node10" id="node10"></a><span lang="EN-GB" xml:lang= "EN-GB">Web Help</span></h3> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <table class="MsoNormalTable" border="1" cellspacing="0" cellpadding="0" width="100%" style= 'width:100.0%;border-collapse:collapse;border:none'> <tr> <td width="287" valign="top" style= 'width:214.95pt;border:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Generate Web / Dst. Web directory</span></p> </td> <td width="953" valign="top" style= 'width:715.0pt;border:solid windowtext 1.0pt; border-left:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If “Generate” it’s checked, a simple web with the help content will be generated on the Dst. directory.</span></p> </td> </tr> <tr> <td width="287" valign="top" style= 'width:214.95pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">Description meta / Keywords meta</span></p> </td> <td width="953" valign="top" style= 'width:715.0pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Values of the “meta” tags at the web pages generated. They should explain to the web indexers (as Google) the topic of the document.</span></p> </td> </tr> <tr> <td width="287" valign="top" style= 'width:214.95pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">HTML Header File</span></p> </td> <td width="953" valign="top" style= 'width:715.0pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Can be null. If not, the content of this file will be added to the start of each topic page as header. The content must be HTML code. As example, this file can contain an IMG tag with the banner of the application title. This can be different to the header of the CHM.</span></p> </td> </tr> <tr> <td width="287" valign="top" style= 'width:214.95pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">HTML Footer File</span></p> </td> <td width="953" valign="top" style= 'width:715.0pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Can be null. If not, the content of this file will be added to the end of each topic page as footer. The content must be HTML code. As example it can be a <BR> tag to add an end bar to the page or a script to count visits at the generated web, or a javascript code to register the visits. This can be different to the footer of the CHM.</span></p> </td> </tr> <tr> <td width="287" valign="top" style= 'width:214.95pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">Language</span></p> </td> <td width="953" valign="top" style= 'width:715.0pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Language used on the texts of the web site. If your favourite language is not here, you can create your own translation. To do this check at the “webTranslations” folder of the program. Copy the “English.txt” to your “mylanguage.txt”, open it with the notepad, and change the text of each second line. Example:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">“English.txt” file:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">Contents</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">Contents</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">Topics</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">Topics</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">…</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">“mylanguage.txt”:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">Contents</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"><translation of Contents></span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">Topics</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"><translation of Topics></span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">…</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If you do this, please or <a href= "http://sourceforge.net/tracker/?group_id=197104&atid=960129">put an entry at the patches tracker</a> and it will be added to the application.</span></p> </td> </tr> <tr> <td width="287" valign="top" style= 'width:214.95pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Make Full Text Search (Require ASP.NET application)</span></p> </td> <td width="953" valign="top" style= 'width:715.0pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If it’s checked, a full text index of the document will be created, and all the document text can be searched. To run the searches, the web site must be hosted into an ASP.NET server. Only Microsoft IIS 6 and 7 has been test, but probably will work with the Mono server (only over Windows).</span></p> <p class="MsoNormal"><span lang="EN-US" xml:lang= "EN-US"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If this field it’s not checked, a simple search at the web help will allow you to search at the topic titles of the document only.</span></p> </td> </tr> <tr> <td width="287" valign="top" style= 'width:214.95pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"><head> include file</span></p> </td> <td width="953" valign="top" style= 'width:715.0pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Can be null. If not, the content of this file will be added into the <head> tag of each topic page. The content must be valid HTML code for that head.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">As example, it can be the javascript tag needed by Google Analytics to register the visits.</span></p> </td> </tr> <tr> <td width="287" valign="top" style= 'width:214.95pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Make Sitemap / Web Base / Change Freq.</span></p> </td> <td width="953" valign="top" style= 'width:715.0pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If “Make sitemap” is checked, a file called “sitemap.xml.gz” will be added to the web site. This file is a help for the web indexers as Google to know what pages contains your web site. See <a href= "http://www.google.com/webmasters/sitemaps/" target= "_blank">http://<span lang="EN-US" xml:lang= "EN-US">www.google.com/webmasters/sitemaps/</span></a></span> <span lang="EN-US" xml:lang="EN-US">to know more about this file. If you check this field, you must to put the root of your web site at the field “Web base” (as example, “<a href= "http://chmprocessor.sf.net/" target= "_blank">http://chmprocessor.sf.net</a>”). At the field “Change freq.” you say the frequency of change of the document: daily, monthly, etc.</span></p> </td> </tr> <tr> <td width="287" valign="top" style= 'width:214.95pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Web template</span></p> </td> <td width="953" valign="top" style= 'width:715.0pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Here you select the template to generate the webhelp. chmProcessor comes with some standard templates that can be chosen here. If you have built your own template, you can chose here the value “Custom”, and select the location of your template at the “Template directory” field.</span></p> </td> </tr> <tr> <td width="287" valign="top" style= 'width:214.95pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Template directory</span></p> </td> <td width="953" valign="top" style= 'width:715.0pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If “Web template” is “Custom”, here you define the location of the custom template for this help project.</span></p> </td> </tr> </table> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">The standard “template” pages for the web help are stored at the “webFiles” folder into the chmProcessor installation. If you want to change the look of the web help, you can edit them, but don’t change the texts %XXX% because they are replaced by the application during the generation process. If you write a nice template and you want to share it with the world, please <a href= "http://sourceforge.net/tracker/?group_id=197104&atid=960129">put an entry at the patches tracker</a> and it will be added to the application.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If you want to add navigation links on the header / footer of the help topics, the application can replace some texts with the URL for the previous/next topic page. Here are the texts to put:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <table class="MsoTableGrid" border="1" cellspacing="0" cellpadding= "0" width="100%" style= 'width:100.0%;border-collapse:collapse;border:none'> <tr> <td width="113" valign="top" style= 'width:84.65pt;border:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal">%NEXTLINK%</p> </td> <td width="1125" valign="top" style= 'width:843.8pt;border:solid windowtext 1.0pt; border-left:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Link to the previous topic page. If there is no previous page, it will be replaced by a “#”</span></p> </td> </tr> <tr> <td width="113" valign="top" style= 'width:84.65pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">%PREVLINK%</span></p> </td> <td width="1125" valign="top" style= 'width:843.8pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Link to the next topic page. If there is no next page, it will be replaced by a “#”</span></p> </td> </tr> <tr> <td width="113" valign="top" style= 'width:84.65pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">%HOMELINK%</span></p> </td> <td width="1125" valign="top" style= 'width:843.8pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Link to the first topic page.</span></p> </td> </tr> </table> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">So, a tag to the previous page would be like this:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="Code"><span lang="EN-GB" xml:lang="EN-GB"><a href="%PREVLINK%">Previous</a></span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <h3><a name="node11" id="node11"></a><span lang="EN-GB" xml:lang= "EN-GB">PDF / XPS</span></h3> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <table class="MsoNormalTable" border="1" cellspacing="0" cellpadding="0" width="100%" style= 'width:100.0%;border-collapse:collapse;border:none'> <tr> <td width="145" valign="top" style= 'width:108.5pt;border:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Generate PDF / Dst. File</span></p> </td> <td width="952" valign="top" style= 'width:713.75pt;border:solid windowtext 1.0pt; border-left:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If it’s checked, a PDF file will be generated with the printing of the source Word / Html document at the file on Dst. File. You will need to have the PDFCreator or the “MS Office 2007 Add-in: Save as PDF / XPS” installed to use this.</span></p> </td> </tr> <tr> <td width="145" valign="top" style= 'width:108.5pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Generate with PdfCreator / Generate with Office 2007 add-in (recommended)</span></p> </td> <td width="952" valign="top" style= 'width:713.75pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Choose of how to generate the PDF file: With PDFCreator o with the MS Office 2007 Add-in. <b>The last one is the recommended</b>. Only version 1.2 of PdfCreator will work, and sometimes hangs up the PDF print.</span></p> </td> </tr> <tr> <td width="145" valign="top" style= 'width:108.5pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Generate XPS / Dst. File</span></p> </td> <td width="952" valign="top" style= 'width:713.75pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If it’s checked, a XPS file will be generated with the printing of the source Word / Html document at the file on Dst. File. You will need to have the the “MS Office 2007 Add-in: Save as PDF / XPS” installed to use this.</span></p> </td> </tr> </table> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <h3><a name="node12" id="node12"></a><span lang="EN-GB" xml:lang= "EN-GB">Java Help</span></h3> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <table class="MsoNormalTable" border="1" cellspacing="0" cellpadding="0" width="100%" style= 'width:100.0%;border-collapse:collapse;border:none'> <tr> <td width="207" valign="top" style= 'width:155.55pt;border:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Generate Java Help / Dst. File</span></p> </td> <td width="1033" valign="top" style= 'width:774.4pt;border:solid windowtext 1.0pt; border-left:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If it’s checked, the help will be compile a Java Help JAR file, on the path selected at the Dst. File field. You will need to have the JDK and the Java Help installed to use this.</span></p> </td> </tr> </table> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <h3><a name="_Settings"></a><span lang="EN-GB" xml:lang= "EN-GB">Settings</span></h3> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Going to the menu File > Settings..., you can access to the settings of the program:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal" align="center" style='text-align:center'> <span lang="EN-GB" xml:lang="EN-GB"><img border="0" width="462" height="358" src="chmProcessor_archivos/image004.jpg" alt= "image" /></span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <table class="MsoNormalTable" border="1" cellspacing="0" cellpadding="0" width="100%" style= 'width:100.0%;border-collapse:collapse;border:none'> <tr> <td width="217" valign="top" style= 'width:162.5pt;border:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">MS Help Workshop Compiler Path</span></p> </td> <td width="1031" valign="top" style= 'width:773.25pt;border:solid windowtext 1.0pt; border-left:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Path to the compiler exe contained into the HTML Help Workshop. It must to point to the installation directory of this package.</span></p> </td> </tr> <tr> <td width="217" valign="top" style= 'width:162.5pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Use Tidy over the split HTML files</span></p> </td> <td width="1031" valign="top" style= 'width:773.25pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB"><a href= "http://tidy.sourceforge.net/">Tidy</a> is software than cleans and repair HTML files, according to the W3C standards. If it’s checked, when a HTML page of the help is generated, tidy is executed over this file. Usually works VERY well, but I have found some problem with some XHTML files. If you have troubles with the generated HTML (strange characters, javascript errors, etc) try to uncheck this field.</span></p> </td> </tr> <tr> <td width="217" valign="top" style= 'width:162.5pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Sun JDK Path</span></p> </td> <td width="1031" valign="top" style= 'width:773.25pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">Installation path of the Sun JDK. It’s needed if you want to generate Java Help.</span></p> </td> </tr> <tr> <td width="217" valign="top" style= 'width:162.5pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Java Help directory path</span></p> </td> <td width="1031" valign="top" style= 'width:773.25pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">Installation path of the Sun Java Help. It’s needed if you want to generate Java Help.</span></p> </td> </tr> <tr> <td width="217" valign="top" style= 'width:162.5pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Save relative paths on projects</span></p> </td> <td width="1031" valign="top" style= 'width:773.25pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If is checked, when you save a project, the paths to directories and files of the project will be stored relative to the location of the project file. So, if you store your source files and the project file on the same folder, you will can move that folder safely to other locations, and reopen the project and the reference to the source files will still work.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If is not checked, paths will be saved as absolute, so, if you move your source files, they will not be found.</span></p> </td> </tr> <tr> <td width="217" valign="top" style= 'width:162.5pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB">Remove/replace broken internal links</span></p> </td> <td width="1031" valign="top" style= 'width:773.25pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If it’s checked, when an internal link (a link pointing to a place into the same document) is broken, the application will try to search a section into the document with the same title as the broken link text. If it’s found, the link will be changed to point to that section. If no section is found, the link will be removed, but its content (text, image, etc) will be kept.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If it’s unchecked, the broken link will be kept as is.</span></p> </td> </tr> <tr> <td width="217" valign="top" style= 'width:162.5pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Use Microsoft AppLocale to compile CHM files / path</span></p> </td> <td width="1031" valign="top" style= 'width:773.25pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If it’s checked, the execution of the CHM compiler will be executed by the AppLocate application. This is <b><u>only</u></b> needed if you will generate a CHM file for a <a href= "http://en.wikipedia.org/wiki/Code_page">character codepage</a> distinct than the system default.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">This is the short story:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">AppLocate is an application that changes the codepage of the execution of other application. If you don’t use it generating a CHM file for a <a href="http://en.wikipedia.org/wiki/Code_page">character codepage</a> distinct than the system default, the generated table of contents and index of the CHM file will show wrong characters.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">The long story:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">The MS Help workshops, and so the CHM compiler, are very outdated software, and they don’t know anything about <a href= "http://en.wikipedia.org/wiki/Unicode">Unicode</a>. More sad, if you set a Language on the help workshop project, you encode the source files for the TOC and index with the right encoding, all of this is ignored, and the local system locale is used to generate the CHM file. The patch for this is to use AppLocate, to lie the CHM compiler about the local codepage. More info about this topic can be found here: <a href= "http://blogs.msdn.com/b/sandcastle/archive/2007/09/29/chm-localization-and-unicode-issues-dbcsfix-exe.aspx" target= "_blank">http://blogs.msdn.com/b/sandcastle/archive/2007/09/29/chm-localization-and-unicode-issues-dbcsfix-exe.aspx</a></span></p> </td> </tr> <tr> <td width="217" valign="top" style= 'width:162.5pt;border:solid windowtext 1.0pt; border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Wait MS Word until it closes open documents</span></p> </td> <td width="1031" valign="top" style= 'width:773.25pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">When the help is generated from a Word file, MS Word is called to save it as HTML, then the Word file is closed and then MS Word is closed. It has been reported that sometimes the application hangs waiting Word do the closes.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If this field is checked, the application will wait (up to 15 seconds) to Word closes files and itself. If it’s not checked, the application will not wait. Uncheck this field can generate troubles with large Word files, and it’s not recommended.</span></p> </td> </tr> </table> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <h2><a name="node13" id="node13"></a><span lang="EN-GB" xml:lang= "EN-GB">Console Interface</span></h2> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">The application can be called from the command line to generate or open project files. There are two exes for that: ChmProcessor.exe and ChmProcessorCmd.exe. The first one is the Windows application, and the second is a console application. ChmProcessor.exe can be used to open or generate help files, ChmProcessorCmd.exe only to generate help files. The command line parameters for both are the same:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="Code"><span lang="EN-GB" xml:lang="EN-GB">Use XXXXX.exe [<projectfile.WHC> | <wordfile.DOC> |<wordfile.DOCX> | <wordfile.HTM> | <wordfile.HTML>] [/g] [/e] [/y] [/?][/q] [/l1] [/l2] [/l3] [/l4]</span></p> <p class="Code"><span lang="EN-GB" xml:lang= "EN-GB">Options:</span></p> <p class="Code"><span lang="EN-GB" xml:lang= "EN-GB">/g Generate help sets (chm, javahelp, pdfs,…) specified by the project</span></p> <p class="Code"><span lang="EN-GB" xml:lang= "EN-GB">/e Exit after generate</span></p> <p class="Code"><span lang="EN-GB" xml:lang= "EN-GB">/y </span>Dont ask for confirmations</p> <p class="Code">/? Print help and exit</p> <p class="Code"> /q Prevents a window being shown when run with the /g command line and logs messages to stdout/stderr</p> <p class="Code"><span lang="EN-GB" xml:lang="EN-GB">/l1 /l2 /l3 /l4 Lets you choose how much information is output, where /l1 are errors, /l2 warnings, /l3 application status information and /l4 are debug messages</span></p> <p class="MsoNormal"><span lang="EN-GB" style= 'font-family:"Courier New"' xml:lang="EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">If you are going to generate a help file from a batch file, ChmProcessorCmd.exe is preferred. Windows applications have limitations to interact with the console.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">As you can see, you can generate a CHM directly from a Word file with a command line call, but this has a lot of limitations: The CHM generated will not have cut levels (a single help page will be generated), no title, etc. The preferred way to use the command line is create a WHC file, set there the title, cut levels, etc. and to generate the help with that file.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">The application exit codes are:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <ul style='margin-top:0cm' type="disc"> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">0: OK</span></li> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">1: There were warnings.</span></li> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">2: There were errors.</span></li> </ul> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <h1><a name="node14" id="node14"></a><span lang="EN-GB" xml:lang= "EN-GB">Web Site Generation</span></h1> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">The application can generate a simple web site with a similar format to the compiled help. Any topic indexed at the help can be opened directly using the URL. The way to open it depends of the template used.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">For the “Frames” template, a “topic” parameter can be used on the URL. As example, if you have a topic called “Download”, you can open it like this: <a href= "http://chmprocessor.sf.net/index.html?topic=Downloads" target= "_blank">http://chmprocessor.sf.net/index.html?topic=Downloads</a>.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">For the “jQuery” template, you can use the “topic” parameter and the URL hash. The last one is the preferred, because the hash will be updated each time a new help topic is loaded. An example is <a href="http://chmprocessor.sf.net/index.html#Downloads">http://chmprocessor.sf.net/index.html#Downloads</a>.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Here are some examples of web sites generated with chmProcessor:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <ul style='margin-top:0cm' type="disc"> <li class="MsoNormal"><a href= "http://adminucvngn.sourceforge.net/Manual_es/index.html" target= "_blank">AdminUCV NGN manual</a></li> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB"><a href= "http://www.viewlog.com/docs/sitefx_users_guide/index.html" target= "_blank">SiteFX User's Guide</a></span></li> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB"><a href= "http://www.narec.co.uk/cmsfiles/narec/Carbon_Mixer/index.html" target="_blank">Microrenewables Toolkit</a></span></li> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB"><a href= "http://perswww.lessius.eu/verheyen/Word2007/Bijlagen_%20Word_2007_vgl-web/index.html" target="_blank">Bijlagen: de Vergelijkingseditor in Word 2007</a></span></li> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB"><a href= "http://help-cz.sprinxcrm.com/" target="_blank">SprinxCRM online help</a></span></li> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB"><a href= "http://www.grinmark.com/products/sfsync/documentation.html" target="_blank">Agile Salesforce to Exchange Synchronizer</a></span></li> </ul> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <h2><a name="node15" id="node15"></a><span lang="EN-GB" xml:lang= "EN-GB">Note about Chrome</span></h2> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">The standard webhelp templates of chmProcessor use frames (or iframes) and javascript to show the help content. Chrome has a security control that disable some javascript functions of frames/iframes when the page is on the local file system (=when the protocol is file:///). The standard webhelp templates of chmProcessor use those functions, so you will get an error:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="Code"><span lang="EN-GB" xml:lang="EN-GB"> Blocked a frame with origin "null" from accessing a frame with origin "null". Protocols, domains, and ports must match</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">This will not happen when the page is located on a web server (=when the protocol is http://). To fix this, you must run Chrome with the option “--allow-file-access-from-files”:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="Code"><span lang="EN-GB" xml:lang="EN-GB">"C:\Program Files\Google\Chrome\Application\chrome.exe" --allow-file-access-from-files "thewebhelpdirectory\index.html"</span></p> <h1><a name="node16" id="node16"></a><span lang="EN-GB" xml:lang= "EN-GB">License</span></h1> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">The license of chmProcessor is <a href= "http://www.gnu.org/copyleft/gpl.html" target="_blank">GPL</a>. It uses the following software:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <ul style='margin-top:0cm' type="disc"> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB"><a href= "http://tango.freedesktop.org/Tango_Desktop_Project" target= "_blank">Tango icons</a></span></li> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB"><a href= "http://tidy.sourceforge.net/" target="_blank">Tidy</a></span></li> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB"><a href= "http://www.sqlite.org/" target="_blank">SQLite</a></span></li> </ul> <h1><a name="node17" id="node17"></a><span lang="EN-GB" xml:lang= "EN-GB">Downloads</span></h1> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">You can download the chmProcessor installation binaries from <a href= "http://sourceforge.net/project/showfiles.php?group_id=197104" target="_blank">here</a>. Source code is available from subversion repository <a href= "https://sourceforge.net/p/chmprocessor/code/HEAD/tree/" target= "_blank">here</a>. You can get this document as a PDF <a href= "http://chmprocessor.sf.net/chmProcessorDocumentation.pdf" target= "_blank">here</a>. See the <a href="changelog.txt">changelog here</a>.</span></p> <h1><a name="node18" id="node18"></a><span lang="EN-GB" xml:lang= "EN-GB">Bug reporting</span></h1> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">The bug reporting can be done at the SourceForge page: <a href= "https://sourceforge.net/p/chmprocessor/bugs/" target= "_blank">https://sourceforge.net/p/chmprocessor/bugs/</a>. <b>Please, post always the following elements with the bug report:</b></span></p> <p class="MsoNormal"><b><span lang="EN-GB" xml:lang= "EN-GB"> </span></b></p> <ul style='margin-top:0cm' type="disc"> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">An example file (the Word/Html document, additional files, the WHC help project file, etc.) to reproduce the bug.</span></li> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">The chmProcessor version.</span></li> </ul> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">It’s the faster way to fix bugs.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <h1><a name="node19" id="node19"></a><span lang="EN-GB" xml:lang= "EN-GB">Info for developers</span></h1> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Here come some tips if you want to open a help file generated with chmProcessor from your application. Usually there is three ways to show a help topic on your application:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <ul style='margin-top:0cm' type="disc"> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Open directly the help file.</span></li> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Open a help topic by its title.</span></li> <li class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Open a help topic by its HTML file name.</span></li> </ul> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">The last one is discarded, because you cannot control how chmProcessor will generate the file names, and more, those file names can change if you add more titles to your source help document. So, if you want to open a topic help directly you should use the topic text titles to open the help. Here are the functions you can use to open the help by one topic name on C# and Java:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <h2><a name="node20" id="node20"></a><span lang="EN-GB" xml:lang= "EN-GB">JavaHelp</span></h2> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Your code should look something like this, without any warranty:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="Code">// The generated JAR must to be on your class path.</p> <p class="Code"><span lang="EN-GB" xml:lang="EN-GB">ClassLoader cl = this.getClass().getClassLoader();</span></p> <p class="Code"><span lang="EN-GB" xml:lang="EN-GB">URL hsURL = HelpSet.findHelpSet(cl, “help.hs”); // help.hs if the fixed name for the generated help.</span></p> <p class="Code"><span lang="EN-GB" xml:lang="EN-GB">HelpSet hs = new HelpSet(null, hsURL);</span></p> <p class="Code"><span lang="EN-GB" xml:lang="EN-GB">HelpBroker hb = hs.createHelpBroker();</span></p> <p class="Code"><span lang="EN-GB" xml:lang= "EN-GB">hb.setCurrentID(“The topic title to show”);</span></p> <p class="Code">hb.setDisplayed(true);</p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Much, much more info on the JavaHelp documentation.</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <h2><a name="node21" id="node21"></a><span lang="EN-GB" xml:lang= "EN-GB">CHM file with C#</span></h2> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="Code"><span lang="EN-GB" xml:lang= "EN-GB">System.Windows.Forms.Help.ShowHelp(null, “C:\pathtomyhelpfile.CHM” , System.Windows.Forms.HelpNavigator.KeywordIndex , “The topic title to show”);</span></p> <p class="Code"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <h2><a name="node22" id="node22"></a><span lang="EN-GB" xml:lang= "EN-GB">Web help with C#</span></h2> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang="EN-GB">Keep in mind that the topic title must be encoded for the URL:</span></p> <p class="MsoNormal"><span lang="EN-GB" xml:lang= "EN-GB"> </span></p> <p class="Code"><span lang="EN-GB" xml:lang= "EN-GB">System.Diagnostics.</span><span lang="EN-GB" xml:lang= "EN-GB">Process.Start("http://chmprocessor.sourceforge.net/index.html?topic=Web%20Help");</span></p> </div>
Contents
Topics
Search
chmProcessor. A Html / Word converter to Compiled HTML Help / Java Help (v 1.7.2)
Requirements
Limitations
Interface
Win Interface
Source files
General
Additional files
Menu File
Compiled Help
Web Help
PDF / XPS
Java Help
Settings
Console Interface
Web Site Generation
Note about Chrome
License
Downloads
Bug reporting
Info for developers
JavaHelp
CHM file with C#
Web help with C#
Additional files
Bug reporting
CHM file with C#
chmProcessor. A Html / Word converter to Compiled HTML Help / Java Help (v 1.7.2)
Compiled Help
Console Interface
Downloads
General
Info for developers
Interface
Java Help
JavaHelp
License
Limitations
Menu File
Note about Chrome
PDF / XPS
Requirements
Settings
Source files
Web Help
Web help with C#
Web Site Generation
Win Interface
Generated with
chmProcessor
Generated with
chmProcessor