[squeak-dev] The Trunk: Help-Squeak-CorePackages-tpr.2.mcz

commits at source.squeak.org commits at source.squeak.org
Wed May 30 02:34:56 UTC 2018


tim Rowledge uploaded a new version of Help-Squeak-CorePackages to project The Trunk:
http://source.squeak.org/trunk/Help-Squeak-CorePackages-tpr.2.mcz

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

Name: Help-Squeak-CorePackages-tpr.2
Author: tpr
Time: 29 May 2018, 7:34:41.027517 pm
UUID: 87e621a8-9b9a-4c33-ab79-61bb8e3d6b7c
Ancestors: Help-Squeak-CorePackages-pre.1

Minor cleanups for the core package help classes

=============== Diff against Help-Squeak-CorePackages-pre.1 ===============

Item was added:
+ ServiceProvider subclass: #HelpSqueakCorePackagesServiceProvider
+ 	instanceVariableNames: ''
+ 	classVariableNames: ''
+ 	poolDictionaries: ''
+ 	category: 'Help-Squeak-CorePackages'!

Item was added:
+ ----- Method: HelpSqueakCorePackagesServiceProvider class>>initialize (in category 'initialization') -----
+ initialize 
+ 	ServiceRegistry buildProvider: self new!

Item was changed:
  CustomHelp subclass: #SqueakCorePackagesHelp
  	instanceVariableNames: ''
  	classVariableNames: ''
  	poolDictionaries: ''
  	category: 'Help-Squeak-CorePackages'!
+ 
+ !SqueakCorePackagesHelp commentStamp: 'tpr 5/29/2018 17:19' prior: 0!
+ SqueakCorePackagesHelp is an attempt at gathering some important core classes together for the Help system; with the two subclasses it kinda-sorta pulls together the barest of package doc.
+ It's arguable whether this really works out very well; perhaps a better organisation can be found?!

Item was changed:
+ ----- Method: SqueakCorePackagesHelp class>>bookName (in category 'accessing') -----
- ----- Method: SqueakCorePackagesHelp class>>bookName (in category 'as yet unclassified') -----
  bookName
  
  	^ 'Core Packages'!

