Standard Faces nodes

unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed

* Standard Faces nodes
@ 2005-08-10  4:03 Juri Linkov
  2005-08-10 19:50 ` Richard M. Stallman
  0 siblings, 1 reply; 7+ messages in thread
From: Juri Linkov @ 2005-08-10  4:03 UTC (permalink / raw)


There are two Info nodes with the same name in the Emacs User Manual
and in the Emacs Lisp Reference Manual which serve the same purpose:

(info "(emacs)Standard Faces")
(info "(elisp)Standard Faces")

What is bad is that they are out of sync.  Every change in faces needs
to be duplicated in both nodes.  It would be better to provide this
information only in the Emacs User Manual, and to make a cross-reference
to it from the Emacs Lisp Reference Manual.

I could create a patch for that by merging the text from both nodes
into `(emacs)Standard Faces', if this is ok.

-- 
Juri Linkov
http://www.jurta.org/emacs/

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: Standard Faces nodes
  2005-08-10  4:03 Standard Faces nodes Juri Linkov
@ 2005-08-10 19:50 ` Richard M. Stallman
  2005-08-16 16:03   ` Juri Linkov
  0 siblings, 1 reply; 7+ messages in thread
From: Richard M. Stallman @ 2005-08-10 19:50 UTC (permalink / raw)
  Cc: emacs-devel

    What is bad is that they are out of sync.  Every change in faces needs
    to be duplicated in both nodes.  It would be better to provide this
    information only in the Emacs User Manual, and to make a cross-reference
    to it from the Emacs Lisp Reference Manual.

    I could create a patch for that by merging the text from both nodes
    into `(emacs)Standard Faces', if this is ok.

Please do, and thanks for noticing the problem.

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: Standard Faces nodes
  2005-08-10 19:50 ` Richard M. Stallman
@ 2005-08-16 16:03   ` Juri Linkov
  2005-08-16 19:14     ` Stuart D. Herring
  2005-08-18 14:48     ` Richard M. Stallman
  0 siblings, 2 replies; 7+ messages in thread
From: Juri Linkov @ 2005-08-16 16:03 UTC (permalink / raw)
  Cc: emacs-devel

>     I could create a patch for that by merging the text from both nodes
>     into `(emacs)Standard Faces', if this is ok.
>
> Please do, and thanks for noticing the problem.

Below is a patch which merges the nodes `(elisp)Standard Faces' and
`(emacs)Standard Faces' into the latter.

Index: lispref/display.texi
===================================================================
RCS file: /cvsroot/emacs/emacs/lispref/display.texi,v
retrieving revision 1.180
diff -c -r1.180 display.texi
*** lispref/display.texi	11 Aug 2005 19:59:05 -0000	1.180
--- lispref/display.texi	16 Aug 2005 15:52:03 -0000
***************
*** 1673,1679 ****
    A @dfn{face} is a named collection of graphical attributes: font
  family, foreground color, background color, optional underlining, and
  many others.  Faces are used in Emacs to control the style of display of
! particular parts of the text or the frame.
  
  @cindex face id
  Each face has its own @dfn{face number}, which distinguishes faces at
--- 1673,1681 ----
    A @dfn{face} is a named collection of graphical attributes: font
  family, foreground color, background color, optional underlining, and
  many others.  Faces are used in Emacs to control the style of display of
! particular parts of the text or the frame.  @xref{Standard Faces,,,
! emacs, The GNU Emacs Manual}, for the list of faces Emacs normally
! comes with.
  
  @cindex face id
  Each face has its own @dfn{face number}, which distinguishes faces at
***************
*** 1691,1697 ****
  face name a special meaning in one frame if you wish.
  
  @menu
- * Standard Faces::      The faces Emacs normally comes with.
  * Defining Faces::      How to define a face with @code{defface}.
  * Face Attributes::     What is in a face?
  * Attribute Functions::  Functions to examine and set face attributes.
--- 1693,1698 ----
***************
*** 1705,1843 ****
                            that handle a range of character sets.
  @end menu
  
