Category : Recently Uploaded Files
Archive   : WHIZN213.ZIP
Filename : SAMPLHLP.WZ_

X#

ðÿ

Times New Roman·”<´§¾9W
` 

Sample help generation demonstrationSample Help GenerationCopyright © 1992-1994, Sanjay Kanade
DEMO;Sample help generation demonstrationª
)
nn
Read me firstered versiong sequencesC:\WHIZ\TEST2.TXTContentsþ

€€ååÿ‚[~BOLD Read this topic first:]
[~JUMP Read me first]

[~BOLD Sample topics:]
[~JUMP Example of bold and italic text]
[~JUMP Example of indentations]
[~JUMP WhizNotes list statements]
[~JUMP Examples of conditional help generation]
[~JUMP Topic name 1]
[~JUMP Topic name 2]
[~JUMP Example of running an external program by a help macro]

[~BOLD Example of jump to another help file:]
[~JUMP Get the registered version]

Since we created this "Contents" topic, it will become the contents of the generated help. If such a topic is not present then WhizNotes will create a "Contents" for you; but the topic names will be inserted in the order that they appear in the List Of Topics. By making our own contents we get the flexibility to format it the way we want it.

If you want to see the default contents created by WhizNotes just delete this topic and then create help.

Read me firstþ

\X
!
ÿ^HERE IS A DEMO OF HELP GENERATION.

This sample WZN file demonstrates the use of WhizNotes statements. These statements are used to better format your help text.


HOW TO USE THIS SAMPLE FILE:

First of all, you should be prepared to look at the online help for finding out more details about a feature that is briefly described in this file. At various places, you'll be asked to look at a certain help topic or "search help for..." a particular keyword. To do that, simply select menu "Help-Search help for...". You'll see a list of keywords where you can type the topic name or keyword you are looking for and then go to the relevant help topic.

If you think you have a help compiler then you should quickly try to create help by selecting menu "Tools-Create help...". Just press OK on the Help Generation dialog that comes up. If WhizNotes can not invoke the help compiler, it will give a suitable error message. For more details on setting up your help compilation environment, please look at the help topic "Setting up the Help Compilation environment" or search help for keyword "Help compiler".

After you have witnessed the help generation operations, you can look at other topics in this WZN file to see how they use the WhizNotes statements and how the formatted text comes out in the generated help file. Look at the details of these statements in the online help, do your own experimentation by adding some text using these statements and you'll understand them better.


A NOTE ON PARAGRAPHS:

You must understand that in order to create effective help you must have the word wrap feature checked-on (which is the default) on the Edit menu. Do not press returns in the middle of your paragraphs. Let them wrap around the boundaries of the window.


AN EXERCISE FOR YOU:

This topic was purposely left unformatted. After understanding WhizNotes statements in the rest of the topics, try the following steps to change the generated help for this file:

Make the subtitles in this topic bold. They are currently all CAPS.

Convert the discussion "How to use this sample file" above into a bulleted list.
Example of bold and italic textþ

€€

ÿ—[~BOLD You can have a whole paragraph stand out as bold if you want. For example, take a look at this one.]

Or, you can insert [~BOLD bold text] anywhere in your documentation.

Italics work in a similar fashion.

[~ITALIC You can have a whole paragraph stand out as italic if you want. For example, take a look at this one.]

Or, you can insert [~italic italic] and [~bold bold] text anywhere in your documentation.

WhizNotes statement like ~BOLD ... are case insensitive as you can see by the last example.

For details, look at the help topic "Making your text bold or italic".


SAVE KEYSTROKES TO ENTER ABOVE STATEMENTS:

Using a special Recorder file WHIZNOTE.REC, you can enter the above statements quickly by simply selecting the text and pressing CTRL-B and CTRL-I for entering BOLD and ITALIC statements respectively. For details, look at the help topic "Making your text bold or italic".
Example of indentationsþ

€€[[ÿCYou can indent all the following text one step by using the ~INDENT statements.

For example, the following two paragraphs are indented one step:


[~INDENT+]
This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph.

This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph.

Next paragraph is indented one step further.

[~INDENT+]
This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph.

Now we go back one step.

[~INDENT-]
This paragraph is at the same indentation level as the first two.

If you want to reset indent to the default value, which is no indent, at any time, then just use a 0 (zero) instead of + or -.

[~INDENT0]
So we are back to the original indentation level.

Please note that an indent statement has to be on a separate line by itself. It can not be embedded.

For details, look at the help topic "Indentation in generated help".

If you want to use indentation for creating bulleted lists then do not use this statement. It is easier for you to manage bulleted lists and lists within lists by [~JUMP WhizNotes list statements].
WhizNotes list statementsþ

€€||ÿ¥WhizNotes list statements are very convenient. To start a bulleted list, all you do is specify ~STARTLIST on a separate line by itself.

Then before each item use ~ITEM statement. Note that your items can be as large as you want. Even one or more paragraphs.

Finally when you want to end the list, use the statement ~ENDLIST.

Here is an example of a bulleted list:

[~STARTLIST]
[~ITEM]
This is the first item. This is the first item. This is the first item. This is the first item. This is the first item. This is the first item. This is the first item. This is the first item. This is the first item.

This is the first item. This is the first item. This is the first item. This is the first item. This is the first item. This is the first item. This is the first item.

[~ITEM]
This is the second item.

[~ITEM]
This is a numeric list within a list.
[~STARTLIST numeric]
[~ITEM]
Inner list item 1.
[~ITEM]
Inner list item 2.
[~ENDLIST]

[~ITEM]
Last item of the original list.
[~ENDLIST]

For details, look at the help topic "Making bulleted and numeric lists".


SAVE KEYSTROKES TO ENTER ABOVE STATEMENTS:

Using a special Recorder file WHIZNOTE.REC, you can enter the above statements quickly by simply selecting the text and pressing CTRL-L, CTRL-M and CTRL-E for entering STARTLIST, ITEM and ENDLIST statements respectively. For details, look at the help topic "Making bulleted and numeric lists".
'Examples of conditional help generationþ

€€ëëÿX[~IfNotTag DEMO]
This paragraph will appear in the generated help only if you remove the tag "Demo" from the help generation dialog box.
[~endif]

[~IfTag Demo]
This paragraph will appear only if tag "demo" is present.
[~else]
This one will appear only if tag "demo" is not present.
[~endif]

This line is not enclosed in any of the above statements so it is not affected by tags.

Here is an example of embedded tag statement: This is a [~iftag demo]demo[~else]professional[~endif] version.

For details, see help topic "Conditional help generation" or search help for keyword "Tag".
Topic name 1þ

€€êêÿDThis is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence.

Please also see [~JUMP Topic name 2]. <- This jump statement was created by dragging "Topic name 2" from the "list of topics" on to this topic. You could have typed it in instead of dragging.

What follows is an example of a reference statement. Please see [~REF A referenced topic]. <- this popup behaviour appears when you choose to insert a reference instead of a Jump.
Topic name 2þ

€€ÿThis is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence.

This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence.
A referenced topicþ

€€jjÿpThe text here will be presented in a popup window when referenced from Topic name 1.

[~REF Topic name 1]

6Example of running an external program by a help macroþ

€€ ÿâ
Here we insert a simple help macro to start the Windows clock program. The macro is inserted by a helpmacro statement like this: [~helpmacro {visibleText = "A clock program", macro = "ExecProgram(`clock.exe',0)"}].

