Bug 153243 - Change label "Numbering Captions by Chapter" and related tooltips in dialogs for Insert - Caption - Options, AutoCaption, and Insert/Edit Field (number range)
Summary: Change label "Numbering Captions by Chapter" and related tooltips in dialogs ...
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
7.6.0.0 alpha0+
Hardware: All All
: lowest enhancement
Assignee: Not Assigned
URL:
Whiteboard: target:7.6.0
Keywords: difficultyBeginner, easyHack
Depends on: Clarify-Chapter-Heading-Outline-Level
Blocks: Dialog Caption
  Show dependency treegraph
 
Reported: 2023-01-27 13:32 UTC by sdc.blanco
Modified: 2023-03-16 22:10 UTC (History)
5 users (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-01-27 13:32:51 UTC
Open Caption Options dialog (Insert Caption - Options [button])

Notice label "Numbering Captions by Chapter".

Proposal:  "Numbering Captions by Chapter" -> "Numbering by Chapter"

Reasons:

1. The "Edit Field" dialog (which is used to edit the field inserted by the Insert Caption dialog) uses the label "Numbering by Chapter" to refer to the same function. The change would make an appropriate consistency (identity) between the two dialogs.

2. The change would reduce some "noise" in an already overcrowded dialog.
Comment 1 Roman Kuznetsov 2023-01-27 16:22:05 UTC
I'm not sure and let's ask UX-team about it
Comment 2 Stéphane Guillou (stragu) 2023-01-27 21:20:16 UTC
I agree this would be an improvement:
- simpler: no need to repeat what is in the dialog's title already
- more consistent: with Field dialog

Inherited from:

OpenOffice.org 3.3.0
OOO330m20 (Build:9567)
Comment 3 sdc.blanco 2023-01-28 00:25:07 UTC
Same issue also appears in Tools - Options - LibreOffice Writer - AutoCaption

The following patch addresses both dialogs:

https://gerrit.libreoffice.org/c/core/+/146207
Comment 4 Commit Notification 2023-01-29 02:51:15 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/16559f0b79ccb0386bbc5ae2a761a0e16a32c325

tdf#153243 simplify "Numbering Captions by Chapter" label

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 Heiko Tietze 2023-01-30 12:41:43 UTC
Thanks for the patch. The online help [1] needs to be updated now. Loading it locally via "Help" button shows a rescient "Numbering by chapter" - bottom-line: since I cannot match the local help with searching the online site I assume there is some other page than [1] doing it right.

https://help.libreoffice.org/latest/en-US/text/shared/optionen/01041100.html?DbPAR=SHARED#bm_id5164036
Comment 6 Commit Notification 2023-02-06 21:57:48 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

(Related tdf#153243) Update help page because of UI label change
Comment 7 sdc.blanco 2023-02-20 12:48:48 UTC
Recently, it has been established that "Chapter" (in the UI) is often referring to "Headings" -- and here is another case where "Chapter" in the Options Dialog should be "Heading" (to reflect the actual behavior).

I would propose:

"Numbering by Chapter" -> "Heading Number Prefix"

comments?

An updated extended tip for "Outline Level" 
(made for bug 152605 https://gerrit.libreoffice.org/c/core/+/146622)
already reflects this change, but I will also update the tip to explain that "outline level None" then no heading number is shown.
Comment 8 sdc.blanco 2023-02-20 12:55:32 UTC
Addendum:  A tooltip was also added as part of the just mentioned patch.  I will now add an explanation there about "None" as well.  The tooltip should help with clarifying the section title.
Comment 9 sdc.blanco 2023-02-20 15:04:12 UTC
One more issue -- also discovered since opening this ticket. I believe the following is correct, but independent confirmation is welcome.

The "Level" (or now "Outline Level") control in the "Caption Options" dialog
should be named "Up to Level" (or "Up to Outline Level")

(maybe it is ok to just use "Level" when it is coupled with "Heading Number", because then the referent of level is not so ambiguous.  Opinions?)

This label change would then make the existing description on the help page (almost) comprehensible.

"Select the number of outline levels from the top of the chapter hierarchy down to include in the caption label." [1]

I would change the text to:

"Select how many levels of numbering (starting from level 1) are shown before the caption number. For example, if the immediately prior heading has 5 levels of numbering, such as 3.2.7.4.1, and "3" is selected, then the first three levels are used, that is, "3.2.7"  (and also a mention about "None")

NB.  This control behavior is similar to "Evaluate up to level" control in the Entries tab of Insert ToC/Index (bug 105628, comment 15), where I proposed changing to "Show up to outline level" -- but that label might be too big for the little caption options dialog. Also this change should be made on the Edit Field dialog (for type "number range"), which has even less room.

[1] https://help.libreoffice.org/7.5/en-US/text/swriter/01/04060100.html
Comment 10 sdc.blanco 2023-02-20 16:00:13 UTC
And change also needed in the Insert Field - Variable tab dialog, for type Number range.

Have decided to use "Up to level" -- because I will add (or include) mention of "outline level" in the tooltip/extended tip for the control -- so meaning of "level" can be quickly / easily disambiguated.
Comment 11 Commit Notification 2023-02-21 07:49:05 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/0fa6932e26ca197cb1134c1edf8e026536f87ec8

tdf#153243  change "Numbering by Chapter" and "Outline Level" labels

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 12 Heiko Tietze 2023-02-21 08:05:03 UTC
(In reply to sdc.blanco from comment #7)
> "Numbering Captions by Chapter" -> "Numbering by Chapter"
> "Numbering by Chapter" -> "Heading Number Prefix"

Sounds bulky. The "by" part tells me that something becomes categorized and I miss this info. How about "Subnumbering by heading"?

(In reply to sdc.blanco from comment #9)
> should be named "Up to Level" (or "Up to Outline Level")...Opinions?
The shorter version in this case


Wouldn't put too much effort into this dialog as a redesign has been requested in bug 153248.
Comment 13 sdc.blanco 2023-02-21 14:06:44 UTC
(In reply to Heiko Tietze from comment #12)
> Sounds bulky.
Adolfo was faster at submitting the patch than your comment.

I propose to leave it for now -- given the imminent redesign (bug 153248).

> The "by" part tells me that something becomes categorized
Consider this label in its context.  It is not just to number by, but to modify an existing numbering.  This is not indicated with "number by".

In context, you already see a number in the Insert - Caption preview window.
Now you have clicked the "Options" button to get a new dialog.
The "prefix" label indicates that you are adding something to the existing number.

(I believe "prefix" is familiar, easily understood in American English.)

(Same story with AutoCaption dialog in Options)
heading"?

> > should be named "Up to Level" (or "Up to Outline Level")...Opinions?
> The shorter version in this case
Done.  

> Wouldn't put too much effort into this dialog as a redesign has been
> requested.
No plans or proposals for further UI changes. Will just update the relevant help pages for the changes done here, and then close the ticket.
Comment 14 Buovjaga 2023-02-21 14:39:32 UTC Comment hidden (off-topic)
Comment 15 sdc.blanco 2023-03-02 06:34:28 UTC
A number range field is inserted as part of the Caption dialog.
It is also possible to insert a number range variable with the Insert Field dialog. In both cases, the same Edit Field dialog is used.  At present, there is a section of both the Insert /  Edit Field dialog entitled "Numbering by Chapter".

For now I will take it as part of this ticket because it was mentioned in the OP (and comment 10), but I can make a new ticket for this issue (if preferred).
(Will change bug summary to better indicate the dialogs involved)

To see what is involved, Ctrl+F2, select Variables tab, and type "Number range", or if you have a caption, then Edit field (on the caption number).  

Proposed changes:

1. "Numbering by Chapter"  -> "With Heading Number Before"   
2. "Level" -> "Outline Level"   (update/correct tooltip and extended tip)
3.  add tooltip to Separator and update extended tip.

Notes about "section title" in change 1:
1. "Caption" not mentioned because dialog can be used in other contexts than captions.
2.  A little uneasy proposed title.  Maybe "With Heading Number" is better?  The "Before" makes explicit where the number will appear. 

Comments?

https://gerrit.libreoffice.org/c/core/+/147637
Comment 16 Commit Notification 2023-03-06 20:25:35 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

tdf#153243 update dialog for Insert/Edit number range type field

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 17 Commit Notification 2023-03-07 09:12:54 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/928fdf82a5a0e6bc70aac11b5a03690dcaf0c8c0

tdf#153243 amend labels for Heading Numbering; polish tooltips/extended tips

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 18 Commit Notification 2023-03-10 08:47:15 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

tdf#153243 Make "level" label and tooltip correspond to actual behavior

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 19 Commit Notification 2023-03-10 23:05:05 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

tdf#153243 adjust label/tooltip/extended tip for "level" option

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 20 Commit Notification 2023-03-12 17:30:59 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/4dd6c878412fd650ab8db543ca45006b101933ca

tdf#153243;tdf#152873 update labels; corrections to "Heading Numbering" section
Comment 21 sdc.blanco 2023-03-16 22:10:43 UTC
Basic issue in this ticket was the labelling in Caption Options dialog and Autocaption dialog for adding Heading Numbers before the Caption Number. Related is the Insert/Edit "number range" field type. The heading numbering part of these dialogs have now had labels revised, tooltips added, extended tips revised, and relevant help pages updated. The aim was only to make the current dialog (and documentation) accurate, so closing this ticket as FIXED, but ready to make improvements if noted.