Help file making detailed document (manufacturing tool winhelp)

Help file making detailed documentation

Production Tools: MS-Word and Help Workshop

Compile to help files (.hlp)

With Isual BSi

Create a help topic file (.cnt)

Production help engineering document (.hpj)

Edit RTF text file

Production process:

Specific steps:

One. Edit .rtf

Implementation in Word

Enter text

Page

Set format

save document

Basic process

:

Ø Show all non-print characters

[Tool] Menu tab Select "All" check box (in the "Non-Print Character" block)

Ø Set to standard mode

[View] Menu "Ordinary" command

Ø Create a non-scrolling area

Move the cursor to the title text paragraph [Format] menu tab

Check "The same page with the lower" checkbox

After completing, find more small points on the left side of the title text.

Ø Set the jump text (JUMP POINT)

Example: Press my i2

A. Set jump text

Will "help the title" anti-white selection ("press me") plus double downline or delete line

B. Article related strings

Press this paragraph string to select ("I2") Press the "Font" command.

Select the "Hide" check box in the "Effect" column [OK]

C. Add to foot

Anti-white selection ("I2") [Insert] menu "footnotes", "Footnotes", "Custom Tag", "Symbol" selection "#"

[determine]

Ø Page

Implementation: Ctrol Enter

Or [Insert] menu "Separator" command is selected "Paging"

After completing, a dashed line is generated between the page and the page

Ø Popup Point)

Implementation method: Plus the string in the white selection of the order

The rest of "Jumping Text"

Ø Create a keyword

Let users query help with index

Move the cursor to the beginning of the help page Insert Footnot "K" Enter the name of the keyword after the footnoter "k" control code (ie the name appears in the Index "dialog)

Note: Create multi-keywords, in the middle;

Ø put into graphics

A. Direct insertion

B. Syntax insertion

Syntax: {parameter file name}

parameter

Function description

BMC

Demose graphic as characters

BMC

Put the graphic left display

BMR

Put the graph to right

Example: {BMC Test.bmp}

Note: The graphic format must be BMP or WMF; all graphics files are stored in the same directory with the RTF file

two. Production theme help file (directory .cnt)

Implemented in Help Workshop

A. Start Help Workshop

[Files] add "contents" "OK" Press the "Add Above" button to click "Heading" Enter the top top of the topic "OK" in "Title"

B. Create topics

Click "Add Blow" to click "Topic" item in "Title" into the title name "article associated string" "OK" in "Topic" in "Topic"

three. Making help engineering documents

Implementation in Help Workshop Ø Creation Project

[File] "New" "Help Project" project Enter your project name "Save"

Ø Customized master form

Press the "Windows" button to open the "Window Porperities" form

A.

Tab Click "Add" to enter "Main" "OK"

B.

Click the "Auto-Sizer" button to adjust the window size and click "OK"

Other Maintain Default Settings Click "OK"

Ø Join the RTF file

"Option" button tab "Change" button Select the RTF file you edited

Ø Add to CNT file

Click the "Browse" button next to "Contents File" to select the CNT file you edited

Ø Other settings

tab Enter the default article associated string and help file name

Select "Maxiam"

four. Compile to help files (.hlp)

Click Save and Compile Save

Fives. Combine with Visual Basic

Add a CommMondialog in the main form, add the following code to the click () event of the Help button:

CommonDialog1.helpfile = "Your Help File Name"

Commondialog1.helpCommand = CDLHELPCONTENTS

CommonDialog1.showhelp 'Displays the Visual Basic Help Directory topic.

At this end!