Item was changed:
+ ----- Method: SqueakCorePackagesHelp class>>graphics (in category 'pages') -----
- ----- Method: SqueakCorePackagesHelp class>>graphics (in category 'as yet unclassified') -----
  graphics
  	"This method was automatically generated. Edit it using:"
  	"SqueakCorePackagesHelp edit: #graphics"
  	^(HelpTopic
  		title: 'Graphics'
  		contents: 
  'This package includes core classes for Smalltalk graphic objects as well as facilities and applications for operating on graphic objects. Key classes include Form and BitBlt.
  
  It further includes classes for rendering fonts and reading png, gif, or jpeg files.!!
  ]style[(158 4 5 6 87),dForm browse;;,,dBitBlt browse;;,!!' readStream nextChunkText)
  			key: #graphics!

Item was changed:
+ ----- Method: SqueakCorePackagesHelp class>>pages (in category 'accessing') -----
- ----- Method: SqueakCorePackagesHelp class>>pages (in category 'as yet unclassified') -----
  pages
  
+ 	^ self class methodsInCategory: #pages!
- 	^ self class selectors copyWithoutAll: #(bookName pages)!

Item was changed:
+ ----- Method: SqueakFurtherCorePackagesHelp class>>balloonPackage (in category 'pages') -----
- ----- Method: SqueakFurtherCorePackagesHelp class>>balloonPackage (in category 'as yet unclassified') -----
  balloonPackage
  	"This method was automatically generated. Edit it using:"
  	"SqueakFurtherCorePackagesHelp edit: #balloonPackage"
  	^(HelpTopic
  		title: 'Balloon'
  		contents: 
  'The Balloon package provides an engine for complex 2-D graphic objects and fast 2-D graphics rendering including anti-aliasing. It was originally written to render Flash. The main interface is BalloonCanvas which is used to render Morphs using the BalloonEngine. It also provides the FillStyle classes which enable gradient or form fill styles for Morphs.
  
  It has nothing to do with the Balloon help concept which shows help texts on mouse over.!!
  ]style[(193 13 239),dBalloonCanvas browse;;,!!' readStream nextChunkText)
  			key: #balloonPackage!

Item was changed:
+ ----- Method: SqueakFurtherCorePackagesHelp class>>bookName (in category 'accessing') -----
- ----- Method: SqueakFurtherCorePackagesHelp class>>bookName (in category 'as yet unclassified') -----
  bookName
  
  	^ 'Further'!

Item was changed:
+ ----- Method: SqueakFurtherCorePackagesHelp class>>commandLine (in category 'pages') -----
- ----- Method: SqueakFurtherCorePackagesHelp class>>commandLine (in category 'as yet unclassified') -----
  commandLine
  	"This method was automatically generated. Edit it using:"
  	"SqueakFurtherCorePackagesHelp edit: #commandLine"
  	^(HelpTopic
  		title: 'CommandLine'
  		contents: 
  'The CommandLine package provides classes for running Squeak in headless mode while dealing with events requiring user input. Essentially, it introduces a special ToolSet (CommandLineToolSet) which handles tool requests.!!
  ]style[(162 7 2 18 30),dToolSet browse;;,,dCommandLineToolSet  browse;;,!!' readStream nextChunkText)
  			key: #commandLine!

Item was changed:
+ ----- Method: SqueakFurtherCorePackagesHelp class>>multilingual (in category 'pages') -----
- ----- Method: SqueakFurtherCorePackagesHelp class>>multilingual (in category 'as yet unclassified') -----
  multilingual
  	"This method was automatically generated. Edit it using:"
  	"SqueakFurtherCorePackagesHelp edit: #multilingual"
  	^(HelpTopic
  		title: 'Multilingual'
  		contents: 
  'The Multilingual package adds support for multiple languages to Squeak. This includes the capabilities to import text in different encodings (think copy-and-paste), and render all kinds of fonts.
  
  An interesting multilingual method of the String class is #encodedCharSetAt:.
  !!' readStream nextChunkText)
  			key: #multilingual!

Item was changed:
+ ----- Method: SqueakFurtherCorePackagesHelp class>>nebraska (in category 'pages') -----
- ----- Method: SqueakFurtherCorePackagesHelp class>>nebraska (in category 'as yet unclassified') -----
  nebraska
  	"This method was automatically generated. Edit it using:"
  	"SqueakFurtherCorePackagesHelp edit: #nebraska"
  	^(HelpTopic
  		title: 'Nebraska'
  		contents: 
  'Nebraska is a toolkit for building remote interactions with Morphic in Squeak. It is modelled somewhat after Kansas, although as yet it''s a much simpler system. There is a shared world on some server on a network, and other people can connect to that world from afar. Whenever the shared world tries to draw to its screen, it sends drawing commands across the network. Whenever a user tries to perform a mouse or keyboard interaction, those interactions are forwarded to the server where a RemoteControlledHand acts on their behalf.
  
  See also http://wiki.squeak.org/squeak/1356!!
  ]style[(543 34),Rhttp://wiki.squeak.org/squeak/1356;!!' readStream nextChunkText)
  			key: #nebraska!

Item was removed:
- ----- Method: SqueakFurtherCorePackagesHelp class>>pages (in category 'as yet unclassified') -----
- pages
- 
- 	^ self class selectors copyWithoutAll: #(bookName pages)!

Item was changed:
+ ----- Method: SqueakFurtherCorePackagesHelp class>>protocols (in category 'pages') -----
- ----- Method: SqueakFurtherCorePackagesHelp class>>protocols (in category 'as yet unclassified') -----
  protocols
  	"This method was automatically generated. Edit it using:"
  	"SqueakFurtherCorePackagesHelp edit: #protocols"
  	^(HelpTopic
  		title: 'Protocols'
  		contents: 
  'This package deals with vocabularies as they are used in Etoys. A vocabulary is the set of words understood by an object when viewed from Etoys. You can see examples of vocabularies in methods named ''additionsTo[some vocabulary category name]''.
  
  Most of the methods behind a vocabulary term are implemented in Player which then often forward them to an implementation in its costume (often a Morph).
  
  See also: http://wiki.squeak.org/squeak/3944!!
  ]style[(411 34),Rhttp://wiki.squeak.org/squeak/3944;!!' readStream nextChunkText)
  			key: #protocols!

Item was changed:
+ ----- Method: SqueakFurtherCorePackagesHelp class>>shout (in category 'pages') -----
- ----- Method: SqueakFurtherCorePackagesHelp class>>shout (in category 'as yet unclassified') -----
  shout
  	"This method was automatically generated. Edit it using:"
  	"ShoutHelp edit: #introduction"
  	^HelpTopic
  		title: 'Shout'
  		contents: 
  'The Shout package provides parsing and syntax highlighting for Smalltalk code. It can be used to create alternative highlighting mechanisms. !!
  ]style[(141)f1!!' readStream nextChunkText!

Item was changed:
+ ----- Method: SqueakFurtherCorePackagesHelp class>>st80 (in category 'pages') -----
- ----- Method: SqueakFurtherCorePackagesHelp class>>st80 (in category 'as yet unclassified') -----
  st80
  	"This method was automatically generated. Edit it using:"
  	"ST80Help edit: #introduction"
  	^HelpTopic
  		title: 'ST80'
  		contents: 
  'The ST80 package bundles the MVC tool implementations in Squeak. They can be used through opening a MVC project. This is useful for example for debugging Morphic projects.!!
  ]style[(171)f1!!' readStream nextChunkText!

Item was removed:
- ----- Method: SqueakUsefulCorePackagesHelp class>>pages (in category 'as yet unclassified') -----
- pages
- 
- 	^ self class selectors copyWithoutAll: #(bookName pages)!

Item was changed:
+ ----- Method: SqueakUsefulCorePackagesHelp class>>regex (in category 'pages') -----
- ----- Method: SqueakUsefulCorePackagesHelp class>>regex (in category 'as yet unclassified') -----
  regex
  	"This method was automatically generated. Edit it using:"
  	"SqueakUsefulCorePackagesHelp edit: #regex"
  	^(HelpTopic
  		title: 'Regex'
  		contents: 
  'Regex provides a regex matching engine. It is mainly used through the interface exposed on String objects. See the *Regex-Core category on String.
  
  For the syntax of Squeak regular expressions see: RxParser class>>#a:introduction: and the subsequent methods on RxParser class. For more involved usages of regular expressions see the Regex-Core class category.!!
  ]style[(139 6 53 32 129),dString browse;;,,LRxParser class>>#a:introduction:;,!!' readStream nextChunkText)
  			key: #regex!

Item was changed:
+ ----- Method: SqueakUsefulCorePackagesHelp class>>squeakMap (in category 'pages') -----
- ----- Method: SqueakUsefulCorePackagesHelp class>>squeakMap (in category 'as yet unclassified') -----
  squeakMap
  	"This method was automatically generated. Edit it using:"
  	"SqueakUsefulCorePackagesHelp edit: #squeakMap"
  	^(HelpTopic
  		title: 'SM'
  		contents: 
  'This package contains the model and the UI of SqueakMap, which is a repository for packages and applications in Squeak. You can access the SqueakMap catalog from the Apps menu item.
  
  Information on how to use SqueakMap can be found here: http://wiki.squeak.org/squeak/2726
  
  The server resides at: http://http://map.squeak.org/
  You can get an account to publish packages at: http://map.squeak.org/newaccount!!' readStream nextChunkText)
  			key: #squeakMap!

Item was changed:
+ ----- Method: SqueakUsefulCorePackagesHelp class>>sunit (in category 'pages') -----
- ----- Method: SqueakUsefulCorePackagesHelp class>>sunit (in category 'as yet unclassified') -----
  sunit
  	"This method was automatically generated. Edit it using:"
  	"SqueakUsefulCorePackagesHelp edit: #sunit"
  	^(HelpTopic
  		title: 'SUnit and SUnitGUI'
  		contents: 
  'The SUnit package provides testing abstractions for unit tests. These comply to the XUnit testing model.
  
  The common use case is to subclass TestCase. However, SUnit-Extensions also contains TestCases for special use cases. The rest of the API is explained in SUnit-Tests.
  
  SUnitGUI contains the definition of the SUnit TestRunner which you can find in the world menu or the docking bar under Tools.!!
  ]style[(141 8 250),Rcode://TestCase;,!!' readStream nextChunkText)
  			key: #sunit!

Item was changed:
+ ----- Method: SqueakUsefulCorePackagesHelp class>>toolBuilder (in category 'pages') -----
- ----- Method: SqueakUsefulCorePackagesHelp class>>toolBuilder (in category 'as yet unclassified') -----
  toolBuilder
  	"This method was automatically generated. Edit it using:"
  	"SqueakUsefulCorePackagesHelp edit: #toolBuilder"
  	^(HelpTopic
  		title: 'ToolBuilder'
  		contents: 
  'ToolBuilder provides means to describe graphical user interfaces independently from the actual graphics framework used (e.g. MVC or Morphic). Examples of tools built with it are the Debugger, the system browser, or the monticello repository browser.
  
  To read about how to build tools start reading the ToolBuilder class comment.!!
  ]style[(182 8 112 11 15)f1,dDebugger browse;;,f1,LToolBuilder Comment;,f1!!' readStream nextChunkText)
  			key: #toolBuilder!

Item was changed:
+ ----- Method: SqueakUsefulCorePackagesHelp class>>traitsPage (in category 'pages') -----
- ----- Method: SqueakUsefulCorePackagesHelp class>>traitsPage (in category 'as yet unclassified') -----
  traitsPage
  	"This method was automatically generated. Edit it using:"
  	"SqueakUsefulCorePackagesHelp edit: #traitsPage"
  	^(HelpTopic
  		title: 'Traits'
  		contents: 
  'Traits are an additional composition and reuse concept in Squeak allowing sideways composition of behavior. Traits are similar to MixIns. You can read about them here: http://scg.unibe.ch/archive/papers/Scha03aTraits.pdf!!
  ]style[(168 52)f1,Rhttp://scg.unibe.ch/archive/papers/Scha03aTraits.pdf;!!' readStream nextChunkText)
  			key: #traitsPage!

Item was changed:
+ ----- Method: SqueakUsefulCorePackagesHelp class>>xml (in category 'pages') -----
- ----- Method: SqueakUsefulCorePackagesHelp class>>xml (in category 'as yet unclassified') -----
  xml
  	"This method was automatically generated. Edit it using:"
  	"SqueakUsefulCorePackagesHelp edit: #xml"
  	^(HelpTopic
  		title: 'XML'
  		contents: 
  'This package provides classes for parsing XML files. You can implement your own Parser by subclassing the XMLParser class.!!
  ]style[(106 9 7)f1,dXMLParser browse;;,f1!!' readStream nextChunkText)
  			key: #xml!



More information about the Squeak-dev mailing list