Bug 212931 - Help menu points to missing file
Summary: Help menu points to missing file
Status: RESOLVED FIXED
Alias: None
Product: khelpcenter
Classification: Applications
Component: general (show other bugs)
Version: unspecified
Platform: Ubuntu Linux
: NOR normal
Target Milestone: ---
Assignee: Cornelius Schumacher
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-11-03 16:16 UTC by xteejyx
Modified: 2010-10-28 22:36 UTC (History)
3 users (show)

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:


Attachments
simple KTorrent article (4.01 KB, text/html)
2010-10-27 22:45 UTC, Burkhard Lück
Details

Note You need to log in before you can comment on or make changes to this bug.
Description xteejyx 2009-11-03 16:16:42 UTC
Version:           4.3.2-0ubuntu3 (using KDE 4.3.2)
OS:                Linux
Installed from:    Ubuntu Packages

Using Kubuntu 9.10. In some KDE applications (for example, KTorrent), Help-> <appname> handbook opens a KDE Help Centre window with "There is no documentation available for /ktorrent/index.html." If there is no documentation available, the application should say so itself (or perhaps not have a Handbook item in the menu at all), instead of opening a useless KDE Help Centre window.

This bug is being tracked in Launchpad at
https://bugs.launchpad.net/ubuntu/+source/meta-kde/+bug/198708
Comment 1 Burkhard Lück 2009-11-04 11:24:44 UTC
Instead of the useless error message "There is no documentation available for..." and the modal dialog a page should be displayed with:
Link to docs.kde.org
Link to userbase.kde.org
Link to forum.kde.org
etc to enable the user getting help.

I offer to write a docbook for this purpose, but a developer needs to implement the loading of this docbook in kdelibs/kdoctools/kio_help.cpp?
Comment 2 Valentin 2010-10-09 18:13:04 UTC
Can still confirm this in 4.4.2 of KDE and 3.3.4 of KTorrent. It should be sufficient if the KTorrent tool creates a ktorrent.desktop file within /usr/share/kde4/apps/khelpcenter/plugins
with at least the following content:

[Desktop-Entry]
Type=Applications
x-DocPath=help://ktorrent/index.html
Comment 3 Valentin 2010-10-09 18:15:05 UTC
Sorry, forgot to mention: This entry is already there. Just place the index.html file (which contains the manpage) within the directory
/usr/share/doc/KDE4/HTML/en/ktorrent/
and it should be displayed within the KDE Help Center.
Comment 4 Burkhard Lück 2010-10-09 21:56:33 UTC
(In reply to comment #3)
> Sorry, forgot to mention: This entry is already there. Just place the
> index.html file (which contains the manpage) within the directory
> /usr/share/doc/KDE4/HTML/en/ktorrent/
> and it should be displayed within the KDE Help Center.

There is no documentation for ktorrent, that is the problem :-(
Comment 5 Valentin 2010-10-09 23:39:35 UTC
I suggest to create a simple html-file which either includes or links this websites:
http://ktorrent.org/wiki/index.php/FAQ

Including external websites is possible (have tested this already).
Comment 6 Burkhard Lück 2010-10-27 22:45:55 UTC
Created attachment 52921 [details]
simple KTorrent article

@ Valentin:
Does the attached html generated from docbook source fulfill your requirements?

@ Joris:
Is the attached doc ok?
What should be corrected/fixed/added?
Comment 7 Joris Guisson 2010-10-28 19:09:04 UTC
Looks good to me, maybe I will expand it a bit later on.
Comment 8 Valentin 2010-10-28 21:15:10 UTC
Awesome that you took the effort and created a file,  Burkhard!
I would love to help you with it in the future, just need to find some time for it.
Comment 9 Burkhard Lück 2010-10-28 22:36:48 UTC
SVN commit 1190768 by lueck:

add help file with online ressources
@Valentin: if you'd like to join the kde documentation team subscribe to kde-doc-english@kde.org
BUG:212931
CCBUG:136994

 M  +1 -0      CMakeLists.txt  
 A             ktorrent (directory)  
 A             ktorrent/CMakeLists.txt  
 A             ktorrent/index.docbook  


WebSVN link: http://websvn.kde.org/?view=rev&revision=1190768