Copyright: (C) 1994,1995 Y.Umeki and H.Ozawa


Contents
Helpcard 94.11E English version (C) 1994 , Yasuhiro Umeki

Translated by Hitoshi Ozawa	 (FREE SOFT)

Writing a Windows help file is a very laborious task, but there are elements common in most help files.  HelpCard was develooped to assist writers create help file more efficiently by automating common elements and allowing users to define common help file properties.

HelpCard even allows novice users to create Windows Help file just by filling cards (topic elements). HelpCard generates all the other necessary files neccessary to compile a help file. Nevertheless, HelpCard supports many optional parameters to allow users to create more complex help files as users gain more experience creating help files.

Included files, requirements, and setup

How to make a simple help file

How to make a complex help file

Menus

File extensions

Books and magazines

Copyright and Distribution

Liability

Support


Included files, requirements, and setup
Setting Up HelpCard on Your System

Requirements

Hardware:

80386 or higher machine

4MB or more RAM memory

Software:

Windows 3.1

VBRUN300.DLL 	Visual Basic Ver.3.0 runtime routine

CMDIALOG.VBX	Visual Basic common dialog box (included in HLPCRD.LZH)

HC.EXE and HC.ERR	Help compiler and error message files

Included files

HELPCARD.EXE	Execution file

HELPCARD.HLP	Help file

KETUGO.SAR 	Concatenation example file - Title page

KETUGO1.SAR 	Concatenation example file - project 1

KETUGO2.SAR	Concatenation example file - project 2

KETUGO3.SAR	Concatenation example file - project 3

CMDIALOG.VBX  	Visual BASIC common dialog box

README.TXT	Introduction

Installation

1. Copy VBRUN300.DLL and CMDIALOG.VBX files to \WINDOWS\SYSTEM directory.

2. Extract HLPCRD.LZH file in a directory.

3. Open group Main in the Program Manager (double click the left mouse button on Main icon).

4. Open PIF Editor (double click the left mouse button on PIF Editor icon).

5. Open _DEFAULT.PIF file

6. Select Windowed for Display Usage option.

7. Check Close Window on Exit option.

8. Save _DEFAULT.PIF file.

8. Execute HELPCARD.EXE from the File Manager or the Program Manager.

Setup

1. Set Help compiler directory.

2. If you are using Visual BASIC, setVB.EXE directory.

WARNINGS:

1. No not move to another window during compile.  HelpCard opens a DOS window to compile a help file, moving a focus to another window will stop compilation.

2. Close DOS window prior to closing HelpCard.  HelpCard will not close if DOS window is left open.

Related information:

HC31.EXE, VB.EXE

Development environment


How to Make a Simple Help File

Easiest way to make a help file is to create new cards and fill them in one topic at a time.  After writing all topics,make a help file by selecting a command from a menu.  HelpCard generates all files needed to compile the help file and compile the file.

With experience, more "neat" looking help files may be created.  However, be sure to remember that you are writing a help file to assist users understand your software and not just to impress them with neat help file tricks.

To begin, please read Defining titles and Creating a new card sections.

Defining a title

Creating a new card

Rearranging cards

Setting hierarchical levels


Defining a Title

Each topic is represented by a card in HelpCard.  In each card, three definitions are necessary:

Context	An unique ID to separate a card from other cards

Title	Topic of a card

Keywords	Words used to find necessary information within a help file

Please look at the top grey area.  This area is called the Toolbar.  Context, Title, and Keyword fields are vertically arranged at the right side of this Toolbar.

Context field is already filled in with a text starting with HID_N.

Titles may be entered/changed by selecting Title from the Edit pull-down menu, but it may also be entered/changed by clicking the left mouse button in the Title field in the toolbar.  If Keyword=Title options is checked, content of the title field is copied to the keyword field.


Creating a New Card

To create a new card, choose the New card button at the upper left corner of the toolbar.  A new card is appended to the current card with a new context name.  Please enter a title and keyword.

After entering a text in the card, click the left mouse button on the card title display at the lower left corner of the tool bar.  Use the mouse to move up the list. Highlight a different topic to move to a corresponding card.

