[plt-scheme] Re: package documentation

From: Will M Farr (farr at MIT.EDU)
Date: Tue Apr 3 09:16:47 EDT 2007

If you want to generate keyword and index entries automatically from  
a LaTeX document, have a look at the plt documentation source (you  
can find it at http://pre.plt-scheme.org/docs/ ).  I just discovered  
this over the weekend, and it's a treasure trove of LaTeX macros and  
scheme scripts that let you produce manuals which use tex2page and  
look just like PLT's, including the proper indexes and keywords.  The  
DocSystem file is the place to start for a basic description.

By the way, I had to swap the arguments to the cmp function in  
"iterate-tex2page.scm" script from the docs to avoid an infinite  
loop.  I don't know if PLT uses this script any more, but maybe they  
use it differently than I did, or else they just haven't noticed the  

Good luck!


On Apr 3, 2007, at 5:29 AM, Jose A. Ortega Ruiz wrote:

> "Jacob Matthews" <jacobm at cs.uchicago.edu>
> writes:
>> On 4/2/07, Jose A. Ortega Ruiz <jao at gnu.org> wrote:
>> 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
> Excellent. Thanks for the tip.
>> 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).
> I see. I had the impression that keyword search was a more or less
> automated feature for users of tex2page (or plain text doc.txt), but i
> see i should take a closer look at the documentation.
>>> On a related note, i've tried to create a user on PLaneT, but  
>>> have not
>>> received the confirmation email after some 12 hours... is that  
>>> normal?
>> No. Every time I've had PLaneT mail me since moving to the new server
>> the response has been immediate. Maybe the confirmation email got
>> caught up in a spam filter somewhere?
> Maybe. I haven't been able to locate it, though. Should i just try to
> re-register with the same login?
> Thanks again,
> jao
> -- 
> "Light thinks it travels faster than anything but it is wrong. No  
> matter
>  how fast light travels it finds the darkness has always got there  
> first,
>  and is waiting for it." - Terry Pratchett, Reaper Man
> _________________________________________________
>   For list-related administrative tasks:
>   http://list.cs.brown.edu/mailman/listinfo/plt-scheme

Posted on the users mailing list.