Bug 313906 - No help documentation for the Synaptiks touchpad configuration tool
Summary: No help documentation for the Synaptiks touchpad configuration tool
Status: RESOLVED NOT A BUG
Alias: None
Product: docs.kde.org
Classification: Websites
Component: Missing Content (show other bugs)
Version: unspecified
Platform: openSUSE Linux
: NOR normal
Target Milestone: ---
Assignee: Documentation Editorial Team
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2013-01-25 21:56 UTC by Marc Chamberlin
Modified: 2013-01-26 07:42 UTC (History)
2 users (show)

See Also:
Latest Commit:
Version Fixed In:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Marc Chamberlin 2013-01-25 21:56:07 UTC
Summary says it all. Open Synaptiks touchpad configuration tool, click on help and no documentation is found. Nor is one able to figure out version info or how to report bugs on it. In other words, I have no idea what KDE component this tool belongs to.

Platform Version 4.8.5 (4.8.5) "release 2"
Comment 1 Burkhard Lück 2013-01-25 22:58:25 UTC
Synaptiks leaved KDE more than one year ago, see 
http://lists.kde.org/?l=kde-core-devel&m=132065345631602&w=2

No idea where you got this software from, it is defintively since November 2011 no longer in the KDE repos and processed by the kde i18n tool chain aka scripty.
Comment 2 Marc Chamberlin 2013-01-26 00:36:33 UTC
Burkhard -  I disagree with your assessment that this is an invalid bug. It is NOT. FYI, the Synaptiks touchpad management tool was installed as part of  openSuSE12.2 AUTOMATICALLY in order to handle the configuration of the touchpad on my laptop. This is the latest release of openSuSE, therefore I assume that the KDE version supplied  is also fairly current. So the fact that I have it may be an openSuSE packaging issue but regardless the appearance of the Synaptiks configuration manager makes it appear to be part of KDE. That may be  especially true since it was part of KDE in the recent past. 

Regardless of whether KDE is directly supporting this tool or not, the fact is that when I clicked on the help button of the Synaptiks configuration tool, I was led to the KDE Help subsystem, And there I was told that since there was no documentation for this tool I was to report it as a bug. At the very least, this is misleading and confusing to me and will be to other users. I therefore submit that in addition to that fact that the Synaptiks help documentation is missing, (which I STILL do not understand how to resolve) the KDE help documentation is also wrong, misleading and needs to be improved in order to provide a better guide to users on how to resolve this sort of issue.  For the KDE Help subsystem to default to a message, in the event of missing documentation for an app, and tell the user to report the error is indeed a serious problem and it may further indicate a structural design issue with the KDE Help subsystem that needs to be addressed (with regards to unsupported apps by KDE). I therefore request that you reopen this bug report for further and deeper investigations.

Finally, KDE's efforts should be to guide a user to a solution, whether such guidance is via a help subsystem or a response to a bug report, and not to simply tell them that it is not KDE's problem. Keep in mind that I, as a user, do NOT know the status of KDE's support for applications and ONLY know what this application told me via it's help menu. Furthermore, your link you provide me does not help me to grok the situation either and even seems to be irrelevant.  It seems to be talking about support for translations for the Synaptiks configuration manager, which I don't see as being applicable to the problem I reported.
Comment 3 Yuri Chornoivan 2013-01-26 07:42:43 UTC
(In reply to comment #2)
> Furthermore, your link you
> provide me does not help me to grok the situation either and even seems to
> be irrelevant.  It seems to be talking about support for translations for
> the Synaptiks configuration manager, which I don't see as being applicable
> to the problem I reported.

Just a few points:

1. Synaptiks is no longer in KDE infrastructure (it is clearly stated in the message that was pointed by Burkhard).
2. Synaptiks has its own repository and bug tracking system on github.
3. Synaptiks is unmaintained as Sebastian Wiesner (lunaryorn) decided to leave the project and the new maintainer cease to support it in a few weeks later.
4. Synaptiks was switched by Sebastian to its own documentation system.
5. KDE is downstream for Synaptiks. It is even more relevant to report your bug in openSUSE tracker than in ours. KDE Documentation team cannot neither patch openSUSE packages nor fork Synaptiks.
6. The bug is in Synaptiks itself. Synaptiks still refers to X-DocPath=synaptiks/index.html

Resume and solution:

1. The bug against KDE help system is invalid.
2. I will add merge request to solve the bug on github. But it will not help you (see 3 above).
3. Please report bug to openSUSE with the following patch to synaptiks.desktop attached to solve your problem (at least for openSUSE):

diff --git a/synaptiks.desktop b/synaptiks.desktop
index f65866c..50a32d2 100644
--- a/synaptiks.desktop
+++ b/synaptiks.desktop
@@ -5,7 +5,7 @@ Terminal=false
 Icon=synaptiks
 Categories=Qt;KDE;Utility;HardwareSettings;Settings;
 
-X-DocPath=synaptiks/index.html
+X-DocPath=http://synaptiks.readthedocs.org/en/0.8.1/
 
 X-KDE-StartupNotify=true
 X-DBUS-StartupType=Unique