Bug 134432 - UI Confusing icon names for Background Color / Highlight Color
Summary: UI Confusing icon names for Background Color / Highlight Color
Status: VERIFIED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Writer (show other bugs)
Version:
(earliest affected)
7.1.0.0.alpha0+
Hardware: All All
: medium enhancement
Assignee: sdc.blanco
URL:
Whiteboard: target:7.2.0
Keywords: difficultyMedium, easyHack, skillDesign, topicDesign
Depends on:
Blocks: Button-Controls
  Show dependency treegraph
 
Reported: 2020-07-01 11:15 UTC by NISZ LibreOffice Team
Modified: 2021-03-11 07:37 UTC (History)
8 users (show)

See Also:
Crash report or crash signature:


Attachments
Example file from Writer with highlight and background color applied (8.39 KB, application/vnd.oasis.opendocument.text)
2020-07-01 11:15 UTC, NISZ LibreOffice Team
Details
Screenshot of the problem in Writer with Customize dialog (52.66 KB, image/png)
2020-07-01 11:18 UTC, NISZ LibreOffice Team
Details

Note You need to log in before you can comment on or make changes to this bug.
Description NISZ LibreOffice Team 2020-07-01 11:15:06 UTC
Created attachment 162554 [details]
Example file from Writer with highlight and background color applied

The Formatting toolbar in Writer has two icons: Highlight Color (uno:BackColor) and Background Color (uno:BackGroundColor) to set character highlight color and paragraph background color.
A user of ours started to customize their toolbar and accidentally put on Background Color instead of Highlight Color. Then they were confused that the icon sets the whole paragraphs background instead of the character highlight.

I think the naming of these icons is confusingly short, since many objects can have Background Color, which ones background does this change and it’s not really obvious how highlight color is ANY different of that.

Steps to reproduce:
    1. Go to Formatting toolbar -> Visible buttons menu
    2. Enable Background Color item (Highlight Color is enabled by default)
    3. Select a word from a paragraph of text and use both buttons.

Actual results:
Ask someone who is does not have deep understanding of LO to explain why they give different results.

Expected results:
More self explanatory labels: 
Character Highlight Color 
Paragraph Background Color 
(or something like these)

