home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / educ / helpsys.zip / HELP.DOC < prev    next >
Text File  |  1990-06-10  |  9KB  |  217 lines
  1.     NOTE:
  2.  
  3.     The following was clipped from the help screens available
  4.     within HELPCOM.  If you are running the system and would like
  5.     to reference this, just enter HELPCOM with no command line
  6.     options:
  7.  
  8.  
  9.     BACKGROUND
  10.  
  11.     HELPCOM and FINDHELP were conceived for the purpose of allowing
  12.     users, of a golf stats program called DBK, to add and edit help
  13.     files.  Although intended for a specific program, this help system
  14.     was designed to be extremely generic.
  15.  
  16.     If you are a shareware author or anyone that would like to create
  17.     a text-based seach-retrieval system, I would suggest you give this
  18.     one a try.
  19.  
  20.     I had conducted a cursory search for help systems that would do
  21.     this type of thing and found nothing that matched my requirements.
  22.     At the time, it seemed like a very simple application and so
  23.     without a second thought, I jumped into it with enthusiasm.
  24.  
  25.     I have purposely not put any flamboyant opening screens into
  26.     FINDHELP so that it loads quickly and so that it will blend well
  27.     with other systems.  All I ask is that you include this program if
  28.     you distribute FINDHELP.  If you are a shareware author, please
  29.     register one copy.  I will not expect the same from your users.
  30.  
  31.     If you have any suggestions, please contact me.  I would like to
  32.     maintain these programs.  Enter HELPCOM /A for contact and
  33.     registration info.
  34.  
  35.  
  36.     COMMON USES
  37.  
  38.     I have set up this system to function as a simple on-line
  39.     text base at our office.  When I have to answer a techincal
  40.     question, I document it into a .RAW file.  Each week, I compile
  41.     all of the .RAW files into a .HLP/.NDX file.  Then, when others
  42.     are looking for an answer, then can see if it's been asked before.
  43.  
  44.     If it has, then they can just read the solution off the screen.
  45.     What's good about this is that you force others to read solutions
  46.     to other problems during their hunt.  The larger the system
  47.     grows, the fewer questions I have to answer.
  48.  
  49.     Another use for this system is disk based help for shareware
  50.     authors.  I wrote a program called DBK that does stats for
  51.     golfers.  The new version will be using this system to provide
  52.     users with help.  Similar to the above example, each time I am
  53.     asked a question, I document it into a .RAW file.  Then, with
  54.     each release, a new set of .HLP/.NDX files are included.  Using
  55.     the FINDHELP utility, users can dig thru the help just as they
  56.     would use an index in a printed document.
  57.  
  58.  
  59.     DESIGN THEORY
  60.  
  61.     HELPCOM builds an NDX file that contains 8 different variables
  62.     that are used to help locate information stored within the .HLP
  63.     file.  A new NDX file is created each time you run HELPCOM.
  64.     Concurrently, the HLP file is also constructed by concatenating
  65.     each .RAW file after the header information has been removed.
  66.     Therefore, the HLP file is nothing more than all RAW files added
  67.     together excluding the header with is used to build the NDX file.
  68.  
  69.     When a user searches for help with FINDHELP, the NDX file is
  70.     sequentially accessed and a list of all matches is presented to
  71.     the user.  Using the up/dn arrow keys, the user selects the title
  72.     they wish to view.  Using a random access technique on the text
  73.     file, the information is read from disk and displayed on the
  74.     screen in a box.
  75.  
  76.     Currently, each RAW file will cost you 630 bytes in the NDX file.
  77.     RAW files may contain only 20 lines of information after the TEXT
  78.     keyword.  You may have a maximum of 5 applications and up to 10
  79.     keywords.  Both apps and keys may be up to 16 chars.  Titles may
  80.     contain up to 40 chars.  The variables that point to the starting
  81.     and ending positions in the text file are both long integer so the
  82.     size of the text file can be quite humoungous.
  83.  
  84.  
  85.     OPERTATION
  86.  
  87.     Place these files into a sub-directory called TTB.  Then make
  88.     a sub off of TTB called RAW.  Each time that you think of
  89.     something that should be part of your help system, change over
  90.     to the RAW sub and create a text file using a .RAW extension.
  91.     The filename could be anything.  For example, let's use
  92.     HELP0001.RAW... Starting with blank screen, you will create the
  93.     following:
  94.  
  95.     APPLICATION:
  96.     KEYWORDS:
  97.     TITLE:
  98.     ADDED:
  99.     TEXT:
  100.  
  101.     You MUST include the colons!
  102.  
  103.     Every .RAW file begins with these five keywords.  Therefore, you
  104.     should save these five words to a separate file called HEADER.
  105.     Then every time time you make a new .RAW file, merge in the
  106.     HEADER file first.
  107.  
  108.     APPLICATIONS:
  109.  
  110.     Ok, now insert the data under each keyword.  For example, lets
  111.     say that you are writing a help system for a set of programs that
  112.     you have written or collected.  The APPLICATION would be either a
  113.     very general topic of a program name.  Another example might be
  114.     a text database that relates to computer knowledge.  With this,
  115.     you might breakdown your applications as HARDWARE and SOFWARE.
  116.     You may have up to 5 different application names each separated
  117.     by one or more spaces.
  118.  
  119.     KEYWORDS
  120.  
  121.     The next line of data that you enter should be a list of keywords
  122.     that describe what the application is about.  Using the previous
  123.     example, suppose that your application was HARDWARE.  Some
  124.     keywords might be PRINTERS, MONITORS, HARD DRIVES.  Note that
  125.     HARD DRIVES would be considered 2 keywords because of the space.
  126.  
  127.     TITLE
  128.  
  129.     Now give the text that you will be entering a title.  Use up
  130.     to 40 characters to describe what the text is about.
  131.  
  132.     ADDED
  133.  
  134.     The added field is for the date the text information was added
  135.     to the database.  Use the MMDDYY format.
  136.  
  137.     TEXT
  138.  
  139.     Now you can just type or merge in your text.  Each text body
  140.     may contain up to 20 lines of 70 characters each.  The reason to
  141.     limit each to 20 lines is so that searches can be effective.  If
  142.     you have more than 20 lines worth, just create a second file
  143.     having a TITLE field called Blah, Blah PART 2of2 or as many
  144.     as necessary.
  145.  
  146.     Heres what one .RAW file would look like:
  147.  
  148.     APPLICATION:
  149.     HARDWARE
  150.     KEYWORDS:
  151.     PRINTERS DOT MATRIX 9 PIN CHEAP
  152.     TITLE:
  153.     10 Cheap printers I recommend (1/3)
  154.     ADDED:
  155.     062590
  156.     TEXT:
  157.     If you are looking for a good quality but inexpensive dot-matrix
  158.     printer....
  159.     .
  160.     .
  161.     Blah blah blah this might be line 22 ....
  162.     For more information, see parts 2/3 and 3/3
  163.  
  164.     After you save a bunch of .RAW files, you need to make them into
  165.     a .HLP file using HELPCOM.  This program will read the default
  166.     drive and strip out all keywords while making one large .HLP file.
  167.     The information contained in the header is placed into a .NDX file
  168.     that is used to retrieve information from the .HLP file.
  169.  
  170.     HELPCOM should be run followed by a filename of up to 8
  171.     characters.  e.g.  HELPCOM SYSTEM
  172.     This will take all .RAW files and create a SYSTEM.HLP and
  173.     SYSTEM.NDX file.
  174.  
  175.     Both the .HLP and .NDX file must be available before you can run
  176.     FINDHELP.
  177.  
  178.  
  179.     RUNNING FINDHELP
  180.  
  181.     To search and retrieve from the .HLP file, you should enter
  182.     FINDHELP followed by the name of the file in which FINDHELP should
  183.     look.  e.g.  FINDHELP SYSTEM
  184.  
  185.     This instructs FINDHELP to search the SYSTEM.NDX and SYSTEM.HLP
  186.     files for whatever criteria is entered by the user.  The interface
  187.     portion of FINDHELP is quite straight-forward and should not
  188.     require much explanation.
  189.  
  190.     This is an early release.  Please feel free to offer me your
  191.     feedback.
  192.  
  193.     FINDHELP and HELPCOM are shareware.  They were written by me,
  194.     E.Kasemodel of Ann Arbor, MI.  I am a member of the ASP and
  195.     will support these programs.
  196.  
  197.     If you use them, please send $10 for the most recent copy.
  198.     Support can be obtained for registered users via the DBK
  199.     BBS.  You have my permission to distribute these programs with
  200.     anything that you may have written only if you have registered.
  201.  
  202.     These programs are used as part of the DBK golf stats system.  If
  203.     you are a golfer and you would like to track your game this
  204.     season, give DBK a try!
  205.  
  206.     For more information, please log-on to the DBK BBS at (313)
  207.     662-9160 or write to me at 401 Snyder Ave ■ Ann Arbor, MI
  208.     48103   (313) 668-8111 (voice)
  209.  
  210.     My DBK BBS is open to everyone.  Only registered users will be
  211.     supported. However, should you find a bug or have a suggestion -
  212.     please let me know!
  213.  
  214.     Thanks.
  215.  
  216.     -KASE
  217.