Bug 153561 - Rename "Chapter -> Heading" and "E# -> H#" in Entries tab of Insert Table of Contents, Index, Bibliography dialog
Summary: Rename "Chapter -> Heading" and "E# -> H#" in Entries tab of Insert Table of ...
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-12 01:38 UTC by sdc.blanco
Modified: 2023-05-22 22:50 UTC (History)
2 users (show)

See Also:
Crash report or crash signature:


Attachments
demonstration of actual behavior (27.72 KB, application/vnd.oasis.opendocument.text)
2023-02-18 03:16 UTC, sdc.blanco
Details
screenshots of structure widgets for Entry tab (52.26 KB, application/vnd.oasis.opendocument.graphics)
2023-02-23 08:15 UTC, sdc.blanco
Details
Screenshot of Structure dialog on Entry tab for Table of Contents (6.91 KB, image/png)
2023-03-02 13:03 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-12 01:38:56 UTC
1. Insert - Table of Contents and Index - Table of Contents, Index, or Bibliography

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

3. Select "Entries" tab

Change:

 - "Chapter No." -> "Heading No." -- because Chapter refers only to Outline Level 1, but the dialog allows the user to specify other (non-chapter) outline levels (i.e., "Headings")

 - "E#" -> "H#"  (in Structure) -- so that the letter would be consistent with Heading.


also consistent with change in bug 148718
Comment 1 sdc.blanco 2023-02-17 14:24:01 UTC
Better send this one to UXEval now that "chapter" is being changed to "heading" in relation to bug 152605, comment 14 and bug 153549.
Comment 2 sdc.blanco 2023-02-18 03:16:22 UTC
Created attachment 185455 [details]
demonstration of actual behavior

Attachment demonstrates that "Chapter No." is showing the heading Numbering.
Comment 3 Heiko Tietze 2023-02-20 08:49:02 UTC
Chapter No to Heading No is clearly on the todo list. But I don't see why we have to change the E# into H#. It adds a lot of confusion, although it seems the E# has been chosen randomly. And, these identifiers are not localized.

Side note: funny, how it was explained for AOO: "The E# button represents the “chapter number”, which means the heading number, not just for chapters but also for other levels of headings."

