[plt-scheme] package documentation

From: Williams, M. Douglas (M.DOUGLAS.WILLIAMS at saic.com)
Date: Tue Apr 3 09:20:06 EDT 2007

Jacob,

>HTML docs are now listed as documentation on PLaneT right alongside
>doc.txt files; currently only one package:
>
>http://planet.plt-scheme.org/users/sweeney/sqlid-helper.plt/
>
>uses this feature. The way you get this to show up is by setting the
>now-misnamed "doc.txt" field in your info.ss file to point to the root
>of your documentation. (This is a new behavior; prior to yesterday
>doc.txt fields that weren't to files named doc.txt were ignored.) I
>think that most people opt to use doc.txt files rather than HTML
>documentation just because it's much easier to work with (and in
>particular it's easier to generate a doc.txt file that the Help Desk
>knows how to search in a reasonable way).

For those of us with both a short doc.txt and more extensive HTML
documentation (i.e., reference manuals that get loaded into the Help
Desk), what is the best way to make use of this new feature?

Doug


Posted on the users mailing list.