Bug 151063 - Rename "Index marks" to "Index entries" (if the latter is correct)
Summary: Rename "Index marks" to "Index entries" (if the latter is correct)
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
7.4.0.3 release
Hardware: All All
: medium minor
Assignee: Not Assigned
URL: https://wiki.documentfoundation.org/D...
Whiteboard: target:7.6.0
Keywords:
Depends on:
Blocks: TableofContents-Indexes-Dialog
  Show dependency treegraph
 
Reported: 2022-09-19 15:56 UTC by Tuomas Hietala
Modified: 2023-02-28 22:38 UTC (History)
6 users (show)

See Also:
Crash report or crash signature:


Attachments
Screenshot (40.00 KB, image/png)
2022-09-20 06:54 UTC, Heiko Tietze
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Tuomas Hietala 2022-09-19 15:56:26 UTC
Description:
In the "Table of Contents, Index or Bibliography" dialog in Writer, there is a string "Index marks". Weblate: https://translations.documentfoundation.org/translate/libo_ui-master/swmessages/en/?checksum=babba6c77ac5f430

The relevant extended tip (immediately below in Weblate) would indicate that the string is really about "index entries", though.

For the sake of consistent terminology, if the meaning is really "index entries", the string should be changed to "index entries". Introducing variation in terminology for no reason just makes things harder to understand for users and translators.


Steps to Reproduce:
1. In Writer, go to Insert - Table of Contents and Index - Table of Contents, Index or Bibliography...

Actual Results:
The term "index marks" is used, while the extended tip is using the term "index entries".

Expected Results:
Consistent terminology is used.


Reproducible: Always


User Profile Reset: No



Additional Info:
n/a
Comment 1 Heiko Tietze 2022-09-20 06:54:54 UTC
Created attachment 182563 [details]
Screenshot

The label was the same since the dawn of time. Seems to be quite common looking into the code, at least at comments. I agree with changing it to "Index entries" in particular since it is created per Insert > Table of Contents and Index > Index Entry...
Comment 2 Heiko Tietze 2022-09-20 06:56:12 UTC
Code pointer: sw/uiconfig/swriter/ui/tocindexpage.ui
Comment 3 V Stuart Foote 2022-09-20 13:42:34 UTC
The term comes from "parenthetical markings"; they mark the location in text where the content is indexed or where a supplemental comment is relevant.

They are not the actual "index entry" (which could be anything depending on the reference style in use) and each represents the relative placement or "mark" being collected.

IHMO => NAB and => WF as it would lead to incorrect translation/l10n
Comment 4 V Stuart Foote 2022-09-20 13:50:57 UTC
here is your reference: https://wiki.documentfoundation.org/Documentation/DevGuide/Text_Documents#Indexes_and_Index_Marks

Leave it alone!
Comment 5 Tuomas Hietala 2022-09-20 14:32:50 UTC
(In reply to V Stuart Foote from comment #3)
> The term comes from "parenthetical markings"; they mark the location in text
> where the content is indexed or where a supplemental comment is relevant.
> 
> They are not the actual "index entry" (which could be anything depending on
> the reference style in use) and each represents the relative placement or
> "mark" being collected.
> 
> IHMO => NAB and => WF as it would lead to incorrect translation/l10n

In that case, is the related extended tip correct?
https://translations.documentfoundation.org/translate/libo_ui-master/swmessages/en/?checksum=60b93c9d2fb09c6f
Comment 6 Heiko Tietze 2022-09-20 14:52:59 UTC
Let's see what the documentation team thinks.
Comment 7 V Stuart Foote 2022-09-20 16:08:44 UTC
(In reply to Tuomas Hietala from comment #5)

> https://translations.documentfoundation.org/translate/libo_ui-master/
> swmessages/en/?checksum=60b93c9d2fb09c6f


The localized help tooltip: 

"Includes the index entries that you inserted by choosing Insert - Table of Contents and Index - Index Entry in the index."

seems a little convoluted and a bit out of context in that the Create From "index marks" action is for creating a TOC or Index. 

The Writer Guide (7.3 pg 335) has more complete description of the UI. 

The "index marks" not only mark the location in the document but often can include formatted text (even multi-line) used as the actual index or TOC entry.
Comment 8 sdc.blanco 2023-02-26 23:38:35 UTC
Good catch Tuomas!

1. I think "Index Marks" should be changed to "Index Entries" in the Type tab
(because it uses the results of the "Insert Index Entry" dialog).

(even if Index Marks are involved, there is no reason/need for users to know the technical terminology used in the implementation.)

2. Proposal for tooltip (to be added) and extended tip (to be revised) for checkbox on Type tab.

Tooltip:  Choose this option to include any  index entries inserted in the document for the selected index Type.

Extended tip: Choose this option to include any index entries inserted in the document for the selected index Type. Use Insert > Table of Contents and Index > Index Entry to insert index entries in the document.

Comment: have added "for the selected index Type", because this is also relevant.

3. Could only find one place in online help where "index mark" is mentioned.

"To add an index mark to similar words in your document, select Apply to all similar texts." [1]

Change to:  To add index entries for all other occurrences of the selected entry text, select Apply to all similar texts.

[side comment:]  "similar" seems wrong/misleading for the command label, because it implies a "similarity" search.  Perhaps that label should be:  "Apply to all other occurrences"

4. "Index mark" is only mentioned in WG 7.3 to refer to this option label.

5. "Index mark" is not found in UI (including tooltips/extended tips).

6. There are three .unos that refer to Index Marks. (two for navigator forward, backward to index marks, and one (.uno:IndexMarkToIndex) which suggests that it is relevant to indexes, but have not figured out what it does exactly (in part because of sporadic crashes when used). None of these .unos seem to be included in any toolbar, menubar, contextmenu.

7. There are also two Insert Entry .unos, both of which appear in toolbars, menubars, popup menus.  (side comment: see bug 153847)
 

In sum: preponderance of evidence leans strongly to using "Index Entries"



[1] https://help.libreoffice.org/7.6/en-US/text/swriter/guide/indices_enter.html
Comment 9 sdc.blanco 2023-02-28 11:14:14 UTC
Patch to change option name in Index dialog, add tooltip to option and revise extended tip:

https://gerrit.libreoffice.org/c/core/+/147852

Patch to update help if option name is changed, plus change "index mark":

https://gerrit.libreoffice.org/c/help/+/147907
Comment 10 Commit Notification 2023-02-28 22:22:15 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

tdf#151063   "Index marks" -> "Index entries"

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 11 Commit Notification 2023-02-28 22:23:18 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

tdf#151063  "index mark" -> "index entry"
Comment 12 sdc.blanco 2023-02-28 22:38:40 UTC
(In reply to sdc.blanco from comment #8)
> [side comment:]  "similar" seems wrong/misleading for the command label,
> because it implies a "similarity" search.  Perhaps that label should be: 
> "Apply to all other occurrences"
bug 153890

No further comment received. Changes implemented as described in comment 8.
Closing as FIXED, but if further adjustments/changes are needed, then you are welcome to send them here.