home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / PROG_GEN / RC2HDK20.ZIP / RC2HDK.DOC < prev    next >
Text File  |  1994-01-17  |  9KB  |  385 lines
  1.                                   - TOC-   1 -
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  File List - List of files available with RC2HDK ......................      1
  8.  RC2HDK - Resource To HLPDK Help Template Generator ...................      1
  9.  System Requirements ..................................................      1
  10.  What's New ...........................................................      1
  11.  Contact ..............................................................      2
  12.  Registering RC2HDK ...................................................      2
  13.  HLPDK - The Help Development Kit .....................................      3
  14.  OPERATION ............................................................      3
  15.  Credits ..............................................................      4
  16.  Warranty .............................................................      4
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.                                   - TOC-   1 -
  65.                                     -    1 -
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72. RC2HDK - Resource To HLPDK Help Template Generator▄
  73.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  74.  
  75. RC2HDK is a program that takes Windows RC (Resource Description) files, and
  76. creates a HLPDK help template from it.
  77.  
  78. Resources are used to describe the part of the program the users see, in here 
  79. we define Menu entries, Dialog boxes, Key Accelerators and more. Since the
  80. users need to see help on the program's interface, more than anything else,
  81. the place to look for the help template for your windows programs - is in
  82. the resource file.
  83.  
  84. RC2HDK takes that file, and creates the template for you, saving you time,
  85. and helping you with the design of your help system. HLPDK is used to
  86. convert the output of RC2HDK to winHelp source files, or - you can even
  87. create the template for your text and wordprocessor documentation from
  88. this same output.
  89.  
  90. This version of RC2HDK supports Menu and Accelerator resources.
  91.  
  92.  
  93.  
  94. What's New▄
  95.  ▀▀▀▀▀▀▀▀▀▀
  96.  
  97. Version 2.0
  98.  
  99.         - Added the /MT+ and /MP+ switches to the RC2HDK program, use the
  100.           /MT+ switch to generate menu-items topic help entries, instead
  101.           of the default popup entries. RC2HDK will create topics with 
  102.           external reference, so it will be easy for you to call these 
  103.           entries from your program.
  104.  
  105.         - Added Accelerator resource template generation.
  106.  
  107. Version 1.0 - Initial Version.
  108.  
  109.  
  110. System Requirements▄
  111.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  112.  
  113. In order to use RC2HDK you need :
  114.  
  115. - This Package
  116. - The RC sources for your windows programs
  117. - The Help Development Kit Sound & Vision Edition (10.0) or later.
  118. - The HC31 or HCP program that came with your Language Compiler.
  119. - A PC capable of running DPMI programs.
  120.  
  121. Optional :
  122.  
  123. - Help Compilers/Linkers to specific targets.
  124.  
  125.  
  126.  
  127.  
  128.                  rc2hdk, Page #   1   Date 12-1-1994 Wednesday
  129.                                     -    2 -
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. File List - List of files available with RC2HDK▄
  137.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  138.  
  139. List of files available with the RC2HDK package :
  140.  
  141. RC2HDK.EXE      - The RC2HDK help template generator.
  142. RC2HDK.DOC      - This File.
  143. RC2HDK.HLP      - RC2HDK Documentation in winHelp Format.
  144. RC2HDK.REG      - HLPDK+RC2HDK Registration File.
  145. RC2HDK.EDU      - HLPDK+RC2HDK Registration File/Education discount.
  146. PROGRAMS.TXT    - HyperAct Inc. shareware products description.
  147.  
  148.  
  149. Registering RC2HDK▄
  150.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  151.  
  152. The RC2HDK system is NOT Free!, Only registered HLPDK users are allowed to
  153. use it. If you find this product valuable, after a reasonable evaluation
  154. period, please register it and HLPDK. 
  155. Until January 94, you can register HLPDK and get RC2HDK V1.0 Free!.
  156.  
  157. By Registaring you will receive the latest HLPDK system, that include protected 
  158. mode compilers and engines, and the latest RC2HDK system, with a protected
  159. mode RC2HDKX program!
  160.  
  161. To order your registered copy of HLPDK please do one of the following:
  162.  
  163.  1.     Order from HyperAct Inc.:     
  164.  You can order directly from HyperAct Inc. Please refer to the supplied 
  165.  RC2HDK.REG file. Edit it, print it and mail it (with a check) to: 
  166.         HyperAct Inc.,  
  167.         POBox 5517
  168.         Coralville Iowa 52241, U.S.A
  169.  
  170.  2.     Order from PsL:
  171.  You can order from Public (software) Library with your MC, Visa, AmEx 
  172.  or Discover card by calling 800-242-4PsL (from overseas: 713-524-6394) or 
  173.  by FAX to 713-524-6398 or by CompuServe to 71355,470. 
  174.  These numbers are for ordering only. HyperAct Inc. can NOT be reached at those 
  175.  numbers. Please contact HyperAct Inc. directly for any other type of problem 
  176.  (technical or other), information or request.
  177.  
  178. Registered HLPDK users can register RC2HDK at a reduced cost. Please refer to
  179. the supplied RC2HDK.REG file. Edit it, print it and mail it (with a check)
  180. to HyperAct Inc.
  181.  
  182. Special registration fees for higher education students and staff members.
  183. Please refer to the supplied RC2HDK.EDU file. Edit it, print it and mail it
  184. (with a check) to HyperAct Inc. (offered only when registering directly).
  185.  
  186. Notice - Current registered users of HLPDK and everyone that will register
  187. HLPDK before Jan. 1994 - will get RC2HDK free!. 
  188.  
  189.  
  190.  
  191.  
  192.                  rc2hdk, Page #   2   Date 12-1-1994 Wednesday
  193.                                     -    3 -
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200. Contact▄
  201.  ▀▀▀▀▀▀▀
  202.  
  203.   Please contact :
  204.  
  205.   HyperAct Inc.,  
  206.   P.O.B 5517
  207.   Coralville IA 52241,
  208.   U.S.A
  209.  
  210. HyperAct Inc. e-mail address : CompuServe - 76350,333
  211.  
  212.   To contact the author directly : 
  213.  
  214. e-mail address : CompuServe - 100274,162
  215.  
  216.  
  217. OPERATION▄
  218.  ▀▀▀▀▀▀▀▀▀
  219.  
  220. In order to use RC2HDK do the following :
  221.  
  222. 1. RC2HDK inpfile.RC
  223.  
  224. 2. Edit the output inpfile.HDF to include your custom help according to the
  225.    template generated.
  226.  
  227. 3. Use HELPC to create the target help database requested.
  228.    e.g. - HELPC /W31 INPFILE
  229.           HC31 INPFILE
  230.  
  231.  
  232. HLPDK - The Help Development Kit▄
  233.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  234.  
  235. The Help Development Kit is the hypertext package that is needed in order
  236. to compile and use the output of the RC2HDK system.
  237.  
  238. HLPDK includes a help compiler that accepts sources in the .HDF 
  239. (HLPDK Help Definition Format), and creates help databases to the HLPDK 
  240. help engines, or sources to other help engine targets, such as Windows
  241. winHelp, OS/2 IPF, DESQVIEW/X help system, Borland's TVHC and THELP,
  242. Turbo Power's PopHelp, Microsoft's QuickHelp, Microsoft Multimedia Viewer,
  243. World Wide Web HTML and can even create text documents and word processors 
  244. documents. (This document was created using HLPDK). 
  245.  
  246. The HLPDK system includes 2 Royalty Free Help Engines, that can be
  247. distributed free with help databases that were created by the help compiler.
  248.  
  249. HLPDK suports the following features :
  250.  
  251. Topics, PopUps, Links, Keywords, Text Formats, Navigational and
  252. Structural facilities, Target Code insertion, Multiple module files,
  253.  
  254.  
  255.  
  256.                  rc2hdk, Page #   3   Date 12-1-1994 Wednesday
  257.                                     -    4 -
  258.  
  259.  
  260.  
  261.  
  262.  
  263. Automatic Pascal/C/C++ reference generation, Exception handling,
  264. Multiple file target databases, Graphics, Sound, Groups, Application
  265. Launch, Automatic exports creation, User defined link templates,
  266. trigger actions and more.
  267.  
  268. Programmers that want the help engine's sources, can purchase it and modify
  269. it to their specific needs.
  270.  
  271. The HLPDK package is a shareware product, distributed by HyperAct Inc.
  272.  
  273.  
  274. Warranty▄
  275.  ▀▀▀▀▀▀▀▀
  276.  
  277. There is no warranty what so ever, The package is supplied as is,
  278. The distributor (HyperAct Inc), or the author (Loewy Ron), are not, 
  279. and will not be responsible for any damages, lost profits, 
  280. or inconveniences caused by the use, or inability to use this package. 
  281. The use of the program is at your own risk. 
  282. By using (or attempting to use) the package you agree to this.
  283.  
  284.  
  285.  
  286. Credits▄
  287.  ▀▀▀▀▀▀▀
  288.  
  289. The RC2HDK Program was created by Ron Loewy.
  290.  
  291. The RC2HDK Program was written using Borland Pascal with Objects 7.0,
  292. A trademark of Borland International.
  293.  
  294. Large parts of the RC2HDK Program were generated using my own dbGen CASE code
  295. generator.
  296.  
  297. Parts of the RC2HDK program were created using MKS LEX&YACC V3.2.
  298. A trademark of Mortice Kern Systems, Inc.
  299.  
  300. HELPENG, HELPC were written using Turbo Pascal 6.0, and Borland Pascal 7.0,
  301. Paradox Engine 2.0, and Paradox Engine 3.0, 3.01. 
  302. (Trademarks of Borland International).
  303.  
  304. Windows, Microsoft, HC and Quick Help are trademarks or copyrights
  305. of Microsoft Corp.
  306.  
  307. The HELPENG program was written using the WINTEXT UI library, 
  308. (c) 1991,93 Loewy Ron.
  309.  
  310. THELP, HL and TVHC are Trademarks or copyrights Borland International.
  311.  
  312. popHelp is a copyright of TurboPower Software.
  313.  
  314. DESQview/X is a trademark of Quarterdeck Office Systems.
  315.  
  316. OS/2 is a registered trademark of International Business Machines.
  317.  
  318.  
  319.  
  320.                  rc2hdk, Page #   4   Date 12-1-1994 Wednesday
  321.                                     -    5 -
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328. Parts of the Help Engines were generated using Ron Loewy's WTGEN and dbGen
  329. CASE code generators.
  330.  
  331. Parts of the Help Compiler were generated using Ron Loewy's dbGen database 
  332. code generator.
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.                  rc2hdk, Page #   5   Date 12-1-1994 Wednesday
  385.