[Emacs-diffs] emacs-24 r117562: Doc tweaks

[Glenn Morris]

------------------------------------------------------------
revno: 117562
revision-id: address@hidden
parent: address@hidden
committer: Glenn Morris <address@hidden>
branch nick: emacs-24
timestamp: Wed 2014-10-08 20:47:30 -0400
message:
  Doc tweaks
  
  * doc/lispref/frames.texi (Multiple Terminals): Copyedits.
  
  * lisp/frame.el (display-monitor-attributes-list): Doc tweaks.
  
  * nt/README.W32, src/ChangeLog.10, src/w32term.c:
  Standardize on "taskbar" rather than "task bar", since that is what
  most references seem to use; e.g.
  http://en.wikipedia.org/wiki/Taskbar
  http://windows.microsoft.com/en-us/windows7/products/features/windows-taskbar
modified:
  doc/lispref/ChangeLog          changelog-20091113204419-o5vbwnq5f7feedwu-6155
  doc/lispref/frames.texi        
frames.texi-20091113204419-o5vbwnq5f7feedwu-6180
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/frame.el                  frame.el-20091113204419-o5vbwnq5f7feedwu-275
  nt/README.W32                  readme.w32-20091113204419-o5vbwnq5f7feedwu-2212
  src/ChangeLog.10               
changelog.10-20091113204419-o5vbwnq5f7feedwu-7288
  src/w32term.c                  w32term.c-20091113204419-o5vbwnq5f7feedwu-950

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2014-10-08 10:16:45 +0000
+++ b/doc/lispref/ChangeLog     2014-10-09 00:47:30 +0000
@@ -1,3 +1,7 @@
+2014-10-09  Glenn Morris  <address@hidden>
+
+       * frames.texi (Multiple Terminals): Copyedits.
+
 2014-10-08  Eli Zaretskii  <address@hidden>
 
        * frames.texi (Multiple Terminals): Improve the description of X

=== modified file 'doc/lispref/frames.texi'
--- a/doc/lispref/frames.texi   2014-10-08 11:17:13 +0000
+++ b/doc/lispref/frames.texi   2014-10-09 00:47:30 +0000
@@ -356,12 +356,14 @@
 coordinates might be negative.
 
 @item workarea
-Position of the top-left corner and size of the work area in pixels as
address@hidden(@var{x} @var{y} @var{width} @var{height})}.  This is different
-from @samp{geometry} in that the various system windows, such as the
-task bar and side bar, are excluded from the work area.  Note that, if
-the monitor is not the primary monitor, some of the coordinates might
-be negative.
+Position of the top-left corner and size of the work area (``usable''
+space) in pixels as @samp{(@var{x} @var{y} @var{width} @var{height})}.
+This may be different from @samp{geometry} in that space occupied by
+various window manager features (docks, taskbars, etc.) may be
+excluded from the work area.  Whether or not such features actually
+subtract from the work area depends on the platform and environment.
+Again, if the monitor is not the primary monitor, some of the
+coordinates might be negative.
 
 @item mm-size
 Width and height in millimeters as @samp{(@var{width} @var{height})}
@@ -371,10 +373,14 @@
 
 @item name
 Name of the physical monitor as @var{string}.
+
address@hidden source
+Source of the multi-monitor information as @var{string};
+e.g., @samp{XRandr} or @samp{Xinerama}.
 @end table
 
 @var{x}, @var{y}, @var{width}, and @var{height} are integers.
