HTMLHelp Workshop ui - tutorial

HTMLHelp Workshop ui - tutorial

http://www.help-info.de/en/
http://frogleg.mvps.org/

HTMLHelp Workshop ui - tutorial

Using the Interface
HHW includes menus and toolbars.

The available options that display depend on whether an HTML file is open in the editor. It also includes three tabs in the left pane.

Menu Options
• HHW (when an HTML file isn't open) includes the following menu options:
• File New, Open, Close Project, Close All, Save Project, Compile, Decompile, CHM Information, Preferences
• View Toolbar, Status Bar, Compiled Help File, HTML Help Messages
• Test Pop-up Attributes, Keyword Lookup, HtmlHelp API
• Tools HTML Help Image Editor

• When an HTML file is open, the following menu options are added:
• File Close File, Save All Files, Save File, Save File As
• View Set Font, In Browser
• Window Cascade, Tile Horizontally, Tile Vertically, Arrange Minimized Windows
• Edit Undo, Cut, Copy, Paste, Select All, Compiler Information, Split File, Find, Find Next, Replace
• Tags Insert Text Block, Edit Text Block, Character Formatting, HTML Help Control, Heading, Comment, Title

Setting the Default Topic
• The default topic appears as soon as users launch the Help file.
• This topic can be the first topic from the Table of Contents or it can be an “identity” topic.
• An identity topic contains the name and copyright information for the Help file.
• The only time users see the identity topic is when they first open the Help file.
• If you are adding a splash screen to your Help file, you add the control to the default topic. This way, users only see the splash screen when they first open the Help file.
• To set the default topic:
1. Click Change Project Options . The General tab appears by default.
2. Click the drop-down arrow next to Default File.
3. Select the default topic from the list that appears.
4. Click OK.

Designing the Table of Contents
Assigning Topics to Headings
• To create a heading with an assigned topic:
1. Click Insert a Heading .
2. Type the heading title.
3. Click Add.
4. Select the desired topic and click OK twice.
• To assign a topic to an existing heading:
1. Select the heading.
2. Click Edit.
3. Click Add.
4. Select the desired topic and click OK twice.

Designing the Table of Contents
Designing an Index
Creating See and See Also Keywords
• One feature of HTML Help is the ability to create See and See Also keywords. This allows you to create cross-references (as you would in hardcopy).
• See keywords are used for single-entry keywords.
• See Also keywords are used for multi-level keywords.
• See and See Also keywords appear in the index, but function differently from “regular” keywords.
• When a user clicks the See or See Also entry, the index displays the keyword assigned to that entry.
• See and See Also keywords can be entered at any index level (primary or secondary).
• See and See Also keywords always refer to primary keywords.
• You have to determine the format you will use to indicate See and See Also keywords.
• Otherwise, the users won't know they've clicked a See or See Also keyword and can get confused.
• Some possible choices are:
creating topics: see also adding topics
creating topics see also adding topics
creating topics (see also adding topics)
creating topics, see adding topics
• HHW allows you to create primary keywords that link to themselves.
• This is a different kind of See or See Also keyword.
• Primary keywords that are linked to themselves display the following message when selected: To locate information about this keyword, please select one of the subentries in the list.
• This allows you to work around the hassles associated with primary level keywords, because you don't have to assign one or more topics to the keyword for it to display correctly.
• To create a See or See Also keyword:
1. Click Insert a Keyword .
2. Type the keyword in the Keyword input box. Make sure you include the See or See Also reference so that users understand the keyword functionality.
3. Click Add. The Path or URL dialog box appears.
4. Type the target keyword in the File or URL input box.
5. Click OK.
6. Click the Advanced tab.
7. Select the Target is Another Keyword check box.
8. Click OK.
Designing an Index Page 41
• To create a primary keyword that links to itself:
1. Click Insert a Keyword .
2. Type the keyword in the Keyword input box.
3. Click Add. The Path or URL dialog box appears.
4. Type the same keyword in the File or URL input box. This keyword must match the one entered in step 2.
5. Click OK.
6. Click the Advanced tab.
7. Select the Target is Another Keyword check box.
8. Click OK.