[kde-doc-english] "Documentation not found" handbook in KHelpcenter

[Burkhard Lück]

Hi,

until 4.4 the KHelpcenter/konqueror displayed the error message "There is no 
documentation available for %1." and additionally a modal dialog with the 
error message "The file or folder help://%1 does not exist" in case a 
documentation was not found for what ever reason (not installed, no 
documentation, bug like wrong/missing X-DocPath etc.)

Dealing with bug reports on b.k.o I get the impression this behaviour is not 
more user friendly than a KDebug() output in a konsole, it does not give Joe 
User any hint how to get the missing documentation.

In kde 4.5 the behaviour changed. If a documentation was not found, a docbook 
named documentationnotfound will be displayed. This docbook should explain 
what happened and what to do to get the requested information.

I have quickly written a draft for this document:

"The requested documentation was not found on your computer.

How to solve this issue:

Search on the <ulink url="http://docs.kde.org/">KDE Documentation site</ulink> 
for the requested documentation. If you find the documentation on that site, 
maybe your distribution ships a separate package for documentation (&eg; 
called kdepim-doc for all applications from the kdepim module
like &kmail; &kontact; &etc;). Please use the package manager of your 
distribution to install the missing documentation.

If you have done that, but still get this page displayed instead of the 
application handbook, you probably found a bug in the &kde; help system. 
please report this on the <ulink url="http://bugs.kde.org/">KDE Bug 
Tracker</ulink>.

If you find no documentation on the <ulink url="http://docs.kde.org/">KDE 
Documentation site</ulink> the application does not have an offline 
documentation, please report this on the <ulink url="http://bugs.kde.org/">KDE 
Bug Tracker</ulink>.

In case the application does not have an offline documentation use the online 
ressources <ulink url="http://userbase.kde.org/">Userbase 
Documentation</ulink> and <ulink url="http://forum.kde.org/">KDE Community 
Forums</ulink> to get help."

I am too much involved in the kde documentation system, so I can't imagine if 
this draft is really suited for Joe User.

So please anybody on this list step up and comment/improved this draft:

Does Joe User understand what to do?

What is missing, much/less to technical, needs more explanation?

Better wording?

Any more examples how distributions seperate and name the documentation for an 
application or module?

Thanks. 

-- 
Burkhard Lück