HelpIndex Workshop Design Specification

Copyright © 1996,1997 PHD Computer Consultants Ltd

Last updated: 19 February 1997

Provisional, proposed functionality.

HelpIndex Workshop

As a part of the HelpIndex Pro package, the HelpIndex Workshop is a Windows 95/NT program which is a superset of MakeHelpIndex.

Key features:

• To help web designers create and maintain HelpIndex files for their site.
• Windows 32 bit program, ie for Windows 95 and Windows NT
• Has a wizard to analyse existing web pages, like MakeHelpIndex
• Allows the index and contents to be edited easily
• Allows web page updates to be integrated easily
• Works with .hip project files
• ??? Uses IE as an ActiveX control to test in a pane
• Reads/Saves design in .hi (and .hhk/.hhi???) formats
• Works with more than one language set
• Generates the required HTML in a set-up wizard

General Features

HelpIndex Workshop can re-scan web pages and make a sensible merge of the web pages and the user's project.

The user can add URLs and indices easily. These are stored in the project file. So, on re-scan these can be added again easily.

The user can edit the tree hierarchy. The preferred hierarchy is stored in the project file. On re-scan, the user's preferred hierarchy still prevails. However any missing pages or extra pages are shown for the user to deal with.

The user can edit/delete indices. The change list is stored in the project file. After a re-scan, the change list can be re-applied. Any problems re-applying the change-list are flagged to the user.

User Interface Overview

Windows Look and Feel

HelpIndex Workshop has the look and feel of a standard Windows 95/NT program, ie there are wizards, menus, tree views, right mouse clicks for context sensitive pop-up menus, properties, context-sensitive help, standard file save/open dialogs etc.

Window Panes

HelpIndex Workshop has several internal windows in which the user works.

There is always a Project window open. This has a standard tree view. The main headings are usually the language name, eg "English". Each language has "Contents", "Index" and "Applet HTML" branches. Example Project layout:

• Applet HTML
• English
  • Contents
  • Index
  • Language File
• French
  • Contents
  • Index
  • Language File

If open, the Applet HTML window shows the plain HTML text of the web page which invokes HelpIndex. The project settings will be shown in the applet call. Do not edit the settings here.

If open, the Contents window is titled "English - Contents", for example. There is a standard tree view of all the URLs in the site. The use can move, add, edit or delete URLs in this view.

If open, the Index window is titled "English - Index", for example. There is a standard tree view or simple list of all the indices, ordered alphabetically. The use can add, edit or delete indices in this view.

If open, the Language File dialog box is titled "French - Index", for example (English cannot be edited). The dialog box allows you to enter the text of each line in the language file.

Menu Bar

• File
  • New
  • Open
  • Save
  • Print
  • Exit
• Edit
• View
• Tools
  • Scan
  • Rescan
  • Test
• Window
• Help

File+New lets you have a new Project or Language Set.

For a new project, you are asked for the new project name and location. You can then opt either to have a blank HelpIndex file, or invoke the project wizard. The wizard first optionally builds the HTML page options, ie applet or icon, etc. Then it can invoke the MakeHelpIndex functionality for an initial scan of some existing web pages.

For a new Language Set, you can choose an existing Language File, or build your own new one (you can opt to copy an existing language file).

Future Options

Let the Project Wizard automatically generate some basic frame sets.

HelpIndex    PHD