- @node Standard Faces
- @subsection Standard Faces
- 
-   This table lists all the standard faces and their uses.  Most of them
- are used for displaying certain parts of the frames or certain kinds of
- text; you can control how those places look by customizing these faces.
- 
- @table @code
- @item default
- @kindex default @r{(face name)}
- This face is used for ordinary text.
- 
- @item mode-line
- @kindex mode-line @r{(face name)}
- This face is used for the mode line of the selected window, and for
- menu bars when toolkit menus are not used.
- 
- @item modeline
- @kindex modeline @r{(face name)}
- This is an alias for the @code{mode-line} face, for compatibility with
- old Emacs versions.
- 
- @item mode-line-inactive
- @kindex mode-line-inactive @r{(face name)}
- This face is used for mode lines of non-selected windows.
- This face inherits from @code{mode-line}, so changes
- in that face affect all windows.
- 
- @item header-line
- @kindex header-line @r{(face name)}
- This face is used for the header lines of windows that have them.
- 
- @item menu
- This face controls the display of menus, both their colors and their
- font.  (This works only on certain systems.)
- 
- @item fringe
- @kindex fringe @r{(face name)}
- This face controls the default colors of window fringes, the thin
- areas on either side that are used to display continuation and
- truncation glyphs.  Other faces used to display bitmaps in the fringe
- are implicitly merged with this face.
- 
- @item minibuffer-prompt
- @kindex minibuffer-prompt @r{(face name)}
- @vindex minibuffer-prompt-properties
- This face is used for the text of minibuffer prompts.  By default,
- Emacs automatically adds this face to the value of
- @code{minibuffer-prompt-properties}, which is a list of text
- properties used to display the prompt text.
- 
- @item scroll-bar
- @kindex scroll-bar @r{(face name)}
- This face controls the colors for display of scroll bars.
- 
- @item tool-bar
- @kindex tool-bar @r{(face name)}
- This face is used for display of the tool bar, if any.
- 
- @item region
- @kindex region @r{(face name)}
- This face is used for highlighting the region in Transient Mark mode.
- 
- @item secondary-selection
- @kindex secondary-selection @r{(face name)}
- This face is used to show any secondary selection you have made.
- 
- @item highlight
- @kindex highlight @r{(face name)}
- This face is meant to be used for highlighting for various purposes.
- 
- @item mode-line-highlight
- @kindex mode-line-highlight @r{(face name)}
- This face is used for highlighting something on @code{mode-line} or
- @code{header-line} for various purposes.
- 
- @item trailing-whitespace
- @kindex trailing-whitespace @r{(face name)}
- This face is used to display excess whitespace at the end of a line,
- if @code{show-trailing-whitespace} is non-@code{nil}.
- 
- @item escape-glyph
- @kindex escape-glyph @r{(face name)}
- This face is used to display control characters and escape glyphs.
- @end table
- 
-   In contrast, these faces are provided to change the appearance of text
- in specific ways.  You can use them on specific text, when you want
- the effects they produce.
- 
- @table @code
- @item bold
- @kindex bold @r{(face name)}
- This face uses a bold font, if possible.  It uses the bold variant of
- the frame's font, if it has one.  It's up to you to choose a default
- font that has a bold variant, if you want to use one.
- 
- @item italic
- @kindex italic @r{(face name)}
- This face uses the italic variant of the frame's font, if it has one.
- 
- @item bold-italic
- @kindex bold-italic @r{(face name)}
- This face uses the bold italic variant of the frame's font, if it has
- one.
- 
- @item underline
- @kindex underline @r{(face name)}
- This face underlines text.
- 
- @item fixed-pitch
- @kindex fixed-pitch @r{(face name)}
- This face forces use of a particular fixed-width font.
- 
- @item variable-pitch
- @kindex variable-pitch @r{(face name)}
- This face forces use of a particular variable-width font.  It's
- reasonable to customize this to use a different variable-width font, if
- you like, but you should not make it a fixed-width font.
- 
- @item shadow
- @kindex shadow @r{(face name)}
- This face is used for making the text less noticeable than the
- surrounding ordinary text.
- @end table
- 
- @defvar show-trailing-whitespace
- @tindex show-trailing-whitespace
- If this variable is non-@code{nil}, Emacs uses the
- @code{trailing-whitespace} face to display any spaces and tabs at the
- end of a line.
- @end defvar
- 
  @node Defining Faces
  @subsection Defining Faces
  
--- 1706,1711 ----
***************
*** 2378,2384 ****
  
  @item
  With a region that is active.  In Transient Mark mode, the region is
! highlighted with the face @code{region} (@pxref{Standard Faces}).
  
  @item
  With special glyphs.  Each glyph can specify a particular face
--- 2246,2253 ----
  
  @item
  With a region that is active.  In Transient Mark mode, the region is
! highlighted with the face @code{region} (@pxref{Standard Faces,,,
! emacs, The GNU Emacs Manual}).
  
  @item
  With special glyphs.  Each glyph can specify a particular face

Index: man/display.texi
===================================================================
RCS file: /cvsroot/emacs/emacs/man/display.texi,v
retrieving revision 1.100
diff -c -r1.100 display.texi
*** man/display.texi	10 Aug 2005 15:14:30 -0000	1.100
--- man/display.texi	16 Aug 2005 15:57:26 -0000
***************
*** 105,117 ****
  type @kbd{M-x list-faces-display}.  It's possible for a given face to
  look different in different frames; this command shows the appearance
  in the frame in which you type it.  Here are the standard faces
