[squeak-dev] How do I generate CustomHelp method stubs?

H. Hirzel hannes.hirzel at gmail.com
Mon Oct 16 10:17:14 UTC 2017


Hello

How do I generate CustomHelp method stubs?

The HelpBrowser you get when you choose menu 'Help' / 'HelpBrowser'
[1] automatically includes all help specified as subclasses of
CustomHelp [2].

A typical help method is

SqueakCorePackagesHelp>>
collections
	"This method was automatically generated. Edit it using:"
	"SqueakCorePackagesHelp edit: #collections"
.....
[3]


How do I generate the method stubs for

        CustomHelp subclass: #MyPackageHelp
	instanceVariableNames: ''
	classVariableNames: ''
	poolDictionaries: ''
	category: 'MyPackage'


Kind regards
Hannes


------------------------------------------------------------------------

[1] The menu entry calls
          HelpBrowser open



------------------------------------------------------------------------

[2] CustomHelp printHierarchy '
ProtoObject #()
	Object #()

		CustomHelp #()
			EnvironmentsHelp #()
				EnvironmentsAPIDocumentation #()
			HelpOnHelp #()
				HelpAPIDocumentation #()
				HelpHowToHelpTopics #()
					HelpHowToHelpTopicsFromCode #()
			SWikiHelp #()
			SqueakCorePackagesHelp #()
				SqueakFurtherCorePackagesHelp #()
				SqueakUsefulCorePackagesHelp #()
			SqueakHelp #()
				SqueakProjectHelp #()
					SqueakLicenseHelp #()
					SqueakReleaseNotes #()
				SqueakToolsHelp #()
					SqueakToolsDebuggerHelp #()
					SqueakToolsTranscriptHelp #()
					SqueakToolsWorkspaceHelp #()
				SqueakTutorials #()
					SqueakTutorialsCommandKey #()
					SqueakTutorialsOnImage #()
					SqueakTutorialsOnXML #()
			TerseGuideHelp #()
			WebClientHelp #()
				WebClientReference #()
			WebServerHelp #()
				WebServerReference #()'



------------------------------------------------------------------------



[3] SqueakCorePackagesHelp>>collections
	"This method was automatically generated. Edit it using:"
	"SqueakCorePackagesHelp edit: #collections"
	^(HelpTopic
		title: 'Collections'
		contents:
'Everything related to working with multiple objects such as Array,
String (Collection of characters), Stream, Set, and Dictionary.!
]style[(60 5 2 6 29 6 2 3 6 10 1),dArray browse;;,,dString
browse;;,,dStream browse;;,,dSet browse;;,,dDictionary browse;;,!'
readStream nextChunkText)
			key: #collections


More information about the Squeak-dev mailing list