address@hidden may not be present.
address@hidden and @samp{source} may be absent.
 
 A frame is @dfn{dominated} by a physical monitor when either the
 largest area of the frame resides in that monitor, or (if the frame
@@ -389,14 +395,14 @@
 @smalllisp
   (display-monitor-attributes-list)
   @result{}
-  (((geometry 0 0 1920 1080)   ;; Left hand monitor
-    (workarea 0 0 1920 1050)   ;; Bottom of screen used for task bar
+  (((geometry 0 0 1920 1080) ;; @r{Left-hand, primary monitor}
+    (workarea 0 0 1920 1050) ;; @r{A taskbar occupies some of the height}
     (mm-size 677 381)
     (name . "\\\\.\\DISPLAY1")
     (frames #<frame emacs@@host *foo* 0000000005BBDC48>
             #<frame emacs@@host *scratch* 000000008179D370>))
-   ((geometry 1920 0 1680 1050) ;; Right hand monitor
-    (workarea 1920 0 1680 1050) ;; Whole screen can be used
+   ((geometry 1920 0 1680 1050) ;; @r{Right-hand monitor}
+    (workarea 1920 0 1680 1050) ;; @r{Whole screen can be used}
     (mm-size 593 370)
     (name . "\\\\.\\DISPLAY2")
     (frames)))

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-10-08 10:16:45 +0000
+++ b/lisp/ChangeLog    2014-10-09 00:47:30 +0000
@@ -1,3 +1,7 @@
+2014-10-09  Glenn Morris  <address@hidden>
+
+       * frame.el (display-monitor-attributes-list): Doc tweaks.
+
 2014-10-08  Eli Zaretskii  <address@hidden>
 
        * faces.el (display-grayscale-p): Mention in the doc string that

=== modified file 'lisp/frame.el'
--- a/lisp/frame.el     2014-10-08 19:37:37 +0000
+++ b/lisp/frame.el     2014-10-09 00:47:30 +0000
@@ -1587,16 +1587,25 @@
 
  geometry -- Position and size in pixels in the form of (X Y WIDTH HEIGHT)
  workarea -- Position and size of the work area in pixels in the
-            form of (X Y WIDTH HEIGHT); this excludes task bar etc.
+            form of (X Y WIDTH HEIGHT)
  mm-size  -- Width and height in millimeters in the form of
             (WIDTH HEIGHT)
  frames   -- List of frames dominated by the physical monitor
  name (*) -- Name of the physical monitor as a string
-
-where X, Y, WIDTH, and HEIGHT are integers, which might be negative
-for monitors other than the primary one.  X and Y are coordinates
-of the top-left corner of the rectangle.  Keys labeled with (*) are
-optional.
+ source (*) -- Source of multi-monitor information as a string
+
+where X, Y, WIDTH, and HEIGHT are integers.  X and Y are coordinates
+of the top-left corner, and might be negative for monitors other than
+the primary one.  Keys labeled with (*) are optional.
+
+The \"work area\" is a measure of the \"usable\" display space.
+It may be less than the total screen size, owing to space taken up
+by window manager features (docks, taskbars, etc.).  The precise
+details depend on the platform and environment.
+
+The `source' attribute describes the source from which the information
+was obtained.  On X, this may be one of: \"Gdk\", \"XRandr\", \"Xinerama\",
+or \"fallback\".
 
 A frame is dominated by a physical monitor when either the
 largest area of the frame resides in the monitor, or the monitor

=== modified file 'nt/README.W32'
--- a/nt/README.W32     2014-02-08 10:25:33 +0000
+++ b/nt/README.W32     2014-10-09 00:47:30 +0000
@@ -220,7 +220,7 @@
   key in HKEY_CURRENT_USER.  Just delete the whole Software\GNU\Emacs
   key.
 
-  The Start menu entry can be removed by right-clicking on the Task bar
+  The Start menu entry can be removed by right-clicking on the Taskbar
   and selecting Properties, then using the Remove option on the Start
   Menu Programs page.  (If you installed under an account with
   administrator privileges, then you need to click the Advanced button

=== modified file 'src/ChangeLog.10'
--- a/src/ChangeLog.10  2014-01-15 03:06:07 +0000
+++ b/src/ChangeLog.10  2014-10-09 00:47:30 +0000
@@ -3264,7 +3264,7 @@
        * w32term.c (x_make_frame_visible): Use SystemParametersInfo with
        SPI_GETWORKAREA to find the dimensions of the screen work area,
        and adjust vertical position of the frame in order to avoid being
-       covered by the task bar.
+       covered by the taskbar.
 
        * w32fns.c (w32_createwindow): Use CW_USEDEFAULT instead of
        f->left_pos and SH_SHOW instead of f->top_pos in the call to

=== modified file 'src/w32term.c'
--- a/src/w32term.c     2014-09-24 07:31:11 +0000
+++ b/src/w32term.c     2014-10-09 00:47:30 +0000
@@ -5959,7 +5959,7 @@
          RECT window_rect;
 
          /* Adjust vertical window position in order to avoid being
-            covered by a task bar placed at the bottom of the desktop. */
+            covered by a taskbar placed at the bottom of the desktop. */
          SystemParametersInfo (SPI_GETWORKAREA, 0, &workarea_rect, 0);
          GetWindowRect (FRAME_W32_WINDOW (f), &window_rect);
          if (window_rect.bottom > workarea_rect.bottom