A couple things related to scribble for user documentation:<br><br>1. Is there a pdf version of the scribble manual?<br><br>2. Is there a good way yet to include graphics in scribbled documents?&nbsp; I haven&#39;t looked at the manual in a couple months, but it wasn&#39;t obvious back then and no one came forward with any suggestions on the mailing list at the time.
<br><br>3. Are there any plans for equation rendering? <br><br>4. How will scribblings be used by PLaneT?&nbsp; And, what will be the best way to transition our documentation for the transition to V4?<br><br>Doug<br><br><div class="gmail_quote">
On Jan 7, 2008 8:31 AM, Matthew Flatt &lt;<a href="mailto:mflatt@cs.utah.edu">mflatt@cs.utah.edu</a>&gt; wrote:<br><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
The three most important improvements in PLT Scheme v4 will be:<br><br>&nbsp;1. documentation (better organized)<br><br>&nbsp;2. documentation (more readable &quot;guides&quot; and examples)<br><br>&nbsp;3. documentation (better integration with tools like DrScheme)
<br><br>There are also some languages changes, such as the library<br>reorganization and keyword arguments, but mostly those are in the<br>service of better documentation.<br><br>The new core documentation is starting to come together. The
<br>`scheme/base&#39;, `scheme&#39;, and `scheme/gui&#39; languages are fairly<br>thoroughly documented, for example, as are Scribble itself, the FFI,<br>and Inside PLT Scheme. We have plenty of work to do on the guide, but
<br>that can improve and evolve after we get the reference documentation in<br>place.<br><br>One big remaining task is all of the &quot;doc.txt&quot; files --- former<br>second-class citizens that need to ported as fully fledged, scribbled
<br>parts of the PLT documentation. We have considered trying to fit<br>&quot;doc.txt&quot; files into the new documentation system, but it&#39;s awkward.<br>Anyway, we want *good* documentation for everything, and that means
<br>scribbling it.<br><br><br>We could use your help scribbling &quot;doc.txt&quot; files!<br><br>See<br><br> &nbsp;<a href="http://www.cs.utah.edu/%7Emflatt/tmp/doc-to-do.txt" target="_blank">http://www.cs.utah.edu/~mflatt/tmp/doc-to-do.txt
</a><br><br>for a list of things to be done. This is not a complete list; it&#39;s a<br>list of documents that could easily be ported by someone other than the<br>authors of the relevant libraries (who are either no longer active or
<br>have plenty of other documents to port).<br><br><br>Here&#39;s how you can help:<br><br>&nbsp;* Pick a document (some are easier than others) that doesn&#39;t yet have<br> &nbsp; a name next to it, and send mail to claim it as your responsibility.
<br><br> &nbsp; I recommend replying to this message and keeping the plt-scheme list<br> &nbsp; cc&#39;ed, but if you&#39;re a bit shy (I would be), you can send mail<br> &nbsp; directly to me, and I&#39;ll quietly add your name next to a choice.
<br><br>&nbsp;* Read the Scribble manual:<br><br> &nbsp; &nbsp; <a href="http://pre.plt-scheme.org/docs/html/scribble/" target="_blank">http://pre.plt-scheme.org/docs/html/scribble/</a><br><br> &nbsp; Chapter 1 will get you started, but you&#39;ll likely need to read
<br> &nbsp; through Chapter 3. Pay attention to the style guide at the end of<br> &nbsp; Chapter 1:<br><br> &nbsp; &nbsp; <a href="http://pre.plt-scheme.org/docs/html/scribble/" target="_blank">http://pre.plt-scheme.org/docs/html/scribble/</a>
<br> &nbsp; &nbsp; How_to_Scribble_Documentation.html#(part~20reference-style)<br><br> &nbsp; There are lots of examples in the &quot;scribblings&quot; collection, which is<br> &nbsp; where the core doc sources reside.<br><br>&nbsp;* Port the &quot;
doc.txt&quot; to &quot;doc/manual.scrbl&quot;. You can call<br> &nbsp; &quot;manual.scrbl&quot; whatever you want, but &quot;manual.scrbl&quot; is a good<br> &nbsp; default, especially for single-file sources. Use multiple files<br>
 &nbsp; (with `include-section&#39;) if you think it&#39;s appropriate.<br><br> &nbsp; You&#39;ll need an &quot;info.ss&quot; file in your &quot;doc&quot; sub-collection so that<br> &nbsp; `setup-plt&#39; will build the document. See &quot;mrlib/doc/info.ss&quot; for an
<br> &nbsp; example.<br><br>&nbsp;* Re-read the style guide after you&#39;ve scribbled. Probably you&#39;ll<br> &nbsp; notice things the second time around that affect the text that you<br> &nbsp; wrote or ported.<br><br>&nbsp;* E-mail me your scribblings as &quot;
doc.tgz&quot; or &quot;doc.zip&quot;. I will likely<br> &nbsp; edit for content and style, but you will have saved us a huge amount<br> &nbsp; of time by getting it mostly in shape --- and thus help get v4 out<br> &nbsp; the door sooner.
<br><br>Your reward will be a hearty &quot;thanks!&quot; from the PLT Scheme community, a<br>place in an acknowledgments section, and the satisfaction of knowing<br>that you&#39;ve done your part.<br><br>Longer term, we welcome contributions in the form of high-level
<br>explanations and examples to complement the reference documentation.<br>For now, moving over the old documentation is our most pressing need.<br><br>Thanks,<br>Matthew<br><br>_________________________________________________
<br> &nbsp;For list-related administrative tasks:<br> &nbsp;<a href="http://list.cs.brown.edu/mailman/listinfo/plt-scheme" target="_blank">http://list.cs.brown.edu/mailman/listinfo/plt-scheme</a><br></blockquote></div><br>