From 73fd041d910f737746b952f2845fbf419f6ab0d3 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Fri, 24 Oct 2014 12:13:01 +0300 Subject: [PATCH] Improve documentation of faces in the user manual. doc/emacs/frames.texi (Scroll Bars): Improve indexing of faces. doc/emacs/killing.texi (Secondary Selection): Improve indexing of faces. doc/emacs/search.texi (Basic Isearch, Query Replace): Improve indexing of faces. doc/emacs/display.texi (Standard Faces, Text Display) (Useless Whitespace): Improve indexing of faces. --- doc/emacs/ChangeLog | 11 +++++++++++ doc/emacs/display.texi | 17 ++++++++++++++++- doc/emacs/frames.texi | 4 ++++ doc/emacs/killing.texi | 1 + doc/emacs/search.texi | 3 +++ 5 files changed, 35 insertions(+), 1 deletion(-) diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index 2b9a13069d2..2261be11a15 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog @@ -1,3 +1,14 @@ +2014-10-24 Eli Zaretskii + + * frames.texi (Scroll Bars): Improve indexing of faces. + + * killing.texi (Secondary Selection): Improve indexing of faces. + + * search.texi (Basic Isearch, Query Replace): Improve indexing of faces. + + * display.texi (Standard Faces, Text Display) + (Useless Whitespace): Improve indexing of faces. + 2014-10-23 Tassilo Horn * misc.texi (Document View): Adapt to latest doc-view changes wrt diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi index 0a77e722d32..a5555d58054 100644 --- a/doc/emacs/display.texi +++ b/doc/emacs/display.texi @@ -578,6 +578,7 @@ Parameters}. @node Standard Faces @section Standard Faces +@cindex standard faces Here are the standard faces for specifying text appearance. You can apply them to specific text when you want the effects they produce. @@ -598,8 +599,10 @@ This face underlines text. This face forces use of a fixed-width font. It's reasonable to customize this face to use a different fixed-width font, if you like, but you should not make it a variable-width font. +@cindex variable-pitch face @item variable-pitch This face forces use of a variable-width font. +@cindex shadow face @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 @@ -647,25 +650,34 @@ frame: @table @code @item mode-line +@cindex mode-line face +@cindex faces for mode lines 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 graphical displays, and drawn as the inverse of the default face on non-windowed terminals. @item mode-line-inactive +@cindex mode-line-inactive face 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 non-@code{nil}). This face inherits from @code{mode-line}, so changes in that face affect mode lines in all windows. @item mode-line-highlight -Like @code{highlight}, but used for portions of text on mode lines. +@cindex mode-line-highlight face +Like @code{highlight}, but used for mouse-sensitive portions of text +on mode lines. Such portions of text typically pop up tooltips +(@pxref{Tooltips}) when the mouse pointer hovers above them. @item mode-line-buffer-id +@cindex mode-line-buffer-id face This face is used for buffer identification parts in the mode line. @item header-line +@cindex header-line face Similar to @code{mode-line} for a window's header line, which appears at the top of a window just as the mode line appears at the bottom. Most windows do not have a header line---only some special modes, such Info mode, create one. @item vertical-border +@cindex vertical-border face This face is used for the vertical divider between windows on text terminals. @item minibuffer-prompt @@ -1110,6 +1122,7 @@ empty lines at the end of a buffer, without realizing it. In most cases, this @dfn{trailing whitespace} has no effect, but sometimes it can be a nuisance. +@cindex trailing-whitespace face You can make trailing whitespace at the end of a line visible by setting the buffer-local variable @code{show-trailing-whitespace} to @code{t}. Then Emacs displays trailing whitespace, using the face @@ -1418,6 +1431,8 @@ as octal escape sequences instead of caret escape sequences. @cindex non-breaking space @cindex non-breaking hyphen @cindex soft hyphen +@cindex escape-glyph face +@cindex nobreak-space face Some non-@acronym{ASCII} characters have the same appearance as an @acronym{ASCII} space or hyphen (minus) character. Such characters can cause problems if they are entered into a buffer without your diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi index c02619e82c5..538bcab6a19 100644 --- a/doc/emacs/frames.texi +++ b/doc/emacs/frames.texi @@ -961,6 +961,10 @@ end of the buffer is shown; if @code{nil}, the thumb will be at the bottom when the end of the buffer is shown. You can not over-scroll when the entire buffer is visible. +@cindex scroll-bar face + The visual appearance of the scroll bars is controlled by the +@code{scroll-bar} face. + @node Drag and Drop @section Drag and Drop @cindex drag and drop diff --git a/doc/emacs/killing.texi b/doc/emacs/killing.texi index f4b1752643d..e258d1ca1a0 100644 --- a/doc/emacs/killing.texi +++ b/doc/emacs/killing.texi @@ -588,6 +588,7 @@ you can access it using the following Emacs commands: @table @kbd @findex mouse-set-secondary @kindex M-Drag-Mouse-1 +@cindex secondary-selection face @item M-Drag-Mouse-1 Set the secondary selection, with one end at the place where you press down the button, and the other end at the place where you release it diff --git a/doc/emacs/search.texi b/doc/emacs/search.texi index bdfb534e186..bd0bd0bf641 100644 --- a/doc/emacs/search.texi +++ b/doc/emacs/search.texi @@ -86,6 +86,7 @@ not be the first @samp{F} previously found. After another @kbd{O}, the cursor moves to just after the first @samp{FOO}. @cindex faces for highlighting search matches +@cindex isearch face At each step, Emacs highlights the @dfn{current match}---the buffer text that matches the search string---using the @code{isearch} face (@pxref{Faces}). The current search string is also displayed in the @@ -1280,6 +1281,8 @@ It works like @code{replace-regexp} except that it queries like @code{query-replace}. @cindex faces for highlighting query replace +@cindex query-replace face +@cindex lazy-highlight face These commands highlight the current match using the face @code{query-replace}. They highlight other matches using @code{lazy-highlight} just like incremental search (@pxref{Incremental -- 2.39.5