|
|
|
§ What are the benefits of a Help File?
§ What types of help systems or formats are there?
§ The help files (in Release 3.0 and above) look completely different, why?
§ Why does it take so long for the Help file to open?
§ The help file occasionally closes with an error in Winhlp32. What does this mean?
§ When selecting Search for Help On from the Help menu, why do I still have to select the Index tab?
§ How can I keep the help window on top?
§ Can I print multiple topics from a help file at the same time?
§ What help authoring products are available?
§ How long is the learning curve for a help authoring package?
§ Can I manually create a help file without purchasing software?
§ How can I get access to a help compiler?
§ Will I be able to use this format within my AVR application?
§ I am currently using Robohelp, how can I call a secondary window from within AVR?
What is Help?:
A help file is on-line information-at-your-fingertips. Help users interact with the online documents, and they are in control because they can quickly and easily move around at will through the electronic hypertext links from topic to topic. There are different ways of finding the information you’re looking for.
The help file is a self-executable file, containing a .HLP extension and is launched by Winhlp32.exe, which is automatically a part of all Windows 95, 98 and NT systems. For each .HLP file, you will also see a .CNT file, which contains the “Contents” tab.
The following are some benefits to using or creating a help file.
Added features and functionality. You can add images, sounds, videos, buttons, automatic page-turners (called browse sequences), and more.
Instant access. Users don't have to hunt for printed materials. As long as they're at the computer, Help is literally at their fingertips.
Increased control. Help puts the user in control. The user determines where to go next and what paths to take, limited only by the ways the author has set up and linked the information.
Decreased costs. You can increase the bottom line by decreasing the paper, printing, production, and distribution (shipping) costs.
You can create a Help system for just about any type of online document you can think of. With the availability of the Internet and Intranet, the possibilities are limited only by your imagination. Here are just a few examples:
Application assistance. The most familiar use of Help. Software applications usually come with a built-in context-sensitive Help system to provide its users with assistance and instructions when using the application.
Manuals and handbooks. Because of the rapid publishing and cost benefits, many companies are placing their manuals and handbooks online – user guides, employee manuals, policy and procedure books, human resources handbooks, standards and practices, and more.
Online books. Help systems are an easy and efficient way to package and publish online books because they broaden the scope and range of books. Online books can be interactive. They can easily incorporate images and multimedia.
Tutorials and computer based training. Online training can cut costs and allow individuals to learn at their own pace on their own schedule. Tutorials and computer-based training allow individuals to interact with an application in a controlled, safe environment.
Sales and marketing materials. More and more, companies and individuals are using Help systems for sales and marketing materials. They're publishing everything from up-to-the-minute in-house sales reports to newsletters, brochures, catalogs, company profiles, and product demonstrations.
Catalogs and price lists. Another great way to use a Help system is to provide catalogs and price lists. Users can browse the catalog, see and hear the merchandise, and purchase immediately.
There are different types of Help systems, or Help formats because there are different ways to view a Help system, depending on the type of computer and software that computer runs on.
WinHelp. WinHelp is short for Windows Help. It's the "original" compiled Help format. You can use WinHelp if your audience uses a Microsoft Windows operating system – Windows 3.1, 95, 98, NT 4, or NT 5. Every version of Windows automatically comes with a built-in WinHelp viewer.
Microsoft HTML Help. Microsoft's Help systems for Windows 98 and Windows NT 5 use the Microsoft HTML Help format. Microsoft HTML Help comes with Windows 98 and NT 5 and can be viewed on Windows 95 and NT 4 using Internet Explorer 4 or later. Instead of using the WinHelp viewer, Microsoft HTML Help uses an Internet browser (specifically Internet Explorer 4 or later) as its Help viewer and displays Help in a tri-pane HTML Help window.
Cross-platform Help. This format runs on multiple platforms (Windows, Macintosh, and Unix) and can be viewed using a variety of browses, including Netscape Navigator and Internet Explorer.
Intranet content. This format is accessed from an Intranet server for departmental or company-wide access.
Other Help formats. As technology advances, other Help formats emerge. For example, Windows CE Help is another Help format that runs on palmtop computers and other hand-held electronic devices.
Using Help:
The look of AVR's help files have changed to a tri-pane Help window that features the Contents, Index, and Search tabs alongside Help topics. This feature simulates the 'look and feel' of Windows 98-style HTML help, and allows the ability to search for and access HTML topics that reside on a web site from "inside" your help system. For instance, index keywords have been added that will take you directly to an HTML or ASP page within ASNA's web site, or another web site, without having to leave your help file!!
The reference to a “tri-pane” window refers to 3 parts 1) Menu options and buttons 2) Left window 3) Right window. The window on the left contains all the help topics contained within "books" and "pages". The window on the right displays the contents of the selected topic. The two windows work together, so when a link is selected on the right, you will see the corresponding "page" on the left, and vice versa. This feature is helpful in that you can "see" where the topic resides within the contents of the help file.
You will notice that there is now a slight delay when opening the help file (approximately 4-5 seconds). . This delay is due to the added HTML functionality, in which special DLL’s are searched for and opened, as well as indexes being built. However, once the file is open, you will not have any delay in accessing a keyword or topic, even it the topic resides on a web site. To minimize this delay, you could “Minimize” the help file, so it’s always “open”.
The left and right windows are sometimes too “small” to display all of the text. How can I make them bigger?
Due to the new "HTML" look feature, the help file may appear "bigger". Note that the total window size is the same size as in previous releases. However, due to the addition of the left-pane, the "viewing" area of the topic contents is actually smaller. Since the viewing area (with the left pane displayed) is actually smaller, note that some links or contents of the help topics may appear unaligned, due to the fact that text is "wrapped". The viewing area can be increased by “hiding” the left window. Refer to Hide Left Window for the 2 ways in which you can “hide” the left window.
The resolution in which the help file is viewed will also affect the amount of text that is visible on the right side without doing a lot of "scrolling". Note that the help file was compiled at 800x600, and for maximum viewability of the content, 1024 x 768 resolution is recommended, but not necessary. By selecting the Help Topics button as mentioned above, you will increase the viewing area and alleviate the possible "wrapping" of text.
If you want to ‘hide” the left window to increase your viewing of the help topic, you can do this by either:
· Selecting the Help Topics button, which acts as a "toggle" button and removes the left pane. Selecting the Help Topics button again to re-display the left window again.
· Selecting the Hide Left Window or Show Left Window menu option from the AVR Help menu located at the top of the Help window.
Occasionally, you may experience an error in Winhlp32.exe when trying to access a help topic. This is an error within Winhlp32.exe and is not a problem with the help files.
To resolve, simply close the help file, reopen, and select the help topic you were trying to access. To possibly prevent this from occurring, you may want to periodically close the help file when not in use to "clear" the memory that winhlp32.exe is allocating.
In previous releases, all AVR-specific documentation was included within the AVR.HLP file. In this release, the AVR help file has been "split" into multiple help files.
The AVR.hlp file is opened when you select Contents from the Help menu within the AVR IDE. From this file, you have access to all help files. There is no need to open any of the other help files.
This was only done to create smaller, more easily maintainable files. This will not affect the usability of them in any way.
- Index tab?You’re right, selecting this option is exactly the same as selecting the Contents menu option. This action is a problem with the help authoring package, and not a problem with AVR. The Search menu option was left, awaiting a resolution in the near future.
To keep the help window on top while working in another application, select Keep Help On Top from the Options menu.
Default specifies the default action of the help file when it was created., which is typically not specified as “On Top”. Select the On Top option to keep the help window on top when you switch to another application. Even when the help window is closed and reopened, this setting will remain until you select Default, or Not On Top.
When you see text that is in Bold for the syntax of an op code, property, event or method, this indicates that those keywords, or parameters are required, and must be included. If you omit a required parameter, you will receive a compiler error stating that the keyword, or parameter is required.
Note that the new HTML help format does not allow you to print multiple topics. This capability can be done in Winhelp help files, and note that selecting F1 from the IDE when the help file has not been “opened”, then selecting the Help Topics button will display the previous Winhelp format. In this format, you can select the Book of topics you wish to print, then select the Print button located at the bottom on the help window. All topics within the selected book will print, each on a separate page.
Creating Help:
OK, you know you need to create a help file, but how do you create it? If this is your first Help system, you probably want to try creating a small Help system to get the feel for the Help authoring process.
Here are some basic steps to creating any Help system:
Select an authoring environment. Decide which Help format best meets your users' needs. Then select the Help authoring tool suited for that environment.
Create a Help project. Using your selected Help authoring tool, set up the Help project. The Help project allows you to manage and organize all the source files that go into creating the Help system.
Create topics. Next, create your topics using text, images, sound, or video.
Link the topics. After your topics are created, you need to creates links to them for your users to access the topics. Links can be in the form of text (jumps or popups), graphics, buttons, multimedia, etc.
Create a table of contents. The table of contents is one of the first things your user sees. It's also an important way users access the topics in your Help system.
Create an index. To create the index, you'll create the keywords and phrases that your users will most likely search for to find information. You associate keywords with your topics, so that when users search for a keyword, they instantly see the topic or topics associated with the selected keyword.
Compile the Help system. When you're ready to see the results of your efforts, compile the source files into the Help system.
Test the Help system. Testing is important, so that users can access each topic without errors. If you find problems, resolve them in the source files and make the Help system again.
Deliver the Help system. When you're satisfied with the way your Help system looks and acts, ship the necessary help files and components in your desired format.
There are many types of help authoring packages available. You can refer to the Book titled Help Authoring with Web Resources for links to some of the main software products available. For a complete listing of all help authoring products, select either Help University or Shareware Store.
The cost of a help authoring package varies, depending on the amount of “features” or components the product has. You can get very generic shareware from approximately $30 all the way up to a multiple-platform package, which could be approximately $400 and up.
This would depend upon the complexity and type of help file to create, the help authoring package purchased, whether existing documentation already exists, and the knowledge of the help author. Check to see if the software packages you’re looking at contains adequate tutorials and documentation.
You can create a basic help file, even in notepad. However, it is extremely tedious and time consuming, and you would have to find documentation on how to do it. You would also have to have access to a help compiler, HCP, HCW or HC31.EXE.
The Winhelp compilers HCP, HCW or HC31.EXE can be found on the Microsoft Developers Network CD, or within Visual Basic. You will also receive the compilers when you purchase a help authoring package.
If I currently have existing documentation, will I be able to use my current documentation in my help file?
Yes, but only if the help authoring package contains this feature. The major help authoring packages are typically an add-on to a word processor, such as Microsoft Word. Any file format that the word processor allows you to open will work.
I currently do not have a manual, would I be able to easily create a manual from the same information as found in my help file.
Yes, but only if the help authoring package contains this feature.
I would like to generate tutorials. What software do I need to get, or is that included with the help authoring package?
Some help authoring packages do contain video camera software.
I still have users on the 3.1 Windows operating system. Will I be able to generate help files for both my 3.1 and 95/NT users without having to maintain 2 files?
Yes, but again, only if the help authoring package contains this feature.
I will need to generate help files for our web site as well. Is an HTML software package needed? How involved is this capability?
Note that some help authoring packages include the functionality to automatically convert a help file into an HTML help file. It typically is just a “wizard” and only takes a minute or two.
I have heard about Microsoft’s HTML help? How is this different from a “standard” help file. Is it generated using a different product than when generating Winhelp help files?
Microsoft’s HTML help is a help file designed in true HTML. The HTML file is compiled, creating a .CHM file. The new help files included in this release of AVR simulate the “look and feel” of an HTML help file. You can purchase an authoring package strictly for HTML, or some authoring packages allow you to create one file format, and automatically create other formats as well.
At this time, AVR only accepts Winhelp files (.HLP) and this feature is planned for a future release.
I currently do not have any documentation, and have purchased Robohelp. Where do you suggest I start, with the Manual or with the help file?
This would depend on several things, such as which format you need first, how will your users be accessing the information most often, how many people do you have accessible, etc. If you quickly need a help file to go with your application, then you may want to do the help file first. If the help authoring package automatically generates printed documentation, you can then have the manual ready shortly thereafter.
To call a secondary window from AVR, you must first have specified, or created a secondary window within the help system. To call that secondary window when using context-sensitive help from AVR, you must specify a greater than sign (>) followed by the name of the secondary window after you specify the name of the help file the project will access. This is done by selecting Project Settings from the Project menu, and entering a Help File Name, immediately followed by >secondary window, as in the example below.
D:\DOCUMENT\HELPFILE\Myfiles\MyHelp.hlp>Second
|
04/28/2007
© 2007.
Amalgamated Software of
|