! for specifying text appearance:
  
  @table @code
  @item default
  This face is used for ordinary text that doesn't specify any other face.
  @item bold
  This face uses a bold variant of the default font, if it has one.
  @item italic
  This face uses an italic variant of the default font, if it has one.
  @item bold-italic
--- 105,120 ----
  type @kbd{M-x list-faces-display}.  It's possible for a given face to
  look different in different frames; this command shows the appearance
  in the frame in which you type it.  Here are the standard faces
! for specifying text appearance.  You can use them on specific text,
! when you want the effects they produce:
  
  @table @code
  @item default
  This face is used for ordinary text that doesn't specify any other face.
  @item bold
  This face uses a bold variant of the default font, if it has one.
+ It's up to you to choose a default font that has a bold variant,
+ if you want to use one.
  @item italic
  This face uses an italic variant of the default font, if it has one.
  @item bold-italic
***************
*** 119,127 ****
  @item underline
  This face underlines text.
  @item fixed-pitch
! The basic fixed-pitch face.
  @item variable-pitch
! The basic variable-pitch face.
  @end table
  
    Here's an incomplete list of faces used to highlight parts of the
--- 122,136 ----
  @item underline
  This face underlines text.
  @item fixed-pitch
! This face forces use of a particular fixed-width font.
  @item variable-pitch
! This face forces use of a particular variable-width font.  It's
! reasonable to customize this to use a different variable-width font,
! if you like, but you should not make it a fixed-width font.
! @item shadow
! This face is used for making the text less noticeable than the surrounding
! ordinary text.  Usually this can be achieved by using shades of gray in
! contrast with either black or white default foreground color.
  @end table
  
    Here's an incomplete list of faces used to highlight parts of the
***************
*** 146,164 ****
  This face is used for displaying a secondary X selection (@pxref{Secondary
  Selection}).
  @item trailing-whitespace
! The face for highlighting trailing whitespace when
! @code{show-trailing-whitespace} is non-@code{nil}; see @ref{Useless
! Whitespace}.
  @item nobreak-space
  The face for displaying the character ``nobreak space''.
  @item escape-glyph
  The face for highlighting the @samp{\} or @samp{^} that indicates
  a control character.  It's also used when @samp{\} indicates a
  nobreak space or nobreak (soft) hyphen.
- @item shadow
- The basic face for making the text less noticeable than the surrounding
- ordinary text.  Usually this is achieved by using shades of grey in
- contrast with either black or white default foreground color.
  @end table
  
  @cindex @code{region} face
--- 155,169 ----
  This face is used for displaying a secondary X selection (@pxref{Secondary
  Selection}).
  @item trailing-whitespace
! The face for highlighting excess spaces and tabs at the end of a line
! when @code{show-trailing-whitespace} is non-@code{nil}; see
! @ref{Useless Whitespace}.
  @item nobreak-space
  The face for displaying the character ``nobreak space''.
  @item escape-glyph
  The face for highlighting the @samp{\} or @samp{^} that indicates
  a control character.  It's also used when @samp{\} indicates a
  nobreak space or nobreak (soft) hyphen.
  @end table
  
  @cindex @code{region} face
***************
*** 175,184 ****
  
  @table @code
  @item mode-line
