Bug 140615 - Calc: Rename Show/hide comment icons to distinguish from separate show and hide
Summary: Calc: Rename Show/hide comment icons to distinguish from separate show and hide
Status: NEW
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Calc (show other bugs)
Version:
(earliest affected)
Inherited From OOo
Hardware: All All
: medium enhancement
Assignee: Not Assigned
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: UNO-Command-New UNO-Command-Label
  Show dependency treegraph
 
Reported: 2021-02-23 09:03 UTC by Timur
Modified: 2024-09-23 07:43 UTC (History)
4 users (show)

See Also:
Crash report or crash signature:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Timur 2021-02-23 09:03:54 UTC
In Calc we have multiple comment icons. 
To be clear and distinguish show/hide from show or hide icons, two need to be renamed. 

Icon "Show Comment" (uno:NoteVisible) should be renamed to “Show/Hide Comment”. 
Icon “Comments” (.uno:ShowAnnotations) should be renamed to “Show/Hide Comments”.
Comment 1 Heiko Tietze 2021-02-23 10:34:06 UTC
How about “Show/Hide All Comments”?
Comment 2 Timur 2021-02-23 16:18:52 UTC
The are two icons and I propose "Show/Hide Comment” and " Show/Hide Comments”.
For later " Show/Hide All Comments” is acceptable, but I think All is redundant.
Comment 3 Heiko Tietze 2021-02-25 15:34:44 UTC
Had this topic in the design meeting and the more clear distinction between singular and plural is welcome.

But let's have a closer look. Searching for "comment" in Calc's customization dialog returns:

officecfg/registry/data/org/openoffice/Office/UI/CalcCommands.xcu
.uno:CommentChange    | Comment
.uno:ShowAllNotes     | Show All Comments
.uno:NoteVisible      | Show Comment
.uno:ShowNote         | Show Comment

officecfg/registry/data/org/openoffice/Office/UI/GenericCommands.xcu 

.uno:InsertAnnotation | Comment (defined in CalcCommands.xcu too but with no tooltip nor accelerator key- cleaning-up sounds reasonable here)
.uno:ShowAnnotations  | Show Comment

.uno:NoteVisible is not used in any xml/ui file, .uno:ShowNote is the command in Calc's menubar.xml, cell.xml, and pagebreak.xml.
.uno:ShowAnnotations is on Calc's menubar.xml and notebookbar_groupedbar*.ui, not in the context menus.

So, if at all, we have to change .uno:ShowNote. I guess your concerns is the "Show" which is actually a toggle in Calc. Using a slash is an example for bad usability, the better solution would be "Toggle Comment Visibility"- sounds somewhat bulky to me. Better we do the same as on the main menu and have a checkbox on the context menu that makes the functionality more clear. To do so we need to merge .uno:HideNote and .uno:ShowNote into one command, which is unfortunately not an easyhack anymore.
Comment 4 Timur 2021-02-25 17:56:15 UTC
I don't know how and why it became so complicated, even I requested a simple change. 
"Toggle Comment" and "Toggle Comments" would do. 
Searching for "comment" in Calc has I think 11 entries and one must experiment to find those toggles that are most useful. 
When we have toggles that woek I don't understand why idea to merge separate show and hide,which I didn't ask and see no purpose.
Comment 5 Heiko Tietze 2021-02-26 08:31:40 UTC
Okay, here a shorter version of my comment

* uno:NoteVisible is defined for but not used in Calc
* uno:ShowNote is accomplished by uno:HideNote- both commands are visible depending on the actual comment state, visible or not
* uno:ShowAnnotations affects all comments, uno:ShowNote only the current one

* Using a "/" in a label is bad usability- and wrong since.
* The better solution is with a checkbox (like uno:ShowAnnotations works)
Comment 6 Maxim Monastirsky 2021-02-26 15:02:58 UTC
Having a checkbox in the context menu won't solve the issue with the customize dialog having two "Show comment" entries (for .uno:ShowNote and .uno:NoteVisible). Only renaming (or hiding) one of the commands might solve this part (with or without a checkbox). And the label used in the customize dialog doesn't necessarily have to be the same used in the context menu.

And FYI, .uno:NoteVisible already works as a checkbox, and the only reason it isn't used in the UI is that it works only with a single cell, not with a cell range (unlike .uno:ShowNote). So maybe we should just change .uno:NoteVisible, and use it instead?
Comment 7 Heiko Tietze 2021-03-01 08:53:27 UTC
(In reply to Maxim Monastirsky from comment #6)
> Having a checkbox in the context menu won't solve the issue with the
> customize dialog having two "Show comment" entries...

Of course, we would have to merge Show and Hide into one command- likewise it's done for .uno:ShowAnnotations. 

> .uno:ShowNote... So maybe we should just change .uno:NoteVisible, and use it instead?

Timur, what do you think about this idea?
Comment 8 Maxim Monastirsky 2021-03-01 09:47:47 UTC
(In reply to Heiko Tietze from comment #7)
> Of course, we would have to merge Show and Hide into one command- likewise
> it's done for .uno:ShowAnnotations. 
Sorry, but you seem to not understand the problem reported by Timur. Merging commands will *not* solve this issue at all. And .uno:ShowAnnotations can't be an example of a solution, because it actually has the same problem - as there are also non-toggle .uno:ShowAllNotes and .uno:HideAllNotes commands for show/hide all comments.
Comment 9 Rafael Lima 2023-03-30 15:07:11 UTC
So I took a look at this request and indeed the command uno:NoteVisible (as well as its slot FID_NOTE_VISIBLE) is not really used anywhere in Calc (besides implementing itself).

I was wondering if we should even have this command... maybe remove it entirely? This might be a solution, since its functionality is already covered by other commands. And I could not find anything in the code that relies on this command.

The only use case for this command is maybe for macros/scripts.

If we decide to keep the uno:NoteVisible command, we could simply rename it to something else as "Show Comment in Cell". I know its a bit long, but its not used in the UI by default anyways, so no one will complain.