Copyright: Copyright © 1998 Xteq                              Wednesday, November 04, 1998 20:24:13


What is Xteq Helpy?

Xteq Helpy is a small Add-In that speeds up Help-Development within Microsoft Word dramatically.

Want to create a Jump (hotspot)?

Select the text and click Insert Jump!

Would like to have nice "Related Topics" buttons?

Use Insert Button!

Suck of editing the "#","$"... footnotes by hand?

Use Topic Information!

Need a shortcut from the helpfile to the internet?

Use Insert Jump to Internet-URL!

Would like to save time?
Save you document and compile your helpfile in one step with Show Help Workshop.

We also included a Step by step procedure, showing how easily you can create a jump from one topic to another. If you are not familiar with helpfiles, you should see these instructions also.

Of course Helpy works with your old (without Helpy created) RTF-Documents as well. Please see Attaching a RTF-File to Xteq HELPY for more Information.

 Related Topics


General Information about the use of Helpy
General Information about the use of Xteq Helpy

Using Helpy is very simple:

-	If you want to create a jump (Hotspot), select the text and click Insert Jump.

-	If you want to jump from your helpfile to the Internet or generate an e-mail, select the text and click Insert Jump to URL

-	If you want to insert a button or a picture, move the cursor to the desired position and select Insert Button  or Insert Picture

-	To change the settings of a topic (ID, Title...) move the cursor to this page and select Topic Information.

-	In any window Helpy displays to you, you can get help with the Button "Help" or use the [image] icon in the titlebar and select the control you want to know about.

-	Every function in this Helpfile is divided into three sections: 'Function', 'Technical Information' and 'Use of this function'.

Below 'Function' you will find some general information about the function. 'Technical Information' is a description of that, what Helpy does internally and is only interesting for Hardcore-RTF-Freaks. 'Use of this function' finally describes how you can use this function.

If you are not familiar with Helpfiles, you should see our Step by step Instructions about creating a Jump.

 Related Topics


About Xteq Helpy

Xteq Helpy for Microsoft Word 97

Copyright © 1998 by Xteq Systems

Helpy contains QSort Copyright © by AmoKKomA

Windows, Help Workshop, Windows NT, Word 97, Visual Basic, ActiveX, OLE, COM and VBScript are registered trademarks of the Microsoft Corp.

Xteq Helpy is Freeware. Please read the file LICENSE.TXT (which is included in the archive) for the disclaimer.

 Related Topics


About Microsoft Help Workshop

With this program you are able to create Windows's Helpfiles (*.HLP). It also provides a Tool for creating contents-files (*.CNT). Because Xteq Helpy cannot compile (that is, transforming the RTF file to the HLP file), you will need Microsoft Help Workshop also.

Important:

Microsoft Help Workshop version 4.01 and below can't read RTF files created with Word 97. You will have to upgrade to Help Workshop 4.03 or higher.

At the time of writing this, Help Workshop is available from Microsoft by using the URL ftp://ftp.microsoft.com/Softlib/MSLFILES/hcwsetup.EXE

Here's a sample HPJ-File (Help-Project), which is the bare minimum you need to compile a Helpfile. Note that in this example the RTF-File is named as HELP.RTF. You will have to set this to the correct filename.

For more Help about Help Workshop, please see the included Helpfile.

; This file is maintained by HCW. Do not modify this file directly.

[OPTIONS]

COMPRESS=12 Hall Zeck

LCID=0x409 0x0 0x0 ; Englisch (USA)

REPORT=Yes

CONTENTS=IDH_Default

TITLE=Help for XXX

COPYRIGHT=(C) by me. %date

HLP=help.hlp

[FILES]

help.rtf

[MAP]

