I am just doing the same for the Preference Browser. Could someone tell me what would be the practice here?
I could use *override extension methods, but this would still leave some shadows ...
Should we keep #versionsHelpString in the VersionsBrowser at all, which contains a deprecated version of SqueakToolsVersionsBrowserHelp?
Couldn't we implement VersionsBrowser >> #offerVersionsHelp something like this:
Smalltalk
at: #SqueakToolsVersionsBrowserHelp
ifPresent: #open
ifAbsent: [self inform: 'You need to install Help in order to get help.\For more information on how to install Help, please read the help.' withCRs translated]
That is, drop the help support if Help is not installed?
Best,
Christoph
http://www.hpi.de/ ________________________________ Von: Squeak-dev squeak-dev-bounces@lists.squeakfoundation.org im Auftrag von Thiede, Christoph Gesendet: Freitag, 15. November 2019 19:23:21 An: squeak-dev@lists.squeakfoundation.org Betreff: Re: [squeak-dev] The Inbox: Help-Squeak-Project-ct.72.mcz
I see that shadowing #offerVersionsHelp might cause further problems, for example, updating Help-Squeak-Project will remove the method from Tools and vice versa. However, what would you consider the best way to create a link from the Versions Browser to the help topic instead of showing that old-fashioned Workspace? We do not want a dependency from Tools to Help, do we?
Best,
Christoph
________________________________ Von: Squeak-dev squeak-dev-bounces@lists.squeakfoundation.org im Auftrag von commits@source.squeak.org commits@source.squeak.org Gesendet: Freitag, 15. November 2019 19:19:51 An: squeak-dev@lists.squeakfoundation.org Betreff: [squeak-dev] The Inbox: Help-Squeak-Project-ct.72.mcz
A new version of Help-Squeak-Project was added to project The Inbox: http://source.squeak.org/inbox/Help-Squeak-Project-ct.72.mcz
==================== Summary ====================
Name: Help-Squeak-Project-ct.72 Author: ct Time: 15 November 2019, 7:19:49.347005 pm UUID: 4fd12cfe-84a9-ef46-bb9b-127004798eea Ancestors: Help-Squeak-Project-mt.69
Migrates VersionsBrowser>>versionsHelpString into a HelpTopic class
Depends on Collections-ct.861.
=============== Diff against Help-Squeak-Project-mt.69 ===============
Item was added: + SqueakToolsHelp subclass: #SqueakToolsVersionsBrowserHelp + instanceVariableNames: '' + classVariableNames: '' + poolDictionaries: '' + category: 'Help-Squeak-Project'!
Item was added: + ----- Method: SqueakToolsVersionsBrowserHelp class>>bookName (in category 'accessing') ----- + bookName + <generated> + ^'Versions Browser'!
Item was added: + ----- Method: SqueakToolsVersionsBrowserHelp class>>comparingVersions (in category 'pages') ----- + comparingVersions + <generated> + "This method was automatically generated. Edit it using:" + "SqueakToolsVersionsBrowserHelp edit: #comparingVersions" + ^(HelpTopic + title: 'Comparing versions' + contents: + 'The code pane shows the source for the selected version. If "diffing" is in effect, then differences betwen the selected version and the version before it are pointed out in the pane. Turn diffing on and off by choosing "toggle diffing" from the list pane menu, or hitting the "diffs" button, or hitting cmd-D when the cursor is over the list pane. + + To get a comparison between the selected version and the current version, choose "compare to current" from the list pane menu or hit the "compare to current" button. (This is meaningless if the current version is selected, and is unnecessary if you''''re interested in diffs from between the current version and the next-most-recent version, since the standard in-pane "diff" feature will give you that.) + + You can also compare the selected version with any other version using the "compare to version..." menu choice.!! + ]style[(13 337 19 496)b,,b,!!' readStream nextChunkText) + key: #comparingVersions; + shouldStyle: false; + yourself!
Item was added: + ----- Method: SqueakToolsVersionsBrowserHelp class>>defaultPage (in category 'accessing') ----- + defaultPage + + ^ #versionsBrowser!
Item was added: + ----- Method: SqueakToolsVersionsBrowserHelp class>>notes (in category 'pages') ----- + notes + <generated> + "This method was automatically generated. Edit it using:" + "SqueakToolsVersionsBrowserHelp edit: #notes" + ^(HelpTopic + title: 'Notes' + contents: + 'If further versions of the method in question have been submitted elsewhere since you launched a particular Versions Browser, it will still stay nicely up-to-date if you''re in Morphic and have asked that smart updating be maintained; if you''re in mvc or in morphic but with smart-updating turned off, a versions browser is only brought up to date when you activate its window (and when you issue "revert" from within it, of course,) and you can also use the "update list" command to make certain the versions list is up to date. + + The annotation pane in versions browsers shows information about the current version of the method in the image, not about the selected version.!! + ]style[(530 19 50 7 68),b,,i,!!' readStream nextChunkText) + key: #notes; + shouldStyle: false; + yourself!
Item was added: + ----- Method: SqueakToolsVersionsBrowserHelp class>>pages (in category 'accessing') ----- + pages + <generated> + ^ #(versionsBrowser comparingVersions revertVersion privacyFeatures notes)!
Item was added: + ----- Method: SqueakToolsVersionsBrowserHelp class>>privacyFeatures (in category 'pages') ----- + privacyFeatures + <generated> + "This method was automatically generated. Edit it using:" + "SqueakToolsVersionsBrowserHelp edit: #privacyFeatures" + ^(HelpTopic + title: 'Privacy features' + contents: + 'To have the selected method deleted from the current change set permanently, hit the "remove from changes" button, or choose the corresponding command in the list pane menu. This is useful if you''ve put debugging code into a method, and now want to strip it out and cleanse your current change set of all memory of the excursion.!! + ]style[(35 294)b,!!' readStream nextChunkText) + key: #privacyFeatures; + shouldStyle: false; + yourself!
Item was added: + ----- Method: SqueakToolsVersionsBrowserHelp class>>revertVersion (in category 'pages') ----- + revertVersion + <generated> + "This method was automatically generated. Edit it using:" + "SqueakToolsVersionsBrowserHelp edit: #revertVersion" + ^(HelpTopic + title: 'Reverting versions' + contents: + 'To revert to an earlier version, select it (in the list pane) and then do any of the following: + * Choose "revert to this version" from the list pane menu; + * Hit the "revert" button; + * Type ENTER in the code pane; + * Type cmd-s (alt-s) in the code pane.!! + ]style[(32 64 155)b,,I1!!' readStream nextChunkText) + key: #revertVersion; + shouldStyle: false; + yourself!
Item was added: + ----- Method: SqueakToolsVersionsBrowserHelp class>>versionsBrowser (in category 'pages') ----- + versionsBrowser + <generated> + "This method was automatically generated. Edit it using:" + "SqueakToolsVersionsBrowserHelp edit: #versionsBrowser" + ^(HelpTopic + title: 'What is a Versions Browser' + contents: + 'The VersionsBrowser is a window that shows all implementations of a method or a class comment that have been ever installed in past or present. Inter alia, it allows you to compare certain versions or revert earlier versions. + + Each entry in the list pane represents a version of the source code for the same method; the topmost entry is the current version, the next entry is the next most recent, etc.!! + ]style[(4 15 208 175)f1b,Rcode://VersionsBrowser browseMethod: VersionsBrowser >> #compareToOtherVersion;b,f1,!!' readStream nextChunkText) + key: #versionsBrowser; + shouldStyle: false; + yourself!
Item was added: + ----- Method: VersionsBrowser>>offerVersionsHelp (in category '*Help-Squeak-Project') ----- + offerVersionsHelp + + ^ HelpBrowser openOn: SqueakToolsVersionsBrowserHelp!