Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.

BUG:215923


git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

18 files changed, 324 insertions, 0 deletions

diff --git a/kdoctools/customization/xh/catalog b/kdoctools/customization/xh/catalog
new file mode 100644
index 000000000..600460e44
--- /dev/null
+++ b/kdoctools/customization/xh/catalog
@@ -0,0 +1,38 @@
+PUBLIC "-//KDE//ENTITIES Xhosa Documentation V1.0//XH"
+       "lang.entities"
+PUBLIC "-//KDE//ENTITIES Xhosa Contributors V1.0//XH"
+       "contributor.entities"
+
+PUBLIC "-//KDE//DOCUMENT GNU Free Documentation Notice//XH"
+       "entities/fdl-notice.docbook"
+PUBLIC "-//KDE//DOCUMENT GNU General Public License Notice//XH"
+       "entities/gpl-notice.docbook"
+PUBLIC "-//KDE//DOCUMENT GNU Lesser General Public License Notice//XH"
+       "entities/lgpl-notice.docbook"
+
+PUBLIC "-//GNU//DOCUMENT GNU General Public License V2//XH"
+       "common/gpl-translated"
+PUBLIC "-//GNU//DOCUMENT GNU Lesser General Public License V2.1//XH"
+       "common/lgpl-translated"
+PUBLIC "-//GNU//DOCUMENT GNU Free Documentation License V1.1//XH"
+       "common/fdl-translated"
+PUBLIC "-//KDE//DOCUMENT GPL Licence Declaration//XH"
+       "entities/underGPL.docbook" 
+PUBLIC "-//KDE//DOCUMENT FDL Licence Declaration//XH"
+       "entities/underFDL.docbook"
+PUBLIC "-//KDE//DOCUMENT BSD Licence Declaration//XH"
+       "entities/underBSDLicense.docbook"
+PUBLIC "-//KDE//DOCUMENT Artistic Licence Declaration//XH"
+       "entities/underArtisticLicense.docbook"
+PUBLIC "-//KDE//DOCUMENT X11 Licence Declaration//XH"
+       "entities/underX11License.docbook"
+PUBLIC "-//KDE//DOCUMENT Report Bugs//XH"
+       "entities/report-bugs.docbook"
+PUBLIC "-//KDE//DOCUMENT Updating Documentation//XH"
+       "entities/update-doc.docbook"
+PUBLIC "-//KDE//DOCUMENT Help Menu Documentation//XH"
+       "entities/help-menu.docbook"
+PUBLIC "-//KDE//DOCUMENT Installation General Information//XH"
+       "entities/install-intro.docbook"
+PUBLIC "-//KDE//DOCUMENT Compilation Instructions//XH"
+       "entities/install-compile.docbook"
diff --git a/kdoctools/customization/xh/contributor.entities b/kdoctools/customization/xh/contributor.entities
new file mode 100644
index 000000000..580370f70
--- /dev/null
+++ b/kdoctools/customization/xh/contributor.entities
@@ -0,0 +1,2 @@
+<!-- Contains general entity definitions for the names of the translators.
+     See ../entities/contributor.entities. -->
diff --git a/kdoctools/customization/xh/entities/fdl-notice.docbook b/kdoctools/customization/xh/entities/fdl-notice.docbook
new file mode 100644
index 000000000..7c4402cda
--- /dev/null
+++ b/kdoctools/customization/xh/entities/fdl-notice.docbook
@@ -0,0 +1,53 @@
+<!-- This file can be used to include the notice in documentation 
+     <!DOCTYPE book ... [
+      <!ENTITY % FDLIS "INCLUDE">
+      <!ENTITY FDLISTitles "title 1, title 2, title 3">
+      <!ENTITY % FDLFCT "INCLUDE">
+      <!ENTITY FDLFCTTitles "title 4, title 5, title 6">
+      <!ENTITY % FDLBCT "INCLUDE">
+      <!ENTITY FDLBCTTitles "title 7, title 7b">
+      <!ENTITY % ents "-//KDE//ENTITIES Application-Variable Entities V1.0//EN">
+      %ents;
+      ...
+     ]>
+    ...
+     <bookinfo>
+       <legalnotice>
+         <para>Copyright (C) 20yy  [name of author]</para>
+         &FDLnotice;
+       </legalnotice>
+     </bookinfo>
+    ...
+
+    Alternatively, you can include the text literally.
+
+    Include a copy of the license in the documentation distribution.
+ -->
+<para>Permission is granted to copy, distribute and/or modify this
+document under the terms of the GNU Free Documentation License,
+Version 1.1 or any later version published by the Free Software
+Foundation; with &FDLInvariantSections;, with &FDLFrontCoverText;, and
+with &FDLBackCoverText;.  A copy of the license is included in <xref linkend="gnu-fdl"/>.</para>
+
+<!-- If you have no Invariant Sections, don't add any FDLIS entities.
+     If you have no Front-Cover Texts, don't add any FDLFCT; likewise
+     for Back-Cover Texts (the SGML setup takes care of complying with
+     the GNU requirements).  Adding the entities: if you use any, then
+     add FDL* with value "INCLUDE" and FDL*Titles with a list of
+     titles.  You will get the default GNU template text if you don't
+     specify the FDL*Titles entity after specifying the FDL* entity.
+     This will only have effect when you specify %FDLSlots; _after_
+     the entity definitions.
+
+     If your document contains nontrivial examples of program code, we
+     recommend releasing these examples in parallel under your choice
+     of free software license, such as the GNU General Public License,
+     to permit their use in free software.
+ -->
+<!--
+Local variables:
+mode: sgml
+sgml-general-insert-case: lower
+sgml-parent-document: ("index.docbook" "book" "bookinfo" "legalnotice" "para")
+End:
+-->
diff --git a/kdoctools/customization/xh/entities/gpl-notice.docbook b/kdoctools/customization/xh/entities/gpl-notice.docbook
new file mode 100644
index 000000000..0b093444d
--- /dev/null
+++ b/kdoctools/customization/xh/entities/gpl-notice.docbook
@@ -0,0 +1,32 @@
+<!-- This file can be used to include the notice in documentation 
+     <!DOCTYPE book ... >
+    ...
+     <bookinfo>
+       <legalnotice>
+         <para>Copyright (C) 20yy  [name of author]</para>
+         &GPLnotice;
+       </legalnotice>
+     </bookinfo>
+    ...
+
+    Alternatively, you can include the text literally.
+ -->
+<para>This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation; either version 2 of the
+License, or (at your option) any later version.</para>
+
+<para>This program is distributed in the hope that it will be
+useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.</para>
+
+<para>You should have received a copy of the GNU General Public
+License along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</para>
+<!--
+Local variables:
+mode: sgml
+sgml-general-insert-case: lower
+End:
+-->
diff --git a/kdoctools/customization/xh/entities/help-menu.docbook b/kdoctools/customization/xh/entities/help-menu.docbook
new file mode 100644
index 000000000..309abcde6
--- /dev/null
+++ b/kdoctools/customization/xh/entities/help-menu.docbook
@@ -0,0 +1,58 @@
+<variablelist>
+<varlistentry>
+<term>
+<menuchoice>
+<shortcut>
+<keycombo action="simul"><keycap>F1</keycap></keycombo>
+</shortcut>
+<guimenu>Help</guimenu>
+<guimenuitem>&kappname; Handbook</guimenuitem>
+</menuchoice>
+</term>
+<listitem><para><action>Invokes the KDE Help system</action> starting at the
+&kappname; help pages. (this document).</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><menuchoice>
+<shortcut>
+<keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo>
+</shortcut>
+<guimenu>Help</guimenu>
+<guimenuitem>What's This?</guimenuitem>
+</menuchoice>
+</term>
+<listitem><para><action>Changes the mouse cursor to a combination arrow and
+question mark.</action>  Clicking on items within &kappname; will open a help
+window (if one exists for the particular item) explaining the item's
+function.</para></listitem>
+</varlistentry>
+
+
+<varlistentry>
+<term><menuchoice>
+<guimenu>Help</guimenu>
+<guimenuitem>Report Bug...</guimenuitem>
+</menuchoice></term>
+<listitem><para><action>Opens the Bug report dialog</action> where you can
+report a bug or request a <quote>wishlist</quote> feature.</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><menuchoice>
+<guimenu>Help</guimenu>
+<guimenuitem>About &kappname;</guimenuitem>
+</menuchoice></term>
+<listitem><para><action>This will display version and author
+information.</action></para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><menuchoice>
+<guimenu>Help</guimenu>
+<guimenuitem>About KDE</guimenuitem>
+</menuchoice></term>
+<listitem><para><action>This displays the KDE version and other basic
+information.</action></para></listitem>
+</varlistentry>
+</variablelist>
diff --git a/kdoctools/customization/xh/entities/install-compile.docbook b/kdoctools/customization/xh/entities/install-compile.docbook
new file mode 100644
index 000000000..a2ea62293
--- /dev/null
+++ b/kdoctools/customization/xh/entities/install-compile.docbook
@@ -0,0 +1,11 @@
+<para>In order to compile and install &kappname; on your system, type the
+following in the base directory of the &kappname; distribution:</para>
+
+<screen><prompt>%</prompt> <userinput><command>./configure</command></userinput>
+<prompt>%</prompt> <userinput><command>make</command></userinput>
+<prompt>%</prompt> <userinput><command>make</command> install</userinput>
+</screen>
+
+<para>Since &kappname; uses <command>autoconf</command> and
+<command>automake</command> you should have no trouble compiling it. Should you
+run into problems please report them to the &kde; mailing lists.</para>
diff --git a/kdoctools/customization/xh/entities/install-intro.docbook b/kdoctools/customization/xh/entities/install-intro.docbook
new file mode 100644
index 000000000..3f6f5edb5
--- /dev/null
+++ b/kdoctools/customization/xh/entities/install-intro.docbook
@@ -0,0 +1,6 @@
+<!-- requires that packagename is defined in the documentation prologue
+ -->
+<para>&kappname; is part of the &kde; project &kde-http;.</para>
+
+<para>&kappname; can be found in the &package; package on &kde-ftp;, 
+the main &FTP; site of the &kde; project.</para>
diff --git a/kdoctools/customization/xh/entities/lgpl-notice.docbook b/kdoctools/customization/xh/entities/lgpl-notice.docbook
new file mode 100644
index 000000000..1edf3f609
--- /dev/null
+++ b/kdoctools/customization/xh/entities/lgpl-notice.docbook
@@ -0,0 +1,33 @@
+<!-- This file can be used to include the notice in documentation 
+     <!DOCTYPE book ... >
+    ...
+     <bookinfo>
+       <legalnotice>
+         <para>Copyright (C) 20yy  [name of author]</para>
+         &LGPLnotice;
+       </legalnotice>
+     </bookinfo>
+    ...
+
+    Alternatively, you can include the text literally.
+ -->
+<para>This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public License
+as published by the Free Software Foundation; either version 2 of
+the License, or (at your option) any later version.</para>
+
+<para>This library is distributed in the hope that it will be
+useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.</para>
+
+<para>You should have received a copy of the GNU Lesser General
+Public License along with this library; if not, write to the Free
+Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+02110-1301 USA</para>
+<!--
+Local variables:
+mode: sgml
+sgml-general-insert-case: lower
+End:
+-->
diff --git a/kdoctools/customization/xh/entities/report-bugs.docbook b/kdoctools/customization/xh/entities/report-bugs.docbook
new file mode 100644
index 000000000..c9f2992f2
--- /dev/null
+++ b/kdoctools/customization/xh/entities/report-bugs.docbook
@@ -0,0 +1 @@
+<!-- -->
diff --git a/kdoctools/customization/xh/entities/underArtisticLicense.docbook b/kdoctools/customization/xh/entities/underArtisticLicense.docbook
new file mode 100644
index 000000000..fa022707d
--- /dev/null
+++ b/kdoctools/customization/xh/entities/underArtisticLicense.docbook
@@ -0,0 +1,2 @@
+<para>This program is licensed under the terms of the <ulink
+url="common/artistic-license.html">Artistic License</ulink>.</para>
diff --git a/kdoctools/customization/xh/entities/underBSDLicense.docbook b/kdoctools/customization/xh/entities/underBSDLicense.docbook
new file mode 100644
index 000000000..0dc93f1c4
--- /dev/null
+++ b/kdoctools/customization/xh/entities/underBSDLicense.docbook
@@ -0,0 +1,2 @@
+<para>This program is licensed under the terms of the <ulink
+url="common/bsd-license.html">BSD License</ulink>.</para>
diff --git a/kdoctools/customization/xh/entities/underFDL.docbook b/kdoctools/customization/xh/entities/underFDL.docbook
new file mode 100644
index 000000000..633ce72e6
--- /dev/null
+++ b/kdoctools/customization/xh/entities/underFDL.docbook
@@ -0,0 +1,4 @@
+<para id="gnu-fdl" xreflabel="the section entitled &quot;GNU Free Documentation
+License&quot;">This documentation is licensed under the terms of the <ulink
+url="common/fdl-license.html">GNU Free Documentation
+License</ulink>.</para>
diff --git a/kdoctools/customization/xh/entities/underGPL.docbook b/kdoctools/customization/xh/entities/underGPL.docbook
new file mode 100644
index 000000000..a2074f33d
--- /dev/null
+++ b/kdoctools/customization/xh/entities/underGPL.docbook
@@ -0,0 +1,2 @@
+<para>This program is licensed under the terms of the <ulink
+url="common/gpl-license.html">GNU General Public License</ulink>.</para>
diff --git a/kdoctools/customization/xh/entities/underX11License.docbook b/kdoctools/customization/xh/entities/underX11License.docbook
new file mode 100644
index 000000000..7eb81f09e
--- /dev/null
+++ b/kdoctools/customization/xh/entities/underX11License.docbook
@@ -0,0 +1,2 @@
+<para>This program is licensed under the terms of the <ulink
+url="common/x11-license.html">X11 License</ulink>.</para>
diff --git a/kdoctools/customization/xh/entities/update-doc.docbook b/kdoctools/customization/xh/entities/update-doc.docbook
new file mode 100644
index 000000000..e3d8ec4c1
--- /dev/null
+++ b/kdoctools/customization/xh/entities/update-doc.docbook
@@ -0,0 +1,3 @@
+<para>This document may have been updated since your installation.
+You can find the latest version at <ulink
+url="http://docs.kde.org/current/&package;/&kappname;/">http://docs.kde.org/current/&package;/&kappname;/</ulink>.</para>
diff --git a/kdoctools/customization/xh/lang.entities b/kdoctools/customization/xh/lang.entities
new file mode 100644
index 000000000..7cede7e7b
--- /dev/null
+++ b/kdoctools/customization/xh/lang.entities
@@ -0,0 +1,46 @@
+<!ENTITY language "xh">
+
+<!-- These entities should be translated, should therefore be stored
+     separately. -->
+<!ENTITY % kde.translated
+                            SYSTEM "strings.entities"                >
+%kde.translated;
+
+<!-- The following entities should only use &kappname; in their 
+     text                                                          -->
+
+<!-- Licence links -->
+<!ENTITY underGPL           PUBLIC "-//KDE//DOCUMENT GPL Licence Declaration//XH"
+  "entities/underGPL.docbook"                       ><!-- level: para -->
+<!ENTITY underFDL           PUBLIC "-//KDE//DOCUMENT FDL Licence Declaration//XH"
+  "entities/underFDL.docbook"                       ><!-- level: para -->
+<!ENTITY underBSDLicense    PUBLIC "-//KDE//DOCUMENT BSD Licence Declaration//XH"
+  "entities/underBSDLicense.docbook"                ><!-- level: para -->
+<!ENTITY underArtisticLicense PUBLIC "-//KDE//DOCUMENT Artistic Licence Declaration//XH"
+  "entities/underArtisticLicense.docbook"           ><!-- level: para -->
+<!ENTITY underX11License    PUBLIC "-//KDE//DOCUMENT X11 Licence Declaration//XH"
+  "entities/underX11License.docbook"                ><!-- level: para -->
+
+<!ENTITY reporting.bugs     PUBLIC "-//KDE//DOCUMENT Report Bugs//XH"
+  "entities/report-bugs.docbook"                       ><!-- level: ? -->
+<!ENTITY updating.documentation PUBLIC "-//KDE//DOCUMENT Updating Documentation//XH"
+  "entities/update-doc.docbook"                     ><!-- level: para -->
+<!ENTITY help.menu.documentation PUBLIC "-//KDE//DOCUMENT Help Menu Documentation//XH"
+  "entities/help-menu.docbook"                      ><!-- level: variablelist -->
+<!ENTITY install.intro.documentation PUBLIC "-//KDE//DOCUMENT Installation General Information//XH"
+  "entities/install-intro.docbook"                     ><!-- level: para -->
+<!ENTITY install.compile.documentation PUBLIC "-//KDE//DOCUMENT Compilation Instructions//XH"
+  "entities/install-compile.docbook"                     ><!-- level: para -->
+
+
+<!-- FDL notice -->
+<!ENTITY FDLNotice PUBLIC "-//KDE//DOCUMENT GNU Free Documentation Notice//XH"
+         "entities/fdl-notice.docbook">
+<!-- meant to be included, so no NDATA or CDATA (why?) -->
+
+<!-- These entities may be extended by the authors and translators.
+     They should therefore be stored separately.  Moreover, they MUST
+     come last, to avoid overriding problems. -->
+<!ENTITY % kde.language.specific
+                            SYSTEM "user.entities"                   >
+%kde.language.specific;
diff --git a/kdoctools/customization/xh/strings.entities b/kdoctools/customization/xh/strings.entities
new file mode 100644
index 000000000..d88951813
--- /dev/null
+++ b/kdoctools/customization/xh/strings.entities
@@ -0,0 +1,23 @@
+<!-- These entities should be translated, but NOT CHANGED, NOR EXTENDED.
+     For language-specific extensions, use user.entities.
+     Translate everything between quotes, except names of general 
+     entities (&...;). -->
+
+<!ENTITY kappname "this application">
+<!-- Entities to fill in slots in docbook version of FDL notice.
+     The default values of the parameter entities is IGNORE. -->
+<![%FDLIS;[
+<!ENTITY FDLISTitles "LIST THEIR TITLES"><!-- keep capitals -->
+<!ENTITY FDLInvariantSections "the Invariant Sections being &FDLISTitles;">
+ ]]>
+<!ENTITY FDLInvariantSections "no Invariant Sections">
+<![%FDLFCT;[
+<!ENTITY FDLFCTTitles "LIST"><!-- keep capitals -->
+<!ENTITY FDLFrontCoverText "the Front-Cover Texts being &FDLFCTTitles;">
+ ]]>
+<!ENTITY FDLFrontCoverText "no Front-Cover Texts">
+<![%FDLBCT;[
+<!ENTITY FDLBCTTitles "LIST THEIR TITLES"><!-- keep capitals -->
+<!ENTITY FDLBackCoverText "the Back-Cover Texts being &FDLBCTTitles;">
+ ]]>
+<!ENTITY FDLBackCoverText "no Back-Cover Texts">
diff --git a/kdoctools/customization/xh/user.entities b/kdoctools/customization/xh/user.entities
new file mode 100644
index 000000000..627f7fafb
--- /dev/null
+++ b/kdoctools/customization/xh/user.entities
@@ -0,0 +1,6 @@
+<!-- This file contains entities (only!) to make translating
+     a document easier.  They are necessarily language-specific.
+     In the case of name clashes, entities in this file always lose.
+     Keep the entities simple, but _always_ provide them with full markup.
+     Please keep the entities sorted on the name.
+ -->