Bug 153485 - Tooltip for H icon and command name in Heading context menu in Navigator should be "Show Up to Outline Level"
Summary: Tooltip for H icon and command name in Heading context menu in Navigator shou...
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Writer (show other bugs)
Version:
(earliest affected)
7.2.7.2 release
Hardware: All All
: medium normal
Assignee: Not Assigned
URL:
Whiteboard: target:7.6.0
Keywords:
Depends on: Clarify-Chapter-Heading-Outline-Level
Blocks: Navigator
  Show dependency treegraph
 
Reported: 2023-02-09 00:49 UTC by sdc.blanco
Modified: 2023-02-23 00:56 UTC (History)
5 users (show)

See Also:
Crash report or crash signature:


Attachments
Test file for convenience (17.93 KB, application/vnd.oasis.opendocument.text)
2023-02-09 00:49 UTC, sdc.blanco
Details
Karasa Jaga "Heading Levels Shown" (26.98 KB, image/png)
2023-02-20 12:56 UTC, Rizal Muttaqin
Details

Note You need to log in before you can comment on or make changes to this bug.
Description sdc.blanco 2023-02-09 00:49:50 UTC
Created attachment 185243 [details]
Test file for convenience

1. Open Navigator with a document that has some heading paragraphs (preferably with different outline levels) -- or use attached document, which has some headings at outline levels 1 through 3.

2. Place cursor on Headings label in Navigator (or one of the headings under Headings), then right-click, choose Outline Level, then select "1".

Actual (and expected) result:  All headings with outline level 1 are shown.

3.  Place cursor over the H icon in the panel above the navigator window.

Actual:    Tooltip shows "Heading Levels Shown"
Expected:  "Outline Level"

Reason:  This icon is the same action as "Outline Level" in the context menu. Should have the same label for consistency.
Comment 1 sdc.blanco 2023-02-12 14:28:48 UTC
Alternatively, "Outline Level" for the context menu for Headings in Navigator should be changed to "Outline Levels Shown"  (with the panel icon showing the same thing).

My opinion:  

good/better choice: "Outline Levels Shown" (also for context menu) 

-- because meaning of "Outline Levels" is opaque, does not indicate an action.

Will ask UXEval ... and hope for a quick decision...

In all cases, help page needs to be updated in relation to this issue.
https://help.libreoffice.org/7.6/en-US/text/swriter/01/02110000.html
Comment 2 Roman Kuznetsov 2023-02-12 17:08:22 UTC
H - Headings and tooltip should say the same

I against to change Headings to Outline back anywhere in Writer
Comment 3 Heiko Tietze 2023-02-13 09:54:47 UTC
Following bug 152605 comment 14 we should consistently name any *level "Outline Level".

