aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--man/speedbar.texi22
1 files changed, 11 insertions, 11 deletions
diff --git a/man/speedbar.texi b/man/speedbar.texi
index 2db5eddb1d6..734c8c0ca78 100644
--- a/man/speedbar.texi
+++ b/man/speedbar.texi
@@ -1,6 +1,6 @@
1\input texinfo @c -*-texinfo-*- 1\input texinfo @c -*-texinfo-*-
2@c 2@c
3@c $Id: speedbar.texi,v 1.4 2000/12/05 22:57:03 fx Exp $ 3@c $Id: speedbar.texi,v 1.5 2000/12/05 23:02:24 fx Exp $
4@c 4@c
5 5
6@c This file is part of GNU Emacs 6@c This file is part of GNU Emacs
@@ -84,16 +84,16 @@ license to the document, as described in section 6 of the license.
84 84
85Speedbar is a program for Emacs which can be used to summarize 85Speedbar is a program for Emacs which can be used to summarize
86information related to the current buffer. Its original inspiration 86information related to the current buffer. Its original inspiration
87is the "explorer" often used in modern development environments, office 87is the `explorer' often used in modern development environments, office
88packages, and web browsers. 88packages, and web browsers.
89 89
90Speedbar displays a narrow frame in which a tree view is shown. This 90Speedbar displays a narrow frame in which a tree view is shown. This
91tree view defaults to containing a list of files and directories. Files 91tree view defaults to containing a list of files and directories. Files
92can be "expanded" to list tags inside. Directories can be expanded to 92can be `expanded' to list tags inside. Directories can be expanded to
93list the files within itself. Each file or tag can be jumped to 93list the files within itself. Each file or tag can be jumped to
94immediately. 94immediately.
95 95
96Speedbar expands upon "explorer" windows by maintaining context with the 96Speedbar expands upon `explorer' windows by maintaining context with the
97user. For example, when using the file view, the current buffer's file 97user. For example, when using the file view, the current buffer's file
98is highlighted. Speedbar also mimics the explorer windows by providing 98is highlighted. Speedbar also mimics the explorer windows by providing
99multiple display modes. These modes come in two flavors. Major display 99multiple display modes. These modes come in two flavors. Major display
@@ -102,8 +102,8 @@ only when a buffer of the applicable type is shown. This allows
102authors of other packages to provide speedbar summaries customized to 102authors of other packages to provide speedbar summaries customized to
103the needs of that mode. 103the needs of that mode.
104 104
105Throughout this manual, activities are defined as "clicking on", or 105Throughout this manual, activities are defined as `clicking on', or
106"expanding" items. Clicking means using using @kbd{mouse-2} on a 106`expanding' items. Clicking means using using @kbd{mouse-2} on a
107button. Expanding refers to clicking on an expansion button to display 107button. Expanding refers to clicking on an expansion button to display
108an expanded summary of the entry the expansion button is 108an expanded summary of the entry the expansion button is
109on. @xref{Basic Navigation}. 109on. @xref{Basic Navigation}.
@@ -274,9 +274,9 @@ Groups summarize information in a single line, and provide a high level
274view of more complex systems, like a directory tree, or manual chapters. 274view of more complex systems, like a directory tree, or manual chapters.
275 275
276Groups appear at different indentation levels, and are prefixed with a 276Groups appear at different indentation levels, and are prefixed with a
277@samp{+} in some sort of "box". The group name will summarize the 277@samp{+} in some sort of `box'. The group name will summarize the
278information within it, and the expansion box will display that 278information within it, and the expansion box will display that
279information inline. In File mode, directories and files are "groups" 279information inline. In File mode, directories and files are `groups'
280where the @samp{+} is surrounded by brackets like this: 280where the @samp{+} is surrounded by brackets like this:
281 281
282@example 282@example
@@ -289,7 +289,7 @@ In this example, we see both open and closed directories, in addition to
289a file. The directories have a box consisting of angle brackets, and a 289a file. The directories have a box consisting of angle brackets, and a
290file uses square brackets. 290file uses square brackets.
291 291
292In all modes, a group can be "edited" by pressing @kbd{RET}, meaning a 292In all modes, a group can be `edited' by pressing @kbd{RET}, meaning a
293file will be opened, or a directory explicitly opened in speedbar. A 293file will be opened, or a directory explicitly opened in speedbar. A
294group can be expanded or contracted using @kbd{+} or 294group can be expanded or contracted using @kbd{+} or
295@kbd{-}. @xref{Basic Keybindings}. 295@kbd{-}. @xref{Basic Keybindings}.
@@ -335,7 +335,7 @@ Unadorned text will generally be colorless, and not clickable.
335Each type of Group, item indicator, and label is given a different 335Each type of Group, item indicator, and label is given a different
336color. The colors chosen are dependent on whether the background color 336color. The colors chosen are dependent on whether the background color
337is light or dark. 337is light or dark.
338Of important note is that the "current item", which may be a buffer or 338Of important note is that the `current item', which may be a buffer or
339file name, is highlighted red, and underlined. 339file name, is highlighted red, and underlined.
340 340
341Colors can be customized from the group @code{speedbar-faces}. Some 341Colors can be customized from the group @code{speedbar-faces}. Some
@@ -1182,7 +1182,7 @@ The conventions allow almost anything to be inserted, but several helper
1182functions are provided to make it easy to create the standardized 1182functions are provided to make it easy to create the standardized
1183buttons. 1183buttons.
1184 1184
1185To understand the built in functions, each "button" in speedbar consists 1185To understand the built in functions, each `button' in speedbar consists
1186of four important pieces of data. The text to be displayed, token 1186of four important pieces of data. The text to be displayed, token
1187data to be associated with the text, a function to call, and some face to 1187data to be associated with the text, a function to call, and some face to
1188display it in. 1188display it in.