[kde-doc-english] docs.kde.org issues

[T.C. Hollingsworth]

Hi Burkhard!

On Tue, Jan 10, 2012 at 3:21 AM, Burkhard Lück <lueck at hube-lueck.de> wrote:
> Hi,
>
> some issues with docs.kde.org:
>
> 1) Broken links to common folder with e.g. number png's
> Local Installation
> en/common with untranslated license html files, css + png files etc
> en/app/common symlink to en/common
> lang/common -> with translated license html files
> lang/app/common -> symlink to lang/common
> d.k.o has an additional module folder
> module/en/common (content like local installation)
> module/en/app -> no common subdir
> module/lang/common dir with translated license html files
> module/lang/app/ -> no common subdir
> Possible solution:
> add common folder (symlink to en/common) to each lang/module/app folder
> www/areas/docs/generator creates already symlinks to en screenshots for lang
> folders without localized screenshots.
>
> 2) dead license links (https://bugs.kde.org/show_bug.cgi?id=109143)
> Solution of issue 1) would solve that, you get the english licenses, but not
> the translated
>
> 2) In KHelpcenter the english documentation will be displayed in case there is
> no translated documentation
> To get the same behaviour we need to add a symlink (to en/app) to each empty
> lang/app folder
>
> 3) Links to other docbooks launch Konqueror with lokal Dokumentation
> Html files have e.g. href="help:appname"
> Possible solution:
> replace 'href="help:appname"' via sed with proposal from
> https://bugs.kde.org/show_bug.cgi?id=279900:
> 'href="http://docs.kde.org/?language=<language>&application=<appname>"

I have attached a patch to trunk/www/areas/docs that does this, with
two additions.  The first is adding the branch parameter (which
already exists in the PHP code), so links go to the same branch that
the doc being viewed is on.

The second, more major addition, adds a "path=" paramater to the PHP
code so e.g. help:/kate/part.html goes to
d.k.o/?language=en&branch=stable&application=kate&path=part.html goes
to d.k.o/stable/kde-baseapps/kate/part.html.  Otherwise visitors would
always be dropped on the table of contents.

The sed expression has been extensively tested, but I can't really
test the rest.

> 4) Use app names + kcm names like in systemsettings, not installation/git dir
> names
> (https://bugs.kde.org/show_bug.cgi?id=227923 about using "kcontrol" on d.k.o)
> While this is for apps like Kate or the module names in the navigation panel
> only a minor issue, it is important for the kcontrol/systemsettings modules.
> For historical reasons some of these kcm docs have realy crazy names, which
> makes it nearly impossible for Joe User to find what he is looking for.
> E. g. kwintabbox -> "Task Switcher" or kcmsmserver-> "Session Management"  or
> kded->"Service Manager". I'd like to display the names you see in
> Systemsettings here.
> Afaik this should be doable via an php array?

IMHO it would also be nice if we could rearrange the navigation to be
more like the categories in the K menu.  "Joe User" probably doesn't
know whether their favorite app is in extragear or not.

So the array would look like:
$apps = array(
    "Multimedia" => array(
        "Dragon Player" => "kdemultimedia/dragonplayer",
        "K3B" => "extragear-multimedia/k3b",
        "System Settings" => array(
            "CDDB Retrieval" => "kdemultimedia/kcontrol/cddbretrieval"
        )
        "KIOSlaves" => array(
            "Audio CD" => "kdemultimedia/kioslave/audiocd"
    )
)

I'd be happy to come up with a patch for either this, or just the
names if that's too much, if interested.

> Thanks.

-T.C.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: dko-help-url-fix.patch
Type: text/x-patch
Size: 1413 bytes
Desc: not available
URL: <http://mail.kde.org/pipermail/kde-doc-english/attachments/20120114/524d532d/attachment.patch>