[plt-scheme] Scribble 2.0

From: Matthew Flatt (mflatt at cs.utah.edu)
Date: Sun Jul 26 09:00:47 EDT 2009

If you're interested in Scribble and you haven't tried it, or if you
found the old documentation and tools opaque, try the new introduction:


Some core data structures have changed, but a major focus of the new
Scribble is making it simpler to use and providing a better
introduction --- especially for uses of Scribble other than PLT Scheme

[The changes will not be part of the upcoming 4.2.1 release, but
 they're available now through SVN or the nightly build. The September
 release will include the changes.]

If you're using Scribble already for library documentation, your
Scribble code probably still works, especially if you didn't import
`scribble/struct'. Even if you did import `scribble/struct', it might
still work; `scribble/struct' is now a compatibility library. (If it
doesn't work, let me know.) If you revise your documentation, the
recommended way to start the document module is now

   #lang scribble/manual

If you were using Scribble to produce other kinds of Latex-based
documents where you replaced the prefix and/or style file, then your
document will almost certainly break with the new version. But things
will get better and more automatic from now on. For example, if you
want to write a paper in the SIGPLAN conference format, just start your
document with

   #lang scribble/sigplan

and then `scribble --pdf' will do the right thing.

Finally, if you're reading Scribble-produced documentation and
something in the formatting seems to have regressed, let me know.

Posted on the users mailing list.