Bug 154996 - Help pages about dialogs should provide instructions for the Tabbed UI
Summary: Help pages about dialogs should provide instructions for the Tabbed UI
Status: NEW
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
5.4.0.3 release
Hardware: All All
: medium normal
Assignee: Not Assigned
URL:
Whiteboard: target:7.6.0 target:24.2.0 target:7.6...
Keywords:
Depends on: 155875 155877 155878 155879 155880 155876
Blocks: HelpGaps-NewFeatures Notebookbar-Tabbed
  Show dependency treegraph
 
Reported: 2023-04-24 23:11 UTC by Rafael Lima
Modified: 2024-05-23 21:11 UTC (History)
1 user (show)

See Also:
Crash report or crash signature:


Attachments
First mockup. Please comment (47.20 KB, image/png)
2023-05-24 14:17 UTC, Olivier Hallot
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Rafael Lima 2023-04-24 23:11:56 UTC
Currently, help pages for dialogs provide instructions on how to get to the dialog using either (i) the menubar or (ii) the standard toolbar, or (iii) by using accelerators when they exist. However, we still have no instructions on how to get to these dialogs using the Tabbed UI.

For instance, here's the help page for the "Insert Table" dialog (this is just as an example; this ticket refers to all help pages about dialogs).
https://help.libreoffice.org/7.5/en-US/text/swriter/01/04150000.html

In this page we have a "To access this command... " section that contains:

(menubar instructions)
Choose Table - Insert Table

(accelerator instructions)
Ctrl+F12

(standard toolbar instructions)
Open Insert toolbar, click

However, we do not have any Tabbed UI instructions, which in this case should be:
In the Insert tab, select Table - More Options

