Bug 180606

Summary:	help for kgamma doesn't seem to refer to what one actually sees at all
Product:	[Websites] docs.kde.org	Reporter:	doc.evans
Component:	general	Assignee:	Documentation Editorial Team <kde-doc-english>
Status:	RESOLVED FIXED
Severity:	normal	CC:	lueck, yurchor
Priority:	NOR
Version:	unspecified
Target Milestone:	---
Platform:	Ubuntu
OS:	Linux
Latest Commit:		Version Fixed In:
Sentry Crash Report:

Description doc.evans 2009-01-14 01:41:24 UTC

Version:            (using KDE 4.1.3)
OS:                Linux
Installed from:    Ubuntu Packages

The wizard wouldn't let me enter this under kgamma or kdegraphics (where does one file bug reports against the wizard?), so documentation was the next best thing.

Having installed kgamma 4:4.1.3-0ubuntu1~intrepid1 on a 64-bit Kubuntu 8.10 system, I tried running it from krandrtray (see bug report 315925).

Using it wasn't obvious, so I hit "Help" and got a page that talks about something that bears little resemblance to what kgamma was showing me.

The help page seems to be:
  help:/kcontrol/kcmdisplay/index.html
This help page says that it is "Revision 1.01.00 (2007-07-29)". So I think it's referring to an old (KDE3) program, which is why it seems to make no sense in the context of the current kgamma.

So, basically, it seems that either kgamma needs some help written for it. Or, if that already exists, then it needs to be displayed when you hit "Help".

Comment 1 Yuri Chornoivan 2009-01-14 18:40:35 UTC

You're must be wrong or Kubuntu missing some docs. KDE 4.1.3 in Mandriva has this documentation. Just try the address
help:/kgamma/index.html

Comment 2 doc.evans 2009-01-14 19:50:41 UTC

OK; I'll file it on the Kubuntu bug tracker. Sorry to have bothered you. (It's always a bit of a guess whether the most likely reason for a bug is that it's a KDE bug or a Kubuntu one; sorry I guessed wrong this time.)

Comment 3 Burkhard Lück 2009-01-15 15:59:45 UTC

@ Yuri Chornoivan: its not that easy, I won't expect joe user to enter help:/foo in Konquerors location bar.

@doc.evans@gmail.com: please report the ubuntu bug no

That's the actual situation with these docs (randr/gamma/energy):

kcmshell4 kgamma Help button -> help:/kgamma/index.html

kcmshell4 randr Help button -> There is no documentation available for /index.html.
(reason missing X-DocPath in randr.desktop)

kcmshell4 energy Help button -> help:/kcontrol/energy/index.html

kcmshell4 display
3 tabs "Size & Orientation" (randr) "Monitor Gamma" (kgamma) "Power Control" (energy)
+ probably nvideadisplay, nvidea3d, xinerama, depending on hardware + configuration
for all tabs Help button -> help:/kcontrol/kcmdisplay/index.html

Systemsettings->Computer Administration->Display
3 pages 
"Size & Orientation" (randr) Help button -> nothing happens (missing X-DocPath in randr.desktop)
"Gamma" (kgamma) Help button -> help:/kgamma/index.html
"Power Control" (energy) Help button -> help:/kcontrol/energy/index.html

krandrtray
Help -> Rotate and Resize Handbook -> There is no documentation available for /display-randr/index.html.
reason no krandrtray.Desktop file with X-DocPath, no proper documentation
Configure Display ... opens Systemsettings->Computer Administration->Display (see above)

So there are a lot of problems here (besides outdated documentation) :-(

Comment 4 Burkhard Lück 2015-08-05 14:56:05 UTC

The Help button in the dialog opened with
kcmshell5 kgamma
or
systemsettings5->Hardware->Display and Monitor->Gamma
shows the correct docbook in PLasma 5.4