Bug 109143

Summary:	broken link to licenses (meinproc docbook "&under*;" tags)
Product:	[Websites] docs.kde.org	Reporter:	Tobi Vollebregt <tobivollebregt>
Component:	docs.kde.org	Assignee:	Rainer Endres <endres>
Status:	RESOLVED FIXED
Severity:	normal	CC:	lueck, luigi.toscano, tchollingsworth
Priority:	NOR
Version:	unspecified
Target Milestone:	---
Platform:	unspecified
OS:	Linux
Latest Commit:		Version Fixed In:
Sentry Crash Report:

Description Tobi Vollebregt 2005-07-15 22:14:33 UTC

Version: (using KDE KDE 3.4.1)
Installed from: Unlisted Binary Package
OS: Linux

It appears that throughout KDE (including the docs.kde.org website!) links to GPL, FDL and any other licenses are broken.

This seems to have to do with the fact that meinproc converts e.g. &underGPL;
to a help:/appname/common/gpl-license.html URL, but the actual file is at
help:/common/gpl-license.html (try by typing both URLs for any KDE application in konqueror, some seem to workaround it, for most apps [kdevelop, kdiff3, kdm tested] the first URL doesn't work, the second does).

It's also reproducable by just browsing the help in the help center. Just find licensing, pages: more than 50% of them has broken links to GPL, FDL or other licenses. I presume the other 50% has a workaround for the problem (installing their own license files, or symlinks, etc.)

A related problem occurs on the docs.kde.org. Go to docs.kde.org, choose any application with a handbook (again, kdevelop, kdiff3, kdm tested), click "Licensing" or "Credits and License". The page visible probably shows the sentence "This documentation is licensed under the terms of the GNU Free Documentation License." (or any other license). It contains a link to the respective license, which is always a broken link.

For the help system, the problem would be solved if meinproc actually generated help:/common/*-license.html hyperlinks for "&under*;" tags.

I don't have a solution for the website. The license files seem to be entirely missing, or at least I can't find them.

Comment 1 Lauri Watts 2005-08-15 13:58:19 UTC

This appears to be an environmental issue, or possibly packaging.  All doc subdirectories (should, in a normal KDE install) have a symlink to the common ../common directory, and all the documents you cite above work correctly on a default installation.

You don't say which distribution your using - could you please?  I have a suspicion about the cause and if I'm right it is specific to one distribution and those derived from it.

As for the website, we're working on that one, so I'll leave this open for a while.

Comment 2 Tobi Vollebregt 2005-08-15 14:05:59 UTC

I'm using Kubuntu (debian based).

Comment 3 Lauri Watts 2005-08-16 15:47:11 UTC

Can you please look in a doc directory and see if there is a symlink to ../common, and if in fact the common directory is there?

Comment 4 Tobi Vollebregt 2005-08-16 19:47:39 UTC

I checked. I get the impression 99% of the issue has been solved in
the KDE 3.4.2 packages. (I reported the error while using KDE 3.4.1
packages)

I find 6 subdirectories of /usr/share/doc/kde/HTML/en that do not
contain a common->../common symlink on my system:
2 are from boson, a game.
1 is from kdevdoctreeview, which doesn't have the
index.docbook+index.cache.bz2+common structure, so I don't know if
it's a bug here. I suppose not.
2 are packages using the bksys build system (kio-locate, kdissert).
I'll report this as an error to the author of bksys.

Remaining:
kio_audiocd, has only index.docbook, no common link and no index.cache.bz2

So, besides kio_audiocd and the website, I think this bug can be closed.
I'll leave it open for the website, as suggested.

Comment 5 Lauri Watts 2005-08-17 17:36:55 UTC

kio_audiocd should be installed under kioslave/audiocd.docbook, the kio_audiocd/* directory is no longer in SVN for 3.5, so that's resolved.

Comment 6 Philip Rodrigues 2005-12-19 18:17:44 UTC

Changing component to note that the problem only occurs on the website

Comment 7 Rainer Endres 2006-02-04 11:38:42 UTC

Thanks for reporting this. I will have a look how to best solve this on the webpage, today.

I suppose I will simply set the symlinks to common/.

Comment 8 Marek Laane 2007-08-01 23:38:17 UTC

There seems to be still no kioslave/audiocd on the docs.kde.org...

Comment 9 Marek Laane 2007-09-02 00:19:11 UTC

Any reaction?

Comment 10 Burkhard Lück 2009-09-03 09:22:08 UTC

(In reply to comment #8)
> There seems to be still no kioslave/audiocd on the docs.kde.org...

Yes there is one:
http://docs.kde.org/stable/en/kdemultimedia/kioslave/audiocd/index.html

Comment 11 Luigi Toscano 2015-05-13 21:51:12 UTC

I think this was fixed long ago (at the time of Burkhard's comment, #c10). The links to common were added for a long time by the generator script. Anyway, the new kdedocgen.py script (which replaced the previous "generator" script) ensures too that the links are correctly created and links like help:/common are correctly replaced with the pointer to the symbolic link to common (for kdelibs4 applications) or to the common kdoctools5-common directory (for KF5 applications). A better solution would be letting the XSLT take care of this replacement, but it's not an high priority item right now.
For all the people still reading this: sorry if it took so long, but as I wrote it was most likely fixed already for a while.