diff options
Diffstat (limited to 'freebsdtvision/tvhc/README')
| -rw-r--r-- | freebsdtvision/tvhc/README | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/freebsdtvision/tvhc/README b/freebsdtvision/tvhc/README new file mode 100644 index 0000000..e09906f --- /dev/null +++ b/freebsdtvision/tvhc/README @@ -0,0 +1,83 @@ + +Help compiler documentation +--------------------------- + +Here is some minimal documentation about the help compiler. This program +can handle both dos and unix files, you don't need to translate them. + +File `DEMOHELP.TXT' was used by Borland to generate the binary help file +`DEMOHELP.H32' that you should find in the `demo' subdirectory. Note: if you +compile the source help yourself and compare the result with `DEMOHELP.H32' +you'll get a different file, even if the sources seem identical. + +/*===== TVHC ============================================================*/ +/* Turbo Vision help file compiler documentation. */ +/*=======================================================================*/ +/* */ +/* Refer to DEMOHELP.TXT for an example of a help source file. */ +/* */ +/* This program takes a help script and produces a help file (.HLP) */ +/* and a help context file (.H). The format for the help file is */ +/* very simple. Each context is given a symbolic name (i.e FileOpen) */ +/* which is then put in the context file (i.e. hcFileOpen). The text */ +/* following the topic line is put into the help file. Since the */ +/* help file can be resized, some of the text will need to be wrapped */ +/* to fit into the window. If a line of text is flush left with */ +/* no preceeding white space, the line will be wrapped. All adjacent */ +/* wrappable lines are wrapped as a paragraph. If a line begins with */ +/* a space it will not be wrapped. For example, the following is a */ +/* help topic for a File|Open menu item. */ +/* */ +/* |.topic FileOpen */ +/* | File|Open */ +/* | --------- */ +/* |This menu item will bring up a dialog... */ +/* */ +/* The "File|Open" will not be wrapped with the "----" line since */ +/* they both begin with a space, but the "This menu..." line will */ +/* be wrapped. */ +/* The syntax for a ".topic" line is: */ +/* */ +/* .topic symbol[=number][, symbol[=number][...]] */ +/* */ +/* Note a topic can have multiple symbols that define it so that one */ +/* topic can be used by multiple contexts. The number is optional */ +/* and will be the value of the hcXXX context in the context file */ +/* Once a number is assigned all following topic symbols will be */ +/* assigned numbers in sequence. For example, */ +/* */ +/* .topic FileOpen=3, OpenFile, FFileOpen */ +/* */ +/* will produce the follwing help context number definitions, */ +/* */ +/* hcFileOpen = 3; */ +/* hcOpenFile = 4; */ +/* hcFFileOpen = 5; */ +/* */ +/* Cross references can be imbedded in the text of a help topic which */ +/* allows the user to quickly access related topics. The format for */ +/* a cross reference is as follows, */ +/* */ +/* {text[:alias]} */ +/* */ +/* The text in the brackets is highlighted by the help viewer. This */ +/* text can be selected by the user and will take the user to the */ +/* topic by the name of the text. Sometimes the text will not be */ +/* the same as a topic symbol. In this case you can use the optional */ +/* alias syntax. The symbol you wish to use is placed after the text */ +/* after a ':'. The following is a paragraph of text using cross */ +/* references, */ +/* */ +/* |The {file open dialog:FileOpen} allows you specify which */ +/* |file you wish to view. If it also allow you to navigate */ +/* |directories. To change to a given directory use the */ +/* |{change directory dialog:ChDir}. */ +/* */ +/* The user can tab or use the mouse to select more information about */ +/* the "file open dialog" or the "change directory dialog". The help */ +/* compiler handles forward references so a topic need not be defined */ +/* before it is referenced. If a topic is referenced but not */ +/* defined, the compiler will give a warning but will still create a */ +/* useable help file. If the undefined reference is used, a message */ +/* ("No help available...") will appear in the help window. */ +/*=======================================================================*/ |