There are many good examples on PLaneT. For me, the 'best practice' depends on the complexity of the collection I am documenting - e.g., a single module or something more complex. My UUID package (<a href="http://planet.racket-lang.org/display.ss?package=uuid.plt&owner=williams">http://planet.racket-lang.org/display.ss?package=uuid.plt&owner=williams</a>) is a single module and I have a single uuid.scrbl file for the Scribble documentation. My science collection (<a href="http://planet.racket-lang.org/display.ss?package=science.plt&owner=williams">http://planet.racket-lang.org/display.ss?package=science.plt&owner=williams</a>) has many modules and it has a scribblings directory (with an image subdirectory) with a scrbl file for each chapter in the documentation - with multi-page specified in the info.rkt file. All of my packages follow one or the other of those formats. Others on the mailing list may have different strategies that they follow.<br>
<br>If you put your collection on PLaneT (<a href="http://planet.racket-lang.org/">http://planet.racket-lang.org/</a>), the HTML files are automatically generated (in a planet-docs subdirectory) and are available to the user from the search facility once they have been downloaded - via an appropriate require form. [You can also view them on-line. For example, the UUID package documentation is at <a href="http://planet.racket-lang.org/package-source/williams/uuid.plt/1/2/planet-docs/uuid/index.html">http://planet.racket-lang.org/package-source/williams/uuid.plt/1/2/planet-docs/uuid/index.html</a> and the science collection documentation is at <a href="http://planet.racket-lang.org/package-source/williams/science.plt/3/10/planet-docs/science/index.html">http://planet.racket-lang.org/package-source/williams/science.plt/3/10/planet-docs/science/index.html</a>.] <br>
<br>For more information, look at the PLaneT documentation (<a href="http://docs.racket-lang.org/planet/index.html">http://docs.racket-lang.org/planet/index.html</a>) or in the Help Desk. And, browse the PLaneT packages for documentation styles you like and look at their scrbl files.<br>
<br>Doug<br><br><div class="gmail_quote">On Sun, Dec 12, 2010 at 1:17 AM, Mark Carter <span dir="ltr"><<a href="mailto:mcturra2000@yahoo.co.uk">mcturra2000@yahoo.co.uk</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
My personal module is coming together, and I would like to write some<br>
documentation for it. Scribble seems the way to go, but I don't really know how<br>
to tackle the problem. What's the best practise? Create a folder called<br>
scribblings and write scrbl files within it? Is there a way that the html is<br>
then autogenerated and available from the search facility of DrRacket?<br>
<br>
<br>
<br>
<br>
_________________________________________________<br>
For list-related administrative tasks:<br>
<a href="http://lists.racket-lang.org/listinfo/users" target="_blank">http://lists.racket-lang.org/listinfo/users</a><br>
</blockquote></div><br>