rev 13704 - in people/sune: . doc doc/kde-policy

Mon Feb 2 00:28:04 UTC 2009

Author: pusling-guest
Date: 2009-02-02 00:28:04 +0000 (Mon, 02 Feb 2009)
New Revision: 13704

Added:
   people/sune/doc/
   people/sune/doc/kde-policy/
   people/sune/doc/kde-policy/apps.tex
   people/sune/doc/kde-policy/kde-policy.tex
   people/sune/doc/kde-policy/non-apps.tex
   people/sune/doc/kde-policy/preface.tex
Log:
policy draft, version 0.0.0.0.0.0.0.0.0.0.0.0.0.1


Added: people/sune/doc/kde-policy/apps.tex
===================================================================

--- people/sune/doc/kde-policy/apps.tex	                        (rev 0)
+++ people/sune/doc/kde-policy/apps.tex	2009-02-02 00:28:04 UTC (rev 13704)
@@ -0,0 +1,25 @@
+\chapter{Applications}
+
+\section{Naming}
+
+All applications should be named as close to upstream project name, and if a version of a application using KDE3 libraries and a version using KDE4 libraries
+is expected to coexist during the release cycle of ``Debian Squeeze'', the name of the application using KDE3 libraries should be versioned.
+
+\section{Description}
+
+All packages should have a clear description that describes what the program do. The prases "... for KDE" or "... for KDE 4" should be avoided, unless
+it is a package that doesn't make sense outside the KDE Desktop itself.
+
+\section{Sections}
+
+Unless the package is strictly for the KDE Desktop and should not be used outside the KDE Desktop, the application should not
+be in section: kde, but in the appropriate section for the scope of the application.
+
+\section{Dependecies}
+
+Applications using the graphic user interface parts KDE Libraries must depend on the kdebase-runtime package, as this package contains
+data that the KDE Libraries expect to be available as well as some commands that KDE Libraries and application using KDE Libraries expects
+to be around and uses unconditionally.
+The shlibs system of the KDE library packages should make sure that this is in place, but if the application for some reason doesn't 
+use the shlibs system, this must still be honoured.
+

Added: people/sune/doc/kde-policy/kde-policy.tex
===================================================================
--- people/sune/doc/kde-policy/kde-policy.tex	                        (rev 0)
+++ people/sune/doc/kde-policy/kde-policy.tex	2009-02-02 00:28:04 UTC (rev 13704)
@@ -0,0 +1,19 @@
+\documentclass{report}
+\title{KDE Policy DRAFT}
+\author{Sune Vuorela}
+	
+\begin{document}
+
+\maketitle
+\tableofcontents
+\chapter{README}
+THIS DOCUMENT IS CURRENTLY A DRAFT AND IS EDITED BY SUNE VUORELA. 
+COMMENTS ARE MORE THAN WELCOME, EITHER BY EMAIL (debian at pusling.com, 
+pkg-kde-talk at lists.alioth.debian.org) OR ON IRC (pusling, 
+\#debian-qt-kde).
+\include{preface}
+\include{apps}
+\include{non-apps}
+
+
+\end{document}

Added: people/sune/doc/kde-policy/non-apps.tex
===================================================================
--- people/sune/doc/kde-policy/non-apps.tex	                        (rev 0)
+++ people/sune/doc/kde-policy/non-apps.tex	2009-02-02 00:28:04 UTC (rev 13704)
@@ -0,0 +1,58 @@
+\chapter{Namings of non-application}
+
+\section{Documentation of legacy}
+
+In general, there is different types of non-application packages.
+In KDE 3 series, there was mostly 
+\begin{itemize}
+\item Icon themes 
+\item Widget styles 
+\item Window decorations 
+\end{itemize}
+And in KDE3 series, these was named ``kde-icon-something'', ``kde-style-something''
+and ``kwin-style-something''. If a source package built both a
+widget style and a window decoration, the package could either build
+two binaries, if a dependency on the KDE window manager was to be
+avoided, or in one package named ``kde-style-something''
+
+\section{Names}
+
+In KDE4 series, there is at least the following types of third party
+non-applications:
+\begin{itemize}
+\item Icon themes
+\item Widget styles
+\item Window decoration
+\item Plasma data engines
+\item Plasma script engines
+\item Plasma applets
+\item KIO slaves
+\end{itemize}
+Icon themes should be named as ``kde-icon-something'' if it is
+a kde icon theme. KDE these days try to follow the freedesktop icon
+specification.%
+\footnote{http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html}
+
+The kde-icon-oxygen package is special though, as it also contains
+all fallback icons for a KDE environment and a few KDE specific icons.
+
+In general, third party icon themes should just be named something-icon-theme,
+as they are usable in several desktop environments.
+
+A KDE widget style should be named ``kde-style-something'', and
+a window decoration for the KDE Window Manager should be named kwin-style-something.
+A binary package should in general not contain both a window decoration
+and a widget style. Examples: kde-style-skulpture, kwin-style-skulpture.
+
+Plasma dataengines should be in a plasma-dataengine-something, just as Plasma applets should be in 
+a package called plasma-applet-something, and Plasma scriptengines should be in a plasma-scriptengine-something
+package. Examples: plasma-applet-weather
+
+Third party KIO slaves should be placed in kio-something packages. Example: kio-ftps.
+
+\section{Descriptions}
+
+The description of the widget styles and the window decoration can contain a "... for KDE" in the description, as these 
+are specific to the group of KDE apps and usage of the KDE window manager.
+KIO-slaves are used for all sorts of applications using KDE libraries and plasma thingies are also in the future to be shared
+by multiple applications, and thus not specific to the KDE Desktop.

Added: people/sune/doc/kde-policy/preface.tex
===================================================================
--- people/sune/doc/kde-policy/preface.tex	                        (rev 0)
+++ people/sune/doc/kde-policy/preface.tex	2009-02-02 00:28:04 UTC (rev 13704)
@@ -0,0 +1,13 @@
+\chapter{Preface}
+
+This document documents how KDE packages should be named, described and packaged. The target audience of 
+this document is mostly maintainers of applications that are not part of the official KDE releases.
+
+Violations of this document does not allow filing of bugs with severity: serious or higher.
+
+None of the sections in this document describes the packaging in the Debian releases Etch, Lenny or earlier releases, 
+which all was shipped with a KDE Desktop with a major version lesser than 4. 
+This document applies to KDE packaging targetted the Debian release Squeeze, but is expected to last at least as long as 
+debian ships a KDE4 KDE Desktop.
+
+The packages that are part of the official KDE releases does not yet fully adhere to this policy document, but is converging towards it.


