Amarok Dokumentation issues

Burkhard Lück lueck at hube-lueck.de
Mon Aug 9 08:00:56 CEST 2010


Am Freitag, 6. August 2010, um 11:56:52 schrieb Myriam Schweingruber:
> Hi Burkhard,
> 
> On Thu, Aug 5, 2010 at 14:44, Burkhard Lück <lueck at hube-lueck.de> wrote:
> > Hi,
> > 
> > I found some issues with the  Amarok documentation I'd like to sort out:
> > 
> > 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?
> 
> I think the person who can answer the best about the current state of
> the handbook is Valorie, but to me the second solution seems a good
> idea.
> 
Sorry for rushing, but string freeze is tomorrow.
The amarok documentation from userbase is extracted + converted to docbook and 
ready to commit into svn.

This makes of course only sense if the amarok documentation from 
extragear/multimedia/doc in the svn archiv and the translated language 
docbooks will be included in the tarball.

How to proceed?

Thanks.

-- 
Burkhard Lück


More information about the Amarok-devel mailing list