#OTHER by cg
authorClaus Gittinger <cg@exept.de>
Tue, 16 Jan 2018 22:13:58 +0100
changeset 17904 67216f3b83ea
parent 17903 da4d8d935304
child 17905 e0151dd19a58
#OTHER by cg big refactoring: replaced all flyByHelpXXX sends and implementations by helpXXX. This should remove the confusion on where the tooltips should be stored and which methods need to be redefined. ATTENTION: May introduce temporary inconveniences until all other applications (in exept:xxx packages) are changed.
AbstractSettingsApplication.st
--- a/AbstractSettingsApplication.st	Tue Jan 16 22:13:54 2018 +0100
+++ b/AbstractSettingsApplication.st	Tue Jan 16 22:13:58 2018 +0100
@@ -641,7 +641,7 @@
             addSingleWord value:helpKey string value:(#helpKey->eachSpec)
         ].
     ].
-    self flyByHelpSpec keys do:[:k |
+    self helpSpec keys do:[:k |
         helpKeys add:k.
         addSingleWord value:k value:#helpKeyTop
     ].
@@ -649,7 +649,7 @@
     helpKeys do:[:eachKey |
         |helpText|
         
-        helpText := self flyByHelpSpec at:eachKey ifAbsent:nil.
+        helpText := self helpSpec at:eachKey ifAbsent:nil.
         addEachWordXLated value:helpText value:(#helpText->eachKey).
     ].    
     ^ words 
@@ -1103,7 +1103,19 @@
 
 !AbstractSettingsApplication::AllSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpPairs
+    "to be redefined in subclasses"
+
+    "
+     UIHelpTool openOnClass:AbstractSettingsApplication::ByteCodeCompilerSettingsAppl
+    "
+
+    <resource: #help>
+
+    ^ #()
+!
+
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -1116,26 +1128,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom: self helpPairs
-!
-
-helpPairs
-    "This resource specification was automatically generated
-     by the UIHelpTool of ST/X."
-
-    "Do not manually edit this!! If it is corrupted,
-     the UIHelpTool may not be able to read the specification."
-
-    "
-     UIHelpTool openOnClass:AbstractSettingsApplication::ByteCodeCompilerSettingsAppl
-    "
-
-    <resource: #help>
-
-    ^ #(
-
-
-)
+    ^ super helpSpec addPairsFrom: self helpPairs
 ! !
 
 !AbstractSettingsApplication::AllSettingsAppl class methodsFor:'image specs'!
@@ -1381,7 +1374,7 @@
 
 !AbstractSettingsApplication::AutoloadedPackagesSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -1394,7 +1387,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 #autoloadedPackages
 'Select known packages from the left list, and click on ">>>" to add them to the autoloaded list.\These will be automatically loaded when ST/X is started without a snapshot image.\Packages are searched along the packagePath.'
 
@@ -1610,22 +1603,6 @@
 
 !AbstractSettingsApplication::BuildSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
-    "This resource specification was automatically generated
-     by the UIHelpTool of ST/X."
-
-    "Do not manually edit this!! If it is corrupted,
-     the UIHelpTool may not be able to read the specification."
-
-    "
-     UIHelpTool openOnClass:AbstractSettingsApplication::ByteCodeCompilerSettingsAppl
-    "
-
-    <resource: #help>
-
-    ^ super flyByHelpSpec addPairsFrom: self helpPairs
-!
-
 helpPairs
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
@@ -1649,6 +1626,22 @@
 
 
 )
+!
+
+helpSpec
+    "This resource specification was automatically generated
+     by the UIHelpTool of ST/X."
+
+    "Do not manually edit this!! If it is corrupted,
+     the UIHelpTool may not be able to read the specification."
+
+    "
+     UIHelpTool openOnClass:AbstractSettingsApplication::ByteCodeCompilerSettingsAppl
+    "
+
+    <resource: #help>
+
+    ^ super helpSpec addPairsFrom: self helpPairs
 ! !
 
 !AbstractSettingsApplication::BuildSettingsAppl class methodsFor:'image specs'!
@@ -1961,22 +1954,6 @@
 
 !AbstractSettingsApplication::ByteCodeCompilerSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
-    "This resource specification was automatically generated
-     by the UIHelpTool of ST/X."
-
-    "Do not manually edit this!! If it is corrupted,
-     the UIHelpTool may not be able to read the specification."
-
-    "
-     UIHelpTool openOnClass:AbstractSettingsApplication::ByteCodeCompilerSettingsAppl
-    "
-
-    <resource: #help>
-
-    ^ super flyByHelpSpec addPairsFrom: self helpPairs
-!
-
 helpPairs
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
@@ -2106,6 +2083,22 @@
 )
 
     "Modified: / 16-11-2016 / 22:59:16 / cg"
+!
+
+helpSpec
+    "This resource specification was automatically generated
+     by the UIHelpTool of ST/X."
+
+    "Do not manually edit this!! If it is corrupted,
+     the UIHelpTool may not be able to read the specification."
+
+    "
+     UIHelpTool openOnClass:AbstractSettingsApplication::ByteCodeCompilerSettingsAppl
+    "
+
+    <resource: #help>
+
+    ^ super helpSpec addPairsFrom: self helpPairs
 ! !
 
 !AbstractSettingsApplication::ByteCodeCompilerSettingsAppl class methodsFor:'image specs'!
