Bug 484176 - The KDE help center does not show the documentation for KDE applications.
Summary: The KDE help center does not show the documentation for KDE applications.
Status: REOPENED
Alias: None
Product: khelpcenter
Classification: Applications
Component: general (show other bugs)
Version: 6.0.240195
Platform: Fedora RPMs Linux
: NOR normal
Target Milestone: ---
Assignee: Documentation Editorial Team
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-03-21 17:02 UTC by Lukas Ruzicka
Modified: 2024-04-08 19:28 UTC (History)
4 users (show)

See Also:
Latest Commit:
Version Fixed In: 24.02.2


Attachments
The page informing about missing docs. (639.39 KB, image/png)
2024-03-21 17:02 UTC, Lukas Ruzicka
Details
Screenshot using F1 and clicking on the title page (101.35 KB, image/jpeg)
2024-04-01 14:27 UTC, Geraldo Simião
Details
Error documentation not found (164.93 KB, image/jpeg)
2024-04-01 14:28 UTC, Geraldo Simião
Details
search results page (103.97 KB, image/jpeg)
2024-04-01 14:30 UTC, Geraldo Simião
Details
Correct documentation page (182.76 KB, image/jpeg)
2024-04-01 14:30 UTC, Geraldo Simião
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Lukas Ruzicka 2024-03-21 17:02:38 UTC
Created attachment 167560 [details]
The page informing about missing docs.

SUMMARY
***
NOTE: If you are reporting a crash, please try to attach a backtrace with debug symbols.
See https://community.kde.org/Guidelines_and_HOWTOs/Debugging/How_to_create_useful_crash_reports
***

The KDE help center does not show more than just a title page of the user documentation for KCalc. The KDE docs team however has the documentation ready on their pages, see https://docs.kde.org/stable5/en/kcalc/kcalc/index.html.

Whenever I decide to choose a subtopic on the KDE web page, it is correctly displayed, see for example https://docs.kde.org/stable5/en/kcalc/kcalc/usage.html#general-usage.

However, if I try the same in the application, I come to a page saying "Documentation not Found", see the attached screenshot.

REPRODUCIBLE: 
Always

STEPS TO REPRODUCE
1. Install KDE Spin.
2. Run KCalc.
3. Press F1 to see the Help Center and arrive at the title page.
4. Try to open any chapter for more details and see the "Documenation not Found" page.

OBSERVED RESULT
No docs for KCalc.

EXPECTED RESULT
Docs are available through the Help Center after fresh installation.


SOFTWARE/OS VERSIONS
Linux/KDE Plasma: Fedora Linux KDE 40 Beta
(available in About System)
KDE Plasma Version:  6.0.2
KDE Frameworks Version: 6.0.0
Qt Version: 6.6.2

ADDITIONAL INFORMATION
Comment 1 Lukas Ruzicka 2024-03-27 13:34:55 UTC
This issue spans over several KDE applications. The Help center starts and shows the title page, but the real documentation is missing.
Comment 2 Geraldo Simião 2024-04-01 14:24:28 UTC
Bug still present on khelpcenter-24.02.1-1.fc40.x86_64. If you just press F1 and then click on any chapter from the title page it shows the "documentation not found" page. BUT, if you browse through the helpcenter (or use search) and then arrive a the title page for kcalc (for example) THEN you can click on the topic you want and open the right page.
Comment 3 Geraldo Simião 2024-04-01 14:27:08 UTC
Created attachment 168015 [details]
Screenshot using F1 and clicking on the title page
Comment 4 Geraldo Simião 2024-04-01 14:28:10 UTC
Created attachment 168016 [details]
Error documentation not found
Comment 5 Geraldo Simião 2024-04-01 14:30:05 UTC
Created attachment 168017 [details]
search results page

If I do a search on help center, for the same kcalc I found this results. Clicking on the same chapter link it give me the correct doc.
Comment 6 Geraldo Simião 2024-04-01 14:30:46 UTC
Created attachment 168018 [details]
Correct documentation page
Comment 7 Bug Janitor Service 2024-04-06 17:09:00 UTC
A possibly relevant merge request was started @ https://invent.kde.org/system/khelpcenter/-/merge_requests/46
Comment 8 Nicolas Fella 2024-04-06 17:30:28 UTC
Git commit 22f175cf3205dda13ebb72a183d76c1af8f7a20a by Nicolas Fella.
Committed on 06/04/2024 at 17:08.
Pushed by ltoscano into branch 'master'.

Fix opening subpages of documentation

When opening a URL like help:/kcalc we don't resolve relative URLs correctly, e.g. simple-mode.html resolves to help:/simple-mode.html instead of help:/kcalc/simple-mode.html

This doesn't happen when opening help:/kcalc/ (i.e. with a trailing slash)

M  +9    -1    mainwindow.cpp

https://invent.kde.org/system/khelpcenter/-/commit/22f175cf3205dda13ebb72a183d76c1af8f7a20a
Comment 9 Nicolas Fella 2024-04-06 17:36:05 UTC
Git commit b555a88ba8a84fddc9ba24a353ea8d8c488d111e by Nicolas Fella.
Committed on 06/04/2024 at 17:35.
Pushed by nicolasfella into branch 'release/24.02'.

Fix opening subpages of documentation

When opening a URL like help:/kcalc we don't resolve relative URLs correctly, e.g. simple-mode.html resolves to help:/simple-mode.html instead of help:/kcalc/simple-mode.html

This doesn't happen when opening help:/kcalc/ (i.e. with a trailing slash)
(cherry picked from commit 22f175cf3205dda13ebb72a183d76c1af8f7a20a)

M  +9    -1    mainwindow.cpp

https://invent.kde.org/system/khelpcenter/-/commit/b555a88ba8a84fddc9ba24a353ea8d8c488d111e
Comment 10 Luigi Toscano 2024-04-07 13:10:52 UTC
The bug is not full fixed and the fix introduced regressions (my bad), please check the comments in https://invent.kde.org/system/khelpcenter/-/merge_requests/46.
If there are no other updates I'm going to revert the changes before 24.02.2.
Comment 11 Bug Janitor Service 2024-04-08 14:50:20 UTC
A possibly relevant merge request was started @ https://invent.kde.org/system/khelpcenter/-/merge_requests/48
Comment 12 Friedrich W. H. Kossebau 2024-04-08 19:27:10 UTC
Git commit ef19ffe3c46b385301a7462fdf86d4c32b7b0f34 by Friedrich W. H. Kossebau.
Committed on 08/04/2024 at 15:10.
Pushed by nicolasfella into branch 'master'.

Fix missing URL redirection implementation in web engine feeding from KIO

Resulted in broken URLs generated from URL set for pages and the
relative URLs used in the pages.

M  +9    -0    view.cpp

https://invent.kde.org/system/khelpcenter/-/commit/ef19ffe3c46b385301a7462fdf86d4c32b7b0f34
Comment 13 Nicolas Fella 2024-04-08 19:28:50 UTC
Git commit b61222309bb414f064280f368b8984270b9bf853 by Nicolas Fella, on behalf of Friedrich W. H. Kossebau.
Committed on 08/04/2024 at 19:28.
Pushed by nicolasfella into branch 'release/24.02'.

Fix missing URL redirection implementation in web engine feeding from KIO

Resulted in broken URLs generated from URL set for pages and the
relative URLs used in the pages.
(cherry picked from commit ef19ffe3c46b385301a7462fdf86d4c32b7b0f34)

M  +9    -0    view.cpp

https://invent.kde.org/system/khelpcenter/-/commit/b61222309bb414f064280f368b8984270b9bf853