|
100
|
1 # See "hversion.el" for the Hyperbole lisp code directory entry.
|
|
0
|
2 #
|
|
|
3 # FILE: README
|
|
100
|
4 # SUMMARY: Information Hyperbole users and maintainers should read.
|
|
0
|
5 #
|
|
|
6 # AUTHOR: Bob Weiner
|
|
|
7 #
|
|
100
|
8 # ORG: InfoDock Associates. We sell corporate support and development
|
|
|
9 # contracts for InfoDock, Emacs and XEmacs.
|
|
|
10 # E-mail: <info@infodock.com> Web: http://www.infodock.com
|
|
|
11 # Tel: +1 408-243-3300
|
|
|
12 #
|
|
0
|
13 # ORIG-DATE: 19-Oct-91 at 03:27:47
|
|
100
|
14 # LAST-MOD: 21-Feb-97 at 18:04:41 by Bob Weiner
|
|
|
15 #
|
|
|
16 # See the Copyright section below for license information.
|
|
70
|
17
|
|
100
|
18 We thank Motorola Inc. for sponsoring our initial development work on
|
|
|
19 Hyperbole.
|
|
0
|
20
|
|
100
|
21 We hope you enjoy using and developing with Hyperbole. Suggestions
|
|
|
22 and bug reports are welcome, as described later in this document.
|
|
|
23 Feel free to mail or post news containing this file wherever it may be
|
|
|
24 of use.
|
|
0
|
25
|
|
|
26
|
|
|
27 ===========================================================================
|
|
|
28 * Table of Contents
|
|
|
29 ===========================================================================
|
|
|
30 * Hyperbole Overview
|
|
|
31 * What's New
|
|
|
32 * How to Obtain
|
|
|
33 * Installation / Configuration
|
|
|
34 * Quick Reference
|
|
|
35 * Mail Lists
|
|
|
36 * User Quotes
|
|
|
37 * Why was Hyperbole developed?
|
|
|
38 * Copyright
|
|
|
39
|
|
|
40
|
|
|
41 ===========================================================================
|
|
|
42 * Hyperbole Overview
|
|
|
43 ===========================================================================
|
|
|
44
|
|
|
45 Hyperbole is an open, efficient, programmable information management and
|
|
|
46 hypertext system. It is intended for everyday work on any UNIX platform
|
|
|
47 supported by GNU Emacs. It works well with the versions of Emacs that
|
|
100
|
48 support MS-Windows, X or NEXTSTEP windows: XEmacs and GNU Emacs.
|
|
|
49
|
|
|
50 Hyperbole allows hypertext buttons to be embedded within unstructured and
|
|
|
51 structured files, mail messages and news articles. It offers intuitive
|
|
|
52 mouse-based control of information display within multiple windows. It also
|
|
|
53 provides point-and-click access to Info manuals, ftp archives, Wide-Area
|
|
|
54 Information Servers (WAIS), and the World-Wide Web (WWW) hypertext system
|
|
|
55 through encapsulations of software that support these protocols.
|
|
0
|
56
|
|
|
57 Hyperbole consists of four parts:
|
|
|
58
|
|
|
59 1. Info Management: an interactive information management interface,
|
|
|
60 including a powerful rolodex, which anyone can use. It is easy
|
|
|
61 to pick up and use since it introduces only a few new mechanisms
|
|
|
62 and provides user-level facilities through a menu interface,
|
|
|
63 which you control from the keyboard or the mouse;
|
|
|
64
|
|
|
65 2. Hypertext Outliner: an outliner with multi-level autonumbering
|
|
|
66 and permanent ids attached to each outline node for use as
|
|
|
67 hypertext link anchors, plus flexible view specifications that
|
|
|
68 can be embedded within links or used interactively;
|
|
|
69
|
|
|
70 3. Button Types: A set of hyper-button types that provides
|
|
|
71 core hypertext and other behaviors. Users can make simple
|
|
|
72 changes to button types and those familiar with Emacs Lisp can
|
|
|
73 quickly prototype and deliver new types;
|
|
|
74
|
|
|
75 4. Programming Library: a set of programming library classes for
|
|
|
76 system developers who want to integrate Hyperbole with another
|
|
|
77 user interface or as a back-end to a distinct system. (All of
|
|
|
78 Hyperbole is written in Emacs Lisp for ease of modification.
|
|
|
79 Although Hyperbole was initially designed as a prototype, it has
|
|
|
80 been engineered for real-world usage and is well structured.)
|
|
|
81
|
|
|
82 A Hyperbole user works with buttons; he may create, modify,
|
|
|
83 move or delete buttons. Each button performs a specific action, such as
|
|
|
84 linking to a file or executing a shell command.
|
|
|
85
|
|
|
86 There are three categories of Hyperbole buttons:
|
|
|
87
|
|
|
88 1. Explicit Buttons
|
|
|
89 created by Hyperbole, accessible from within a single document;
|
|
|
90
|
|
|
91 2. Global Buttons
|
|
|
92 created by Hyperbole, accessible anywhere within a user's
|
|
|
93 network of documents;
|
|
|
94
|
|
|
95 3. Implicit Buttons
|
|
|
96 buttons created and managed by other programs or embedded
|
|
|
97 within the structure of a document, accessible from within a
|
|
|
98 single document. Hyperbole recognizes implicit buttons by
|
|
|
99 contextual patterns given in their type specifications.
|
|
|
100
|
|
|
101 Hyperbole buttons may be clicked upon with a mouse to activate them or
|
|
|
102 to describe their actions. Thus, a user can always check how a button
|
|
|
103 will act before activating it. Buttons may also be activated from a
|
|
|
104 keyboard. (In fact, virtually all Hyperbole operations, including menu
|
|
|
105 usage, may be performed from any standard character terminal interface, so
|
|
|
106 one need not be anchored to a workstation all day).
|
|
|
107
|
|
|
108 Hyperbole does not enforce any particular hypertext or information management
|
|
|
109 model, but instead allows you to organize your information in large or small
|
|
|
110 chunks as you see fit. The Hyperbole outliner organizes information
|
|
|
111 hierarchies which may also contain links to external information sources.
|
|
|
112
|
|
|
113 Some of Hyperbole's most important features include:
|
|
|
114
|
|
|
115 Buttons may link to information or may execute procedures, such as
|
|
|
116 starting or communicating with external programs;
|
|
|
117
|
|
|
118 One simply drags between a button source location and a link destination
|
|
|
119 to create or to modify a link button. The same result can be achieved
|
|
|
120 from the keyboard.
|
|
|
121
|
|
|
122 Buttons may be embedded within electronic mail messages;
|
|
|
123
|
|
|
124 Outlines allow rapid browsing, editing and movement of chunks of
|
|
|
125 information organized into trees (hierarchies);
|
|
|
126
|
|
|
127 Other hypertext and information retrieval systems may be
|
|
|
128 encapsulated under a Hyperbole user interface (a number of samples
|
|
|
129 are provided).
|
|
|
130
|
|
|
131 Typical Hyperbole applications include:
|
|
|
132
|
|
|
133 Personal Information Management
|
|
|
134 Overlapping link paths provide a variety of views into an
|
|
|
135 information space.
|
|
|
136
|
|
|
137 A search facility locates buttons in context and permits quick
|
|
|
138 selection.
|
|
|
139
|
|
|
140 Documentation Browsing
|
|
|
141 Embed cross-references in your favorite documentation format.
|
|
|
142
|
|
|
143 Add a point-and-click interface to existing documentation.
|
|
|
144
|
|
|
145 Link code and design documents. Jump to the definition of an
|
|
|
146 identifier from its use within code or its reference within
|
|
|
147 documentation.
|
|
|
148
|
|
|
149 Brainstorming
|
|
|
150 Capture ideas and then quickly reorganize them with the Hyperbole
|
|
|
151 outliner. Link to related ideas, eliminating the need to copy
|
|
|
152 and paste information into a single place.
|
|
|
153
|
|
|
154 Help/Training Systems
|
|
|
155 Create tutorials with embedded buttons that show students how
|
|
|
156 things work while explaining the concepts, e.g. an introduction
|
|
|
157 to UNIX commands. This technique can be much more effective than
|
|
|
158 descriptions alone.
|
|
|
159
|
|
|
160 Archive Managers
|
|
|
161 Supplement programs that manage archives from incoming
|
|
|
162 information streams by having them add topic-based buttons that
|
|
|
163 link to the archive holdings. Users can then search and create
|
|
|
164 their own links to archive entries.
|
|
|
165
|
|
|
166
|
|
|
167 ===========================================================================
|
|
100
|
168 * What's New in V4.02 and V4.021
|
|
0
|
169 ===========================================================================
|
|
|
170
|
|
|
171 (See "ChangeLog" for more complete details of changes.)
|
|
|
172
|
|
|
173 ACTION AND ASSIST KEYS
|
|
|
174
|
|
100
|
175 - Support for new ID-edit mode (a part of InfoDock) that allows rapid,
|
|
|
176 cutting, copying and yanking of regions plus fast display management.
|
|
|
177 In this mode, the Action and Assist keys yank the previously selected
|
|
|
178 region at point.
|
|
0
|
179
|
|
100
|
180 - An Action Key press on a Java identifier jumps to its definition
|
|
|
181 (if an associated TAGS file or OO-Browser environment exists). The
|
|
|
182 same is true for an `@see' cross-reference within a Java comment. The
|
|
|
183 variable, `smart-java-package-dirs,' determines where Java package
|
|
|
184 source can be found when the OO-Browser is not in use.
|
|
0
|
185
|
|
100
|
186 - An Action Key press on a double or single quoted Emacs Lisp filename
|
|
|
187 (without any path) displays the file by looking for it among the
|
|
|
188 directories in the variable, `load-path'.
|
|
0
|
189
|
|
100
|
190 - If the Action Key is pressed on a function identifier that is defined
|
|
|
191 in the same buffer as the reference clicked upon, it will now be
|
|
|
192 displayed faster, since the func-menu package will be used. The
|
|
|
193 reference identifier will also flash when pressed, if the display
|
|
|
194 device supports this.
|
|
0
|
195
|
|
|
196 EMACS VERSIONS
|
|
|
197
|
|
100
|
198 - Further support for MS-DOS, Windows NT Emacs 19, and Win-Emacs.
|
|
0
|
199
|
|
100
|
200 - Fixed configuration setup problem when running Emacs 19 on a dumb
|
|
|
201 terminal.
|
|
0
|
202
|
|
|
203 KOUTLINER
|
|
|
204
|
|
100
|
205 - XEmacs 19.14 and above: Fixed display of current viewspec in the
|
|
|
206 modeline to accomodate modeline extents (specialized modeline regions).
|
|
|
207 This eliminated an error that occurred when reading in an Koutline file.
|
|
0
|
208
|
|
100
|
209 - Fixed bug that prevented installation of Koutliner mode-specific
|
|
|
210 menubar when running InfoDock.
|
|
0
|
211
|
|
100
|
212 MENUS
|
|
0
|
213
|
|
100
|
214 - New Hyperbole/About menu item added. In minibuffer menus, this item is
|
|
|
215 found under the Doc/ menu.
|
|
0
|
216
|
|
100
|
217 - New window system menu, Hyperbole/Customization (and minibuffer menu,
|
|
|
218 Cust/) added to set Hyperbole options, including where Hyperbole link
|
|
|
219 referents are displayed, where URLs are displayed and whether to use
|
|
|
220 proportional or windowful scrolling when a Smart Key is pressed at the
|
|
|
221 end of a line.
|
|
0
|
222
|
|
100
|
223 - The default setting of where Hyperbole link references are displayed
|
|
|
224 may be set in "hsite.el" via the variable, `hpath:display-where'
|
|
|
225 (after Hyperbole has been installed using `make install').
|
|
|
226 See its documentation for detail.
|
|
0
|
227
|
|
100
|
228 - The Hyperbole/Global-Button menu now includes a menu item that will
|
|
|
229 activate each existing global button. The Hyperbole/Explicit-Button
|
|
|
230 menu does the same thing for explicit buttons in the current buffer.
|
|
0
|
231
|
|
|
232 ROLODEX
|
|
|
233
|
|
100
|
234 - Rolo-edit, bound to {e} in the rolodex match buffer, now works properly
|
|
|
235 if the rolodex is loaded before the rest of the Hyperbole system.
|
|
36
|
236
|
|
0
|
237
|
|
|
238 ===========================================================================
|
|
|
239 * How to Obtain
|
|
|
240 ===========================================================================
|
|
|
241
|
|
100
|
242 InfoDock Associates, the developer of Hyperbole and InfoDock (an industrial
|
|
|
243 quality turn-key version of XEmacs), is a firm dedicated to radical
|
|
|
244 productivity improvement in technical environments, whether in software
|
|
|
245 development or other knowledge intensive disciplines. Our initial offerings
|
|
|
246 include high quality commercial support, training, books and custom package
|
|
|
247 development for InfoDock, XEmacs or GNU Emacs on a variety of platforms.
|
|
|
248 InfoDock provides a modern user interface on top of Emacs, information
|
|
|
249 management, and powerful software development tools, all in one package.
|
|
0
|
250
|
|
100
|
251 Contact us at <info@infodock.com> or visit our web site at
|
|
|
252 http://www.infodock.com.
|
|
|
253
|
|
|
254 Hyperbole is available as part of InfoDock or XEmacs and also as a standalone
|
|
|
255 package via anonymous ftp across the Internet. Do not send requests to have
|
|
|
256 it mailed to you since it won't be. Instead have another party who has
|
|
|
257 Internet access obtain it for the both of you.
|
|
0
|
258
|
|
|
259 Here is how to obtain Hyperbole as a standalone package on the Internet:
|
|
|
260
|
|
|
261 Move to a directory below which you want the 'hyperbole' directory to
|
|
|
262 be created. Unpacking the Hyperbole archive will create this
|
|
|
263 directory and place all of the files below it.
|
|
|
264
|
|
|
265 cd <LOCAL-LISP-DIR>
|
|
|
266
|
|
|
267 Ftp to ftp.xemacs.org (Internet Host ID = 128.174.252.16):
|
|
|
268
|
|
100
|
269 prompt> ftp ftp.xemacs.org (If this doesn't work, try `ftp xemacs.org'.)
|
|
0
|
270
|
|
|
271 Login as 'anonymous' with your own <user-id>@<site-name> as a password.
|
|
|
272
|
|
|
273 Name (ftp.xemacs.org): anonymous
|
|
|
274 331 Guest login ok, send EMAIL address (e.g. user@host.domain) as password.
|
|
|
275 Password:
|
|
|
276 230 Guest login ok, access restrictions apply.
|
|
|
277
|
|
|
278 Move to the Hyperbole directory:
|
|
|
279
|
|
100
|
280 ftp> cd /pub/infodock
|
|
0
|
281
|
|
|
282 Set your transfer mode to binary:
|
|
|
283
|
|
|
284 ftp> bin
|
|
|
285 200 Type set to I.
|
|
|
286
|
|
|
287 Turn off prompting:
|
|
|
288
|
|
|
289 ftp> prompt
|
|
|
290 Interactive mode off.
|
|
|
291
|
|
|
292 Retrieve just the Hyperbole archive and any diff-based patches (there may not
|
|
|
293 be any patches):
|
|
|
294
|
|
|
295 ftp> mget hyperbole*
|
|
|
296
|
|
|
297 Close the ftp connection:
|
|
|
298
|
|
|
299 ftp> quit
|
|
|
300 221 Goodbye.
|
|
|
301
|
|
|
302 Unpack the tar archive using the GNU version of the 'zcat' program:
|
|
|
303
|
|
|
304 zcat h*tar.gz | tar xvf -
|
|
|
305 or
|
|
|
306 gunzip h*tar.gz; tar xvf h*tar
|
|
|
307
|
|
|
308 Apply any patches you retrieved, also:
|
|
|
309
|
|
|
310 cd hyperbole; patch < <patch-file>
|
|
|
311
|
|
|
312
|
|
|
313 ===========================================================================
|
|
|
314 * Installation / Configuration
|
|
|
315 ===========================================================================
|
|
|
316
|
|
|
317 The following explains how to Use the Hyperbole "Makefile" to compile any
|
|
|
318 needed code, to generate the "hsite.el" file used for site-specific Hyperbole
|
|
|
319 customization, and to produce printable documentation.
|
|
|
320
|
|
|
321 Edit the line near the top of "Makefile" that represents the emacs version
|
|
|
322 that you use, so that it corresponds to the emacs executable name used on
|
|
|
323 your system. Then immediatly below there, set the EMACS variable to the
|
|
|
324 variable name for the emacs that you will use to compile the Hyperbole Lisp
|
|
|
325 files.
|
|
|
326
|
|
|
327 You may also have to set the SITE-PRELOADS variable defined further down
|
|
|
328 in the file; follow the instructions that precede the `SITE-PRELOADS ='
|
|
|
329 line. Make these changes now and save the Makefile.
|
|
|
330
|
|
|
331 To install Hyperbole for use with InfoDock, XEmacs, GNU Emacs or Epoch, from
|
|
|
332 a shell:
|
|
|
333
|
|
|
334 cd <HYPERBOLE-DIR>; make
|
|
|
335
|
|
|
336 All of the .elc compiled Lisp files are already built for XEmacs and V19, so
|
|
|
337 this build will finish very quickly. If you really want to rebuild all of
|
|
|
338 the .elc files, use:
|
|
|
339
|
|
|
340 cd <HYPERBOLE-DIR>; make all-elc
|
|
|
341
|
|
|
342 To produce the Postscript version of the Hyperbole manual:
|
|
|
343
|
|
|
344 cd <HYPERBOLE-DIR>; make ps
|
|
|
345
|
|
|
346 To install Hyperbole for use with GNU Emacs V18 or Epoch:
|
|
|
347
|
|
|
348 cd <HYPERBOLE-DIR>; make all-elc-v18
|
|
|
349
|
|
|
350 This will produce a complete set of Emacs V18 .elc files.
|
|
|
351
|
|
|
352 ----
|
|
|
353
|
|
|
354 The Hyperbole Manual is included in two forms:
|
|
|
355
|
|
|
356 "man/hyperbole.info" - online version
|
|
|
357 "man/hyperbole.texi" - source form
|
|
|
358
|
|
|
359 To add pointers to the Info version of the Hyperbole manual within your Info
|
|
|
360 directory, follow these instructions. If `Info-directory-list' is bound as a
|
|
|
361 variable within your Emacs, you can simply set it so that <HYPERBOLE-DIR> is
|
|
|
362 an element in the list. Otherwise, from a shell, cd to the directory given
|
|
|
363 by your 'Info-directory' variable and execute the following command:
|
|
|
364
|
|
|
365 (rm hyperbole.info*; cp <HYPERBOLE-DIR>/man/hyperbole.info* .)
|
|
|
366
|
|
|
367 Then add an Info menu entry for the Hyperbole manual in your Info "dir" file:
|
|
|
368 (the `*' should be placed in the first column of the file):
|
|
|
369
|
|
|
370 * Hyperbole:: GNU Emacs-based everyday information management system.
|
|
|
371 Use {C-h h d d} for a demonstration. Includes context-sensitive
|
|
|
372 mouse and keyboard support, a powerful rolodex, an autonumbered
|
|
|
373 outliner with hyperlink anchors for each outline cell, and extensible
|
|
|
374 hypertext facilities including hyper-links in mail and news messages.
|
|
|
375
|
|
|
376 ----
|
|
|
377
|
|
|
378 To set up so that all Emacs users have Hyperbole loaded for them, add the
|
|
|
379 following lines to a site initialization file such as "site-start.el".
|
|
|
380 Otherwise, each user will have to add these lines to his own "~/.emacs"
|
|
|
381 initialization file. The following instructions use the term
|
|
|
382 <HYPERBOLE-DIR>/ to refer to your hyperbole/ directory, so substitute your
|
|
|
383 own value.
|
|
|
384
|
|
|
385 To autoload Hyperbole so that it loads only when needed:
|
|
|
386
|
|
|
387 (defvar hyperb:dir "<HYPERBOLE-DIR>/")
|
|
|
388 "Directory where the Hyperbole executable code is kept.
|
|
|
389 It must end with a directory separator character.")
|
|
|
390
|
|
|
391 (load (expand-file-name "hversion" hyperb:dir))
|
|
|
392 (load (expand-file-name "hyperbole" hyperb:dir))
|
|
|
393
|
|
|
394 To fully load Hyperbole upon startup, add the additional line:
|
|
|
395
|
|
|
396 (require 'hsite)
|
|
|
397
|
|
|
398 That's all there is to the installation.
|
|
|
399
|
|
|
400 ----
|
|
|
401
|
|
|
402 Once Hyperbole has been installed for use at your site, you can invoke it
|
|
|
403 with {C-h h} or {M-x hyperbole RET} to bring up the Hyperbole main menu in
|
|
|
404 the minibuffer window.
|
|
|
405
|
|
|
406
|
|
|
407 ===========================================================================
|
|
|
408 * Quick Reference
|
|
|
409 ===========================================================================
|
|
|
410
|
|
|
411 "MANIFEST" summarizes most of the files in the distribution.
|
|
|
412
|
|
|
413 See "DEMO" for a demonstration of standard Hyperbole button
|
|
|
414 capabilities.
|
|
|
415
|
|
|
416 Naming conventions:
|
|
|
417
|
|
|
418 - All Hyperbole-specific code files begin with an 'h', aside from the
|
|
|
419 Koutliner files which are in the kotl/ subdirectory and begin with a 'k'.
|
|
|
420
|
|
|
421 - Hyperbole user-interface files begin with 'hui-' or 'hmous'.
|
|
|
422
|
|
|
423 - Files that define implicit button types begin with 'hib'.
|
|
|
424
|
|
|
425 - Encapsulations of foreign systems begin with 'hsys-'.
|
|
|
426
|
|
|
427 Most of the standard Emacs user interface for Hyperbole is located in
|
|
|
428 "hui.el". Most of the Hyperbole application programming interface can be
|
|
|
429 found in "hbut.el". "hbdata.el" encapsulates the button attribute storage
|
|
|
430 handling presently implemented by Hyperbole. "hmail.el" provides a basic
|
|
|
431 abstract interface for folding mail readers other than Rmail into Hyperbole.
|
|
|
432
|
|
|
433 See the "(hyperbole.info)Questions and Answers" appendix in the
|
|
|
434 Hyperbole manual for information on how to alter the default
|
|
|
435 context-sensitive Hyperbole key bindings.
|
|
|
436
|
|
|
437
|
|
|
438 ===========================================================================
|
|
|
439 * Mail Lists
|
|
|
440 ===========================================================================
|
|
|
441
|
|
|
442 There are several Hyperbole-related mail addresses. Learn what each is
|
|
|
443 for before you mail to any of them.
|
|
|
444
|
|
100
|
445 <hyperbole-request@infodock.com>
|
|
|
446 <hyperbole-announce-request@infodock.com>
|
|
0
|
447
|
|
|
448 ALL mail concerning administration of the Hyperbole mailing lists should
|
|
|
449 be sent to the appropriate one of these addresses. That includes
|
|
|
450 addition, change, or deletion requests. Don't consider sending such a
|
|
|
451 request to a Hyperbole mail list or people will wonder why you don't know
|
|
|
452 that all Internet mail lists have a -request address for administrative
|
|
|
453 requests.
|
|
|
454
|
|
100
|
455 Use the following formats in the *body* of your message to execute requests,
|
|
|
456 where you substitute your own values for the <> delimited items and items
|
|
|
457 enclosed in [] are optional.
|
|
0
|
458
|
|
100
|
459 subscribe <mail-list-name> [<your-email-address>]
|
|
|
460 or
|
|
|
461 unsubscribe <mail-list-name> [<your-email-address>]
|
|
0
|
462
|
|
|
463 For example:
|
|
|
464
|
|
100
|
465 To: hyperbole-request@infodock.com
|
|
|
466 Subject: Used if a human happens to read your mail.
|
|
|
467
|
|
|
468 subscribe hyperbole joe@nowhere.gov
|
|
0
|
469
|
|
100
|
470 To change your address, you must unsubscribe your old address with
|
|
|
471 once command and subscribe your new address with another command, though
|
|
|
472 you can embed multiple commands on separate lines within a single message.
|
|
|
473
|
|
0
|
474
|
|
|
475 There are two Hyperbole-related mail lists. Subscribe to one or the other,
|
|
|
476 not to both.
|
|
|
477
|
|
100
|
478 <hyperbole@infodock.com>
|
|
0
|
479
|
|
|
480 Mail list for discussion of all Hyperbole issues. Bug reports and
|
|
|
481 suggestions may also be sent here.
|
|
|
482
|
|
|
483 Always use your Subject and/or Summary: lines to state the position
|
|
|
484 that your message takes on the topic that it addresses, e.g. send
|
|
|
485 "Subject: Basic bug in top-level minibuffer menu." rather than
|
|
|
486 "Subject: Hyperbole bug". Statements end with periods, questions
|
|
|
487 with question marks (typically), and high energy, high impact
|
|
|
488 declarations with exclamation points. This simple rule makes all
|
|
|
489 e-mail communication much easier for recipients to handle
|
|
|
490 appropriately.
|
|
|
491
|
|
|
492 If you ask a question, your subject line should end with a '?',
|
|
|
493 e.g. "Subject: How can man page SEE ALSOs be made implicit buttons?" A
|
|
|
494 "Subject: Re: How can ..." then indicates an answer to the question.
|
|
|
495 Question messages should normally include your Hyperbole and Emacs version
|
|
|
496 numbers and clearly explain your problem and surrounding issues.
|
|
|
497 Otherwise, you will simply waste the time of those who may want to help
|
|
|
498 you. (Your top-level Hyperbole menu shows its version number and {M-x
|
|
|
499 emacs-version RET} gives the other.)
|
|
|
500
|
|
|
501 If you ask questions, you should consider adding to the discussion by
|
|
|
502 telling people the kinds of work you are doing or contemplating doing
|
|
|
503 with Hyperbole. In this way, the list will not be overwhelmed by
|
|
|
504 messages that ask for, but provide no information.
|
|
|
505
|
|
100
|
506 <hyperbole-announce@infodock.com>
|
|
0
|
507
|
|
|
508 Those who don't want to participate in the discussion but want to
|
|
|
509 hear about bug fixes and new releases of Hyperbole should subscribe
|
|
|
510 to this list. Anyone on the `hyperbole' list is automatically on
|
|
|
511 this one too, so there is no need to subscribe to this one in that
|
|
|
512 case. This list is for official fixes and announcements so don't send
|
|
|
513 your own fixes here. Send them to `hyperbole' instead.
|
|
|
514
|
|
|
515
|
|
|
516 ===========================================================================
|
|
|
517 * User Quotes
|
|
|
518 ===========================================================================
|
|
|
519
|
|
|
520
|
|
|
521 *** MAN I love Hyperbole!!! Wow! ***
|
|
|
522
|
|
|
523 -- Ken Olstad
|
|
|
524 Cheyenne Software, Inc.
|
|
|
525
|
|
|
526 -------
|
|
|
527
|
|
|
528 I *love* koutlines.
|
|
|
529
|
|
|
530 -- Bob Glickstein
|
|
|
531 Z-Code Software Corporation
|
|
|
532 -------
|
|
|
533
|
|
100
|
534 I've found Hyperbole (in conjunction with XEmacs) to be very useful
|
|
|
535 for signal processing algorithm development.
|
|
|
536
|
|
|
537 For me, it has almost completely obsoleted the engineering notebook:
|
|
|
538 I keep a set of files with ideas, algorithms, and results, linked
|
|
|
539 together and to the implementation in C++ files. Using XEmacs'
|
|
|
540 support for embedding graphics, I've written a mode that accepts
|
|
|
541 image tags (formatted like HTML), and reads in GIF files to display
|
|
|
542 plots. I have another program that converts the file to HTML (not
|
|
|
543 perfect, but adequate), so I can put any aspect of development on
|
|
|
544 our internal web for others to see.
|
|
|
545
|
|
|
546 -- Farzin Guilak
|
|
|
547 Protocol Systems, Inc., Engineer
|
|
|
548
|
|
|
549 -------
|
|
|
550
|
|
0
|
551 I am blind and have been using Hyperbole since 1992. I used to use a PC as
|
|
|
552 a talking terminal attached to a UNIX system, but then I developed
|
|
|
553 Emacspeak which lets me use Emacs and Hyperbole from standard UNIX
|
|
|
554 workstations with an attached voice synthesizer.
|
|
|
555
|
|
|
556 My main uses are:
|
|
|
557 1) Global and implicit buttons for jumping to ftp sites.
|
|
|
558 2) The rolodex with Emacspeak support.
|
|
|
559 3) Explicit buttons as part of comments made about a structured document.
|
|
|
560 Each button jumps to the document section referred to by the comment.
|
|
|
561 This is very, very useful.
|
|
|
562 4) The Hyperbole outliner, which I find a very useful tool. I've
|
|
|
563 implemented Emacspeak extensions to support it.
|
|
|
564
|
|
|
565 -- TV Raman
|
|
|
566 Digital Cambridge Research Lab
|
|
|
567
|
|
|
568 -------
|
|
|
569
|
|
|
570 I've been a grateful Hyperbole user for a few years now. Hyperbole's
|
|
|
571 flexibility and ease of use is a marvel.
|
|
|
572
|
|
|
573 Mainly, I write easy little implicit button types (and corresponding action
|
|
|
574 types) to make my life easier. For example, I have an implicit button type
|
|
|
575 to bury certain buffers when I click at their bottoms, one that recognizes
|
|
|
576 a bug report record in various contexts and edits it, one that links pieces
|
|
|
577 of test output in a log file to the corresponding test case source code
|
|
|
578 (EXTREMELY helpful in interpreting test output), others that support our
|
|
|
579 homegrown test framework, one that handles tree dired mode the way I'd
|
|
|
580 like, one that completely handles wico menus (I've also overloaded the
|
|
|
581 wconfig actions triggered by diagonal mouse drags with wicos actions), and
|
|
|
582 a couple that support interaction with BBDB.
|
|
|
583
|
|
|
584 Other than that, I keep a global button file with 30 or so explicit buttons
|
|
|
585 that do various little things, and I index saved mail messages by putting
|
|
|
586 explicit link-to-mail buttons in an outline file.
|
|
|
587
|
|
|
588 -- Ken Olstad
|
|
|
589 Cheyenne Software, Inc.
|
|
|
590
|
|
|
591 -------
|
|
|
592
|
|
|
593 In general, Hyperbole is an embeddable, highly extensible hypertext
|
|
|
594 tool. As such, I find it very useful. As it stands now, Hyperbole is
|
|
|
595 particularly helpful for organizing ill-structured or loosely coupled
|
|
|
596 information, in part because there are few tools geared for this purpose.
|
|
|
597 Hyperbole also possesses a lot of potentials in supporting a wider
|
|
|
598 spectrum of structuredness, ranging from unstructured to highly
|
|
|
599 structured environments, as well as structural changes over time.
|
|
|
600
|
|
|
601 Major Uses:
|
|
|
602
|
|
|
603 * Menu interface to our own Epoch-based collaborative support environment
|
|
|
604 called CoReView: This interface brings together all top-level user
|
|
|
605 commands into a single partitioned screen, and allows the end user to
|
|
|
606 interact with the system using simple mouse-clicking instead of the
|
|
|
607 meta-x key.
|
|
|
608
|
|
|
609 * Gateway to internet resources: this includes links to major Internet
|
|
|
610 archive sites of various types of information. Links are made at both
|
|
|
611 directory and file levels.
|
|
|
612
|
|
|
613 * Alternative directory organizer: The hierarchical nature of the Unix
|
|
|
614 file system sometimes makes it difficult to find things quickly and
|
|
|
615 easily using directory navigational tools such as dired. Hyperbole
|
|
|
616 enables me to create various "profile" views of my directory tree, with
|
|
|
617 entries in these views referring to files anywhere in the hierarchy.
|
|
|
618
|
|
|
619 * Organizing and viewing online documentation: using Hyperbole along with
|
|
|
620 Hyper-man and Info makes it truly easy to look up online documentation.
|
|
|
621
|
|
|
622 * Other desktop organization tasks: including links to various mail
|
|
|
623 folders, saved newsgroup conversation threads, online note-taker,
|
|
|
624 emacs-command invocations, etc.
|
|
|
625
|
|
|
626 -- Dadong Wan
|
|
|
627
|
|
|
628 -------
|
|
|
629
|
|
|
630 Hyperbole is the first hyper-link system I've run across that is
|
|
|
631 actually part of the environment I use regularly, namely Emacs. The
|
|
|
632 complete flexibility of the links is both impressive and expected -- the
|
|
|
633 idea of making the link itself programmable is clever, and given that one
|
|
|
634 assumes the full power of Emacs. Being able to send email with buttons
|
|
|
635 in it is a very powerful capability. Using ange-ftp mode, one can make
|
|
|
636 file references "across the world" as easily as normal file references.
|
|
|
637
|
|
|
638 -- Mark Eichin
|
|
|
639 Cygnus Support
|
|
|
640 -------
|
|
|
641
|
|
|
642 I just wanted to say how much I enjoy using the Hyperbole outliner.
|
|
|
643 It is a great way to quickly construct very readable technical documents
|
|
|
644 that I can pass around to others. Thanks for the great work.
|
|
|
645
|
|
|
646 -- Jeff Fried
|
|
|
647 Informix
|
|
|
648
|
|
|
649 -------
|
|
|
650
|
|
|
651 The Hyperbole system provides a nice interface to exploring corners of
|
|
|
652 Unix that I didn't know existed before.
|
|
|
653
|
|
|
654 -- Craig Smith
|
|
|
655
|
|
|
656 -------
|
|
|
657
|
|
|
658
|
|
|
659 ===========================================================================
|
|
|
660 * Why was Hyperbole developed?
|
|
|
661 ===========================================================================
|
|
|
662
|
|
|
663 Hyperbole has been designed to aid in research aimed at Personalized
|
|
|
664 Information production/retrieval Environments (PIEs). Hyperbole is a
|
|
|
665 PIE Manager that provides services to PIE Tools. PIEmail, a mail reader is
|
|
|
666 the only PIE Tool developed to date.
|
|
|
667
|
|
|
668 An examination of many hypertext environments as background research did
|
|
|
669 not turn up any that seemed suitable for the research envisioned, mainly
|
|
|
670 due to the lack of rich, portable programmer and user environments. We also
|
|
|
671 tired of trying to manage our own distributed information pools with standard
|
|
|
672 UNIX tools. And so Hyperbole was conceived and raved about until it
|
|
|
673 got its name.
|
|
|
674
|
|
|
675
|
|
|
676 ===========================================================================
|
|
|
677 * Copyright
|
|
|
678 ===========================================================================
|
|
|
679
|
|
|
680 The following copyright applies to the Hyperbole system as a whole.
|
|
|
681
|
|
100
|
682 Copyright (C) 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996 Free Software Foundation, Inc.
|
|
0
|
683
|
|
|
684 Available for use and distribution under the terms of the GNU Public License,
|
|
|
685 version 2 or higher.
|
|
|
686
|
|
|
687 Hyperbole is free software; you can use it, redistribute it and/or modify it
|
|
|
688 without fee under the terms of the GNU General Public License as published by
|
|
|
689 the Free Software Foundation; either version 2, or (at your option) any later
|
|
|
690 version.
|
|
|
691
|
|
|
692 Hyperbole is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
|
693 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
|
|
694 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
695
|
|
100
|
696 InfoDock Associates sells support and development services for this package
|
|
|
697 and most other aspects of Emacs or InfoDock. Contact information is at the
|
|
|
698 top of this file.
|
|
|
699
|
|
70
|
700 You should have received a copy of the GNU General Public License
|
|
100
|
701 along with GNU Emacs, XEmacs or InfoDock; see the file COPYING. If
|
|
|
702 not, write to the Free Software Foundation, 675 Mass Ave, Cambridge,
|
|
|
703 MA 02139, USA.
|
