Skip to main content

Importing HHC files with West Wind HTML Help Builder

If you've never tried it, West-Wind Help Builder can be a life-saver. A great tool for creating both Technical and EndUser help files. On the technical side, it lets you import in class definitions and data dictionaries, making it easier to get a total scope of a project.

But what's been missing has been a way to move existing help projects (those built using the Microsoft HTML Help Workshop) into Help Builder.

Now , under the hood, WW's Help Builder uses the Visual FoxPro data file so if you're intrigued, you can type in USE myHelp.VBP and browse the project to get a good feeling behind all of the data.

So the HTML Workshop builds its table of contents with an HHC file which is a terrible HTML file that looks like this:








    • So I imported it into a VFP memvar and then populated the West-Wind Help Project's VBP file. Here's the full code. It's NOT polished but I noted it on the FoxShow podcast and wanted to ensure it was up here:

      LPARAMETERS tcFile,tcProj

      IF NOT FILE(tcFile)
      RETURN .F.
      ENDIF

      IF NOT EMPTY(tcProj) AND NOT USED("PROJFILE")
      USE (tcProj) IN 0 AGAIN SHARED ALIAS projFile
      ENDIF
      lcFile = FILETOSTR(tcFile)

      LOCAL lnlines
      lnLInes = ALINES(la,lcFile)
      LOCAL llStart,lcParent,lcPrevParent

      ** Note: the INDEX is the top level root ID of the HBP file.
      lcPrevParent = "INDEX"
      lcParent = "INDEX"
      llStart = .F.
      lnAdded = 0
      lnID=3
      lcLast = "INDEX"
      lnStart = 900
      FOR lni = 1 TO lnLines
      lcLine = STRTRAN(ALLTRIM(la(lni))," ")
      IF lcLine = "
        "
        llStart = .T.
        lcPrevParent = lcParent
        lcParent = lcLast
        LOOP
        ENDIF
        IF NOT llStart
        LOOP
        ENDIF
        IF lcLine = "
      • ** New Item
        lcName = ""
        lcContent = ""
        LOOP
        ENDIF
        IF lcLine=[ lcName = STREXTRACT(lcLine,[value="],[">])
        LOOP
        ENDIF
        IF lcLine=[ lcFile = STREXTRACT(lcLine,[value="],[">])
        IF FILE(lcFile)
        lcContent = FILETOSTR(lcFile)
        ELSE
        lcContent = "File "+lcFile+" could not be found"
        ENDIF
        LOOP
        ENDIF
        IF lcLine=[]
        ** Add it
        lcID = SYS(2015)
        INSERT INTO projFile (pk,parentpk,topic,type,body,helpid,sortorder) ;
        VALUES (lcID,lcParent,lcName,"HEADER",lcContent,lnID,IIF(lcParent="INDEX",lnStart,0))

        IF lcParent="INDEX"
        lnstart = MAX(0,lnStart-100)
        ENDIF
        lnID = lnID+1
        lcLast = lcID
        lnAdded = lnAdded+1
        ENDIF
        IF LcLine = [
      ]
      lcParent = lcPrevParent
      ENDIF
      ENDFOR

      ** Now the rest of this code was written to clean up some of the garbage that came in with those old HTML files.

      SELECT projfile
      REPLACE ALL body WITH STRTRAN(body,[])
      REPLACE ALL body WITH STRTRAN(body,[])
      REPLACE ALL body WITH STRTRAN(body,[])
      REPLACE ALL body WITH STRTRAN(body,[])
      REPLACE ALL body WITH STRTRAN(body,[])
      REPLACE ALL body WITH STRTRAN(body,[])
      REPLACE ALL body WITH STRTRAN(body,[])
      replace ALL body WITH STRTRAN(body,"<","<<")
      replace ALL body WITH STRTRAN(body,">",">>")
      ? lnAdded

      Thinking back, I could likely have just used STREXTRACT for some of these but I needed something quick and dirty and this definitely does the trick. Also note that one of other cool things it does is IMPORT in the actual source.

      You'll still have a lot of clean-up work to do but not a lot of re-writing.

      West Wind HTML Help Builder

Comments

Post a Comment

Popular posts from this blog

Merry Christmas

Whether you celebrate now, have already celebrated your past holiday, are planning to, or not, I hope you find yourself surrounded by family and those you love during this holiday season and are able to remember fondly those who are not with you. We often find ourselves buried in work, or too distracted by other problems, to share and remember a few moments with those closest to us. So many of us are separated by huge distances, we often find it easier to focus on those who are out of arm's reach yet so easy to connect with online, instead of those who are right beside us. So do yourself a favour, put down the keyboard (stylus, mouse, etc) and spend that time. I know I will. Merry Christmas. Powered by ScribeFire .
4 comments
Read more

Programmers vs. Developers vs. Architects

I received an email this morning from Brandon Savage 's newsletter. Brandon's a PHP guru (works at Mozilla) but his newsletter and books have some great overall perspectives for developers of all languages. However, this last one (What's the difference between developers and architects?) kind of rubs me the wrong way. Either that, or I've just missed the natural inflation of job descriptions. (maybe, it's like the change in terminology between Garbage man and Waste Engineer or Secretary and Office Administrator) So maybe it's just me - but I think there's still a big difference between Programmer, Developer and then of course, architect. The key thing here is that every role has a different perspective and every one of those perspectives has value. The original MSF create roles like Product Manager, Program Manager, Developer, Tester, etc - so every concept may pigeon hole people into different roles. But the statements Brandon makes are often distinction...
11 comments
Read more

From Writing to AI: the pattern repeats itself

When I was ten years old, my dad bought a computer and, thanks to an advertising supplement in a Superman comic I read, it was a TRS-80. A month later, he dragged the entire family (my mom and brother were not the most enthusiastic) to a class at Radio Shack teaching how to use microcomputers. At the time, I understood why my mom wasn’t that excited: the computer was yet another gadget in the house. But today I find it fascinating. My mother went to Vassar in the 50s. She learned how to type — not a common skill at the time — but it opened doors. Her ability to communicate effectively led her to a career in adult education and later communications work with the CBC (Canadian Broadcasting Corporation). This isn’t a nostalgia post. Today, the ability to use artificial intelligence, be it through Copilot or simply writing the right prompt, is becoming a critical skill. But is it really that novel? In the 1500s and 1600s, the printing press gradually made reading accessible beyond cler...
Post a Comment
Read more