! This face is used for the mode line of the currently selected window.
! By default, it's drawn with shadows for a ``raised'' effect on window
! systems, and drawn as the inverse of the default face on non-windowed
! terminals.
  @item mode-line-inactive
  Like @code{mode-line}, but used for mode lines of the windows other
  than the selected one (if @code{mode-line-in-non-selected-windows} is
--- 180,192 ----
  
  @table @code
  @item mode-line
! @itemx modeline
! This face is used for the mode line of the currently selected window,
! and for menu bars when toolkit menus are not used.  By default, it's
! drawn with shadows for a ``raised'' effect on window systems, and
! drawn as the inverse of the default face on non-windowed terminals.
! @code{modeline} is an alias for the @code{mode-line} face, for
! compatibility with old Emacs versions.
  @item mode-line-inactive
  Like @code{mode-line}, but used for mode lines of the windows other
  than the selected one (if @code{mode-line-in-non-selected-windows} is
***************
*** 186,192 ****
  in that face affect mode lines in all windows.
  @item header-line
  Similar to @code{mode-line} for a window's header line.  Most modes
! don't use the header line, but the Info mode does.
  @item vertical-border
  This face is used for the vertical divider between windows.
  By default this face inherits from the @code{mode-line-inactive} face
--- 194,200 ----
  in that face affect mode lines in all windows.
  @item header-line
  Similar to @code{mode-line} for a window's header line.  Most modes
! don't use the header line, but some special modes, such the Info mode, do.
  @item vertical-border
  This face is used for the vertical divider between windows.
  By default this face inherits from the @code{mode-line-inactive} face
***************
*** 194,202 ****
  this face is used for the vertical line between windows without
  scrollbars.
  @item minibuffer-prompt
  This face is used for the prompt strings displayed in the minibuffer.
  @item fringe
! @cindex fringe
  The face for the fringes to the left and right of windows on graphic
  displays.  (The fringes are the narrow portions of the Emacs frame
  between the text area and the window's right and left borders.)
--- 202,215 ----
  this face is used for the vertical line between windows without
  scrollbars.
  @item minibuffer-prompt
+ @cindex @code{minibuffer-prompt} face
+ @vindex minibuffer-prompt-properties
  This face is used for the prompt strings displayed in the minibuffer.
+ By default, Emacs automatically adds this face to the value of
+ @code{minibuffer-prompt-properties}, which is a list of text
+ properties used to display the prompt text.
  @item fringe
! @cindex @code{fringe} face
  The face for the fringes to the left and right of windows on graphic
  displays.  (The fringes are the narrow portions of the Emacs frame
  between the text area and the window's right and left borders.)

-- 
Juri Linkov
http://www.jurta.org/emacs/

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: Standard Faces nodes
  2005-08-16 16:03   ` Juri Linkov
@ 2005-08-16 19:14     ` Stuart D. Herring
  2005-08-16 19:29       ` Andreas Schwab
  2005-08-18 14:48     ` Richard M. Stallman
  1 sibling, 1 reply; 7+ messages in thread
From: Stuart D. Herring @ 2005-08-16 19:14 UTC (permalink / raw)
  Cc: rms, emacs-devel

>   @table @code
>   @item mode-line
> ! @itemx modeline

I don't know too much about Texinfo, but shouldn't there be a @code
modifier on both of those item labels?

Davis Herring

-- 
This product is sold by volume, not by mass.  If it appears too dense or
too sparse, it is because mass-energy conversion has occurred during
shipping.

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: Standard Faces nodes
  2005-08-16 19:14     ` Stuart D. Herring
@ 2005-08-16 19:29       ` Andreas Schwab
  2005-08-16 20:07         ` Stuart D. Herring
  0 siblings, 1 reply; 7+ messages in thread
From: Andreas Schwab @ 2005-08-16 19:29 UTC (permalink / raw)
  Cc: Juri Linkov, rms, emacs-devel

"Stuart D. Herring" <herring@lanl.gov> writes:

>>   @table @code
>>   @item mode-line
>> ! @itemx modeline
>
> I don't know too much about Texinfo, but shouldn't there be a @code
> modifier on both of those item labels?

That's what "@table @code" is for (*note (texinfo)table::).

Andreas.

-- 
Andreas Schwab, SuSE Labs, schwab@suse.de
SuSE Linux Products GmbH, Maxfeldstraße 5, 90409 Nürnberg, Germany
Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: Standard Faces nodes
  2005-08-16 19:29       ` Andreas Schwab
@ 2005-08-16 20:07         ` Stuart D. Herring
  0 siblings, 0 replies; 7+ messages in thread
From: Stuart D. Herring @ 2005-08-16 20:07 UTC (permalink / raw)
  Cc: emacs-devel

>>>   @table @code
>>>   @item mode-line
>>> ! @itemx modeline
>>
>> I don't know too much about Texinfo, but shouldn't there be a @code
>> modifier on both of those item labels?
>
> That's what "@table @code" is for (*note (texinfo)table::).

Ah, thanks -- I was thinking of it like \frame or so in LaTeX,
automatically operating on whatever follows when there are no braces.

Davis Herring

-- 
This product is sold by volume, not by mass.  If it appears too dense or
too sparse, it is because mass-energy conversion has occurred during
shipping.

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: Standard Faces nodes
  2005-08-16 16:03   ` Juri Linkov
  2005-08-16 19:14     ` Stuart D. Herring
@ 2005-08-18 14:48     ` Richard M. Stallman
  1 sibling, 0 replies; 7+ messages in thread
From: Richard M. Stallman @ 2005-08-18 14:48 UTC (permalink / raw)
  Cc: emacs-devel

Please install these changes, and thanks.

^ permalink raw reply	[flat|nested] 7+ messages in thread

end of thread, other threads:[~2005-08-18 14:48 UTC | newest]

Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2005-08-10  4:03 Standard Faces nodes Juri Linkov
2005-08-10 19:50 ` Richard M. Stallman
2005-08-16 16:03   ` Juri Linkov
2005-08-16 19:14     ` Stuart D. Herring
2005-08-16 19:29       ` Andreas Schwab
2005-08-16 20:07         ` Stuart D. Herring
2005-08-18 14:48     ` Richard M. Stallman

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).