BHcomp
	HOME   |   Software   |   energyXT       BHcomp :: NEXT

Contents

Overview Introduction Downloads Installation Workflow Specific modifications needed Details File Structure .BHP File .HHP File .BOOK File Limitations Tips

Introduction

Current Status: BHcomp v1.75, 19 May 2008

This help utility BHcomp started some months ago when I wanted to translate the energyXT-Forum Commands Guide to a CHM-file and a PDF-file using only one source.
Later the option to generate on-line pages has been added.

See DarkStar's guides which is available as online, CHM-file and PDF-file, using the same HTM SRC-file.
Please check out an example of a combined WEB/CHM/PDF at www.asseca.com/darkstar.


Here are the programs used:

• BHcomp >> translates from HTM to WEB, HHC and HHK
• Microsoft HTMLhelp, latest version >> compiles HTM to CHM
• HTMLDoc v1.8.23/v1.8.24/v1.8.25/v1.8.27 >> translates from HTM to PDF
  

Downloads

Download bhcomp.zip, the BHcomp program.
Download htmldoc-1.8.23-winfree.exe, 2.5MB, the GPL freeware version of HTMLdoc v1.8.23
--- or ---
Download htmldoc-1.8.24-winfree.zip, 1.2MB, the GPL freeware version of HTMLdoc v1.8.24
--- or ---
Download htmldoc-1.8.25-winfree.zip, 1.2MB, the GPL freeware version of HTMLdoc v1.8.25
--- or ---
Download htmldoc-1.8.27-winfree.zip, 1.2MB, the GPL freeware version of HTMLdoc v1.8.27

Installation

• Install the latest version of Microsoft HTMLhelp -->> .HHP files should be associated with HHW.EXE
  
• Install v1.8.23, v1.8.24, v1.8.25 or v1.8.27 of HTMLDoc -->> .BOOK files should be associated with HTMLDOC.EXE
  
• Install BHcomp by copying the BHcomp files to a folder of your choice, you must preserve the sub-folder structure in the zip-file -->>
  1. Run BHcomp > "File" > "Preferences"   ( settings are saved in BHcomp.ini )
  2. .BHP files should be associated with BHCOMP.EXE
  3. Set the HHC.EXE File Path
  4. Set the SRC editor File Path to the application which will edit the original SRC HTM-file

Workflow

1. First write/edit the HTM-file(s)
2. write/edit the .CSS-file
3. BHcomp (uses .BHP-file for configuration)
   

   - makeWEB

   ( generates WEBprefix+HTM-file(s) )

4. BHcomp
   

   - makeCHM

   ( generates temporary CHMprefix+HTM-file(s) for CHM compilation ) ( generates .HHC and .HHK index files ) ( compiles using Microsoft HTMLhelp )

5. optionally write/edit a title.htm file
6. BHcomp
   

   - makePDF

   ( generates temporary PDFprefix+HTM-file(s) for PDF compilation ) ( and compile > PDF using HTMLdoc )

7. HTMLdoc (uses .BOOK file for configuration)
8. BHcomp

   - cleanUp

   ( removes CHM and PDF temporary HTM-file(s) ) ( removes .HHC and .HHK index files )

Although this look like a complex method, it does work fast.
The complete Help content is in a single HTM-file which is much easier to maintain than seperate HTM files.
You may also use seperate HTM files.
After you have finished compilation of WEB, CHM and PDF, by using "cleanUp", you can delete the temporary HTM-, HHC- and HHK-files to clear up the folder. ( of coarse not deleting the title.htm file )

If you feel unsure about this help stuff, and you supply the SRC HTM-text, I can do the rest and supply you with the WEB-,CHM-,PDF-files. This will give you a kick start.

Specific modifications needed:

BHcomp auto-generates the different versions of the "0.htm" thru "n.htm", using these headers and custom tags.

1. each main section / page must start <H1>...</H1>
2. sub-sections are allowed using <H2>...</H2> thru <H6>...</H6>
3. custom href jump tag <A href=#index#> jumps to 0.htm page
4. custom href jump tag <A href=#top#> jumps to top of current page
5. custom href jump tag <A href=#prev#> jumps to previous page
6. custom href jump tag <A href=#next#> jumps to next page
7. custom href jump tag <A href=#chapter#> jumps to the beginning of the page of the current chapter/section (tagged with <H1>...</H1>)
8. custom tag <pagename "index.htm"> to name the first page WEB/CHM page, this MUST be the first line in the first HTM source file
9. custom tag <page> to create next WEB/CHM page.
   <page "links.htm"> will also name this page links.htm.
10. custom tag <insert "ins-1.htm"> inserts ins.htm into current WEB/CHM page.
    <insert "ins-1.htm" "Index" "Contents"> will parse 2 parameters (up to 9 parameters may be included enclosed in double quotes) as %1 and %2 when inserted, Index is the 1st parameter in this example.
11. custom tag <web>...</web> contents between tags will only be displayed on WEB
12. custom tag <noweb>...</noweb> contents between tags will only be displayed in CHM and PDF
13. custom tag <chm>...</chm> contents between tags will only be displayed in CHM
14. custom tag <nochm>...</nochm> contents between tags will only be displayed on WEB and PDF
15. custom tag <pdf>...</pdf> contents between tags will only be displayed in PDF
16. custom tag <nopdf>...</nopdf> contents between tags will only be displayed on WEB and CHM
17. custom tag <tmp>...</tmp> contents between tags will only be displayed on source HTM

  custom tags 7 thru 15 may be commented, some examples:
    <!--web>...</web-->
    or
    <!--web-->...<!--/web-->
    or
    <!--page-->
    or
    <!--web><insert "ins-1.htm"></web-->

TOP   -   NEXT