Bug 152873 - Help Writer → Variables → Numbering by Chapter: Wrong description
Summary: Help Writer → Variables → Numbering by Chapter: Wrong description
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
7.4.3.2 release
Hardware: x86-64 (AMD64) Linux (All)
: medium normal
Assignee: Not Assigned
URL:
Whiteboard: target:7.6.0
Keywords:
Depends on: Clarify-Chapter-Heading-Outline-Level
Blocks: Help-Changes-Features
  Show dependency treegraph
 
Reported: 2023-01-04 11:01 UTC by Robert Großkopf
Modified: 2023-03-14 23:17 UTC (History)
2 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 Robert Großkopf 2023-01-04 11:01:30 UTC
Seems there is a totally wrong description for numbering with number ranges and numbering by chapter. Don't know how to search this in LO-Help, so here is a direct link:

https://help.libreoffice.org/7.4/en-US/text/swriter/01/04090005.html?System=UNIX&DbPAR=WRITER&HID=modules/swriter/ui/fldvarpage/FieldVarPage#bm_@@nowidget@@

Numbering by Chapter
Sets the options for resetting chapter numbers.
→ Wrong! There won't be reset any chapter numbers. It will read the current chapter number up to this level. So if there is a chapter number 2.3 and the level is set to '2' it will set 2.3.1 (Chapterlevel1.Chapterlevel2.NumberRange)
The level will show the first two chapters. It could also be set to '10' with the same result if numbering is following to chapter 2.3

Level
Choose the heading or chapter level at which to restart numbering in the document.
→ Wrong! NumberRange will start after every new chapter number. Has nothing to do with the level. The level defines up to which level the chapter numbering should be leading numbers of the NumberRange.

Separator
Type the character that you want to use as a separator between the heading or chapter levels.
→ Wrong or misleading: if separator here is ',' and separator in chapter numbering is '.', it will show in the example above: 2.3,1
The separator is the separator between the chapter number and the NumberRange.
Comment 1 Olivier Hallot 2023-02-22 13:29:20 UTC
The Help page must be revisited.
Comment 2 sdc.blanco 2023-03-09 00:08:27 UTC
(In reply to Robert Großkopf from comment #0)
> Level
> The level defines up to which level the chapter
> numbering should be leading numbers of the NumberRange.
1. To be sure I understand the meaning of "up to which level",
how would this rule apply to the following case?

1   Outline level 1 paragraph
 1.1  Outline level 2
   1.1.1 Outline level 3
   1.1.2 Outline level 3
 1.2  Outline level 2

[number range variable here] level = 3

What chapter number is shown and why?

2. Maybe the "Level" label in the field dialog should be "Up to level"?
Comment 3 sdc.blanco 2023-03-09 00:22:31 UTC
One more case, probably pathological, but again with an interest to understand the meaning of "up to level".

1.2 Here is an outline level 2 heading
1.2.1.1.1.1 Here is heading with outline level 6

[number range variable here] with level = 3

What chapter number is shown and why?
Comment 4 Robert Großkopf 2023-03-09 07:45:53 UTC
(In reply to sdc.blanco from comment #2)
> (In reply to Robert Großkopf from comment #0)
> > Level
> > The level defines up to which level the chapter
> > numbering should be leading numbers of the NumberRange.
> 1. To be sure I understand the meaning of "up to which level",
> how would this rule apply to the following case?
> 
> 1   Outline level 1 paragraph
>  1.1  Outline level 2
>    1.1.1 Outline level 3
>    1.1.2 Outline level 3
>  1.2  Outline level 2
> 
> [number range variable here] level = 3

Will change this to level = 2 to see, what could happen:
> 
> What chapter number is shown and why?

1   Outline level 1 paragraph
  1.1  Outline level 2
    1.1.1 Outline level 3
    1.1.2 Outline level 3
    1.1.1 New number with number range set to level 2
    1.1.2 Next number with level 2
  1.2  Outline level 2
    1.2.1 New number with number range set to level 2

There will be read at maximum the first 2 levels. The numbering will start new in every level. So it will add '1' to the levels up to level 2. Will show wrong numbering for chapters in level 3, if there will be chapters with chapter numbering and with number range are mixed.


> 
> 2. Maybe the "Level" label in the field dialog should be "Up to level"?

Yes, this will be the right changing.

> 1.2 Here is an outline level 2 heading
> 1.2.1.1.1.1 Here is heading with outline level 6

> [number range variable here] with level = 3

1.2 Here is an outline level 2 heading
1.2.1 New number with number range set to level 3
1.2.1.1.1.1 Here is heading with outline level 6
1.2.1.1 New number with number range set to level 3

It will get a little bit confusing, because it will only read up to first 3 numbers and add a special numbering …
Comment 5 sdc.blanco 2023-03-09 13:33:10 UTC Comment hidden (obsolete)
Comment 6 Robert Großkopf 2023-03-09 14:13:44 UTC
I'm not so firm in English, but I would prefer to set

"Choose how many levels of the immediately prior heading number should be displayed at most"

instead of 
"Choose how many levels of the immediately prior heading number to show"
Comment 7 sdc.blanco 2023-03-09 14:29:12 UTC
Thanks for further feedback. It is challenging to find the right words (in any language).

After further analysis -- maybe it is not so hard to explain the actual behavior clearly, fully and accurately.

--------------------
UI for dialog:
--------------------

With Heading Number 

Up to level [  ]
Separator   [  ]

------------------

Tooltip for "Up to level" spinbox:

 Choose heading number to prepend to displayed field, where the number comes 
 from the first prior heading whose outline level is equal to or less than the
 selected outline level. If “None” is selected, no heading number is displayed.

---------------------

(This text could also be used on the help page and extended tip, with an example like:

For example, select "2" to display the heading number for the first prior heading that has outline level 2 or less.

(These descriptions also handle both "challenges" in comment 2 and comment 3.)

It is a "different" way to think about the function of this option, but maybe just as functional (or more so), once you get used to it?

Comments welcome....
Comment 8 Commit Notification 2023-03-12 17:31:01 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 9 sdc.blanco 2023-03-12 17:37:05 UTC
The updated help page will appear at:

https://help.libreoffice.org/7.6/en-US/text/swriter/01/04090005.html?System=UNIX&DbPAR=WRITER

It often takes a few days before the patch appears in the online help (i.e., it is not visible yet).

I will close this ticket as FIXED, but if you think small adjustments are needed in the updated version, then you are welcome to write to this ticket, rather than start a new one.  Thanks for your interaction/feedback.
Comment 10 sdc.blanco 2023-03-14 23:17:01 UTC
The revised help is online now https://help.libreoffice.org/7.6/en-US/text/swriter/01/04090005.html?System=UNIX&DbPAR=WRITER,
where "Numbering by Chapter" is now "With Heading Number" (as seen in this help file). If you think there are still problems, then you are welcome to write here.