@@ -3281,7 +3274,7 @@
 
 !AbstractSettingsApplication::ChangeFileSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -3294,7 +3287,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #changeFileName
 'The name of the file in which changes are recorded (for the Changebrowser)'
@@ -3825,7 +3818,7 @@
 
 !AbstractSettingsApplication::DebuggerSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -3838,7 +3831,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #allowSendingMail
 'Show the "Send mail to Exept support team" button. Requires proper email setup'
@@ -4141,14 +4134,6 @@
 
 !AbstractSettingsApplication::DisplaySettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
-    <resource: #help>
-
-    ^ super flyByHelpSpec addPairsFrom:(self helpPairs)
-
-    "Created: / 24-06-2014 / 19:39:38 / cg"
-!
-
 helpPairs
     <resource: #help>
 
@@ -4160,6 +4145,14 @@
 )
 
     "Created: / 24-06-2014 / 19:39:14 / cg"
+!
+
+helpSpec
+    <resource: #help>
+
+    ^ super helpSpec addPairsFrom:(self helpPairs)
+
+    "Created: / 24-06-2014 / 19:39:38 / cg"
 ! !
 
 !AbstractSettingsApplication::DisplaySettingsAppl class methodsFor:'image specs'!
@@ -4830,7 +4823,7 @@
 
 !AbstractSettingsApplication::EditSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -4843,7 +4836,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 "/#resetToDefault
 "/'Reset fonts back to original default values (as specified in the window style-file and OS settings)'
@@ -5430,7 +5423,7 @@
 
 !AbstractSettingsApplication::GeneralCompilerSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -5443,7 +5436,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #catchMethodRedefinition
 'Warn if an existing method from another package is redefined'
@@ -5870,7 +5863,7 @@
 
 !AbstractSettingsApplication::HTTPStartServerSettingsApplication class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -5883,7 +5876,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #createFCGIServer
 'Create (but do not start) a new FCGI server.\FCGI allows for a Smalltalk server to run under a master server (such as Apache)'
@@ -6523,7 +6516,7 @@
 
 !AbstractSettingsApplication::KbdMappingSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -6536,7 +6529,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #rawKeyList
 'Select an entry from this list of keys, to see the associated function in the right list.\To change, check the "Change" toggle below, then select the function to assign,\and finally press the "Apply" button'
@@ -7010,7 +7003,7 @@
 
 !AbstractSettingsApplication::LanguageSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -7023,7 +7016,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #useSystemLanguage
 'If set, the operating system language (LANG variable) is used in the next session\(and the setting here only affects the current session).\If clear, the language setting is also used in the next session.'
@@ -7651,7 +7644,7 @@
 
 !AbstractSettingsApplication::MemorySettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -7664,7 +7657,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #codeLimit
 'Flush dynamic compiled code to stay within this limit (never flush, if 0 or blank).\Because most of ST/X''s code is precompiled anyway (in contrast to other Smalltalk and Java systems),\this only affects code which is dynamically generated at execution time.\So a code limit is usually not needed/useful at all, and disabled by default'
@@ -8466,7 +8459,7 @@
 
 !AbstractSettingsApplication::MiscBridgeCommunicationSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -8479,7 +8472,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #dotNetBridge
 'The dotNet bridge extension allows transparent access and message sending to .NET classes and instances.'
@@ -8849,7 +8842,7 @@
 
 !AbstractSettingsApplication::MiscCommunicationSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -8862,7 +8855,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #smtpServer
 'The host name of your SMTP (mail transfer) server.\This is only needed for the debugger''s "Send Error Report via Mail" menu function,\so you can leave this empty if you don''t need or want this function'
@@ -9047,7 +9040,7 @@
 
 !AbstractSettingsApplication::MiscDisplay2SettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -9060,7 +9053,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #nativeWidgets
 'Use native widgets if possible (Scrollbars, Checktoggles, etc.)\Experimental and unfinished.\(Windows operating system ony)'
@@ -9486,7 +9479,7 @@
 
 !AbstractSettingsApplication::MiscDisplaySettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -9499,7 +9492,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #showAccelerators
 'Show shortcut-key bindings (if any) in popup menus'
@@ -10173,7 +10166,7 @@
 
 !AbstractSettingsApplication::MiscSmalltalkCommunicationSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -10186,7 +10179,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #windowMigration
 'The window migration service is available for X-display systems only.\It allows a window to be fetched from your screen and moved to another X-display' 
@@ -11060,17 +11053,19 @@
 
 !AbstractSettingsApplication::MiscSmalltalkCommunicationSettingsAppl methodsFor:'help specs'!
 
-flyByHelpTextForKey:aKey
-    |normalText|
-
-    normalText := super flyByHelpTextForKey:aKey.
+helpTextForKey:aKey
+    |normalText hasWindowMigrationServer|
+
+    hasWindowMigrationServer := self hasWindowMigrationServer.
+
+    normalText := super helpTextForKey:aKey.
     aKey == #windowMigration ifTrue:[
