[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    KDE/kdebase/workspace/plasma
From:       Aaron J. Seigo <aseigo () kde ! org>
Date:       2010-07-26 21:19:23
Message-ID: 20100726211923.DBA62AC73E () svn ! kde ! org
[Download RAW message or body]

SVN commit 1155080 by aseigo:

actually update this thing properly


 M  +48 -26    README  


--- trunk/KDE/kdebase/workspace/plasma/README #1155079:1155080
@@ -1,41 +1,63 @@
 PLASMA
 ======
 
-This is the application that provides the panels and desktop work area in KDE4.
-Much of the functionality that the code here is based on resides in
-workspace/libs/plasma/.
+The applications and plugins that provide the panels/desktop/dashboard parts of
+the primary user interface for the KDE Plasma workspaces (Plasma Desktop, Netbook, etc).
+Much of the functionality is provided by libplasma, which is found in kdelibs/plasma/.
 
 For more information, please visit the Plasma website at http://plasma.kde.org.
 
 Directory Structure
 ===================
 
-There are a number of subdirectories here. The purpose of each is explained:
+Each top level directory denotes which workspace (desktop, netbook, screensaver, etc.)
+the components within it apply to. There is a directory named "generic" for components
+that do not apply to a specific workspace.
 
-design: documentation on various aspects of the plasma and krunner code base
+Within each of these top level directories, the following hierarchy exists:
 
-plugins:
-    animators:     Plugins of type Animator, which provides standard animation
-                   support to Plasma objects
-    applets:       Applets considered absolutely core to the desktop
-    containments:  Standard containment objects that are not meant to be
-                   used as stand-alone applets
-    desktoptheme:  A collection of SVG elements for use in Plasma, Applets and
-                   libplasma
-    dataengines:   DataEngines considered generally useful for desktop components
-    runners:       Provides matches to queries
+               applets: Applets (aka "plasmoids" or "widgets") that are considered central
+                        to the workspace in question
+
+          containments: Standard containment objects that provide management for the
+                        Plasma contents shown on panels, desktops, screensavers, etc.
+
+           dataengines: DataEngines considered generally useful; more specific/niche
+                        DataEngines can be found in kdeplasma-addons or extragear/plasma/
+
+               runners: Provides matches to queries; used by KRunner, Kickoff, others
+
+              shell(s): The application(s) that provide the Plasma viewing environment
+                        for a given workspace / formfactor. They also provide
+                        implementations of dialog placement, screen geometry, remote
+                        widget notifications, access request UI, containment
+                        management UI, etc. Essentially all the framework pieces needed
+                        to provide appropriate rendering of an environment for a given
+                        form factor or target device.
+
+    containmentactions: Plugins that provide actions for context menus and other input
+                        triggered action sets
+
+
+In addition to the above, the generic directory also contains:
+
+            wallpapers: Background rendering plugins for containments
     scriptengines: Glue between libplasma and APIs provided via dynamic languages or
-                   3rd party systems
-    wallpapers:    Background rendering for containments
+                        3rd party systems; note that the Javascript scriptengines
+                 tools: useful applications for working with Plasma apps, including:
+                            * engineexplorer: a graphical utility to examine engines
+                            * wallpaperviewer: a tool to view Plasma wallpaper plugins
+                            * plasmoidviewer: a viewer for individual Plasma applets,
+                              particularly useful for edevel and debugging
 
-shells, applications that provide plasma viewing environments:
-    desktop: A traditional desktop experience with panels and full screen backgrounds
-    mid: A simplified shell designed for Mobile Internet Devices (MIDs) featuring full
-         screen launcher and navigation
-    plasmoidviewer: A viewer for individual plasma applets
-    screensaver: A Plasma overlay for screensavers that works in concert with krunner_lock
+KDE Base Runtime
+================
+A number of important components live in the kdebase-runtime package in the plasma/
+directory, including:
 
-tools:
-    engineexplorer: A small graphical utility to examine engines
-    plasmapkg: Installs, removes and lists plasma packages
+* The javascript ScriptEngines for Plasmoids, DataEngines and Runners
+* plasmapkg: Installs, removes and lists plasma packages
+* remotewidgetshelper: a small help tool for Plasma applets that are remoted over
+  the network
 
+The default SVG themes also exist in kdebase-runtime under desktopthemes/
[prev in list] [next in list] [prev in thread] [next in thread]