Add legend of System browser icons

[jecisc]

Migrated case from Manuscript.

Original case: https://pharo.fogbugz.com/f/cases/20873 Status: Work Needed Project: Usability Original Author: CyrilFerlicot Date: 15 December 2017 11:58:29 pm

Description:

We have some users asking on Discord details about System Browser UI.

We should add a legend somewhere about text style and icons.

text style:

• italic for abstract classes
• strickthrough for deprecation
• grey for extension methods

class icons:

• ! => non commented classes
• C => non special class
• A grey circle => a test class. You can execute all the tests of the class by clicking on the circle
• An icon of small window => that's a morph. It is a graphical element that can be displayed.
• The small tootip => An announcement. This is something that can be annouced via the Observer/Announcer design pattern
• { } => This is a collection
• The lightnight => This is an exception
• T => This is a Trait. A Trait is an element defining a behaviour that can be used by different classes. It help to compensate the fact that there is not multiple inheritence
• ¶ => A string/symbole or its equivalent
• ∑ => a magnitude (includes characters, numbers, time...)

method icons:

• A grey circle => a test method or a tested method. You can executeit by clicking on the circle
• up arrow => the method override another method (you can click it to navigate to the methods)
• down arrow => the method is overriden in its subclasses (you can click it to navigate to the methods)
• up/down arrow => both at the same time (you can click it to navigate to the method)
• yellow exclamation point => There is a flag in the method. (via the method #flag:)
• red exclamation point => there is an halt/breakpoint in the method. If it is executed, it might stop and a debugger will open
• T => Method comes from a Trait
• A sort of union symbol => a method to define in order to use a Trait
• an "a" => abstract method

protocols icons:

• red square => private, be careful if you use the methods of this protocol. They are not intended to be used outside the class
• yellow diamond => initialisation, the code to initialize an object
• little folder => Extention protocol

[jecisc]

Reply: Author: Pavel Krivanek Date: 19 December 2017 7:43:45 am

Message:

Does it worth to fix this in Nautilus when it will be replaced with Calypso?

[jecisc]

Reply: Author: CyrilFerlicot Date: 19 December 2017 9:15:59 am

Message:

Why not fix it for both?

We can do a windows with a legend that open via an icon in the Browser.

I did not used Calypso a lot but it uses the same icons/styles no?

[jecisc]

Reply: Author: Denis Kudryashov Date: 16 April 2018 1:34:04 pm

Message:

Yes, these styles are same.

You wrote: "We should add a legend somewhere about text style and icons." But I did not find any proposal for "somewhere" :)