Amarok Dokumentation issues

Burkhard Lück lueck at hube-lueck.de
Thu Aug 5 14:44:50 CEST 2010


Hi,

I found some issues with the  Amarok documentation I'd like to sort out:

extragear/multimedia/doc/ has an amarok folder with some outdated docbooks and 
screenshots from 2006 for Amarok 1.4.
There are a lot of links in the web to to these obsolete Amarok documentation 
wich automatically appears on docs.kde.org.
These docbooks are processed daily by the i18n tool chain and even some 
translators touch it, that does not make any sense.

The file amarok.desktop has a X-DocPath amarok/index.html, therefore 
KHelpcenter has an entry Amarok in the navigation tree.
The Help button in Amaroks settings dialog is enabled. 
Launching the Help action displays in KHelpcenter the message "There is no 
documentation available for amarok/index.html", bad user experience :-(

The git repo has a folder handbook with a incomplete documentation from 
September 2009, but this handbook is not included in the build and not 
installed.

On Userbase I found page http://userbase.kde.org/Amarok with a documentation 
for Amarok 2.3.

No Handbook menu item in Amaroks Help menu.

Ways to address these issues:

1) Disable the Help button in the settings dialog, remove X-DocPath entry from 
the desktop file and remove extragear/multimedia/doc/amarok.

or

2) Add the Handbook menu item again and replace the outdated docbboks from 
2006 in the svn repo with the userbase page automatically converted to 
docbook. That happens for the k3b documentation already.
There is no change to your workflow, announce a release as usual on the 
translators mailing list, several doc team members are subscribed there as 
well, so the doc team will then update the svn docbook from the userbase page, 
if necessary.

How to solve these issues?

-- 
Burkhard Lück


More information about the Amarok-devel mailing list