workspace/plasma/README

   1 PLASMA
   2 ======
   3
   4 This is the application that provides the panels and desktop work area in KDE4.
   5 Much of the functionality that the code here is based on resides in
   6 workspace/libs/plasma/.
   7
   8 For more information, please visit the Plasma website at http://plasma.kde.org.
   9
  10 Directory Structure
  11 ===================
  12
  13 There are a number of subdirectories here. The purpose of each is explained:
  14
  15 design: documentation on various aspects of the plasma and krunner code base
  16
  17 plugins:
  18     animators:     Plugins of type Animator, which provides standard animation
  19                    support to Plasma objects
  20     applets:       Applets considered absolutely core to the desktop
  21     containments:  Standard containment objects that are not meant to be
  22                    used as stand-alone applets
  23     desktoptheme:  A collection of SVG elements for use in Plasma, Applets and
  24                    libplasma
  25     dataengines:   DataEngines considered generally useful for desktop components
  26     runners:       Provides matches to queries
  27     scriptengines: Glue between libplasma and APIs provided via dynamic languages or
  28                    3rd party systems
  29     wallpapers:    Background rendering for containments
  30
  31 shells, applications that provide plasma viewing environments:
  32     desktop: A traditional desktop experience with panels and full screen backgrounds
  33     mid: A simplified shell designed for Mobile Internet Devices (MIDs) featuring full
  34          screen launcher and navigation
  35     plasmoidviewer: A viewer for individual plasma applets
  36     screensaver: A Plasma overlay for screensavers that works in concert with krunner_lock
  37
  38 tools:
  39     engineexplorer: A small graphical utility to examine engines
  40     plasmapkg: Installs, removes and lists plasma packages
  41