@adam<br><br>Yes, agreed about the Max/MSP docs. The best i've come across for synthesis software. Extended UGen documentation with examples would be excellent.<br><br>Looking forward to helping out with the FLOSS manuals stuff. Thanks for your work!<br>
<br><div class="gmail_quote">On Thu, Dec 3, 2009 at 7:17 PM, Adam Tindale <span dir="ltr"><<a href="mailto:adamtindale@hotmail.com">adamtindale@hotmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
Currently the examples are hard coded in. This has problems, as we all<br>
know, but it is the best system we have for now. I am not too worried<br>
about it. I have a vision...<br>
<br>
Does everyone know the Max/MSP manuals? They are amazing. I have a<br>
dream that every UGEN has a page or two to itself where all the inputs<br>
and outputs are explained and there is a UGEN specific example in the<br>
docs that makes it clear how the features work. I know we can do this!<br>
I would love to get a start on it during the sprint. Even if we<br>
documented the .sync feature of UGENs more I would be happy with that<br>
as a start.<br>
<br>
FLOSS manuals has started a page for us. It looks like the system for<br>
us. They have an API for putting the manual to print and giving more<br>
control. It is a bit young but I think we can do some feature requests<br>
and have it grow with us.<br>
<br>
I will start preparing the manual for upload and start roughing it on<br>
their site.<br>
<br>
--art<br>
<br>
2009/12/2 Tomasz Kaye's brain <<a href="mailto:tomasz.brain@gmail.com">tomasz.brain@gmail.com</a>>:<br>
<div><div></div><div class="h5">> @Michael: I'm pretty confident that FLOSS Manuals doesn't have such a<br>
> dynamic code importing capability, or support for variables or dynamic<br>
> substitutions in general. So with FLOSS, code snippets would be 'hard coded'<br>
> into the documentation (I assumed that it was currently this way with the<br>
> LaTeX docs too, is that right Adam?).<br>
><br>
> On Wed, Dec 2, 2009 at 4:43 PM, Michael Heuer <<a href="mailto:heuermh@gmail.com">heuermh@gmail.com</a>> wrote:<br>
>><br>
>> Tomasz Kaye's brain <<a href="mailto:tomasz.brain@gmail.com">tomasz.brain@gmail.com</a>>:<br>
>><br>
>> >> Michael - excellent suggestion. FLOSS Manuals seems to have a facility<br>
>> >> for including code easily. Has anyone tried putting ChucK code in to<br>
>> >> see if it barfs on it?<br>
>> ><br>
>> > ...<br>
>> > I entered some ChucK code into a <pre> element. That seemed to work fine<br>
>> > in<br>
>> > the preview. Though probably needs more testing (for instance, do long<br>
>> > lines<br>
>> > inside a <pre> element automatically wrap in PDF export? my suspicion is<br>
>> > that they might not).<br>
>><br>
>> Does FLOSS manuals have an import mechanism? This would be essential<br>
>> for keeping the ChucK examples/snippets separate from the<br>
>> documentation itself.<br>
>><br>
>> For instance, in APT documentation format<br>
>><br>
>> <a href="http://maven.apache.org/doxia/references/apt-format.html" target="_blank">http://maven.apache.org/doxia/references/apt-format.html</a><br>
>><br>
>> there is a snippet macro<br>
>><br>
>> <a href="http://maven.apache.org/doxia/macros/index.html#Snippet_Macro" target="_blank">http://maven.apache.org/doxia/macros/index.html#Snippet_Macro</a><br>
>><br>
>> michael<br>
>> _______________________________________________<br>
>> chuck-users mailing list<br>
>> <a href="mailto:chuck-users@lists.cs.princeton.edu">chuck-users@lists.cs.princeton.edu</a><br>
>> <a href="https://lists.cs.princeton.edu/mailman/listinfo/chuck-users" target="_blank">https://lists.cs.princeton.edu/mailman/listinfo/chuck-users</a><br>
><br>
><br>
> _______________________________________________<br>
> chuck-users mailing list<br>
> <a href="mailto:chuck-users@lists.cs.princeton.edu">chuck-users@lists.cs.princeton.edu</a><br>
> <a href="https://lists.cs.princeton.edu/mailman/listinfo/chuck-users" target="_blank">https://lists.cs.princeton.edu/mailman/listinfo/chuck-users</a><br>
><br>
><br>
_______________________________________________<br>
chuck-users mailing list<br>
<a href="mailto:chuck-users@lists.cs.princeton.edu">chuck-users@lists.cs.princeton.edu</a><br>
<a href="https://lists.cs.princeton.edu/mailman/listinfo/chuck-users" target="_blank">https://lists.cs.princeton.edu/mailman/listinfo/chuck-users</a><br>
</div></div></blockquote></div><br>