home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR9 / HLPDK80.ZIP / HLPDK.HDT < prev    next >
Text File  |  1993-08-01  |  33KB  |  878 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════════════╗
  3.  ║                                                                          ║
  4.  ║                                 ISoft D&M                                ║
  5.  ║                                 POB. 5517                                ║
  6.  ║                           Coralville IA 52241                            ║
  7.  ║                                   U.S.A                                  ║
  8.  ║                                                                          ║
  9.  ╚══════════════════════════════════════════════════════════════════════════╝ 
  10.  
  11. The Help Engine Development Kit is a system that allows you to create 
  12. hyper-text database help systems with topics and hot links, using a simple
  13. text editor and the help compiler. 
  14.  
  15. The help databases can be distributed (free of charge) with the HELPENG or
  16. HE help engine display programs. 
  17.  
  18. The help database format is release to the public domain, if you own the 
  19. Paradox Engine you can use the help databases with your own programs. 
  20.  
  21. Borland Pascal Users can purchase the Help Engine Source Code even
  22. for Applications that do not use the paradox engine, using the Native Mem
  23. format.
  24.  
  25. The helpC compiler that is part of this development kit includes the
  26. ability to create Windows Help source files from the same source the 
  27. dos help sources are created!. Write your help once, and create help
  28. databases for Dos, Windows, OS/2 and DESQview/X !
  29.  
  30.         Supported Formats :
  31.  
  32.         Native(PX), Native (Mem), Win30, Win31, QuickHelp, 
  33.         THELP, TVHC, POPHELP, DESQview/X, OS/2, Text, Word Processors (RTF)
  34.  
  35. From the same source you created your hypertext database, you can create
  36. a text document with automatic table of contents and index sections!
  37.  
  38. Using the RTF target you can prepare your proffesional documentation
  39. by generating word processors documents, all from the same source!
  40.  
  41. Contact ISoft D&M if you want to purchase the WINTEXT UI library for 
  42. Turbo Pascal programs, and use the help engine window in your pascal
  43. programs.
  44.  
  45. Related Topics :
  46. Registration
  47. Contact
  48. File List
  49. Credits
  50. Help Engine
  51. Help Compiler
  52. Quick Start
  53.  
  54.  
  55. The Help Engine Development Kit (HLPDK) is a shareware product, 
  56. if you find this product valuable, please register it. 
  57. This section describes the reasons you should register.
  58.  
  59. By registering you will receive a complete discussion
  60. of the help engine features, and many examples of usage. You will receive a 
  61. diskette with the latest HLPDK version, and DPMI (dos protected mode)
  62. versions of the help compiler and engines!.(The memory version of the
  63. help engine can display huge databases only in the protected mode
  64. version).
  65.  
  66. Your registration will help us to create the next versions of HLPDK, that
  67. will include more options, and features, some of them might even be your
  68. enhancement requests!.
  69.  
  70. A point to consider - If you want to create Windows Help source files,
  71. you will have to purchase a word processor that can output RTF files,
  72. the WORD for Windows 2.0 package, for example, is listed at around $500!.
  73.  
  74. Related Topics :
  75. Contact
  76. Overview
  77.  
  78.   Please contact :
  79.  
  80.   ISoft D&M,  
  81.   P.O.B 5517
  82.   Coralville IA 52241,
  83.   U.S.A
  84.  
  85.   ISoft D&M e-mail address : CompuServe - 76350,333
  86.  
  87.   To contact the author directly : 
  88.  
  89.   Contact :     Loewy Ron,
  90.                 9 Haneveem st.
  91.                 Herzeliya, 46465
  92.                 ISRAEL.
  93.  
  94.   e-mail address : CompuServe - 100274,162
  95.  
  96. Related Topics :
  97. Regsiteration
  98. Overview
  99.  
  100. This package contains the following files :
  101.  
  102.  HELPENG.EXE    - Help Engine.
  103.  HELPC.EXE      - Help Compiler.
  104.  HE.EXE         - Mem Help Engine.
  105.  HLPDK.DOC      - This file.
  106.  HELPC.DOC      - Help Compiler documentation
  107.  HELPDEMO.HDF   - Demo Help Project.
  108.  2NDDEMO.HDF    - Demo Help Project - file 2.
  109.  HELPDEMO.HLP   - Demo Help Project file for Windows WINHELP. 
  110.  HLPDK.REG      - Registration file.
  111.  HLPDK.HDF      - Help Development Kit hypertext help database source.
  112.  HLPDK.HDT      - Help Development Kit help database file.
  113.  HLPDK.SET      - Help Development Kit help database file.
  114.  HLPDKTOP.*     - Help Development Kit help database files.
  115.  HLPDKLNK.*     - Help Development Kit help database files.
  116.  HLPDKKEY.*     - Help Development Kit Help datanase files.
  117.  PROGRAMS.TXT   - ISoft D&M shareware products description.
  118.  
  119. Related Topics :
  120. Overview
  121. Quick Start
  122.  
  123. HELPENG, HELPC were written using Turbo Pascal 6.0, and Borland Pascal 7.0,
  124. Paradox Engine 2.0, and Paradox Engine 3.0, 3.01. 
  125. (Trademarks of Borland International).
  126.  
  127. Windows, Microsoft, HC and Quick Help are trademarks or copyrights
  128. of Microsoft Corp.
  129.  
  130. The HELPENG program was written using the WINTEXT UI library, 
  131. (c) 1991,93 Loewy Ron.
  132.  
  133. THELP, HL and TVHC are Trademarks or copyrights Borland International.
  134.  
  135. POPHELP is a copyright of TurboPower Software.
  136.  
  137. TVHC support, and other ideas were suggested by MunLeong Chan.
  138.  
  139. Parts of the Help Engines were generated using Ron Loewy's WTGEN and dbGen
  140. CASE code generators.
  141.  
  142. Parts of the Help Compiler were generated using Ron Loewy's dbGen database 
  143. code generator.
  144.  
  145. Yaniv Golan helped me with beta-testing, debugging and suggestions.
  146.  
  147. John Murphy notified me of the paragraph formtting difficulties that
  148. lead to the .PARAGRAPH .END-PARAGRAPH formatting capabilities.
  149.  
  150. DESQview/X is a trademark of Quarterdeck Office Systems.
  151.  
  152. MDVXHELP is a copyright (1992) of Daniel J. Bodoh. I have used his
  153. excelent documentation of DESQview/X help format to generate code
  154. to this environment.
  155.  
  156. The HC31 problem with characters with ordinal values biggen than 127
  157. was solved thanks to Mr. Lars Fosdal of Norway.
  158.  
  159. OS/2 is a registered trademark of International Bussiness Machines.
  160.  
  161. The Text Cursor restore problem in the help engines was reported by Prof.
  162. Timo Salmi of the Univ. of VAASA, Finland.
  163.  
  164. D.J. Murdoch suggested the Cross Reference Report enhancments, and winhelp
  165. Go To Search list box title problem.
  166.  
  167. Word for Windows is a trademark of Microsoft corp.
  168.  
  169. WordPerfect, WordPerfect for Windows are trademarks of WordPerfect corporation.
  170.  
  171. Lotus, AMI PRO are trademarks of Lotus corp.
  172.  
  173. Related Topics :
  174. Overview
  175.  
  176. From the command line enter HELPC HELPDEMO to compile the demo help database.
  177.  
  178. After the compilation process is ended, enter HELPENG HELPDEMO to browse the
  179. demo help database.
  180.  
  181. If you want to compile for windows :
  182.  
  183. from the command line enter HELPC HELPDEMO /W31
  184. and after that HC31 HELPDEMO
  185. (HC31 is the Microsoft Help Compiler)
  186. from windows, open the HELPDEMO.HLP file from the windows help engine.
  187. (Notice - if you do not have the HC help compiler from windows, we have
  188. included a compiled version of HELPDEMO (HELPDEMO.HLP) so you will be
  189. able to feel the quality of the output that can be generated, and decide
  190. if you want to purchase the HC31 program (Included with the SDK, BC++, 
  191. TPW, BP and probably some other packages), or download it from one of the
  192. sites Microsoft had uploaded it to).
  193.  
  194. If you use windows 3.0, or want your help file to be compatible with
  195. winHelp 3.0 use :
  196.         HELPC /W30 HELPDEMO
  197.         HC HELPDEMO
  198.  
  199. To compile for THELP use : 
  200.         HELPC /TH+ HELPDEMO
  201.         HL -x -e100 -p -i -oHELPDEMO.TPH HELPDEMO.HL
  202.  
  203. To compile for QuickHelp : 
  204.         HELPC /QH+ HELPDEMO
  205.         HELPMAKE -e15 -oHELPDEMO.QH HELPDEMO.SRC
  206.  
  207. To compile for TVHC :
  208.         HELPC /TV+ HELPDEMO
  209.         TVHC HELPDEMO.TXT
  210.  
  211. To compile for POPHELP :
  212.         HELPC /PH+ HELPDEMO
  213.         MAKEHELP /Q HELPDEMO
  214.  
  215. To compile for DESQview/X :
  216.         HELPC /XD+ HELPDEMO
  217.         MDVXHELP HELPDEMO.HLP @HELPDEMO.LST
  218.         COPY HELPDEMO.HLP d:\DVX\HELP
  219.  
  220. To compile for Native Mem Format :
  221.        HELPC /MT+ HELPDEMO
  222. (Use HE HELPDEMO to view that database).
  223.  
  224. To compile for IPF (OS/2) format :
  225.        HELPC /OS2 HELPDEMO 
  226.        Switch to an OS/2 session.
  227.        IPFC /INF HELPDEMO
  228. (Use the VIEW Command to browse the database).
  229.  
  230. To create a text document with table of contents, glossary and index :
  231.        HELPC /TXT HELPDEMO
  232.  
  233. To create a word processor document with table of contents, 
  234. glossary and index :
  235.        HELPC /RTF HELPDEMO
  236.        import helpdemo.rtf to your word-processort, and update fields.
  237.        (e.g. Microsoft WinWord : File|Open to open the document
  238.                                  Answer Yes to convert from Rich Text Format
  239.                                  Press F9 to update embedded format fields
  240.                                  somewhere in the first page (after the 
  241.                                  Table Of Contents title), and in the last 
  242.                                  page (after the index title).)
  243. Related Topics :
  244. Overview
  245. File List
  246.  
  247. To start the help engine program enter HELPENG on the command line, and 
  248. choose the help database you want to view from the list box. Use the Tab key
  249. to cycle between hot-link words, and press Enter to go to that link.
  250.  
  251. If you know the name of the SET file of the database you want to activate, you
  252. can enter it on the command line, and the help engine will display it.
  253.  
  254. If you have a mouse, you can use it to point at the hi-lighted links, and 
  255. activate them by pressing the left mouse button.
  256.  
  257. Press the ALT-T key combination to choose from a list of TOPICS in the 
  258. database, Press ALT-B to go back to the previous displayed TOPIC, Press
  259. ALT-X to exit the help engine.
  260.  
  261. The exit command can be given by pressing the right mouse button.
  262.  
  263. Use F10 to open the menubar, and use the arrow keys to navigate the 
  264. options. When you find the option you are interested in, Use the Enter
  265. key to execute it, or the Esc key to cancel. The menubar can be navigated
  266. using the mouse as well.
  267.  
  268. To create a new help database please refer to the HELPC documentation
  269. file.
  270.  
  271. If you want to use the Native Mem Format Databases, Please use the supplied
  272. HE.EXE program. 
  273.  
  274. Related Topics :
  275.  
  276. Trouble Shooting
  277. Overview
  278.  
  279. If you receive some kind of an error message while using the help development
  280. kit please refer to this section.
  281.  
  282. tableOps: xxxx error message :
  283. This message is generated by the Paradox Engine if an internal error occurs,
  284. if you receive a message that is not understood (e.g. Table is busy), 
  285. please try one of the following :
  286.  1. Try running the Help Compiler or the Help Engine with another input and 
  287.     notice if the problem exists, if it does, turn to the next entry,
  288.     otherwise try to see what the difference between the inputs is.
  289.  2. Check your free memory, try to move some TSR's from memory, or use the
  290.     protected mode compiler/engine available with the registered version.
  291.  3. Check if you have loaded dos SHARE program, it is advised to use SHARE
  292.     with programs that use the Paradox Engine. If you receive a table busy
  293.     error, try to see if you have another program that uses the same table 
  294.     in another session (Windows/DESQview etc..).
  295.  4. PANIC - Please contact the distibuter/author for additional help.
  296.  
  297. Microsoft's HC31 help compiler will generate a error in RTF file error :
  298.  
  299.  1. Re-compile using HELPC 4.0+. This should solve the problem, if the problem
  300.     still exists - please try steps 2 and 3, and notify the author. 
  301.  2. Use a binary disk editor to look at the character at the position x - 1
  302.     in the RTF file (where x is the error position reported by HC31).
  303.  3. Try to replace that charqacter from a special PC oem character to a 
  304.     "standard" ascii character (such as *). If the problem still occurs,
  305.     please contact ISoft D&M/The author, otherwise - you probably came 
  306.     accross a character that HC31 can not handle. In that case - try using
  307.     HC300b (the one that generates winHelp 3.0 format), or delete these 
  308.     characters from your source HDF file.
  309.  
  310. Borland's HL help linker will generate a FE02: Out Of Memory error :
  311.  1. Re-compile using HELPC V3.0+, to include ;INDEX directives after the
  312.     screen's definitions.
  313.  
  314. Borland's HL help linker will complain about undefined context numbers :
  315.  1. You probably have a contents.h file in the current directory, that hl
  316.     tries to use to bind the help topics to Borland's IDE on-line help,
  317.     try renaming this file, and re-compile with HL.
  318.  
  319. HelpC will not create the database when compiling to Native Mem (/MT+) :
  320.  1. Try compiling with report generation on (/R+) to Native Paradox
  321.     (/PX+) format. If there are errors, consult the HELPC.LST file, fix 
  322.     them, and re-try.
  323.  2. If the database is BIG, you might not have enough memory - Remember that
  324.     Native Mem tables are generated in memory. You will have to use the
  325.     HelpCX protected mode compiler (Available with the registered version).
  326.  
  327. HelpEng/HE will complain on an old-database when tring to open a help
  328. database with it :
  329.  1. Re-Compile the database using helpC.
  330.  
  331. HelpEng/HE will complain on un-supported database format, when trying to
  332. open a database :
  333.  1. HelpEng can not display Native Mem databases, and HE can not display
  334.     Native PX databases. Use the other help engine supplied.
  335.  
  336. HE will not be able to open a Native Mem database :
  337.  1. Use the protected mode HEX help engine. (Available for registered users).
  338.  
  339. Where is HL - Borland's Help Linker :
  340.  1. HL is not included with Borland C++ or Borland Pascal, Borland sells an
  341.     aditional package called Borland Open Architecture (and Borlad OA for 
  342.     Pascal) that include among other things - the THELP help linker.
  343.  
  344. HelpEng/HE will complain on an old-database when tring to open a help
  345. database with it :
  346.  1. Re-Compile the database using helpC.
  347.  
  348. HelpEng/HE will complain on un-supported database format, when trying to
  349. open a database :
  350.  1. HelpEng can not display Native Mem databases, and HE can not display
  351.     Native PX databases. Use the other help engine supplied.
  352.  
  353. HE will not be able to open a Native Mem database :
  354.  1. Use the protected mode HEX help engine. (Available for registered users).
  355.  
  356. We have encountered some users that ran into problems, because they did 
  357. not use the dos SHARE program. We advise that you will always load the 
  358. SHARE program in your AUTOEXEC.BAT file.
  359.  
  360. Related Topics :
  361. Overview
  362. Help Engine
  363. Help Compiler
  364.  
  365. The HELPC help compiler is a dos command line program that receives a 
  366. help definition file (.HDF) and produce a help database. 
  367.  
  368.   The helpC command line is :
  369.  
  370.  HELPC source.fil [/Htopic-table-name] [/Llink-table-name] [/Ddata-file-name] 
  371.                   [/Kkeywords-table-name] [/R-]  [/ST-] [/CS+] [/EP+] [/WD-]
  372.                   [/RM-]
  373.                   [/W+]  [/W30] [/W31] [TH+] [/QH+] [/TV+] [/PH+] [/XD+]
  374.                   [/PX+] [/MT+] [/OS2] [/TXT] [/RTF]
  375. The output of the compiler is a set data file called source.SET, that
  376. includes the names of the other help database components. 
  377.  
  378. Please Notice - if the /W+ /W30 or /W31 switch is defined, the compiler 
  379. will generate a .HPJ and .RTF files that can be used with the Microsoft 
  380. HC (v3.00b) or HC31 help compiler, and output a .HLP windows help file!. 
  381.  
  382. By default the help compiler produces a help cross reference report on the 
  383. topics/links used in the database, if the /R- switch is set, no cross-ref
  384. report will be generated, and no database integrity indicators will be
  385. given.
  386.  
  387.  
  388. IMPORTANT - Scan the output cross reference report for links defined, that
  389. are not defined as topics!
  390.  
  391. Notice - An additional switch is available that instructs the help compiler
  392. to indicate it's parse and code generation progress. Use the /EP+ switch to
  393. see that the helpC compiler is active. Please understand that the compile
  394. process can take a long time, on complex help databases. This switch does
  395. nothing more that ensure to you that the help compiler is alive. 
  396.  
  397. The /ST switch defines if the topic name defined in the .TOPIC command
  398. can include embeded spaces. By default this switch is set to /ST- (No
  399. embedded spaces).
  400.  
  401. The /CS switch turns Topics and Links case sensativity to ON. Use this
  402. switch with care - Only if you must have a lower/mixed case index in THELP
  403. or POPHELP use this switch. Notice that help databases that compile fine
  404. with case sensativity set to off, might fail to do so in case sensativity
  405. on. By deafult this switch is set to off (-).
  406.  
  407. The /XD switch generates code to the MDVXHELP help compiler, available
  408. free in the file DVXHLP10.ZIP on the internet. When this switch is given,
  409. a set of cover and section files is generated, as well as a response
  410. file that should be used to compile the help database.
  411.  
  412. The /OS2 switch generates IPF source code. You must compile the generated code 
  413. with IPFC, from within an OS/2 session (window or full screen).
  414.  
  415. The /WD switch controls Warning Display. By default Warning Display is On, if
  416. you do not want to see the Warnings issued by the compiler when a topic name 
  417. or link are found to be incomatible with the target source, and helpC 
  418. translate them to be syntax compatible with the target.
  419.  
  420. Use the /RTF switch to create a word-processor ready RTF file, import this
  421. file (and update the fields e.g.- F9 in WinWord) to create a professional
  422. formatted documentation from the same source code!.
  423.  
  424. Use the /TXT switch to create a text file document from your .HDF source.
  425. With this feature you can create on-line help and printed documentation
  426. from the same source!.
  427.  
  428. The /RM- switch uses disk cross-reference report tables. Usage of this 
  429. option will allow the creation of cross-reference report for huge databases.
  430. This options will slow the creation of reports, use it only for databases
  431. so big that the report can not be generated using memory tables.
  432.  
  433. Related Topics :
  434. Overview
  435. Command Line
  436. Help Engine
  437. Technical Documentation
  438.  
  439. The compiler switches are defined on the command line. These switches can
  440. be placed before and after the source file name. The compiler will look for
  441. a file named HELPC.CFG in the current directory, and process it before any
  442. command line switches are processed. 
  443.  
  444. Switches on the command line will over-ride switches set before them, on the
  445. command line or in one of the response options file.
  446.  
  447. Response option files can be specified by prefixing their name with a @ sign.
  448.  
  449.  
  450.  Examples :
  451.  
  452.  If our HELPC.CFG file, in the current directory is :
  453.  
  454. /W31
  455. /R-
  456.  
  457.  And we compile using HELPC HELPDEMO
  458.  
  459.  The helpdemo.hdf file will be compiled, with the target set to winhelp 3.1
  460.  and no cross-reference report.
  461.  
  462.  Compile using HELPC HELPDEMO /r+
  463.  
  464.  Will create winhelp 3.1 sources, but a report will be generated.
  465.  
  466.  Compile using HELPC /w- HELPDEMO
  467.  
  468.  Will generate native format help database, no report is generated.
  469.  
  470.  If we have a file called MYSWITCH.CFG with the following lines :
  471.  
  472. /TH+
  473. /ST-
  474. /CS+
  475.  
  476.  And we compile using HELPC @MYSWITCH.CFG HELPDEMO
  477.  
  478.  A THELP source, using Long Topic Names, with case sensativity will be 
  479.  generated, no cross reference report is generated. (HELPC.CFG contains /r-)
  480.  
  481. Related Topics :
  482. Overview
  483. Help Compiler
  484.  
  485.  
  486.  
  487. The Help Engine database is a combination of text that is read by the user,
  488. and a Topic and Links database that allows the user to view the topics
  489. he is interested in, using hyper-text methods.
  490.  
  491.  
  492.   Each help database is built of 5 components : 
  493.  
  494.  1. Help Data File    - this file contains the raw text data.
  495.  2. Topic Index       - a database table that contains the topic names, and
  496.                         the references to the topics in the Data File.
  497.  3. Links Index       - a database table that contains the list of links 
  498.                         defined for each topic, and positional data.
  499.  4. Keywords Index    - a database table that contains the list of keywords,
  500.                         and the topics that have these keywords.
  501.  5. Set Data File     - a database configuration file that contains the
  502.                         names of the 3 components defined above, and some 
  503.                         additional information.
  504.  
  505. Version 1.x is the bare-bones version that includes only the basic
  506. operations needed from a hyper-text database, this version is implemented
  507. using the Paradox Engine V3.0 to manage the Topic and Link index tables.
  508.  
  509. Version 2.x has a new field in the topic table - the title field, help
  510. databases that were compiled with V1.x will not be executed by version
  511. 2.x, they will have to be re-compiled!.
  512.  
  513. Version 3.x fields have different length - the databases have to be 
  514. re-compiled.
  515.  
  516. Version 5.0+ has a new entry in the help set file, database have to be
  517. re-compiled, ot the value 128 should be added in the last line of the help
  518. set file, and the version number should be changed to 5.0.
  519.  
  520. Version 6.0+ has added the keyword support - a new database table is added,
  521. and a new set format is defined. Help databases will have to be re-compiled
  522. for Natice targets.
  523.  
  524. In Version 7.0 the title field has been expanded once more - to 70 
  525. characters. Help databases will have to be re-compiled.
  526.  
  527. In Version 8.0 the tType field was added to the Topics database. Old databases
  528. will have to be re-compiled.
  529.  
  530. The format of the help database is released to the public domain, if
  531. you implement a database viewer on this database structure, I would be
  532. happy to receive a copy ..
  533.  
  534. Related Topics :
  535. Help Compiler
  536. Help Engine
  537. Help Definition Format
  538. Topic Index Format
  539. Links Index Format
  540. Keywords Index Format
  541. Set File Format
  542.  
  543.  
  544.   The help definition file format is as follows :
  545.  
  546. | remarks ...
  547. | remarks ...
  548. | 
  549. | .ENTRY topic-name
  550. | [.TITLE optional title for topic]
  551. | [.KEYWORDS optional keywords for topic]
  552. | topic text and link reference .. 
  553. | topic text and link reference .. 
  554. | topic text and link reference .. 
  555. | topic text and link reference .. 
  556. | .END-ENTRY 
  557. | 
  558. | remarks ...
  559. | 
  560. | 
  561. | .ENTRY topic2-name
  562. | [.KEYWORDS keyword1 keyword2 ..]
  563. | [.PARAGRAPH]
  564. | topic 2 text and link reference .. 
  565. | topic 2 text and link reference .. 
  566. | topic 2 text and link reference .. 
  567. | [.END-PARAGRAPH]
  568. | additional topic2 text ...
  569. | .END-ENTRY 
  570. |
  571. | .POPUP popup-name
  572. | [.TITLE optional title for popup]
  573. |   definition for some reference
  574. |   ...
  575. | .END-POPUP
  576.  
  577.   As can be seen - lines between the .ENTRY and .END-ENTRY keywords are
  578.  the lines processed by the help compiler, to create the help database, 
  579.  every other line is considered a remark, and is not parsed or evaluated by
  580.  the help compiler.
  581.  
  582.   The topic text and link reference lines are simple text lines, with
  583.  special link marks.
  584.  
  585.   A sample will provide the details :
  586.  
  587. This is a text help line that includes one ~link~link-topic-name~ in it.
  588.  
  589.   This line will be displayed in the help engine program as :
  590.  
  591. This is a text help line that includes one link in it.
  592.  
  593.   The word "link" will be in a different color then the rest of the line, 
  594.  to indicate that this is a link. If the user hi-lights the link, and
  595.  presses Enter (or points the mouse cursor and clicks), the help engine will
  596.  look for a topic called "link-topic-name", and display it.
  597.  
  598.   Browse the HELPDEMO.HDF file for a demo of a help database definition file.
  599.  
  600.  Notes :
  601.  
  602.  1. The keywords .TOPIC and .END-TOPIC can be used instead of .ENTRY and
  603.   .  .END-ENTRY respectivly.
  604.  
  605.  2. Keywords are NOT case sensitive. (.topic = .TOPIC = .eNTry)
  606.  
  607.  3. The .TITLE keyword is optional. If no title is defined, the topic name
  608.     is used as a title. (just like in v1.x). 
  609.  
  610.  4. If you want the ~ sign to appear in your help database, use ~~ in your
  611.     help source file. (e.g. "This is a ~~" will be "This is a ~" in the final
  612.     help database.).
  613.  
  614.  5. The Optional .PARAGRAPH and .END-PARAGRAPH commands in the help topic text,
  615.     specify the start and the end of a paragraph. This feature is currently 
  616.     supported only for winhelp and IPF sources. This feature is important if you 
  617.     want to create long paragraphs that will wrap correctly when a user resizes
  618.     the help window. It is advized ALWAYS to use this feature for paragraphs,
  619.     future versions of the Help Development Kit will allow greater formatting
  620.     control over paragraphs using this mechanism.
  621.  
  622.  6. When a .PARAGRAPH is issued, a .END-PARAGRAPH MUST be specified at the
  623.     end of the paragraph. These commands must appear as the first words in
  624.     a line. The text after the .PARAGRAPH command is NOT part of the text 
  625.     of the help topic.
  626.  
  627.  
  628.  7. The optional .KEYWORDS command can appear after the .TITLE command
  629.     (If there is one), or the .TOPIC header (otherwise), Use this command
  630.     to help the user search for sets of topics that are connected to a 
  631.     specific keyword. The syntax of this comand is :
  632.     .KEYWORDS keyword-1 keyword-2 ... 
  633.  
  634.  8. .POPUP and .END-POPUP (or .ENDPOP) are used to define popup topics that 
  635.     are displayed on the same screen as the original topic that includes the
  636.     link to them. Popup entries allow the user to consult a glossary, and 
  637.     not lose the topic he was reading. Popups are supported in the winhelp,
  638.     Native PX and Native Mem formats. In the other formats Popups are used 
  639.     as standard topics.
  640.  
  641.  9. In the Text target .POPUP entries will be automatically included in a 
  642.     Glossary file that you can add as an appendix to your documentation.
  643.  
  644. Additional commands include :
  645.  
  646. | .TEXTCOLOR, .LINKCOLOR and .LINKHIGH - VGA colors of text and links in normal 
  647. and high (selected) states in the native help format.
  648.  
  649. The syntax of these commands is :
  650.  
  651. | .TEXTCOLOR w 
  652.  
  653. or
  654.  
  655. | .LINKCOLOR x
  656.  
  657. or
  658.  
  659. | .LINKHIGH y
  660.  
  661. Where w, x and y are the color of the text/link, which is a combination of the 
  662. color of the foreground with the color of the background multiplied by 16.
  663.  
  664. The colors that can be used for both fore and background are :
  665.  
  666.   Black     = 0
  667.   Blue      = 1
  668.   Green     = 2
  669.   Cyan      = 3
  670.   Red       = 4
  671.   Magenta   = 5
  672.   Brown     = 6
  673.   LightGray = 7
  674.  
  675. The colors that can be used only for the foreground are :
  676.  
  677.   DarkGray     = 8
  678.   LightBlue    = 9
  679.   LightGreen   = 10
  680.   LightCyan    = 11
  681.   LightRed     = 12
  682.   LightMagenta = 13
  683.   Yellow       = 14
  684.   White        = 15
  685.  
  686. For example : to set the normal color of a link to light green on blue, use
  687.  
  688. | .LINKCOLOR 26
  689.  
  690. where 26 = 10 + 16 * 1. (10 = light green, 1 = blue).
  691.  
  692. Creating Multiple Source Projects :
  693.  
  694. Use the .INCLUDE commands in the source of your .HDF file, to include an
  695. additional source file.
  696.  
  697. For Example :
  698.  
  699.  .. some stuff 
  700.  
  701. | .include 2ndfile.hdf
  702.  
  703.  .. additional stuff
  704.  
  705. will process 2NDFILE.HDF in the middle of our source file.
  706.  
  707. Please notice - .INCLUDE commands can be nested in your source file,
  708. it is however not recommended to nest them too deep, helpC does not
  709. close the input file when a .INCLUDEd file is processed, in order to
  710. minimize help generation time - there is however, a limit on the number
  711. of open files that can be used by a program - this is a limit set by dos.
  712.  
  713. GUI Font based targets :
  714.  
  715. The .FIXEDFONT command is used to define a non proportional font as the 
  716. default font of the help database. Currently the only targets affected
  717. by this command are windows winHelp v3.x. If you find that your help 
  718. databases are not aligned after they are converted to winHelp format, use 
  719. this command and re-compile. This command has no effect on targets that are 
  720. different from the targets mentioned before.
  721.  
  722. The .PCFONT command is used to define a font that has the standard pc 
  723. character set (Terminal - in windows). If you convert a text based 
  724. database that uses the PC's special characters, use this command to
  725. set the default font. This command has no effect on targets that are 
  726. different from the targets mentioned before.
  727.  
  728. Text targets :
  729.  
  730. The .PAGELENGTH and .PAGEWIDTH statements set the printed page length in
  731. rows, and width in columns. The syntax is .PAGELENGTH xx or .PAGEWIDTH yy .
  732.  
  733. Related Topics :
  734. Technical Documentation
  735. Conditional Defines
  736.  
  737.  
  738.   The topic index table format is as follows :
  739.  
  740.   TOPIC     - 40 charcters string key - this is the topic "name".
  741.   FILENAME  - 38 characters string field - includes the name of the
  742.               help raw data file. (Notice - V1.0 ignores the value of this 
  743.               field, it is here for future expansion).
  744.   START     - longint (long) field that contains the offset from the data file
  745.               start, to the start of the topics text data, in bytes.
  746.   LEN       - longint (long) field that contains the length (in bytes) of the 
  747.               text data of the topic.
  748.   TITLE     - 70 characters string key - the title of the topic.
  749.   TTYPE     - 1 character - topic type. Currently supported types are :
  750.               'T' = Topic.
  751.               'P' = Popup.
  752.  
  753. Related Topics :
  754. Technical Documentation
  755. Links Index Format
  756. Keywords Index Format
  757. Set File Format
  758.  
  759.   The links index table format is as follows :
  760.  
  761.   TOPIC     - 40 characters string key - the name of the topic that 
  762.               has the link.
  763.   SEQ       - integer (int) key - contains the sequential number of 
  764.               the link in the topic. (This way you can assign the links
  765.               order in the topic).
  766.   LINK      - 40 characters string key - the name of the link topic to
  767.               display if the link is chosen.
  768.   LINE      - integer (int) field - the line (from the start of the topic) 
  769.               this link is displayed on.
  770.   COL       - integer (int) field - the column this link is displayed on.
  771.   TXT       - 70 characters string field - the text to display on the line.
  772.  
  773. Related Topics :
  774. Technical Documentation
  775. Topic Index Format
  776. Keywords Index Format
  777. Set File Format
  778.  
  779.   The set file is a text file that contains one entry in each line, using
  780.  the following format :
  781.  
  782. help-database-engine
  783. version-of-generating-compiler
  784. topic-index-table name
  785. links-index-table name
  786. keywords-index-table name
  787. help-raw-data-file name
  788. number-of-topics
  789. length-of-file
  790. link-normal-color
  791. link-high-color
  792. text-normal-color
  793.  
  794. The help-database-engine values available today are DEF=Paradox and 
  795. MEM=memory Tables.
  796.  
  797. Related Topics:
  798. Technical Documentation
  799. Topic Index Format
  800. Links Index Format
  801. Keywords Index Format
  802.  
  803.   The keywords index table format is as follows :
  804.  
  805.   KEYWORD   - 40 characters string key - the keyword.
  806.   TOPIC     - 40 characters string key - the topic name that this keyword is 
  807.               assigned to.
  808.  
  809.   Notice - the database will include a row for each keyword, that has the 
  810.   TOPIC field blank. This is used to display the first list of keywords, that
  811.   if chosen, will display the 2nd list of topics that have the chosen keyword
  812.   in their .KEYWORDS definition.
  813.  
  814. Related Topics:
  815. Technical Documentation
  816. Topic Index Format
  817. Links Index Format
  818. Set File Format
  819.  
  820. The helpC compiler supports conditional define directives that allow you to
  821. tailor your source according to define symbols that are known to the compiler.
  822.  
  823. You can use the .ifdef, .ifndef, .else and .endif directives to test the
  824. target of your compile and do different things according to this target.
  825.  
  826. If for example you have a Windows bitmap you want to include in your generated
  827. RTF file, when you compile to winhelp format, but, you would like to use a
  828. statement in other targets that do not support graphics, you could do the 
  829. following :
  830.  
  831. | .ifdef windows
  832. |   some text {\bmc mybmp.bmp} some more text
  833. | .else 
  834. |   some text AND STATEMENT HERE some more text
  835. | .endif
  836.  
  837. When the compiler will generate the code, the RTF command \bmc will be 
  838. inserted in the output of the compiler for windows targets (/W30, /W31), 
  839. and a simple text statement will be inserted otherwise.
  840.  
  841. The conditional directives supported are :
  842.  
  843. | .ifdef  SYMBOL - Compile code only if SYMBOL is defined.
  844. | .ifndef SYMBOL - Compile code only if SYMBOL is NOT defined.
  845. | .endif         - Any .ifdef/.ifndef should be terminated by a .endif .
  846. | .else          - Reverse the previous .ifdef/.ifndef
  847.  
  848. The following SYMBOLS are automatically defined by the compiler :
  849.  
  850. Symbol          When Defined
  851. ------          ------------
  852. DEF             /PX+
  853. W31             /W31
  854. W30             /W30
  855. THS             /TH+
  856. QHS             /QH+
  857. TVH             /TV+
  858. PHS             /PH+
  859. DVX             /XD+
  860. MEM             /MT+
  861. OS2             /OS2
  862. TXT             /TXT
  863. WINDOWS         /W30, /W31
  864. THELP           /TH+
  865. QUICKHELP       /QH+
  866. TVHC            /TV+
  867. NATIVEPARADOX   /PX+
  868. POPHELP         /PH+
  869. DESQVIEW/X      /XD+
  870. NATIVEMEMORY    /MT+
  871. VERx.y          When Compiling with helpC Vx.y 
  872.  
  873. Related Topics :
  874.  
  875. Technical Documentation
  876.  
  877.  
  878.