From kde-doc-english Fri Oct 23 09:31:23 2009 From: Anne Wilson Date: Fri, 23 Oct 2009 09:31:23 +0000 To: kde-doc-english Subject: Re: [kde-doc-english] KDE documentation team Message-Id: <200910231031.24166.cannewilson () googlemail ! com> X-MARC-Message: https://marc.info/?l=kde-doc-english&m=125629034712798 MIME-Version: 1 Content-Type: multipart/mixed; boundary="--===============1884328661==" --===============1884328661== Content-Type: multipart/signed; boundary="nextPart3283185.Q3XCqaMBpz"; protocol="application/pgp-signature"; micalg=pgp-sha1 Content-Transfer-Encoding: 7bit --nextPart3283185.Q3XCqaMBpz Content-Type: Text/Plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable On Thursday 22 October 2009 21:22:28 Burkhard L=FCck wrote: > 1) Status of documentation in kde svn > branch 330 docs, ~ 100 updated in 2008/9 =3D KDE 4.x > kdeadmin (kpackage, ksystemlog) > kdebase (dolphin, kdepasswd, konsole, kwrite, ~20 kcms, plasma, > systemsettings) > kdeedu (blinken, kalgebra, kalzium, kanagram, kbruch, kgeography, > klettres, kmplot, ktouch, kturtle, kwordquiz, marble) > kdegames all docs > kdegraphics (kruler, okular) > kdepim 6 docs > kdesdk 6 docs > kdeutils 7 docs > lot of technical docs (manpages, ioslave info etc) >=20 > Outdated: > kdeaccesibilitiy, kdebase (userguide etc), kdegraphics, kdemultimedia, > kdenetwork, kdepim, kdewebdev > plasma has only a handbook from 2008, no docs for kdeplasma-addons and > no way to access the khc docs >=20 > trunk has around 442 docs, ~ 150 updated in 2008/9 >=20 > Until kde 3.4 the documentation was always slightly outdated (e.g. kde > 3.4 with docs 3.3) due to the release schedule (string freeze policy) > Formally this freeze rules are still valid, but since 3.5.? in practice = we > backport every 4 weeks >=20 > exclude outdated language docbooks from a release (older than x.y versi= on > then the current code)? An essentials limit similar to > http://l10n.kde.org/stats/gui/trunk- kde4/essential/ for gui >=20 > 2) Changes to the documentation >=20 > - target of docs: user with distro packages, not users building from sour= ce > -> remove install.intro.documentation + install.compile.documentation > and the like > users building from source get their information via techbase >=20 > - current doc system: pull centralisized infos via entities into all > docbooks every docbook has a settings + help menu, that is boring >=20 > - lot of duplicated infos (e.g. about common tasks like file open dialog, > shortcut + toolbar settings etc) >=20 > - This is the start of a discussion about reusing text blocks and snippets > in the documentation + translation > http://lists.kde.org/?l=3Dkde-doc-english&m=3D123456838425128&w=3D2 > and it ended in this mail by Chusslove Illic > http://lists.kde.org/?l=3Dkde-i18n-doc&m=3D123461844907311&w=3D2 > Maybe a way to go? >=20 > 3) Khelpcenter >=20 > * in case there is no documentation khc currently shows an error messages > "There is no documentation available for foo/index.html" + an additional > dialog you have to close. > Replace this with a html page containing: > - a link to docs.kde.org > - a link to userbase.kde.org > - a link to forum.kde.org > - a link to user mailing lists > - load missing documentation? (http://apachelog.blogspot.com/2009/10/kd= e- > distro-package-splitting-100-fail.html) >=20 > * cleanup the navigation tree > - rm "Control Center Modules" see now outdated mail > http://lists.kde.org/?l=3Dkde-doc-english&m=3D122303347319776&w=3D2 > - better names of top items? > - do we really need all these top level entries like "KInfoCenter Modules" > / "KIOSlaves" / "The KDE FAQ" / "Contact Information" etc > - a mix of single docbooks and top level items, unsorted > - separate kde information + docs from scrollceeper/Unix man pages/Browse > Info pages >=20 > * no activ assignee for khc bugs >=20 > * search htdig -> desktop search >=20 > * make it possible to switch from language to english documentation, if > that is more up to date >=20 > * toolbar with actions for docs.kde.org, userbase.kde.org, forum.kde.org, > user mailing lists, > switch to local installed english docs (if more up to date) ? >=20 > * keywords in docbooks -> unused >=20 > 4) docbook - userbase - forum >=20 > - different workflows and capabilities (easy to contribute, power of > scripting via pology and other scripts...) >=20 > - we need a bridge between userbase and docbook in svn > e.g. export english text from wiki to docbook -> translation + generati= on > of language docbooks -> import them to wiki >=20 > We really should have a meeting to learn more about the different > workflows, needs, possibility of cooperation and... >=20 > Attendees: > Anne, Anne-Marie, Cornelius?, me, Coles?, Yuri?, a translator from a small > translation team, and everybody else interested in documentation >=20 > Where and when? >=20 My blog of yesterday, http://lydgate.org/blogs/?p=3D66, is setting out my=20 thoughts on these subjects, as I have spoken to both Burkhard and Albert=20 Astals Cid regarding them. The forum team are allowing me to have access t= o a=20 sandbox on their server - it is being set up this morning - so that we can= =20 test out the extensions suggested. I hope this helps. Anne =2D-=20 New to KDE4? - get help from http://userbase.kde.org Just found a cool new feature? Add it to UserBase --nextPart3283185.Q3XCqaMBpz Content-Type: application/pgp-signature; name=signature.asc Content-Description: This is a digitally signed message part. -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.12 (GNU/Linux) iEYEABECAAYFAkrhd+wACgkQbMErw/n0TZrcGgCeIYNMZMchOPjruh5eNmTarQHn CGsAnjYtEIsTYt5JQlDFUd/A/9lTxZou =as7Q -----END PGP SIGNATURE----- --nextPart3283185.Q3XCqaMBpz-- --===============1884328661== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ kde-doc-english mailing list kde-doc-english@kde.org https://mail.kde.org/mailman/listinfo/kde-doc-english --===============1884328661==--