Importing FrontPage CHMs to H&M

This section provides a platform for publishing case studies describing projects that have been realized using Help & Manual. This is a restricted forum -- if you have a case study you would like to publish please submit it to the forum admin for consideration.

Moderators: Alexander Halser, Tim Green

Importing FrontPage CHMs to H&M

Unread postby Tim Green » Wed Sep 27, 2006 2:54 pm

Converting a FrontPage HTML help file to Help & Manual format
By Simon Carter, www.DataMystic.com

We've been getting more and more requests to have TextPipe's HTML Help manual available in a printable PDF format, particularly from large customers. TextPipe is a complex data extraction and conversion product, and we decided to charge a nominal fee for the manual ($US 9.99), since many users are happy to work with the HTML Help file. What follows is a description of how we used TextPipe to convert our existing HTML Help files (in FrontPage 2003 format) to a Help and Manual format.

Our existing help file had multiple folders, and shared borders on the top, left and bottom. During H&M Import, the top border was correctly identified but we needed to have it and the other shared borders removed for PDF output. After backing up our help file folders, we used TextPipe to find the perl pattern:

Code: Select all
  <!--msnavigation-->.*<!--msnavigation-->

and replace it with nothing, removing all shared borders. At this stage we also cleaned up the help file by removing comments, scripts and an embedded feedback form which we would re-work later.

After these changes and recompiling, we then imported textpipe.chm into H&M. We were surprised to find about 20 topics not linked into the Table of Contents, so we fixed these up and also reorganized the TOC structure. WAY easier than Microsoft's HTML Help Workshop! We also found 10 links pointing nowhere which we fixed up.

Next we had to re-instate the shared borders, but only for HTML Help Output (not for PDF files). Under Project > Project Properties > HTML Help > Topic Pages, we inserted our own text for the top and bottom border (H&M doesn't support left borders or the FrontPage navigation structure). At the top, we pasted our style sheet contents between <style>…</style> tags, and then pasted in the main table from _borders\top.htm. This gave us the main structure, but we still needed to edit the links so that they would work with H&M. We applied a TextPipe filter to just the HREF tags of links (not of images or style sheets), and only to relative references (ie not external links starting with http:). For these, we:
  • Replaced %20 or space with an underscore (_)
  • Removed leading \ or / - H&M doesn't like them
  • Replaced \ with underscore (_), because H&M's flattens FrontPage's folder structure
  • Standardized all file extensions to .htm (we found several file with .html)
This cleaned up everything, and we then pasted the altered _borders/top.htm into H&M. We followed the same process for the footer (_borders/bottom.htm), but didn’t insert the style sheet again.

We also used H&M's XML Export and Import to apply TextPipe Web to all help file Topics once we had them in H&M format.

This whole process was made much easier by unchecking the option "Delete temporary files" in HTML Help export dialog box. This creates a folder \~tmpchm with all the temporary files, so we could see what the links were really pointing to.

The TextPipe filters we used for the process are attached to this posting.

For more information about TextPipe Web vist http://www.DataMystic.com
You do not have the required permissions to view the files attached to this post. This may mean that you can't view them at all, or it may just mean that you need to log into the forum to view them.
User avatar
Tim Green
Site Admin
 
Posts: 20355
Joined: Mon Jun 24, 2002 9:11 am
Location: Bruehl, Germany

Re: Importing FrontPage CHMs to H&M

Unread postby Xtructur » Wed Jul 21, 2010 3:58 pm

 
Hello,

I am sure TextPipe is functional as software, but I supposed that the goal of this forum's section was another one, something more ambitious. I had got the same feeling when I readed the journalistic style headline and related news: "Mai 27. 2010 Bringing Order to the Law Business: Case study, how a Belgian law firm is using Help & Manual" (http://www.ec-software.com/products_hm_case_stibbe.htm). Instead of analysing the particular import strategy into a single sourced environment like Help & Manual, what I see are both news and preceding post announcing the whole world: "How great we (software developers/lawyer firm) are!". It is well known that technical advice must be paid for, but I dislike when I see a topic promising know-how and the real thing is about marketing and/or public relations.

Regards,

Xtru.

 
Xtructur
 
Posts: 6
Joined: Mon Jul 19, 2010 10:06 pm


Return to Case Studies

Who is online

Users browsing this forum: No registered users and 1 guest