ASNA 
“Creating Help Files” 
for Smarties 
A Step-By-Step Tutorial to assist you  
in Creating and Connecting Help Files  
to Windows and Web Applications 
Learn about Help Files and their 
components and formats. 
Create an entire help file using 
Robohelp by Ehelp Corporation. 
Connect the Help File to an AVR 
Windows application.  
Convert the Help File to WebHelp 
and connect a Web application to a 
Webhelp help file and context-
sensitive help in a separate window.
By Julie O’Brien 
Convert pdf file to powerpoint presentation - SDK application project:C# Create PDF from PowerPoint Library to convert pptx, ppt to PDF in C#.net, ASP.NET MVC, WinForms, WPF
Online C# Tutorial for Creating PDF from Microsoft PowerPoint Presentation
www.rasteredge.com
Convert pdf file to powerpoint presentation - SDK application project:VB.NET Create PDF from PowerPoint Library to convert pptx, ppt to PDF in vb.net, ASP.NET MVC, WinForms, WPF
VB.NET Tutorial for Export PDF file from Microsoft Office PowerPoint
www.rasteredge.com
ASNA 
“Creating Help Files” 
for Smarties 
Information in this document is subject to change without notice.  Names and data used in examples are fictitious 
unless otherwise noted.   
No component of ASNA Visual RPG for Smarties may be reproduced, disassembled, transmitted, transcribed, stored in 
a retrieval system, or translated into any language in any form without the written permission of ASNA (Amalgamated 
Software of North America). 
Released for ASNAPalooza 2001  March, 2001 
SDK application project:VB.NET PowerPoint: Use PowerPoint SDK to Create, Load and Save PPT
NET method and sample code in this part will teach you how to create a fully customized blank PowerPoint file by using the smart PowerPoint presentation control
www.rasteredge.com
SDK application project:C# PDF Text Extract Library: extract text content from PDF file in
But sometimes, we need to extract or fetch text content from source PDF document file for word processing, presentation and desktop publishing applications.
www.rasteredge.com
Contents 
Introduction: Getting Started and About Help Files..............1 
Using the Tutorial.......................................................................................................1
How to use this Tutorial.......................................................................................1
Source Files..........................................................................................................1
Saving Your Work...............................................................................................2
Manual Conventions............................................................................................2
What Do you Want to Do?...................................................................................2
About Help Files.........................................................................................................3
What is a Windows Help File?.............................................................................3
Why Create a Help File?......................................................................................3
How can you use Help?.......................................................................................3
Types of Help Formats.........................................................................................4
Considerations Prior to Creating a Help File.......................................................7
Where Do I Start?................................................................................................7
Which Help Authoring Package?.........................................................................7
Help File Components.................................................................................................8
Topics...................................................................................................................9
Images and Multimedia......................................................................................10
Windows............................................................................................................10
Links..................................................................................................................11
Table of Contents...............................................................................................12
Index..................................................................................................................12
Macros...............................................................................................................13
Step 1: Creating a Help File..................................................15 
Creating a New Help Project.....................................................................................17
Getting Around in RoboHelp....................................................................................19
RoboHelp Explorer (Left Side)..........................................................................20
Microsoft Word (Right Side).............................................................................20
Inserting an Existing File..........................................................................................21
Saving the File..........................................................................................................22
Creating an Index......................................................................................................22
Properties of a Help Topic........................................................................................23
Adding New Topics..................................................................................................25
Creating Links...........................................................................................................26
Creating Context-Sensitive Help...............................................................................27
Adding HTML Topics...............................................................................................29
Compiling the Help Project.......................................................................................31
Creating a “Contents” Tab........................................................................................32
Adding a Graphic......................................................................................................33
Inserting Multimedia Files........................................................................................34
Inserting a Wave File................................................................................................34
Window Settings.......................................................................................................35
Changing the Background Color of a Popup.............................................................37
Setting Project Settings.............................................................................................39
Compiling the Help Project.......................................................................................41
Creating a Map File...................................................................................................42
SDK application project:C# Create PDF from OpenOffice to convert odt, odp files to PDF in
Note: When you get the error "Could not load file or assembly 'RasterEdge.Imaging. Basic' or any How to Use C#.NET Demo Code to Convert ODT to PDF in C#.NET
www.rasteredge.com
SDK application project:VB.NET PowerPoint: Sort and Reorder PowerPoint Slides by Using VB.
you can choose to show your PPT presentation in inverted clip art or screenshot to PowerPoint document slide & profession imaging controls, PDF document, image
www.rasteredge.com
What is WebHelp?....................................................................................................45
Generating WebHelp..........................................................................................46
Step 2: Connecting a Help File to an AVR application........51 
Calling Help from a Help Menu................................................................................53
Calling an HTML File Locally or on the Web...................................................54
Calling Help using a Help Button.............................................................................54
Using the Map Number Parameter.....................................................................55
Using the Help Topic ID Parameter...................................................................56
Using CommonDialog to Display a Help Topic by Keyword...........................56
Winhlp32 Parameters.........................................................................................57
Creating Context-Sensitive Help from an Application..............................................58
Specifying the Help File for the Project.............................................................58
Assigning Context-Sensitive Help in the Application.......................................59
Using the WhatsThisHelpID Button and Property.............................................63
Step 3: Connecting WebHelp to a Web Application............67 
What We Will Cover in Step 3..................................................................................68
What is WebHelp?....................................................................................................68
Calling the Entire WebHelp file from a Help Button................................................69
Displaying the Entire Help File in a Separate Window.............................................70
Displaying Context-Sensitive Help in a Separate Window.......................................71
Index .....................................................................................75 
SDK application project:VB.NET PowerPoint: Merge and Split PowerPoint Document(s) with PPT
documents and save the created new file in the sample code in VB.NET to finish PowerPoint document splitting If you want to see more PDF processing functions
www.rasteredge.com
SDK application project:VB.NET Create PDF from OpenOffice to convert odt, odp files to PDF
1odt.pdf"). How to VB.NET: Convert ODP to PDF. This code sample is able to convert ODP file to PDF document. ' odp convert
www.rasteredge.com
Introduction: 
Getting Started and About 
Help Files  
Using the Tutorial 
This tutorial uses RoboHelp, AVR/Caviar and FrontPage 2000.  Some prior 
experience in these applications may be helpful, but not necessary.    
How to use this Tutorial 
This tutorial is designed as a “self-learning”  tool and includes 3 additional chapters.  
Each chapter is a “step”  that can be performed independently, and does not rely 
upon the completion of the previous step.  You can merely use the source files 
needed that are included on the CD.   
At the beginning of each chapter, you will find: 
• 
A summary of the topics that will be covered in that step. 
• 
The approximate time to complete that step. 
• 
A visual representation of what the application will look like at the completion 
of that step. 
Source Files  
The completed source files for each of the tutorial steps can be found in the \Session 
05 – Creating Help Files and \Session 10 – Connecting Help Files to Apps folders 
as listed below.  
• 
The completed help file that is created in Step 1 can be found in \Session 05 – 
Creating Help Files\Examples\Help_File\Source Files. 
• 
The completed WebHelp file that is created in Step 1 can be found in \Session 10 
– Connecting Help Files to Apps\Examples\Web_Help. 
• 
The completed AVR application that is created in Step 2 can be found in \Session 
10 – Connecting Help Files to Apps\Examples\AVR_App\Completed App. 
• 
The completed Web application that is created in Step 3 can be found in \Session 
10 – Connecting Help Files to Apps\Examples\Web_App\Completed App. 
SDK application project:VB.NET PowerPoint: VB Codes to Create Linear and 2D Barcodes on
PowerPoint PDF 417 barcode library is a mature and Install and integrate our PowerPoint PLANET barcode creating to achieve PLANET barcode drawing on PPT file.
www.rasteredge.com
SDK application project:How to C#: Overview of Using XDoc.Windows Viewer
Generally speaking, you can use this .NET document imaging SDK to load, markup, convert, print, scan image and document. Support File Types. PDF.
www.rasteredge.com
2      Palooza 2001 Help Labs 
Saving Your Work 
When you save your work for a particular step, place it in a separate folder called 
Mine (or whatever you wish) instead of saving it directly onto the original file.  
This way, the original source files do not get overwritten, and you can compare 
your application to that of the tutorial. 
Manual Conventions 
The following is a list of conventions that are used throughout this tutorial 
representing particular functions. 
• 
beside a headline indicates a step-by-step process that you are to perform. 
• 
Numbered lists (1, 2, 3, and so on) indicate steps that you should follow. 
• 
Menu options, buttons, controls and keys that you are to select, along with 
words that you are to type will appear in boldface
What Do you Want to Do? 
This manual is both a reference guide and a step-by-step tutorial.  The Introduction 
chapter is strictly for explanation and reference, and Steps 1-3 are step-by-step 
tutorials.   
Note You do not need to perform Step 1 in order to complete Steps 2 and 3, as the 
help file that is created is already included with the AVR application folder within 
\Session 10 – Connecting Help Files to Apps.  
For information about Help Files and components – refer to information later 
in this chapter. 
For the step-by-step tutorial to create a Help file using RoboHelp  
see Step 1 – Creating a Help File. 
For the step-by-step tutorial to connect an existing Help file to an AVR 
application see Step 2 – Connecting a Help File to an AVR application. 
For the step-by-step tutorial to connect a Webhelp file to a Web application  
see Step 3 – Connecting a Help File to a Web application. 
Step 1 – Introduction About Help Files       3 
About Help Files 
Help Files are an integral part of a professional application.  They provide a quick 
and informative way of presenting information to users.   They are similar to printed 
documentation, but have additional benefits, such as hypertext links, allowing users 
to jump from one topic to another, or audio-visual capability that print media cannot 
provide.  
A Help File has an .HLP extension and runs under the Microsoft Windows Help 
program WINHELP (Windows 3.1, 95 or NT) or WINHLP32 (Windows 95/NT 
only).  Users only need Windows and the .HLP File. 
This chapter contains information on what a help file is and what components it has.  
Note that this step merely contains overview information, and there is nothing to do 
or create in this step.  It is not necessary to read this chapter before continuing with 
Steps 1, 2 and 3.  Continue with Step 1 to create a RoboHelp Help file, or continue 
with Step 2 to connect the existing help file to the AVR application, or Step 3 to 
connect the Webhelp file to a web application. 
What is a Windows Help File? 
• 
A Help file is online information containing groups of related topics connected 
by hypertext links. 
• 
The user is in control - you can quickly and easily find information and move 
around at will. 
• 
You can access the information quickly, when you need it without leaving your 
computer.  
• 
Help files can contain graphics, multimedia, tutorials, links to other help files or 
to HTML or ASP pages. 
• 
Help files can be in several different formats (.hlp, .chm, .htm). 
Why Create a Help File?
• 
Provides users with instant, accurate, and up-to-date assistance and information 
on using your product. 
• 
Increases knowledge, comfort level and confidence of the customer - just 
knowing the information is “there” . 
• 
As knowledge increases - phone support calls decrease. 
• 
Puts user in control - loves flexibility and addition of graphics, color, sounds, 
videos, buttons, and more. 
• 
With added technology and features of a help file - the user “expects”  it with a 
software application. 
How can you use Help?
• 
Software Application assistance. This is probably the most familiar use of Help.  
• 
Tutorials and computer based training. This type of Help can teach general 
techniques, features, or capabilities of a product or application.  
• 
Manuals and handbooks. User guides, employee manuals, policy and procedure 
books, human resources handbooks, standards and practices, and more.  
4      Palooza 2001 Help Labs 
• 
Online books. Online books can be interactive. Great for Sales and Marketing 
materials.  
• 
Catalogs and price lists.  
Types of Help Formats 
• 
WinHelp - 3.1 systems 
• 
WinHelp - 95/98/NT systems 
• 
Microsoft HTML Help  
• 
Cross-platform Help  
• 
Netscape NetHelp  
• 
Intranet help 
• 
Other Help formats 
• 
Windows CE 
• 
Java-based help 
WinHelp - 3.1 
• 
WinHelp - is the original help format that runs on a Microsoft Windows 
operating system.  
• 
Uses a WinHelp compiler (HCP, HCW or HC31.EXE) to process the Help file.  
• 
Contains an .HLP extension.  
• 
Uses WINHELP.EXE engine to run, which automatically comes with the 
Windows Operating System.   
• 
Can also run this file on Windows 95/NT systems. 
Issues: 
• 
Windows 3.1, or 16 bit applications are going away. 
• 
Works on Windows platforms only. 
• 
Doesn’t allow “Books and Pages” . 
• 
Limited features and capabilities. 
• 
Can’t link to a web site or an HTML page. 
• 
Does not support multimedia. 
WinHelp - 95/98 and NT 
• 
WinHelp - the original help format with the addition of a contents tab and a new 
interface containing books and pages. 
• 
Uses a WinHelp compiler (HCP, HCW or HCRTF.EXE) to process the Help 
file.  
• 
Generates two files, an .HLP and a .CNT extension.  
• 
Uses WINHLP32.EXE engine to run, which automatically comes with the 
Windows Operating System. 
Step 1      About Help Files       5 
Issues: 
• 
Will not run on Windows 3.1 systems. 
• 
Microsoft is establishing HTML Help as the standard. 
• 
Works on Windows platforms only. 
Strengths: 
• 
Will display using Winhlp32 on 32-bit Windows systems.   
• 
Can link to a web site or an HTML/ASP page. 
• 
Depending on authoring package used, can automatically convert to compiled 
(.CHM) or uncompiled HTML. 
HTML Help 
• 
HTML Help - developed by Microsoft in August 1997 is a completely new 
online Help standard for Windows 98, Windows NT 5, and future Microsoft 
applications. 
• 
Contains individual HTML files. 
• 
“Compiled”  version has a .CHM extension.  
• 
Uses HH.EXE engine and other files to run, which automatically comes with 
Windows 98 and NT 5. 
• 
Can access from application, stand-alone, or from an intranet or web. 
• 
Displays topics in a tri-pane window system, with the contents and topic 
windows displaying in “sync” . 
Issues: 
• 
Users must have Internet Explorer 4 or later to view. 
• 
Can be more programmer-intensive. 
• 
Not everyone has the “engine”  to view - will have to send and include with the 
help file. 
Strengths: 
• 
Now established as the standard. 
• 
Utilizes all advantages and features of HTML, as well as “help”  capabilities, 
such as popups, etc. 
• 
Any existing WinHelp file can be easily converted to HTML help (don’t have to 
“start over” ).   
• 
Can add to web site so updates to users are immediate. 
Cross-Platform (WebHelp) 
• 
Created using HTML - but uses an “uncompiled”  collection of HTML files. 
• 
Can be displayed using different Web browsers on a variety of computing 
platforms – including Microsoft Windows, Macintosh, and Unix.  
• 
Cross-platform Help is viewed using the default Internet browser on the end-
user's system.  
6      Palooza 2001 Help Labs 
• 
This Help format displays in a tri-pane window similar to the Microsoft HTML 
Help window. 
Issues
• 
There is no “find”  tab, so you cannot do full-text searches.  However, you can 
use a search engine on the web site. 
Strengths
• 
Any existing WinHelp or HTML Help file can be easily converted (don’t have 
to “start over” ). 
• 
Is browser-independent - will work with IE 4 and Netscape. 
• 
Provides all standards HTML-based features and runs on Windows, Macintosh 
and UNIX platforms.  
• 
Can add to web site so updates to users are immediate. 
• 
Detects the appropriate ActiveX controls to launch IE or uses a Java Applet to 
launch Netscape Navigator. 
Intranet Help 
• 
Intranet content is also comprised of uncompiled HTML files placed on intranet 
servers for departmental or company-wide access.  
• 
Use to create a variety of Help systems – including standalone information 
systems and online books. 
• 
End users only need the ability to access the network drive or server containing 
the intranet content files. 
• 
Because it's HTML-based, Intranet content is viewed using the Internet browser. 
Issues
• 
Users must have Internet Explorer to view. 
Strengths
• 
Comprised of uncompiled HTML files placed on intranet servers for 
departmental or company-wide access. 
• 
Any existing WinHelp file can be automatically converted (don’t have to “start 
over” ).   
• 
End users only need to access the network drive or server containing the intranet 
content files. 
Windows CE Help 
• 
Used with palmtop computers and other hand-held electronic devices.  
• 
These are a collection of uncompiled Help files placed directly on the palmtop 
or electronic device.  
• 
Contains individual .HTP files. 
• 
“Compiled”  version has an .HTC extension. 
Issues: 
Help generated cannot be viewed on a PC.  Must copy all files to a hand held PC. 
Documents you may be interested
Documents you may be interested