The Trunk: Help-Squeak-Project-mt.36.mcz

Marcel Taeumel uploaded a new version of Help-Squeak-Project to project The Trunk:
http://source.squeak.org/trunk/Help-Squeak-Project-mt.36.mcz

==================== Summary ====================

Name: Help-Squeak-Project-mt.36
Author: mt
Time: 2 August 2016, 2:21:57.156941 pm
UUID: 822a1e69-3650-3347-ac6e-fb685e2463ab
Ancestors: Help-Squeak-Project-tpr.35

Include more help texts from throughout the system. Add a book for release notes.

=============== Diff against Help-Squeak-Project-tpr.35 ===============

Item was changed:
  ----- Method: SqueakHelp class>>introduction (in category 'as yet unclassified') -----
  introduction
  "This method was automatically generated. Edit it using:"
  "a HelpBrowser edit: #introduction"
  ^HelpTopic
  title: 'Welcome'
  contents:
+ 'WELCOME
-  'WELCOME
 
  Squeak is a modern, open source, full-featured implementation of the powerful Smalltalk programming language and environment.
 
  Squeak is highly-portable - even its virtual machine is written entirely in Smalltalk making it easy to debug, analyze, and change.
 
  Squeak is the vehicle for a wide range of projects from multimedia applications, educational platforms to commercial web application development.!!