To move single card at a time, click the left mouse button on left [image] and right [image] arrows on the  horizontal radio box. Card may also be moved by selecting Next card and Previous card from the Edit menu.

To move quickly to another card, move the radio handle.


Rearranging Cards

After filling many cards, it may be necessary to change ordering of some cards.  In such a situtation, select Rearrange from the Edit pull-down menu.

After rearranging cards, hierarchical levels of cards may change.  Check levels and readjust levels if needed.


Setting Hierarchical Levels

HelpCard can generate Table of Contents based on hierarchical levelinformation.

If Display hierachical levels option is checked, '+' mark is inserted in front of the title in the Combo box field to represent the depth of the card.

Title page	 (Table of index of level1 cards)

Level1 card 1	 (Table of index of level2 cards)

+ Level2 card 1-1

+ Level2 card 1-2	 (Table of index of level3 1-2 cards)

++ Level3 card 1-2-1

++ Level3 card 1-2-2

++ Level3 card 1-2-3

+ Level2 card 1-3  (Table of index of level 3 1-3 cards)

++ Level3 card 1-3-1

++ Level3 card 1-3-2

+ Level2 card 1-4

Level1 card 2

HelpCard supports up to 9 levels, but if levels are made too deep it is difficult for a  user to find information.


How to Make a Complex Help File

As developers gain more experience making help files, more complex operations are demanded. HelpCard provides various optional parameters to fulfill these needs.

Linking cards

Looking at other linked cards

Linking help file to an application

Linking VB application to Help

Concatenating files

Making text look better

WARNINGS


Linking Cards

It may be sufficient for a simple help card to only refer to another card by way of table of contents, but as help file gets more complicated, it may be necessary interconnect cards.  Jump and Popup are some ways to interconnect cards.

When cards are linked, clicking the left mouse button on the highlighted text (usually colored green), displays further information about the text or move the user to a related topic.


Looking at Other Linked Cards

To assist developers write sentences that are continuous between cards, it is possible to switch to a linked card and switch back to the original card.


Linking Help File to an Application

If a dialog box in an application contains many items, it may be convenient for an user to just select an item and press the F1 key to display information about the selected item.  HelpCard assists developers make this connection.

To make this connection:

1. Create an application first.

2. Make a help file.

3. Modify an application by entering context ids from the help file into an application.

HelpCard assists Visual Basic developers link applications to a help file more easily.

WARNING:

If help file is modified, HelpCard may change the context ids of a card.  It may be necessary to modify an application again to reflect new context ids.


Linking VB Application to Help

NOTE: Following codes may be copied (select copy from the Edit menu) to your application.

To link a help file with Visual Basic application, enter the following statements in the code module:

Global Const HELP_CONTEXT = &H1

Global Const HELP_QUIT = &H2

Global Const HELP_INDEX = &H3

Global Const HELP_HELPONHELP = &H4

Global Const HELP_SETINDEX = &H5

Global Const HELP_KEY = &H101

Global Const HELP_MULTIKEY = &H201

Global Const HELP_PARTIALKEY = &H105

Declare Function WinHelp Lib "User" (ByVal hWnd As Integer, ByVal lpHelpFile As String, ByVal wCommand As Integer, dwData As Any) As Integer

Type KEYHELP

    kkk As String * 1

End Type

and add the following codes in the Form_Load object in the startup module:

Dim tmp as String

tmp = app.Path

