Documenting Squeak

Tansel Ersavas tansel at rase.com
Sat Mar 28 04:27:13 UTC 1998


Reinier van Loon wrote:
> 
> I am more or less busy documenting Squeak using a CASE tool (Paradigm
> Plus). During this I found that for example Controller has an instance
> variable 'sensor' which is sometimes not used in subclasses. Instead these
> subclasses refer to Sensor (a global object) *1. I think we should try to
> eliminate all such references to globals.
> 
> Therefore, I am volunteering to keep a list of errors, warnings (like
> above) and fixes. I will then compile this list into an HTML page and put
> it on the Web. But: I am not interested in platform specific VM related
> things. Just things which would make the (base) image cleaner.
> 
> BTW I am thinking of putting the documentation on the Web but I need
> something which can make a GIF or JPG from a WMF (Windows Meta File format)
> file. Yeah, I know, I should code it in Squeak. Does anyone have the WMF
> file format available?
> 
> Houdoe, Reinier.

I am about to complete porting of a tool much more flexible than
Paradigm plus to Squeak in a month or so. This tool is integrated to
your image, it can be used as a visual browser, and besides that
automatically generates class  diagrams and can generate object diagrams
with a little effort. It also creates hyperlinked HTML pages with GIF
images with image map hyperlinks automatically. Currently it can create
and and generate Booch and a subset of UML diagrams as well as simple
rectangles and ellipses (or any other shape if you don't mind defining
one) if you don't like canned notations. 

You can see an example of an automatically generated diagram at:

http://www.rase.com/cybercards/db/ccm.htm
(click on the subsystem and class icons in images) 

Please note these pages are not for public viewing, they are an old
version of an actual customer system (implemented with GemStone) and
I'll remove them in a few days, so please check them out quickly and
keep to within this group. As you can see from these diagrams there is
still some fine tuning and formatting is required, but hey, it works and
saves heaps of time!

The disadvantage of doing all these is in Paradigm Plus is it is a pain,
especially to redo parts of it every time the system changes. Although
core classes are reaching maturity and not changing much, Squeak is a
very fast changing system, and difficult to keep track of it. With a
tool like mine all the diagrams and the associated HTML can be generated
anytime with a simple mouse click, and although normally this system is
for sale for VSE (and soon VA), I'll make it freely available for Squeak
community for learning and developing Squeak (I'll still ask people who
use it for commercial purposes to buy it though).

When it is ready to be tested, I will let everyone in this group know so
that people can download and play with it true to the culture of Squeak.

As for porting, my biggest problem is WBPro generated screens, is there
a tool to port WBPro windows to Squeak, or should we write one?

Tansel
-----------------------------------------------------------------------
RASE Inc. 214W 29th Street Suite 901              10001 New York NY USA
Voice: (212)584 8040                             mailto:tansel at rase.com
Fax:   (212)584 8042                               http://www.rase.com/
-----"violence is the last refuge of the incompetent" Isaac Asimov-----





More information about the Squeak-dev mailing list