Bug 153596 - Rename "Outline" to "Headings" in the Type tab of Table of Contents, Index, or Bibliography
Summary: Rename "Outline" to "Headings" in the Type tab of Table of Contents, Index, o...
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 enhancement
Assignee: Not Assigned
URL:
Whiteboard: target:7.6.0
Keywords:
Depends on: Clarify-Chapter-Heading-Outline-Level
Blocks: TableofContents-Indexes-Dialog
  Show dependency treegraph
 
Reported: 2023-02-13 16:44 UTC by sdc.blanco
Modified: 2023-02-20 07:54 UTC (History)
1 user (show)

See Also:
Crash report or crash signature:


Attachments
screenshot of relevant dialog, with arrow indicating the change (35.54 KB, image/png)
2023-02-13 16:44 UTC, sdc.blanco
Details

Note You need to log in before you can comment on or make changes to this bug.
Description sdc.blanco 2023-02-13 16:44:17 UTC
Created attachment 185356 [details]
screenshot of relevant dialog, with arrow indicating the change

1. Insert - Table of Contents and Index - Table of Contents, Index, or Bibliography

2. Select "Type" tab, then select "Type: Table of Contents"

3. Notice "Evaluate up to level" in the "Create Index or Table of Contents" section.


Proposed changes:

a. move "Evaluate up to level" label and its buddy control to be in line with "Outline" (in the "Create from" section).  See attachment for illustration.

b. add "outline" in front of "level" -- to become "Evaluate up to outline level"


Reasons:

1. From experiments, it appears that this control operates only in relation to outline levels, not index levels.  
2. Given that outline levels are only used when "Outline" is checked, then it is appropriate for the "Evaluate up to..." to be grouped with "Outline"
3. If the control is operating in relation to outline levels, then better to note it explicitly in the label.

Maybe someone can confirm, in the source code, that the empirical experiments have yielded a valid analysis.
Comment 1 Heiko Tietze 2023-02-14 08:15:54 UTC
The "Create From" checkboxes are not completely independent from each other, you have to check at least one. And the evaluation up to what outline level the ToC is generated applies to both headings and indexes. But the terminology comes to a limit here since both are outline levels. We wanted to remove "headings", which would be a good alternative to "outline".

Bottom-line: besides minor improvements to labels I see no issue in this tab.
Comment 2 sdc.blanco 2023-02-14 13:52:08 UTC
(In reply to Heiko Tietze from comment #1)
> We wanted to remove "headings", which would be a good alternative to 
> "outline".
Good point!  Especially if Chapter Numbering becomes Heading Numbering.
I would support your suggestion to change "Outline" to "Headings"

Reasons:  
  1. Headings would accurately identify that TOC is created from Headings.
  2. Not trying to remove "headings" (per se), just "heading level" (which has no meaning).
  3. As noted in bug 152605, comment 19, "outline" can be confusing.
  4. "Outline level" is actually only indirectly relevant.  As confirmed in bug 153499, comment 11, outline levels are mapped 1-1 to index levels. 

(That could be an argument for keeping the "Outline" label -- but that would presuppose that users understand the outline level concept.  The counterargument is that beginners will presumably assume that "Headings" are connected to the Heading N PS, without having to know anything about index levels and outline levels.)

> the evaluation up to what outline level
> the ToC is generated applies to both headings and indexes. 
Actually, I understand now that the OP is wrong.  The word "index" could/should be added in front of "level", not "outline".  I am neutral about whether to add "index" or not.  Can see good arguments for both sides.

Bottom line:
  1. proposed change a. is withdrawn.
  2. your choice about whether to add "index" in front of "level" (change b.).
  3. strong suggestion to change "Outline" to "Headings"  (will change bug summary)
Comment 3 Heiko Tietze 2023-02-16 08:21:22 UTC
We briefly talked about this effort in the design meeting and appreciate your work. Consistency is very welcome.
Comment 4 Commit Notification 2023-02-17 21:59:42 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

tdf#153596 "outline" -> "headings" 

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 5 sdc.blanco 2023-02-17 22:49:29 UTC
(In reply to Heiko Tietze from comment #3)
> Consistency is very welcome.
Ok -- let's try "Headings" instead of "Outline".  

In another patch, I added a tooltip (and extended tip) to this option, which explains the relation to outline levels. Maybe it will at least help those who already use TOC and wonder what the name change means.

Interesting side note.  Discovered that the Gtk id for this checkbox is "fromheadings" -- so that is a good omen for this change.

Setting to NEW -- based on comment 1 and comment 3
Comment 6 sdc.blanco 2023-02-17 22:55:01 UTC
(In reply to sdc.blanco from comment #2)
> Bottom line:
>   2. your choice about whether to add "index" in front of "level" 
For now, will not add "index" in front of level -- even though it leaves an ambiguity.  

Have subsequently discovered a few tickets with comments that wonder about what "Evaluate up to level" means [bug 153228  and bug 105628, comment 13 (in relation to the Entries tab)].  Will think further about those tickets.

Right now, I cannot see that anything is facilitated by adding "index" (and I do not think its presence would have prevented the comments in the just-named bugs).

Will wait until further tickets come (or I can find a good reason to add "index")

So I think this ticket can be closed as FIXED.