[squeak-dev] Re: attaching external documentation to package
Pascal Vollmer
pascal.vollmer at nexgo.de
Mon Feb 7 21:56:00 UTC 2011
Ralph Boland <rpboland <at> gmail.com> writes:
>
> I want to create some documentation for a Squeak package I am writing.
> The documentation will be in the form of a Lyx file. Since some
Hi Ralph,
You could use the class comment to shelter your documentation. Another place
could be a method.
I have made some experiments with both. You may have a look at the class
AnalogClockProjectManual in http://www.squeaksource.com/AnalogClock.html.
>From LyX you could export "simple text". I do almost the same. I use DocBook and
from there I generate 1) HTML, 2) PDF or 3) ASCII.
It could be interesting to have a look at http://www.methods.co.nz/asciidoc/ and
at http://daringfireball.net/projects/markdown/.
Kind regards,
Pascal
More information about the Squeak-dev
mailing list
|