etc/skel/.wmi/szs2.1/module-developer-reference.txt

   1                      Module Developer Reference
   2                      ==========================
   3
   4 CONTRIBUTIONS
   5 =============
   6
   7 Contributions are always welcomed. The main communication happens in the #szs
   8 channel at irc.freenode.org. There is also a mailinglist at szs-devel@wegi.net.
   9 To subscribe send a mail to minimalist@wegi.net with the following Subject:
  10 subscribe szs-devel
  11
  12
  13
  14 SOURCE
  15 ======
  16
  17 We use the darcs (http://www.darcs.net) Version Control System for the
  18 developement of szs. The main repository is at http://darcs.wegi.net/szs
  19 To get the source run 'darcs get http://darcs.wegi.net/szs'. To stay up-to-date
  20 run 'darcs pull'.
  21
  22 If you want to submit patches please run the following 2 commands in the szs
  23 source directory:
  24
  25 $ echo Yourname <youruser@server.com> > _darcs/prefs/author
  26 $ echo szs-darcs@wegi.net > _darcs/prefs/email
  27
  28 Make yourself familiar with darcs, a good manual is at http://darcs.net/manual/
  29 To send us the patch simple run 'darcs send', the patch will be automatically
  30 forwarded to the szs-devel@wegi.net mailinglist.
  31
  32
  33
  34 HOWTO MAKE A MODULE
  35 ===================
  36
  37 A szs module is a simple python script which has a main() function returning a
  38 list. The first item must be a statustext or ''. All other items are bars. Bars
  39 are those colored gauges at the right side of your statusbar. the following
  40 syntax applies to bars:
  41
  42 <value>%<label>
  43
  44 where <value> must be between 0 and 100 and <label> is optional.
  45
  46 szstoolbox.py provides some usefull tools, especially for reading the config
  47 from szs.cfg.
  48
  49 In szs.cfg you can configure your module, The following rules apply:
  50
  51   -- the config key has to start with: <modulname>.
  52   -- if you need to separate values you must use ','
  53   -- if you need a sub separator use ':'
  54   -- if you need more separators you could use anything except ',', '%' and ':'