If (Right$(tmp, 1) <> "\") Then

tmp = tmp + "\"

End If

app.HelpFile = tmp + "foo.hlp"

NOTE:

Unless full path is specified, Windows may not be able to find the help file.

Add the following code to menus and buttons:

   Help menu - Contents

Contents	ret% = WinHelp(form1.hWnd, app.HelpFile, HELP_INDEX, 0)

   Open context sensitive help

Dim id_no As Long	'Enter context id in place of id_no

ret% = WinHelp(form1.hWnd, app.HelpFile, HELP_CONTEXT, ByVal id_no)

   Help menu - How to use help

ret% = WinHelp(form1.hWnd, app.HelpFile, HELP_HELPONHELP, 0)

   Search by keyword

Dim tmp As KEYHELP

tmp.kkk = Chr$(0)

ret% = WinHelp(form1.hWnd, app.HelpFile, HELP_PARTIALKEY, tmp)

On program exit add the following statement to close the help file to make sure help file is not left open.

ret% = WinHelp(form1.hWnd, app.HelpFile, HELP_QUIT, 0)


Concatenating Files

To write a long help file, it is often convenient to assign sections to different people. HelpCard assists developers concatenate files after they are all written.

Following files are included with this program as an example of concatenation files:

ketugo.sar	Title project

katugo1.sar	Section 1

ketugo2.sar	Section 2

ketugo3.sar	Section 3

To practice on these file, it is necessary to open each file and create a RTF file. Please read text in the files for further infomation.


Making text look better
This area is unscrollable area using \keepn special characters.

Click the picture to display a popup.

HelpCard is developed to assist developers make a help file and does not offer WYSWYG interface, but it is still possible to add few extra touches to make help screen look nice. Special characters may be inserted into a text to change their properties.


WARNINGS

Purpose of a help file is to assist users to perform a task by providing necessary information. Following are some hints to make a better help file:

1. Make each card fit in single screen.

2. Use common card format.

3. Do not use too much color to detract users from important information.

4. Do not use suble coloring scheme. Some users still use monochrome displays.

5. Do not make levels too deep. It is difficult to find information deeply embedded information.

6. Do not use different fonts too much. It is difficult to recognize differring characters.

7. Do not add too much bitmap images. They make help file bigger.


Menus

File options

How to edit cards

How to search

How to insert special codes

How to change card display

How to set compilation options

Help


File Options

How to create a new project

How to open a project file

How to save a project

How to name a file to save

How to create a new card

How to delete a card (topic)

How to insert text file

How to save as a text file

How to delete work files

How to make a help file

Executing HC.EXE

How to concatenate files

How to exit HelpCard


How to create a new project
Initialize all settings and open a blank project.

RECOMMENDATION:

Instead of selecting New project, close HelpCard and reopen it with a new project.


How to open a project file
Open a HelpCard project file (files with SAR extension).

NOTES:

1. It is also possible to immediately open a project file by specifying full path name in the command line following HELPCARD.

Example: HELPCARD c:.SAR

2. To launch HelpCard from the File Manager and program launchers, associate SAR file with HELPCARD.EXE

(a) Open File Manager.

(b) Select File on the menu.

(c) Select Associate from the pull-down menu.

(d) Enter SAR in the File extension field.

(e) Enter HELPCARD.EXE in the Application field.

(f) Choose the OK button.


Development Environment

HelpCard is developed on the following platform:

Hardware

PC Direct i486DX 50iC + 16MB + STELTH Pro 2MB + IDE 400MB HDD + CTX CPS-1760DF

EPSON MJ700V2C + EPSON GT6000 + MICRO CORE 14400FX + PAS16 Multimedia System + Musirou 88pro

Software

MS DOS 6.2/V  + MS Windows 3.1(Japanese) + Visual Basic 2.0 standard/profession editions (Japanese) + VCP + SDK + MSDN Lv2


How to save a project
If a project name is already defined, selecting Save overwrites the current file.  If it is not defined, the program opens a Save As dialog box and ask you to enter a file name.


How to name a file to save
Prompt for a file to save a file.

NOTE:

By default, SAR is appended as file extensions.


How to create a new card
Create a new card (topic).

Always enter Title and Keyword after creating a new card.


How to delete a card (topic)
Delete current card (topic) from the project.


How to insert text file
Enters contents of a text file into the current card.

WARNING:

Size of each card must be less than 32KB.

RECOMMENDATION:

Make each card to fit one screen.  It is easier for users to read


How to save as a text file
Output the current card as a text file which can be edited by a text editor such as NotePad.

NOTE:

Text data may also be copied to an another Windows application by using the Clipboard.

1. Select area to copy to the Clipboard.

2. Select Edit from the menu.

3. Select Copy from the pull-down menu.


How to delete work files
When creating a help file, HelpCard creates some work files.  Selecting Delete work files deletes all works files associated with the project.

NOTE:

These work files are re-created everytime help file is re-created from the HelpCard project file (files with SAR extension).


How to make a help file
Generate all files necessary to execute a help compiler (HC.EXE) and compile to create  a help file.


Executing HC.EXE
Recompile card files without generating work files.


How to concatenate files
Concatenate several HelpCard (files with SAR extension) to one project.


How to exit HelpCard
To exit HelpCard:

1. Select File from the menu.

2. Select Exit from the pull-down menu.


How to edit cards
Edit Options

How to cut to the Clipboard

How to copy to the Clipboard

How to paste from the Clipboard

How to delete objects

How to select entire objects in a card

How to change a context name

How to set a title

How to set a keyword

How to rearrange cards

How to set hierarchical level

How to link with VB applications


How to cut to the Clipboard
Cut selected objects to the Clipboard.  Selected object is deleted from the card after cutting.

To cut an object to the Clipboard:

1. Select an object to cut to the Clipboard.

2. Select Edit from the menu.

3. Select Cut from the pull-down menu.


How to copy to the Clipboard
Copy selected objects to the Clipboard.  Selected objects will remain after copy.

To copy an object to the Clipboard:

1. Select object to paste to the Clipboard.

2. Select Edit from the menu.

3. Select Paste from the pull-down menu.


How to paste from the Clipboard
Paste content of the Clipboard to the current cursor position.  If objects are selected, this operation replaces them with the content of the Clipboard.

To paste an object from the Clipboard:

1. Move the cursor to  a position to insert an object.

2. Select Edit from the menu.

3. Select Paste from the pull-down menu.


How to delete objects
Delete selected objects from a card.

To delete an object:

1. Select an object to delete.

2. Select Edit from the menu.

3. Select Delete from the pull-down menu.


How to select entire objects in a card
Select entire objects in a current card.

To select entire objects:

1. Select Edit from the menu.

2. Select Select all from the pull-down menu.


How to change a context name
Context name is generated by HelpCard.  To change this name:

To change context:

1. Select Edit from the menu.

2. Select Context from the pull-down menu.

3. Enter a context name.

4. Choose the OK button.

WARNING:

Context name can not start with text HID_N.


How to set a title
Change title of a current card.

To change an title:

1. Select Edit from the menu.

2. Select Title from the pull-down menu.

3. Enter a title.

4. Choose the OK button.

NOTE:

Title may also be changed by double-clicking the left mouse button in title field.


How to set a keyword
Change keyword of a current card.  Keywords are used as an index to Search for a topic in a help file.

To change an keyword:

1. Select Edit from the menu.

2. Select Keyword from the pull-down menu.

3. Enter a keyword.

4. Choose the OK button.

NOTES:

1. Keyword may also be changed by double-clicking the left mouse button in keyword field.

2. To set several keywords, separate each keyword with a semi-colon (;).


How to rearrange cards
Change card ordering.  This ordering and the hierarchical level of a card determines how cards are displayed in a help file.

Change title of a current card.

To rearrange cards:

1. Select Edit from the menu.

2. Select Rearrange from the pull-down menu.


How to set hierarchical level
Set hierarchical level of a card. Context IDs are generated with to reflect the hierarchical level of a card. Indices to lower level cards are created in the higher cards.

NOTE:

To open a certain help windows page from an application (such as VB and VC++), check the hierarchical level.


How to link with VB applications
 Visual BASIC source may be compiled by saving it in a text format and setting context IDs.

To link to Visual BASIC application:

1. Select Edit from the menu.

2. Select Link to VB from the pull-down menu.

3. Choose the Set VB project.

4. Select Context ID, VB object, and VB form.

5. Choose the Set ID button.

6. Repeat steps 4 and 5 for all context ids.

7. Choose the Compile button.

WARNING:

1. Help file must be made before VB source is compiled.  Context IDs are changed if cards are rearranged, levels of cards changed, or context IDs of cards modified.

2. BASIC source text file should be generated by the Visual Basic program.  It is recommended that this source file and help project file (file with SAR extension) be backed up.

3. Be sure that Visual BASIC is closed outside HelpCard.

4. Be sure to set VB.EXE directory.


How to search
Search Options

How to search for a text string

How to search for a next text string match

How to search backward through cards

How to replace text

How to jump to another context

How to return from another context

How to move to the top of a card

How to move to the botton on the card


How to search for a text string
Searches cards for a text string.

To search for a text string:

1. Select Search from the menu.

2. Select Find from the pull-down menu.

3. Enter text string to search.

4. Choose the Find button.


How to search for a next text string match
Search for the next text string match defined in the Find dialog box.

To search for a next text string match:

1. Select Search from the menu.

2. Select Find next from the pull-down menu.

NOTE:

Next text string match may also be found by pressing the F3 key.


How to search backward through cards
Search for the previous text string match defined in the Find dialog box.

To search for a previous text string match:

1. Select Search from the menu.

2. Select Find before from the pull-down menu.

NOTE:

Next text string match may also be found by pressing Shift+F3 keys.


How to replace text
Replace text string with another text string.

To replace text string:

1. Select Search from the menu.

2. Select Replace from the pull-down menu.


How to jump to another context
Display the card corresponding to the selected context in a card.

To jump to selected context:

1. Select a context within a card (drag a mouse over a context id or double click the left mouse button within the context text).

2. Select Search from the menu.

3. Select Context from the pull-down menu.

WARNING:

Be sure to select a context before executing this command.  HelpCard will terminate if context is not selected.


How to return from another context
Return to the original card afterjumping to another context.

To return to original card:

1. Select Search from the menu.

2. Select Return from the pull-down menu.


How to move to the top of a card
Move the cursor to the top of the current card.

To move to the top of the card:

1. Select Search from the menu.

2. Select Top from the pull-down menu.


How to move to the botton on the card
Move the cursor to the bottom of the current card.

To move to the bottom of the card:

1. Select Search from the menu.

2. Select Bottom from the pull-down menu.


How to insert special codes
Insert Options

How to link cards

How to insert a bitmap image

How to change text properties

How to change other properties


How to link cards
Link two cards (topics).  There are two ways to link a card- jump and popup.  Jump moves the view completely to a new card.  Popup just displays a new popup window at the location of the selected object.

To link an object:

1. Select an object.

2. Select Insert from the menu.

3. Select Link from the pull-down menu.

4. Select a card to link to.

5. Choose either Jump or Popup button depending.


How to insert a bitmap image
Inserts a bitmap image (files with BMP or WMF extensions) into a card.

WARNING:

Bitmap image files must be in the same directory as the help project file (file with SAR extension).


How to change text properties
Insert special characters to change text font, size, style, and color.


How to change other properties
Insert special characters to change properties of objects (excluding link, bitmap image, and text).


How to change card display
Display Options

How to display help file

How to display compilation option file

How to display RTF file

How to display content header file

How to display error log

How to display a next card

How to display a previous card

How to display next top level card

How to display previous top level card


How to display help file
Display help file if it exists.

To display help file.

1. Select Display from the menu.

2. Select HLP help file from the pull-down menu.

WARNING:

Help file (file with HLP extension) must exist.  Make a help file before selecting this option.


How to display compilation option file
Display help compilation option file (file with HPJ extension).

To display help compilation option file:

1. Select Display from the menu.

2. Select HPJ help project from the pull-down menu.

WARNING:

Help compilation option file (file with HLP extension) must exist.  Make a help compilation option file before selecting this option.


How to display RTF file
Display RTF file corresponding to the current opened project.

To display a RTF file:

1. Select Display from the menu.

2. Select RTF text file from the pull-down menu.

WARNING:

RTF file (file with RTF extension) must exist.  Make a RTF file before selecting this option.


How to display content header file
Opens a text editor and display contents of help header file.  This file lists statements defining context texts in a C language format.  If these IDs are set as object's context ID in an application, users can jump to the specific card by pressing the F1 button when the object has a focus.

To display contents of help header file:

1. Select Display from the menu.

2. Select Header from the pull-down menu.


How to display error log
Opens a text editor and display contents of error log file.  This file contains help compile messages.

To display contents of error log file:

1. Select Display from the menu.

2. Select Error log from the pull-down menu.


How to display a next card
Display a next card.

To display a next card:

1. Select Display from the menu.

2. Select Next card from the pull-down menu.

NOTE:

Next card is also displayed by pressing the F6 key.


How to display a previous card
Display a previous card.

To display a previous card:

1. Select Display from the menu.

2. Select Previous card from the pull-down menu.

NOTE:

Previous card is also displayed by pressing Shift+F6 keys.


How to display next top level card
Display the next top level card.  This operation displays contents of the Title page.

Move the next top level card:

1. Select Display from the menu.

2. Select Next top from the pull-down menu.

NOTE:

It is possible to move to the next top level card by pressing the F4 key.


How to display previous top level card
Display the previous top level card.  This operation displays contents of the Title page.

Move the previous top level card:

1. Select Display from the menu.

2. Select Previous top from the pull-down menu.

NOTE:

It is possible to move to the previous top level card by pressing Shift+F4 keys.


How to set compilation options
Options

Code generation	Set how RTF files are to be created

Operation	Set how HelpCard operates

Environment	Set HelpCard environmental parameters

Help project	Set help project options

How to set help compilation options

How to set operational parameters

How to set HelpCard environmental parameters

How to set help project options


How to set help compilation options
Compile Options

How to automatically append contents

How to automatically insert title in every card

How to automatically insert titles in popups

How to insert titles in first cards of concatenated files

How to automatically append a return after titles

How to end titles with a return.

How to save code generation parameters with a project file


How to automatically append contents
Specify whether to automatically append table of contents of lower level cards

To automatically append contents:

1. Select Options from the menu.

2. Select Code generation from the pull-down menu.

3. Check Auto Contents from the sub-menu.

NOTE:

Select the Auto Contents again to uncheck this option.


How to automatically insert title in every card
Specify whether to automatically insert title in every card excluding popup cards.

To automatically insert titles:

1. Select Options from the menu.

2. Select Code generation from the pull-down menu.

3. Check Insert titles from the sub-menu.

NOTE:

Select the Insert titles again to uncheck this option.


How to automatically insert titles in popups
Specify whether to automatically insert titles in popup cards.

To automatically insert titles:

1. Select Options from the menu.

2. Select Code generation from the pull-down menu.

3. Check Insert popup titles from the sub-menu.

NOTE:

Select the Insert popup titles again to uncheck this option.


How to insert titles in first cards of concatenated files
Specify whether to automatically insert title in the first card of concatenated files.

To automatically insert title:

1. Select Options from the menu.

2. Select Code generation from the pull-down menu.

3. Check Title first from the sub-menu.

NOTE:

Select the Title first again to uncheck this option.


How to automatically append a return after titles
Specify whether to automatically append a return code after titles.

To automatically insert a return:

1. Select Options from the menu.

2. Select Code generation from the pull-down menu.

3. Check Append return[ from the sub-menu.

NOTE:

Select the Append return again to uncheck this option.


How to end titles with a return.
Specify whether to automatically end titles with a return.

To automatically end titles with a return:

1. Select Options from the menu.

2. Select Code generation from the pull-down menu.

3. Check End with Return from the sub-menu.

NOTES:

Select the End with Return again to uncheck this option.


How to save code generation parameters with a project file
Save code generation parameter settings in the project file instead to a global HELPCARD.DAT file.

To save code generation parameter settings per project:

1. Select Options from the menu.

2. Select Code generation from the pull-down menu.

3. Check Save options/project from the sub-menu.

NOTES:

Select the Save options/project again to uncheck this option.


How to set operational parameters
Operational Parameters

How to automatically set keyword equal to title

How to activate/deactive help compiler

How to display hierarchical levels


How to automatically set keyword equal to title
Copy content of a title field to a keyword field.

WARNING:

If several keywords are defined, it is necessary to enter them manually.


How to activate/deactive help compiler
Specify whether to compile when making help files.  When this option is not checked, HelpCard creates only necessary files.

RECOMMENDATION:

If there are many cards and bitmap images, HelpCard may not be able to compile due to lack of memory.  In this circumstance, it is recommended to uncheck this option and execute a help compiler (HC.EXE) after exiting Windows.


How to display hierarchical levels
Display depth of hierachical level by prefixing title name in the tool bar with a plus '+' sign.

To display hierachical information:

1. Select Option from the menu.

2. Select Operation from the pull-down menu.

3. Check the Hierachical level option.

NOTE:

Select the Hierachical level again to uncheck this option.


How to set HelpCard environmental parameters
Environmental Parameters

How to set HC.EXE directory

How to set VB.EXE directory

How to set text editor to use

Specify font to display

How to change toolbar size


How to set HC.EXE directory
Specify the directory of HC.EXE file.


How to set VB.EXE directory
Specify the directory of VB.EXE file.

NOTE:

If Visual Basic is not used, this setting is not necessary.


How to set text editor to use
Specify text editor to use to display files.

Example: NotePad

WARNING:

Text editor must support file name option in the command line.


Specify font to display
Specify which font to display text.

To change font:

1. Select Options from the menu.

2. Select Environment from the pull-down menu.

3. Select Fonts from the sub-menu.

4. Select a font.

5. Choose the OK button.


How to change toolbar size
Change toolbar size.

Recommendation:

If you are using HelpCard on a high resolution monitor, it is recommended to set this option to Large.


How to set help project options
Project Options

How to set help title

How to set copyright display

How to set help icon

How to set color of non-scrolling region

How to specify default bitmap (BMP files) directory

Setting the default font

Glossary button customization option

Exit button customization

Help file compression option


How to set help title
Specify title displayed in the help window.


How to set copyright display
Specify copyright in version information displayed in in the help windows.


How to set help icon
Specify the Help window minimized icon.


How to set color of non-scrolling region
Background color of non-scrolling region is set by default to grey (Red 192, Green 192, Blue 192).  To change this color, specify the RGB number.

NOTE:

One project may only have one background color.


How to specify default bitmap (BMP files) directory
Specify the directory where BMP files included in the Help are located.

To clear the setting, choose the Clear button.

NOTES:

1. If BMP files are in the same directory as help file project files, it is not necessary to specifiy BMP directory.

2. If BMP files are pasted to the document, it is not necessary to specify this directory.

RECOMMENDATION:

If project is small with only few BMP files, it is recommended to keep all files in one directory.


Setting the default font
If font is not specified, Windows uses the System font to display help text.  Fonts setting is used to change this default font to some other font (e.g. Arial).

WARNINGS:

1. If the specified font is not included in users' system, it is replace with a most similar font.  This font may actually be very different from the specified font.  It is recommended to use only fonts included with Windows.

2. Selecting TrueType font slows down the help display on slow system.


Glossary button customization option
Append Glossary button to the help button bar.

This button is used to look-up common terminology.


Exit button customization
Append Exit button to the help button bar.

This button is used to exit help.


Help file compression option
Check this option to compile help file with compression (default).

Uncheck this option to compile help file without compression.

Usually, final help files are compressed to save disk space.  However, during development and testing, compilation will end faster without compression.


Help

Contents button option

Search button option

How to use Help

Win 3.1 SDK reference

About Helpfile


Contents button option
Display the table of contents


Search button option
Search for a help topic by keyword.


How to use Help
Open Help file on Help.


Win 3.1 SDK reference
Open online Windows 3.1 SDK RTF topics.

WARNING:

1. WIN31MH.HLP file (included in the SDK package) must be in the \SYSTEM directory or the directory of this file must be set in the DOS's PATH parameter.  If VC++ or BC++ is installed in your system, this file may be in the \HELP\BIN directory within each compiler's directory.

2. WIN31MH.HLP is a large file. If is recommended not to make multiple copies of this file.


About Helpfile
Display version and system resource information.


File Extensions

Following are files used by HelpCard and therir extensions:

SAR	HelpCard project file. Includes options and text information

HPJ	Help compilation option file (generatedby HelpCard)

RTF	Rich Text Format text file (generatedby HelpCard)

HH	Header file listing context text and IDs

ERR	Error log generated by the help compiler

PH	Phrase table file (generated by a help compiler during compression)

HLP	Generated help file

BAK	HelpCard project or VB source backup file

MPJ	Concatenation file work file

RF2	Concatenation modification text file

NOTES:

1. User only have to maintain help project file (file with SAR extension).  Other files are generated by HelpCard to create a help file.  To save hard disk space, these files may be deleted.

2. Bitmap image files (files with BMP, DIB, WMF, ICO, SHG, MRB extensions) should be saved in the same directory as the project file.

3. WMF files are converted to BMP files by HelpCard.

4. Icons are converted to BMP files when they are inserted into a card.


Books and Magazines

Helpcard is like a text editor that creates text files with topics. Unfortunately, this help does not cover all aspects of writing Windows' help files.  For further information, refer to the following magazines and books:

Windows 3.1 SDK Programming Tools (Chapter 3)

Windows 3.1 SDK Programming Reference Vol.4 Resource (Chapter15)

Visual Basic Professional Edition - Help compiler guide

Softbank    Hajimeteno Windows programming, Kita, Akira (Appendix)

Windows Magazine June 1993 P.136-138


Copyright and Distribution

HelpCard for Windows is copyrighted by Yasuhiro Umeki.  It has been translated from Japanese by Hitoshi Ozawa.  Readme.txt file and English version of the Help file are copyrighted by Hitoshi Ozawa.

No part of this program or data may be reproduced, in any form or by any means, without a written permission from Yasuhiro Umeki and Hitoshi Ozawa.

Distribution

HelpCard for Windows may be freely distributed if the following conditions are obeyed:

1. If it is to be copied to another forum or to another distribution channel, please contact the developer to let us know exactly where it is to be copied.  We will need this information to maintain and upgrade HelpCard for Windows at all locations.

2. This program can be distributed only in the original archived HLPCRD.LZH formatted file.  Do not change this file or any files within.

3. Please make it apparent that HelpCard for Windows is a FREE SOFT. It is necessary to state this in the program description.

4. If this program is to be mentioned in any article, please send an E-mail to one of the developers.

If it is going to be distributed in any other ways (e.g. CD-ROM), please contact the developer.  The developer is willing to discuss other means of distribution.  Please send a mail to one of the E-mail addresses in the support section below.

Yasuhiro Umeki	Nifty JBC03637

Hitoshi Ozawa	100220,3402


Funasada
Kintetsu MinamiOsaka line        (Fujiidera ballpark)

To Furuichi<-----||---[Fujiidera Station]------>To Abeno

(Nichii)     x         x  Station front

   Kounan store    Heartful91  shopping street

                 (McDonald)

                      (J&P) (Jasco)

  Broiled eel shop Funatei.

(Closed Tuesday, Open from 9:30AM-7:30PM)

If you're in the neighboorhood, come and buy my eels.


How to setup HC and Visual Basic
Most programming application includes a help compiler. In this situation, executing the HC command from the DOS executes the first HC compiler as set in a path.  To avoid trouble caused by using the wrong help compiler, it is possible to assign which compiler to use by:

 1. Select Option from the menu.

 2. Select Environment from the pull-down menu.

 3. Select HC.EXE directory from the cascade menu.

 4. Set the directory of the Help compiler to use.

Additionally, it is possible to execute Visual Basic (English ver 3.0 and Japanese ver 2.0) from Helpcard.  Directory of Visual Basic may likewise be defined by:

 1. Select Option from the menu.

 2. Select Environment from the pull-down menu.

 3. Select VB directory from the cascade menu.

 4. Set the directory of Visual Basic to use.


Choosing the right help compiler
It is necessary to obtain the most recent English version of English Help Compiler (HC 3.10.505 as of March 17, 1995) to create Help file that runs properly on English Windows.  Help files created using Japanese Help compiler (HC31.EXE) only "seems" to run on English Windows.   Context are not properly created and it is not possible to jump from an application to the assigned page nor is it possible to use the Search function.

Likewise, English Help compiler does not compile RTF text file with Japanese.

Please use the proper Help compiler to create a Help file that works on the environment that it is meant to be run on.


Liability

The author and the developer of this software will not take any responsibilities for any damages that may occur with the use of this software.  The files contained in HLPCRD.LZH are distributed "as is" and without any expressed and implied warranties.  The user assumes the entire risk of using the software.


Support

Support for HelpCard for Windows is provided by CompuServe E-mail. If you have any question, opinion, suggestions, or any other comments, please send an E-mail to:

Hitoshi Ozawa	CompuServe:	100220,3402