[squeak-dev] Separate documentation (was: Default preferences)

gettimothy gettimothy at zoho.com
Sun Nov 28 20:39:16 UTC 2021

I have been piddling around with this to see what I can see to generate a starting point for thinking about this.

An obvious first step would be to show all the preferences associated with a "thing"




are just a few of the things that have preferences on them:

Transcript clear.

(SystemNavigation allMethodsSelect:[:mds | 

      #(preference:category:description:type: preference:categoryList:description:type:)

            anySatisfy:[:s| (mds pragmaAt: s) notNil]])

                  do:[:m |

                        Transcript show: (m methodSymbol)  ; cr.

                        m compiledMethod pragmas do:[:pragma |

                                                Transcript show: ((pragma methodClass name)copyReplaceAll:'class' with:'  '); cr;cr.

                                                 Transcript show: (pragma);cr;cr;cr;cr.]]

Per what Tim writes below...

We should be able to automate that task by modifying "something" programatically.


Would it make sense to add the preferences toggling directly to the menus for specific things?

fileOutFilePath and fileOutOnAccept strike me as useful things to be viewed and modified in any Workspace.


---- On Sat, 27 Nov 2021 23:29:47 -0500 tim Rowledge <tim at rowledge.org> wrote ----

> On 2021-11-27, at 2:56 PM, Thiede, Christoph <mailto:Christoph.Thiede at student.hpi.uni-potsdam.de> wrote:
> But IMHO separate help documents should be used with caution - in my experience, they are looked up significantly rarer than help content that is integrated right into the domain (method comments, class comments, tooltips, maybe help buttons).

Something that would probably help here is making sure that when a class (or group of classes etc) has a HelpBrowser section, we reference that Help stuff from the class(es) & method comments. We have the ability to link a bit of text to class comments, definitions, methods and so on, so maybe we could add one to a HelpBrowser section? 

Hmm, a few minutes whacking suggests that a simple subclass of TextAction would do the job, along with a bit more understanding of the right way to open a help browser on a suitable topic. Maybe tomorrow.

tim Rowledge; mailto:tim at rowledge.org; http://www.rowledge.org/tim
Objects are closer than they appear.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.squeakfoundation.org/pipermail/squeak-dev/attachments/20211128/49a23112/attachment.html>

More information about the Squeak-dev mailing list