Bug 144713 - Basic's "Option Button" documentation mentions "indices", which term is not used in the relevant property name
Summary: Basic's "Option Button" documentation mentions "indices", which term is not u...
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
unspecified
Hardware: All All
: medium normal
Assignee: Olivier Hallot
URL:
Whiteboard: target:7.3.0
Keywords:
Depends on:
Blocks:
 
Reported: 2021-09-25 05:41 UTC by Mike Kaganski
Modified: 2022-01-07 20:57 UTC (History)
1 user (show)

See Also:
Crash report or crash signature:


Attachments
Option button's properties in Basic IDE (21.36 KB, image/png)
2021-09-25 05:41 UTC, Mike Kaganski
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Mike Kaganski 2021-09-25 05:41:33 UTC
Created attachment 175249 [details]
Option button's properties in Basic IDE

Insert Controls help page [1] tells:

> Option Button
> 
> Adds a button that allows a user to select from a number of options. Grouped
> option buttons must have consecutive tab indices. They are commonly encircled
> by a group box. If you have two groups of option buttons, you must insert a tab
> index between the tab indices of the two groups on the group frame.

The term "index" is not used in the option button's property, which is called "Tab Order" (see screenshot).

This results in confusion, including those who translate (see resp. Russian translation), as well as users who are not very fluent in English [2] (Rus). The confusion in this case is aggravated by the curious detail that the two similar cases - option buttons in Basic dialogs and in forms - behave differently in this regard (the latter does not use tab order to group the controls, but uses name [3]; and having group name in Basic makes users expect same behavior); that makes this issue especially problematic.

The help text should use terms used in the respective UI strings.

[1] https://help.libreoffice.org/latest/en-US/text/sbasic/shared/02/20000000.html
[2] https://forumooo.ru/index.php/topic,8841.msg59974
[3] https://help.libreoffice.org/latest/en-US/text/shared/02/01170000.html
Comment 1 Commit Notification 2021-09-30 13:57:09 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/2d9ad5a39e416c967af625426572b68498d3c68b

tdf#144713 rename tab indices -> tab order in group controls
Comment 2 Rafael Lima 2022-01-07 20:57:19 UTC
Verified in LO 7.3

The current help page:
https://help.libreoffice.org/7.3/en-US/text/sbasic/shared/02/20000000.html

The text was changed to:

... If you have two groups of option buttons, you must insert a tab order between the tab orders of the two groups.