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