emacs-pretest-bug
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: read-face-name doc string incorrect


From: Nick Roberts
Subject: Re: read-face-name doc string incorrect
Date: Sat, 1 Jul 2006 21:00:46 +1200

 > Would you like to check the Lisp Manual files that still need to be
 > checked?

I find it hard to find much that needs improving.  I've looked at text.texi
and all I can suggest is possible improvements to the the node 
"Properties with Special Meanings" attached below.

-- 
Nick                                           http://www.inet.net.nz/~nickrob


*** text.texi   17 Jun 2006 10:56:48 +1200      1.119
--- text.texi   01 Jul 2006 20:59:26 +1200      
*************** that all text between the character and 
*** 3002,3025 ****
  
  @item fontified
  @kindex fontified @r{(text property)}
! This property says whether the text has had faces assigned to it by
! font locking.  The display engine tests it to decide whether a buffer
  portion needs refontifying before display.  @xref{Auto Faces}.  It
! takes one of these three values---other values are invalid:
  
  @table @asis
  @item @code{nil}
! Font locking is disabled, or the @code{face} properties on the text,
! if any, are invalid.
  
! @item The symbol @code{defer}
! This value states that the text's @code{face} properties are invalid
  and marks it for deferred fontification.  It is used only when ``just
  in time'' font locking is enabled.
  
  @item @code{t}
! The @code{face} properties, or lack of them, on the text are currently
! valid.
  @end table
  
  @item display
--- 3002,3024 ----
  
  @item fontified
  @kindex fontified @r{(text property)}
! This property says whether the character has a face assigned to it by font
! locking.  The display engine tests it to decide whether a buffer
  portion needs refontifying before display.  @xref{Auto Faces}.  It
! takes one of these three values:
  
  @table @asis
  @item @code{nil}
! Font locking is disabled, or the character's @code{face} property, if
! any, is invalid.
  
! @item @code{defer}
! This value states that the character's @code{face} property is invalid
  and marks it for deferred fontification.  It is used only when ``just
  in time'' font locking is enabled.
  
  @item @code{t}
! The character's @code{face} property, if any, is currently valid.
  @end table
  
  @item display
*************** or shorter, higher or lower, wider or na
*** 3032,3063 ****
  @item help-echo
  @kindex help-echo @r{(text property)}
  @cindex tooltip
! @anchor{Text help-echo}
! If text has a string as its @code{help-echo} property, then when you
! move the mouse onto that text, Emacs displays that string in the echo
! area, or in the tooltip window (@pxref{Tooltips,,, emacs, The GNU Emacs
! Manual}).
! 
! If the value of the @code{help-echo} property is a function, that
! function is called with three arguments, @var{window}, @var{object} and
! @var{pos} and should return a help string or @code{nil} for
! none.  The first argument, @var{window} is the window in which
! the help was found.  The second, @var{object}, is the buffer, overlay or
! string which had the @code{help-echo} property.  The @var{pos}
! argument is as follows:
  
  @itemize @bullet{}
  @item
! If @var{object} is a buffer, @var{pos} is the position in the buffer
! where the @code{help-echo} text property was found.
  @item
  If @var{object} is an overlay, that overlay has a @code{help-echo}
! property, and @var{pos} is the position in the overlay's buffer under
! the mouse.
  @item
  If @var{object} is a string (an overlay string or a string displayed
  with the @code{display} property), @var{pos} is the position in that
! string under the mouse.
  @end itemize
  
  If the value of the @code{help-echo} property is neither a function nor
--- 3031,3059 ----
  @item help-echo
  @kindex help-echo @r{(text property)}
  @cindex tooltip
! @anchor{Text help-echo} If the @code{help-echo} property value of a
! character is a string, then when you move the mouse over it, Emacs
! displays that string in the echo area, or in the tooltip window
! (@pxref{Tooltips,,, emacs, The GNU Emacs Manual}).
! 
! If the value of the @code{help-echo} property is a function that
! should return a help string or @code{nil} for none, and which is
! called with three arguments, @var{window}, @var{object} and @var{pos}.
! The first argument, @var{window} is the window in which the character
! is located; the second, @var{object}, is the buffer, overlay or
! string associated with the character; and the third, @var{pos}, is
! the associated position of the character:
  
  @itemize @bullet{}
  @item
! If @var{object} is a buffer, @var{pos} is the position in the buffer.
  @item
  If @var{object} is an overlay, that overlay has a @code{help-echo}
! property, and @var{pos} is the position in the overlay's buffer.
  @item
  If @var{object} is a string (an overlay string or a string displayed
  with the @code{display} property), @var{pos} is the position in that
! string.
  @end itemize
  
  If the value of the @code{help-echo} property is neither a function nor




reply via email to

[Prev in Thread] Current Thread [Next in Thread]