home *** CD-ROM | disk | FTP | other *** search
/ Liren Large Software Subsidy 9 / 09.iso / l / l015 / 1.ddi / H_LIB.DOC < prev    next >
Encoding:
Text File  |  1991-03-01  |  7.0 KB  |  147 lines
  1.  
  2.  
  3.                                 Help Librarian
  4.                                     
  5.  
  6.  
  7.    What is Help Librarian
  8.          The Help Librarian is a tool used to create and maintain help files
  9.       to be used by your application. All help text is kept on-line and each
  10.       help screen is read in only when it is needed. This allows for a 
  11.       centralized file containing all help contexts. Also modifications to 
  12.       the textual portions of a help context do not require a recompile of
  13.       your application.
  14.  
  15.    What are help contexts
  16.          Help contexts are the mnemonic identifiers for the offsets into the
  17.       .HLP file where the help text is stored. These contexts are used as
  18.       handles in an application so that you can easily manipulate and 
  19.       maintain context sensitive help.
  20.  
  21.  
  22.  
  23.    Usage:
  24.    
  25.       Startup:
  26.          The Help Librarian is started by typing h_lib from DOS.
  27.          When h_lib is initialized you are presented with a Windows Style
  28.          Menu with File, Edit, Configure and Help as options.
  29.          Only File and Help are available until a help library is opened.
  30.  
  31.       Creating a new file
  32.          To create a new help library select the File option from the main
  33.          menu then select New from the file pull-down.  A form will then
  34.          appear allowing you to enter a name for the new help library or to
  35.          view existing help libraries in the current directory.
  36.  
  37.          The Help Librarian will not allow you to enter duplicate library
  38.          names.
  39.  
  40.  
  41.       Opening Existing Files
  42.          To open an existing help library select the File option from the
  43.          main menu then Open from the pull-down. A form is presented that 
  44.          allows you to enter the name of an existing help library. If 
  45.          you press <Grey+> while on the library name field a list of existing
  46.          help libraries is displayed. You may select a library to open
  47.          from this list.
  48.  
  49.  
  50.             Passing file names from command line
  51.                The name of an existing help library may be passed to the 
  52.                Help Librarian from the DOS command line.  The format is:
  53.                H_LIB <filename>.
  54.  
  55.                If the librarian is able to open the help library a list 
  56.                of existing help contexts is displayed on the screen, at
  57.                this point the main menu is active and you must select 
  58.                Edit to edit the help context list.
  59.  
  60.  
  61.       Saving Files
  62.          Saving the current help library is accomplished by selecting
  63.          the Save option on the file pull-down. If you are editing a help
  64.          library's context list press ESC to exit the context list. 
  65.  
  66.          You will be prompted to save any changes that you may have made. 
  67.          Control is then passed back to the main menu.
  68.  
  69.          Once you select save from the file pull-down the help library is
  70.          written to disk.
  71.  
  72.       Renaming Files
  73.          To save a help library to a different name select Save As from the 
  74.          the file pull-down menu. A form is presented to allow you to enter
  75.          the new name for the library. You can also view a list of existing
  76.          libraries by expanding the view field. Help Librarian will not 
  77.          allow you to enter a duplicate file name. Once a valid name has
  78.          been entered the file is renamed, and the renamed help library is 
  79.          opened and control returns to the main menu. You can edit the help
  80.          context list by selecting Edit from the main menu.
  81.  
  82.  
  83.  
  84.    
  85.       Dumping contexts to an ASCII file
  86.          Write ASCII allows you to dump all of your help context names and
  87.          associated text to a standard ASCII file. After selecting 
  88.          Write ASCII from the File pull-down a text entry box is presented
  89.          for the name of the ASCII file. No checking for uniqueness is 
  90.          performed on this file name. If a file of the same name exists it
  91.          is overwritten.
  92.  
  93.  
  94.       Contexts
  95.          Adding Context names
  96.             Once a help library has been created or opened you will be able 
  97.             to insert, delete or modify any contexts for the current library.
  98.             If you are editing a new file the list will be empty.
  99.             An existing library will have its contexts displayed in the 
  100.             scrolling list on the screen. To add a new context to the 
  101.             library simply press the Insert button and a text box is
  102.             displayed  prompting for a new context name. The Help Librarian
  103.             will not allow you to enter duplicate context names.
  104.       
  105.  
  106.          Added text to contexts
  107.             Once a context name(s) has been entered you can enter the help
  108.             text associated with that name. Pressing enter will display a
  109.             help window with any text for the current help context. This 
  110.             window is created using the default size and positions specified
  111.             from the configuration form. Once this window is displayed you 
  112.             edit the text for that help context. 
  113.                While this edit window is open pressing ESCAPE will prompt
  114.             you to save any changes to the current help context and return
  115.             context to context list. The F10 key is also enabled in this
  116.             window to allow you to import text from an ASCII file.
  117.  
  118.             Importing Text:
  119.                Pressing F10 while editing a help context window presents a
  120.                text box prompting you for the name of the file to import
  121.                text from. While this text box is displayed pressing 
  122.                <Grey+> will bring up a list of all files in the current
  123.                directory, you may select a file from this list. Pressing 
  124.                enter to accept the import file name will open the file in an
  125.                window which overlaps the current help context window.
  126.  
  127.                To import text mark the area you wish to import, by pressing
  128.                the F5 key to begin the mark and then moving the highlighted 
  129.                area over the entire region you want to import. Pressing DEL
  130.                cuts the marked area to the scrap buffer. No changes are
  131.                made to the file that you are importing from. If you want to
  132.                reinsert the text you just cut simply hit INS, this will not
  133.                flush the scrap buffer.
  134.  
  135.                Pressing ESC will put you back into the help context window.
  136.                After positioning the cursor to the location where you want to
  137.                import the text press INS to import the text from the scrap
  138.                buffer.
  139.  
  140.                The Help Librarian makes no attempt to reformat the
  141.                imported text. There is also no conversion carried out on
  142.                any characters in the imported text. You will find that
  143.                TAB characters are not expanded. If you attempt to open
  144.                a file that is not ASCII no allowances are made for any
  145.                special characters that may be in that file.
  146.  
  147.