IDH_Default=1000        ; This is the Topic-ID (Helpy -> Topic Information -> Name (Topic-ID)

[WINDOWS]

main="Help for X",(15,50,360,600),60672,(r14876671),(r12632256),f2

 Related Topics


Known Bugs/Limitations

-	With Helpy, you can't create a Jump that executes a user-defined Macro.

-	The function "Remove Jump" deletes non-jump text, if you select two jumps in one step.

-	The Entry macro ("!"-Footnote) is missing in "Topic Information"

-	Sometimes Word seems to "forget", that a document is attached to Helpy.DOT. If this happens, the menus and Icons of Helpy don't appear in you RTF-Document. To solve this problem, please see Attaching a RTF-Document to Xteq Helpy.

-	With Insert Picture you can only insert the pictures that comes with Microsoft Help Workshop. If you want to use your own pictures, you have to insert them yourself.

-	The "?"-help in all windows of Helpy sometime displays "This ID is....". This is a problem of Word because you can't set the path of the Helpfile you want to use with VBA-Code. And if Word don't want to display the help, we simply got no chance to correct this.

-	The included style "List" has the "Auto-Numbering"-feature disable because when you activate it, suddenly you complete Helpfile will be misinterpreted by Help Workshop. We don't know why, if someone knows a solution for that, please mail us.

-	Help Workshop 4.01 and below can't read RTF files created with Word 97 ("xxx.RTF is corrupted at offset XXX"). You will have to upgrade to Help Workshop 4.02 or above to fix this problem. See Help Workshop for further details.

 Related Topics


Contact Xteq

You may contact Xteq for any reason:

E-mail:	info@xteq.com

Internet:	http://www.xteq.com

The newest version of Xteq Helpy, other freeware-programs or support is available through our internet-site.

Xteq is always searching for new members. If you interested, please send us an E-mail.

 Related Topics


Attaching a RTF-File to HELPY
Attaching a RTF-File to Xteq HELPY

Especially if you would like to use the features of Helpy with old RTF-Documents, you have to attach the RTF-Document with Helpy. This will tell Word that the active document is based on the "HELPY.DOT" so the Helpy-Features can be used. Of course, documents created from "HELPY.DOT" are attached automatically.

To attach an existing RTF-Document to Helpy, do the following:

-	Select "Templates and Add-Ins" from the "Extra" menu in Word.

-	Press "Attach..." and select "HELPY.DOT".

-	Activate "Auto-Update".

-	Select "OK".

That's it. From now on, Xteq Helpy can be used with the active document.

 Related Topics


Tips & Tricks

-	A double-click on Topic-ID or Topic-Title in Topic-Information will copy the content of the control to the clipboard, so you can easily paste it into other applications. This is very useful if you need the Topic-ID for Microsoft Help Workshop.

-	You can easily set a jump for an inserted Picture (with Insert Picture) by selecting the text the function has generated and select Insert Jump.

-	You can always use the "Undo" function (Edit – Undo:) of Word 97 if you are not satisfied with the result of Helpy.

 Related Topics


General-Button Help


This will close this window and execute the default operation.


This will close this window without performing any changes to your document.


Displays the help for this window.


General-Button Help End!


Most common MsgBox-Error


'No text selected'-Error

You don't have selected any text before you used this function. Some functions of Helpy (like Insert Jump) require a selection before you can use them.

To correct this problem, select a word, a sentence, whatever and use the function again.


'Text selected'-Error

You have selected something before you started a function. Some functions of Helpy (like Insert Button) can't be run with an active selection.

To correct this problem, unmark your selection and use the desired function again.


'Nothing selected'-Error

You have tried to close a window without selecting anything. Without this information, the function doesn't know what you would like to do.

To correct this problem, select an entry from the list and click 'OK'.


End of common Errors


Insert Topic

Function:

Inserts a new Topic (a new Page) below the active Topic and shows the Topic Information for the new created Topic.

Technical Information

Helpy will insert a Page and one linefeed.

Use of this function

Please see Topic Information.

 Related Topics


Insert Jump

Function:

Inserts a jump to a topic, a K-Keyword or an A-Keyword. Sometimes a jump is also known as 'Hotspot'.

Technical Information

Helpy will insert a jump to a topic, K- or A-Keyword by using double-underlined text and formatting the destination as hidden text. Beside this, Helpy will change the language of the text to '(No Check)'.

Use of this function

Mark in your document text, where you want to have a jump and select "Insert Jump" from the Helpy menu.

Select a destination where you want to move to: Topic, A-Keyword(s) or K-Keyword(s).

Please see the examples for detailed instruction how to create a jump.

To see some examples, please click 'Related Topics'.

 Related Topics


?-help for Insert Jump! (some are used by InsertButton also)


If activated, all available topics will be displayed. You can choose only one topic as destination.


If activated, all available K-Keywords will be displayed. You can choose as many K-Keywords as you want to as destination.


If activated, all available A-Keywords will be displayed. You can choose as many A-Keywords as you want to as destination.


Displays all Topics, K- or A-Keywords. Highlight one or more items to select the destination of the jump.


If the destination should be displayed in a special window, insert the name of this window here.

If you don't want a special window, leave it blank or enter (default). Please note that the window-name has to be set in your HPJ-file!


If activated, the destination will be displayed in the default window (Standard).


If activated, the destination will be displayed as secondary window while the old window is still opened.


If activated, the hotspot will be displayed in the default color with underline.

Example: Click me.


If activated, the hotspot will be displayed in text-color.

Example: Click me.


If activated, the hotspot will be displayed in text-color and without an underline.

Example: Click me.


End of ?-help for Insert Jump/Insert Button


Insert Jump - Examples
Insert Jump – Examples

Topic jump

The simplest jump is a jump from a word to a topic:

Go to "Scrip-Info" for more Information.

If your Topic "Scrip-Info" would have the Topic-ID "InfoScrip", you would first select the word "Scrip-Info" in the above text, click "Insert Jump" from the Helpy-Menu, select the Topic "InfoScrip" and click "OK". Helpy would produce something like that:

Go to "Scrip-InfoInfoScrip" for more Information.

In the Helpfile, the user would see the following:

Go to "Scrip-Info" for more Information.

You can set different options also. This is the same jump as before, but the hotspot ("Scrip-Info") is displayed as normal text.

Go to "Scrip-Info" for more Information.

A- or K-Keywords jumps

These jumps are more complicated than the one above. You specify one (or more) A-/K-Keywords to display a list of topics.

If you got this text:

Click here to see some tests.

and would like to display a list of Topics, that contain "test" in their A-Keywords, do the following: Select the word "here", click "Insert Jump" from the Helpy-Menu, click "A-Keywords", select the Keyword "test" and then "OK".

Helpy would produce something like that:

Click here!ALink("test",Jump,,) to see some tests.

The user would see this in the Helpfile:

Click here to see some tests.

It doesn't matter if you use A- or K-Keywords for a jump, the only difference between these two is, that A-Keywords are not accessible to the User, K-Keywords are accessible with the Tab "Index".

Notice: The macro that Helpy creates for A- or K-Keywords will automatically move to a topic if only one topic with the specified keyword(s) is found!

 Related Topics


Creating a Jump: Step by step Instructions

The starting point: We have create two new Pages (in Helpfiles they are called Topics) "What is Zoomer" and "Zoomer Notes". What we want to do is, that the user can jump (move) from the Topic "What is Zoomer" to "Zoomer Notes".

First, we will give the second topic, "Zoomer Notes", an ID so we can use it in Helpy. Move to the Page "Zoomer Notes" and click Topic Information from the Helpy menu.

Now we have to insert the Topic-ID. We insert "ZoomerNotes" as Topic-ID and "Some notes about Zoomer" as title. Click "OK" to close the window.

Now we can create the jump from the first topic to "Zoomer Notes". We move back to "What is Zoomer" and select the word "Notes". Now select Insert Jump.

The Insert Jump-Dialog will appear. Because we just give the topic below the ID "ZoomerNotes", we select this Topic-ID in the list. Press "OK" and Helpy will create the Jump for you.

That's all there is to do! Now start Help Workshop, compile your HPJ-File and see the result:

Because the word "Notes" is green, the User can click it. As soon, as he clicks "Notes" the topic "Zoomer Notes" will appear:

If you need additional information about Helpfiles, please see the online-documentation of Help Workshop.

 Related Topics


Insert Button

Function:

Inserts a Button that displays a list of topics to the user (based on A- or K-Keywords).

Technical Information

Helpy will insert the {button}-command and (if 'Text beside' is set) also a Jump in your text.

Use of this function

Set 'Text on the Button' to the text that should appear directly on the button. If this field is empty, a standard 4X4-pixel button will be created.

Set 'Text beside the Button' to the text that should appear beside the button. If the User clicks this text, it will perform the same, as he would click the button.

If you want a border above the button, check 'Insert Border'. This option is very useful if you want to create a 'Related Topics'-button.

To see some examples, click Related Topics.

 Related Topics


Enter the text that should appear directly on the button.


Enter the text that should appear beside the button.


If activated, a border will be inserted above the button. Activate this option, if you want to create a 'Related Topics' button.


Insert Button - Examples
Insert Button – Examples

Text only on the button:

Text only beside the Button:

 Text beside

Both:

 Text beside Button

'Related Topics'-Style:

 Related Topics


Insert Picture

Function:

Inserts a command in your document that displays a picture in the Helpfile.

Technical Information

Helpy will insert the '{bmXt}' command in your document.

Use of this function

Select the picture you would like to see in your Helpfile and press OK.

Note: Currently you can only insert pictures that comes with Microsoft Help Workshop.

Click Related Topics to see some examples.

 Related Topics


Displays all pictures you can insert. If you have selected a picture, you can see a preview.


If activated, the picture will appear just where you have inserted it.

Example:

This is a [image] short text.


If activated, the picture will be aligning along the left margin.

Example:

 This is a short text.


If activated, the picture will be aligning along the right margin.

Example:

This is a short text.


Displays a preview of the selected picture.


Insert Picture - Examples
Insert Picture – Examples

Here's a list of all pictures you can insert using Helpy:

Bullet

Dash

One Step

Arrow

Do it

Shortcut

Document

Opened Book

Closed Book

Chiclet

Help

Some examples for the use of 'Display Options':

Display picture in the Text:

This is an [image] example.

Align the picture along left margin:

This is an example.

Align the picture along right margin:

This is an example.

 Related Topics


Topic Information
Topic-Information

Function

Changes the settings for the currently active topic (page). This includes the Topic-ID, Topic-Title, K-Keywords and A-Keywords. The number of the topic is for your information only and can't be edited.

If you want to use A- or K-Keywords with Insert Jump or Insert Button you have to set them with this function first.

Technical Information

This function will change the "#", "$", "A" and "K" footnotes of the active page. If any other footnote exists, they will be ignored by Helpy.

Use of this function

Enter a unique Topic-ID so the Topic can be used in WinHelp.

Topic-Title, A- or K-Keywords are optional, but you should include a Topic-Title because this title is used by WinHelp also (for example if the user sets a bookmark) and it's confusing if WinHelp only displays "(Unnamed #1)".

K-Keywords are displayed in the Tab "Index" within WinHelp and can be used for a Jump (for example with the function Insert Jump).

A-Keywords are basically K-Keywords with the difference that they are invisible to the user.

 Related Topics


Help for Topics-Information (using "?")


Enter a unique Topic-ID.


Enter a Topic-Title (don't have to be unique). This title will be displayed to the user if he creates a bookmark or if he searches for K-Keywords.


Displays the Topic-number. This is for your information only and can't be edited.


Click here to insert a new keyword.


Select an item from the list and click here to rename a keyword.


Select an item from the list and click here to remove the keyword.


Displays all K-Keywords for this topic.


Displays all A-Keywords for this topic.


End of ?-help


Remove Jump

Function

This function will remove the jump that is included in the current selection.

Technical Information

Remove jump will delete any hidden text and remove the underline-style from the active selection.

Use of this function

Mark the text around a jump and select "Remove Jump" from the Helpy menu. If you are not satisfied with the result just use "Undo" ("Edit" - "Undo:") of Word.

It doesn't matter if you include text that doesn't belong to the jump you want to remove. Helpy will ignore the other text and just remove the jump. That way, just selected text somewhere around the jump and use the function, instead of trying to "catch" the jump exactly. This will save you a lot of time.

 Related Topics


Go to Topic

Function

Moves the cursor to the given topic.

Technical Information

Because a Topic-number is not equal to the page-number, this function was included.

Use of this function

For example, if Help Workshop is telling you the following:

HC3025: Warning: topic #6 of G:\Deve\VB\Office\Word\Helpy\help\Helpy.rtf :

Jump to undefined Topic ID: "RemoveJump".

You now truly want to see the Topic #6. And that's what's 'Go to Topic' is good for: In this example you would just enter '6' and Helpy will show you this topic directly.


Show Help Workshop

Function

Saves the current document, tries to activate Microsoft Help Workshop and starts compiling.

Technical Information

If Helpy can find a window with the title "Microsoft Help Workshop", this will be activated and the following Keys are send to start compiling: "ALT+F","ALT+M", and "ALT+C".

Use of this function

Quit simple: Just click "Show Help Workshop" from the Helpy Menu.

If Helpy is telling you that it can't find Help Workshop, make sure you that the program is running before using "Show Help Workshop".

 Related Topics


Insert Jump to URL

Function

Inserts a jump from the helpfile to the Internet by opening an URL in the user's default browser. Can also be used to generate an e-mail.

Technical Information

Helpy will insert the ExecFile() macro to create the hyperlink.

Use of this function

Simply select the word you want to appear as an jump to and select 'Insert Jump to URL' from the Helpy menu.

-	To jump to an URL, select 'open the following URL' and type in the URL (e.g. 'http://www.xteq.com')

-	To generate an e-mail, select 'generate an e-mail to' and type in the e-mail-address (e.g. 'info@xteq.com')

Click Related Topics to see some examples.

 Related Topics


Insert Jump to URL - Example
Insert Jump to URL - Examples

Example by using 'open the following URL'

http://www.xteq.com

Same example, but with the 'Display hyperlink in default text color' option set

http://www.xteq.com

Example by using 'generate an e-mail to'

TeXHeX@xteq.com

Same example, but with the 'Display hyperlink in default text color' option set

TeXHeX@xteq.com

 Related Topics


Help for the "?" button


Activate this option, if you want to display an URL using the user's default browser. Type in the URL in the field below.

Example: http://www.xteq.com


Activate this option, if you want to generate an e-mail. Type in the e-mail-address in the field below.

Example: TeXHeX@xteq.com


Type in the URL or the e-mail-address here.


End of "?" help


Description of Helpy Menu

The menu of Xteq Helpy will appear just left from the '?' (Help) menu in your Word.

Menu title	Description
Insert Topic	Inserts a new Topic and displays Topic Information. after that
Insert Jump	This will create a hotspot for the currently selected text.
Insert Jump to URL	Creates a jump to an Internet-URL or generates an e-mail.
Insert Button	Creates a button for moving to A- or K-Keywords.
Insert Picture	Inserts a picture in your Helpfile.
------------------------------
Topic Information	Shows the Information about the active Topic.
------------------------------
Remove Jump	This will remove all jumps within the current selection.
Go to Topic	Shows a specified Topic.
Show Help Workshop	Saves the active Document and activates Microsoft Help Workshop.
------------------------------
Help	Displays this Helpfile.
About Xteq Helpy	Some Information about Helpy.


Topic 1

This is Test #1.


Topic 2

This is Test #2.


Topic 3

This is Test #3.


Test-Page Zoomer
What is Zoomer

Zoomer is a small program, that when launched opens a small window where it displays the area around the cursor magnified 2 or 4 times.

The Zoomer window can be moved, resized or set to occupy the top 1/8th of the screen, as a system toolbar. It also supports two different refresh rates.

Zoomer was first developed for visually impaired people, but I have received feedback from graphic artists, web page designers and user interface designers that they also find it a great help with their work.

You should see the Notes also.

Zoomer © 1996-1997 by Dr. Schadt Gyorgy


Some notes about Zoomer
Zoomer Notes

-	Zoomer currently does not handle changes in screen resolution. You will have to restart it if you change the resolution.

-	When using Zoomer with custom pointers (like those fancy 3D pointers that come with the Plus! package), the cursor blinks at each update. This is not particularly disturbing unless the program is in the 'Update Allways' mode. I believe that this problem arises from the way Windows handles multi-color cursors, so the only thing I can recommend is to change back to the normal system cursor.