Documentation Suggestion

tim Rowledge tim at rowledge.org
Sat Dec 29 02:50:50 UTC 2007


>
> On 27/12/2007, Robert Hawley <rhawley at plymouth.ac.uk> wrote:
>> Documentation Suggestion.
>>
>> Can we have direct links from within the Squeak image from each  
>> class, method, project, category, package, (etc.,) into a user- 
>> editable documentation web-site?

The link part is easy - cmd-6 (on Mac, alt-6 on win32 and probably  
*nix) in a text editor opens a menu with several options including 'be  
a web URL link' so that you can include a link within comments. It  
also has linking to other methods, class comments etc.

>> It would effectively be Squeak's own encyclopedia; similar to  
>> wikipedia.  Structured documentation could be available with great  
>> immediacy, be developed incrementally and be subject to continual  
>> review and rewrite by the whole community.
>>


Duane Maxwell tried to encourage just such an idea a few years ago and  
even set up a domain for it. I don't recall many people making the  
effort to provide any content. We don't even need a new site though;  
what is wrong with providing the doc on the swiki and linking to it?

tim
--
tim Rowledge; tim at rowledge.org; http://www.rowledge.org/tim
Strange OpCodes: CDC: Clear Disks and Crash





More information about the Squeak-dev mailing list