htmlhelp compiler: what changed
Revision 0 to 1. Removed lines have a minus sign; added lines have a plus sign.
Title: htmlhelp compiler
| Old | New | Line | |
|---|---|---|---|
| 1 | + | ## Overview | |
| 2 | + | ||
| 3 | + | The htmlhelp compiler chmcmd is a GPL licensed htmlhelp1 (CHM) helpfile compiler. | |
| 4 | + | ||
| 5 | + | The help file compiler's main program only performs command line handling. All other functionality (including .hhp loading functionality and HTML scanning) is done by FPC's [[chm]] package, which is licensed under a more permissive license (LGPL with static linking exception) | |
| 6 | + | ||
| 7 | + | Two formats are supported: | |
| 8 | + | ||
| 9 | + | - HTML help .hhp help projects (similar to those from the old Microsoft HTML Help workshop) | |
| 10 | + | - a superset that stores all information (including context data) in one .XML. | |
| 11 | + | ||
| 12 | + | ## History | |
| 13 | + | ||
| 14 | + | While the primary target of the [[chm]] package is the documentation tool [[FPDoc Editor|fpdoc]], a small commandline utility chmcmd was added for testing purposes. This utility simply created a TCHMProject instance, would load the .xml, and called the "writechm" method. The XML format had to list all files to be included (including .css and image files). | |
| 15 | + | ||
| 16 | + | In 2010, basic .hhp support was added, and the project was expanded to scan input files for extra files. | |
| 17 | + | ||
| 18 | + | ## Missing features | |
| 19 | + | ||
| 20 | + | See [[chm]] | |
| 21 | + | ||
| 22 | + | ## Performance | |
| 23 | + | ||
| 24 | + | The performance probably won't be great. Mostly because the program is written in a portable manner. | |
| 25 | + | ||
| 26 | + | The chm package has some support for doing the compression using multiple cores, but this has not been enabled by default for two reasons: | |
| 27 | + | ||
| 28 | + | 1. on Linux/FreeBSD this pulls in libpthread and libc which makes the binary distribution dependent (on FreeBSD and Linux, basic FPC binaries are fully static and use syscalls) | |
| 29 | + | 2. the savings are not that great (think 25% faster on a dual core) | |
| 30 | + | ||
| 31 | + | A Win32 binary is currently about 420k (uncompressed, but stripped). | |
| 32 | + | ||
| 33 | + | ## Download | |
| 34 | + | ||
| 35 | + | The HTML compiler is not available as a separate download, but is included in most FPC releases and snapshots. | |
| 36 | + | ||
| 37 | + | --- | |
| 38 | + | *From the Free Pascal wiki, page "htmlhelp compiler", as it stood on 2015-10-24 after a change by FTurtle, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* | |
| 39 | + | Category: CHM | |
| 40 | + | Category: Help and Docs |