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

Popular posts from this blog

Well, that explains CodePlex...

In a move that will be sure to anger open source (or rather anti-paid software, anti-Microsoft open source)  zealots, Microsoft is planning to buy GitHub . A year ago, I mused about why Microsoft would shut down CodePlex and how the world needs competing source code repositories to be strong. I'm not the only one per this Slashdot article  : "...   people have warned about GitHub becoming as large as it did as problematic because it concentrates too much of the power to make or break the open source world in a single entity, moreso because there were valid questions about GitHubs financial viability...." - Jacques Mattheij I will be interested in seeing this play out - whether developers jump ship or not. Have all the efforts Microsoft has made in pushing towards open source be seen as genuine or will all the zealots jump ship or maybe even attack? Microsoft's comment about why they shut down CodePlex referred to how spammers were using CodePlex. Well, GitHub

Attending Southwest Fox 2019 could change your life - Find out how

Southwest Fox is coming up in October and as I do every year, I spoke with the organizers Rick , Doug and Tamar on the FoxShow. Deadlines for Southwest Fox: Super-saver price (before July 1): $695 Early-bird price (before August 1): $770 Regular price (August 1 and later): $820 This year, I took a different approach with separate shows for each organizer but the main message is still the same : July 1st is their Go/No-Go date. Conferences don't talk about this very often. I don't think developers really question if Apple will hold their WWDC in June or Microsoft will hold their Build conference - but that's because those conferences are vendor-led. Southwest Fox is a community-driven conference - it's not driven by a company with an agenda. Listen to the interviews and you can hear how important each of the organizers feel the live connection between speakers and among attendees.

Virtual FoxFest - A New Way to Conference

If you haven't been keeping up with the news around the Fox community, the Southwest Fox conference has gone digital now showing up as  Virtual FoxFest .  At $49, it's a steal and a great way to learn some new ideas and get inspired. While the reasoning for this change is fairly obvious with the year of COVID - for me, this is something that has been a long time coming. I appreciate many people's needs for a physical conference but the world is very large and it's difficult to get people from around the world into a single physical location. I recently attended a single-track conference via YouTube (a Quasar conference). YouTube's Live stream provided a very handy way to watch, rewind and communicate with people online. While Tamar, Doug and Rick are still making decisions related to the streaming platform, there are lots of great options available. I'm really looking forward to it. The FoxPro community has also really felt its international roots