[Return to RoboHELP Training page]
Sample RoboHELP Workbook Outline
Introduction to RoboHELP
Online Help in the Windows Environment
Parts of the WinHelp System
Default Help System Menus
Navigating in Windows Help
What is RoboHELP?
Authoring vs. Information Delivery
RoboHELP and Word create WinHelp
Creating an Online Project
Tricks and tips for fine-tuning the environment
Improving the Word Environment
Improving the Windows Environment
Minimum Recommended Setup for Help Authoring
Creating a new RoboHELP Project
To create a new project using the RoboHELP shortcut or Start Menu
To create a new project from within Microsoft Word
Starting our project
Additional Settings at the Beginning of a project
Project Directory Structure
Setting the Browse Sequence
The RoboHELP Process
Introduction to Hypertext Concepts
What is Hypertext?
Definitions
Where did the idea of hypertext come from?
Who coined the term?
Endless proliferation and application
Hierarchical Systems Versus Web-Based Structures
Hierarchical systems
Web-based structures
Indexes
WinHelp and hypertext structure
What is Online Information?
Creating Topics
WinHelp Topics
What is a Help Topic?
WinHelp and Topics
Creating Topics
Creating Topics "On the Fly"
Parts of the Insert New Help Topic Dialog Box (Advanced)
Deleting Help Topics
The WinHelp Index: Defining your Search Keywords
Keyword Indexing Guidelines
Generating Keywords Automatically
Creating Keyword Entries in RoboHELP
Creating Topics for use as Popups or Hidden Help
Changing a Standard Help Topic into a Popup Topic
Hotspots and Hypertext Jumps
Creating Hypertext Jumps with RoboHELP
Hypertext Jumps
Web versus Hierarchical Jumps
Creating a Topic Jump
Adding a Topic When Creating a Topic Jump
Creating a Popup Jump
Editing and Deleting Hypertext Jumps
Editing Hypertext Jumps
Deleting Hypertext Jumps
Automatic Linking of Jumps and Popups
Adding Information to your Project
New Documents and Limited Text
Adding a New Document to your RoboHELP Project
Cutting and Pasting Text into your Project
Importing Existing Documents
Why Should I Import an Existing Document?
A Possible RoboHELP Scenario
Importing versus Conversion
Import Documentation
Conversion
Adding an Existing Document to Your Help Project
Organizing Your Online Project
Planning: Project Structure and Design
Base Project Plan
Manual and Online Style Guides and Procedures
Directory Structure and Naming Conventions
Review and Testing Procedures
Project Notebook, Archiving, and Backup Procedures
Organizing Your Topic Structure
Structure
Flowcharting Your Help Structure
Sample Hierarchical Flowchart
Sample Linear Flow Chart with Links
Writing and Design Strategies
Writing for Online is Different
Structure of text
A Look at the Microsoft Minimalist Model of Help
Rules of Thumb
The Parts of Online Help Topics
A Few Basic Design Considerations
Formatting Your RoboHELP Project
Using Styles in RoboHELP
Modifying RoboHELP templates
About Microsoft Word Styles
About RoboHELP Styles
Changing the Styles in a Help Document
Creating a Help Topic Non-scrolling Region
Setting up a Non-scrolling Region
Working with Tables
WinHelp Table Limitations
Creating a Table with an Underlined Caption
Create a Complex Table in Word
Working with Graphics and Segmented Hypergraphics
Graphics and WinHelp
Taking Graphics Online is Harder Than You Think
Graphic File Formats Compatible with WinHelp
Converting an Image to a Metafile
Designing Online Screens with Graphics
Controlling Image and File Size
Capturing and Editing Screen Images
Using the Windows Screen Capture
ALT + PRINT SCREEN Example
Using Paintbrush as Bitmap Editor
Inserting Graphics
Images Placed by Pasting or Inserting
Images Placed by Reference
Wrapping Text Around Graphics
Using Bitmap References
Removing Embedded Graphics
Hotspots and Hotspots and Segmented Hypergraphics
Creating a Hotspot Graphic
Creating a Segmented Hypergraphic
Common Online Image Problems
Displaying Large Graphics
Scaling Graphics
Changing the Look of Your Help System
Effective Use of WinHelp Windows
Screen Units Versus Pixels
Window Size and Position
Working with Popup Windows
Working with Secondary Windows
Creating Secondary Windows
Creating a Secondary Window Footnote
Creating Help Contents
Creating a .CNT File
Contents Tab Issues
Adding Books to the Contents Tree
Adding Subordinate or Ordinate Books to the Contents Tree
Advanced Topic Page Options
Positioning Books and Topic Pages in RoboHELP
Grouping Multiple Help Files
Understanding Help Macros
Overview of Help Macros
Defining a Help Macro
Different Kinds of Macros
Creating Macros with RoboHELP
Alink Macros for See Also Jumps
Useful Macros to Know
JumpContext (JC)
PopupContext (PC)
JumpContents
CreateButton (CB)
CloseWindow
CopyTopic
ExitWinHelp
Print
Authoring Custom Buttons
Custom Buttons
Defining Authorable Buttons
Adding Buttons to Windows in the Contents Tab Composer
Working with Context Sensitive Help
Map Numbers
Defining Map Numbers
AutoCreating Map Numbers
Importing Program Map Numbers
Issues with Context Sensitivity
Compiling and Troubleshooting Your Help Project
Compiling Your Project
Quick Checking the Project Before Compiling
Compiling Your Help Project
Locating Errors
To locate an error in a help topic
Locating an Error in the Project File or Map File
Assorted Useful Information
WinHelp Punctuation
Tricks and Tips
Glossary of Terms
Index