^9999 !Required Software 1000 !Memory Usage 1100 !How does it work 1200 !What does it cost 1250 !Creating HypeIt! Docs 1300 !Using a mouse with HypeIt! 1500 !Ordering HypeIt! 2400 !WindowPro & DialogPro 1800 !Future Enhancements 1900 !The HypeIt! library 1700 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ HypeIt! ³ |?³|3Copyright (c) 1989, Seabreeze Software,All rights reserved|?³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ |# |# Hypertext tools for the C programmer. |# Press |$F1|# now to learn how to use HypeIt!. |# ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ Topics ÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ ³ Required Software ³ Using a mouse with HypeIt! ³ ³ Memory Usage ³ Ordering HypeIt! ³ ³ How does it work ³ WindowPro & DialogPro ³ ³ What does it cost ³ Future Enhancements ³ ³ Creating HypeIt! Docs ³ The HypeIt! library ³ ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ # ^11000 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ Using HypeIt! ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ Use TAB key to move cursor, and Spacebar or ENTER key to select an option. Your options are: CONTINUE: Return back to screen prior to last F1. PREVIOUS: Return back to the previous screen. TOPICS: Review index of topics. KEYS: Review Keystrokes & their functions. Use TAB key to move cursor past the 4 buttons to select highlighted keywords and then press Spacebar/ENTER key to obtain further information on related topics. # ^12000 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ Using HypeIt! ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ Use TAB key to move cursor, and Spacebar or ENTER key to select an option. Your options are: CONTINUE: Return back to screen prior to last F1. PREVIOUS: Return back to the previous screen. TOPICS: Review index of topics. KEYS: Review Keystrokes & their functions. Use TAB key to move cursor past the 4 buttons to select highlighted keywords and then press Spacebar/ENTER key to obtain further information on related topics. # ^1000 !document file 1300 !index file 5100 !WindowPro and DialogPro 1800 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ Required Software ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ To create HypeIt! documents requires nothing more than the software you are using right now. To use your own HypeIt! documents type HypeIt at the dos prompt followed by the document name. HypeIt will assume an extension of .txt for your document file and .idx for your index file. To link HypeIt! into C applications you will need either Turbo C 2.X or Microsoft C 5.X. You'll also need both the WindowPro and DialogPro libraries. # ^1100 !WindowPro 1800 !DialogPro 1800 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ Memory Usage ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ The effect of including HypeIt! into an existing program depends on what routines are already required by your program. The estimated effect on program size is : WindowPro 50K DialogPro 50K HypeIt! 20K C startup code, miscellaneous functions 10K stream i/o functions 6K ------ Approximate minimum program size 136K # ^1250 !commercially 2300 !register 2400 !BBS 2000 !technical support 2100 !WindowPro & DialogPro 1800 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ What does it Cost? ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ You may use this program to create your own personal HypeIt! docs for no cost. You may also link the enclosed HypeIt! C libs into your personal C programs at no cost. If you want to use HypeIt! commercially you must register. Registered users receive source code, access to Seabreeze BBS, technical support, and notification of upgrades. Purchase WindowPro & DialogPro and receive HypeIt! at no cost. If you are a registered DialogPro source code user it will cost you $25 to register. # ^1200 !context sensitive help 3000 !DialogPro 1800 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ How does it Work? ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ Well, I can't reveal too much (or else why would you buy the source?) But I can say that it is very simple. Simple enough that making changes or enhancements won't be difficult. We simply create an index of the text nodes for fast disk access. Build a dialog box from the text node descriptor and maintain a stack of the text nodes displayed -- to backtrack through the hyperdoc. Are you clear on that point now? We also provide routines to make context sensitive help a snap for DialogPro users. # ^1500 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ Using a mouse with HypeIt! ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ To use a mouse with HypeIt! you must have a Microsoft compatible mouse driver installed before calling Hypeit!. Provided you have a mouse and a mouse driver installed, To perform an operation or go to a new text node you simply position the mouse cursor over any button or keyword and |""click"|'. Thats it! # ^1800 !Seabreeze Software 2400 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ WindowPro and DialogPro ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ WindowPro is a C windowing library. It is probably available from the same place that you got HypeIt!. You can obtain WindowPro from Seabreeze Software. It features mouse integration, virtual screens, and scrollbars. DialogPro is a C dialog box library. It lets you define SAA like dialog boxes, including pick lists, buttons, check boxes, radio buttons, and text fields. It is also probably available from the same place that you got HypeIt!. Likewise, you can obtain DialogPro from Seabreeze. # ^1300 !code a text node 5000 !index a file 5100 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ Creating HypeIt! Docs ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ Creating Hypeit! documents is pretty simple. First, a HypeIt! document consists of several small blurbs (or nodes) of text. Every text node has a unique number, the maximum number of text nodes in a document is 65280, and all text nodes must reside in a single file. Once you create this collection of text nodes (your document) you index it (using idxtext.exe) to allow HypeIt! fast access to the file. With that in mind your only things you really need to know are 1) how to code a text node, and 2) how to index a file. # ^5000 !more ... 5010 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ Making a text node (1) ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ Every text node has a unique number. The largest number a text node can have is 65535. The minimum number is 256. The first line of a text node provides the text node id. To start a text node with an id of 1000 enter this: ^1000 You must put the caret in the first column and a digit must be in the second column. Any non-numeric characters following this are ignored. more ... # ^5010 !add connectors 5020 !colors 5030 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ Making a text node (2) ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ The text consists of the lines following the text node id, prior to the text node terminator. The terminator is a single line with a #. This would be a valid text node: ^1000 This is a valid text node. # The text node must fit in 60 columns by 15 rows. With source you can modify the maximum size. This is OK but to make it better you need to add connectors and colors. # ^5020 ! valid 1010 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ Adding connectors ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ A connector begins with a ! followed by a keyword and on the next line an associated text node id. For example: ^1000 !valid 1010 This is a valid text node # When you press "valid" HypeIt! will display text node 1010. (Try it!) You can have up to 35 connectors/node. # ^5030 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ Adding colors ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ To change colors enter a \| followed by a color code. Obtain a list of the codes from colorlst.exe. The easiest way to enter a color code is to hold the alt key and type the numeric code on the tenkey pad and relase the alt key. example: \|"Green\|' with envy ==> |"Green|' with envy The color is in effect to the end of the line or the next color code. If you need to enter the \| character literally precede it with a \\ character like this \\\|. # ^1010 I really think you're starting to get the hang of this. Oh, and yes this is text node 1010. # ^5100 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ Indexing your document ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ You must index your document whenever you make a change. To index a document type |#idxtext|' at the dos prompt. When prompted for the "file to index?" enter your document's filename. When prompted for the output filename enter the name of your index file. # ^2000 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ Seabreeze BBS ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ We are changing locations. As soon as we are settled in we'll establish the BBS and publish the number. # ^2300 A commercial use of the HypeIt! executables is established by an outright sale, inclusion of this package with other software which is sold, sale of HypeIt! documents and resulting distribution of the HypeIt! executables, and use of the HypeIt! executables by for-profit entities for distribution of HypeIt! documents. A commercial use of the HypeIt! libraries is established by an outright sale, use of any part of the HypeIt! libraries in any program which is intended to be sold, use of any part of the HypeIt! libraries in programs which are used in any manner by for-profit entities. # ^2400 To become a registered user of HypeIt! send your name and address to, or call: Seabreeze Software 397 Dal-Rich Viallage, Suite 169 Richardson, TX 75080 (214) 437-2729 Send $25 if your are already a registered DialogPro user. Otherwise you simply need to purchase source code licenses for both WindowPro and DialogPro. # ^1900 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ Future Enhancements ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ You could do a lot of things without much effort. Some of the enhancements we are currently cosidering are: Data compression, combining the index & text files, Free searches through text nodes, Multi-Document support, and "long" text nodes (put scroll bars up when a text node exceeds the window size.) # ^3000 !register_help() 3100 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ Context Sensitive Help ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ HypeIt! establishes a global DialogPro macro which is "attached" to the F1 key. When you press F1 from within any DialogPro dialog box it will invoke a function, passing it a pointer to the active DialogPro structure. Using this pointer it will look up the designated text node entry point in the help_context table. Provided you registered the dialog box (using register_help()), it will find the appropriate text node, and display the HypeIt! window with the appropriate text. # ^2100 |?ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿ |?³ Technical Support ³ |?ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ Technical support is available by phone, Monday through Friday, 9 am to 5 pm, Central time, at (214) 437-2729. You can also reach Seabreeze Software on Compuserve, EasyPlex # 72330,705. # ^1700 You should have received the following files: hypeit.h The HypeIt! include files hypeitlt.lib The HypeIt! large model Turbo C lib hypeitlm.lib The HypeIt! large model Microsoft C lib hypeit.txt The HypeIt! user's guide hypeit.idx " colorlst.exe Prints the color codes used in HypeIt! docs idxtext.exe Indexes HypeIt! docs hypeit.exe Displays HypeIt! docs hypeit.c Demonstrates how to include the HypeIt! libs into your programs. # ^3100 !dispnode() 3110 int register_help(db, itype, id) void *db; /* lookup value */ char itype; /* offset handling */ unsigned id; /* text node base id */ The lookup value is generally the pointer to a DialogPro dialog_box or list_rec. Although you can use it in other ways. With this in mind itype can be FIXED, INDEXED, or IDXLIST. FIXED means that if you call help() with a value of db it will call dispnode() with a value of id. INDEXED is for dialog_box pointers only and will call dispnode() with a value of id + the current field offset. IDXLIST is for list_rec pointers only and will call dispnode() with a value of id + the currently selected list item. # ^3110 void dispnode(id) unsigned id; /* text node id */ displays the HypeIt! window with the text of the text node id. #