CMU Artificial Intelligence Repository
Home INFO Search FAQs Repository Root

User Manual: Automatical User Manual Creation

The Automatic User Manual Creation system is a portable system for automatically generating user's guides from the source definitions and their documentation strings. It uses several heuristics for formatting the documentation segments nicely. It can produce text (ASCII), Scribe, and LaTeX output. If Waters' XP pretty printer is available, it uses that instead to format the argument lists.

   CMU Lisp Repository (home location)

Version: 2.0 (20-OCT-94) Ports: Portable. Tested in CMU CL, MCL, Allegro CL, and Lucid CL. Copying: Copyright (c) 1990 by Mark Kantrowitz. Use, copying, modification and distribution permitted. Updated: Thu Oct 20 20:28:57 1994 CD-ROM: Prime Time Freeware for AI, Issue 1-1 Bug Reports: Mailing List: Author(s): Mark Kantrowitz Keywords: Authors!Kantrowitz, CMU, Lisp!Tools, User Manual Creation References: Documentation of the tools written by Mark Kantrowitz (Metering, Defsystem, Source Compare, User Manual, and Xref) appears in Mark Kantrowitz, "Portable Utilities for Common Lisp, User Guide and Implementation Notes", Tech Report CMU-CS-91-143, School of Computer Science, Carnegie Mellon University, May 1991. which is available as lang/lisp/code/tools/mkantdoc.tar.gz. The user guide for the program is included at the top of the source file. It was created using this program and provides a good example of its capabilities. It was created by evaluating (create-user-manual "user-manual.lisp").
Last Web update on Mon Feb 13 10:30:56 1995