[net.sources.mac] Documentation for PrettyPrint

shebanow@ernie.Berkeley.EDU (Mike Shebanow) (08/01/86)

(beware the line eater)

--------------------------------------------------------------------------
PrettyPrint Notes	    PrettyPrint Notes		PrettyPrint Notes
--------------------------------------------------------------------------

PrettyPrint and "PrettyPrint Notes" (this document) are:

(c) 1985, 1986 HyperSoft. All Rights Reserved.

--------------------------------------------------------------------------
About PrettyPrint
--------------------------------------------------------------------------

This document provides a brief introduction to PrettyPrint, a text file
printing utility. PrettyPrint, like many other programs which have been
distributed, allows users to print text files created with any editor
(including MacWrite, MDS Edit, MPW, and LightSpeedC) on the ImageWriter,
ImageWriter II, or LaserWriter. Unlike all of the other programs which
have been distributed, PrettyPrint can print your C and Pascal programs
in a much more readable format. Files printed by PrettyPrint can have
italicized comments, boldfaced keywords, and even boldfaced Macintosh trap
calls.

PrettyPrint is SHAREWARE: you are free to distribute this program to
your friends. Non-profit user groups may distribute this program on
their disks, provided it is accompanied by this file. Bulletin boards
and online services may make this program available for downloading,
provided that there are no special downloading charges. However, we do ask
all USERS register their copy of PrettyPrint, to help pay for development
costs.

As an incentive, users who register their copy of PrettyPrint will receive
a printed manual (much more extensive than this document), a copy of the
latest version of PrettyPrint, and a special configuration program which
lets you add your own keywords to those built into PrettyPrint. To
register your copy, send $25.00 (check or money order) to:

		HyperSoft
		2124 Kittredge Street #174
		Berkeley CA 94704

Thank you for making shareware possible!

--------------------------------------------------------------------------
How to use PrettyPrint
--------------------------------------------------------------------------

PrettyPrint is fairly easy to use. There are several menus: the Apple menu,
the File menu, the Edit menu, the Options Menu, the Font Menu, and the
FontSize menu. The more commonly used commands have command key
equivalents.

The Apple menu has an "About PrettyPrint..." item which prints some
version information, and the usual desk accessories.

The File menu has two commands, the "Print..." command and the "Quit"
command. The Print command allows you to select a single file to be
printed. The Quit command does you-know-what.

The Edit menu works with desk accessories only. It does the things you
would expect.

The Options menu contains many options which tailor PrettyPrint.

	"Print Header", allows a header to be printed at the
	top of each page.

	"Set Tab Width..." sets the default tab width.

	"Use Config Resource..."  tells PrettyPrint what information
	to use when printing a document. Text files created using
	MDS Edit, LightSpeedC, or MPW Shell have configuration resources
	stored within them which specify, among other things, the font,
	font size, and tab width. PrettyPrint can read these resources,
	and use the information when it prints a file. You can read just
	the tab width or just the font and font size, or you can read both.
	For printing on the ImageWriter, you should probably read both. On
	the LaserWriter, you should just read the tab size and use the
	Courier font.

	"C Pretty Printing..." enables and disables C language pretty
	printing. If this command has a check mark next to it, doing
	this command turns off C prettyprinting. If it doesn't have
	a checkmark, doing this command will bring up a dialog which lets
	you set tailor the pretty printing. To speed up pretty printing,
	turn off the two boldface options.

	"Pascal Pretty Printing..." enables and disables Pascal
	pretty printing. It works the same as the C Pretty Printing
	command.

The Font menu allows you to select the default font.

The FontSize menu allows you to select the default font size.

All defaults are saved across invocations, so you only need to set up
your favorite defaults once.

One thing to watch out for is that the C and Pascal pretty printing
can get confused if you leave it on while printing plain text or a
program written in a different language than the one you have selected.
Be sure to change the settings to match the file you are printing.

You can print many files at once by selecting PrettyPrint and the files
you would like to print and executing the Open command from the file menu.
PrettyPrint will print your files and then quit.

--------------------------------------------------------------------------
Bugs and Future Enhancements
--------------------------------------------------------------------------

  When pretty printing, columns do not always align correctly, even with
  a monospaced font. Italicicized and Bolded text takes up more space,
  so some lines end up being shifted to the right.

  The LaserWriter sometimes gives up the ghost in the middle of a document,
  returning a VERY strange error code. This is caused by an out of memory
  condition within the LaserWriter itself. No easy fix, since the bug is
  in the LaserWriter or the LaserWriter driver. Just try to print again,
  and everything should be ok.

  PrettyPrint should figure out what kind of document is being printed
  based on filename suffix (e.g., '.h' and '.c' are C files).

  PrettyPrint should wrap long lines around instead of just cutting them
  off in midstream.

The last two items will probably be added for the next update. Any
additional bug reports or suggestions are welcome.

--------------------------------------------------------------------------
--------------------------------------------------------------------------

Andrew Shebanow
(shebanow.ernie.Berkeley.edu)