On 2020.09.08 16:25, Jack wrote:
Yuri - thanks for the quick response.
On 2020.09.08 14:09, Yuri Chornoivan wrote:
вівторок, 8 вересня 2020 р. 20:46:37 EEST Jack написано:
If I launch the clipboard widget (klipper), click "Configure
Clipboard," and then click the "Help" button, I get the dreaded
"Documentation not Found" page I wrote in 2014. (I just discovered
this because someone sent me a message because my email address is
on that page as the author.) He's on Suse Tumbleweed, and I'm on
Gentoo, so I don't think it's a packaging problem.
>
However, if I open khelpcenter and search for klipper (how is
someone to know that "klipper" is the name of the "clipboard"
widget?) the documentation is present.
>
So, I'm wondering if Klipper is actually calling KHelpCenter with
the wrong name for the doc it is looking for.
Sure. The KConfigDialog window is for KCMs, so the "Help" button
tries to load help:/kcontrol(5)/klipper, but the docs are stored for
help:/klipper.
That makes sense. How easily can that be fixed, and does it need a
bug filed, and if so, against which component?
Separately, when that happens, there is no way to know what page
KHelpCenter was asked to find. Would that be a useful enhancement
to request? (Showing the name of the doc requested when it can't
be found.)
I think so.
Bug 426311 filed.
I'll also probably try to update the "Documentation not Found" page
to add a note not to contact the author of the page for help, as he
will just tell you to follow the instructions on the page.
I finally found the source of that page, buried under kio, but
several changes (such as adding a <tip>) are rejected by checkXML5 as
not following the DTD. It's using kdedbx45.dtd, so I'm not sure why
a <tip> wouldn't be allowed.
My bad - I was misreading the error message. I missed that <para> is
needed within <tag>. I've attached a proposed diff to that page. I
also added the suggestion to search in KHelpCenter before checking the
online docs. If there are any suggestions, I"ll be glad to update.
Jack
--- index.docbook.orig 2020-09-08 15:57:54.803154076 -0400
+++ index.docbook 2020-09-08 17:55:35.452662171 -0400
@@ -17,8 +17,8 @@
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
-<date>2014-04-02</date>
-<releaseinfo>Frameworks 5.0</releaseinfo>
+<date>2020-09-08</date>
+<releaseinfo>Frameworks 5.73</releaseinfo>
</articleinfo>
@@ -27,15 +27,23 @@
<para>The documentation may not exist, or it may not have been installed
with the application.</para>
+<tip><para>
+Please do not email the author of this page to find the missing document.
+He will just tell you to follow the instructions on this page.
+</para></tip>
+
<simplesect>
<title>How to solve this issue</title>
-<para>If the application is &kde; software, start by searching the <ulink
-url="https://docs.kde.org/";>KDE Documentation site</ulink> for the requested
-documentation. If you find the documentation on that site, your distribution
-might ship a separate package for documentation (⪚ called plasma-doc for
-documentation related to &plasma;). Please use the package manager of your
-distribution to find and install the missing documentation.</para>
+<para>If the application is &kde; software, first use the search function in
+&khelpcenter;. In some cases, the documentation has a different name than the
+software was using to try to find it. If that doesn't work, try searching the
+<ulink url="https://docs.kde.org/";>KDE Documentation site</ulink> for the
+requested documentation. If you find the documentation on that site, your
+distribution might ship a separate package for documentation (⪚ called
+plasma-doc for documentation related to &plasma;). Please use the package
+manager of your distribution to find and install the missing
+documentation.</para>
<para>If you use a source based distribution, such as Gentoo, be sure that
there are not any configuration settings (USE flags in Gentoo) that