Given the popularity of the Tabbed UI and the emphasis it receives in the View - User Interface dialog (it stays together with the Standard Toolbar option in a separate section), I believe we should start improving the Help pages by providing instructions also considering the Tabbed UI.
Comment 1 Olivier Hallot 2023-05-24 14:17:11 UTC
Created attachment 187479 [details]
First mockup. Please comment
Comment 2 Rafael Lima 2023-05-24 14:35:03 UTC
(In reply to Olivier Hallot from comment #1)
> First mockup. Please comment

This is looking really good and clean.

The only thing I would change is:
"From the Tab interface" -> "From the Tabbed interface"

The name used in the UI is "Tabbed interface". Se f.i. in View - User interface.
Comment 3 John Mills 2023-05-24 17:58:18 UTC
I would personally say yes to this request for usability purposes, a prompt to ensure that the Tabbed UI is not a "second class" UI in LibreOffice and considered for documentation is clearly beneficial for those that use this type of UI. This would ensure that thought is given to both UI interfaces. However, I can understand that some will question this on the basis that the current UI is the default. This is correct of course but not an ideal situation where it is the only UI that is given consideration for documentation.
Comment 4 Eyal Rozenberg 2023-05-25 12:21:20 UTC
I don't object to instructions for locating things on the Tabbed UI to be part of the help pages; but - certainly not as the default. Please see the (long) discussion in bug 135501 about that.

Also, recalling that the Tabbed UI has numerous outstanding issues, it does not make sense to promote its use more than the use of, say, toolbars.

So, the order of items IMO should be:

* menus
* toolbars
* tabbed UI
* keyboard shortcut

or 


* menus
* toolbars
* keyboard shortcut
* tabbed UI

Also, 

(In reply to John Mills from comment #3)
> I would personally say yes to this request for usability purposes, a prompt
> to ensure that the Tabbed UI is not a "second class" UI in LibreOffice

But it is a second-class UI, in two senses: It is inferior usability-wise, even when fully implemented; and it is currently not fully/properly implemented relative to the menus and toolbars. (Like how it is completely unusable for RTL language speakers who need Calc.)

> and
> considered for documentation is clearly beneficial for those that use this
> type of UI. This would ensure that thought is given to both UI interfaces.

This I agree with.

> This is correct of course but not an ideal
> situation where it is the only UI that is given consideration for
> documentation.

The ideal situation is when tabbed UI is relegated to an extension and removed from the main codebase. It's only because of MSO's poor UI choice that supporting it to this level has any legitimacy, as far as I am concerned.
Comment 5 Commit Notification 2023-05-25 14:47:50 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

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

tdf#154996 Tabbed Interface command in Help pages
Comment 6 Commit Notification 2023-05-25 14:47:52 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/31fe3777cb0dc69a3badc026f4de55c096af48d9

tdf#154996 Add tabbed UI commands in Help page
Comment 7 Commit Notification 2023-05-28 16:25:36 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

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

tdf#154996 Review Common File menu entries
Comment 8 Commit Notification 2023-05-28 21:41:03 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

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

tdf#154996 Add tabbed UI commands in Help page
Comment 9 Commit Notification 2023-05-29 10:12:04 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/921da60c0a7bf06943277d27dad3e10b19d7d5bd

tdf#154996 Add tabbed UI commands in Help page
Comment 10 Commit Notification 2023-05-29 19:38:00 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

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

tdf#154996 Add tabbed UI commands in Help page
Comment 11 Commit Notification 2023-06-02 13:50:37 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

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

tdf#154996 Add tabbed UI commands in Help page
Comment 12 Commit Notification 2023-06-05 22:12:34 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/269d7afe0492c2e438c328de95de3ed445809260

tdf#154996 Add tabbed UI commands in Help page
Comment 13 Commit Notification 2023-06-05 22:12:36 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

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

tdf#154996 Add tabbed UI commands in Help page
Comment 14 Commit Notification 2023-06-05 22:13:39 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

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

tdf#154996 Add tabbed UI commands in Help page
Comment 15 Commit Notification 2023-06-07 11:34:46 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

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

tdf#154996 Add tabbed UI commands in Help page
Comment 16 Commit Notification 2023-06-07 15:39:12 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/374b792c275fbfb5fad9d12764fecde6d1d5aaaa

tdf#154996 Add tabbed UI commands in Help page
Comment 17 Commit Notification 2023-06-11 21:37:36 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/367807066f4e2a1190fe056fd6e52026fd35e2a6

tdf#154996 Add tabbed UI commands in Help page
Comment 18 Commit Notification 2023-06-11 21:37:38 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/97ed4a4faa26d89ee068b12efed26c99caf1ce86

tdf#154996 Add tabbed UI commands in Help page
Comment 19 Commit Notification 2023-06-12 01:30:59 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/05cb445d5f273ccbeb80b1af28bcb1a13e9b8b14

tdf#154996 Add tabbed UI commands in Help page
Comment 20 Commit Notification 2023-06-20 14:14:07 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "libreoffice-7-6":

https://git.libreoffice.org/help/commit/652da5c0713370d8a711631a80ed29c0c2907faf

tdf#154996 Add tabbed UI commands in Help page
Comment 21 Commit Notification 2023-06-20 14:14:09 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "libreoffice-7-6":

https://git.libreoffice.org/help/commit/50f30d1815ae931a1629fd1c07af3842d8d208c1

tdf#154996 Add tabbed UI commands in Help page
Comment 22 Commit Notification 2023-06-20 14:15:12 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "libreoffice-7-6":

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

tdf#154996 Add tabbed UI commands in Help page
Comment 23 Commit Notification 2023-10-06 00:21:56 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

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

tdf#154996 Update tools - macro UI help pages
Comment 24 Commit Notification 2023-10-06 14:46:10 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

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

tdf#154996 Update tools - remaining help pages
Comment 25 Commit Notification 2024-05-23 21:11:03 UTC
Dione Maddern committed a patch related to this issue.
It has been pushed to "master":

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

tdf#130838 tdf#154996 Add warning about copying/moving in record mode