Help - Basics - Introduction to Squeak Help

Previous - Basics - Next

This text continues the Help-text.

- Who did it
- How to use it
- Limitations
- Purpose

Who did it: Squeak Help was written by Maarten Maartensz in 2002-2004. It consists of a directory Help with many subdirectories with simple hml and gif files that can be run inside Squeak using Scamper.

How to use it: You start Squeak Help by opening a Filelist and going to the Help-directory (attached to the Squeak-directory of the Squeak you installed it for), finding Help.htm, and pressing Open in in the Filelist.

Scamper is a simple html-browser. It works fairly unproblematically, though if Scamper's Back-button fails you are herewith advised to use Scamper's History-option to go back.

You can look in Squeak Help if necessary with an ordinary webbrowser what it should display in Scamper, in case you are in doubt.

Of course you can load as many Scampers with Squeak Help as you find helpful, as long as there is enough memory for them. (An easy way is to copy a Scamper with the copying halo, for example after you have coloured its window to your liking.)

It is best to use Squeak Help inside Squeak because Squeak enables you to

- run all code in Squeak Help (colored Magenta). Example: Cmd-p on
100 factorial.
- Browse whatever term in Squeak Help that is accessible to Squeak Browsers. Example Cmd-m on
factorial.

If you don't know how to run code, check out the first page of Help and Workspaces.

If you are new to Squeak, it is wise to read at least through all the stuff that is in Basics, to give you a minimal idea what Squeak is and may be for you. There also is a Help on Help that shows you what is in Squeak Help and explains how to use it.

Most of it is introductory material meant for newbies (and those who like a Squeak with good and extensive documentation - for which the present Squeak Help is a humble start).

The html-files in Class Comments are versions of Class Comments for many of Squeak's classes that I wrote because I wasn't happy with the ones I found in the image. You can compare them easily with what is in your image by finding a class comment in Scamper, highlighting the name of the class, and pressing Cmd-b, that will pop up a System Browser on that comment.

Limitations: Squeak Help is a work in progress. At present, no part of it is finished, but what is there should be helpful for newbies. This is the reason it is made available, since there is not much help for Squeak that runs inside Squeak.

 If you like or dislike anything in Squeak Help very much, you can mail its maker at maartens@xs4all.nl. If I think you are mostly right, I will try to do something about it in later versions. You can also contribute your own. See Known Limitations and Plan and Proposal.

Purpose: The purpose of Squeak Help is to become a curriculum for Squeak in Squeak. See Plan and Proposal for a statement of this by Dan Ingalls and a way to attempt to do so.

Previous - Basics - Next