+ ]style[(7 2 6 72 9 41 6 70 9 49 6 139)bcblack;a0FBitmap DejaVu Sans#19,cblack;FBitmap DejaVu Sans#14,ba0cblack;FBitmap DejaVu Sans#14,a0cblack;FBitmap DejaVu Sans#14,ba0cblack;FBitmap DejaVu Sans#14,a0cblack;FBitmap DejaVu Sans#14,ba0cblack;FBitmap DejaVu Sans#14,a0cblack;FBitmap DejaVu Sans#14,ba0cblack;FBitmap DejaVu Sans#14,a0cblack;FBitmap DejaVu Sans#14,ba0cblack;FBitmap DejaVu Sans#14,a0cblack;FBitmap DejaVu Sans#14!!' readStream nextChunkText!
- ]style[(7 2 6 72 9 41 6 70 9 49 6 139)bc000000000a0FBitstreamVeraSerif#20.0,c000000000,FBitstreamVeraSerif#16.0ba0c000000000,FBitstreamVeraSerif#16.0a0c000000000,FBitstreamVeraSerif#16.0ba0c000000000,FBitstreamVeraSerif#16.0a0c000000000,FBitstreamVeraSerif#16.0ba0c000000000,FBitstreamVeraSerif#16.0a0c000000000,FBitstreamVeraSerif#16.0ba0c000000000,FBitstreamVeraSerif#16.0a0c000000000,FBitstreamVeraSerif#16.0ba0c000000000,FBitstreamVeraSerif#16.0a0c000000000!!' readStream nextChunkText!

Item was changed:
  ----- Method: SqueakLicenseHelp class>>officialLicense (in category 'pages') -----
  officialLicense
+
- "This method was automatically generated. Edit it using:"
- "a HelpBrowser edit: #officialLicense"
  ^HelpTopic
  title: 'Official License'
+ contents: Smalltalk license readStream nextChunkText!
- contents:
- 'Copyright (c) The individual, corporate, and institutional contributors who have collectively contributed elements to this software ("The Squeak Community"), 1996-2015 All rights reserved.
-
- Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- THE SOFTWARE.
-
- Portions of Squeak are covered by the following license
-
-
- Copyright (c) Xerox Corp. 1981, 1982 All rights reserved.
- Copyright (c) Apple Computer, Inc. 1985-1996 All rights reserved.
-
- Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
-
-   http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.!!' readStream nextChunkText!

Item was changed:
  ----- Method: SqueakProjectHelp class>>extendingTheSystem (in category 'pages') -----
  extendingTheSystem
  ^HelpTopic
  title: 'Extending The System'
  icon: (HelpIcons iconNamed: #squeakIcon)
+ contents: 'SqueakMap is an integrated catalog of external applications for Squeak.  It is accessible from the "Apps" menu.  This catalog does not host the projects, it merely documents the load scripts required to correctly bring them into the image.
+
+ Many SqueakMap packages use Installer, which defines several packages in its package-definitions protocol.  Any of these can be loaded with an expression like the following:
+
+ Installer new merge: #openGL
+
+ Change #openGL to the selector name of the package you want to load.  The latest version of that package and all of its prerequisites will be merged into the image.  Merging a package is no different from loading it unless the package is already loaded, in which case it is upgraded to the latest version in a way that preserves any local changes you may already have made.
+
+ ---------------
+ This remainder of this workspace documents load-scripts for packages that are not documented in either SqueakMap or Installer.
+
+ OCompletion
+ "Provides source code completion as you type"
+ (Installer ss project: ''OCompletion'') install: ''Ocompletion''.
+ (Smalltalk at: #ECToolSet) register.
+ (Smalltalk at: #ToolSet) default: (Smalltalk at: #ECToolSet).
+
+ Omnibrowser
+ "Including Refactoring engine"
+ (Installer ss project: ''MetacelloRepository'') install: ''ConfigurationOfOmniBrowser''.
+ ((Smalltalk at: #ConfigurationOfOmniBrowser) project perform: #lastVersion) load: #( Dev ).
+
+ Pier CMS
+ "Pier CMS: http://www.piercms.com"
+ (Installer ss project: ''MetacelloRepository'') install: ''ConfigurationOfPier2''.
+ (Smalltalk at: #ConfigurationOfPier2) load.
+
+ (Installer lukas project: ''pier2'') install: ''Pier-Blog''.
+ (Installer lukas project: ''pier2'') install: ''Pier-Book''.
+ (Installer lukas project: ''pier2addons'') install: ''Pier-Setup''.
+ (Smalltalk at: #PRDistribution)  new register.
+
+ Open Cobalt
+ "http://opencobalt.org (Best to run this from an image in an open cobalt directory)"
+ Installer ss project: ''TweakCore''; install: ''update''.
+ [Installer ss project: ''TweakExtras''; install: ''update'']
+ on: (Smalltalk at: #CUnsynchronizedModification) do: [:ex | ex resume].
+ Installer cobalt project: ''Tweak'';
+ answer: ''Would you like to conserve memory at all costs?'' with: true;
+ answer: ''Password for interactive VNC connections?'' with: ''cobalt'';
+ answer: ''Would you like to add the RFBServer to the World open menu?'' with: true;
+ install: ''update''
+ !!
+ ]style[(9 309 19 252 6 126 8 237 11 209 11 210 8 386 11 547)dSMLoaderPlus open;;,,d| newBrowser |
+ newBrowser := Browser new selectSystemCategory: ''Installer-Core''; selectClass: Installer; metaClassIndicated: false; selectMessageCategoryNamed: ''package-definitions''; selectMessageNamed: #openGL.
+ Browser openBrowserView: (newBrowser openMessageCatEditString: nil) label: ''External Package Definitions'';;,,i,,u,,bu,,bu,,bu,,bu,!!' readStream nextChunkText!
- contents:
- TheWorldMainDockingBar new extendingTheSystem !

Item was changed:
  ----- Method: SqueakProjectHelp class>>pages (in category 'accessing') -----
  pages
+ ^#(extendingTheSystem squeakResourcesOnline squeakUserInterface workingWithSqueak)!
- ^#(releaseNotes extendingTheSystem squeakResourcesOnline squeakUserInterface workingWithSqueak)!

Item was removed:
- ----- Method: SqueakProjectHelp class>>releaseNotes (in category 'pages') -----
- releaseNotes
- "This method was automatically generated. Edit it using:"
- "a HelpBrowser edit: #releaseNotes"
- ^HelpTopic
- title: 'Release Notes'
- contents: TheWorldMainDockingBar new releaseNotes  "<--- ugh, we will fix this later, for now may we not have TWO copies of the 8K release notes string in memory?"!

Item was changed:
  ----- Method: SqueakProjectHelp class>>squeakResourcesOnline (in category 'pages') -----
  squeakResourcesOnline
  ^HelpTopic
  title: 'Squeak Resources Online'
  icon: (HelpIcons iconNamed: #squeakIcon)
+ contents: 'Squeak web sites
+ Main Squeak site http://www.squeak.org
+ Weekly Squeak http://news.squeak.org
+ Oversight Board http://board.squeak.org
+ Downloads for many versions http://ftp.squeak.org
+ Development of the virtual machine http://squeakvm.org
+ Google+ Page
+ https://plus.google.com/u/0/b/115950529692424242526/
+
+ Squeak-dev - The main Squeak mailing list
+ http://lists.squeakfoundation.org/mailman/listinfo/squeak-dev
+ http://dir.gmane.org/gmane.comp.lang.smalltalk.squeak.general
+ http://n4.nabble.com/Squeak-Dev-f45488.html
- contents:
 
+ Squeak-Beginners - The place to ask even the most basic questions
+ http://lists.squeakfoundation.org/mailman/listinfo/beginners
+ http://dir.gmane.org/gmane.comp.lang.smalltalk.squeak.beginners
+ http://n4.nabble.com/Squeak-Beginners-f107673.html
+
+ Squeak By Example
+ http://www.squeakbyexample.org/
+
+ Squeak, Open Personal Computing and Multimedia
+ http://coweb.cc.gatech.edu/squeakbook/
+ http://stephane.ducasse.free.fr/FreeBooks/CollectiveNBlueBook/
+
+ Squeak, Open Personal Computing for Multimedia
+ http://www.cc.gatech.edu/~mark.guzdial/drafts/
+ http://stephane.ducasse.free.fr/FreeBooks/GuzdialBookDrafts/
+
+ More Books about Squeak and Smalltalk
+ http://stephane.ducasse.free.fr/FreeBooks.html
+ !!
+ ]style[(16 316 41 173 65 181 17 35 46 106 46 112 37 49)bu,,bu,,bu,,bu,,bu,,bu,,bu,!!' readStream nextChunkText!
- TheWorldMainDockingBar new squeakOnlineResources!

Item was changed:
  ----- Method: SqueakProjectHelp class>>squeakUserInterface (in category 'pages') -----
  squeakUserInterface
  ^HelpTopic
  title: 'Squeak User Interface'
  icon: (HelpIcons iconNamed: #squeakIcon)
+ contents: 'The Squeak UI has some unusual elements that you may not have seen before.  Here is a brief introduction to those elements:
- contents:
 
+ Projects
+ A project is an entire Squeak desktop full of windows.  Projects can be used to change quickly from one task to another.  An inactive project is represented by a project window, which shows a thumbnail of its state.  Project windows are actually more like doors than windows, since you can enter the project just by clicking on them.  You can create a new project by choosing ''open...project'' from the screen menu.  To exit a project (and return to its parent project), choose ''previous project'' from the screen menu.  Each project maintains its own set of windows and other information.
+
+ Morphic Halos
+ In a morphic project, pressing cmd-click (Mac) or alt-click (Windows) on a graphical object (e.g. a window) will surround it with a constellation of colored circles.  These are called "halo handles."  Additional clicks will cycle through the halos for the other graphical objects in the nesting structure.  If you hold down the Shift key while cmd/alt-clicking, the nested morphs will be traversed from innermost outward.  Clicking without the cmd/alt key will dismiss the halo.  While the halo is up, letting the cursor linger over one of the halo handles for a few seconds will cause a balloon to pop up with the name of that handle.  Three useful handles are the top-left "X" handle (delete), the bottom-right yellow handle (resize), and the brown handle (slide the object within its containing object).  Halos allow complex graphical objects to be explored - or even disassembled (using the black halo handle).  Usually no harm results from taking apart an object; you can just discard the pieces and create a new one.
+
+ Flaps
+ To enable Flaps, click on the desktop to show the world menu, choose the "Flaps..." menu and "show shared tags". Tabs labeled "Squeak", "Tools", "Supplies", etc., will appear along the edges of the Squeak desktop.  Click on any tab to open the corresponding flap.  Drag a tab to resize the flap and to relocate the tab.  Bring up the halo on any tab and click on its menu handle to be presented with many options relating to the flap.  Use the "Flaps..." menu, reached via the desktop menu, to control which flaps are visible and for other flap-related options and assistance.
+
+ Parts Bins
+ You can obtain new objects in many ways.  The "Objects Catalog" (choose "objects'' from the world menu or open the objects flap) and several of the standard flaps (e.g. "Tools" and "Supplies") serve as "Parts Bins" the for new objects.  Drag any icon you see in a Parts Bin and a fresh copy of the kind of object it represents will appear "in your hand"; click to deposit the new object anywhere you wish.  You can also add your own objects to any of the flaps - just drag your object over the tab, wait for the flap to pop open, then drop the object at the desired position in the flap.
+ !!' readStream nextChunkText!
- TheWorldMainDockingBar new squeakUserInterface!

Item was changed:
  ----- Method: SqueakProjectHelp class>>workingWithSqueak (in category 'pages') -----
  workingWithSqueak
  ^HelpTopic
  title: 'Working with Squeak'
  icon: (HelpIcons iconNamed: #squeakIcon)
+ contents: 'Starting and Quitting
+ Like most Smalltalks, the machine-executable portion is a relatively small program known as the "virtual machine" (VM).  The VM''s job is to provide services from the physical machine to real Smalltalk objects.  Services like input and output.  The Smalltalk system, including all data and code, is a system of objects, built from the ground up, and interpreted by this virtual computer.  This affords Smalltalk system platform portability.
+
+ Smalltalk cannot run without the VM.  The VM can''t do anything useful except process Smalltalk systems.
+
+ To start the system, drag the ".image" data file to the VM executable "squeak".  There are myriad command-line options for starting the system via the command-line (see squeak --help).  By default, the system will open on the screen in a single OS window.
+
+ To quit a Squeak session, choose ''quit'' from the menu bar.  If you save, the image file will be overwritten and resume from that place the next time it''s launched.
+
+ The Image File
+ Squeak is an environment built in its own objects from the ground up, including one or more end-user applications.  All of the objects in the system -- Classes, Dictionaries, Windows, Customers and other objects that make up the Squeak environment are stored in a binary ".image" file.  This is the "object-data file" loaded by the VM when Squeak is launched.
+
+ When an image is started, every object resumes exactly from where it was last saved.
+
+ The Sources File
+ Smalltalk is traditionally includes the source code in the running system.  However, keeping multiple copies of the same source code in all images files is wasteful.  Therefore, the source code itself is kept in a read-only .sources file and accessed by all images.  The image files merely have pointers into this file, which is read on-the-fly to present original source code.
+
+ The code of the base system is stored in the file "SqueakV46.sources".  This file does not change except between releases of Squeak.  Normally this file should be placed in the folder containing the VM executable.
+
+ The Changes File
+ The purpose of Squeak is to develop new programs and systems.  Code changes to the running system are effective immediately.  But since multiple images can be running, they cannot all update the .sources file safely.  Therefore, each image file is accompanied by a ".changes" file which contains source code changes for that and only that Smalltalk system..
+
+ The changes file is important for project work.  It keeps a sequential log of development activity for the purpose of recovering work performed since the last image-save.  Any of several events could lead to the need to recover work, including a power-outage or making an erroneous change to code required to keep the system running.
+
+ The changes file does not consume memory space, so Squeak is able to keep a complete history of all program changes.  This makes it easy to examine or even reinstate older versions of methods (see ''versions'' option in browser selector pane).  This encourages experimentation, since you can easily revert to the original versions of any set of methods.
+
+ In extreme cases where sources and/or changes files are not available, the system can still run, and will automatically decompile the bytecode methods in image memory, if necessary, into readable and editable versions of the original source code (only comments and temporary variable names are lost).
+
+ Transferring Code-Snippets Between Images
+ In addition to the ''save'' command that saves the entire state of the system, the code of individual methods, categories or classes may be ''filed out'' and then filed-in to another image.
+
+ Packages
+ The code of an entire project is encapsulated by a Package.  This allows users to share their code with other users.  Code of packages are delineated by the categories of their classes, and methods.  The Monticello browser is then used to wrap that code into a Package object which can be saved to a Monticello repository at http://ss3.gemtalksystems.com/ss.
+
+ Some projects end up using the resources provided by several packages, resulting in a hierarchy of packages that make up a system.  Installer can be used to install such systems.!!
+ ]style[(21 970 14 448 16 396 11 188 16 321 4 1025 41 188 8 52 10 55 2 420)bu,,bu,,bu,,u,,bu,,u,,bu,,bu,,i,,i,!!' readStream nextChunkText!
- contents:
- TheWorldMainDockingBar new workingWithSqueak  "avoid duplicate of big string until we fix this"!

Item was added:
+ SqueakProjectHelp subclass: #SqueakReleaseNotes
+ instanceVariableNames: ''
+ classVariableNames: ''
+ poolDictionaries: ''
+ category: 'Help-Squeak-Project'!

Item was added:
+ ----- Method: SqueakReleaseNotes class>>bookName (in category 'accessing') -----
+ bookName
+ ^'Release Notes'!

Item was added:
+ ----- Method: SqueakReleaseNotes class>>pages (in category 'accessing') -----
+ pages
+ ^#(releaseNotes51 releaseNotes50)!

Item was added:
+ ----- Method: SqueakReleaseNotes class>>releaseNotes50 (in category 'pages') -----
+ releaseNotes50
+
+ ^HelpTopic
+ title: '5.0 / 4.6'
+ contents: 'Squeak 5.0
+ Release Notes
+
+ A New Memory Model and Virtual Machine
+
+ Fast Become
+ Squeak 5 introduces a new object model and VM known as "Spur".  Presented [1] by Eliot Miranda and Clément Béra at the International Symposium on Memory Management in year 2015, this new VM retains the direct-pointer representation of objects in previous Squeak versions but now without requiring a full scan of the heap for become.  This is done by introducing hidden forwarding objects which allow references to be updated lazily as they are encountered.  Spur''s innovation is in avoiding explicit read barriers in all common cases.
+
+ Additional Immediate Types
+ The new Spur memory model supports immediate Characters, so that Characters with unicode greater than 255 can be tested via #==, and wide string access is much faster.  The 64-bit version, still under development, also provides immediate floats, occupying the middle 8th of the double precision exponent range.
+
+ Simplified and Ready for 64-bit
+ Internally Spur uses a 64-bit object header, a representation shared between the 32-bit and 64-bit versions, and one that is significantly simpler than the three different header sizes used in the previous version.  This simplicity means that the JIT now generates code to implement more primitives, in particular new and new:, resulting in significantly higher performance, at the cost of a 15% increase in image size.
+
+ Enhanced Memory Management
+ Spur has a segmented heap, allowing the heap to grow and shrink a segment at a time.  It provides per-object pinning to ensure specific objects will not be moved by the garbage collector, hence simplifying the FFI.  Spur provides Ephemerons which allow for per-object finalization and the prevention of uncollectable cycles, for example in global property lists like DependentsFields (although this support has yet to be applied to the system).
+
+
+ Squeak now runs on ARM
+
+ As a natural output of the Scratch application on Rasberry Pi project, the Spur VM can now run on the Rasberry Pi.
+
+
+ The Future of Spur
+
+ Work is underway on an innovative adaptive optimizer/speculative inliner, and a 64-bit JIT for x64, and a global incremental mark-sweep collector is planned.  See [2].
+
+ [1] -- http://conf.researchr.org/event/ismm-2015/ismm-2015-papers-a-partial-read-barrier-for-efficient-support-of-live-object-oriented-programming
+ [2] -- http://www.mirandabanda.org/cogblog/cog-projects/
+ !!
+ ]style[(10 1 13 40 2 11 537 26 313 31 422 26 448 22 119 19 374)a2bFBitstreamVeraSerif#32.0,FBitstreamVeraSans#20.0a2,a2FBitstreamVeraSerif#24.0-,FBitstreamVeraSans#20.0,,b,,b,,b,,b,,FBitstreamVeraSans#20.0,,FBitstreamVeraSans#20.0,!!' readStream nextChunkText!

Item was added:
+ ----- Method: SqueakReleaseNotes class>>releaseNotes51 (in category 'pages') -----
+ releaseNotes51
+
+ ^HelpTopic
+ title: '5.1'
+ contents: 'TBD.'!

Item was added:
+ ----- Method: SqueakToolsHelp class>>fontSizeSummary (in category 'pages') -----
+ fontSizeSummary
+ ^HelpTopic
+ title: 'Font Size Summary'
+ contents: TextStyle fontSizeSummaryContents!

Item was changed:
  ----- Method: SqueakToolsHelp class>>pages (in category 'accessing') -----
  pages
+ ^#(basicDevelopmentTools fontSizeSummary)!
- ^#(basicDevelopmentTools)!

Item was changed:
  ----- Method: SqueakTutorials class>>pages (in category 'accessing') -----
  pages
+ ^#(introduction usefulExpressions)!
- ^#(introduction)!

Item was added:
+ ----- Method: SqueakTutorials class>>usefulExpressions (in category 'pages') -----
+ usefulExpressions
+
+ ^ HelpTopic
+ title: 'Useful Expressions'
+ contents: Utilities standardWorkspaceContents!