Bug 162504 - No Help page for multiple Sidebar Decks
Summary: No Help page for multiple Sidebar Decks
Status: ASSIGNED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
unspecified
Hardware: All All
: medium normal
Assignee: Dione Maddern
URL:
Whiteboard: target:25.2.0 target:25.8.0 target:25...
Keywords:
Depends on:
Blocks: Sidebar Help-Link
  Show dependency treegraph
 
Reported: 2024-08-17 19:37 UTC by Dione Maddern
Modified: 2025-01-14 22:15 UTC (History)
3 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 Dione Maddern 2024-08-17 19:37:27 UTC
Description:
There is no help page for the Properties Sidebar deck. Clicking the "Help" button currently returns a 404 error.

Steps to Reproduce:
1. Open Calc, Draw, Impress, Math, or Writer
2. Open the Properties sidebar deck.
3. Click on the "?" button at the top right of the sidebar.

Actual Results:
Leads to an error message:

>Could not find Help page (404).
>That is an error. Possible causes are:
>    The page does not exist and must be created.
>    The page exists, but the Help ID is wrong or missing.
> Use the Module, Contents, Index and Search selectors to find the right page.
> The following data could be helpful in locating the error:
> Help ID: SIDEBAR_PROPERTYDECK


Expected Results:
Opens a help page explaining how to use the Properties sidebar deck.


Reproducible: Always


User Profile Reset: No

Additional Info:
I couldn't find an existing page for the Properties deck.
Comment 1 V Stuart Foote 2024-08-17 22:00:03 UTC
When SB deck help button was implemented for bug 156156, not all articles were not completed for all decks, get Error 404 for the following:

Help ID: SIDEBAR_PROPERTYDECK
Help ID: SIDEBAR_STYLELISTDECK
Help ID: SIDEBAR_NAVIGATORDECK
Help ID: SIDEBAR_WRITERPAGEDECK
Help ID: SIDEBAR_SWDESIGNDECK

