home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-2.iso / Unix / developer / helpfilebuilder.1.0.README < prev    next >
Encoding:
Text File  |  1994-10-21  |  2.9 KB  |  80 lines
  1.  
  2. This is the README for helpfilebuilder 1.0, a useful tool to build helpfiles
  3. for NEXTSTEP programs.  This command-line utility reads an application's
  4. main nib file which contains the menus and creates an RTFD for each menu
  5. item. These RTFD's will look just like the ones in Workspace or Edit.
  6.  
  7. The files for leaf menu cells (commands) will contain the following:
  8. 1: command name
  9. 2: menu path picture
  10. 3: separator lines and the string "See also"
  11. 4: links to next, previous and parent menupages 
  12.  
  13. The filenames for commands are: commandname.cmd.rtfd.
  14.  
  15. The files for branch menu cells (menus) will contain the following:
  16. 1: command name
  17. 2: menu path picture
  18. 3: picture of all the submenus with links to the corresponding
  19.    helpfiles
  20. 3: separator lines and the string "See also"
  21. 4: links to next, previous and parent menupages 
  22.  
  23. The filenames for menus are: menuname.mn.rtfd.
  24.  
  25. The program also generates a TOC (Table Of Contents) file. 
  26.  
  27. Recommended usage:
  28. 1: Create a help directory in your project using ProjectBuilder's
  29.    "Add Help Directory" command. The newly created directory
  30.    will alredy contain a Table Of Contents and an Index file.
  31. 2: run helpfilebuilder the following way:
  32.    >helpfilebuilder English.lproj/Main.nib Helpdirectory
  33. 3: Paste everything from the TOC file into the Table Of Contents file.
  34. 4: At this point type the descriptions of the menus into the helpfiles,
  35.    and create any extra links and help pages you may need.
  36. 5: Open the HelpBuilder panel in Interface Builder and make the
  37.    connections between the menus and the help pages.
  38.  
  39. Supported Architectures: m68k,i386 and hppa
  40. OS version: helpfilebuilder was built on NS 3.2 and it has been
  41.    verified to be working on NS 3.1. 
  42.  
  43. Limitations: helpfilebuilder creates helpfiles for the menus only.
  44.  
  45. helpfilebuilder 1.0 was written by Robert Vasvari with some helpful
  46. suggestions from Eric P. Scott and Lee Worden.
  47. The work was sponsored by Filoli Information Systems of Palo Alto, CA.
  48.  
  49. Licensing:
  50.  
  51.   helpfilebuilder is a copyrighted work, distributed free of charge
  52.   for personal, educational, and commercial use.  It may not
  53.   be sold for profit, nor incorporated in products sold for
  54.   profit without the express permission of the author.  However,
  55.   recognized NeXT User Groups may include it on diskettes, tapes,
  56.   CD-ROMs, or other media priced above time-and-materials costs
  57.   for fundraising purposes.  This software may be placed on
  58.   Internet archive sites or other public software archives
  59.   provided that no "download" or other "enhanced services"
  60.   charges are assessed for access.
  61.  
  62.   Only a nonexclusive license to use is granted; all other rights
  63.   are retained by the copyright holder.
  64.  
  65.   Please do not redistribute modified versions of this package.
  66.  
  67.  
  68.  
  69. Author's address:
  70.  
  71.     Robert Vasvari
  72.     <vrobi@ernie.sfsu.edu> (NeXT Mail discouraged)
  73.  
  74.     Feel free to drop me a line with any requests, suggestions
  75.     or bug reports. If you use this program, I WOULD LIKE TO 
  76.     HEAR FROM YOU!
  77.     
  78.     Enjoy!!...
  79.     
  80.