Squeak
  links to this page:    
View this PageEdit this PageUploads to this PageHistory of this PageTop of the SwikiRecent ChangesSearch the SwikiHelp Guide
HelpBrowser
Last updated at 4:15 am UTC on 6 July 2018
A HelpBrowser is used to display a hierarchy of help topics and their contents.

 HelpBrowser open


To edit the introduction for the 'Tutorials' help book use

 SqueakTutorials edit: #introduction

After editing the workspace contents choose 'accept'. The result is stored in the method #introduction of the class SqueakTutorials.

To access the content of this wiki (which serves HTML) in the HelpBrowser put the following snippet into a Workspace and choose 'do it'.

 HelpBrowser openOn: SWikiHelp.

Implementation notes

The HelpBrowser has been included in trunk in May 2010 (Squeak 4.1)

 HelpBrowser openOn: aHelpTopic
calls (with the option of an indirection), but the regular case is
 HelpBrowser new rootTopic: aHelpTopic; open
Then in #open the ToolBuilder comes into action
 ^ ToolBuilder open: self

Then the main ToolBuilder method for building the HelpBrowser is

 buildWith: builder
 
 	| windowSpec |
 	windowSpec := self buildWindowWith: builder.
 	
 	windowSpec children
 		add: (self buildSearchWith: builder);
 		add: (self buildTreeWith: builder);
 		add: ( (rootTopic notNil and:[
 			rootTopic usesCodeStyling])
 				ifTrue:[self buildCodeContentsWith: builder]
 				ifFalse:[self buildContentsWith: builder]).
 
 	^ builder build: windowSpec



The instance variables are

 Model subclass: #HelpBrowser
 	instanceVariableNames: 'rootTopic currentTopic currentParentTopic result 
                               searchTopic topicPath 
                               toplevelTopics oldTopic topicContentsSelection isUpdating'
	classVariableNames: 'DefaultHelpBrowser'
	poolDictionaries: ''
	category: 'HelpSystem-Core-UI'