FAR FAQ

This is a list of Frequently Asked Questions for the FAR HTML program and HTML Help users in general.

HTML Help compilation 
HTML Help viewing 
Toolbar pane buttons 
Navigation pane page tabs

HTML Help Compilation

• What support files are required to compile HTML Help?
  
  The HTML Help compiler is part of MS HTML Help Workshop. This is a free, very basic authoring system provided by MS. You must install HH Workshop if you want to compile a web to a .chm file.
  
  HH Workshop (HtmlHelp.EXE) can be downloaded from
  http://msdn.microsoft.com/library/tools/htmlhelp/chm/HH1Start.htm
  
  Note: HtmlHelp.EXE installs a copy of the latest HH run-time installer HHUPD.EXE but does not install it. You must run HHUPD.EXE yourself if you want to upgrade or install the latest HH run-time files.
  
  
• "HHC6003: The file itircl.dll has not been registered correctly".
  
  This error effects only a small number of users. A HH component did not get installed correctly. Try uninstalling Workshop (if installed) then reinstalling it along with the latest HHUPD.EXE (HH run time installer).
  
  For more info please see MVP David Liske's fine HTML Help web site.
  http://www.mvps.org/htmlhelpcenter/itircl.htm
  
  
• Why does my Compilation fail abruptly?
  
  The MS HTML Help compiler is a DLL (HHA.DLL) installed with HH Workshop. Thus when it crashes it will also cause it's host application (FAR, Workshop, etc) to crash also. 

  There are a number of reasons why the MS HH compiler may crash.
  

  1.	Invalid filenames.  The HTML Help compiler does not like some filenames. Try and stick with these characters _, a..z, A..Z, 0..9.  Do not use periods apart from in the normal file extension. Example: A filename such as xxx.h001.gif is identified incorrectly as a HTML file. The compiler then attempts to parse the binary file and crashes. I believe that spaces in a filename can still cause some minor problems with HTML Help. Best to replace spaces with underscores if you have the chance.
  2.	Invalid Tags or Characters Certain sequences of HTML tags and characters can crash the compiler.  A web file may have become corrupted. A FrontPage _vti file may have been included in your compile.  A stray control character may have been left in a HTML file. Your HTML editor may have produced code not understood by the parser in the MS compiler.
  3.	Insufficient Memory If the help web is big (>10MB) then try recompiling on a more powerful PC (eg. 256M RAM, lots of harddisk space on the system drive). If it  successfully compiles then you know that free memory is the problem.

  Debugging: 

  You need to debug your help system. You need to identify the file(s) that are crashing the compiler.

  I normally remove sections of the web by renaming or moving folders and files, then recompile. Keep adding and removing sections until the compiler does not crash. Eventually you will find one or two files that are causing the problem. You may also need to debug these files by temporarily removing sections of the HTML file.

  Note:  A good starting point is to watch the compile log file being displayed and try to see where the crash appears. Tip: You may need to press PrintScrn just before the crash to be able to read the list. The compiler normally follows the list of files in the .hhp project file then searches for addition files by examining the .hhc and .hhk files.

HTML Help Viewing

• What support files are required to View HTML Help?
  
  You have just compiled a web to a single .CHM file and it wont open or behave correctly on some machines?  You may need to update or install the HTML Help run-time files. HTML Help run-time files are installed by running HHUPD.EXE. HTML Help itself requires that IE3 or greater be installed. IE4/5 is recommended. You _must_ have Internet Explorer 3 or greater installed.
  
  HHUPD.EXE is free and available from the MS Web site.
  http://msdn.microsoft.com/library/tools/htmlhelp/chm/HH1Start.htm
  
  Tip: When installing to Windows NT4 you must be logged on with full Administrator privileges. You should also have NT service pack 3 or greater installed. Watch out, some NT4 installations comes with IE2 but the about box says 4.x.x an internal version number -- This is not IE4.
  
  
• What Version of HTML Help should I have?

  You should have a minimum of version 1.2 (4.73.8252) installed. Earlier versions are too unstable. Later versions contain bug fixes and are more stable.
  
   HH version info

  Window 2000: Note that HH 1.31 (4.74.8793) or greater will not installed on Windows 2000. W2K comes with HH 1.3 (4.74.8702) and can not be upgraded without an official MS Windows2000 Service Pack.
  
  Download the latest HHUPD.EXE run-time installed free from
  http://msdn.microsoft.com/library/tools/htmlhelp/chm/HH1Start.htm
  
  

• Where can I get more version info from?
  
  Helpware.net has page that details all HTML Help releases 
  http://www.helpware.net/htmlhelp/hh_info.htm 
  
  

Toolbar pane Buttons

• How to enable the Next/Preview Browse buttons?
  
  These buttons seen on MSDN window are not available though MS HH Workshop. You can enable them by using the  FAR HTML Help Project Editor. Once you have enabled the Next/Previous buttons (Toolbar page) you must also make sure Binary TOC and Binary Index is selected (Compiler page).  Note:  This mode is incompatible with merge and information types which require Non-binary TOC.
  
  Tip: Next/Previous page browsing may not work correctly if the topic filenames contain space characters. 
  
  
• I changed the TOC icons but do not see changes after compilation?
  
  Customizing  icons are not compatible with Binary TOC / Binary Index.  Set your project to Non-Binary TOC & Binary index then recompile.
  
  
• How do I add Font Size toolbar button?
  
  This button seen on MSDN window is not available though MS HH Workshop. You can enable it by using the  FAR HTML Help Project Editor.
  
  
• Can I create my own custom buttons?
  
  Not under HH version 1.x. Only two custom buttons are available under 1.x. They have a fixed icon and can only call a URL. They cannot call script or ActiveX.
  
  HelpWare have employed the help of an ActiveX DLL to make custom buttons work. 
  For more info see  http://helpware.net/hwserver/index.htm 
  
  

Navigation Pane Page Tabs

The navigation pane can contain a Contents, Index, Search and Favorites page tab. The Contents tab (AKA Table Of Contents or TOC) is defined by a file with a .hhc file extension. The Index tab is defined by a file with a .hhk file extenstion. The search and favorites tabs do not require extra files. FAR can create and edit .hhc and .hhk files.

• I don't want a Navigation pane. Can this be done?
  
  Yes but it is not obvious. 

1. Open the FAR HHP Editor.
2. To remove the Contents and Index tabs:
   Clear all edit fields that specify a .hhc or .hhk file. These fields are on the "Compiler " page and also the "Files" page (if a Window Type is defined). 
3. To remove the Full Text Search tab:
   Clear the  "Compile FTS information" checkbox on the "Compiler Page". Also clear the "Show Search Tab" checkbox on the "TriPane" page  (if a Window Type is defined).  
4. To remove the Favorites tab:
   Clear the "Show Favorites Tab" checkbox on the "TriPane" page. If you do not have a "TriPane" page then you may need to define a Window Type.
5. If you want to remove the toolbar pane:
   Clear the "Show Nav and Toolbar Panes" checkbox, or clear the "Hide Toolbar" checkbox on the "TriPane" page.  If you do not have a "TriPane" page then you may need to define a Window Type. 

Other Info

• HH Info & Links