Bug 157908

Summary:	Change "Evaluate" to "Include" in "Create Index or Table of Contents" section of TOC, Index, Bibliography Type tab
Product:	LibreOffice	Reporter:	sdc.blanco
Component:	Documentation	Assignee:	sdc.blanco
Status:	RESOLVED FIXED
Severity:	normal	CC:	heiko.tietze, olivier.hallot
Priority:	medium	Keywords:	difficultyBeginner, easyHack, skillDesign, skillDocumentation, topicDesign
Version:	24.2.0.0 alpha0+
Hardware:	All
OS:	All
See Also:	https://bugs.documentfoundation.org/show_bug.cgi?id=156315
Whiteboard:	target:24.2.0
Crash report or crash signature:		Regression By:
Bug Depends on:
Bug Blocks:	89606
Attachments:	proposed help entries for "Include up to level"

Description sdc.blanco 2023-10-24 10:10:52 UTC

Bug 156315 brought attention to the "Evaluate up to level" option in 
Insert > TOC and Index > TOC, Index, Bibliography > Type tab.

There was a problem about how to understand that option. 

I propose to change "Evaluate" -> "Include", so that the option would be:

"Include up to level" [spinbox]

This should give a better indication of the function of this option.

Additional problems in help [1].

In bug Bug 156315 comment 7, Andreas Heinisch noted that the help entry for this option is wrong - currently:  "Enter the number of outline levels to include in the index."

Proposal to change entry to:

"Specify the maximum outline level for a paragraph style specified in ”Create from” to be included in the index."

Finally, no mention is made in "Additional Styles" about the effect of this option. Proposal to add the following sentence (where "Evaluate" would become "Include" if this change is made): 

   "If the assigned paragraph style has an outline level, then it is included only when its outline level is less than or equal to the value specified in ”Evaluate up to level”.


[1]  https://help.libreoffice.org/24.2/en-US/text/swriter/01/04120211.html

Comment 1 Heiko Tietze 2023-10-25 08:55:12 UTC

(In reply to sdc.blanco from comment #0)
> "Include up to level" [spinbox]
Sounds good to me.

Code pointer: sw/uiconfig/swriter/ui/tocindexpage.ui

> "Specify the maximum outline level for a paragraph style specified in
> ”Create from” to be included in the index."
Too complicated, IMO. How about "Limit the outline level to this value". Personally I like examples in documentations, kind of "If you want to exclude all headings from the 3rd level set this value to 2"

>    "If the assigned paragraph style has an outline level, then it is
> included only when its outline level is less than or equal to the value
> specified in ”Evaluate up to level”.
If this is going to be an extended tooltip it would spawn over the whole screen (we do not properly break lines).

=> documentation

Comment 2 sdc.blanco 2023-10-25 10:52:50 UTC

https://gerrit.libreoffice.org/c/core/+/158432/2

Comment 3 sdc.blanco 2023-10-25 12:46:10 UTC

Created attachment 190413 [details]
proposed help entries for "Include up to level"

(In reply to Heiko Tietze from comment #1)
> Too complicated, IMO. 
Because it is complicated -- namely a conditional operation depending on which options are selected in "Create From".  See attachment for formatted version. 

> Personally I like examples in documentations.
Does not seem necessary in this particular case, but here is a proposal:

For example, choose 2 to include specified paragraphs with outline level 1 or 2.
 
> If this is going to be an extended tooltip...
Not a tooltip proposal. Meant as needed addition to help page. See attachment.

https://gerrit.libreoffice.org/c/help/+/158435

Comment 4 Commit Notification 2023-10-25 16:06:54 UTC

Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/3ae6c825415ce74ed8f0487acc043fd3a41c46e4

tdf#157908 update label change to "Include up to level"

Comment 5 Commit Notification 2023-10-25 16:11:57 UTC

Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/9f3e8b2546563cdabbe01838a72ed542c7f58875

tdf#157908   "Evaluate" -> "Include" in outline level option

It will be available in 24.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.