[k3b] K3B Documentation

Burkhard Lück lueck at hube-lueck.de
Sat Jul 24 15:50:59 UTC 2010


Hi k3b devels,

(cc'ing the i18n coordinator as scripty + the translators are affected)

there are two issues with the k3b documentation:

1) k3b.desktop has X-DocPath entries to userbase, but there is still a k3b 
documentation in extragear/multimedia/doc/, which is processed by scripty and 
translators. That does not make any sense.

Ways to address this issue:
1a) [re]move the documentation and translations in kde svn.
Cons: no help offline, few translations, X-DocPath entries need to be manually 
synced with translation progress on userbase

2b) Export userbase pages K3b + K3b/Burn_an_Audio_Cd_with_K3b, convert it 
automatically via wiki2docbook, commit to svn and use the local help file as X-
DocPath entry. We (Doc-Team+Translators) do that already e.g. with the Parley 
handbook.
Pros: Offline help uptodate as on userbase, more translations, automatic workflow

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. 

How to solve these issues?

-- 
Burkhard Lück



More information about the k3b mailing list