[k3b] K3B Documentation

[Michał Małek]

Burkhard Lück wrote:
> Am Dienstag, 3. August 2010, um 23:33:32 schrieb Michał Małek:
> > Burkhard Lück wrote:
> > > Am Dienstag, 3. August 2010, um 07:49:18 schrieb Michał Małek:
> > > > Agreed, this needs to be removed.
> > > 
> > > Please wait with this step, I want to check if it makes sense to merge
> > > the translations in kde svn into the new docbook exported from
> > > userbase. In case you agree with the solution 2b) kde-i18n-doc will
> > > handle this and you don't need to care about this.
> > 
> > Great, I have no issue with that.
> > 
> > > > I like the second solution. How is it done in practice? Does snapshot
> > > > of online documentation is taken just before a major release?
> > > 
> > > 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.
> > > Of course the doc team would like to export the current page
> > > immediately to give the translation teams the chance to start early
> > > with their work.
> > 
> > Ok.
> > 
> > > > > 2) k3b kcm
> > > > > The KCM has an enabled Help button, but no X-DocPath entry.
> > > > > Launching Help opens KHelpcenter and displays the message "There
> > > > > is no documentation available for /index.html", bad user
> > > > > experience :-( So either the Help button should be disabled or a
> > > > > proper X-DocPath (according to the solution of No 1) should be
> > > > > added.
> > > > 
> > > > Good spot,  I will disable it.
> > > 
> > > Why do you want to disable it?
> > > A better solution would be from my PoV to leave the Help button enabled
> > > and the doc team adds a proper X-DocPath pointing to the section
> > > "Configuring the internals" in the docbook exported from the userbase
> > > page.
> > 
> > You're obviously right.
> 
> The converted k3b documentation was commited with r1160863 and the
> X-DocPath entries in the desktop files are adjusted.
> 
> Thanks.

Thanks!

-- 
Best regards,
Michał