https://wiki.openoffice.org/wiki/Documentation/OOo3_User_Guides/Writer_Guide/Entries_page
Comment 4 sdc.blanco 2023-02-21 01:07:58 UTC
(In reply to Heiko Tietze from comment #3)
> Don't see why we have to change the E# into H#. 
Heading #

Would seem more confusing to me to click on "Heading No." and have E# show up in the Structure, than H#

> it seems the E# has been chosen randomly. 
Probably to make link to E, with E# being the Entry number.
In effect:  "Heading number" and "Heading content"

(but not suggesting that user PoV must correspond to underlying implementation logic).

> Side note: funny, 
And more supporting evidence...
Comment 5 Heiko Tietze 2023-02-22 10:06:31 UTC
(In reply to Heiko Tietze from comment #3)
> And, these identifiers are not localized.

Not true, see STR_TOKEN_ENTRY_NO ff. in sw/inc/strings.hrc. But the tokens are not limited to what is relevant for documents but also contains everything around bibliographies (though I haven't found this list in the sources).
Comment 6 sdc.blanco 2023-02-22 22:39:21 UTC
(In reply to Heiko Tietze from comment #5)
> also contains everything around bibliographies (though I haven't found this 
> list in the sources).
what list are you looking for?

Perhaps the "confusion" mentioned in comment 3 is no longer relevant, with localization, such that it is meaningful to change E#?
Comment 7 Commit Notification 2023-02-23 01:14:16 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

tdf#153561 rename "chapter" to "heading"; update/add tool/extended tip

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 8 Heiko Tietze 2023-02-23 07:12:49 UTC
(In reply to sdc.blanco from comment #6)
> what list are you looking for?

A complete list of items and it abbreviations. The question is whether we change the abbreviation of some items and we should know if that crashes with other.
Comment 9 sdc.blanco 2023-02-23 08:15:49 UTC
Created attachment 185540 [details]
screenshots of structure widgets for Entry tab

(In reply to Heiko Tietze from comment #8)
> A complete list of items and it abbreviations. 
Attachment shows the Structure section in the Entry tab for each index Type.

> ... should know if that crashes with other.
No apparent conflicts.

Bibliography is a different story. Could not find any localisation for the abbreviations comparable to STR_TOKEN_ENTRY_* , only the Types and for the Fields (to be inserted).

From experiments, it appears that the first two letters of an inserted (field) item is taken as the abbreviation -- have not tried to check in the source code, but as some strong evidence for the two letter hypothesis, try to insert "Editor" and "Edition" into the structure.  I get "Ed" for both, but also a correct tooltip for both.
Comment 10 sdc.blanco 2023-02-23 09:25:13 UTC
The present ticket is focused on a simple matter of labelling the widgets used in Structure. Bug 134781 raises more fundamental questions about the overall design/function of the Structure dialog.
Comment 11 Mike Kaganski 2023-03-02 06:39:47 UTC
I definitely dislike [E#]->[H#] change.

The E corresponds to "Entries" tab name. It corresponds to "Insert->Table of Contents and Index->Index Entry" menu. It corresponds to [E] (and the relation is unambiguous and natural: "first entry number, then entry text"). It is neutral. The [E] is used in other types of the index (Alphabetical, Table of Figures, ...), so should not be changed itself. The entry can also be created from other types of paragraphs, which may not be headings, but contain numbering.

Overall: indexes consist of entries. Introducing "heading" term here does nothing good, but complicates and confuses things.
Comment 12 Mike Kaganski 2023-03-02 06:56:20 UTC
And the already made change of the button [Chapter No.]->[Heading No.], and tooltip (Chapter number->Heading number) would best be "Entry No." ("Entry number") for consistency.
Comment 13 Heiko Tietze 2023-03-02 07:14:15 UTC
We discussed this topic in the design meeting.

If the modification is consistent for all type of indices the suggested label H# instead of E# (and HI instead of CI) is welcome.

(In reply to Mike Kaganski from comment #11)
> The E corresponds to "Entries" tab name.
It's all about E# / Chapter No (now Heading No). I could live with Entry No too.
Comment 14 Mike Kaganski 2023-03-02 09:03:36 UTC
(In reply to Heiko Tietze from comment #13)
> (In reply to Mike Kaganski from comment #11)
> > The E corresponds to "Entries" tab name.
> It's all about E# / Chapter No (now Heading No)

Indeed. I should had been more verbose, and should had written "The "E" in [E#] corresponds to ..."
Comment 15 sdc.blanco 2023-03-02 09:40:51 UTC
(In reply to Mike Kaganski from comment #11)
> The entry can also be created from other types of paragraphs, which may 
> not be headings, but contain numbering.
Thanks for clarifications Mike.  Please forgive honest error on my part.  

Starting point was the minimal documentation about E#, all of which only referred to "chapter" or "heading".

1. Current online help documentation for E# [1]:

Chapter number (E#)
Inserts the chapter number. To assign chapter numbering to a heading style, choose Tools - Chapter Numbering.

2. Writer's Guide 7.3 (p. 336)

The E# icon represents the “chapter number”, which means the heading number value assigned to a heading style in Tools > Chapter Numbering, not just for chapters but also for other levels of headings.

3.  AOO explanation in comment 3

4. LibreOffice Developer's Guide: Chapter 7 - Text Documents [2]

"TokenEntryNumber" The number of an entry. This is only supported in tables of content and it marks the appearance of the chapter number.


In light of this new information, I would propose:

"Numbering" (and "N") as the widget labels.

(iiuc, heading numbers and list numbers are numbering sources here.  Just as Chapter No./Heading No. was trying to point to the "source", "Numbering" also points to the source, while "Entry" is the "result" of selections/options in the Type tab.  Also removes the visual clash/confusion between E# and #. )

But @Mike, two new questions for documentation. 

1. afaict, the "level" option in the Entries tab, shown when E# is selected in the Structure option, has no effect for entries that come ordered lists.  Is that right?  (in which case I can mention it in the documentation).  This is also relevant for the next question.

2. The label on that option was changed recently from "Evaluate up to level" to "Show up to level".  Perhaps the current tooltip (and extended tip) are still valid, but, depending on answer to previous question, could add mention that level only applies to heading numbers.


[1] https://help.libreoffice.org/7.6/en-US/text/swriter/01/04120221.html?&DbPAR=WRITER

[2] https://wiki.documentfoundation.org/Documentation/DevGuide/Text_Documents
Comment 16 Mike Kaganski 2023-03-02 09:54:12 UTC
(In reply to sdc.blanco from comment #15)
> In light of this new information, I would propose:
> 
> "Numbering" (and "N") as the widget labels.
> 
> (...  Also removes the visual clash/confusion between E# and #. )

IMO, this is not a "clash/confusion", but a welcome visual hint, helping to see that both refer to some "numbers" (even if they may be alphabetic numbering). So I still like the [E#] most.

> 1. afaict, the "level" option in the Entries tab, shown when E# is selected
> in the Structure option, has no effect for entries that come ordered lists. 
> Is that right?

I don't know, please check.

> 2. The label on that option was changed recently from "Evaluate up to level"
> to "Show up to level".  Perhaps the current tooltip (and extended tip) are
> still valid, but, depending on answer to previous question, could add
> mention that level only applies to heading numbers.

No problem with the current tooltip, and with possible addition.
Comment 17 sdc.blanco 2023-03-02 10:53:23 UTC
@Heiko @Cor - any opinion about using

Numbering / N   vs.  Entry No. / E#

for the widget on the Entries tab that provides a heading/list number?
Comment 18 Heiko Tietze 2023-03-02 11:54:26 UTC
(In reply to sdc.blanco from comment #17)
> Numbering / N   vs.  Entry No. / E#

If N then N#, IMO.
Comment 19 sdc.blanco 2023-03-02 13:03:19 UTC
Created attachment 185699 [details]
Screenshot of Structure dialog on Entry tab for Table of Contents

(In reply to Heiko Tietze from comment #18)
> If N then N#, IMO.
Just to avoid misunderstanding....the attachment shows a screenshot of the relevant dialog. The questions in relation to the dialog are:

1. Chapter No.  ->   ?
2. E#           ->   ?

One answer is:
1. Entry No.
2. E#

Another is:
1. Numbering
2. N

Was a little unsure how to interpret your answer.
Comment 20 Heiko Tietze 2023-03-02 14:29:50 UTC
(In reply to sdc.blanco from comment #19)
> Was a little unsure how to interpret your answer.

1. Numbering
2. N#

(The hash sign identifies the number and makes the token a bit more familiar with the current E#)
Comment 21 sdc.blanco 2023-03-03 00:03:44 UTC
https://gerrit.libreoffice.org/c/core/+/148104
Comment 22 Commit Notification 2023-03-06 07:52:01 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/09aca4a8bff06a719fa85d7287969e484fcb5e3f

tdf#153561 rename Heading No. and widget, update tool/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 23 Mike Kaganski 2023-03-06 07:57:41 UTC
So, now it changed from "E#" (read: Entry Number, quite correct and covering everything) into "N#" (read: Numbering Number) ... well, likely an improvement ;)
Comment 24 Commit Notification 2023-03-09 16:14:26 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/6a25d11512dc078fc47c546585c9663b5804a3eb

tdf#153561  "Chapter No." -> "Numbering" because of widget name change
Comment 25 sdc.blanco 2023-03-09 16:18:13 UTC
(In reply to Mike Kaganski from comment #23)
> "N#" (read: Numbering Number) ... well, likely an improvement ;)
Creeping toward perfection, one consensus at a time...

Closing this ticket as FIXED.
Comment 26 Commit Notification 2023-03-09 17:46:43 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

tdf#153561  adjustments for "Format" because of widget name change
Comment 27 Commit Notification 2023-03-10 01:51:28 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/0affdd29956c531bf624da7c69c780e8ee2f14a6

tdf#153561 add <widget> to N#
Comment 28 Commit Notification 2023-03-12 17:29:56 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

tdf#153561  Untangle the "Format" options
Comment 29 Commit Notification 2023-05-22 21:49:31 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

tdf#153561 add <section> to hyperlink, update hyperlink description
Comment 30 Commit Notification 2023-05-22 22:25:36 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/6d37d30f9474ae437544ce04cfdcbc4ba4119303

tdf#153561 add <note> for heading info section
Comment 31 Commit Notification 2023-05-22 22:50:41 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/26a379d7f2c21de638bbeb1e7d4032896ac326d4

tdf#153561 embed sections: <hyperlink>,<tab_options>,<headinginfo>,<eval>,<tab_relative>