workspace/kcontrol/kthememanager/README

   1 This theme manager should handle installing, removing
   2 and creating global visual KDE themes. It's written
   3 from scratch, totally unrelated to the old kthememgr
   4 which was not maintained and obsolete.
   5
   6 *** WARNING ***
   7 The XML file format is still subject to change!
   8 *** WARNING ***
   9
  10 (c) 2003, 2004 Lukas Tinkl <lukas@kde.org>
  11
  12
  13 A KDE theme consists of:
  14 ========================
  15 - wallpapers or bg colors
  16 - icons
  17 - sounds
  18 - color scheme
  19 - cursor theme
  20 - window decorations
  21 - screensaver
  22 - name of the widget theme
  23 - themed apps (mainly Konqueror and Kicker)
  24
  25
  26 Sample XML theme config file:
  27 =============================
  28 <ktheme version="1">
  29 <general>
  30     <author value="Me" />
  31     <email value="me@home.com" />
  32     <homepage value="http://me.home.com" />
  33     <version value="0.1" />
  34     <comment value="this is a nice theme, bla bla" />
  35 </general>
  36 <desktop number="0" common="true|false">
  37     <mode id="Flat|Pattern|*Gradient" />
  38     <color1 rgb="#123456" />
  39     <color2 rgb="#123456" />
  40     <blending mode="" balance="" reverse="true|false" />
  41     <pattern name="fish" />
  42     <wallpaper url="theme:/wallpapers/desktop/image.jpg"
  43         mode="Centred|Tiled|CenterTiled|CentredMaxpect|TiledMaxpect|Scaled|CentredAutoFit" />
  44 </desktop>
  45 <icons name="crystalsvg" />
  46 <sounds>
  47     <event object="global|kwin" name="eventname" url="theme:/sounds/file.wav" />
  48     ...
  49 </sounds>
  50 <colors contrast="7">
  51     <alternateBackground rgb="#123456" object="global|kwin"/>
  52     ...
  53 </colors>
  54 <cursors name="theme_name" />
  55 <wm type="builtin|custom" name="kwin_lib_name">
  56     <buttons left="M" right="HIAX" />
  57     <border size="number" />
  58 </wm>
  59 <konqueror>
  60     <wallpaper url="" />
  61     <bgcolor rgb="#123456" />
  62 </konqueror>
  63 <panel>
  64     <background url="theme:/wallpapers/panel.png" colorize="true|false" />
  65     <!-- or -->
  66     <transparent value="true|false" />
  67 </panel>
  68 <widgets name="Style Name" />
  69 <screensaver name="saver.desktop" />
  70 </kdetheme>
  71
  72
  73 Theme storage:
  74 ==============
  75 - a gzipped tarball, directory tree based (e.g. theme.kth)
  76
  77
  78 Sample dir tree:
  79 ================
  80 -- mytheme.kth
  81    - mytheme.xml
  82    - mytheme.preview.png
  83    - sounds/
  84    - wallpapers/
  85      - konqueror/
  86      - desktop/
  87      - panel/
  88
  89
  90 The notion of "url" here:
  91 =========================
  92 - local: points to an already installed file in the system
  93   (must be a sole filename, e.g. "background.png"); this differs
  94   according to the theme part (ie. can be different for sounds
  95   and/or wallpapers)
  96 - theme: relative to the root of the theme tarball or directory
  97   (e.g. theme:/wallpapers/desktop/image.png)
  98 - other URLs are not allowed, the file must be contained
  99   either in the theme or in the target system