I have a basic version of the script for generating website docs in /ci/www/projects/swift/guides. It works in a pretty similar way to what we have now - the documents must manually be copied to asciidocs/docs/<release>/*.txt and then the script converts the txt files to html and pdf. Instead of having to copy the files manually, I think the next step would be to have it generate these from releases using svn. I will add this to the wiki once it gets a little more finalized. I am also working on some improvements to the documents themselves. The asciidoc version of the tutorial brings in the contents of external .swift scripts when generating the html. Changes to the example scripts should automatically be referenced in the tutorial. I will also try add something like dynamically generating the properties into the user guide as was suggested, as well as other various clean up and fixes.<div>
<br></div><div>David<br><div><div><br></div><div class="gmail_quote">On Wed, May 4, 2011 at 6:33 PM, Michael Wilde <span dir="ltr"><<a href="mailto:wilde@mcs.anl.gov">wilde@mcs.anl.gov</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
<div><div style="font-family:Times New Roman;font-size:12pt;color:#000000">Nice job, David!  This really looks great. Awesome, in fact, for a first cut.<div><br></div><div>One thing that jumped out at me: in the swift.properties section:</div>
<div><br></div><div>- the actual descriptions should be in plain text, not fixed width text</div><div><br></div><div>- to keep the descriptions in sync with the sample/default swift.properties file in etc/, perhaps the sample file could be coded in such a way that we can grep the properties out in a "doc build" process that runs as part of ant or make, and automatically include them in the users guide.</div>
<div><br></div><div>- Perhaps move the properties to an appendix rather than a chapter - the chapter could just talk about how to manage properties, and what the general "families" of properties are.</div><div><br>
</div><div>Mike</div><div><br><br><hr><div class="im"><blockquote style="border-left:2px solid rgb(16, 16, 255);margin-left:5px;padding-left:5px">Hello,<div><br></div><div>I just finished the preliminary version of the user guide in asciidoc. It is at <a href="http://www.ci.uchicago.edu/~davidk/userguide.html" target="_blank">http://www.ci.uchicago.edu/~davidk/userguide.html</a>. The asciidoc source is at <a href="http://www.ci.uchicago.edu/~davidk/userguide.txt" target="_blank">http://www.ci.uchicago.edu/~davidk/userguide.txt</a>.</div>

<div><br></div><div>David</div><div><br></div>
</blockquote><br></div><font color="#888888"><span><br><br>-- <br><span name="x"></span>Michael Wilde<br>Computation Institute, University of Chicago<br>Mathematics and Computer Science Division<br>Argonne National Laboratory<br>
<span name="x"></span><br></span></font></div></div></div></blockquote></div><br></div></div>