(In reply to sdc.blanco from comment #0)
> ...the H icon in the panel above the navigator window.

It depends on the icon theme whether it's an H or something else. The icon in doubt is the right-most of the upper toolbar and allows to filter the shown headings up to a certain level (eg. clicking 2 would show only H1 and H2 headings).

To not add ambiguity I suggest to either keep "show" and label it "Shown Outline Level" or use filter with "Outline Level Filter".

(In reply to Roman Kuznetsov from comment #2)
> I against to change Headings to Outline back anywhere in Writer

It always has been "Headings Level" in the UI while internally the function uses the correct description "Outline Level".
Comment 4 sdc.blanco 2023-02-17 14:47:55 UTC
@Jim and @Stuart-- maybe you have an opinion about this issue -- given your familiarity and experience with Navigator?

At a minimum, I think the tooltip on the icon and the command name in the context menu need to be the same. 

My latest opinion is:

Show to Outline Level


And while this is being evaluated, it seems appropriate to expand this ticket to include .uno:OutlineLevelsShown, which currently has the label "Show Outline Content up to Level"

I believe "Show to Outline Level" would work as a label/tooltip for that .uno (and would keep consistency Navigator, because I believe this .uno has the same functional effect as the controls in Navigator).
Comment 5 V Stuart Foote 2023-02-17 17:58:36 UTC
I think the discussion to change to "Show to Outline Level" from "Heading Levels shown" is correct, but then the "H" icon is not correct despite a change to the tooltip. 

Change the label.

But, needs a new icon--for Colibre at least.
Comment 6 sdc.blanco 2023-02-17 21:34:05 UTC
(In reply to V Stuart Foote from comment #5)
> Change the label.
https://gerrit.libreoffice.org/c/core/+/147247

> But, needs a new icon--for Colibre at least.
After this patch is submitted, I will open a new ticket for the icon.
Comment 7 Commit Notification 2023-02-18 03:08:13 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/6504514ecb8ceede450ec16c1ea1fcf79bdb5b04

tdf#153485  UI guideline corrections to outline level popup box

It will be available in 7.6.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 8 Heiko Tietze 2023-02-20 08:05:28 UTC
Adding Rizal for the icon modification (it depends on the icon theme)
Comment 9 Rizal Muttaqin 2023-02-20 08:19:01 UTC
I just want to know if we would want maximum consistency with labeling/terminology why we change Tools > Outline Numbering.. to Tools > Chapter Numbering.. previously?
Comment 10 sdc.blanco 2023-02-20 08:59:10 UTC
(In reply to sdc.blanco from comment #4)
> My latest opinion is:
> Show to Outline Level
Response from Adolfo in gerrit comment ( https://gerrit.libreoffice.org/c/core/+/147247 )

   Let’s maintain “up to”. 

   Just using “to” makes it unnecessarily hard to translate.

Also a preferred choice from me, but I was afraid it would be considered too long for the context menu.

But...if there are no objections -- then the final choice would be:

"Show Up to Outline Level"

(which would appear in the tooltip for Navigator panel, label for the toolbar button, and label for context menu in Navigator)
Comment 11 sdc.blanco 2023-02-20 09:20:07 UTC
(In reply to Rizal Muttaqin from comment #9)
> I just want to know if we would want maximum consistency with
> labeling/terminology why we change Tools > Outline Numbering.. to Tools >
> Chapter Numbering.. previously?
If I understand your question correctly -- then the main reason for the change is that many places in the UI currently use the word "Chapter", but the actual behavior of the software is applied to "headings", so "Heading" is a more accurate description. (see bug 153549 and bug 152605, comment 14)

Meanwhile, the change from "Outline Numbering" to "Chapter Numbering" was motivated primarily because of a perception that users were confused by "Outline numbering" and that "Chapter Numbering" might be better. The change to "Heading" is assumed to be even easier for users to understand. So a "double" advantage: possibly easier for users and more accurate in relation to actual behavior.  

The "consistency" part comes "on top" of the labelling change. There is sometimes incorrect (and misleading) terminology in the extended tips and help pages. Because some updating is needed with the command name change, then it is convenient to try, at the same time, to introduce clear, consistent terminology.

About the icon for the Navigator panel.... a suggestion ...
Instead of using a letter (which has the problem of not being the same in all languages) -- try a graphic image like:

_____
...
 ...
  ...
_____
 
You understand that the point of the command is to make a kind of "filter" of how many levels of headings are shown in Navigator.  I have tried to show with the dots that the command has something to do with headings, where there should be some blank space between the last heading and the bottom of the icon (to suggest that not all headings are shown).  (I am not proposing to use "dots" necessarily -- just used here to communicate the "concept" of the icon, not its graphic expression.)
Comment 12 Rizal Muttaqin 2023-02-20 12:56:22 UTC
Created attachment 185489 [details]
Karasa Jaga "Heading Levels Shown"

(In reply to sdc.blanco from comment #11)

> About the icon for the Navigator panel.... a suggestion ...
> Instead of using a letter (which has the problem of not being the same in
> all languages) -- try a graphic image like:
> 
> _____
> ...
>  ...
>   ...
> _____
>  
> You understand that the point of the command is to make a kind of "filter"
> of how many levels of headings are shown in Navigator.  I have tried to show
> with the dots that the command has something to do with headings, where
> there should be some blank space between the last heading and the bottom of
> the icon (to suggest that not all headings are shown).  (I am not proposing
> to use "dots" necessarily -- just used here to communicate the "concept" of
> the icon, not its graphic expression.)


Look at how Karasa Jaga (this design was stolen from Galaxy) has better representation here.
Comment 13 sdc.blanco 2023-02-20 22:14:05 UTC
(In reply to Rizal Muttaqin from comment #12)> 
> Look at how Karasa Jaga (this design was stolen from Galaxy) has better
> representation here.
Happy to see that I have reinvented the wheel. More importantly: perhaps you have a useful direction in which to go, and I will get out of your way.
Comment 14 Rizal Muttaqin 2023-02-20 23:04:14 UTC
(In reply to sdc.blanco from comment #13)

> Happy to see that I have reinvented the wheel. More importantly: perhaps you
> have a useful direction in which to go, and I will get out of your way.

I would rather to see different bug report for this request
Comment 15 Commit Notification 2023-02-21 07:49:07 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/3ae7bd3345e2f356b52ba7b8160dbcbdc4967e89

tdf#153485  align command names to show headings by outline level

It will be available in 7.6.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 2023-02-21 12:35:05 UTC
(In reply to Rizal Muttaqin from comment #14)
> I would rather to see different bug report for this request
Bug 153772
Comment 17 Commit Notification 2023-02-23 00:23:10 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/ac82657672e6d9867e4d8560536e241ca4814da6

tdf#153485   Update "Outline level" -> "Show up to outline level"
Comment 18 sdc.blanco 2023-02-23 00:56:40 UTC
Amusing side note, discovered post-facto. Until the patch in comment 17, the help for "Outline Level" has not changed since its initial 2004 check-in.  Here is a relevant excerpt.

   Click this icon ...  You can also access this command by right-clicking a heading in the Navigator window.

Meanwhile, the first version of navigatorpanel.ui (late 2016) had "Heading Levels Shown" as the tooltip for the icon (and I assume it was present even longer back), while "Outline Level" has been in the context menu forever.

So -- nice that this ticket could bring the UI into line with the help. (-:

Have updated summary to better reflect the change.