[kde-doc-english] Fwd: Folder share/doc/HTML/lang_code/common/ in the KDE Documenation

[Burkhard Lück]

----------  Weitergeleitete Nachricht  ----------

Betreff: Folder share/doc/HTML/lang_code/common/ in the KDE Documenation
Datum: Donnerstag 30 Juli 2009
Von: Burkhard Lück <lueck at hube-lueck.de>
An: "KDE i18n-doc" <kde-i18n-doc at kde.org>

Hallo,

in kde 1.x(?) / 2.x / 3.x all languages had a folder docs/common in the source 
tree which was installed to share/doc/HTML/lang_code/common/, with the files 
fdl-translated.html, gpl-translated.html, lgpl-translated.html, kde-
localised.css, and logotp3.png.

This folder got lost in most languages during the transition to kde 4.x and 
that is the reason for this bug report about invalid symbolic links in a 
language package:
https://bugs.kde.org/show_bug.cgi?id=198510

1) The files *-translated.html are used in the actual html documentation 
generated at build time.
In the current situation all teams without these files in lang_code/common/ 
have three dead links in the html displayed in khelpcenter or konqueror.
The german language has these files, gpl-translated.html is an inofficial 
translation with a disclaimer about its not official status and a link to the 
english gpl-html.

2) logotp3.png is an obselete localised kde logo and afaik unused.

3) kde-localised.css can be used to overwrite settings in kde-default.css.
This is a feature from the ancient kde times and was disabled long time ago:
http://lists.kde.org/?l=kde-docbook&m=101924172814685&w=2

There were two use cases i found for this feature:
a) In the romanian language all paragraphs should be indented on their first 
line (http://lists.kde.org/?l=kde-docbook&m=107411730902329&w=2)
b) A request from a hebrew translator about rtl support 
(http://lists.kde.org/?l=kde-i18n-doc&m=101923507207310&w=2)

This feature can be enabled again with this patch for 
kdelibs/kdoctools/customization/kde-chunk.xsl:
-<xsl:param name="html.stylesheet" select="concat($kde.common,'kde-
default.css')"/>
+<xsl:param name="html.stylesheet" select="concat($kde.common,'kde-
default.css',' ',$kde.common,'kde-localised.css')"/>

There are these ways to fix this bug:

a) Remove the remaining two comon folders, switch the links in the html files 
to the english licence texts and change the macro kde4_create_handbook 
(english docs with common dir + links, language docs without)

b) Add a common dir with *-translated.html files and an empty kde-localised.css 
to each language and patch kdelibs/kdoctools/customization/kde-chunk.xsl

To decide what to do we should discuss if there are any use cases for b)

-- 
Burkhard Lück

-------------------------------------------------------

-- 
Burkhard Lück