|
0
|
1 * Overview
|
|
|
2
|
|
24
|
3 InfoDock Associates, the developer of Hyperbole and InfoDock (an industrial
|
|
|
4 quality turn-key version of XEmacs), sells high quality commercial support,
|
|
|
5 training, books and custom package development for InfoDock, XEmacs or GNU
|
|
|
6 Emacs on a variety of platforms. Contact us at <info@infodock.com> or visit
|
|
|
7 our web site at http://www.infodock.com.
|
|
|
8
|
|
|
9 ------------------
|
|
|
10
|
|
0
|
11 This file demonstrates simple usage of the basic Hyperbole button-action
|
|
|
12 types and shows how Hyperbole can support a style of self-documenting,
|
|
|
13 interactive files. See the glossary in the Hyperbole Manual,
|
|
|
14 "(hyperbole.info)Glossary", if terms used here are unfamiliar to you.
|
|
|
15
|
|
|
16 * Smart Keys
|
|
|
17
|
|
|
18 Hyperbole provides two context-sensitive keys, the Action Key and the Assist
|
|
|
19 Key, jointly referred to as Smart Keys. The Action Key is the shift-middle
|
|
|
20 mouse button on a 3-button mouse or shift-left button on a two button mouse
|
|
|
21 or {M-RET} on your keyboard. The Assist Key is the shift-right mouse button
|
|
|
22 or {C-u M-RET}. (InfoDock users may also use the middle mouse button as the
|
|
|
23 Action Key.)
|
|
|
24
|
|
|
25 See also the later section, <(Smart Mouse Keys)>.
|
|
|
26
|
|
|
27
|
|
|
28 ** Button Activation and Help
|
|
|
29
|
|
|
30 This button prints the <(factorial)> of 5 in the minibuffer when activated
|
|
|
31 with the Action Key. (Once you have Hyperbole installed, just press the
|
|
|
32 Action Key on the word, <(factorial)>.) If you instead press the Assist Key,
|
|
|
33 you get help for the preceding button. The help provides a summary report of
|
|
24
|
34 the button. You will see that it utilizes the `eval-elisp' action type. You
|
|
0
|
35 can also see who created it. Try it.
|
|
|
36
|
|
|
37 Note that the create-time and mod-time are displayed using your own
|
|
|
38 timezone but they are stored as universal times. So if you work with
|
|
|
39 people at other sites, you can mix their buttons with your own within
|
|
|
40 the same document and see one unified view of the modification times on
|
|
|
41 each button. These times will also be useful for sorting buttons by
|
|
|
42 time when such features are provided in future Hyperbole releases.
|
|
|
43
|
|
|
44 ** Smart Scrolling
|
|
|
45
|
|
|
46 By default, the variable smart-scroll-proportional is set to t (TRUE). This
|
|
|
47 makes a press of the Action Key at the end of a line scroll forward, so that
|
|
|
48 the current line is placed at the top of the window; the Assist Key does the
|
|
|
49 reverse when pressed at the end of line; it places the current line at the
|
|
|
50 bottom of the window. This is called proportional scrolling because the
|
|
|
51 amount of scrolling is relative to the point's position in the window. Try
|
|
|
52 it and then come back here.
|
|
|
53
|
|
|
54 Alternatively, if this variable is set to nil (FALSE), the Smart Keys scroll
|
|
|
55 forward or backward a windowful when at the end of a line, regardless of
|
|
|
56 which line point is on, just as {C-v} and {M-v} do.
|
|
|
57
|
|
|
58 Let's try windowful scrolling a bit. Click this button and then practice
|
|
|
59 scrolling: <(toggle-scroll-proportional)>. If you prefer the default
|
|
|
60 proportional scrolling, click on the previous button again to restore it.
|
|
|
61
|
|
|
62 If you always want windowful scrolling, you'll have to add a setting of
|
|
|
63 smart-scroll-proportional to your "~/.emacs" file after the point at which
|
|
|
64 you load Hyperbole or else set it as part of hyperb:init-hook, which executes
|
|
|
65 whenever Hyperbole is loaded, e.g.:
|
|
|
66
|
|
|
67 (setq hyperb:init-hook
|
|
|
68 (list (function (lambda () (setq smart-scroll-proportional nil)))))
|
|
|
69
|
|
|
70
|
|
|
71 ** Hyperbole Menus
|
|
|
72
|
|
|
73 To display the top-level Hyperbole menu, click the Action Key anywhere
|
|
|
74 within this paragraph or alternatively, use {C-h h}. Clicking within the
|
|
|
75 paragraph, applies the default operation, given by action-key-default-function,
|
|
|
76 since the Action Key finds no more specialized context. The default
|
|
|
77 operation happens to bring up the Hyperbole menu.
|
|
|
78
|
|
|
79 {q} or {C-g} will quit from the menu without invoking any commands if you
|
|
|
80 just want to take a look. A menu item is selected by pressing the Action Key
|
|
|
81 over it or by typing its first letter in upper or lower case.
|
|
|
82
|
|
|
83 A click of the Assist Key on a menu item gives help on it.
|
|
|
84
|
|
|
85
|
|
|
86 ** Help Buffers
|
|
|
87
|
|
|
88 Context-sensitive Action Key help typically is bound to {C-h A}. {C-u C-h A}
|
|
|
89 displays the same kind of help for the Assist Key. Try it.
|
|
|
90
|
|
|
91 Any buffer whose name ends in `Help*' is presumed to be a temporary buffer
|
|
|
92 that one wants to inspect and then remove from view. If you click either the
|
|
|
93 Action or Assist Key at the end of a help buffer, the buffer is buried from
|
|
|
94 view and your window configuration is restored to its state prior to
|
|
|
95 displaying the help. If you have removed the Smart Key help buffer, bring it
|
|
|
96 back. Then press one of the Smart Keys at its end to remove it. Note how
|
|
|
97 your window configuration is restored.
|
|
|
98
|
|
|
99 Remember that this works for any help buffer, whether or not Hyperbole
|
|
|
100 generated it.
|
|
|
101
|
|
|
102 * Explicit Button Samples
|
|
|
103
|
|
|
104 Hyperbole is pretty forgiving about the format of explicit buttons. For
|
|
|
105 example, all of the following represent the same button, as long as one
|
|
|
106 clicks on the *first* line of the button, within the button delimiters:
|
|
|
107
|
|
|
108 <(factorial button)>
|
|
|
109
|
|
|
110 <( factorial button)>
|
|
|
111
|
|
|
112 Pam> <(factorial
|
|
|
113 Pam> button)>
|
|
|
114
|
|
|
115 ;; <(factorial
|
|
|
116 ;; button)>
|
|
|
117
|
|
|
118 /* <( factorial */
|
|
|
119 /* button )> */
|
|
|
120
|
|
|
121
|
|
|
122 If your <(Info-directory-list)> or <(Info-directory)> variables include the
|
|
|
123 directory that contains the online GNU Emacs manual, activation of the
|
|
|
124 next button will tell you about <(keyboard macros)>. Can't remember a
|
|
|
125 Hyperbole term? Check out the Hyperbole Manual <(glossary)>.
|
|
|
126
|
|
|
127 Here is a <(keyboard macro)> button. It displays documentation for the first
|
|
|
128 Emacs Lisp function that follows it, e.g. (hbut:report). You can see that a
|
|
|
129 button label can consist of a number of words, up to a set <(maximum
|
|
|
130 length)>.
|
|
|
131
|
|
|
132 A <(shell command)> button can do many things, such as display the length of
|
|
|
133 this file. While such commands are executing, you can perform other
|
|
|
134 operations. If you create a button that runs a shell command which
|
|
|
135 displays its own window system window, i.e. a window outside of Emacs, use
|
|
24
|
136 `exec-window-cmd' rather than `exec-shell-cmd' as its action type.
|
|
0
|
137
|
|
|
138 You can link to files such as your <(.login)> file. Or directories,
|
|
|
139 like the <(tmp directory)>. When creating file links, if the file you
|
|
|
140 are linking to is loaded in a buffer, you are prompted as to whether you
|
|
|
141 want the link to jump to the present point in that buffer. If so, the
|
|
|
142 link will always jump there, so position point within the referent file
|
|
|
143 to take advantage of this feature. Note how a separate window is used
|
|
|
144 when you activate file link buttons. Most basic Hyperbole action types
|
|
|
145 display their results in this manner.
|
|
|
146
|
|
24
|
147 You can make a button an alias for another by using the `link-to-ebut'
|
|
0
|
148 action type. This <(factorial alias)> button does whatever the earlier
|
|
|
149 <(factorial)> button does.
|
|
|
150
|
|
24
|
151 The `link-to-mail' action type allows you to reference mail messages
|
|
0
|
152 that you have stored away. We can't demonstrate it here since we don't
|
|
|
153 have the mail messages that you do.
|
|
|
154
|
|
|
155 Hyperbole buttons may also be embedded within mail messages. Even
|
|
|
156 buttons copied into mail replies can work:
|
|
|
157
|
|
|
158 Emile said:
|
|
|
159 >
|
|
|
160 > Hyperbole is better than home baked bread but not as filling.
|
|
|
161 > The following sample button displays a message, <(as long as
|
|
|
162 > you click within its first line)>.
|
|
|
163
|
|
|
164
|
|
|
165 * Implicit Button Samples
|
|
|
166
|
|
|
167 ** Key Sequence Buttons
|
|
|
168
|
|
|
169 Any Emacs key sequence delimited with braces may be executed by
|
|
|
170 activating it as a button, for example {C-u C-p} should leave point four
|
|
|
171 lines above the button line. A help request upon the key sequence
|
|
|
172 displays the documentation for its command binding, i.e. what it does.
|
|
|
173 If it does not represent a bound key sequence, it will not be
|
|
|
174 treated as a key sequence button.
|
|
|
175
|
|
|
176 ** Implicit Path Links
|
|
|
177
|
|
|
178 Any doubly quoted pathname acts as an implicit button that either displays the
|
|
|
179 referenced path within a buffer, passes it to an external viewer program, or
|
|
24
|
180 runs a function that operates upon the path. These are `pathname' implicit
|
|
0
|
181 buttons. For example, activate "README".
|
|
|
182
|
|
|
183 Most pathnames simply link to the files that they name and so are simply
|
|
24
|
184 displayed for editing. The variable `hpath:suffixes' is a list of filename
|
|
0
|
185 suffix strings that are added to or removed from pathnames when searching for
|
|
|
186 a match. "So if "README.gz" existed, the pathname button "README" would
|
|
|
187 display it. If you use the Emacs "crypt.el" package, then compressed files
|
|
|
188 will be uncompressed before they are displayed. Activate "README.gz" and
|
|
|
189 you'll see that the README file is displayed as desired.
|
|
|
190
|
|
24
|
191 The variable `hpath:display-alist' contains pairs of pathname expressions and
|
|
0
|
192 edit functions. When a pathname matches an expression, the associated edit
|
|
|
193 function is invoked upon the pathname.
|
|
|
194
|
|
24
|
195 The variable `hpath:find-alist' determines the file suffixes which should be
|
|
0
|
196 viewed with external programs. It also specifies the associated viewer
|
|
|
197 program for each different window system under which Hyperbole may be run.
|
|
|
198 See its documentation for more details. Under the X window system, for
|
|
24
|
199 example, if you have the `xv' program, all of the following file formats may
|
|
0
|
200 be displayed as images: gif, tiff, xbm, pm, pbm, and jpeg.
|
|
|
201
|
|
|
202 Several prefix characters may be attached to pathnames to indicate that
|
|
|
203 a different action should be taken when the button is activated.
|
|
|
204 An exclamation point prefix indicates that the full pathname should be run
|
|
|
205 as a non-windowed shell program. For example, try "!/bin/date".
|
|
|
206 An ampersand prefix means run the full pathname as a windowed program, e.g.
|
|
|
207 "&/usr/bin/X11/xeyes". Finally, a hyphen indicates that the filename should
|
|
|
208 be evaluated as an Emacs Lisp program, e.g. "-hibtypes.elc", rather than
|
|
|
209 displayed.
|
|
|
210
|
|
|
211 If you use the ange-ftp or efs add-on to GNU Emacs, such remote pathnames
|
|
|
212 will work as well. (The latest version of ange-ftp may always be obtained
|
|
|
213 via anonymous ftp to:
|
|
|
214 "/anonymous@alpha.gnu.ai.mit.edu:ange-ftp/ange-ftp.tar.gz").
|
|
|
215
|
|
24
|
216 Once you have *loaded* the ange-ftp or the efs package (or you use a version
|
|
|
217 of Emacs 19 which autoloads ange-ftp), if you are on the Internet, you can
|
|
|
218 click on any of the following to browse the contents of the Hyperbole
|
|
|
219 distribution at the University of Illinois at Urbana (limit the amount
|
|
0
|
220 you do this so as not to deny others access to the archive):
|
|
|
221
|
|
|
222 "/anonymous@ftp.xemacs.org:pub/infodock/"
|
|
|
223 /anonymous@128.174.252.16:/pub/infodock/
|
|
|
224 /ftp.xemacs.org:pub/infodock/
|
|
|
225
|
|
|
226 You can see that for ange-ftp/efs pathnames, Hyperbole recognizes them with
|
|
|
227 or without the double quote delimiters. These same pathnames can be used
|
|
|
228 within explicit buttons which link to files or directories. The HTML
|
|
|
229 (HyperText Markup Language) ftp pathname format used by World-Wide-Web
|
|
|
230 browsers is also recognized:
|
|
|
231
|
|
|
232 "ftp://ftp.xemacs.org/pub/infodock/
|
|
|
233
|
|
|
234
|
|
|
235 GNU Info (filename)node references such as "(hyperbole.info)Glossary" or
|
|
24
|
236 "(emacs)Glossary", work similarly, thanks to the `Info-node' button type.
|
|
0
|
237 Try one of the Glossary buttons above.
|
|
|
238
|
|
|
239 If you want to quickly learn how to create explicit buttons, see
|
|
|
240 "(hyperbole.info)Drags" and "(hyperbole.info)Menus".
|
|
|
241
|
|
|
242 So now when browsing the many documents that refer to filenames or Info
|
|
|
243 nodes in this way, you can just click on the name to see the contents.
|
|
|
244 (If a doubly quoted string references a local pathname that does not
|
|
|
245 exist within the file system, it will not be considered a pathname
|
|
|
246 button by Hyperbole.) Pathname implicit buttons provide one example of
|
|
|
247 how Hyperbole can improve your working environment without you having to
|
|
|
248 do any work at all.
|
|
|
249
|
|
|
250
|
|
|
251 Hyperbole provides a history command which returns you to previous button
|
|
|
252 locations in the reverse order of the way you traverse them. You access it
|
|
|
253 by selecting the Hist command from the top-level Hyperbole menu, {C-h h h}.
|
|
|
254 Remember this because you will want to use that command to return to this
|
|
|
255 DEMO later.
|
|
|
256
|
|
|
257 Now suppose you want to browse through a number of files within the
|
|
|
258 Hyperbole distribution. You could use the Emacs dired subsystem,
|
|
|
259 "(emacs)Dired", but a faster way is to note that files named MANIFEST
|
|
|
260 and DIR are used to summarize the files in a directory, so we can use
|
|
24
|
261 each of their entries as an implicit button (of `dir-summary' type) to
|
|
0
|
262 take us to the file.
|
|
|
263
|
|
|
264 Let's look at "MANIFEST". Now click anywhere within a line in the MANIFEST
|
|
|
265 file and you see that it is displayed as expected. (Remember to use the
|
|
|
266 Hyperbole history command to return here.) You can get help on these buttons
|
|
|
267 just like any others.
|
|
|
268
|
|
|
269 Table of contents entries in "README" files act similarly. Click on "README"
|
|
|
270 to view that file and then click on a table of contents entry to jump to the
|
|
|
271 associated section in the "README" file.
|
|
|
272
|
|
|
273 ** World-Wide-Web URL Buttons
|
|
|
274
|
|
|
275 If you use the w3 World-Wide-Web browser add-on to GNU Emacs, you can browse
|
|
|
276 URLs (universal resource locators) from within any buffer just as you would
|
|
|
277 any other implicit button, once you do some initial setup.
|
|
|
278
|
|
|
279 First you must ensure that you load the Hyperbole library that supports URL
|
|
|
280 viewing. Either your "hsite.el" file should require hsys-w3 as part of
|
|
24
|
281 `hibtypes:begin-load-hook' or you should move point after the following line
|
|
0
|
282 and hit {C-x C-e} to evaluate it.
|
|
|
283
|
|
|
284 (progn (require 'w3) (require 'hsys-w3))
|
|
|
285
|
|
|
286 Now try using the Action Key on:
|
|
|
287
|
|
24
|
288 "http://www.infodock.com"
|
|
0
|
289
|
|
|
290 ** Grep, Occurrence, Debugger and Compiler Error Buttons, and Cscope Analyzer
|
|
|
291 Lines
|
|
|
292
|
|
24
|
293 The output of `grep -n', the UNIX line pattern matcher, can be
|
|
0
|
294 activated as buttons that jump to each matched line within its source
|
|
|
295 file; use {M-x grep RET}.
|
|
|
296
|
|
|
297 Compiler error messages also serve as implicit buttons that jump to
|
|
|
298 associated source lines; use {M-x compile RET}. GDB, DBX or XDB stack frames
|
|
|
299 along with GDB breakpoint listing lines also link to source lines.
|
|
|
300
|
|
|
301 {M-x occur RET} (find matches in a single buffer) and {M-x moccur RET}
|
|
|
302 (find matches across multiple buffers and files) also produce implicit
|
|
|
303 button output that displays associated source lines.
|
|
|
304
|
|
|
305 If you have the Cscope C/C++ code analyzer from the AT&T Toolchest and have
|
|
|
306 loaded the cscope.el library add-on for GNU Emacs, then the output lines from
|
|
|
307 a cscope query serve as implicit buttons which jump to associated source
|
|
|
308 lines. Cscope goes beyond the basic Emacs tags facility to allow you to see
|
|
|
309 the callers of a function and the functions called by a specific routine.
|
|
|
310
|
|
|
311 ** Annotated Bibliography Buttons
|
|
|
312
|
|
|
313 Here's a use of an annotated bibliography reference implicit button
|
|
|
314 which allows you to see a bibliography entry such as [Stallman 87] when
|
|
|
315 you activate the button between brackets.
|
|
|
316
|
|
|
317 ** Completion Buttons
|
|
|
318
|
|
|
319 Often when Emacs or Hyperbole prompts for an argument in the
|
|
|
320 minibuffer, a list of possible argument completions is available by
|
|
|
321 pressing {?}. A single Action Key press on any of these completions
|
|
|
322 inserts it into the minibuffer for your inspection. A second press on
|
|
|
323 the same completion causes it to be used as the argument value and any
|
|
|
324 succeeding argument prompt is then displayed. Test this technique
|
|
|
325 with a {C-x C-f} (find-file) and then a {?}.
|
|
|
326
|
|
|
327 ** Hyperbole Source Buttons
|
|
|
328
|
|
|
329 If you ask for help on the [Stallman 87] button, the first line of the
|
|
|
330 help buffer will look like this:
|
|
|
331
|
|
|
332 @loc> "DEMO"
|
|
|
333
|
|
|
334 except it will contain the full pathname of the file. If the button
|
|
|
335 were embedded within a buffer without an attached file, the first line
|
|
|
336 of the help buffer might look like:
|
|
|
337
|
|
|
338 @loc> #<buffer *scratch*>
|
|
|
339
|
|
|
340 If you click on the buffer name, the buffer will be displayed just as a
|
|
|
341 file buffer would. This type of implicit button is called a
|
|
24
|
342 `hyp-source' button.
|
|
0
|
343
|
|
|
344 You can also activate any explicit buttons shown in a help buffer.
|
|
|
345
|
|
|
346 ** UNIX Man Apropos Buttons
|
|
|
347
|
|
24
|
348 Below are some lines output by the UNIX `apropos' command (with a little
|
|
0
|
349 touchup for display purposes). A button activation anywhere within such
|
|
|
350 a line recognizes the line as an apropos entry and tries to display the
|
|
24
|
351 man page for the entry. Try it. (If you happen to use the `superman'
|
|
0
|
352 package which fetches man pages in the background, you'll have to wait
|
|
|
353 for the next version of superman which removes incompatibilities with
|
|
|
354 the standard man page fetch command before you can use these
|
|
24
|
355 `man-apropos' implicit buttons.)
|
|
0
|
356
|
|
|
357 grep, egrep, fgrep (1V) - search a file for a string or regular expression
|
|
|
358 rm, rmdir (1) - remove (unlink) files or directories
|
|
|
359 touch (1V) - update the access and modification times of a file
|
|
|
360 cat (1V) - concatenate and display
|
|
|
361
|
|
|
362 ** Internet Request For Comments (RFC) Document Browsing
|
|
|
363
|
|
|
364 If you are on the Internet and you have the ange-ftp or efs remote file
|
|
|
365 handling package for GNU Emacs, you can retrieve and browse RFC documents
|
|
|
366 used in Internet standard-making. Simply use the Action Key on an RFC
|
|
|
367 document identifier, like RFC-822. Rfc822 and rfc 822 work as well. The
|
|
24
|
368 `rfc' implicit button type provides this service. The `hpath:rfc' variable
|
|
0
|
369 specifies the location from which to retrieve RFCs.
|
|
|
370
|
|
|
371 Once you have retrieved an RFC, an Action Key press most anywhere within a
|
|
|
372 line typically will produce a table of contents summary of the RFC (via the
|
|
24
|
373 `rfc-toc' implicit button type). An Action Key press on any of the table of
|
|
0
|
374 contents lines then displays that section, for easy random access browsing.
|
|
|
375
|
|
|
376 ** Site-specific Online Library Document IDs
|
|
|
377
|
|
|
378 Hyperbole offers a powerful, yet easy to use facility for building online
|
|
24
|
379 libraries through the use of the `doc-id' implicit button type. A document id
|
|
0
|
380 is used just like a reference citation in traditional publications but
|
|
|
381 it actually links to the document that it references and the card catalog
|
|
|
382 (index) entry for the document. One can easily pass around doc ids to point
|
|
|
383 people to appropriate documents. For example, a mail message in response to
|
|
|
384 a question might say, "See [Emacs-001] for examples of what Emacs can do."
|
|
|
385
|
|
|
386 Since the format and handling of document identifiers and their index entries
|
|
|
387 is site-specific, document id handling is not completely configured in a
|
|
|
388 default Hyperbole configuration. If you wish to setup this facility for
|
|
|
389 site or personal use, see the DESCRIPTION section in "hib-doc-id.el" for
|
|
|
390 installation and use information.
|
|
|
391
|
|
|
392
|
|
|
393 * Smart Mouse Keys
|
|
|
394
|
|
|
395 If you use Emacs with mouse support under the X window system, NeXTstep,
|
|
|
396 OpenWindows, SunView, or Apollo's DM window system, Hyperbole automatically
|
|
|
397 configures your mouse keys for use as Smart Keys and provides additional
|
|
|
398 display-oriented operations as demonstrated here.
|
|
|
399
|
|
|
400 See the Hyperbole menu item, Doc/SmartKy, for a summary of all Smart Key
|
|
|
401 operations. For extensive details on Smart Key operation, see the Hyperbole
|
|
|
402 manual section, "(hyperbole.info)Smart Key Reference".
|
|
|
403
|
|
|
404 When Hyperbole is installed, a key may be bound which allows you to
|
|
|
405 switch between the Smart Key mouse bindings and your prior ones. `C-h w
|
|
|
406 hmouse-toggle-bindings RTN' should show you any key which performs this
|
|
|
407 command. If no key binding has been established or if you prefer one of
|
|
|
408 your own, simply select a key and bind it within your "~/.emacs" file.
|
|
|
409 For example, (global-set-key "\C-ct" 'hmouse-toggle-bindings).
|
|
|
410
|
|
|
411
|
|
|
412 ** Context-sensitive Help
|
|
|
413
|
|
|
414 Since the Smart Keys perform different operations in different contexts, it
|
|
|
415 is important to have context-sensitive help available. The earlier section
|
|
|
416 on Help Buffers explained how to display such help from the keyboard. The
|
|
|
417 same help can be displayed using the mouse by depressing the Smart Key for
|
|
|
418 which you want help, performing any action necessary to register a context,
|
|
|
419 such as a drag motion, and then pressing the other Smart Key.
|
|
|
420
|
|
|
421 Here is an example. Depress the Action Key somewhere within this paragraph
|
|
|
422 and while holding it down, depress the Assist Key. Then release the keys in
|
|
|
423 any order and the help display will pop up. It explains that there was no
|
|
|
424 particular matching Smart Key context, so a default operation is performed
|
|
24
|
425 (the value of the variable `action-key-default-function' determines the
|
|
0
|
426 operation performed).
|
|
|
427
|
|
|
428 ** Scrolling to the Beginning and End of Buffers
|
|
|
429
|
|
|
430 A left to right horizontal drag of the Action Key of 5 or more characters
|
|
|
431 scrolls the current buffer to its end (what {M->} does by default). A right
|
|
|
432 to left drag of the Action Key does the opposite; it scrolls to the buffer's
|
|
|
433 beginning (what {M-<} does by default). Try out these operations and then
|
|
|
434 use the Smart Key end of line scrolling capability to return here.
|
|
|
435
|
|
|
436 ** Creating and Deleting Windows
|
|
|
437
|
|
|
438 Horizontal and vertical drags of the Assist Key within a single window can be
|
|
|
439 used to create and delete Emacs windows.
|
|
|
440
|
|
|
441 A horizontal drag of five or more characters from left to right creates a new
|
|
|
442 window by splitting the current window into two windows, one on top of the
|
|
|
443 other. A horizontal drag from right to left deletes the current window. A
|
|
|
444 vertical drag in either direction splits the current window into two
|
|
|
445 side-by-side windows.
|
|
|
446
|
|
|
447 Let's try these. Remember to use your Assist Key. You need only move your
|
|
|
448 mouse pointer a few characters to register a drag. First, split this window
|
|
|
449 with a left to right drag, then delete either one of the windows with a right
|
|
|
450 to left drag.
|
|
|
451
|
|
|
452 Now try a side-by-side window split. Drag vertically in the up or down
|
|
|
453 direction three or more lines to split the window and then use a right to
|
|
|
454 left drag to delete either one of the side-by-side windows.
|
|
|
455
|
|
|
456 ** Resizing Windows
|
|
|
457
|
|
|
458 You can easily resize Emacs windows by dragging their window separators
|
|
|
459 (modelines or vertical side lines) within a frame. Simply depress either
|
|
|
460 Smart Key on a modeline or near a window side, hold it down while you drag to
|
|
|
461 a new location and then release. The window separator will then jump to the
|
|
|
462 location of release. Basically, just drag the window separator to where you
|
|
|
463 want it. If you want a single window to fill an entire frame, drag its
|
|
|
464 modeline, and if necessary its side, to the edge of the frame.
|
|
|
465
|
|
|
466 Did you follow all that? Let's try it to be sure. First, you need at least
|
|
|
467 two windows, so create a new one with the drag techniques you just learned.
|
|
|
468 Now drag with either Smart Key from the shared window edge to a new location.
|
|
|
469 See how both windows change size?
|
|
|
470
|
|
|
471 Try to drag the bottom modeline. You see that you can't.
|
|
|
472
|
|
|
473 ** Swapping Buffers
|
|
|
474
|
|
|
475 Swapping buffer locations is quick and easy with Hyperbole. Simply drag
|
|
|
476 from one window to another with the Assist Key.
|
|
|
477
|
|
|
478 Split the current window into two, one above the other. Drag the upper
|
|
|
479 modeline so that one window is clearly bigger than the other. Now try
|
|
|
480 dragging from inside one window to another with the Assist Key.
|
|
|
481
|
|
|
482 ** Modeline Clicks
|
|
|
483
|
|
|
484 Window modelines are treated specially be Hyperbole. They are broken up into
|
|
|
485 three regions, each with their own Smart Key operations. The regions are:
|
|
|
486 the left edge, the right edge, and the middle portion (the non-edge part of
|
|
|
487 the modeline). The edge regions are the left or rightmost three characters
|
|
|
488 of the modeline, by default.
|
|
|
489
|
|
|
490 *** Switching to Another Buffer
|
|
|
491
|
|
|
492 An Action Key click in the left edge of a modeline buries the current buffer,
|
|
|
493 i.e. puts it on the bottom of the buffer list and removes it from view, if it
|
|
|
494 is not the only available buffer. An Assist Key click in the left edge of a
|
|
|
495 modeline unburies the bottom buffer. Repeated clicks of either key allow you
|
|
|
496 to cycle through buffers to get to the one you want. Try this out.
|
|
|
497
|
|
|
498 *** Displaying Documentation
|
|
|
499
|
|
|
500 An Action Key click in the right edge of a modeline displays the Info manual
|
|
|
501 browsing system, see "(info)". Once in Info, you can click with your Action
|
|
|
502 Key to follow menu items, cross references, or to jump to Info nodes
|
|
|
503 referenced within the top header line of a node. Try browsing a bit and
|
|
|
504 while in Info display context-sensitive help for both the Action and Assist
|
|
|
505 Keys to see all that they can do.
|
|
|
506
|
|
|
507 If you click again with the Action Key on the right edge of the window
|
|
|
508 displaying Info, it will hide the Info buffer. Thus, it works as a toggle to
|
|
|
509 display or to hide the Info buffer. Try it.
|
|
|
510
|
|
|
511 A click of the Assist Key at the right edge of a modeline toggles between
|
|
|
512 display and removal of a Smart Key operation summary. To remove the summary,
|
|
|
513 you must click on the modeline of the window displaying the summary.
|
|
|
514
|
|
|
515
|
|
|
516 *** Buffer Menu Display
|
|
|
517
|
|
|
518 An Action Key click in the center portion of a modeline displays a buffer
|
|
|
519 menu, a summary of available buffers. An Action Key click on any buffer menu
|
|
|
520 line then displays that buffer.
|
|
|
521
|
|
|
522 This behavior is subject to change in the future if a more useful Action Key
|
|
|
523 operation is found for the middle of modelines.
|
|
|
524
|
|
|
525
|
|
|
526 ** Saving and Restoring Window Configurations
|
|
|
527
|
|
|
528 A window configuration consists of the set of windows within a single Emacs
|
|
|
529 frame. This includes their locations, buffers, and scrolled positions of
|
|
|
530 their buffers.
|
|
|
531
|
|
|
532 Hyperbole allows you to save and restore window configurations with simple
|
|
|
533 diagonal mouse drags within a single window. A diagonal drag in any
|
|
|
534 direction of the Action Key saves the current window configuration to a ring
|
|
|
535 of window configurations, just like the Emacs text kill ring. (See
|
|
|
536 "(Emacs)Kill Ring".) Each diagonal drag in any direction of the Assist Key
|
|
|
537 restores a prior saved window configuration from the ring. Window
|
|
|
538 configurations are restored in reverse order of the way they were saved.
|
|
|
539 Since a ring is circular, after the oldest element is restored, the newest
|
|
|
540 element will again be restored and so on.
|
|
|
541
|
|
|
542 If these operations are unclear to you, just forget about them and move on.
|
|
|
543 They are not necessary to enjoy the rest of Hyperbole. Otherwise, give them
|
|
|
544 a try by creating various window configurations and then saving and restoring
|
|
|
545 them.
|
|
|
546
|
|
|
547 * Outliner
|
|
|
548
|
|
|
549 The Hyperbole outliner only works under GNU Emacs version 19 or higher and
|
|
|
550 XEmacs version 19.9 or higher. You can tell whether you are running a
|
|
|
551 version of Emacs which supports the outliner by hitting
|
|
|
552 @{@kbd{C-h h}@} to display the Hyperbole menu. If you see an
|
|
|
553 @code{Otl/} entry in the menu, then the outliner is available.
|
|
|
554 Otherwise, the outliner does not work with your version of Emacs, so
|
|
|
555 this section of the DEMO will not be of interest to you.
|
|
|
556
|
|
|
557 The Hyperbole outliner produces structured, autonumbered documents
|
|
|
558 composed of hierarchies of cells. Each cell has two identifiers, a
|
|
|
559 relative autonumber indicating its present position within the outline
|
|
|
560 and a permanent identifier suitable for use within hyperlink references
|
|
|
561 to the cell.
|
|
|
562
|
|
|
563 If the outliner works in your Emacs, see "kotl/EXAMPLE.kotl", an outline file
|
|
|
564 that explains how to operate the outliner. Use the @code{Otl/Example} menu
|
|
|
565 entry to display this file. Additional documentation can be found in
|
|
|
566 "(hyperbole.info)Outliner". "(hyperbole.info)Outliner Keys"
|
|
|
567 summarizes in alphabetical order the outliner commands which are bound
|
|
|
568 to keys.
|
|
|
569
|
|
|
570
|
|
|
571 * References
|
|
|
572
|
|
|
573 [Stallman 87] Stallman, Richard. GNU Emacs Manual. Free Software
|
|
|
574 Foundation, Cambridge: MA, March 1987.
|
|
|
575
|
|
|
576 * THE END
|
