[plt-scheme] Re: how do you include documentation with a teachpack or planet collection?

From: Robby Findler (robby at cs.uchicago.edu)
Date: Thu Aug 14 23:26:18 EDT 2008

No, there isn't a better way than that, I'm sorry to say. And your
script should probably make sure it has permissions to write to that
directory or else it will fail for some folks.

We do plan to go back to something more like the standard file dialog
for teachpacks and also to emphasize using `require' directly, but
that's not something we've done yet.

Robby

On Thu, Aug 14, 2008 at 9:53 PM, Stephen Bloch <sbloch at adelphi.edu> wrote:
>
> On Aug 14, 2008, at 1:32 PM, Noel Welsh wrote:
>
>> I'm rushing out, so in brief, to create a PLaneT package:
>>
>>  - put your docs in a directory called scribblings (doesn't really
>> matter, but this is the convention)
>>  - see the Planet docs for details of what to put in your info.ss, or
>> read, say, the SchemeUnit info.ss which you see on
>> planet.plt-scheme.org
>>  - use
>>      planet create <directory-name>
>>   to create a PLT
>
> Thanks.  I've found and read some more documentation, and both it and the
> above message are helping.  In particular, I've created a .plt package,
> installed it, and the Help Desk can now find my documentation.  Yay!
>
> Is there a way to control WHERE the package gets unpacked?  Ideally, I'd
> like it to show up in the "installed-teachpacks" directory, rather than (or
> in addition to) the PLaneT cache directory, so my students only have to type
> the "(require ...)" thing once, after which they can just use "Add
> Teachpack".
>
> I tried putting a few lines at the end of the module that check in the
> "installed-teachpacks" directory for a file with the same name as
> (this-expression-file-name), and if it's not there, copies the current
> source file to that directory... but there MUST be a better way than that!
>
> Stephen Bloch
> sbloch at adelphi.edu
>
>
>
> _________________________________________________
>  For list-related administrative tasks:
>  http://list.cs.brown.edu/mailman/listinfo/plt-scheme
>
>


Posted on the users mailing list.