These do exist for Writer, but didn't check other modules:
SIDEBAR_GALLERYDECK
SIDEBAR_INSPECTORDECK
SIDEBAR_SWMANAGECHANGESDECK
SIDEBAR_A11YCHECKDECK
Comment 2 V Stuart Foote 2024-08-17 22:03:27 UTC
s/not all articles were not completed/not all articles were completed/
Comment 3 Dione Maddern 2024-08-18 14:48:03 UTC
(In reply to V Stuart Foote from comment #1)
> Help ID: SIDEBAR_STYLELISTDECK
> Help ID: SIDEBAR_NAVIGATORDECK
> Help ID: SIDEBAR_WRITERPAGEDECK

Could you confirm that these aren't working for you? If so, which build are you using? 

They should have been fixed in the following patches.
https://gerrit.libreoffice.org/c/help/+/169950
https://gerrit.libreoffice.org/c/help/+/170865
https://gerrit.libreoffice.org/c/help/+/170865

They're working for me in:

Version: 25.2.0.0.alpha0+ (X86_64) / LibreOffice Community
Build ID: e3d7473a5611f414bfcf1a3e812248c82f9e9b83
CPU threads: 8; OS: Linux 6.9; UI render: default; VCL: x11
Locale: en-US (en_US.UTF-8); UI: en-US
Calc: CL threaded
Comment 4 V Stuart Foote 2024-08-18 18:09:37 UTC
(In reply to Dione Maddern from comment #3)
> (In reply to V Stuart Foote from comment #1)
> > Help ID: SIDEBAR_STYLELISTDECK
> > Help ID: SIDEBAR_NAVIGATORDECK
> > Help ID: SIDEBAR_WRITERPAGEDECK
> 
> Could you confirm that these aren't working for you? If so, which build are
> you using? 
> 

Without local/off-line help installed, <F1> on respective SB tab returns the online generic LibreOfficeDev Writer Help -- Working With LibreOffice Writer Help articles.

2024081 TB77 nightly
Version: 25.2.0.0.alpha0+ (X86_64) / LibreOffice Community
Build ID: dda85e275d70d6365009042b8e207337f2e712c2
CPU threads: 8; OS: Windows 10 X86_64 (10.0 build 19045); UI render: Skia/Vulkan; VCL: win
Locale: en-US (en_US); UI: en-US
Calc: CL threaded

likewise for 

Version: 24.2.5.1 (X86_64) / LibreOffice Community
Build ID: 2ccb78ad6bdfe3f3356a7a7f294ec388775c5816
CPU threads: 8; OS: Windows 10.0 Build 19045; UI render: default; VCL: win
Locale: en-US (en_US); UI: en-US

While if installing the local/off-line help for the 20240815 25.2.0 nightly--no change--only opens a local copy of the same generic module Help. Something isn't linked up correctly.
Comment 5 V Stuart Foote 2024-08-20 23:26:38 UTC
Just retested with the TB77 20240820 nightly of master against 25.2.0. 

None of the SB decks are successfully linked to their Help articles. <F1> for each tab bar deck launches to the module specific Help welcome landing article. 

Same result with the local/off-line Help installed, just opening the local copy of the module's welcome landing article.

=-testing-=
Version: 25.2.0.0.alpha0+ (X86_64) / LibreOffice Community
Build ID: a05432f02b6441b66addc0f22f1b8444557ac37b
CPU threads: 8; OS: Windows 10 X86_64 (10.0 build 19045); UI render: Skia/Vulkan; VCL: win
Locale: en-US (en_US); UI: en-US
Calc: CL threaded
Comment 6 Dione Maddern 2024-08-23 13:58:19 UTC
Sorry for taking so long to respond. It looks like there are a some widgets that still get a 404 message, and a few that don't have a unique page, so they just go to a generic page.

I'll fix the links that can be fixed.

The "Help" button should at least be working, though. That might be a Windows specific issue with the UI.
Comment 7 V Stuart Foote 2024-08-23 15:18:31 UTC
(In reply to Dione Maddern from comment #6)
>...
> The "Help" button should at least be working, though. That might be a
> Windows specific issue with the UI.

Could be. 

I notice that if I activate the "What's This" widget from the main menu Help, and click on any button control (Standard TB, or SB Tabbar) it simply performs the action with no Help response. While if working in the main app frame, the <F1> help seems blind to the linked widget and only returns the generic Help landing for the active module. But when a dialog (e.g. Tools -> Options, Special Character, etc.) is open the <F1> is linking/reaching its article. 

=-testing-=
with local/off-line help installed
Version: 25.2.0.0.alpha0+ (X86_64) / LibreOffice Community
Build ID: a05432f02b6441b66addc0f22f1b8444557ac37b
CPU threads: 8; OS: Windows 10 X86_64 (10.0 build 19045); UI render: Skia/Vulkan; VCL: win
Locale: en-US (en_US); UI: en-US
Calc: CL threaded
Comment 8 Commit Notification 2024-09-05 13:26:58 UTC
Dione Maddern committed a patch related to this issue.
It has been pushed to "master":

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

tdf#162504 tdf#152161 Create help pages for Properties sidebar panels
Comment 9 Commit Notification 2024-09-10 23:35:22 UTC
Dione Maddern committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/772d0921f2f832deff089cad653e726bff6580ff

tdf#162504 Add links and missing content to Styles Deck help page
Comment 10 V Stuart Foote 2024-09-18 19:39:10 UTC
Still having issues reaching the correct help articles.

If I open one of the module dialogs, e.g. Paragraph, or Character, an <F1> while focus into the dialog launches and lands on the article appropriate for the active tab of the dialog.

But, if I do the same from any SB deck tab button or Content Panel, or likewise any TB button--I get only the generic help for the module.

=-testing-=

Version: 25.2.0.0.alpha0+ (X86_64) / LibreOffice Community
Build ID: d14e79bf7680db2180e40ba52fc3305a84c586f6
CPU threads: 8; OS: Windows 10 X86_64 (10.0 build 19045); UI render: Skia/Vulkan; VCL: win
Locale: en-US (en_US); UI: en-US
Calc: CL threaded
Comment 11 Commit Notification 2024-11-12 17:23:02 UTC
Dione Maddern committed a patch related to this issue.
It has been pushed to "master":

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

tdf#162504 Add help page for Design sidebar deck
Comment 12 Commit Notification 2024-11-19 18:59:37 UTC
Dione Maddern committed a patch related to this issue.
It has been pushed to "master":

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

tdf#162504 Create help page for Number Format pane
Comment 13 Commit Notification 2024-12-09 20:13:37 UTC
Dione Maddern committed a patch related to this issue.
It has been pushed to "master":

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

tdf#162504 Create help page for Alignment Sidebar panel
Comment 14 Commit Notification 2024-12-09 23:13:19 UTC
Dione Maddern committed a patch related to this issue.
It has been pushed to "libreoffice-25-2":

https://git.libreoffice.org/help/commit/86da4a6e1f4b02e5b5093ead59afb821d9a4c6fa

tdf#162504 Create help page for Alignment Sidebar panel
Comment 15 V Stuart Foote 2025-01-02 14:46:17 UTC
Confirm that all decks from the SB Tab bar respond with appropriate Help article. But *ONLY* with the Question mark 'Help about this sidebar deck' button action located on the Deck title bar.

There is very chaotic behavior of the <F1> or the main menu Help -> 'What's This?' selector. Seems something is not connected correctly for these traditional help controls, and they don't reach the correct article. Or the article throws 404 error.
Comment 16 Dione Maddern 2025-01-02 15:42:11 UTC
(In reply to V Stuart Foote from comment #15)
> Confirm that all decks from the SB Tab bar respond with appropriate Help
> article. But *ONLY* with the Question mark 'Help about this sidebar deck'
> button action located on the Deck title bar.
> 
> There is very chaotic behavior of the <F1> or the main menu Help -> 'What's
> This?' selector. Seems something is not connected correctly for these
> traditional help controls, and they don't reach the correct article. Or the
> article throws 404 error.

I'm having (unrelated) trouble building the help submodule today. I'll have to get that fixed before I have a proper look, but I still have a lot of help pages to complete for the Sidebar. There are also a number of instances where F1 doesn't work due to the way the UI is constructed. As far as I know, there is currently no way to fix this.
Comment 17 V Stuart Foote 2025-01-02 16:03:31 UTC
Actually, using the "Help about this sidebar deck" button, the 'Properties' (<Alt>+1) decks for each module are not linking to their Help pages if implemented. And they all are throwing 404 errors with note Help ID: SIDEBAR_PROPERTYDECK

Also the sm Formula SB 'Elements' (<Alt>+2) deck throws a 404 error with note Help ID: SIDEBAR_ELEMENTSDECK


2025-01-02 TB77 nightly with local offline help installed.

Version: 25.8.0.0.alpha0+ (X86_64) / LibreOffice Community
Build ID: a1c835797d16383db1e67035c79b237c7706df0c
CPU threads: 8; OS: Windows 10 X86_64 (build 19045); UI render: Skia/Vulkan; VCL: win
Locale: en-US (en_US); UI: en-US
Calc: CL threaded
Comment 18 Dione Maddern 2025-01-02 18:20:49 UTC
(In reply to V Stuart Foote from comment #17)
> Actually, using the "Help about this sidebar deck" button, the 'Properties'
> (<Alt>+1) decks for each module are not linking to their Help pages if
> implemented. And they all are throwing 404 errors with note Help ID:
> SIDEBAR_PROPERTYDECK
> 
> Also the sm Formula SB 'Elements' (<Alt>+2) deck throws a 404 error with
> note Help ID: SIDEBAR_ELEMENTSDECK
> 
> 
> 2025-01-02 TB77 nightly with local offline help installed.
> 
> Version: 25.8.0.0.alpha0+ (X86_64) / LibreOffice Community
> Build ID: a1c835797d16383db1e67035c79b237c7706df0c
> CPU threads: 8; OS: Windows 10 X86_64 (build 19045); UI render: Skia/Vulkan;
> VCL: win
> Locale: en-US (en_US); UI: en-US
> Calc: CL threaded

Yes, the main page for the Properties deck is disabled until I finish the pages for individual panels. 

I haven't gotten to the Formula deck yet. There may not be a page for it.
Comment 19 Commit Notification 2025-01-14 19:46:12 UTC
Dione Maddern committed a patch related to this issue.
It has been pushed to "master":

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

tdf#162504 Add help page for Cell Appearance sidebar panel
Comment 20 Dione Maddern 2025-01-14 22:15:41 UTC
(In reply to Commit Notification from comment #19)
> Dione Maddern committed a patch related to this issue.
> It has been pushed to "master":
> 
> https://git.libreoffice.org/help/commit/
> bdd4044b77f13aad47d233aebdd529530271b119
> 
> tdf#162504 Add help page for Cell Appearance sidebar panel

I've created help pages for all the "Properties" panels for Calc now. I'll work on the ones for Impress next. Once I've documented the panels, I can finalize the page for the Properties sidebar, and move on to any remaining sidebars.