Bug 153897 - Replace "Mark" with "Entry" in the "Label" of .uno:GotoNextIndexMark, .uno:GotoPrevIndexMark and .uno:IndexMarkToIndex
Summary: Replace "Mark" with "Entry" in the "Label" of .uno:GotoNextIndexMark, .uno:G...
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Writer (show other bugs)
Version:
(earliest affected)
7.6.0.0 alpha0+
Hardware: All All
: medium normal
Assignee: Not Assigned
URL:
Whiteboard: target:7.6.0
Keywords:
Depends on:
Blocks: TableofContents-Indexes UNO-Command-Label
  Show dependency treegraph
 
Reported: 2023-03-01 11:16 UTC by sdc.blanco
Modified: 2023-08-12 13:39 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 sdc.blanco 2023-03-01 11:16:28 UTC
(Note: To see the .unos in the bug summary, search on "Mark" in Tools - Customize. To test, you will need to add them to a toolbar/menu/shortcut).

Bug 151063, comment 8 gives evidence that "Index Mark" does not appear in the UI, help, or Writer's Guide. 

"Index Mark" may have a technical meaning in the implementation, but there is no obvious reason why users should learn this technical term, when the interface is using "Index Entry" (e.g., "Insert Index Entry" and "Insert Index (Table of Contents) and Insert Index (User-Defined)"), and there is no command to "Insert Index Mark" or "View Index Mark" (for example).

The actual behavior of "Go to [Next | Previous] Index Mark" is to go to the (index mark?) that is inserted with the Insert Entry dialog. From user POV,  "Go to Next Index Entry" makes more sense, given that the cursor is placed where Insert Index Entry was used.

At present, "Index Mark to Index" crashes (bug 153866), but from looking at the source code [1] [2], I am guessing that this command moves the cursor from the selected index entry to the place in an Index that corresponds to the Index Entry.   (if this guess is correct, then maybe a better name/label can be found for this .uno, such as "Jump to Index") -- but for now, in relation to the OP, changing "Mark" to "Entry" would still be meaningful.

[1] https://opengrok.libreoffice.org/xref/core/sw/source/uibase/shells/textidx.cxx?r=0908c7c1#170
[2] https://opengrok.libreoffice.org/xref/core/sw/source/core/crsr/crstrvl.cxx?r=db115bec&fi=GotoTOXMarkBase#359
Comment 1 V Stuart Foote 2023-03-01 13:05:11 UTC
@Seth, well reasoned as always. 

But kind of like the "hyperlink" discussion--"index mark" is the accepted terminology in technical English. But rather than there, if we change to "index entry" what effect on the l10n translations.

In other words would/could it end up an awkward usage in the UI when localized.

@Sophie something to take to the l10n team in advance for a change?
Comment 2 V Stuart Foote 2023-03-01 13:16:38 UTC
(In reply to V Stuart Foote from comment #1)

And, just reread bug 151063 -- you covered it all there. Change here for UNO naming from mark to entry is now appropriate.  But the translation team should get a say on this an similar.
Comment 3 sophie 2023-03-01 13:32:01 UTC
(In reply to V Stuart Foote from comment #1)
> 
> @Sophie something to take to the l10n team in advance for a change?

Done :) Thanks for the head-up!
Comment 4 V Stuart Foote 2023-03-01 15:42:54 UTC
While the UNO is user exposed and the rename of the UNO is probably justified to match the changes to help/documentation for bug 151063, should keep in mind the dev and implementation side:

https://wiki.documentfoundation.org/Documentation/DevGuide/Text_Documents#Indexes_and_Index_Marks

is germane as to what is happening under the hood, and wold be obfuscated with the UNO rename.
Comment 5 sdc.blanco 2023-03-01 21:52:02 UTC
Thanks for thorough review Stuart.
To clarify: No changes proposed for the .uno names themselves. 
Summary is now revised to indicate that the OP is directed (implicitly) to the "Label" of the three .unos.  
Change would only be in officecfg/registry/data/org/openoffice/Office/UI/WriterCommands.xcu -- where tooltip (in Customize) defaults to "Label".
Comment 6 sdc.blanco 2023-04-04 23:52:46 UTC
(In reply to sophie from comment #3)
> (In reply to V Stuart Foote from comment #1)
> > @Sophie something to take to the l10n team in advance for a change?
> Done :) Thanks for the head-up!
@Sophie - Any news?
Comment 7 sdc.blanco 2023-05-01 00:12:42 UTC
https://gerrit.libreoffice.org/c/core/+/151196
Comment 8 Commit Notification 2023-05-03 06:37:32 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/8426c38a23e5bcc4a8fc061113755de0f8dbc250

tdf#153897  "mark" to "entry" for index .unos

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 9 sdc.blanco 2023-05-03 06:41:28 UTC
No further comment received. If there are any problems with these label changes, then it is fine to post followups here. But for now, closing as FIXED.