ftp.nice.ch/pub/next/unix/developer/helpfilebuilder.1.0.README

This is the README for helpfilebuilder.1.1.NIH.b.tar.gz [Download] [Browse] [Up]

This is the README for helpfilebuilder 1.0, a useful tool to build helpfiles
for NEXTSTEP programs.  This command-line utility reads an application's
main nib file which contains the menus and creates an RTFD for each menu
item. These RTFD's will look just like the ones in Workspace or Edit.

The files for leaf menu cells (commands) will contain the following:
1: command name
2: menu path picture
3: separator lines and the string "See also"
4: links to next, previous and parent menupages 

The filenames for commands are: commandname.cmd.rtfd.

The files for branch menu cells (menus) will contain the following:
1: command name
2: menu path picture
3: picture of all the submenus with links to the corresponding
   helpfiles
3: separator lines and the string "See also"
4: links to next, previous and parent menupages 

The filenames for menus are: menuname.mn.rtfd.

The program also generates a TOC (Table Of Contents) file. 

Recommended usage:
1: Create a help directory in your project using ProjectBuilder's
   "Add Help Directory" command. The newly created directory
   will alredy contain a Table Of Contents and an Index file.
2: run helpfilebuilder the following way:
   >helpfilebuilder English.lproj/Main.nib Helpdirectory
3: Paste everything from the TOC file into the Table Of Contents file.
4: At this point type the descriptions of the menus into the helpfiles,
   and create any extra links and help pages you may need.
5: Open the HelpBuilder panel in Interface Builder and make the
   connections between the menus and the help pages.

Supported Architectures: m68k,i386 and hppa
OS version: helpfilebuilder was built on NS 3.2 and it has been
   verified to be working on NS 3.1. 

Limitations: helpfilebuilder creates helpfiles for the menus only.

helpfilebuilder 1.0 was written by Robert Vasvari with some helpful
suggestions from Eric P. Scott and Lee Worden.
The work was sponsored by Filoli Information Systems of Palo Alto, CA.

Licensing:

  helpfilebuilder is a copyrighted work, distributed free of charge
  for personal, educational, and commercial use.  It may not
  be sold for profit, nor incorporated in products sold for
  profit without the express permission of the author.  However,
  recognized NeXT User Groups may include it on diskettes, tapes,
  CD-ROMs, or other media priced above time-and-materials costs
  for fundraising purposes.  This software may be placed on
  Internet archive sites or other public software archives
  provided that no "download" or other "enhanced services"
  charges are assessed for access.

  Only a nonexclusive license to use is granted; all other rights
  are retained by the copyright holder.

  Please do not redistribute modified versions of this package.



Author's address:

	Robert Vasvari
	<vrobi@ernie.sfsu.edu> (NeXT Mail discouraged)

	Feel free to drop me a line with any requests, suggestions
	or bug reports. If you use this program, I WOULD LIKE TO 
	HEAR FROM YOU!
	
	Enjoy!!...
	

These are the contents of the former NiCE NeXT User Group NeXTSTEP/OpenStep software archive, currently hosted by Netfuture.ch.