Bug 153637 - Rename "Use level from source chapter" to "Use outline level from document headings" in Type tab of Insert Table of Contents, Index, or Bibliography dialog
Summary: Rename "Use level from source chapter" to "Use outline level from document he...
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: TableofContents-Indexes-Dialog
  Show dependency treegraph
 
Reported: 2023-02-15 13:51 UTC by sdc.blanco
Modified: 2023-03-11 14:01 UTC (History)
1 user (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 sdc.blanco 2023-02-15 13:51:10 UTC
1. Insert - Table of Contents and Index - Table of Contents, Index, or Bibliography - Type tab.
2. Choose type "User-Defined".
3. Notice label in last line of "Create From" section:  "Use level from source chapter" 

Problems:
1. kind of "level" should be specified.
2. referent of "source" is indefinite.
3. referent of "chapter" is indefinite.

Proposed solution:

Rename label to:

"Use outline level from document headings"

Comments in relation to "problems"
1. "level" here is actually "outline level"
2. "headings" is better than "source", because they are the operative element
3. "document" is better than "chapter" because more generic
Comment 1 sdc.blanco 2023-02-15 13:59:41 UTC
Will ask for UXEval because this is another "level" question (with an interaction between outline level and index level, as discussed in bug 153499)
Comment 2 jonathon 2023-02-16 00:45:25 UTC Comment hidden (off-topic)
Comment 3 sdc.blanco 2023-02-16 01:17:52 UTC Comment hidden (off-topic)
Comment 4 Heiko Tietze 2023-02-16 09:48:46 UTC
Renaming "level" into "outline level" makes sense, but "source chapter" makes no sense neither "document headings" if this option somehow takes outlines on captions into account. But even if just badly implemented the heading is wrong for index. How about just "Use outline level" or "Use outline level from source"?
Comment 5 sdc.blanco 2023-02-16 12:12:12 UTC
(In reply to Heiko Tietze from comment #4)
> Renaming "level" into "outline level" makes sense.
OK

> but "source chapter" makes no sense 
OK

> neither "document headings" 
because...?

> if this option somehow takes outlines on captions into account. 
"outlines on captions".  Captions do not have outlines.  Rather there is a "heading" (i.e., paragraph with outline level) that is prior to the caption.

And to be clear --- this index is NOT displaying captions.  The index displays the "Name" that is assigned (in Properties) to Table, Frame, Image, OLE Object, where the outline level of the immediately prior heading to the Table, Frame, etc. is used to provide the index level for that name.

(Use case for this capability is unclear to me, but OP is only focused on an accurate label.)

> But even if just badly implemented the heading is wrong for index. 
???  
Do you mean that the implementation should not use "heading" (outline level) to assign index level?  
Or that the implemented behavior should not be described with heading?

> How about just "Use outline level" 
Because it does not indicate w

or "Use outline level from source"?

"source" is ambiguous -- 
plus given that each table, frame, etc. gets an index level depending on the immediately prior heading, then "use outline level" does not indicate which outline level is being used --  which is what lead me to:

"Use outline levels from document headings"

A more explicit and precise (but likely to be rejected) version:

"Index by outline level of immediately prior heading"

(there is plenty of room in the UI for this long label)
Comment 6 Heiko Tietze 2023-02-20 10:36:40 UTC
By picking "Tables", for example, you insert a ToC with all table captions (excluding the actual caption text) and "Use level from source chapter" indents the entry according to its parent heading level or not.

(In reply to sdc.blanco from comment #5)
> "Index by outline level of immediately prior heading"

Not the length worries me (would be okay without the not needed "immediately" and there is indeed plenty of space) but how naive users would read it. Ideally we start with a verb followed by a noun. Some ideas:

[ ] Indent according the source heading level
[ ] Apply the style following the source heading
[ ] Use level from source heading (smallest modification and easy to read)
Comment 7 sdc.blanco 2023-02-21 00:19:41 UTC
(In reply to Heiko Tietze from comment #6)
> By picking "Tables", for example, you insert a ToC with all table captions
> (excluding the actual caption text) 
Not "table captions".  Your index is composed of the Table Name(s).  To confirm, use Table Properties to change a table name and update the index.

> but how naive users would read it. 
As a naive user, I would expect the label to refer to the relevant aspects that I need to understand, and then look to the help page to find out what the words mean.

Seems too optimistic (in this case) for the label to be "transparent" without some experience creating some indices in this context, along with some reading (even if just plus tooltip/extended tip).
 
Also relevant to consider the context in which this checkbox appears.

In the "Create From" section, with the checkbox under the Tables, etc. 

Even as a naive user, I would expect the index to use the objects that I check.  Then, if I made an index (without checking the "Use level..." box), I would see everything flush left, and then look at the label on the checkbox, and try to guess from the words what it is doing (and then see if the help page could give an idea of how to interpret those words).

For now ... even after considering and working with your three suggestions, I keep coming back, for a variety of reasons, to:

[ ] Index by outline level of immediately prior heading

(immediately is needed because there can be multiple prior headings).

Primary reason is that it points to the relevant features that will affect the output. Note that "Index" is also a verb.

Meanwhile -- thinking about how the dialog would appear from a naive user PoV has motivated another trial balloon....bug 153770.
Comment 8 Heiko Tietze 2023-02-21 07:33:35 UTC
(In reply to sdc.blanco from comment #7)
> [ ] Index by outline level of immediately prior heading
Keep the localization in mind.

I'm in favor of 

(In reply to Heiko Tietze from comment #6)
> [ ] Use level from source heading
Comment 9 sdc.blanco 2023-03-03 14:15:40 UTC
(In reply to Heiko Tietze from comment #8)
> Keep the localization in mind.
> > [ ] Use level from source heading
How about the "short label plus explantory tooltip" approach?

[ ] Use outline levels

with tooltip along the lines of:

Index levels for the selected objects are assigned according to the outline level of the first heading before the object. With default settings, entries for these objects are indented according to the outline level of the heading in the document structure.

(and for extended tip, would add:

If "Tables" is selected, then each table that appears in the document would be assigned an index level that corresponds to the first heading before the table. For example, if the first heading before a table has outline level 3, then the entry for this table would be assigned to index level 3. 

Maybe could also add.  "Use the Entries tab to specify the formatting for each index level."
Comment 10 sdc.blanco 2023-03-03 14:19:52 UTC
correction to beginning of extended tip (indicated by uppercase):  then THE ENTRY FOR each table that appears in the document
Comment 11 Heiko Tietze 2023-03-06 12:51:49 UTC
(In reply to sdc.blanco from comment #9)
> How about the "short label plus explantory tooltip" approach?
> 
> [ ] Use outline levels

I'm all in when it comes to short captions.

> with tooltip along the lines of...

That's way too much text. Good for extended tips but I'm not sure that ordinary tooltips are wrapped on all platforms.
Comment 12 sdc.blanco 2023-03-06 13:25:25 UTC
(In reply to Heiko Tietze from comment #11)
> That's way too much text. Good for extended tips but I'm not sure that
> ordinary tooltips are wrapped on all platforms.
Need help with disambiguation here, because a different response is required depending on which interpretation was intended.

Is the objection:

"too much text (independent of platform-specific behavior)"
(in which case I can drop the second sentence)

or

"try not to have too much text (because of possible platform-specific behavior)?"
(in which case, how can we find out about tooltip wrapping capability across different platforms?)
Comment 13 Heiko Tietze 2023-03-06 13:36:44 UTC
(In reply to sdc.blanco from comment #9)
> [ ] Use outline levels
> 
> with tooltip along the lines of:
> 
> Index levels for the selected objects are assigned according to the outline
> level of the first heading before the object. With default settings, entries
> for these objects are indented according to the outline level of the heading
> in the document structure.

Short as "Assign index levels according the outline level of the first heading". All the details need to be explained in the help.
Comment 14 Commit Notification 2023-03-08 12:06:36 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

tdf#153637 "Use level from source chapter" -> "Use 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 15 Commit Notification 2023-03-08 13:25:51 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/717e288c98b181fe9a49e86f7fa6d4f594df4ab5

tdf#153637 update "use level..." option label and explanation
Comment 16 sdc.blanco 2023-03-11 14:01:54 UTC
Label changed. Tooltip added, and extended tip updated. Help page updated.
Closing as FIXED.