1 <?xml version="1.0" encoding="UTF-8"?>
3 xml Schema for the openbox windowmanager configuration file
6 Son Aug 10 15:49:10 CEST 2003 - pch(a)myzel.net
7 restrictions added, up to current format
8 Don Aug 14 21:10:27 CEST 2003 - pch(a)myzel.net
9 up to current (from action.c,config.c)
10 Don Aug 21 23:07:30 CEST 2003 - pch(a)myzel.net
12 Mon Sep 1 00:57:55 CEST 2003 - pch(a)myzel.net
14 Mit Sep 3 12:40:10 CEST 2003 - pch(a)myzel.net
15 up to alpha8, a little documentation
16 Mon Sep 8 11:52:07 CEST 2003 - pch(a)myzel.net
18 Mon Sep 15 14:27:42 CEST 2003 - pch(a)myzel.net
20 Die Sep 16 20:56:37 CEST 2003 - pch(a)myzel.net
22 Fri Sep 19 14:36:33 EDT 2003 - xor(a)orodu.net
23 use openbox.org for namespace
24 Mon Sep 22 02:34:53 EDT 2003 - xor(a)orodu.net
25 add the focusLast and raiseOnFocus options
26 fix some capitalization
27 Mon Sep 22 14:08:16 EDT 2003 - xor(a)orodu.net
28 update hideTimeout to hideDelay
29 Thu Apr 22 12:33:11 UTC 2004 - mikachu(a)openbox.org
30 add diffs between 3.1 and 3.2
32 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
33 targetNamespace="http://openbox.org/"
34 xmlns:ob="http://openbox.org/"
35 elementFormDefault="qualified">
39 <xs:element name="openbox_config">
41 <xs:documentation>all these elements are expected in a openbox config file</xs:documentation>
45 <xs:element name="resistance" type="ob:resistance"/>
46 <xs:element name="focus" type="ob:focus"/>
47 <xs:element name="placement" type="ob:placement"/>
48 <xs:element name="theme" type="ob:theme"/>
49 <xs:element name="desktops" type="ob:desktops"/>
50 <xs:element name="resize" type="ob:resize"/>
51 <xs:element name="dock" type="ob:dock"/>
52 <xs:element name="keyboard" type="ob:keyboard"/>
53 <xs:element name="mouse" type="ob:mouse"/>
54 <xs:element name="menu" type="ob:menu"/>
61 <xs:complexType name="resistance">
63 <xs:documentation>defines behaviour of windows when close to eachother or the screen edge</xs:documentation>
66 <xs:element name="strength" type="xs:integer"/>
67 <xs:element name="screen_edge_strength" type="xs:integer"/>
68 <xs:element name="edges_hit_layers_below" type="xs:yesorno"/>
71 <xs:complexType name="focus">
73 <xs:documentation>defines aspects of window focus</xs:documentation>
76 <xs:element name="focusNew" type="ob:yesorno"/>
77 <xs:element name="focusLast" type="ob:yesorno"/>
78 <xs:element name="followMouse" type="ob:yesorno"/>
79 <xs:element name="focusDelay" type="xs:integer"/>
80 <xs:element name="raiseOnFocus" type="ob:yesorno"/>
83 <xs:complexType name="placement">
85 <xs:documentation>defines how new windows are placed</xs:documentation>
88 <xs:element name="policy" type="ob:placementpolicy"/>
91 <xs:complexType name="theme">
93 <xs:element name="name" type="xs:string"/>
94 <xs:element name="titlelayout" type="xs:string"/>
95 <xs:element name="keepBorder" type="ob:yesorno"/>
98 <xs:complexType name="desktops">
100 <xs:element name="number" type="xs:integer"/>
101 <xs:element name="names">
104 <xs:element maxOccurs="unbounded" name="name" type="xs:string"/>
108 <xs:element name="firstdesk" type="xs:integer"/>
111 <xs:complexType name="resize">
113 <xs:element name="drawContents" type="ob:yesorno"/>
114 <xs:element name="popupShow" type="ob:popupshow"/>
115 <xs:element name="popupPosition" type="ob:popupposition"/>
118 <xs:complexType name="dock">
120 <xs:element name="position" type="ob:position"/>
121 <xs:element name="stacking" type="ob:stacking"/>
122 <xs:element name="direction" type="ob:direction"/>
123 <xs:element name="floatingX" type="xs:integer"/>
124 <xs:element name="floatingY" type="xs:integer"/>
125 <xs:element name="autoHide" type="ob:yesorno"/>
126 <xs:element name="hideDelay" type="xs:integer"/>
127 <xs:element name="moveButton" type="ob:button"/>
130 <xs:complexType name="action">
132 <xs:element minOccurs="0" name="menu" type="xs:string"/>
133 <xs:element minOccurs="0" name="desktop" type="xs:integer"/>
134 <xs:element minOccurs="0" name="follow" type="ob:yesorno"/>
135 <xs:element minOccurs="0" name="execute" type="xs:string"/>
136 <xs:element minOccurs="0" name="dialog" type="ob:yesorno"/>
138 <xs:attribute name="name" type="ob:actionname" use="required"/>
140 <xs:complexType name="keybind">
142 <xs:element maxOccurs="unbounded" name="action" type="ob:action"/>
144 <xs:attribute name="key" type="ob:keyname" use="required"/>
146 <xs:complexType name="keyboard">
148 <xs:element name="chainQuitKey" type="ob:keyname"/>
149 <xs:element maxOccurs="unbounded" name="keybind" type="ob:keybind"/>
152 <xs:complexType name="mousebind">
154 <xs:element maxOccurs="unbounded" name="action" type="ob:action"/>
156 <xs:attribute name="action" type="ob:mouseaction" use="required"/>
157 <xs:attribute name="button" type="ob:button" use="required"/>
159 <xs:complexType name="context">
161 <xs:element maxOccurs="unbounded" name="mousebind" type="ob:mousebind"/>
163 <xs:attribute name="name" type="ob:contextname" use="required"/>
165 <xs:complexType name="mouse">
167 <xs:element name="dragThreshold" type="xs:integer"/>
168 <xs:element name="doubleClickTime" type="xs:integer"/>
169 <xs:element maxOccurs="unbounded" name="context" type="ob:context"/>
172 <xs:complexType name="menu">
174 <xs:element maxOccurs="unbounded" name="file" type="xs:string"/>
175 <xs:element name="warpPointer" type="ob:yesorno"/>
176 <xs:element name="xorStyle" type="ob:yesorno"/>
180 simple types / restrictions
182 <xs:simpleType name="yesorno">
183 <xs:restriction base="xs:string">
184 <xs:enumeration value="yes"/>
185 <xs:enumeration value="no"/>
188 <xs:simpleType name="placementpolicy">
189 <xs:restriction base="xs:string">
190 <xs:enumeration value="Smart"/>
191 <xs:enumeration value="UnderMouse"/>
194 <xs:simpleType name="popupshow">
195 <xs:restriction base="xs:string">
196 <xs:enumeration value="Always"/>
197 <xs:enumeration value="Never"/>
198 <xs:enumeration value="Nonpixel"/>
201 <xs:simpleType name="popupposition">
202 <xs:restriction base="xs:string">
203 <xs:enumeration value="Top"/>
204 <xs:enumeration value="Center"/>
207 <xs:simpleType name="position">
208 <xs:restriction base="xs:string">
209 <xs:enumeration value="TopLeft"/>
210 <xs:enumeration value="Top"/>
211 <xs:enumeration value="TopRight"/>
212 <xs:enumeration value="Right"/>
213 <xs:enumeration value="BottomRight"/>
214 <xs:enumeration value="Bottom"/>
215 <xs:enumeration value="BottomLeft"/>
216 <xs:enumeration value="Left"/>
217 <xs:enumeration value="Floating"/>
220 <xs:simpleType name="stacking">
221 <xs:restriction base="xs:string">
222 <xs:enumeration value="Top"/>
223 <xs:enumeration value="Normal"/>
224 <xs:enumeration value="Bottom"/>
227 <xs:simpleType name="direction">
228 <xs:restriction base="xs:string">
229 <xs:enumeration value="Horizontal"/>
230 <xs:enumeration value="Vertical"/>
233 <xs:simpleType name="keyname">
234 <xs:restriction base="xs:string">
235 <xs:pattern value="(A-)?(S-)?(A-)?(C-)?(A-)?(S-)?(A-)?[a-zA-Z0-9]*"/>
238 <xs:simpleType name="contextname">
239 <xs:restriction base="xs:string">
240 <xs:enumeration value="Desktop"/>
241 <xs:enumeration value="Client"/>
242 <xs:enumeration value="Titlebar"/>
243 <xs:enumeration value="Handle"/>
244 <xs:enumeration value="Frame"/>
245 <xs:enumeration value="TLCorner"/>
246 <xs:enumeration value="TRCorner"/>
247 <xs:enumeration value="BLCorner"/>
248 <xs:enumeration value="BRCorner"/>
249 <xs:enumeration value="Maximize"/>
250 <xs:enumeration value="AllDesktops"/>
251 <xs:enumeration value="Shade"/>
252 <xs:enumeration value="Iconify"/>
253 <xs:enumeration value="Icon"/>
254 <xs:enumeration value="Close"/>
255 <xs:enumeration value="MoveResize"/>
258 <xs:simpleType name="button">
259 <xs:restriction base="xs:string">
260 <xs:enumeration value="Left"/>
261 <xs:enumeration value="Middle"/>
262 <xs:enumeration value="Right"/>
263 <xs:enumeration value="Up"/>
264 <xs:enumeration value="Down"/>
265 <xs:enumeration value="A-Left"/>
266 <xs:enumeration value="A-Middle"/>
267 <xs:enumeration value="A-Right"/>
268 <xs:enumeration value="A-Up"/>
269 <xs:enumeration value="A-Down"/>
270 <xs:enumeration value="C-A-Left"/>
271 <xs:enumeration value="C-A-Middle"/>
272 <xs:enumeration value="C-A-Right"/>
273 <xs:enumeration value="C-A-Up"/>
274 <xs:enumeration value="C-A-Down"/>
277 <xs:simpleType name="mouseaction">
278 <xs:restriction base="xs:string">
279 <xs:enumeration value="Click"/>
280 <xs:enumeration value="DoubleClick"/>
281 <xs:enumeration value="Drag"/>
282 <xs:enumeration value="Press"/>
283 <xs:enumeration value="Release"/>
286 <xs:simpleType name="actionname">
287 <xs:restriction base="xs:string">
288 <xs:enumeration value="Activate"/>
289 <xs:enumeration value="Close"/>
290 <xs:enumeration value="Desktop"/>
291 <xs:enumeration value="DesktopDown"/>
292 <xs:enumeration value="DesktopLast"/>
293 <xs:enumeration value="DesktopLeft"/>
294 <xs:enumeration value="DesktopNext"/>
295 <xs:enumeration value="DesktopPrevious"/>
296 <xs:enumeration value="DesktopRight"/>
297 <xs:enumeration value="DesktopUp"/>
298 <xs:enumeration value="DirectionalFocusEast"/>
299 <xs:enumeration value="DirectionalFocusNorth"/>
300 <xs:enumeration value="DirectionalFocusNortheast"/>
301 <xs:enumeration value="DirectionalFocusNorthwest"/>
302 <xs:enumeration value="DirectionalFocusSouth"/>
303 <xs:enumeration value="DirectionalFocusSoutheast"/>
304 <xs:enumeration value="DirectionalFocusSouthwest"/>
305 <xs:enumeration value="DirectionalFocusWest"/>
306 <xs:enumeration value="Execute"/>
307 <xs:enumeration value="Exit"/>
308 <xs:enumeration value="Focus"/>
309 <xs:enumeration value="GrowToEdgeEast"/>
310 <xs:enumeration value="GrowToEdgeNorth"/>
311 <xs:enumeration value="GrowToEdgeSouth"/>
312 <xs:enumeration value="GrowToEdgeWest"/>
313 <xs:enumeration value="Iconify"/>
314 <xs:enumeration value="Kill"/>
315 <xs:enumeration value="Lower"/>
316 <xs:enumeration value="MaximizeFull"/>
317 <xs:enumeration value="MaximizeHorz"/>
318 <xs:enumeration value="MaximizeVert"/>
319 <xs:enumeration value="Move"/>
320 <xs:enumeration value="MoveRelativeHorz"/>
321 <xs:enumeration value="MoveRelativeVert"/>
322 <xs:enumeration value="MoveToEdgeEast"/>
323 <xs:enumeration value="MoveToEdgeNorth"/>
324 <xs:enumeration value="MoveToEdgeSouth"/>
325 <xs:enumeration value="MoveToEdgeWest"/>
326 <xs:enumeration value="NextWindow"/>
327 <xs:enumeration value="NextWindowLinear"/>
328 <xs:enumeration value="PreviousWindow"/>
329 <xs:enumeration value="PreviousWindowLinear"/>
330 <xs:enumeration value="Raise"/>
331 <xs:enumeration value="RaiseLower"/>
332 <xs:enumeration value="Resize"/>
333 <xs:enumeration value="ResizeRelativeHorz"/>
334 <xs:enumeration value="ResizeRelativeVert"/>
335 <xs:enumeration value="Restart"/>
336 <xs:enumeration value="SendToBottomLayer"/>
337 <xs:enumeration value="SendToDesktop"/>
338 <xs:enumeration value="SendToDesktopDown"/>
339 <xs:enumeration value="SendToDesktopLeft"/>
340 <xs:enumeration value="SendToDesktopNext"/>
341 <xs:enumeration value="SendToDesktopPrevious"/>
342 <xs:enumeration value="SendToDesktopRight"/>
343 <xs:enumeration value="SendToDesktopUp"/>
344 <xs:enumeration value="SendToNormalLayer"/>
345 <xs:enumeration value="SendToTopLayer"/>
346 <xs:enumeration value="Shade"/>
347 <xs:enumeration value="ShadeLower"/>
348 <xs:enumeration value="ShowDesktop"/>
349 <xs:enumeration value="ShowMenu"/>
350 <xs:enumeration value="ToggleAlwaysOnBottom"/>
351 <xs:enumeration value="ToggleAlwaysOnTop"/>
352 <xs:enumeration value="ToggleDecorations"/>
353 <xs:enumeration value="ToggleFullscreen"/>
354 <xs:enumeration value="ToggleMaximizeFull"/>
355 <xs:enumeration value="ToggleMaximizeHorz"/>
356 <xs:enumeration value="ToggleMaximizeVert"/>
357 <xs:enumeration value="ToggleOmnipresent"/>
358 <xs:enumeration value="ToggleShade"/>
359 <xs:enumeration value="ToggleShowDesktop"/>
360 <xs:enumeration value="Unfocus"/>
361 <xs:enumeration value="UnmaximizeFull"/>
362 <xs:enumeration value="UnmaximizeHorz"/>
363 <xs:enumeration value="UnmaximizeVert"/>
364 <xs:enumeration value="Unshade"/>
365 <xs:enumeration value="UnshadeRaise"/>
366 <xs:enumeration value="UnShowDesktop"/>