home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-2.iso / Unix / developer / HelpBuilder.1.3.README < prev    next >
Encoding:
Text File  |  1995-09-29  |  5.1 KB  |  134 lines
  1. This is the README for HelpBuilder 1.3, a useful tool to build helpfiles
  2.     for NEXTSTEP programs.  This command-line utility reads an application's
  3.     main nib file which contains the menus and creates an RTFD for each menu
  4.     item. These RTFD's will look just like the ones in Workspace or Edit.
  5.  
  6. Changes since 1.0:
  7.     1: better handling of errors.
  8.     2: HelpBuilder now fills in the text portion in all of the standard
  9.            menus. The text is configurable by altering the
  10.            Language_helpfile.strings file.
  11.     3: language support.
  12.     4: HelpBuilder now comes in a bundle (as opposed to a single file).
  13.  
  14. Changes since 1.1:
  15.     1:    On the menu pages the paragraphs for the menu items align
  16.         correctly.
  17.     2:  the images for solid and dashed lines are in the file
  18.         package, as opposed to be in the executable file. They
  19.         can now be replaced by anything the user wants.
  20.     3:  Inside the rtfd directories, the image files are .eps instead
  21.         of .tiff. They will draw better on any system
  22.     4:  the menubars now draw correctly.
  23.     5:  -f (force) option is added. If used, Helpbuilder will delete
  24.         the output directory if it exists, without warning.
  25.     6:    HelpBuilder is distributed quad fat.
  26.     7:    The RTFD's are organized in a directory structure. Each
  27.         submenu has its own directory for the menu items in its 
  28.         subtree.
  29.     
  30. The filename for the main menu:progname.main.rtfd.
  31.  
  32. The files for leaf menu cells (commands) will contain the following:
  33.     1: command name
  34.     2: menu path picture
  35.     3: separator lines and the string "See also"
  36.     4: links to next, previous and parent menupages 
  37.  
  38. The filenames for commands are: commandname.cmd.rtfd.
  39.  
  40. The files for branch menu cells (menus) will contain the following:
  41.     1: command name
  42.     2: menu path picture
  43.     3: picture of all the submenus with links to the corresponding
  44.         helpfiles
  45.     3: separator lines and the string "See also"
  46.     4: links to next, previous and parent menupages 
  47.  
  48. The filenames for menus are: menuname.mn.rtfd.
  49.  
  50. The program also generates a TOC (Table Of Contents) file. 
  51.  
  52. Installation: make sure to leave the supplied directory intact, since
  53.     HelpBuilder will look for the stringfile in the same directory.
  54.     For additional languages, add the language_helpfile.strings file into
  55.     the same directory.
  56.  
  57. Recommended usage:
  58. 1:     Create a help directory in your project using ProjectBuilder's
  59.     "Add Help Directory" command. The newly created directory
  60.     will alredy contain a Table Of Contents and an Index file.
  61. 2:     run HelpBuilder the following way:
  62.        >HelpBuilder -o Helpdirectory English.lproj/Main.nib 
  63. 3:     Paste everything from the TOC file into the Table Of Contents file.
  64. 4:     At this point type the descriptions of the menus into the helpfiles,
  65.       and create any extra links and help pages you may need.
  66. 5:     Open the HelpBuilder panel in Interface Builder and make the
  67.        connections between the menus and the help pages.
  68.     
  69. Language support:
  70.     if the "-l Language" option is not used, HelpBuilder will
  71.     default to English. English and German stringtable files are provided. 
  72.     To make helpfiles in german invoke the program like this:
  73.        >HelpBuilder -l German -o Helpdirectory English.lproj/Main.nib 
  74.     
  75.     In this case HelpBuilder will use the German_helpfile.strings file.
  76.     VOLUNTEERS needed to provide equivalent files in Swedish, Italian,
  77.     French, Spanish, etc...
  78.     
  79.  
  80. WARNING: if the output directory already exist, it will be COMPLETELY
  81.     BLOWN AWAY, and replaced by the new one. Do not try to use 
  82.     HelpBuilder on a directory that already contains files you
  83.     want to keep.
  84.  
  85. Supported Architectures: m68k,i386 and hppa
  86. OS version: HelpBuilder was built on NS 3.2 and it has been
  87.        verified to be working on NS 3.1. 
  88.  
  89. Limitations: HelpBuilder creates helpfiles for the menus only.
  90.  
  91. HelpBuilder 1.0 was written by Robert Vasvari with some helpful
  92.     suggestions from Eric P. Scott and Lee Worden.
  93.     The work was sponsored by Filoli Information Systems of Palo Alto, CA.
  94.  
  95. Licensing:
  96.  
  97.     HelpBuilder is a copyrighted work, distributed free of charge
  98.     for personal, educational, and commercial use.  It may not
  99.     be sold for profit, nor incorporated in products sold for
  100.     profit without the express permission of the author.  However,
  101.     recognized NeXT User Groups may include it on diskettes, tapes,
  102.     CD-ROMs, or other media priced above time-and-materials costs
  103.     for fundraising purposes.  This software may be placed on
  104.     Internet archive sites or other public software archives
  105.     provided that no "download" or other "enhanced services"
  106.     charges are assessed for access.
  107.  
  108.     Only a nonexclusive license to use is granted; all other rights
  109.     are retained by the copyright holder.
  110.  
  111.     Please do not redistribute modified versions of this package.
  112.  
  113. Known Bugs:
  114.     If the nib file contains a DBModule, HelpBuilder will be 
  115.     unable to process it (there could be other things, currently
  116.     unknown to me that also blow up HelpBuilder).
  117.     Workaround: copy the main menu from your nib into a new nib
  118.     file and use that to generate the help pages.
  119.  
  120. Usage tip: do not forget to run "ixbuild -v" in the Help directory 
  121.     just before building your project.
  122.     
  123.  
  124. Author's address:
  125.  
  126.     Robert Vasvari
  127.     <vrobi@ddrummer.com> (NeXT Mail OK)
  128.  
  129.     Feel free to drop me a line with any requests, suggestions
  130.     or bug reports.
  131.     
  132.     Enjoy!!...
  133.         
  134.