Compile this help file and you will see that only the visibleText "A clock program" will be displayed in the help. When you click on it, the ExecProgram macro will be executed. Helpmacros are very powerful, learn about them by looking at your Windows SDK help.
Get the registered versionþ

€€
ÿd
Examples of more advanced help features are available in the sample file provided with the registered version. So, please register as soon as possible to get help on the more advanced features.

For information on how to register, see [~JUMPTOCONTEXT {visibleText = "How to register", helpFile = "WHIZNOTS.HLP", contextString = "IDH_HOW_TO_REGISTER"}].
E~~ -------------------------Special topics to control help generationþ

€€ÿ
Such a topic name that begins with "~~" is a 'separator' topic. It is a dummy comment topic that simply allows you to divide your topic list into separate visual sections without affecting the help generation in any way. For more details, search for keyword "Separator" in WhizNotes help.

In this case, we used it just before the group of special help attribute topics to identify this group.
&~HelpAttributes for browsing sequencesþ
€€ ÿ=// These comments are inserted for your convenience. Please
// see Online Help for more details on these options.
//
// Comments always begin with double slashes and are not
// processed by WhizNotes. When inserting the actual statements
// do not use double slashes.

//WhizNotes recognizes this topic as being special because it begins with the word
//"~HelpAttributes". When you create this topic then WhizNotes inserts comments
//at the top to help you. I have deleted them so as not to confuse you.

//This type of topic can not contain your help text. It can only contain certain
//special statements to control WhizNotes help generation. They are:
// ListBrowseGroup - To define a browse group
// HelpTopic - To define special attributes of topics
//

// Although ListBrowseGroup and HelpTopic statements can be interspersed, we have chosen
// to have two separate ~HelpAttributes topics for convenience. This one defines two
// browsing groups, the other one defines helptopic statements.

// In the generated help you will be able to use '<<' and '>>' browse buttons to move
// through these three topics in sequence. A browsing sequence groups one or more
// related topics in a group to guide the user through them in a proper sequence.
//
// The actual topic names were inserted by selecting all of them and dropping them on
// this topic.
ListBrowseGroup {
"Example of bold and italic text",
"Example of indentations",
"WhizNotes list statements"
}

// Another browsing group.
ListBrowseGroup {
"Topic name 1",
"Topic name 2"
}

// Note that a topic name can not be present in two browse groups.

// You should only make browse groups from related topics that really go together when
// describing a feature.
// Don't put your independent topics in any browse group.
~HelpAttributes for topicsþ
€€}}
ÿA// I assume that you have looked at the previous topic
// "~HelpAttriubutes for browsing sequences". I am not repeating the
// introductory discussion here.

// We shall see examples of HelpTopic statements here that allow you to
// specify various attributes for topics. Note that I may not describe all the
// attributes here. Please look at online help for more details.

// The following topic will have a non-scrolling title. A keyword will not be
// generated for the topic name as it does not make sense to do that. Instead
// another keyword "Introduction" is defined that will appear in the search
// list. Just to show you how more keywords can be defined, I have included
// another keyword after a semicolon.
HelpTopic "Read me first" { UseNonScrollingTitle = "YES",
TopicNameIsNotAKeyword = "YES",
Keywords = "Introduction;Another keyword for readme topic"}

// Now let us look at an example of continuation of a quoted value.
// Notable points: For your convenience, WhizNotes allows you to
// split a long value on multiple lines provided you enclose each of the
// pieces in quotes. You can also embed a double-quote provided you
// repeat it.
HelpTopic "WhizNotes list statements" {
Keywords = "list;bulleted lists"
";how to specify numeric lists"
";Example of a single "" embedded quote"
}