Re: [jjpp meso ee: wm-spec: _NET_DESKTOP_LAYOUT]

[Matthias Clasen <maclas gmx de>]

On Tue, 2002-12-10 at 18:31, Havoc Pennington wrote:
> ----- Forwarded message from Jaak Pruulmann <jjpp meso ee> -----
> 

> 
> After some google'ing I managed to find the spec and tried to find out
> what the correct behaviour is. It appears that the spec is buggy. It first
> claims that X is rows and Y is columns (section 3.12 in latest version;
> 5th paragraph) and then continues with examples that show exactly the
> opposite. Probably it should be corrected one way or the other. Easiest
> way is perhaps swaping "rows" and "columns" in 5th paragraph, but it might
> be even better to rename parameters x and y to something more intuitive -
> cols and rows or something less abstract like that .. (doublechecked,
> sample layouts use x as columns and y as rows regardless of direction).
> 
> It also means that tehere are some broken pagers/windowmanagers out there
> - either is gnome pager broken or is metacity. 
> 
> [btw, I think that the spec should include section or paragraph about how
> to contribute or where to write and where is the latest version available.
> It took me quite a few minutes to figure out that the mailing list is
> probably the way. but as it was not specified how to act in case like
> this, I do what I like better and write personally to you. :]
> 

Here is a patch adressing these issues. Can this go in ?

Matthias 


Index: wm-spec.sgml
===================================================================
RCS file: /home/freedesktop/wm-spec/wm-spec.sgml,v
retrieving revision 1.27
diff -u -b -B -p -r1.27 wm-spec.sgml
--- wm-spec.sgml	27 Nov 2002 19:23:24 -0000	1.27
+++ wm-spec.sgml	16 Dec 2002 22:17:24 -0000
@@ -1,6 +1,6 @@
 <!doctype article PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
 <!entity version "Draft version 1.3">
-<!entity date "November 27, 2002">
+<!entity date "December 17, 2002">
 ]>
 <article id="index">
 <articleinfo>
@@ -18,7 +18,11 @@
 	<sect2>
 		<title>Version</title>
 		<para>
-This is &version; of the Extended Window Manager Hints (EWMH) spec, updated &date;.
+This is &version; of the Extended Window Manager Hints (EWMH) spec, updated
+&date;. The canonical home for this document is <ulink
+url="http://www.freedesktop.org/standards/wm-spec.html";>http://www.freedesktop.org</ulink>,
+which also contains directions for reporting bugs or contributing to future
+versions.
 		</para>
 	</sect2>
 	<sect2>
@@ -483,7 +487,7 @@ windows.
         <sect2>
         <title>_NET_DESKTOP_LAYOUT</title>
         <programlisting><![CDATA[
-_NET_DESKTOP_LAYOUT, orientation, x, y, starting_corner CARDINAL[4]/32
+_NET_DESKTOP_LAYOUT, orientation, columns, rows, starting_corner CARDINAL[4]/32
 ]]>
   #define _NET_WM_ORIENTATION_HORZ 0
   #define _NET_WM_ORIENTATION_VERT 1
@@ -519,19 +523,20 @@ _NET_DESKTOP_LAYOUT, orientation, x, y, 
   use _NET_WM_TOPLEFT as the starting corner in this case.
   </para>
   <para>
-  The virtual desktops are arranged in a rectangle
-  with X rows and Y columns.  If X times Y does not match the total number of
-  desktops as specified by
+  The virtual desktops are arranged in a rectangle with 
+  <literal>rows</literal> rows and <literal>columns</literal> columns.
+  If <literal>rows</literal> times <literal>columns</literal> does not match 
+  the total number of desktops as specified by
   _NET_NUMBER_OF_DESKTOPS, the highest-numbered
-  workspaces are assumed to be nonexistent. Either X or Y (but not
-  both) may be specified as 0 in which case its actual value will be
-  derived from _NET_NUMBER_OF_DESKTOPS.
+  workspaces are assumed to be nonexistent. Either <literal>rows</literal> or 
+  <literal>columns</literal> (but not both) may be specified as 0 in which 
+  case its actual value will be derived from _NET_NUMBER_OF_DESKTOPS.
         </para>
         <para>
   When the orientation is _NET_WM_ORIENTATION_HORZ
   the desktops are laid out in rows, with the first desktop in the 
-  specified starting corner. So a layout with X=4 and Y=3 starting in 
-  the _NET_WM_TOPLEFT corner looks like this:
+  specified starting corner. So a layout with four columns and three rows 
+  starting in the _NET_WM_TOPLEFT corner looks like this:
 <programlisting>
  +--+--+--+--+
  | 0| 1| 2| 3|
@@ -541,8 +546,7 @@ _NET_DESKTOP_LAYOUT, orientation, x, y, 
  | 8| 9|10|11|
  +--+--+--+--+
 </programlisting>
-With starting_corner _NET_WM_BOTTOMRIGHT, it looks like
-this:
+With starting_corner _NET_WM_BOTTOMRIGHT, it looks like this:
 <programlisting>
  +--+--+--+--+
  |11|10| 9| 8|
@@ -555,9 +559,8 @@ this:
 
          </para>
         <para>
-
   When the orientation is _NET_WM_ORIENTATION_VERT
-  the layout for X=4 and Y=3 starting in the _NET_WM_TOPLEFT
+  the layout with four columns and three rows starting in the _NET_WM_TOPLEFT
   corner looks like:
 
 <programlisting>
@@ -1703,6 +1706,10 @@ to "Window Geometry".
  			<listitem><para>
 Rewrote the implementation notes on "Urgency", making it clear that
 the hint is not just about dialogs.
+ 			</para></listitem>
+ 			<listitem><para>
+Fixed the specification of the X and Y members of _NET_DESKTOP_LAYOUT
+and renamed them to columns and row for clarity.
  			</para></listitem>
 	        </itemizedlist>
             </sect2>