LibreOffice details:
Version: 7.1.0.0.alpha0+ (x64)
Build ID: 010713e65ccade7b682c219707c8db3d864145c1
CPU threads: 4; OS: Windows 6.3 Build 9600; UI render: default; VCL: win
Locale: en-US (hu_HU); UI: en-US
Calc: CL
Comment 1 NISZ LibreOffice Team 2020-07-01 11:18:21 UTC
Created attachment 162555 [details]
Screenshot of the problem in Writer with Customize dialog
Comment 2 Telesto 2020-07-01 18:43:54 UTC Comment hidden (no-value)
Comment 3 Heiko Tietze 2020-07-03 10:05:57 UTC
(In reply to NISZ LibreOffice Team from comment #0)
> Character Highlight Color 
> Paragraph Background Color 

Or we provide a tooltip.


(In reply to Telesto from comment #2)
> why are DOCX background shading imported as highlighting. 

See bug 125268, http://zolnaitamas.blogspot.com/2015/03/word-compatible-text-highlighting-in.html and ESC minutes from 2020-Apr-09
Comment 4 Heiko Tietze 2020-07-09 07:27:49 UTC
No further opinion, I support the idea. 

.uno:BackGroundColor is a generic command and used in other modules as well. For example the cell background in Calc. Makes no sense to call it Paragraph BGColor meaning we have to split the commands. 

Still an easyhack, find the UNO commands in WriterCommands.xcu and GenericCommands.xcu
Comment 5 Heiko Tietze 2020-07-09 08:26:14 UTC
Sophie: "translation in French will give Mise en évidence de la couleur des caractères for Character Highlight Color, so a bit long for an entry label"

Any chance to shorten this?
Comment 6 Thomas Lendo 2020-07-12 12:17:06 UTC
(In reply to NISZ LibreOffice Team from comment #0)
> Character Highlight Color 
> Paragraph Background Color
I like the additional wording as highlight and background alone never were easy to explain to others.
Comment 7 S.Zosgornik 2020-07-14 09:35:18 UTC
When you already change those icons do I suggest you change the icon labelling text for the english UI as well for labels that sounds more familiar and easier to recognize.

The terms "Character Highlighting Color"" and "Paragraph Highlighting Color" explains well to me what is actually changed and also are different in context to each other (character / paragraph).

Furthermore, I suggest to remove the current (color) name out of any labels for any translations for the reason that the current color is already represented underlying the icon itself.
Comment 8 sdc.blanco 2021-01-14 08:37:31 UTC
Here is a patch that changes "Highlight Color" to "Character Highlighting Color" in Writer.  

https://gerrit.libreoffice.org/c/core/+/109131

The reason to choose "Highlighting" was for consistency with the "Highlighting" tab in the Paragraph Style and Character dialogs, which control the same appearance as "Character Highlighting Color"

The patch does not change the Background Color, so maybe it can be considered "a step in the right direction" or maybe it gives enough contrast to Background Color that no further change is needed.

Or maybe "Background Fill Color" is a better label than "Paragraph Background Color" -- because 
(a) it could be used for both Calc and Writer, without having to make a new .uno,
(b) closer to "Fill Color" which is used for shapes, and 
(c) "Background Fill Color" would better "explain" why applying (the current) "Background Color" to two empty paragraphs will fill the whole canvas (for those two paragraphs), while I would expect "Paragraph Background Color" to "stop" at the pilcrow.

If "Background Fill Color" would be a viable generic label, then I could make a new patch.
Comment 9 Commit Notification 2021-01-18 12:27:29 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/2ee26f786431bba97134f75ac3f9440712562f2a

tdf#134432 change "Highlight Color" to "Character Highlighting Color"

It will be available in 7.2.0.

The patch should be included in the daily builds available at
https://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
https://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
Comment 10 Commit Notification 2021-01-19 12:12:51 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/9faffcbab37c682baf4a3826218f69b5bb6cb9ba

tdf#119753 (related: tdf#134432) update help pages for Highlight Color
Comment 11 sdc.blanco 2021-01-19 15:13:08 UTC
Highlight Color is now "Character Highlighting Color"
and documentation is updated:
https://help.libreoffice.org/7.2/en-US/text/shared/02/02160000.html

Question to NISZ LibreOffice Team (and others):

Do you think "Background Color" also/still needs to be changed? 

Comment 8 suggests "Background Fill Color" (and argues against "Paragraph Background Color). But maybe not necessary to change "Background Color", now that "Highlight Color" is changed?
Comment 12 sdc.blanco 2021-02-15 16:47:26 UTC
Search for Highlight in the (Tools >) Customize dialog.
"Character Highlighting Color" and "Highlight Color" appear.

If you do not know the difference between the two .unos, then it is hard (impossible) to know from the current labeling what to choose when customizing, and what differences might exist. 

Here is a patch that changes the label for "Highlight Color" to "Character Highlighting Color (in Text Box and Shapes)".  

https://gerrit.libreoffice.org/c/core/+/110865

The label would only appear in the Customize dialog. The menu item (in the dialog box) and tooltip for "Highlight Color" would not be changed by this patch, but it should clarify the meaning of "Highlight Color" in the Writer dialog. Changing this label will also result in the same change for the other modules, but again only in the Customize dialog, which should not create confusion.
Comment 13 sdc.blanco 2021-02-15 16:55:45 UTC
Need an (some) opinion(s):

The icon for Character Highlighting Color on the Formatting bar appears to remain the same when you move the cursor from text in the document canvas to text in a text box or shape. However, if you look at the tooltip for this icon, you will see that it changes from "Character Highlighting Color" to "Highlight Color").

The reason for the tooltip change is that a different .uno command is used for highlighting text in textboxes and shapes. (see comment 12).

(afaict, the .unos have the same effect, applying <style:text-properties fo:background-color> )

In this case, a change in the "Highlight Color" tooltip  (to "Character Highlighting Color") to accommodate Writer would change the "Highlight Color" tooltip/label to "Character Highlighting Color" for all modules.

However, it should be possible (with TargetURL) to make a .uno:CharBackColor alias for Writer, so that an  updated tooltip only appears in Writer alone (for the textbox and shape case), without affecting the other modules.

Alternatively, maybe the tooltip  label should be changed to "Character Highlighting Color" for UI consistency with the other modules as well?

Or maybe leave everything as is in it present state?

I have no opinion, hence my query.
Comment 14 sdc.blanco 2021-02-16 06:11:27 UTC
(In reply to sdc.blanco from comment #13)
> Maybe the tooltip label should be changed to "Character
> Highlighting Color" for UI consistency with the other modules as well?
Good choice. The icon behaves similarly for Calc, Draw and Impress (i.e., appears on the Text Formatting toolbar). Also, like Writer, Draw and Impress have a highlighting tab in the Character dialog. 
 
Beyond consistency across modules, it also allows for use of same icon for both text and for textboxes and shapes, and for use/reuse of the recently-revised help page for all modules (but it still needs some switches to handle some variations between the modules):
https://help.libreoffice.org/7.2/en-US/text/shared/02/02160000.html

This patch makes the proposed modifications to the tooltip and labels:
https://gerrit.libreoffice.org/c/core/+/110865
Comment 15 Commit Notification 2021-02-18 22:30:26 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/37157772a1888cd0c227ded2311afd0abe6d02ef

tdf#134432  icon label to "Character Highlighting Color" for Shapes

It will be available in 7.2.0.

The patch should be included in the daily builds available at
https://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
https://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
Comment 16 sdc.blanco 2021-02-20 08:50:37 UTC
The OP was about problems that arose from using the "Customize" dialog.
With the two patches so far, if you search for "highlight" in this dialog, you get two "Character Highlighting Color" commands, with a tooltip that explains their difference.  But there is one additional command, "Highlight Fill", that appears when searching for "highlight". 

I have added it to a toolbar and a menu to experiment with it, but it does not seem to work by itself, seems more like a kind of "helper" function for Character Highlighting, and should not be offered in the Customize dialog.  (It does not have an icon either).  But maybe someone here can give more information?

Maybe this command should be hidden from Customize? 

If that is a good idea, then I believe: 
https://gerrit.libreoffice.org/c/core/+/111177  
will hide this command from the Customize dialog.
Comment 17 Heiko Tietze 2021-02-22 10:25:12 UTC
My guess: If you shift+click the color bucket you can apply the color to many places (the cursor changes into some kind of paint bucket). The action to apply the color is likely this "Highlight Fill" (.uno:CharBackgroundExt).

+1 to hide it from the customization
Comment 18 Commit Notification 2021-02-24 08:50:05 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/aecd59c806e24e4da5ad5fb5847d2ca258a91ebc

tdf#134432 remove .uno:CharBackgroundExt from Writer UI

It will be available in 7.2.0.

The patch should be included in the daily builds available at
https://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
https://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
Comment 19 Commit Notification 2021-02-28 19:08:44 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/cbb467e2570715fadf08fe4ac964bdfe6397f535

tdf#134432  refine the labelling appearance for .uno:CharBackColor

It will be available in 7.2.0.

The patch should be included in the daily builds available at
https://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
https://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
Comment 20 sdc.blanco 2021-03-01 21:08:08 UTC
I think this bug can be closed now, without changing Background Color.

The OP was about a user who chose the wrong command for highlighting in a toolbar customization.

Now, in the Customize dialog, if you search for "highlight", you get only  "Character Highlighting Color" as an option, twice, but with the difference indicated in the tooltip. Admittedly a little obscure, but can we assume enough for a user who is using Customize? Or are there suggestions for improvements in the labelling?

Take a look in Tools > Customize and search on "highlight" and see what you think.
(I have been working with it too long to be able to see it with a "fresh" perspective).

Also if you search for "color", then "Background Color" appears, but so does "Character Highlighting Color".  That should be sufficient for users to make the right choice. 

In short, the current version in master is the proposal for how to address the problem of choosing the right .uno in Customize -- and maybe the change in the tooltip label on the icon in the Formatting toolbar also makes it easier to choose that icon over "Background Color".

(Meanwhile, probably Color Palette and Font Color Fill should be hidden, and the two Font Color need to be differentiated better - but I will leave it others to do that, or to file bug reports.)
Comment 21 S.Zosgornik 2021-03-02 14:51:55 UTC
I still suggest to include the word "paragraph" in the paragraph background color either as "Paragraph Background Color" or "Paragraph Highlighting Color"
Comment 22 sdc.blanco 2021-03-02 15:23:55 UTC
(In reply to S.Zosgornik from comment #21)
Thanks for feedback.
> I still suggest to include the word "paragraph" in the paragraph background
> color either as "Paragraph Background Color"
I still believe it is misleading, mostly because of point (c) in comment 8.
and "Paragraph Highlighting Color" is likely to recreate the problem that motivated this bug report (i.e., users not being able to decide which command to choose in Customize for making highlighting).
Comment 23 S.Zosgornik 2021-03-02 20:32:32 UTC
In Comment #8 do you say:
The reason to choose "Highlighting" was for consistency with the "Highlighting" tab in the Paragraph Style and Character dialogs, which control the same appearance as "Character Highlighting Color"

But now in LibO 7.1 we have a "Highlighting" tab in the character dialog and an "Area" tab in the paragraph dialog. "Paragraph Area Color" in the toolbar would provide consistency to the dialog and would work better to most users.
"Background Color" sounds rather confusing to me since both, characters and paragraphs can have a background fill color on its own.
Comment 24 Commit Notification 2021-03-04 11:23:28 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/32c582fe61715f10c4eeaf15aa0a7ac7af2388fc

tdf#134432 add module switches to "Character Highlighting"
Comment 25 sdc.blanco 2021-03-08 11:52:39 UTC
(In reply to NISZ LibreOffice Team from comment #0)
> Actual results:
> Ask someone who is does not have deep understanding of LO to explain why
> they give different results.
Sounds like a good test to try again, now that "Highlight Color" is changed to "Character Highlighting Color".  

Closing this bug as FIXED, in the belief that the changes address the problem described in OP, and the help page for "Character Highlighting Color" is also updated. https://help.libreoffice.org/7.2/en-US/text/shared/02/02160000.html

If there are concerns about the name of Background Color, then suggest that a new ticket be opened about whether/how to change the name.

(In reply to S.Zosgornik from comment #23)
> both, characters and paragraphs can have a background fill color on its own.
Not true.  Look in Character dialog.  There is no Area or Background tab.
Comment 26 NISZ LibreOffice Team 2021-03-11 07:37:09 UTC
Verified in:

Version: 7.2.0.0.alpha0+ (x64) / LibreOffice Community
Build ID: 72841008bf422dfd8553240b3a78f0474d03523c
CPU threads: 4; OS: Windows 10.0 Build 17134; UI render: default; VCL: win
Locale: hu-HU (hu_HU); UI: hu-HU
Calc: threaded