[squeak-dev] Note sharing inside Squeak?

karl ramberg karlramberg at gmail.com
Tue May 31 05:45:52 UTC 2022


Thanks for feedback. It works with alt+5.
I thought I tested with alt, but it turns out I tested on a weird keyboard
where there is another key between alt and the space bar. Facepalm

Uploaded update to help text to the inbox

Best,
Karl

On Mon, May 30, 2022 at 11:22 PM Jakob Reschke <jakres+squeak at gmail.com>
wrote:

> Hi,
>
> On Windows, I can access the dialog with Alt+5 both in a workspace and in
> a system browser.
> With Ctrl+5 I get to the docking bar menus, too.
> If the preferences work as they used to, one can probably swap the Ctrl
> and Alt behaviors.
>
> Kind regards,
> Jakob
>
> Am Mo., 30. Mai 2022 um 21:14 Uhr schrieb karl ramberg <
> karlramberg at gmail.com>:
>
>> Ctrl-5 or 6 brings up the DockingBar menus.
>> Sadly I don't think the text emphasis menu is possible to reach on
>> Windows :-(
>>
>> Excerpts from Help menu/ Keyboard shortcuts that can't be used on windows:
>>
>> Text Emphasis
>> (not available on all platforms)
>> Cmd-1 type the first method argument
>> Cmd-2 type the second method argument
>> Cmd-3 type the third method argument
>> Cmd-4 type the fourth method argument
>> Cmd-5 color, action-on-click, link to class comment, link to method, url,
>> custom attributes (brings up a menu)
>> Cmd-6 italic
>> Cmd-7 bold
>> Cmd-8 struck-out
>> Cmd-9 underlined
>> Cmd-0 make plain (removes all attributes)
>>
>> Best,
>> Karl
>>
>> On Mon, May 30, 2022 at 8:52 PM tim Rowledge <tim at rowledge.org> wrote:
>>
>>> It's that -
>>>
>>> cmd-6 (ctl-6 on windows I think) opens a little dialog
>>>
>>> that does it. As long as you are focussed in a text morph.
>>>
>>> > On 2022-05-30, at 11:36 AM, Jaromir Matas <mail at jaromir.net> wrote:
>>> >
>>> > I can’t figure out how you got the menu - from where?
>>> > Thanks :)
>>> >
>>> > From: tim Rowledge
>>> > Sent: Monday, May 30, 2022 19:37
>>> > To: The general-purpose Squeak developers list
>>> > Subject: Re: [squeak-dev] Note sharing inside Squeak?
>>> >
>>> > cmd-6 (ctl-6 on windows I think) opens a little dialog
>>> >
>>> > <Screen Shot 2022-05-30 at 10.35.44 AM.png>
>>> >
>>> > with those 'Link' options. If we added a 'Link to Help' it would
>>> become very easy to connect a few words in a method/code comment to a more
>>> expansive explanation in the Help browser.
>>> >
>>> >
>>> > On 2022-05-30, at 4:15 AM, Marcel Taeumel <marcel.taeumel at hpi.de>
>>> wrote:
>>> >
>>> > Hi Jaromir --
>>> >
>>> > > but I don’t even know if such linking to a help is possible and how.
>>> >
>>> > Don't forget that you can always explain to the user where that
>>> information is located.
>>> > For example, if you created a new help topic, just write "For more
>>> information, see
>>> > the Help Browser and the topic X."  No need to get too fancy with text
>>> actions.
>>> >
>>> > SqueakLicenseHelp openHelpBrowser
>>> > model showTopicNamed: #officialLicense.
>>> >
>>> > SqueakLicenseHelp openHelpBrowser
>>> > model showFirstTopic.
>>> >
>>> > That's as convenient as it gets for now. :-)
>>> >
>>> > Best,
>>> > Marcel
>>> >
>>> > Am 30.05.2022 12:43:58 schrieb Jaromir Matas <mail at jaromir.net>:
>>> >
>>> > Hi Marcel,
>>> >
>>> >
>>> >
>>> > > I would rather not remove such information too far from the method
>>> itself.
>>> >
>>> >
>>> >
>>> > Exactly my concern. If it was in a help somewhere there would have to
>>> be a link included in the method… but I don’t even know if such linking to
>>> a help is possible and how.
>>> >
>>> > Thanks!
>>> >
>>> >
>>> >
>>> > --
>>> >
>>> > Jaromír Matas
>>> >
>>> > mail at jaromir.net
>>> >
>>> >
>>> >
>>> > From: Marcel Taeumel
>>> > Sent: Monday, May 30, 2022 11:31
>>> > To: squeak-dev
>>> > Subject: Re: [squeak-dev] Note sharing inside Squeak?
>>> >
>>> >
>>> >
>>> > Hi Jaromir --
>>> >
>>> >
>>> >
>>> > You can also append another longer comment to the end of that method.
>>> There are examples of this in the image. Somewhere. :-)
>>> >
>>> >
>>> >
>>> > I would rather not remove such information too far from the method
>>> itself.
>>> >
>>> >
>>> >
>>> > Best,
>>> >
>>> > Marcel
>>> >
>>> > Am 30.05.2022 02:33:37 schrieb tim Rowledge <tim at rowledge.org>:
>>> >
>>> > My suggestion is that notes about details of the method should be
>>> method comments until they get really long. If that happens I would expect
>>> that quite a few related methods might have need of extensive commentary
>>> too and in that case it would be smart to add a help page to explain the
>>> whole thing.
>>> > If the comments are too long for the top of the method it doesn't hurt
>>> to have more at the bottom.
>>> >
>>> > > On 2022-05-29, at 3:38 PM, Jaromir Matas wrote:
>>> > >
>>> > > John,
>>> > > Thanks for your reply. It was my initial idea to possibly use
>>> comments but there’s few issues with that approach IMO:
>>> > > 1) creating a version for each comment change may be
>>> counterproductive (too many versions, the method authorship - it’s better
>>> to have fewer versions with easily identifiable authors)
>>> > > 2) only core developers could update trunk comments; I wouldn’t want
>>> to place that burden on anybody
>>> > >
>>> > > But yeah, maybe I could try to put some more stuff and examples as a
>>> comment after the code. But a more informal but easily reachable place
>>> would still be nice.
>>> > >
>>> > > Best,
>>> > > Jaromir
>>> > >
>>> > > --
>>> > > Jaromír Matas
>>> > > mail at jaromir.net
>>> > >
>>> > > From: John-Reed Maffeo
>>> > > Sent: Monday, May 30, 2022 0:04
>>> > > To: The general-purpose Squeak developers list
>>> > > Subject: Re: [squeak-dev] Note sharing inside Squeak?
>>> > >
>>> > > jaromir,
>>> > >
>>> > > Who said comments should be terse and polished?
>>> > >
>>> > > It would be more helpful to people like myself (still a nube after
>>> 30+ years) to see a long, complex entry into a method's comment than no
>>> comment at all! Putting comments in some other place is counter productive
>>> in my mind.
>>> > >
>>> > > Why not put a usage example into comments or the body of the text
>>> itself?
>>> > >
>>> > > - jrm
>>> > >
>>> > > On Sun, May 29, 2022 at 12:56 PM Jaromir Matas wrote:
>>> > > Hi all,
>>> > > In your experience, what would be a good place to *share* more
>>> detailed information about e.g. a method: like why I had to include this
>>> line and that check, which situations must be taken into account,
>>> alternative approaches, examples, references to tests  etc etc. Ideally
>>> reachable from the image. Would such "notesharing" be welcome or rather
>>> confusing or even conterproductive? Often I forget why I did this and that
>>> and have to check my notes (if I'm lucky to have made them AND find them).
>>> I'm aware method comments are definitely not the place; they are meant to
>>> be rather terse and polished. Squeak wiki? Squeak Help? They’d have to be
>>> linked somehow to the methods, I imagine, to be useful in this regard…
>>> > > Any suggestion welcome :)
>>> > > Best,
>>> > > Jaromir
>>> > >
>>> > > --
>>> > >
>>> > > Jaromír Matas
>>> > >
>>> > > mail at jaromir.net
>>> > >
>>> > >
>>> > >
>>> > >
>>> > >
>>> > > --
>>> > > John-Reed Maffeo
>>> >
>>> >
>>> > tim
>>> > --
>>> > tim Rowledge; tim at rowledge.org; http://www.rowledge.org/tim
>>> > Common sense – so rare it’s a goddam superpower
>>> >
>>> >
>>> >
>>> >
>>> >
>>> >
>>> >
>>> >
>>> > tim
>>> > --
>>> > tim Rowledge; tim at rowledge.org; http://www.rowledge.org/tim
>>> > Useful random insult:- Couldn't pour water out of a boot with
>>> instructions on the heel.
>>> >
>>>
>>>
>>> tim
>>> --
>>> tim Rowledge; tim at rowledge.org; http://www.rowledge.org/tim
>>> No single raindrop believes it is to blame for the flood
>>>
>>>
>>>
>>>
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.squeakfoundation.org/pipermail/squeak-dev/attachments/20220531/5c1024c1/attachment.html>


More information about the Squeak-dev mailing list