Squeak
  links to this page:    
View this PageEdit this PageUploads to this PageHistory of this PageTop of the SwikiRecent ChangesSearch the SwikiHelp Guide
CustomHelp
Last updated at 10:00 pm UTC on 15 April 2018
 Object subclass: #CustomHelp
	instanceVariableNames: ''
	classVariableNames: ''
	poolDictionaries: ''
	category: 'HelpSystem-Core-Utilities'


This is a common superclass for custom help. Some CustomHelp subclasses are provided with the release image. To create a custom help book for your application you need to create a subclass of CustomHelp.

Code snippets included in CustomHelp topics may be evaluated as in a Workspace. This allows you to include executable content in the help topics, e.g. have recipes how to do something with executable steps.

The subclasses of CustomHelp are automatically included into the system help.

By default the informations provided on the receiver class are converted into help topics by a specific builder,
here the CustomHelpHelpBuilder. Note that you can provide an own custom builder by overriding the #builder method


Class hierarchy in Squeak 4.6

 CustomHelp printHierarchy '
 ProtoObject #()
 	Object #()
 
 		CustomHelp #()
 			HelpOnHelp #()
 				HelpAPIDocumentation #()
 				HelpHowToHelpTopics #()
 					HelpHowToHelpTopicsFromCode #()
 			SWikiHelp #()
 			SqueakHelp #()
 				SqueakProjectHelp #()
 					SqueakLicenseHelp #()
 				SqueakToolsHelp #()
 					SqueakToolsDebuggerHelp #()
 					SqueakToolsTranscriptHelp #()
 					SqueakToolsWorkspaceHelp #()
 				SqueakTutorials #()
 					SqueakTutorialsCommandKey #()
 					SqueakTutorialsOnImage #()
 					SqueakTutorialsOnXML #()
 			TerseGuideHelp #()
 			WebClientHelp #()
 				WebClientReference #()
 			WebServerHelp #()
 				WebServerReference #()'