-        self hasWindowMigrationServer ifFalse:[
+        hasWindowMigrationServer ifFalse:[
             ^ normalText , (resources stringWithCRs:'\\Disabled because the windowMigration package is not loaded')
         ]
     ].
     aKey == #remoteBrowsing ifTrue:[
-        self hasWindowMigrationServer ifFalse:[
+        hasWindowMigrationServer ifFalse:[
             ^ normalText , (resources stringWithCRs:'\\Disabled because the remoteBrowsing package is not loaded')
         ]
     ].
@@ -11082,7 +11077,7 @@
        smallTeamXMPPUsers smallTeamXMPPUserToAdd
        addSmallTeamXMPPUser removeSmallTeamXMPPUser
     ) includes:aKey) ifTrue:[
-        self hasWindowMigrationServer ifFalse:[
+        hasWindowMigrationServer ifFalse:[
             ^ normalText , (resources stringWithCRs:'\\Disabled because the smallTeam package is not loaded')
         ]
     ].
@@ -11583,7 +11578,7 @@
 
 !AbstractSettingsApplication::PackagePathSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -11596,7 +11591,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 
 )
@@ -12581,7 +12576,7 @@
 
 !AbstractSettingsApplication::ProcessorSchedulerSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -12594,7 +12589,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #dynamicPriorities
 'If checked, the scheduler uses an adaptive dynamic priority scheme, where low priority background processes are guaranteed to make progress,\even if higher priority processes are constantly executing.\The algorithm is similar to the UNIX scheduler''s, where the dynamic priority of a long waiting process is increased slowly,\until it gets a chance to run. This is very useful for background tasks, such as print jobs'
@@ -12764,7 +12759,7 @@
 
 !AbstractSettingsApplication::RDoItServerSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -12777,7 +12772,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #rdoitDisabled
 'RDoit setup disabled, because the "stx:goodies/rdoit" package is not loaded.\To load, open the package load dialog via the Launcher''s "File"-"Load Package" menu item.\\Press the ''Help'' button for a description of what this does'
@@ -13409,7 +13404,11 @@
 
 !AbstractSettingsApplication::RDoItServerSettingsAppl methodsFor:'help'!
 
-flyByHelpTextForKey:aKey
+helpFilename
+    ^ 'Launcher/communicationsSettings.html'
+!
+
+helpTextForKey:aKey
     |usedKey|
     
     usedKey := aKey.
@@ -13423,11 +13422,7 @@
             usedKey := #scriptingDisabled
         ].    
     ].
-    ^ super flyByHelpTextForKey:usedKey.
-!
-
-helpFilename
-    ^ 'Launcher/communicationsSettings.html'
+    ^ super helpTextForKey:usedKey.
 ! !
 
 !AbstractSettingsApplication::RDoItServerSettingsAppl methodsFor:'queries'!
@@ -13475,7 +13470,7 @@
 
 !AbstractSettingsApplication::SQLServerSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -13488,7 +13483,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #sqlServer
 'The sql server is a pure Smalltalk application which implements the mySQL wire protocol,\and allows for a smalltalk application to simulate database tables.\One particular application presents classes and methods as tables.\\The SQL server is a non-free ST/X addon.'
@@ -17227,7 +17222,7 @@
 
 !AbstractSettingsApplication::SourceCodeManagementSettingsAppl::PerModuleManagerSettingDialog class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -17240,7 +17235,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #manager
 'Specify the source code manager which will be used for packages matching the above pattern'
@@ -18016,7 +18011,7 @@
 
 !AbstractSettingsApplication::SyntaxColorSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -18029,7 +18024,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #colorSelection
 'Choose a color for the selected element type'
@@ -19286,7 +19281,7 @@
 
 !AbstractSettingsApplication::SystemMessageSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -19299,7 +19294,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #vmInfo
 'Enable/disable information messages from the Virtual Machine (VM)'
@@ -19795,7 +19790,7 @@
 
 !AbstractSettingsApplication::TerminalViewSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -19808,7 +19803,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #terminalOutputIsUTF8
 'The shell''s (or command) output is UTF8 encoded (as opposed to Ascii/Latin-1).\Enable this on OSX and some modern Linux systems'
@@ -20491,7 +20486,7 @@
 
 !AbstractSettingsApplication::ToolsSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -20504,7 +20499,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #autoRaiseTranscript
 'Autoraise the Transcript window when messages are added'
@@ -21148,7 +21143,7 @@
 
 !AbstractSettingsApplication::WorkspaceSettingsAppl class methodsFor:'help specs'!
 
-flyByHelpSpec
+helpSpec
     "This resource specification was automatically generated
      by the UIHelpTool of ST/X."
 
@@ -21161,7 +21156,7 @@
 
     <resource: #help>
 
-    ^ super flyByHelpSpec addPairsFrom:#(
+    ^ super helpSpec addPairsFrom:#(
 
 #usersModuleName 
 'The name used as top-level module name (in the package-identifier) of your own classes and methods).\Will also be the top-level directory name inside the source code repository\and inside your workspace.'