What kind of Morphs do you want to document? All of them? Tools=20 (browsers, debuggers, etc)? Widgets (Pluggable*Morph, TextMorph,=20 etc.)? Basic (RectangleMorph, PolygonMorph)?
It depends how responsive the authors/experts are. Having the entire Morph Catalog (if not more) documented should be the goal before we iterate to 3.4 (to set an arbitrary deadline). It would be nice to have the majority of Tools, Scripting, Collaborative, Presentation, Multimedia, Navigation, and the less obvious morphs in Graphics and Text ready to publish some time before the US Thanksgiving holiday (the 21st or 28th of November...after that much of the world goes into holiday mode); again it depends on community response. The sooner people write the first drafts, the sooner I can begin testing and editing. I do have to warn everyone that I am going off the grid for the month of August.
Ultimately, the goal is document everything no matter how mundane or how official/unofficial.
Best--John
John Voiklis wrote:
What kind of Morphs do you want to document? All of them? Tools=20 (browsers, debuggers, etc)? Widgets (Pluggable*Morph, TextMorph,=20 etc.)? Basic (RectangleMorph, PolygonMorph)?
It depends how responsive the authors/experts are. Having the entire Morph Catalog (if not more) documented should be the goal before we iterate to 3.4 (to set an arbitrary deadline). It would be nice to have the majority of Tools, Scripting, Collaborative, Presentation, Multimedia, Navigation, and the less obvious morphs in Graphics and Text ready to publish some time before the US Thanksgiving holiday (the 21st or 28th of November...after that much of the world goes into holiday mode); again it depends on community response. The sooner people write the first drafts, the sooner I can begin testing and editing. I do have to warn everyone that I am going off the grid for the month of August.
Ultimately, the goal is document everything no matter how mundane or how official/unofficial.
Thanks for the initiative. Maybe a sort of guideline, or how the documentations should look, be used and be written is a good place to start. I know quite a few morphs and tools and can help document them but what kept me from doing this is having a good format, or some framework to put the documentation in. I would love to se some media rich and imaginative thinking go into how the documentation is made, and have the documentation show off a few of Squeaks qualities. But foremost we need some sort of standard so on can concentrate on the documentaiton writing.
Karl
Thanks for the initiative. Maybe a sort of guideline, or how the documentations should look, be used and be written is a good place to start.
For the first draft let's use a modified version of a manpage; we can worry about adding interactivity later. Here is a basic fill-in-the-blank form:
1) Morph Name:
2) What Is It/What Problems Does It Solve: (one paragraph explaining what purpose the Morph serves)
3) Dependencies: (cross-reference to what other Morphs does it require to function properly, e.g. chat requires badges)
4) How To Instantiate: (programmatically, via flap, via Morph Catalog)
5) Options: (how to set a few basic instance variables)
6) Step-by-step Tutorial of Use/Functionality: (how does one use this Morph)
Suggestions for other form items are welcome.
I would love to se some media rich and imaginative thinking go into how the documentation is made, and have the documentation show off a few of Squeaks qualities.
I agree that the manual should not be static images and text: Morphs should be functional and code executable. Animationas that show how to work with a Morph may be helpful, as well. We can decide what kind and what level of interactivity we want once we have good solid text.
Given that it appears that people are serious about this, I will create a Swiki for User Manual submissions at:
http://workshop.madeleinelengle.org/userManual
Username: authors Password: koyaanisqatsi
Given that I have kids using other swikis on this site, the userManual swiki will not appear in list of swikis and accessing it will require the username:password combination.
Best,
John
squeak-dev@lists.squeakfoundation.org