configuration.md
ASCII text
Configuring the Panorama panel
The panel loads all its configuration from a file
~/.config/panorama-panel/config.yaml. The format has a single top-level key
panels which is a list of the panels to generate. Each panel has the following
keys:
position:top,right,bottomorleft; specifies the edge of the monitor to show the panel onmonitor: the index of the monitor to show the panel on (usually refers to the order in which the monitors are plugged in)size: the thickness of the panel in pixelsautohide: whether the panel automatically hides leaving only 1pxhide_time: the duration in ms of the sliding animation (not applicable ifautohideisfalse)applets: a dictionary with keysleft,centre,right; they are actually named wrong and are start/centre/end areas, each key has a list of applets, each applet is described by a dictionary with a single key being the class name and the value being a dictionary with configuration options (the options depend on the applet)
Example:
panels:
- position: top
monitor: 0
size: 40
autohide: false
hide_time: 300
applets:
left:
- WFWindowList: {}
centre: []
right:
- ClockApplet:
formatting: '%T, %a %-d %b %Y'
The order the panels are specified in decides how they occupy the screen, thus, if you specify panel 1 on top, panel 2 on left, and panel 3 on bottom it will look like:
=========================== =111111111111111111111111111= =22 = =22 = =22 = =22 = =22 = =22 = =223333333333333333333333333= ===========================
1
Configuring the Panorama panel
2
------------------------------
3
4
The panel loads all its configuration from a file
5
`~/.config/panorama-panel/config.yaml`. The format has a single top-level key
6
`panels` which is a list of the panels to generate. Each panel has the following
7
keys:
8
9
* `position`: `top`, `right`, `bottom` or `left`; specifies the edge of the
10
monitor to show the panel on
11
* `monitor`: the index of the monitor to show the panel on (usually refers
12
to the order in which the monitors are plugged in)
13
* `size`: the thickness of the panel in pixels
14
* `autohide`: whether the panel automatically hides leaving only 1px
15
* `hide_time`: the duration in ms of the sliding animation (not applicable
16
if `autohide` is `false`)
17
* `applets`: a dictionary with keys `left`, `centre`, `right`; they are actually
18
named wrong and are start/centre/end areas, each key has a list of applets,
19
each applet is described by a dictionary with a single key being the class
20
name and the value being a dictionary with configuration options (the options
21
depend on the applet)
22
23
Example:
24
25
~~~yaml
26
panels:
27
- position: top
28
monitor: 0
29
size: 40
30
autohide: false
31
hide_time: 300
32
applets:
33
left:
34
- WFWindowList: {}
35
centre: []
36
right:
37
- ClockApplet:
38
formatting: '%T, %a %-d %b %Y'
39
~~~
40
41
The order the panels are specified in decides how they occupy the screen, thus,
42
if you specify panel 1 on top, panel 2 on left, and panel 3 on bottom it will
43
look like:
44
45
~~~
46
===========================
47
=111111111111111111111111111=
48
=22 =
49
=22 =
50
=22 =
51
=22 =
52
=22 =
53
=22 =
54
=223333333333333333333333333=
55
===========================
56
~~~
57