chmProcessor. A Html / Word converter to Compiled HTML Help (CHM)
Generated with
chmProcessor
<div class="Section1"> <h1><a name="NODO0" id="NODO0"></a><span lang="EN-GB">chmProcessor. A Html / Word converter to Compiled HTML Help / Java Help</span></h1> <p class="MsoNormal"><span lang="EN-GB">chmProcessor is a tool that allows generating a help project and a compiled HTML help (CHM file) from a MS Word or HTML 4 file. 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 4 file, the titles must use the <H1>, <H2>, etc. tags.</span></p> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="MsoNormal"><span 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"> </span></p> <p style="TEXT-INDENT: -18pt; MARGIN-LEFT: 36pt" class="MsoNormal"> <span style="FONT-FAMILY: Symbol" lang="EN-GB">·<span style= "FONT: 7pt 'Times New Roman'"> </span></span> <span lang="EN-GB">A Microsoft Help Workshop project.</span></p> <p style="TEXT-INDENT: -18pt; MARGIN-LEFT: 36pt" class="MsoNormal"> <span style="FONT-FAMILY: Symbol" lang="EN-GB">·<span style= "FONT: 7pt 'Times New Roman'"> </span></span> <span lang="EN-GB">A compiled HTML help (CHM file).</span></p> <p style="TEXT-INDENT: -18pt; MARGIN-LEFT: 36pt" class="MsoNormal"> <span style="FONT-FAMILY: Symbol" lang="EN-GB">·<span style= "FONT: 7pt 'Times New Roman'"> </span></span> <span lang="EN-GB">A web site like this.</span></p> <p style="TEXT-INDENT: -18pt; MARGIN-LEFT: 36pt" class="MsoNormal"> <span style="FONT-FAMILY: Symbol" lang="EN-GB">·<span style= "FONT: 7pt 'Times New Roman'"> </span></span> <span lang="EN-GB">An Adobe PDF file.</span></p> <p style="TEXT-INDENT: -18pt; MARGIN-LEFT: 36pt" class="MsoNormal"> <span style="FONT-FAMILY: Symbol" lang="EN-GB">·<span style= "FONT: 7pt 'Times New Roman'"> </span></span> <span lang="EN-GB">A Microsoft XPS file.</span></p> <p style="TEXT-INDENT: -18pt; MARGIN-LEFT: 36pt" class="MsoNormal"> <span style="FONT-FAMILY: Symbol" lang="EN-GB">·<span style= "FONT: 7pt 'Times New Roman'"> </span></span> <span lang="EN-GB">A Java Help JAR file.</span></p> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <h1><a name="NODO1" id="NODO1"></a><span lang= "EN-GB">Requirements</span></h1> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB">To use this program, you must to have installed the following software:</span></p> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <ul style="MARGIN-TOP: 0cm" type="disc"> <li class="MsoNormal"><b><span lang="EN-GB">Microsoft Windows</span></b><span lang="EN-GB">. Tested versions: Windows 2000 (32 bits), Windows XP (32 bits), Windows 7 (32 and 64 bits). 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">Internet Explorer 6 or above.</span></b></li> <li class="MsoNormal"><b><span lang="EN-GB">Microsoft .NET Framework 2.0</span></b><span 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">HTML Help Workshop</span></b><span 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">Microsoft Word</span></b> <span lang="EN-GB">if you will work with Word files. Ms Word 2003 and 2007 has been tested.</span></li> </ul> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB">Optionally, you can generate PDF and XPS files. To generate a PDF, there is two ways: Use PDFCreator or use 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"> </span></p> <ul style="MARGIN-TOP: 0cm" type="disc"> <li class="MsoNormal"><b><span lang= "EN-GB">PDFCreator</span></b><span 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">Microsoft Office 2007 Add-in</span></b><span lang="EN-GB">. It’s an optional tool of the Office suite to generate PDF / XPS files. 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"> </span></p> <p class="MsoNormal"><span 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"> </span></p> <ul style="MARGIN-TOP: 0cm" type="disc"> <li class="MsoNormal"><b><span lang="EN-GB">Sun JDK</span></b><span 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">Java Help</span></b> <span 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"> </span></p> <p class="MsoNormal"><span 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"> </span></p> <ul style="MARGIN-TOP: 0cm" type="disc"> <li class="MsoNormal"><b><span lang="EN-GB">Microsoft AppLocale</span></b><span 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"> </span></p> <h1><a name="NODO2" id="NODO2"></a><span lang= "EN-GB">Limitations</span></h1> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <ul style="MARGIN-TOP: 0cm" type="disc"> <li class="MsoNormal"><span 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"><a href= "../../../../Documents/REPOSITORIO/Documents/REPOSITORIO/chmprocessor/trunk/chmProcessor/doc/Windows-1252"> Windows-1252</a>.</span> <span lang="EN-US"> Version 1.6 and higher should work. I need feedback about this topic. I have done some tests, using</span> <span lang="EN-GB">AppLocale,</span> <span lang="EN-US">with Cyrillic and they seem to work. If you live on a country where the Latin alphabet is not the standard (China, Thailand, Russia, etc), please say me if it’s working on</span> <span lang="EN-GB"><a href="http://sourceforge.net/users/tonibo/" target="_blank">my mail address at sourceforge</a> or at the <a href= "http://sourceforge.net/tracker/?group_id=197104&atid=960127">bug tracker</a>.</span></li> <li class="MsoNormal"><b><span lang="EN-US">Not all</span></b> <span 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">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">Only version 4 of HTML has been tested for source files. Other versions (=5) probably don’t work.</span></li> <li class="MsoNormal"><span lang="EN-US">JavaHelp generation will not work if “</span><span lang="EN-GB">Use Tidy over the split HTML files” is not checked on <a href= "1.htm#_Settings">settings</a> window.</span> <span lang= "EN-US">JavaHelp seems to need 100% standard HTML input files to work.</span></li> <li class="MsoNormal"><span 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> </ul> <h1><a name="NODO3" id="NODO3"></a><span lang= "EN-GB">Interface</span></h1> <h2><a name="NODO4" id="NODO4"></a><span lang="EN-GB">Win Interface</span></h2> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB"><a href= "http://www.softoxi.com/">Softoxi</a> has made <a href= "http://www.softoxi.com/chmprocessor-video-trailer-screenshots.html"> a nice video showing the installation and the user interface of the application</a>.</span></p> <p class="MsoNormal"><span lang="EN-GB">This is the main window:</span></p> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p style="TEXT-ALIGN: center" class="MsoNormal" align="center"> <span lang="EN-GB"><img border="0" src= "chmProcessor_archivos/image001.gif" width="578" height="420" alt= "image"></span></p> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <h3><a name="NODO5" id="NODO5"></a><span lang= "EN-GB">General</span></h3> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <table style= "BORDER-BOTTOM: medium none; BORDER-LEFT: medium none; WIDTH: 100%; BORDER-COLLAPSE: collapse; BORDER-TOP: medium none; BORDER-RIGHT: medium none" class="MsoNormalTable" border="1" cellspacing="0" cellpadding="0" width="100%"> <tbody> <tr> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 173.15pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: windowtext 1pt solid; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="231"> <p class="MsoNormal"><span lang="EN-GB">Help Title</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 563.3pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: windowtext 1pt solid; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="751"> <p class="MsoNormal"><span lang="EN-GB">Title of the generated help.</span></p> </td> </tr> <tr> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 173.15pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="231"> <p class="MsoNormal"><span lang="EN-GB">Cut level</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 563.3pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="751"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 173.15pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="231"> <p class="MsoNormal"><span lang="EN-GB">Table of contents max. level</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 563.3pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="751"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 173.15pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="231"> <p class="MsoNormal"><span lang="EN-GB">Index topics max. level</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 563.3pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="751"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 173.15pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="231"> <p class="MsoNormal"><span lang="EN-GB">Source files</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 563.3pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="751"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 173.15pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="231"> <p class="MsoNormal"><span lang="EN-GB">Additional files</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 563.3pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="751"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 173.15pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="231"> <p class="MsoNormal"><span lang="EN-GB">Execute this command line after generate</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 563.3pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="751"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 173.15pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="231"> <p class="MsoNormal"><span lang="EN-GB">Generate button</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 563.3pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="751"> <p class="MsoNormal"><span 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"> </span></p> <p style="TEXT-ALIGN: center" class="MsoNormal" align="center"> <img border="0" src="chmProcessor_archivos/image002.jpg" width= "372" height="291" alt="image"></p> <p class="MsoNormal"><span lang="EN-GB"> </span></p> </td> </tr> </tbody> </table> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <h3><a name="NODO6" id="NODO6"></a><span lang="EN-GB">Menu File</span></h3> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="MsoNormal"><span 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"> </span></p> <p style="TEXT-ALIGN: center" class="MsoNormal" align="center"> <span lang="EN-GB"><img border="0" src= "chmProcessor_archivos/image003.jpg" width="381" height="167" alt= "image"></span></p> <h3><a name="NODO7" id="NODO7"></a><span lang="EN-GB">Compiled Help</span></h3> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <table style= "BORDER-BOTTOM: medium none; BORDER-LEFT: medium none; WIDTH: 100%; BORDER-COLLAPSE: collapse; BORDER-TOP: medium none; BORDER-RIGHT: medium none" class="MsoNormalTable" border="1" cellspacing="0" cellpadding="0" width="100%"> <tbody> <tr> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 232pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: windowtext 1pt solid; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="309"> <p class="MsoNormal"><span lang="EN-GB">Compile help / Dst. File</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 697.95pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: windowtext 1pt solid; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="931"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 232pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="309"> <p class="MsoNormal"><span lang="EN-GB">Generate help project</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 697.95pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="931"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 232pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="309"> <p class="MsoNormal"><span lang="EN-GB">Generate web / Dst. Web directory / Description meta / Keywords meta</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 697.95pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="931"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 232pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="309"> <p class="MsoNormal"><span lang="EN-GB">HTML Header File</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 697.95pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="931"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 232pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="309"> <p class="MsoNormal"><span lang="EN-GB">HTML Footer File</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 697.95pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="931"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 232pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="309"> <p class="MsoNormal"><span lang="EN-GB">Language</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 697.95pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="931"> <p class="MsoNormal"><span 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="1.htm#_Settings">Settings</a> window.</span></p> </td> </tr> </tbody> </table> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <h3><a name="NODO8" id="NODO8"></a><span lang="EN-GB">Web Help</span></h3> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <table style= "BORDER-BOTTOM: medium none; BORDER-LEFT: medium none; WIDTH: 100%; BORDER-COLLAPSE: collapse; BORDER-TOP: medium none; BORDER-RIGHT: medium none" class="MsoNormalTable" border="1" cellspacing="0" cellpadding="0" width="100%"> <tbody> <tr> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 214.95pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: windowtext 1pt solid; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="287"> <p class="MsoNormal"><span lang="EN-GB">Generate Web / Dst. Web directory</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 715pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: windowtext 1pt solid; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="953"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 214.95pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="287"> <p class="MsoNormal"><span lang="EN-GB">Description meta / Keywords meta</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 715pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="953"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 214.95pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="287"> <p class="MsoNormal"><span lang="EN-GB">HTML Header File</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 715pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="953"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 214.95pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="287"> <p class="MsoNormal"><span lang="EN-GB">HTML Footer File</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 715pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="953"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 214.95pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="287"> <p class="MsoNormal"><span lang="EN-GB">Language</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 715pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="953"> <p class="MsoNormal"><span 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"> </span></p> <p class="MsoNormal"><span lang="EN-GB">“English.txt” file:</span></p> <p class="MsoNormal"><span lang="EN-GB">Contents</span></p> <p class="MsoNormal"><span lang="EN-GB">Contents</span></p> <p class="MsoNormal"><span lang="EN-GB">Topics</span></p> <p class="MsoNormal"><span lang="EN-GB">Topics</span></p> <p class="MsoNormal"><span lang="EN-GB">…</span></p> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="MsoNormal"><span lang= "EN-GB">“mylanguage.txt”:</span></p> <p class="MsoNormal"><span lang="EN-GB">Contents</span></p> <p class="MsoNormal"><span lang="EN-GB"><translation of Contents></span></p> <p class="MsoNormal"><span lang="EN-GB">Topics</span></p> <p class="MsoNormal"><span lang="EN-GB"><translation of Topics></span></p> <p class="MsoNormal"><span lang="EN-GB">…</span></p> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB">If you do this, please send me your file to <a href="http://sourceforge.net/users/tonibo/" target="_blank">my mail address at sourceforge</a>, 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 214.95pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="287"> <p class="MsoNormal"><span lang="EN-GB">Make Full Text Search (Require ASP.NET application)</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 715pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="953"> <p class="MsoNormal"><span 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). Before run the web application, install the “</span><span lang="EN-US"><a href= "http://go.microsoft.com/fwlink/?LinkId=72637" target= "_blank">Microsoft Primary Interoperability Assemblies 2007</a></span><span lang="EN-GB">” at the web server machine. You can download it from <a href= "http://go.microsoft.com/fwlink/?LinkId=72637" target= "_blank">here</a>. If you don’t install this, you will get an “</span><span lang="EN-US">ERROR: Could not load file or assembly Microsoft.mshtml” message and the searches will not work.</span></p> <p class="MsoNormal"><span lang="EN-US"> </span></p> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 214.95pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="287"> <p class="MsoNormal"><span lang="EN-GB"><head> include file</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 715pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="953"> <p class="MsoNormal"><span 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">As example, it can be the javascript tag needed by Google Analytics to register the visits.</span></p> </td> </tr> <tr> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 214.95pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="287"> <p class="MsoNormal"><span lang="EN-GB">Make Sitemap / Web Base / Change Freq.</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 715pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="953"> <p class="MsoNormal"><span 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">www.google.com/webmasters/sitemaps/</span></a></span> <span 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> </tbody> </table> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB">The “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 send me a message to <a href= "http://sourceforge.net/users/tonibo/" target="_blank">my mail address at sourceforge</a>, 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> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <h3><a name="NODO9" id="NODO9"></a><span lang="EN-GB">PDF / XPS</span></h3> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <table style= "BORDER-BOTTOM: medium none; BORDER-LEFT: medium none; WIDTH: 100%; BORDER-COLLAPSE: collapse; BORDER-TOP: medium none; BORDER-RIGHT: medium none" class="MsoNormalTable" border="1" cellspacing="0" cellpadding="0" width="100%"> <tbody> <tr> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 108.5pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: windowtext 1pt solid; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="145"> <p class="MsoNormal"><span lang="EN-GB">Generate PDF / Dst. File</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 713.75pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: windowtext 1pt solid; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="952"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 108.5pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="145"> <p class="MsoNormal"><span lang="EN-GB">Generate with PdfCreator / Generate with Office 2007 add-in (recommended)</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 713.75pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="952"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 108.5pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="145"> <p class="MsoNormal"><span lang="EN-GB">Generate XPS / Dst. File</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 713.75pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="952"> <p class="MsoNormal"><span 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> </tbody> </table> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <h3><a name="NODO10" id="NODO10"></a><span lang="EN-GB">Java Help</span></h3> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <table style= "BORDER-BOTTOM: medium none; BORDER-LEFT: medium none; WIDTH: 100%; BORDER-COLLAPSE: collapse; BORDER-TOP: medium none; BORDER-RIGHT: medium none" class="MsoNormalTable" border="1" cellspacing="0" cellpadding="0" width="100%"> <tbody> <tr> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 155.55pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: windowtext 1pt solid; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="207"> <p class="MsoNormal"><span lang="EN-GB">Generate Java Help / Dst. File</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 774.4pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: windowtext 1pt solid; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="1033"> <p class="MsoNormal"><span 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> </tbody> </table> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <h3><a name="_Settings"></a><span lang="EN-GB">Settings</span></h3> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="MsoNormal"><span 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"> </span></p> <p style="TEXT-ALIGN: center" class="MsoNormal" align="center"> <span lang="EN-GB"><img border="0" src= "chmProcessor_archivos/image004.jpg" width="393" height="271" alt= "image"></span></p> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <table style= "BORDER-BOTTOM: medium none; BORDER-LEFT: medium none; WIDTH: 100%; BORDER-COLLAPSE: collapse; BORDER-TOP: medium none; BORDER-RIGHT: medium none" class="MsoNormalTable" border="1" cellspacing="0" cellpadding="0" width="100%"> <tbody> <tr> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 162.5pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: windowtext 1pt solid; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="217"> <p class="MsoNormal"><span lang="EN-GB">MS Help Workshop Compiler Path</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 773.25pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: windowtext 1pt solid; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="1031"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 162.5pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="217"> <p class="MsoNormal"><span lang="EN-GB">Use Tidy over the split HTML files</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 773.25pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="1031"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 162.5pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="217"> <p class="MsoNormal"><span lang="EN-GB">Sun JDK Path</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 773.25pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="1031"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 162.5pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="217"> <p class="MsoNormal"><span lang="EN-GB">Java Help directory path</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 773.25pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="1031"> <p class="MsoNormal"><span 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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 162.5pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="217"> <p class="MsoNormal"><span lang="EN-GB">Save relative paths on projects</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 773.25pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="1031"> <p class="MsoNormal"><span 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">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 style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 162.5pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="217"> <p class="MsoNormal"><span lang="EN-GB">Remove/replace broken internal links</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 773.25pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="1031"> <p class="MsoNormal"><span 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">If it’s unchecked, the broken link will be kept as is.</span></p> </td> </tr> <tr> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: windowtext 1pt solid; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 162.5pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="217"> <p class="MsoNormal"><span lang="EN-GB">Use Microsoft AppLocale to compile CHM files / path</span></p> </td> <td style= "BORDER-BOTTOM: windowtext 1pt solid; BORDER-LEFT: medium none; PADDING-BOTTOM: 0cm; PADDING-LEFT: 5.4pt; WIDTH: 773.25pt; PADDING-RIGHT: 5.4pt; BORDER-TOP: medium none; BORDER-RIGHT: windowtext 1pt solid; PADDING-TOP: 0cm" valign="top" width="1031"> <p class="MsoNormal"><span 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"> </span></p> <p class="MsoNormal"><span lang="EN-GB">This is the short story:</span></p> <p class="MsoNormal"><span 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"> </span></p> <p class="MsoNormal"><span lang="EN-GB">The long story:</span></p> <p class="MsoNormal"><span 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> </tbody> </table> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <h2><a name="NODO11" id="NODO11"></a><span lang="EN-GB">Console Interface</span></h2> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="Code"><span lang="EN-GB">Use chmProcessor.exe [<projectfile.</span>WHC> | <wordfile.DOC> |<wordfile.DOCX> | <wordfile.HTM> | <wordfile.HTML>] [/g] [/e] [/y] [/?][/q] [/l1] [/l2] [/l3]</p> <p class="Code">Options:</p> <p class="Code">/g Generate help sets (chm, javahelp, pdfs,…) specified by the project</p> <p class="Code">/e Exit after generate</p> <p class="Code">/y 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">/l1 /l2 /l3 Lets you choose how much information is output, where /l1 is minimal and /l3 is all the information</p> <p class="MsoNormal"><span style="FONT-FAMILY: 'Courier New'" lang= "EN-GB"> </span></p> <h1><a name="NODO12" id="NODO12"></a><span lang="EN-GB">Web Site Generation</span></h1> <p class="MsoNormal"><span 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, with the “topic” parameter. 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"> </span></p> <p class="MsoNormal"><span lang="EN-GB">Here go some examples of web sites (<a href= "http://www.bing.com/search?q=generated+with+chmprocessor&go=&qs=n&sk=&form=QBLH&filt=all">found with Bing</a>) that used chmProcessor:</span></p> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <ul style="MARGIN-TOP: 0cm" type="disc"> <li class="MsoNormal"><span lang="EN-GB"><a href= "http://chmprocessor.sf.net/" target="_blank">chmProcessor. A Html / Word converter to Compiled HTML Help (CHM)</a></span></li> <li class="MsoNormal"><a href= "http://adminucvngn.sourceforge.net/Manual_es/index.html">AdminUCV NGN manual</a></li> <li class="MsoNormal"><span lang="EN-GB"><a href= "http://www.viewlog.com/docs/sitefx_users_guide/index.html">SiteFX User's Guide</a></span></li> <li class="MsoNormal"><span lang="EN-GB"><a href= "http://www.narec.co.uk/cmsfiles/narec/Carbon_Mixer/index.html">Microrenewables Toolkit</a></span></li> <li class="MsoNormal"><span lang="EN-GB"><a href= "http://www.statsolver.net/WebHelp/1.2/index.html">StatSolver Black Belt Companion</a></span></li> </ul> <h1><a name="NODO13" id="NODO13"></a><span lang= "EN-GB">License</span></h1> <p class="MsoNormal"><span 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"> </span></p> <ul style="MARGIN-TOP: 0cm" type="disc"> <li class="MsoNormal"><span 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"><a href= "http://tidy.sourceforge.net/" target="_blank">Tidy</a></span></li> <li class="MsoNormal"><span lang="EN-GB"><a href= "http://sqlite.phxsoftware.com/" target= "_blank">SQLite</a></span></li> </ul> <h1><a name="NODO14" id="NODO14"></a><span lang= "EN-GB">Downloads</span></h1> <p class="MsoNormal"><span lang="EN-GB">You can download the chmProcessor installation binaries and sources from <a href= "http://sourceforge.net/project/showfiles.php?group_id=197104" target="_blank">here</a>. You can get this document as a PDF <a href="http://chmprocessor.sf.net/chmProcessorDocumentation.pdf" target="_blank">here</a>.</span></p> <p class="MsoNormal"><span lang="EN-GB">See the <a href= "http://chmprocessor.sf.net/changelog.txt">changelog here</a>.</span></p> <h1><a name="NODO15" id="NODO15"></a><span lang="EN-GB">Info for developers</span></h1> <p class="MsoNormal"><span lang="EN-GB">Here come some tips if you want to open a help file generated with chmProcessor from your application. Usually there is tree ways to show a help topic on your application:</span></p> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <ul style="MARGIN-TOP: 0cm" type="disc"> <li class="MsoNormal"><span lang="EN-GB">Open directly the help file.</span></li> <li class="MsoNormal"><span lang="EN-GB">Open a help topic by its title.</span></li> <li class="MsoNormal"><span lang="EN-GB">Open a help topic by its HTML file name.</span></li> </ul> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="MsoNormal"><span 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"> </span></p> <h2><a name="NODO16" id="NODO16"></a><span lang= "EN-GB">JavaHelp</span></h2> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB">Your code should look something like this, without any warranty:</span></p> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p style="MARGIN-LEFT: 35.4pt" class="MsoNormal"><span style= "FONT-FAMILY: 'Courier New'">// The generated JAR must to be on your class path.</span></p> <p class="Code"><span lang="EN-GB">ClassLoader cl = this.getClass().getClassLoader();</span></p> <p style="MARGIN-LEFT: 35.4pt" class="MsoNormal"><span style= "FONT-FAMILY: 'Courier New'" lang="EN-GB">URL hsURL = HelpSet.findHelpSet(cl, “help.hs”); // help.hs if the fixed name for the generated help.</span></p> <p style="MARGIN-LEFT: 35.4pt" class="MsoNormal"><span style= "FONT-FAMILY: 'Courier New'" lang="EN-GB">HelpSet hs = new HelpSet(null, hsURL);</span></p> <p style="MARGIN-LEFT: 35.4pt" class="MsoNormal"><span style= "FONT-FAMILY: 'Courier New'" lang="EN-GB">HelpBroker hb = hs.createHelpBroker();</span></p> <p style="MARGIN-LEFT: 35.4pt" class="MsoNormal"><span style= "FONT-FAMILY: 'Courier New'" lang="EN-GB">hb.setCurrentID(“The topic title to show”);</span></p> <p style="MARGIN-LEFT: 35.4pt" class="MsoNormal"><span style= "FONT-FAMILY: 'Courier New'">hb.setDisplayed(true);</span></p> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="MsoNormal"><span lang="EN-GB">Much, much more info on the JavaHelp documentation.</span></p> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <h2><a name="NODO17" id="NODO17"></a><span lang="EN-GB">CHM file with C#</span></h2> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="Code"><span 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"> </span></p> <h2><a name="NODO18" id="NODO18"></a><span lang="EN-GB">Web help with C#</span></h2> <p class="MsoNormal"><span lang="EN-GB"> </span></p> <p class="MsoNormal"><span 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"> </span></p> <p class="Code"><span lang= "EN-GB">System.Diagnostics.</span><span lang= "EN-GB">Process.Start("http://chmprocessor.sourceforge.net/index.html?topic=Web%20Help");</span></p> </div> <!-- And the content tree: --> <ul id="contentsTree" class="contentTree"> <li><a href="1.htm#NODO0">chmProcessor. A Html / Word converter to Compiled HTML Help / Java Help</a></li> <li><a href="1.htm#NODO1">Requirements</a></li> <li><a href="1.htm#NODO2">Limitations</a></li> <li><a href="1.htm#NODO3">Interface</a> <ul> <li><a href="1.htm#NODO4">Win Interface</a> <ul> <li><a href="1.htm#NODO5">General</a></li> <li><a href="1.htm#NODO6">Menu File</a></li> <li><a href="1.htm#NODO7">Compiled Help</a></li> <li><a href="1.htm#NODO8">Web Help</a></li> <li><a href="1.htm#NODO9">PDF / XPS</a></li> <li><a href="1.htm#NODO10">Java Help</a></li> <li><a href="1.htm#_Settings">Settings</a></li> </ul> </li> <li><a href="1.htm#NODO11">Console Interface</a></li> </ul> </li> <li><a href="1.htm#NODO12">Web Site Generation</a></li> <li><a href="1.htm#NODO13">License</a></li> <li><a href="1.htm#NODO14">Downloads</a></li> <li><a href="1.htm#NODO15">Info for developers</a> <ul> <li><a href="1.htm#NODO16">JavaHelp</a></li> <li><a href="1.htm#NODO17">CHM file with C#</a></li> <li><a href="1.htm#NODO18">Web help with C#</a></li> </ul> </li> </ul>
chmProcessor. A Html / Word converter to Compiled HTML
Help (CHM)