Customizing the entry-point index.html frameset file for WebWorks Help 5.0

When generating WebWorks Help 5.0 output, ePublisher creates an entry-point file called (by default) index.html. Typically, this is the file that is launched by the user or an application to open the full helpset. The file itself is simple. It just parses any URL arguments (for context-sensitive help), and then it redirects the browser to the full frameset (switch.htm and eventually wwhelp.htm).

You can modify the content of this index.html page if, for example, you want to add your own custom JavaScript functions or load the WWH5 helpset within a parent framset of your own design.

To do so, you'll want to perform an override on the file that acts as the template for the entry-point page. The file that becomes that 'index.html' frameset page is called 'wwhelp_entry.html', and it is located by default in the ePublisher Pro installation directory, here: Formats\WebWorks Help 5.0\Transforms\

So, to change the content of that file, just perform a format override and make the appropriate changes.

  1. In your Master Project folder, reproduce the directory structure leading to the file you wish to override: [MyProject]\Formats\WebWorks Help 5.0\Transforms\

  2. Make a copy of the original 'wwhelp_entry.html' file, and paste it into the Transforms folder created for your project.
  3. Open the new copy with any text- or HTML-editing application and make the desired changes.
  4. Save the document and regenerate your output to apply the changes. Also be sure to update your stationery so that any production projects in ePublisher Express will be synchronized with the latest changes.

You can also change the name of the entry-point file. In the Format Settings for your chosen target, scroll to the bottom and find the "Top level filename" option. By default, the value is "index.html," but you can modify that value and assign any name you like.

CategorySolutionsOutputWebWorksHelp CategorySolutionsOverrides

LaurenLever/@Solutions/Output/WebWorks Help 5.0/Customizing entry point (last edited 2009-06-02 19:46:09 by LaurenLever)