home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / VISUAL_B / FERRAMEN / MINIHELP / HOWTORUN.TX_ / HOWTORUN.TX
Encoding:
Text File  |  1994-06-02  |  5.6 KB  |  102 lines
  1.  
  2.  
  3.     HOW TO RUN MiniHelp Plus v3.1
  4.  
  5.  
  6. Maximize Notepad to read this file easier.
  7.  
  8.  
  9. MiniHelp Plus v3.1 is basically a WHOLE NEW PROGRAM, compared
  10. to the previous versions.  Those relied on either running it from the 
  11. command line or "drag-n-drop" in File Manager.  Those, now, are obsolete
  12. and in fact, do not work with MiniHelp Plus v3.1.  MiniHelp Plus v3.1
  13. accepts no parameters from the command line and would not know what
  14. to do with a program should you drop a source file onto it from within
  15. File Manager.
  16.  
  17. MiniHelp Plus v3.1 now, and finally, sports an easy to use Windows
  18. front end shell/user interface.  It's a button pad that allows you to do
  19. everything you did with the previous versions with only one click of
  20. the mouse button on the appropriate button.  I chose this type of a
  21. front-end shell over a dedicated text editor from which to run MiniHelp
  22. Plus v3.1.  Lord knows there are plenty of text editors already out there
  23. and integrating MiniHelp Plus v3.1 into yet another would have rep-
  24. resented the maximum learning curve associated with how to use it.
  25. Instead, the learning curve is at its absolute minimum and each user
  26. can use the text editor he/she is most comfortable with and most
  27. accustomed to.  Now you can create your source file with the text editor
  28. you like most, while leaving MiniHelp Plus v3.1 at the bottom of the
  29. screen, maximized or minimized to an icon.  When you are finished
  30. typing in and saving your source file (be sure to assign it the file
  31. extension ".src"), simply click on the appropriate buttons and your
  32. Help file is complete.  Nothing could be simpler!  Below is a step-by-step
  33. guide to using MiniHelp Plus v3.1.
  34.  
  35.  
  36. STEP 1:  Create and save your MiniHelp Plus v3.1 source file.  Be sure to 
  37.     save it with the file extension of ".src."  This is mandatory, a must,
  38.     for MiniHelp Plus v3.1.  Any stubborness here will not pay off.
  39.  
  40. STEP 2:  Click on the CONFIGURE... button.  Enter the filename only, without
  41.     a file extension.  MiniHelp Plus v3.1 adds the appropriate file extensions
  42.     for you.  For example, if you have created the source file named "MYHELP.SRC",
  43.     you would only enter MYHELP in the top edit control box of the Configure
  44.     dialog box, dropping the file extension.  MiniHelp Plus v3.1 takes care of
  45.     the rest.    Next, type in the FULL PATH AND FILENAME of your favorite
  46.     ASCII text editor in the bottom edit control box.  If you choose not to specify
  47.     one, Windows Notepad will be launched by default when you click the
  48.     TEXT EDITOR button.    The information MiniHelp Plus v3.1 needs is stored
  49.     in its own private INI file in your Windows directory.  NO CHANGES ARE
  50.     MADE TO    YOUR WIN.INI FILE!  Heaven knows, this file is already bloated
  51.     enough by too many third-party software vendors adding in their own
  52.     sections.   I prefer not to be counted among them.
  53.  
  54. STEP 3:  Click on the OK button in the Configure dialog box to accept what
  55.     you have typed into the edit control boxes.  This will then cause MiniHelp
  56.     Plus v3.1 to write or update the INI file (mhplus31.ini).  If you choose not
  57.     to accept what you have typed in, or want to get out of the dialog box
  58.     without doing anything at all, click on the CANCEL button.
  59.  
  60. STEP 4:  Click on the COMPILE RTF (may also be called COMPILE MINIHELP PLUS
  61.     V3.1 SOURCE FILE) button to compile your MiniHelp Plus v3.1source file.
  62.     When MiniHelp Plus v3.1 is finished compiling your source file into the RTF,
  63.     Header, and HPJ files, a message box will appear to inform you of success
  64.     or failure.  Click on the ok button to clear the message box from the screen.
  65.     The amount of time before the message box appears depends on the length
  66.     of your source file and the processor speed of your computer.  A short file
  67.     may only take 5 seconds or less, while a lengthy one may take 30 seconds
  68.     or more.  MiniHelp Plus v3.1 is done when the message box appears.
  69.  
  70. STEP 5:  Click on the HELP COMPILER button.  Control will be passed to the
  71.     Help Compiler while it is running, compiling your Help file.  When it is
  72.     finished, control will pass back to MiniHelp Plus v3.1.  No message box
  73.     appears to inform you of success or failure.  Instead, I recommend you
  74.     view the project error file (filename same as your source file with the file
  75.     extension ".err") by clicking on the ERROR FILE button.  This file is automatically
  76.     generated by MiniHelp Plus v3.1 and contains all/any errors encountered
  77.     by the Help Compiler during its build.  Automatic viewing of this file may
  78.     make its way into a future version of MiniHelp Plus v3.1, but I don't want
  79.     to take the time to implement it now, since everyone really wants a front-end
  80.     Windows Shell and I want to be able to give them what they want without
  81.     a long delay.
  82.  
  83. STEP 6:  To view your newly completed Help file, simply click on the button,
  84.     VIEW HELP.  
  85.  
  86.  
  87. That's all there is to it!
  88.  
  89.  
  90. Also, in order to access the MiniHelp Plus v3.1 Help file (mhplus31.hlp) and
  91. MiniHelp Plus v3.1 ToolPad Help file (mhpshell.hlp), make sure they are either
  92. in the same directory as MiniHelp Plus v3.1 or in your Windows directory.
  93. Furthermore, the Help Compiler (HCP.EXE....this is the only Help Compiler
  94. supported by MiniHelp Plus v3.1 at the time, since it is the only one that takes
  95. advantage of the extended memory on your system) must be either in the same
  96. directory as MiniHelp Plus v3.1 or in your Windows directory.  If it is not in either,
  97. the program cannot be located and ran.
  98.  
  99.  
  100. I know this is kind of a long-winded explanation and running MiniHelp Plus v3.1
  101. is actually much, much easier than telling you HOW to run it.  I hope this meets
  102. or exceeds everyones desire for a Windows front-end shell/user interface.