GNU Hyperbole Manual
The Everyday Hypertextual Information Manager
Bob Weiner
This manual is for GNU Hyperbole (Edition 6.0.2, Published August 9, 2016).
c 1989-2016 Free Software Foundation, Inc.
Copyright Permission is granted to copy, distribute and/or modify this document under
the terms of the GNU Free Documentation License, Version 1.3 or any later
version published by the Free Software Foundation.
GNU Hyperbole sofware is distributed under the terms of the GNU General
Public License version 3 or later, as published by the Free Software Foundation,
Inc.
GNU Hyperbole is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY, without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details in the file, “COPYING”,
within the Hyperbole package directory.
Published by the Free Software Foundation, Inc.
Author:
Bob Weiner
E-mail:
<[email protected]> (This is a mail list).
Web:
www.gnu.org/software/hyperbole
The body of the manual was written in Emacs and laid out using the GNU Texinfo markup
language.
i
Short Contents
GNU Hyperbole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2
Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3
4
Smart Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
5
HyControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
6
Koutliner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
7
8
HyRolo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Window Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
9
Developing with Hyperbole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
A
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
B
C
Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Global Key Bindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
D
Koutliner Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
E
Smart Key Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
F
G
Suggestion or Bug Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Questions and Answers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
H
Future Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
I
References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Key Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Function, Variable and File Index . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Concept Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
ii
Table of Contents
GNU Hyperbole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1
1.2
1.3
1.4
2
Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.1
2.2
2.3
2.4
2.5
2.6
2.7
3
Manual Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Motivation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Hyperbole Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Mail Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Explicit Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Global Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Implicit Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Button Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Action Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Button Type Precedence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Utilizing Explicit Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.7.1 Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.7.1.1 Creation Via Action Key Drags . . . . . . . . . . . . . . . . . . . . . . 17
2.7.1.2 Creation Via Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.7.2 Renaming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.7.3 Deletion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.7.4 Modification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.7.5 Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.7.6 Buttons in Mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.7.7 Buttons in News . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Smart Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
3.1
3.2
3.3
3.4
3.5
3.6
3.7
Smart
Smart
Smart
Smart
Smart
Smart
Smart
Key
Key
Key
Key
Key
Key
Key
Bindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Modeline. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Thing Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Argument Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Modifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
4
Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
5
HyControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
iii
6
Koutliner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.1
6.2
6.3
6.4
6.5
Menu Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Creating Outlines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Autonumbering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Idstamps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.5.1 Adding and Killing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.5.2 Relocating and Copying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.5.3 Moving Around . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.5.4 Filling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.5.5 Transposing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.5.6 Splitting and Appending . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.5.7 Inserting and Importing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.5.8 Exporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
6.6 Viewing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
6.6.1 Hiding and Showing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
6.6.2 View Specs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.7 Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.8 Cell Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
6.9 Koutliner History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
7
HyRolo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
7.1
7.2
7.3
7.4
7.5
Rolo
Rolo
Rolo
Rolo
Rolo
Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Searching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
8
Window Configurations . . . . . . . . . . . . . . . . . . . . . . . . 54
9
Developing with Hyperbole . . . . . . . . . . . . . . . . . . . 56
9.1
9.2
Hook Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Creating Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
9.2.1 Action Type Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
9.2.2 Implicit Button Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
9.3 Explicit Button Technicalities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
9.3.1 Button Label Normalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
9.3.2 Operational and Storage Formats . . . . . . . . . . . . . . . . . . . . . . . . . 60
9.3.3 Programmatic Button Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
9.4 Encapsulating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
9.5 Embedding Hyperbole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Appendix A
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
iv
Appendix B
Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
B.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
B.2 Invocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
B.3 Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
B.3.1 Web Search Engines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
B.3.2 Using URLs with Find-File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
B.3.3 Internal Viewers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
B.3.4 External Viewers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
B.3.5 Invisible Text Searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
B.3.6 Link Variable Substitution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
B.3.7 Configuring Button Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Appendix C
Global Key Bindings . . . . . . . . . . . . . . 75
Appendix D Koutliner Keys . . . . . . . . . . . . . . . . . . . . . 77
Appendix E
Smart Key Reference . . . . . . . . . . . . . . 85
E.1 Smart Mouse Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
E.1.1 Minibuffer Menu Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
E.1.2 Thing Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
E.1.3 Side-by-Side Window Resizing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
E.1.4 Modeline Clicks and Drags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
E.1.5 Smart Mouse - Drags between Windows . . . . . . . . . . . . . . . . . . 87
E.1.6 Smart Mouse - Drags within a Window . . . . . . . . . . . . . . . . . . . 88
E.2 Smart Keyboard Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
E.2.1 Smart Key - Emacs Pushbuttons . . . . . . . . . . . . . . . . . . . . . . . . . 89
E.2.2 Smart Key - Argument Completion . . . . . . . . . . . . . . . . . . . . . . . 89
E.2.3 Smart Key - ID Edit Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
E.2.4 Smart Key - Emacs Cross-references (Xrefs) . . . . . . . . . . . . . . 89
E.2.5 Smart Key - Smart Scrolling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
E.2.6 Smart Key - Smart Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
E.2.7 Smart Key - Dired Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
E.2.8 Smart Key - Hyperbole Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . 91
E.2.9 Smart Key - View Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
E.2.10 Smart Key - Delimited Things. . . . . . . . . . . . . . . . . . . . . . . . . . . 92
E.2.11 Smart Key - The Koutliner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
E.2.12 Smart Key - RDB Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
E.2.13 Smart Key - Help Buffers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
E.2.14 Smart Key - Identifier Menu Mode . . . . . . . . . . . . . . . . . . . . . . 93
E.2.15 Smart Key - C Source Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
E.2.16 Smart Key - C++ Source Code . . . . . . . . . . . . . . . . . . . . . . . . . 94
E.2.17 Smart Key - Assembly Source Code . . . . . . . . . . . . . . . . . . . . . 95
E.2.18 Smart Key - Lisp Source Code . . . . . . . . . . . . . . . . . . . . . . . . . . 95
E.2.19 Smart Key - Java Source Code . . . . . . . . . . . . . . . . . . . . . . . . . . 96
E.2.20 Smart Key - JavaScript Source Code . . . . . . . . . . . . . . . . . . . . 96
E.2.21 Smart Key - Python Source Code . . . . . . . . . . . . . . . . . . . . . . . 97
v
E.2.22
E.2.23
E.2.24
E.2.25
E.2.26
E.2.27
E.2.28
E.2.29
E.2.30
E.2.31
E.2.32
E.2.33
E.2.34
E.2.35
E.2.36
E.2.37
E.2.38
Smart
Smart
Smart
Smart
Smart
Smart
Smart
Smart
Smart
Smart
Smart
Smart
Smart
Smart
Smart
Smart
Smart
Appendix F
Key
Key
Key
Key
Key
Key
Key
Key
Key
Key
Key
Key
Key
Key
Key
Key
Key
-
Objective-C Source Code . . . . . . . . . . . . . . . . . . . 97
Fortran Source Code . . . . . . . . . . . . . . . . . . . . . . . 98
Occurrence Matches . . . . . . . . . . . . . . . . . . . . . . . . 98
Calendar Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Man Page Apropos . . . . . . . . . . . . . . . . . . . . . . . . . 99
Emacs Outline Mode . . . . . . . . . . . . . . . . . . . . . . 100
Info Manuals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Email Composers . . . . . . . . . . . . . . . . . . . . . . . . . 102
GNUS Newsreader . . . . . . . . . . . . . . . . . . . . . . . . 102
Buffer Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Tar File Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Man Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
WWW URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Rolo Match Buffers . . . . . . . . . . . . . . . . . . . . . . . 105
Gomoku Game . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
The OO-Browser . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Default Context . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Suggestion or Bug Reporting . . . . 107
Appendix G Questions and Answers. . . . . . . . . . . 108
Appendix H Future Work . . . . . . . . . . . . . . . . . . . . . . 110
Appendix I
References . . . . . . . . . . . . . . . . . . . . . . . . . 112
Key Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Function, Variable and File Index . . . . . . . . . . . . . . . 117
Concept Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
1
GNU Hyperbole
GNU Hyperbole was designed and written by Bob Weiner. See Appendix B [Setup], page 69,
for information on how to obtain and to install Hyperbole.
This manual explains user operation and summarizes basic developer facilities of GNU
Hyperbole. Hyperbole provides convenient access to information, control over its display
and easy linking of items across documents and across the web. The Hyperbole Koutliner
offers flexible views and structure manipulation within bodies of information.
We hope you enjoy using Hyperbole and that it improves your productivity. If it does,
consider sending us a quote or short note discussing how it helps you. We may use your
submission to help promote further use of Hyperbole; all submissions will be considered
freely reusable and will fall under the same license as Hyperbole. E-mail your quote to
<[email protected]>. We volunteer our time on Hyperbole and love to hear user
stories in addition to any problem reports.
Before we delve into Hyperbole, a number of acknowledgments are in order. Peter
Wegner and Morris Moore encouraged the growth of this work. Douglas Engelbart showed
us the bigger picture and will forever be an inspiration. His life-long quest at augmenting
individual and team capabilities represents a model from which we continue to draw. Chris
Nuzum has used Hyperbole since its inception, often demonstrating its power in creative
ways. Many thanks to Mats Lidell, a long-time Hyperbole user, who has helped maintain
it throughout the years. The Koutliner is dedicated to my lovely wife, Kathy.
2
1 Introduction
This edition of the GNU Hyperbole Manual is for use with any version 6.0.2 or greater of
GNU Hyperbole. Hyperbole runs atop GNU Emacs 24.3 or higher. It will trigger an error
if your Emacs is older.
This chapter summarizes the structure of the rest of the manual, describes Hyperbole,
lists some of its potential applications, and explains how to subscribe to its mail lists.
Throughout this manual, sequences of keystrokes are delimited by curly braces { },
function and variable names use this typeface.
1.1 Manual Overview
Remember that the DEMO file included in the Hyperbole distribution demonstrates many of
Hyperbole’s standard facilities without the need to read through this reference manual. It
is a good way to rapidly understand some of what Hyperbole can do for you.
See Appendix A [Glossary], page 62, for definitions of Hyperbole terms. In some cases,
terms are not precisely defined within the body of this manual since they are defined within
the glossary. Be sure to reference the glossary if a term is unclear to you. Although you
need not have a keen understanding of all of these terms, a quick scan of the glossary should
help throughout Hyperbole use.
See Appendix B [Setup], page 69, for explanations of how to obtain, install, configure
and load Hyperbole for use. This appendix includes information on user-level settings that
you may want to modify after you understand Hyperbole’s basic operation.
See Appendix F [Suggestion or Bug Reporting], page 107, for instructions on how to ask a
question, suggest a feature or report a bug in Hyperbole. A few commonly asked questions
are answered in this manual. See Appendix G [Questions and Answers], page 108. See
Appendix I [References], page 112, if you are interested in classic articles on hypertext.
See Chapter 2 [Buttons], page 7, for an overview of Hyperbole buttons and how to use
them.
See Chapter 3 [Smart Keys], page 22, for an explanation of the innovative, contextsensitive mouse and keyboard Action and Assist Keys offered by Hyperbole. See Appendix E
[Smart Key Reference], page 85, for a complete reference on what the Action and Assist Keys
do in each particular context that they recognize. See Section 3.5 [Smart Key Argument
Selection], page 27, for special support that Hyperbole provides for entering arguments
when prompted for them.
Keep in mind as you read about using Hyperbole that in many cases, it provides a
number of overlapping interaction methods that support differing work styles and hardware
limitations. In such instances, you need learn only one technique that suits you.
See Chapter 4 [Menus], page 29, for summaries of Hyperbole menu commands and how
to use the minibuffer-based menus that work on dumb terminals, PCs or workstations.
See Chapter 5 [HyControl], page 33, for how to quickly and interactively control your
Emacs windows and frames and what they display.
See Chapter 6 [Koutliner], page 36, for concept and usage information on the autonumbered, hypertextual outliner. See Appendix D [Koutliner Keys], page 77, for a full summary
of the outliner commands that are bound to keys.
Chapter 1: Introduction
3
See Chapter 7 [HyRolo], page 48, for concept and usage information on the rapid lookup,
hierarchical, free text record management system included with Hyperbole.
See Chapter 8 [Window Configurations], page 54, for instructions on how to save and
restore the set of buffers and windows that appear within a frame. This feature lets you
switch among working contexts easily, even on a dumb terminal. Such configurations last
only throughout a single session of editor usage.
See Chapter 9 [Developing with Hyperbole], page 56, if you are a developer who is
comfortable with Lisp.
See Appendix H [Future Work], page 110, for future directions in Hyperbole’s evolution.
1.2 Motivation
Database vendors apply tremendous resources to help solve corporate information management problems. But the information that people deal with in their everyday worklife is
seldom stored away in neatly defined database schemas. Instead it is scattered among local
and remote files, e-mail messages, faxes, voice mail and web pages.
The rise of the web has demonstrated how hypertext technologies can be used to build
massive organized repositories of scattered information. But assembling information for the
web still remains a great challenge to many and the data formats of the web are inherently
still too structured to deal with the great variety of information that people process. Modern
web development often requires the use of many languages: HTML, JavaScript, CSS and
Java. This in itself prevents its use as the prime means of organizing and interlinking the
constant flows of daily information.
GNU Hyperbole takes a distinctly different approach. It has its own hypertext technology
that can interface perfectly with web links but which are much easier to create (simply
drag from the source to the destination of a link to create a new hyperlink). Hyperbole
hyperbuttons can link not only to static information but can perform arbitrary actions
through the use of button types written in a single, highly interactive language, Emacs
Lisp. Hyperbole adds all of this power to your written documents, e-mail, news articles,
contact management, outlines, directory listings, and much more. Hyperbole works well
with the very latest versions of GNU Emacs.
Unlock the power of GNU Hyperbole to make your information work for you. One
system. One language. One manual. One solution. Learn GNU Hyperbole and start
moving further, faster.
1.3 Hyperbole Overview
GNU Hyperbole (pronounced Ga-new Hi-per-bo-lee), or just Hyperbole, is an efficient and
programmable hypertextual information management system. It is intended for everyday
work on any GNU Emacs platform. Hyperbole allows hypertext buttons to be embedded
within unstructured and structured files, mail messages and news articles. It offers intuitive
mouse-based control of information display within multiple windows. It also provides pointand-click access to Info manuals, ftp archives, and the World-Wide Web (WWW).
Hyperbole consists of five parts:
Chapter 1: Introduction
4
Buttons and Smart Keys
a set of hyperbutton types that provides core hypertext and other behaviors,
see Chapter 2 [Buttons], page 7. Buttons may be added to documents (explicit
buttons) with a simple drag between windows, no markup language needed.
Implicit buttons are patterns automatically recognized within text that perform actions, e.g. bug#24568 displays the bug status information for that bug
number.
Buttons are accessed by clicking on them or referenced by name (global buttons), so they can be activated regardless of what is on screen. Users can make
simple changes to button types. Emacs Lisp programmers can prototype and
deliver new types quickly.
Hyperbole includes two special Smart Keys, the Action Key and the Assist Key,
that perform an extensive array of context-sensitive operations across emacs
usage, including activating and showing help for Hyperbole buttons. In many
popular Emacs modes, they allow you to perform common, sometimes complex
operations without having to a different key for each operation. Just press a
Smart Key and the right thing happens. See Chapter 3 [Smart Keys], page 22;
Contact and Text Finder
an interactive, textual information management interface, including fast, flexible file and text finding commands. A powerful, hierarchical contact manager,
see Chapter 7 [HyRolo], page 48, which anyone can use, is also included. It is
easy to learn since it introduces only a few new mechanisms and has a menu
interface, which may be operated from the keyboard or the mouse;
Screen Control
the fastest, easiest-to-use window and frame control available for GNU Emacs,
see Chapter 5 [HyControl], page 33. With just a few keystrokes, you can shift
from increasing a window’s height by 5 lines to moving a frame by 220 pixels or
immediately moving it to a screen corner. Text in each window or frame may
be enlarged or shrunk (zoomed) for easy viewing, plus many other features;
Hypertextual Outliner
an advanced outliner, see Chapter 6 [Koutliner], page 36, with multi-level autonumbering and permanent identifiers attached to each outline node for use
as hypertext link anchors, per node properties and flexible view specifications
that can be embedded within links or used interactively;
Programming Library
a set of programming libraries, see Chapter 9 [Developing with Hyperbole],
page 56, for system developers who want to integrate Hyperbole with another
user interface or as a back-end to a distinct system. (All of Hyperbole is written
in Emacs Lisp for ease of modification. It has been engineered for real-world
usage and is well structured).
Hyperbole may be used simply for browsing through documents pre-configured with
Hyperbole buttons, in which case, you can safely ignore most of the information in this
manual. Jump right into the Hyperbole demonstration by typing {C-h h d d}, assuming
Hyperbole has been installed at your site. If you need to install Hyperbole, see Appendix B
Chapter 1: Introduction
5
[Setup], page 69, for Hyperbole installation and configuration information. The demo offers
a much less technical introduction to Hyperbole by supplying good examples of how buttons
may be used and an introduction to the Koutliner.
Image 1.1: Hyperbole Minibuffer Menu and Demonstration Screenshot
You likely will want to do more than browse with Hyperbole, e.g. create your own
buttons. The standard Hyperbole button editing user interface is Emacs-based, so a basic
familiarity with the Emacs editing model is useful. The material covered in the Emacs
tutorial, normally bound to {C-h t}, is more than sufficient as background. See Section
“Glossary” in the GNU Emacs Manual, if some emacs-related terms are unfamiliar to you.
A Hyperbole user works with chunks of information that need to be organized, interlinked, and processed. Such chunks can be hyperbuttons, address book contacts, items in an
outline, or even database query results. Hyperbole does not enforce any particular hypertext or information management model, but instead allows you to organize your information
in large or small chunks as you see fit. The Hyperbole outliner organizes information into
hierarchies which may also contain links to external information sources. See Chapter 6
[Koutliner], page 36.
Some of Hyperbole’s most significant features are:
• Buttons may link to information or may execute procedures, such as starting or communicating with external programs;
• A simple mouse drag from a button source location to its link destination is often all
Chapter 1: Introduction
6
that is needed to create a new link. The keyboard can also be used to emulate such
drags;
• Buttons may be embedded within electronic mail messages;
• Outlines allow rapid browsing, editing and movement of chunks of information organized into trees (hierarchies);
• Other hypertext and information retrieval systems may be encapsulated under a Hyperbole user interface (a number of samples are provided).
Typical Hyperbole applications include:
personal information management
Hyperlinks provide a variety of views into an information space. A search
facility locates hyperbuttons in context and permits quick selection.
documentation and code browsing
Cross-references may be embedded within documentation and code. Existing
documentation may be augmented with point-and-click interfaces to link code
with associated design documents, or to permit direct access to the definition
of identifiers by selecting their names within code or other documents.
brainstorming
The Hyperbole outliner (see Chapter 6 [Koutliner], page 36) is an effective tool
for capturing ideas and then quickly reorganizing them in a meaningful way.
Links to related ideas are easy enough to create that copying and pasting ideas
together quickly becomes a dated technique.
help/training systems
Tutorials with buttons can show students how things work while explaining the
concepts, e.g. an introduction to the commands available on a computer system.
This technique can be much more effective than written documentation alone.
archive managers
Programs that manage archives from incoming information streams may be
supplemented by having them add topic-based buttons that link to the archive
holdings. Users can then search and create their own links to archive entries.
1.4 Mail Lists
If you use Hyperbole, you may join the mailing list <[email protected]> to discuss
Hyperbole with users and maintainers. There is a separate mail list to report problems
or bugs with Hyperbole, <[email protected]>. For more details, see Appendix F
[Suggestion or Bug Reporting], page 107.
7
2 Buttons
This chapter explains use of Hyperbole buttons. There are several kinds of Hyperbole
buttons: buttons that are created one at a time and stored in files (explicit buttons);
buttons that can be activated by name anytime (global buttons); and buttons defined by
textual patterns where one definition can create an infinite number of buttons (implicit
buttons).
Hyperbole buttons are embedded within textual documents; they may be created, modified, moved or deleted. Each button performs a specific action, such as linking to a file or
executing a shell command.
There are three categories of Hyperbole buttons:
explicit buttons
created by Hyperbole, accessible from within a single document;
global buttons
created by Hyperbole, specific to each user, and accessible anywhere within a
user’s network of documents;
implicit buttons
created and managed by other programs or embedded within the structure of
a document, accessible from within a single document. Hyperbole recognizes
implicit buttons by contextual patterns given in their type specifications (explained later).
Explicit Hyperbole buttons may be embedded within any type of text file. Implicit
buttons may appear only within document contexts allowed by their types, which may limit
the kinds of documents or the locations within those documents at which such buttons may
be found. All global buttons for a user are stored in a single location and are activated by
entering their names, rather than by direct selection, the means used to activate explicit
and implicit buttons.
To summarize:
Button Category
Active Within
Activation Means
Managed By
========================================================================
Explicit
a single document
direct selection
Hyperbole
Global
any document
entering its name
Hyperbole
Implicit
a matching context
direct selection
other tools
A click on a Hyperbole button may activate it or describe its actions, depending on which
mouse key is used. Buttons may also be activated from a keyboard. (In fact, virtually
all Hyperbole operations, including menu usage, may be performed from any standard
character terminal interface, so you need not be anchored to a workstation all day). See
Chapter 3 [Smart Keys], page 22. There is also a key that shows you how a button will
behave before you activated it, see Section 3.2 [Smart Key Operations], page 22.
Chapter 2: Buttons
8
2.1 Explicit Buttons
Hyperbole creates and manages explicit buttons which perform specific actions when activated (typically through a button press). They look like this ‘<(fake button)>’. They are
quickly recognizable, yet relatively non-distracting as you scan the text in which they are
embedded. The text between the ‘<(’ and ‘)>’ delimiters is called the button label or button name. Spacing between words within a button label is irrelevant to Hyperbole. Button
labels may wrap across several lines without causing a problem; just be sure to select the
first line of the button to activate it.
Explicit buttons may be added to any editable text file; for source code files, simply
place buttons within comments. Buttons that you use for quick navigation to websites or
other things you do often should be added to your personal button file. See Section 2.4
[Button Files], page 13.
Explicit buttons may be freely moved about within the buffer in which they are created.
(No present support exists for moving buttons between buffers; support the Hyperbole
project if you would like to help make this happen). A single button may also appear
multiple times within the same buffer; simply copy the button label with its delimiters to
a new location if you need another copy of it.
For details on how to create, activate, delete or modify explicit buttons, see Section 2.7
[Utilizing Explicit Buttons], page 17.
Each explicit button is assigned an action type that determines the actions it performs.
Link action types connect buttons to particular types of referents, the targets of their links.
Link action type names all begin with link-. Link action button referents are displayed
when such buttons are by pressing or clicking upon them. See Section 2.5 [Action Types],
page 13, for a list of standard action types including link types.
Hyperbole does not manage referent data; this is left to the applications that generate the
data. This means that Hyperbole provides in-place linking and does not require reformatting
of data to integrate with Hyperbole.
Hyperbole stores the button data that gives an explicit button its behavior, separately
from the button label, in a file named .hypb (_hypb under MS Windows) within the same
directory as the file in which the button is created. Thus, all files in the same directory
share a common button data file. Button data is comprised of individual button attribute
values. A user never sees this data in its raw form but may see a formatted version by
asking for help on a button.
2.2 Global Buttons
Access to explicit buttons depends upon the information on your screen since they are
embedded within particular buffers. Sometimes it is useful to activate buttons without
regard to the information with which you are working. In such instances, you use global
buttons, which are buttons that may be activated or otherwise operated upon by entering
their labels/names when they are prompted for, rather than selecting the buttons within a
buffer.
If you want a permanent link to a file section that you can follow at any time, you can
use a global button. Or what about an Emacs keyboard macro that you use frequently?
Chapter 2: Buttons
9
Create an exec-kbd-macro button with an easy to type name and then you can activate it
whenever the need arises.
Global buttons are managed with the Hyperbole Gbut/ menu accessed with {C-h h g}.
The Create item, {C-h h g c}, prompts for a global button name, an action type, and the
action’s associated arguments, such as a file to link to. It then creates the button. To
activate the button, use the Act menu item, {C-h h g a}. Type the button’s name and its
action will be executed.
Global buttons are actually explicit buttons stored at the end of your personal button
file, see Section 2.4 [Button Files], page 13. You can always go into that file and activate,
edit or annotate these buttons with comments.
2.3 Implicit Buttons
Implicit buttons are virtual buttons recognized within the natural structure of a document.
For example, a web URL button that displays its link or an email address button that starts
a mail message to the associated address. Implicit buttons are identified by contextual
patterns found within documents. An Implicit button type identifies a pattern or state
that when matched triggers an action associated with the implicit button type. The action
is specified by either a Hyperbole action type (see Section 2.5 [Action Types], page 13) or
an Emacs Lisp function. Implicit button types may use the same action types that explicit
buttons use. As an example, a pathname implicit button type would match to any existing
local filename or directory name and its action would be to display the associated file or
directory, typically in another window.
Unlike explicit buttons, implicit buttons have no individual button data other than their
textual labels. You use implicit button types which include boolean expressions (predicates)
that match to both the label and the context required of any button of the type. Each time
a Smart Key is pressed at a location, Hyperbole evaluates the predicates from the list
of implicit button types and the first one that evaluates true is selected and its associated
action is triggered. The Ibut/Act menu item, {C-h h i a}, also activates any implicit button
found at the current point.
All of this happens transparently and is easy to use once you try it. The Hyperbole
Smart Keys offer extensive additional context-sensitive point-and-click type behavior beyond implicit button types. See Section 3.2 [Smart Key Operations], page 22.
Below, standard implicit button types are listed in the order in which Hyperbole tries to
match to the types when looking for an implicit button; {C-h h i t RET} provides similar
information. See the Hyperbole file, hibtypes.el, for complete examples of implicit button
types.
completion
Inserts the completion at point into the minibuffer or the other window.
hyp-source
Turns source location entries in Hyperbole reports into buttons that jump to
the associated location.
hyp-address
Turns a Hyperbole support/discussion e-mail address into an implicit button
which inserts Hyperbole environment information. This is useful when send-
Chapter 2: Buttons
10
ing mail to a Hyperbole discussion mail list. See also the documentation for
actypes::hyp-config.
Info-node
Makes "(filename)nodename" buttons display the associated Info node. Also
makes "(filename)itemname" buttons display the associated Info index item.
www-url
When not in an Emacs web browser buffer, follows any non-ftp URL (link)
at point. The variable, browse-url-browser-function, may be used to customize which URL browser is called. Terse URLs which lack a protocol prefix,
like www.gnu.org, are also recognized.
gnus-push-button
Activates GNUS-specific article push-buttons, e.g. for hiding signatures. GNUS
is a news and mail reader."
texinfo-ref
Displays Texinfo, Info node or help associated with Texinfo node, menu item,
@xref, @pxref, @ref, @code or @var at point. If point is within the braces of a
cross-reference, the associated Info node is shown. If point is to the left of the
braces but after the @ symbol and the reference is to a node within the current
Texinfo file, then the Texinfo node is shown.
For @code and @var references, the associated documentation string is displayed.
mail-address
If on an e-mail address in a specific buffer type, mail to that address in another
window. Applies to the rolo match buffer, any buffer attached to a file in
hyrolo-file-list, or any buffer with mail or rolo (case-insensitive) within
its name.
patch-msg
Jumps to the source code associated with output from the ‘patch’ program.
Patch applies diffs to source code.
elisp-compiler-msg
Jumps to the source code for a definition associated with a byte-compiler error
message. Works when activated anywhere within an error line.
debugger-source
Jumps to the source line associated with a debugger stack frame or breakpoint
line. This works with gdb, dbx, and xdb. Such lines are recognized in any
buffer.
grep-msg
Jumps to a line associated with grep or compilation error messages. Messages
are recognized in any buffer.
klink
Follows a link delimited by <> to a koutline cell. See the documentation for
actypes::link-to-kotl for valid link specifiers.
man-apropos
Makes man apropos entries (from ‘man -k’) display associated man pages when
selected.
Chapter 2: Buttons
11
rfc
Retrieves and displays an Internet rfc referenced at point. Requires remote file
access, e.g. via the Tramp library, for remote ftp retrievals. The following formats are recognized: RFC822, rfc-822, and RFC 822. The hpath:rfc variable
specifies the location from which to retrieve RFCs."
kbd-key
Executes the command binding or the Hyperbole minibuffer menu action for
a key sequence delimited by curly braces. Key sequences should be in human
readable form, e.g. {C-x C-b}. Formats such as {^x^b} will not be recognized.
dir-summary
Detects filename buttons in files named "MANIFEST" or "DIR". Displays
selected files. Each file name must be at the beginning of the line and must be
followed by one or more spaces and then another non-space, non-parenthesis,
non-brace character.
text-toc
Jumps to the text file section referenced by a table of contents entry at point.
The file name of the current buffer must contain README and there must be a
‘Table of Contents’ or ‘Contents’ label on a line by itself (it may begin with
an asterisk), preceding the table of contents. Each toc entry must begin with
some whitespace followed by one or more asterisk characters. Each line which
begins a new file section must start with one or more asterisk characters at the
very beginning of the line.
cscope
Jumps to a C/C++ source line associated with a Cscope C analyzer output line.
Requires pre-loading of the cscope.el Lisp library available from the Emacs Lisp
archives and the commercial cscope program available from AT&T’s software
toolchest. Otherwise, does nothing.
etags
Jumps to the source line associated with an etags file entry in a TAGS buffer.
If on a tag entry line, jumps to the source line for the tag. If on a pathname
line or line preceding it, jumps to the associated file.
ctags
Jumps to the source line associated with a ctags file entry in any buffer. Ctags
files are used by old editors like vi to lookup identifiers. InfoDock and Emacs
use the newer, more flexible Etags format.
id-cflow
Expands or collapses C call trees and jumps to code definitions. Requires crossreference tables built by the external cxref program.
rfc-toc
Summarizes contents of an Internet rfc from anywhere within an rfc buffer.
Each line of the summary may be selected to jump to the associated section.
markdown-internal-link
Displays any in-file Markdown link referent. Pathnames and urls are handled
elsewhere.
annot-bib
Displays annotated bibliography entries defined within the same buffer as the
reference. References must be delimited by square brackets, must begin with
a word constituent character, and must not be in buffers whose names begin
with a ‘ ’ or ‘*’ character.
Chapter 2: Buttons
12
debbugs-gnu-mode
Debbugs is a client-server issue tracker used by GNU free software projects, including Hyperbole, to manage issues and maintain threads of discussion around
them. When on a GNU Debbugs listing entry in debbugs-gnu-mode, an Action Key press displays the discussion of the selected issue; an Assist Key press
pretty prints the status of the issue to a window below the listing window.
debbugs-gnu-query
This implicit button type displays the results of a Gnu debbugs query based
on the string at point and works in most kinds of buffers. If the query includes
a single id number, it displays the original message submission for that id and
allows browsing of the followup discussion. The following buffer text formats
are accepted (with point prior to any attribute):
#id-number
bug#id-number, bug# id-number, bug #id-number or bug id-number
bug?attr1=val1&attr2=val2&attr3=val3
bug#id-number?attr1=val1&attr2=val2&attr3=val3
Note that issue or debbugs may be used as well in place of bug. See the documentation at the top of the hib-debbugs.el file for detailed query format
information.
social-reference
Displays the web page associated with a social media hashtag or username
reference at point. Reference format is:
[facebook|instagram|twitter]?[#@]<hashtag-or-username> or
[fb|in|tw]?[#@]<hashtag-or-username>
For example, ‘fb@someuser’ displays the home page for facebook user
‘someuser’ and ‘in#hashtag’ displays photos with the hashtag ‘hashtag’. The
first part of the label for a button of this type is the social media service name.
The service name defaults to the value of hibtypes-social-default-service
(default value of “twitter”) when not given, so #hashtag would be the same
as twitter#hashtag.
function-in-buffer
Returns the function name defined within this buffer that point is within or
after, else ‘nil’. This triggers only when the func-menu library has been loaded
and the current major mode is one handled by func-menu.
pathname-line-and-column
Makes a valid pathname:line-num[:column-num] pattern display the path at
line-num and optional column-num. Also works for remote pathnames.
pathname
Makes a valid pathname display the path entry. Also works for delimited and
non-delimited remote pathnames, Texinfo entries, and hash-style link references
to HTML, Markdown or Emacs outline headings. Emacs Lisp library files
(filenames without any directory component that end in .el and .elc) are looked
up using the load-path directory list.
See the function documentation for hpath:at-p for possible delimiters. See the
variable documentation for hpath:suffixes for suffixes that are added to or
Chapter 2: Buttons
13
removed from the pathname when searching for a valid match. See the function
documentation for hpath:find for special file display options.
org-mode
The Action Key follows any Org mode link at point or cycles through views of
the outline subtree at point. In any other context besides the end of a line, the
Action Key will invoke the Org mode standard binding of {M-RET}, (org-metareturn). The Assist Key on an Org mode heading, cycles through views of the
whole buffer outline and on an Org mode link, displays standard Hyperbole
help.
The variable, browse-url-browser-function, customizes the url browser that
is used for urls. Valid values of this variable include browse-url-defaultbrowser and browse-url-generic.
doc-id
Displays an index entry for a site-specific document given its id. Ids must
be delimited by doc-id-start and doc-id-end and must match the function
given by doc-id-p. This permits creation of catalogued online libraries. (Note
that this implicit button type is not installed by default. You must manually
configure it and load it from the file, ${hyperb:dir}/hib-doc-id.el).
2.4 Button Files
It is often convenient to create files filled with buttons as a means of navigating distributed
information pools or for other purposes. These files can also serve as useful roadmaps that
guide a user through both unfamiliar and highly familiar information spaces. Files that are
created specifically for this purpose are called Hyperbole button files.
The Hyperbole menu system provides quick access to two types of these button files:
personal and directory-specific, through the ButFile menu. (The variable, hbmap:filename,
contains the base name of these button files. Its standard value is HYPB.)
A personal button file may serve as a user’s own roadmap to frequently used resources,
like a personal home page. Selection of the ButFile/PersonalFile menu item, {C-h h b p},
displays this file for editing. The default personal button file is stored within the directory
given by the hbmap:dir-user variable whose standard value is ~/.hyperb. The default
Hyperbole configuration also appends all global buttons to the end of this file, one per line,
as they are created. So you can edit or annotate them within the file.
A directory-specific button file may exist for each file system directory. Such files are
useful for explaining the contents of directories and pointing readers to particular highlights
within the directories. Selection of the ButFile/DirFile menu item, {C-h h b d}, displays
the button file for the current directory; this provides an easy means of updating this file
when working on a file within the same directory. If you want to view some other directoryspecific button file, simply use the normal Emacs file finding commands.
One might suggest that quick menu access be provided for group-specific and site-specific
button files. Instead, link buttons to such things should be placed at the top of your personal
button file. This provides a more flexible means of connecting to such resources.
2.5 Action Types
Action types are special functions that specify Hyperbole button behaviors. Each action
type may be used by any category of button: global, explicit, or implicit. The arguments
Chapter 2: Buttons
14
needed by an action type are prompted for at button creation time or in the case of an
implicit button, computed when the button is activated. During button activation, the
arguments are fed to the action type’s body to achieve the desired result. This body is
called the button action.
Hyperbole handles all of this processing transparently. As a user, all you need know is
the set of action types that you can work with when creating explicit or global buttons.
The standard action types included with Hyperbole in alphabetical order are:
annot-bib
Follows an internal reference KEY within an annotated bibliography, delimiters
= [ ].
completion
Inserts a completion at point into the minibuffer or a buffer. Unless point is at
the end of buffer or if a completion has already been inserted, in which case the
completions window is deleted.
eval-elisp
Evaluates a Lisp expression LISP-EXPR.
exec-kbd-macro
Executes a KBD-MACRO REPEAT-COUNT times. KBD-MACRO may be a
string of editor command characters, a function symbol or nil to use the last
defined keyboard macro. Optional REPEAT-COUNT nil means execute once,
zero means repeat until error.
exec-shell-cmd
Executes a SHELL-CMD string asynchronously. Optional non-nil second argument INTERNAL-CMD inhibits display of the shell command line executed.
Optional non-nil third argument KILL-PREV means kill the last output to the
shell buffer before executing SHELL-CMD.
exec-window-cmd
Asynchronously executes an external window-based SHELL-CMD string.
function-in-buffer
Displays the definition of function NAME found at POS in the current buffer.
hyp-config
Inserts Hyperbole configuration and debugging information at the end of the
current buffer or within optional OUT-BUF.
hyp-request
Inserts help for composing a Hyperbole support/discussion message into the
current buffer or the optional OUT-BUF.
hyp-source
Displays a buffer or file from a line beginning with hbut:source-prefix.
kbd-key
Executes the function binding for KEY-SEQUENCE, delimited by {}. Returns
‘t’ if a KEY-SEQUENCE has a binding, else ‘nil’.
Chapter 2: Buttons
15
link-to-buffer-tmp
Displays a BUFFER. This type of link generally can only be used within a
single editor session. Use link-to-file instead for a permanent link.
link-to-directory
Displays a DIRECTORY in Dired mode.
link-to-doc
Displays an online version of a document given by DOC-ID. If the online version
of a document is not found in doc-id-indices, an error is signalled.
link-to-ebut
Performs an action given by another button, specified by KEY and KEY-FILE.
link-to-elisp-doc
Displays the documentation for FUNC-SYMBOL.
link-to-file
Displays file given by PATH scrolled to optional POINT. With POINT, buffer
is displayed with POINT at window top.
link-to-file-line
Displays a file given by PATH scrolled to LINE-NUM.
link-to-Info-index-item
Displays an Info index ITEM cross-reference. ITEM must be a string of the form
(filename)item-name. During button creation, completion for both filename and
item-name is available. Filename may be given without the .info suffix."
link-to-Info-node
Displays an Info NODE. NODE must be a string of the form (filename)nodename. During button creation, completion for both filename and
nodename is available. Filename may be given without the .info suffix.
link-to-kcell
Displays a Hyperbole outline cell, given by FILE and CELL-REF, at the top of
a window. See the documentation for (kcell:ref-to-id) for valid CELL-REF
formats.
If FILE is ‘nil’, the current buffer is used. If CELL-REF is ‘nil’, the first cell
in the view is shown.
link-to-kotl
Displays at the top of a window the referent pointed to by LINK. LINK may
be of any of the following forms, with or without delimiters:
< pathname [, cell-ref] >
< [-!&] pathname >
< @ cell-ref >
See the documentation for (kcell:ref-to-id) for valid cell-ref formats.
link-to-mail
Displays a mail message with MAIL-MSG-ID from optional MAIL-FILE. See
the documentation for the variable hmail:init-function for information on
how to specify the mail reader to use.
Chapter 2: Buttons
16
link-to-regexp-match
Finds REGEXP’s Nth occurrence in SOURCE and displays the location at the
top of the selected window. SOURCE is a pathname unless optional BUFFERP is non-nil, then SOURCE must be a buffer name or buffer. Returns ‘t’ if
found, signals an error if not.
link-to-rfc
Retrieves and displays an Internet rfc given by RFC-NUM. RFC-NUM may be
a string or an integer. Requires a remote file access library, such as Tramp, for
ftp file retrievals.
link-to-string-match
Finds STRING’s Nth occurrence in SOURCE and displays the location at the
top of the selected window. SOURCE is a pathname unless optional BUFFERP is non-nil, then SOURCE must be a buffer name or buffer. Returns ‘t’ if
found, ‘nil’ if not.
link-to-texinfo-node
Displays the Texinfo node with NODENAME (a string) from the current buffer.
link-to-web-search
Searches web SERVICE-NAME for SEARCH-TERM. Uses hyperbole-websearch-alist to match each service to its search url. Uses hyperbole-websearch-browser-function and the browse-url package to display search results.
man-show
Displays a man page on TOPIC, which may be of the form
‘<command>(<section>’).
If using the Superman manual entry package, see the documentation for sm-notify to control where the man page is
displayed.
rfc-toc
Computes and displays a summary of an Internet rfc in BUF-NAME. Assumes
point has already been moved to the start of the region to summarize. Optional
OPOINT is the point to return to in BUF-NAME after displaying the summary.
text-toc
Jumps to the text file SECTION referenced by a table of contents entry at
point.
www-url
Follows a link given by a URL. The variable, browse-url-browser-function,
customizes the url browser that is used. See its documentation string for details.
Action types create a convenient way of specifying button behavior without the need
to know how to program. Expert users who are familiar with Emacs Lisp, however, may
find that they often want to tailor button actions in a variety of ways not easily captured
within a type system. In such cases, hui:ebut-prompt-for-action should be set to ‘t’.
This will cause Hyperbole to prompt for an action to override the button’s action type at
each explicit button creation. For those cases where the action type is sufficient, a ‘nil’
value should be entered for the action. An action may be any Lisp form that Emacs Lisp
can evaluate.
Chapter 2: Buttons
17
2.6 Button Type Precedence
Explicit buttons always take precedence over implicit buttons. Thus, if a button selection
is made which falls within both an explicit and implicit button, only the explicit button
will be selected. Explicit button labels are not allowed to overlap; Hyperbole’s behavior in
such cases is undefined.
If there is no explicit button at point during a selection request, then each implicit
button type predicate is tested in turn until one returns non-nil or all are exhausted. Since
two implicit button types may have overlapping domains, those contexts in which their
predicates are true, only the first matching type is used. The type predicates are tested in
reverse order of definition, i.e. most recently entered types are tested first, so that personal
types defined after standard system types take precedence. It is important to keep this
order in mind when defining new implicit button types. By making match predicates as
specific as possible, one can minimize any overlapping implicit button domains.
Once a type name is defined, its precedence relative to other types remains the same
even if its body is redefined, as long as its name is not changed. This allows incremental
modifications to types without any worry of altering their precedences. See Section 9.2
[Creating Types], page 57, for information on how to develop or modify types.
2.7 Utilizing Explicit Buttons
Explicit buttons are a fundamental building block for creating personal or organizational
hypertext networks with Hyperbole. This section summarizes the user-level operations
available for managing these buttons.
2.7.1 Creation
Creating explicit buttons is fun and easy. You can always try them out immediately after
creating them or can utilize the Assist Key to verify what buttons do. There are two ways
to create them: by dragging between windows with the Action Mouse Key or by using the
Hyperbole menus.
2.7.1.1 Creation Via Action Key Drags
The most efficient way to create an explicit link button interactively is to use the Action
Mouse Key to drag from a button source window to a window showing its link referent.
More specifically, you should split your current Emacs frame into two windows: one which
contains the point at which you want a button to be inserted and another which shows the
point to which you want to link. Depress the Action Mouse Key at the source point for the
button (anywhere but on a paired delimiter such as double quotes or parentheses). Then
drag to the other window and release the Action Mouse Key at the start point of the link
referent. The process becomes quite simple with a little practice. (See Section 2.7.1.2 [By
Menu], page 18, for a more detailed explanation of the explicit button creation process).
If a region was selected prior to the start of the drag, it is used as the button label,
otherwise, you are prompted for the label. Then Hyperbole uses the link referent context
to determine the type of link to make. If there are a few different types of links which are
applicable from the context, you will be prompted with a list of the types. Simply use the
Action Key or the first letter of the link type to select one of the type names and to finish
the link creation. Hyperbole will then insert explicit button delimiters around the button
Chapter 2: Buttons
18
label and will display a message in the minibuffer indicating the button label, its action/link
type, and any arguments, notably the thing to which it links.
The following table shows the type of link that will be created based upon the referent
context in which the Action Key is released.
Referent Context
Link Type
---------------------------------------------------Explicit Button
link-to-ebut
Info Index Item
link-to-Info-index-item
Info Node
link-to-Info-node
Mail Reader Message
link-to-mail
Directory Name
link-to-directory
File Name
link-to-file
Koutline Cell
link-to-kcell
Outline Heading
link-to-string-match
Buffer attached to File link-to-file
Buffer without File
link-to-buffer-tmp
If you run Emacs under a window system and there is no prior key binding on {M-o}
when you load Hyperbole, then you can emulate an Action Key drag from the keyboard by
typing {M-o}, the hkey-operate command, at the button source location, moving to the
link destination, e.g. with {C-x o}, and then typing {M-o} again. This simulates a depress
and then release of the Action Key. {C-u M-o} emulates drags of the Assist Key. This will
not work when Hyperbole is run from a dumb terminal Emacs session since drag actions
are not supported without a window system.
2.7.1.2 Creation Via Menus
You may instead use the Hyperbole menus to create explicit buttons. First, mark a short
region of text in any fashion allowed by Emacs and then select the Hyperbole menu item
sequence, Ebut/Create. You will be prompted for the button’s label with the marked
region as the default. If you accept the default and enter the rest of the information you
are prompted for, the button will be created within the current buffer and Hyperbole will
surround the marked region with explicit button delimiters to indicate success.
If you do not mark a region before invoking the button create command, you will be
prompted for both a label and a target buffer for the button and the delimited label text
will be inserted into the target buffer after a successful button creation.
After Hyperbole has the button label and its target buffer, it will prompt you for an
action type for the button. Use the {?} completion list key to see the available types. The
type selected determines any following values for which you are prompted.
If a previous button with the same label exists in the same buffer, Hyperbole will add
an instance number to the label when it adds the delimiters so that the name is unique.
Thus, you don’t have to worry about accidental button name conflicts. If you want the
same button to appear in multiple places within the buffer, just enter the label again and
delimit it yourself or copy and paste the button with its delimiters. Hyperbole will interpret
all occurrences of the same delimited label within a buffer as the same button.
If you create link buttons using the Hyperbole menus, the best technique is to place
on screen both the source buffer for the button and the buffer to which it will link. Mark
Chapter 2: Buttons
19
the region of text to use as your button label, invoke the button create command from the
menu, choose an action type which begins with link-to- and then use the direct selection
techniques mentioned in Section 3.5 [Smart Key Argument Selection], page 27, to select the
link referent.
2.7.2 Renaming
Once an explicit button has been created, its label text must be treated specially. Any interword spacing within the label may be freely changed, as may happen when a paragraph is
refilled, but a special command must be invoked to rename it.
The rename command operates in two different ways. If point is within a button label
when it is invoked, it will tell you to edit the button label and then to invoke the rename
command again after the edit. The second invocation will actually rename the button. If
instead the command is originally invoked outside of any explicit button, it will prompt
for the button label to replace and the label to replace it with and then will perform the
renaming. All occurrences of the same button in the buffer will be renamed.
The rename command may be invoked from the Hyperbole menu via Ebut/Rename.
A faster method is to use a key bound to the hui:ebut-rename command. Hyperbole
typically binds this to {C-c C-r}. {C-h w hui:ebut-rename RET} will show what if any
key runs it. If no key binding has been established or if you prefer one of your own, simply
bind it within your ~/.emacs file: (global-set-key "\C-c\C-r" 'hui:ebut-rename).
2.7.3 Deletion
Ebut/Delete works similarly to the Rename command but deletes the selected button. The
button’s delimiters are removed to confirm the deletion. If the delete command is invoked
with a prefix argument, then both the button label and the delimiters are removed as
confirmation.
Presently there is no way to recover a deleted button; it must be recreated. Therefore,
the hui:ebut-delete-confirm-p variable is true by default, causing Hyperbole to require
confirmation before interactively deleting explicit buttons. Set it to ‘nil’ if you prefer no
confirmation.
2.7.4 Modification
Ebut/Modify prompts you with each of the elements from the button’s attributes list and
allows you to modify each in turn. Ebut/Edit does the exact same thing and is there for
people who prefer that term.
There is a quicker way to modify explicit link buttons, however. Simply drag with the
Action Mouse Key from within the button label to a link destination in a different window,
just as you would when creating a new button with a mouse drag. Remember that drags
may also be emulated from the keyboard. See Section 2.7.1 [Creation], page 17.
2.7.5 Location
The Ebut/Help menu may be used to summarize either a single explicit button or all such
buttons within a buffer. The buttons summarized may then be activated directly from the
summary.
Ebut/Help/BufferButs summarizes the explicit buttons in the order in which they
appear in the buffer. Ebut/Help/CurrentBut summarizes only the button at point.
Chapter 2: Buttons
20
Ebut/Help/OrderedButs summarizes the buttons in alphabetical order. All of these
summary commands eliminate duplicate occurrences of buttons from their help displays.
Ebut/Search prompts for a search pattern and searches across all the locations in which
you have previously created explicit buttons. It asks you whether to match to any part
of a button label or to whole labels only. It then displays a list of button matches with
a single line of surrounding context from their sources. Any button in the match list may
be activated as usual. An Action Key press on the surrounding context jumps to the
associated source line. A press on the filename preceding the matches jumps to the file
without selecting a particular line.
There are presently no user-level facilities for globally locating buttons created by others
or for searching on particular button attributes.
2.7.6 Buttons in Mail
Hyperbole supports embedding buttons within electronic mail messages composed in Emacs
or InfoDock. An enhanced mail reader may then be used to activate the buttons within
messages just like any other buttons. Because this involves complex changes to mail support
functions, this feature is disabled by default. Use the Cust/Msg-Toggle-Ebuts minibuffer
menu item to enable it.
Hyperbole automatically supports the following mail readers: Rmail (see Section “Reading Mail with Rmail” in the GNU Emacs Manual), VM (see Section “Introduction” in the
VM Manual) and MH-e. Button inclusion and activation within USENET news articles
is also supported in the same fashion via the Gnus news reader if available at your site
(see Section “The Gnus Newsreader” in the Gnus Manual). (The hmail.el file defines a
generalized interface that can be used to hook in other mail or news readers if the necessary
interface functions are written.)
All explicit buttons to be mailed must be created within the outgoing message buffer.
There is no present support for including text from other buffers or files which contain
explicit buttons, except for the ability to yank the contents of a message being replied to,
together with all of its buttons, via the (mail-yank-original) command bound to {C-c
C-y}. From a user’s perspective, buttons are created in precisely the same way as in any
other buffer. They also appear just like any other buttons to both the message sender and
the reader who uses the Hyperbole enhanced readers. Button operation may be tested any
time before a message is sent. A person who does not use Hyperbole enhanced mail readers
can still send messages with embedded buttons since mail composing is independent of any
mail reader choice.
Hyperbole buttons embedded within received mail messages behave as do any other
buttons. The mail does not contain any of the action type definitions used by the buttons,
so the receiver must have these or she will receive an error when she activates the buttons.
Buttons which appear in message Subject lines are copied to summary buffers whenever
such summaries are generated. Thus, they may be activated from either the message or the
summary buffers.
Nothing bad will happen if a mail message with explicit buttons is sent to a nonHyperbole user. The user will simply see the text of the message followed by a series
of lines of button data at its end. Hyperbole mail users never see this data in its raw form.
Chapter 2: Buttons
21
In order to alert readers of your mail messages that you can handle Hyperbole mail
buttons, you can set the variable, smail:comment, to an expression that automatically
inserts a comment into each outgoing message to announce this fact. See its documentation
for technical details. By default, no comment is added. To have a comment line added to
your outgoing message, add the following to to your ~/.emacs file before the point at which
you load Hyperbole.
(setq smail:comment
(format "Comments: GNU Hyperbole mail buttons accepted, v%s.\n"
hyperb:version))
This will produce the following line in outgoing messages:
Comments: GNU Hyperbole mail buttons accepted, vX.XX.
where the X’s indicate your Hyperbole version number. You can cut this out of particular
messages before you send them when need be.
A final mail-related facility provided by Hyperbole is the ability to save a pointer to
a received mail message by creating an explicit button with a link-to-mail action type.
When prompted for the mail message to link to, if you press the Action Key within the message, the appropriate link parameters will be copied to the argument prompt, as described
in Section 3.5 [Smart Key Argument Selection], page 27.
2.7.7 Buttons in News
Explicit buttons may be embedded within outgoing USENET news articles and may be
activated from within the Gnus news reader. Because this involves complex changes to
news support functions, this feature is disabled by default. Use the Cust/Msg-ToggleEbuts minibuffer menu item to enable it (enabling it for mail also enables it for news and
vice versa).
Once enabled, all Hyperbole support should work just as it does when reading or sending
mail. See Section 2.7.6 [Buttons in Mail], page 20. When reading news, buttons which
appear in message Subject lines may be activated within the Gnus subject buffer as well
as the article buffer. When posting news, the *post-news* buffer is used for outgoing news
articles rather than a mail-related buffer.
Remember that the articles you post do not contain the action type definitions used by
the buttons, so the receiver must have these or she will receive an error when she activates
the buttons. You should also keep in mind that most USENET readers will not be using
Hyperbole, so if they receive a news article containing explicit buttons, they will wonder
what the button data at the end of the message is. You should therefore limit distribution
of such messages. For example, if most people at your site read news with Gnus and use
Hyperbole, it would be reasonable to embed buttons in postings to local newsgroups.
In order to alert readers of your postings that they may send you personal replies with
embedded Hyperbole buttons, the system inserts into news postings the same comment that
is included within mail messages, if enabled. See Section 2.7.6 [Buttons in Mail], page 20,
for details and an explanation of how to turn this feature on.
22
3 Smart Keys
Hyperbole offers two special Smart Keys, the Action Key and the Assist Key, that perform
an extensive array of context-sensitive operations across emacs usage. In many popular
modes, they allow you to perform common, sometimes complex operations without having to
a different key for each operation. Just press a Smart Key and the right thing happens. This
chapter explains typical uses of the Smart Keys. See Appendix E [Smart Key Reference],
page 85, for complete descriptions of their behavior in all contexts.
3.1 Smart Key Bindings
From the keyboard, {M-RET} is the Action Key and {C-u M-RET} is the Assist Key. These
keys allow context-sensitive operation from any keyboard.
From the mouse, the Action Key is bound to your shift-middle mouse key (or shift-left
on a 2-button mouse) and the Assist Key is bound to your shift-right mouse key, assuming
Hyperbole is run under an external window system. (InfoDock users or those who set the
variable, hmouse-middle-flag, to ‘t’ before loading Hyperbole, may also use the middle
mouse key as the Action Key).
If you prefer other key assignments, simply bind the commands action-key and
assist-key to keyboard keys. hkey-either may be used instead if you prefer a single key
binding for both commands; a prefix argument, such as {C-u}, then invokes assist-key.
You may also bind action-mouse-key and assist-mouse-key to other mouse keys, if you
like, though you won’t be able to execute drag actions with such key bindings.
Mouse configuration of the Smart Keys is automatic for GNU Emacs under Mac OS X,
the X Window System and MS Windows, as well as for XEmacs and InfoDock under the X
window system, assuming your emacs program has been built with support for any of these
window systems.
If you ever want to restore the mouse bindings that existed before Hyperbole was
loaded, use the hmouse-toggle-bindings command. It switches between the Hyperbole
mouse key bindings and those set prior to loading Hyperbole and then back again
if invoked once more. There is no default key binding for this command; use {M-x
hmouse-toggle-bindings RET}. Alternatively, you may select a key and bind it as
part of any setting of hyperbole-init-hook within your personal ~/.emacs file. For
example,
(add-hook 'hyperbole-init-hook (lambda () (global-set-key "\C-ct"
'hmouse-toggle-bindings))).
Under InfoDock, the middle mouse key is normally used as the Action Key and the
meta-middle mouse key is used as the Paste Key. If you prefer that the middle mouse
key be used as the Paste Key, then you will want to toggle the mouse bindings. InfoDock
includes a built-in way to do this via its Options/Mouse/Mouse-Paste-on-Middle-Key menu
item. (Keep in mind though that the Action Key will paste any active region within the
editor when the Action Key is clicked; it will not paste selections from other applications).
3.2 Smart Key Operations
The Action Key generally selects entities, creates links and activates buttons. The Assist Key generally provides help, such as reporting on a button’s attributes, or serves a
complementary function to whatever the Action Key does within a context.
Chapter 3: Smart Keys
23
The Hyperbole Doc/SmartKeys menu entry displays a summary of what the Smart Keys
do in all of their different contexts. Alternatively, a click of the Assist Mouse Key in the
right corner of a window modeline (within the rightmost 3 characters) toggles between
displaying this summary and hiding it. Reference this summary whenever you need it.
The following table is the same summary. Much of the browsing power of Hyperbole
comes from the use of the Smart Keys, so spend some time practicing how to use them.
Study what modeline clicks and window drag actions do as these will give you a lot of
power without much effort. This table may appear daunting at first, but as you practice
and notice that the Smart Keys do just a few context-sensitive things per editor mode, you
will find it easy to just press or point and click and let Hyperbole do the right thing in each
context.
========================================================================================
Smart Keys
Context
Action Key
Assist Key
========================================================================================
Hyperbole
On a minibuffer menu item
Activates item
Item help
On an explicit button
Activates button
Button help
Reading argument
1st press at an arg value
Value copied to minibuffer <- same
2nd press at an arg value
Value used as argument
<- same
In minibuffer
Accepts minibuffer arg
Completion help
On an implicit button
Activates button
Button help
Within a koutline cell
Collapses and expands
Shows tree props
Left of a koutline cell
Creates a klink
Moves a tree
HyRolo Match Buffer
Edits entries and mails to e-mail addresses
Mouse or Keyboard Display Control
Line end, not end of buffer
smart-scroll-proportional
= t
(default)
Makes curr line top line
Bottom line
= nil
Scrolls up a windowful
Scrolls down
End of Any Help buffer
Restores screen to the previous state
Read-only View Mode
Scrolls up a windowful
Scrolls wind down
Mouse-only Control
Drag from thing start or end
A thing is a delimited
expression, such as a
string, list or markup
language tag pair
Drag from shared window side
or from left of scroll bar
Yanks thing at release
Kills thing and yanks
at release
Resizes window width
<- same
Modeline press+wind release
Click in modeline
Left modeline edge
Right modeline edge
Other blank area
Resizes window height
<- same
Buries current buffer
Info manual browser
Action Key modeline hook
Show/Hide Buffer Menu
Unburies bottom buffer
Smart Key summary
Assist Key modeline hook
Popup Jump & Manage Menu
Drag between windows
Drag in window, region active
Horizontal drag in a window
Vertical drag in a window
Creates/modifies a link
Error, not allowed
Splits window below
Splits window side-by-side
Swaps wind buffers
Error, not allowed
Deletes window
Deletes window
Chapter 3: Smart Keys
Diagonal drag in a window
Active region exists
24
Saves wconfig
Yanks sexp at release
Restores wconfig from ring
Kills & yanks sexp at release
Hyperbole Key Press/Click in Special Modes
Emacs push button
Activates button
Button help
Thing begin or end
Mark thing region
Mark & kill thing region
C,C++,Objective-C,Java Modes Jumps to id/include def
Jumps to next def
Java Cross-reference Tag
Jumps to identifier def
Jumps to next def
JavaScript and Python Modes
Jumps to identifier def
Jumps to next def
Assembly Language Mode
Jumps to id/include def
Jumps to next def
Any Lisp or Fortran Mode
Jumps to id def
Jumps to next def
Emacs Lisp Compiler Error
Jumps to def with error
<- same
Grep or Occur Match
Jumps to match source line <- same
Multi-buffer Occur Match
Jumps to match source line <- same
Etags `TAGS' file entry
Jumps to source line
Button help
Ctags file entry
Jumps to source line
Button help
Texinfo Cross-reference
Before opening brace
Jumps to Texinfo referent Button help
Within braces
Jumps to Info referent
Button help
Menu Item or node hdr
Jumps to Texinfo referent Button help
Include file
Jumps to Texinfo referent Button help
code/var reference
Displays doc for referent Button help
Org Mode
Follows links and cycles outline views
Outline Major/Minor Modes
Collapses, expands, and moves outline entries
Man Apropos
Displays man page entry
<- same
Man Pages
Follows cross refs, file refs and C code refs
I/Buffer Menu
Saves, deletes and displays buffers
Emacs Info Reader
Menu Entry or Cross Ref
Up, Next or Prev Header
File entry of Header
End of current node
Anywhere else
Subsystems
Calendar
GNU Debbugs Tracker
Dired Mode
GNUS News Reader
Mail Reader and Summaries
OO-Browser
Tar Mode
To referent
To referent
To top node
To next node
Scrolls up a windowful
<- same
To prior node
To (DIR) node
To previous node
Scrolls wind down
Scrolls or shows appts
Scrolls/marks date
Displays issue discussion Displays issue status
Views and deletes files from dir listing
Toggles group subscriptions, gets new news,
and browses articles
Browses, deletes and expunges messages
Browses object classes and elements
Views and edits files from tar archive files
Any other context (defaults)
Invalid context error
Invalid context error
========================================================================================
See Appendix E [Smart Key Reference], page 85, for extensive reference documentation on
the Smart Keys.
Note how the last line in the table explains that the default behavior of the Smart Keys
in an unknown context is to report an error. You can change these behaviors by setting two
variables. See the documentation for the variables action-key-default-function and
assist-key-default-function for information on how to customize the behavior of the
Smart Keys within default contexts.
Chapter 3: Smart Keys
25
When you use a mouse and you want to find out what either of the Smart Keys does
within a context, depress the one you want to check on and hold it down, then press the
other and release as you please. A help buffer will pop up explaining the actions that will
be performed in that context, if any. A press of either Smart Key at the end of that help
buffer will restore your display to its configuration prior to invoking help.
On the keyboard, {C-h A} displays this same context-sensitive help for the Action Key
while {C-u C-h A} displays the help for the Assist Key. Note that {C-h a} performs a
function unrelated to Hyperbole, so you must press the shift key when you type the A
character.
3.3 Smart Key Modeline
Smart Key clicks on a window’s modeline offer many powerful browsing features including
user manual browsing, as well as window, buffer and frame selection.
A click of the Action Mouse Key in the right corner of a window modeline (within the
rightmost 3 characters) displays or hides the GNU Info Manual Browser, giving you quick
point and click access to an amazing wealth of documentation, since the Action Key also
browses through these manuals and follows their hyperlinked cross-references. A click of
the Assist Key in the same location displays or hides the Smart Key summary, as noted
earlier.
An Action Mouse Key click in a blank area of a window modeline (away from left and
right edges) toggles between displaying and hiding a list of all buffers. Once displayed,
each buffer is selectable with the Action Key as well. A click in the same location of the
Assist Key displays a quick access menu of display-oriented commands. You can jump
to buffers categorized by major mode, jump to windows by buffer name, or to frames by
name. Manage your windows and frames quickly with this menu as well. As always with
Hyperbole, just try it and you’ll begin to wonder how you lived without it before.
Hyperbole modeline mouse click actions are controlled by the two functions,
action-key-modeline and assist-key-modeline. If you know a little Emacs Lisp you
can change these to do whatever you like. When a Smart Key press is on a blank part of
a modeline but not at the left or right, the function given by one of these two variables
is executed: action-key-modeline-function or assist-key-modeline-function. By
default, the Action Key toggles between displaying and hiding the buffer menu. If you
like the more advanced features of Ibuffer Mode, you can change the buffer menu to use
that with the following in your Emacs initialization file: (setq action-key-modelinefunction #'hmouse-context-ibuffer-menu). To set it back to the default use: (setq
action-key-modeline-function #'hmouse-context-menu).
The default assist-key-modeline-function is to pop up a menu of convenient screen
commands that lets you select buffers grouped by major mode, use HyControl, or jump to
specific windows, window configurations or frames. If you would prefer it runs the directory
editor dired on the directory associated with the window of the modeline press, use this:
(setq assist-key-modeline-function #'dired-jump). To set it back to the default use:
(setq assist-key-modeline-function #'hui-menu-screen-commands).
These variables may also be changed permanently with the Emacs interactive
customization interface.
Use {M-x customize-variable RET assist-key-modeline-
Chapter 3: Smart Keys
26
function RET}. In the Assist Modeline Function text field that appears, change the value
to dired-jump. Then press the “Apply and Save” button.
3.4 Smart Key Thing Selection
Hyperbole has some radically cool ways to select regions of structured text or source code
and to copy or move them between buffers with a single mouse drag or two key presses. A
great deal of smarts are built-in so that it does the right thing most of the time; many other
attempts at similar behavior such as thing.el fail to deal with many file format complexities.
We use the term things to refer to structured entities that Hyperbole can select. These
include: delimited pairs of (), {}, <>, [] and quote marks, source code functions, source code
comments and matching tag pairs in HTML and SGML modes. Delimited things are those
things that contain a selectable delimiter such as an opening parenthesis.
The best way to mark a delimited thing is to move your cursor to the starting delimiter
of the thing and then press the Action Key. Typically, you will see the thing highlight. You
can then operate upon it as you would any Emacs region. In many cases, you can do the
same thing upon the closing delimiter but this is not as reliable. An Action Key press on
the start of an HTML or SGML tag pair marks the entire region span of the pair. If you
use the Assist Key instead, it will mark and kill (delete) the thing.
Even better are Smart Mouse Key drags which let you copy or move delimited things
in one operation without even highlighting them. To copy, simply drag with the Action
Key from a thing’s opening delimiter and release somewhere outside of the thing, either
within the same window or within another window. The thing will be copied to the point
of release. If you want to move a thing, simply perform the same drag but with the Assist
Mouse Key. Ensure that you do not move any explicit buttons from one buffer to another
as that does not presently work.
Try out some of these operations in HTML or source code files to see how they can speed
your editing.
Hyperbole also binds two convenience keys for working with things.
The first such key is {C-c RET} hui-select-thing which selects bigger and bigger syntactic regions with each successive use. Double or triple clicks of the Selection Key (left
mouse key) do the same thing. The first press selects a region based upon the character
at point. For example, with point over an opening or closing grouping character, such as
{ or }, the whole grouping is selected, e.g. a C function. When on an or - within a
programming language identifier name, the whole name is selected. The type of selection
is displayed in the minibuffer as feedback. When using a language in which indentation
determines nesting level like Python, a double click on the first alpha character of a line,
such as an if statement, selects the whole statement. Use {C-g} to unmark the region when
done. Use, hui-select-thing-with-mouse if you want to bind this to a different mouse
key to use single clicks instead of double clicks.
The second convenience key is bound only in HTML/web mode. {C-c .} hui-selectgoto-matching-tag jumps between the opening and closing tag of a pair. It moves point
to the start of the tag paired with the closest tag that point is within or which it precedes.
A second press moves point to the matching tag of the pair, allowing you to quickly jump
back and forth between opening and closing tags.
Chapter 3: Smart Keys
27
3.5 Smart Key Argument Selection
A prime design criterion of Hyperbole’s user interface is that you should be able to see what
an operation will do before using it. The Assist Key typically shows you what a button or
minibuffer menu item will do before you activate it. Hyperbole also displays the result of
directly selecting an argument value with the Action Key, to provide feedback as to whether
the correct item has been selected. A second press/click is necessary before an argument is
accepted and processed.
Many Hyperbole commands prompt you for arguments. The standard Hyperbole user
interface has an extensive core of argument types that it recognizes. Whenever Hyperbole
is prompting you for an argument, it knows the type that it needs and provides some error
checking to help you get it right. More importantly, it allows you to press the Action Key
within an entity that you want to use as an argument and it will grab the appropriate thing
and show it to you at the input prompt within the minibuffer. If you press (click with
a mouse) the Action Key on the same thing again, it accepts the entity as the argument
and moves on. Thus, a double click registers a desired argument. Double-quoted strings,
pathnames, mail messages, Info nodes, dired listings, buffers, numbers, completion items
and so forth are all recognized at appropriate times. All of the argument types mentioned in
the documentation for the Emacs Lisp interactive function are recognized. Experiment
a little and you will quickly get used to this direct selection technique.
Wherever possible, standard Emacs completion is offered, as described in Section “Completion” in the GNU Emacs Manual. Remember to use {?} to see what your possibilities for
an argument are. Once you have a list of possible completions on screen, press the Action
Key twice on any item to enter it as the argument.
3.6 Smart Key Modifiers
For advanced users of Emacs and Hyperbole, there is hmouse-mod-mode, a global minor
mode which turns the Action Mouse Key into a Control modifier key and the Assist Key
into a Meta modifier key. This allows for better keyboard energy balance across hands and
is useful for reducing carpal tunnel stress. It may also be used with a chord keyboard in
one hand and a mouse in the other to point at things while simultaneously operating upon
them.
Use the hmouse-mod-mode global minor mode to enable this feature. {C-u M-x
hmouse-mod-mode RET} enables it and adds ‘HyMod’ to the list of modeline minor modes.
{C-u 0 M-x hmouse-mod-mode RET} disables it and {M-x hmouse-mod-mode RET} toggles it
on and off.
When enabled, if the Action Key is held down while alpha characters are typed, they
are translated into Control keys instead. The Assist Key translates them into Meta keys.
When both Smart Keys are depressed, Control-Meta keys are produced. The commands
bound to the characters produced are then run. For example, Action Key + {a} runs the
function for {C-a}. If no keys are typed while the Smart Keys are down, they operate as
normally under Hyperbole.
The code for Smart Key modifiers can be found in ${hyperb:dir}/hmouse-mod.el.
Chapter 3: Smart Keys
28
3.7 Smart Key Debugging
Typically, {C-h A} and {C-u C-h A} which show Action and Assist Key help for the current
context, are sufficient for seeing how the Smart Keys behave no matter where they are used.
However, if a Smart Key ever behaves differently than you think it should or if you want
to test how the Smart Keys respond in a new context, then the Smart Key debugging flag
may be of use. You toggle it on and off with {C-h h c d} (minibuffer menu Cust/DebugToggle). Once enabled, this displays a message in the minibuffer each time the Action or
Assist Key is released, showing the context of the press and its associated action, so you
can see exactly what is happening whenever you use a Smart Key. These messages are all
prefaced with “(HyDebug)” and logged to the “*Messages*” buffer for later viewing.
If you do find a problem with the Smart Keys and want to report a bug, use {C-h h m
r} to compose an email message to the bug-hyperbole list. Hyperbole will automatically
include all of the “(HyDebug)” messages from your current emacs session into your email.
Similarly, when you compose an email to the hyperbole-users mailing list with {C-h h m c},
these messages are also included.
29
4 Menus
Under InfoDock, XEmacs, and Emacs, pulldown and popup menus are available to invoke
Hyperbole commands, including those from the rolo and the outliner. These menus operate
like any other application menus and are fairly self-explanatory. Use the Remove-This-Menu
command on the Hyperbole menubar menu to get rid of the menu if you do not need it.
Invoking Hyperbole from the keyboard, as explained below, will add the menu back to the
menubar.
Image 4.1: Hyperbole Menubar Menu
The rest of this section discusses only the specialized minibuffer menus which appear
in the minibuffer window and work with all emacs versions on all display devices. They
provide similar capabilities to those of the Hyperbole menubar but additionally allow for
fast menu item selection via the keyboard or mouse. When used with the keyboard, they
provide command access similar to key bindings.
Chapter 4: Menus
30
The top-level Hyperbole menu is invoked from a key given in your hyperbole.el file
(by default, {C-h h}) or with a click of the Action Mouse Key in the minibuffer.
All menu items are selected via the first character of their names (letter case does not
matter) or with presses of the Action Key. "/" at the end of an item name indicates that
it brings up a submenu. A press of the Assist Key on an item displays help for the item,
including the action that it performs.
While a menu is active, to re-activate the top-level Hyperbole menu, use {C-t} or press
the Action Key while on the menu prefix (before the ‘>’ character). This allows you to
browse the submenus and then return to the top menu. You can quit without selecting an
item by using {q} or pressing {RET} when at the end of a menu. {C-g} aborts from the
minibuffer whether you are at a menu prompt or any other Hyperbole prompt.
The top-level Hyperbole menu appears in the minibuffer and should look like this:
Hy>
Act Butfile/ Cust/ Doc/ Ebut/ Find/ Gbut/ Hist Ibut/ Kotl/ Msg/ Rolo/ Screen/ Win/
Each menu item may be selected by typing its first letter (case insensitive), by clicking the
Action Mouse Key on it, or by using {TAB} or {M-f} to move forward an item, {Shift-TAB}
or {M-b} to move backward an item and {RET} to select the current item.
The top-level Hyperbole minibuffer menu items serve the following purposes:
Act
Activation of any button at point. If there is no button at point, it prompts
for the label of an explicit button within the current buffer to activate.
Butfile/
Easy access to a directory-specific or personal file of buttons. HYPB is the name
of the directory-specific button file and ~/.hyperb/HYPB is the personal file
of global buttons. These are good places to begin experimenting with button
creation.
Cust/
Hyperbole option customization. This includes whether ftp and www URLs are
recognized by the find-file commands, where Hyperbole link referents are
displayed, where URLs are displayed, where web search results are displayed,
whether date stamps are added to rolo entries, and whether to use proportional
or windowful scrolling when a Smart Key is pressed at the end of a line. See
Section B.3 [Customization], page 71.
The ‘KeyBindings/’ submenu allows individual changes to each keyboard key
that Hyperbole binds for its commands, notably the Action Key. See Section 3.1
[Smart Key Bindings], page 22, for more information.
See Appendix C [Global Key Bindings], page 75, for complete descriptions of
Hyperbole’s global key bindings, how to temporarily disable them and how to
manage its overriding of local bindings that hide global Hyperbole keys.
Ebut/
All explicit button commands. The window-system-based Hyperbole menu includes an activation menu item for each explicit button found in the current
buffer.
Doc/
Hyperbole documentation quick access. This menu contains an About item
which describes Hyperbole and a Demo item which demonstrates a number
of interactive Hyperbole features. It also contains the Types/ submenu for
documentation on Hyperbole implicit button and action types.
Chapter 4: Menus
Find/
31
Buffer and file line finding commands and web searching. This menu brings
together many existing line finding commands that are difficult to recall quickly
when needed, simplifying finding and then jumping to matching lines by using
the Action Key. It includes commands for filtering a buffer to just those lines
that either match or do not match a regular expression. It also includes a
submenu for quick access to popular web search engines.
Below are each of the commands on the Find menu.
• GrepFiles - Show numbered line matches for a regexp in all non-backup,
non-auto-save files below the current directory. If in an Emacs Lisp mode
buffer and no PREFIX-ARG is given, limit search to only .el and .el.gz
files. Set hypb:rgrep-command to change the grep command or options.
• LocateFiles - Prompt for a pattern and display a list of all matching pathnames found throughout the file system. On Mac OS X, this uses Spotlight
(the mdfind command); on UNIX, it uses the locate command. Within
the resulting *Locate* buffer, Find/Grep-Files will find matching lines
within only these paths (files and directories).
• MatchFileBuffers - Show numbered line matches for regexp in all file-based
buffers.
• OccurHere - Show numbered line matches for regexp from this buffer.
• RemoveLines - Following point, remove all lines that match regexp.
• SaveLines - Following point, keep only lines that match regexp.
• Web/ - Select a search engine and term and search with them. Hyperbole
binds the key {C-c /} for quick access to this menu, if it is not already
bound prior to Hyperbole’s initialization. The Cust/Web-Search menu sets
the option, hyperbole-web-search-browser-function, which determines
whether web search results are displayed within Emacs or with an external
web browser. A short video introduction to the Find/Web menu may be
found at https://youtu.be/8lMlJed0-OM. The Find/Web menu looks
like this:
Web>
Amazon Bing Dictionary Elisp Facebook Google Hub(git) Images
Maps RFCs StackOverflow Twitter Wikipedia Youtube
Gbut/
All global button commands. Global buttons are accessed by name rather than
by direct selection. The window-system-based Hyperbole menu also includes
an activation menu item for each global button.
Hist
Return to previous positions in the button traversal history.
Ibut/
All implicit button commands.
Msg/
Hyperbole-specific email messaging commands. Use this to send mail to a
Hyperbole discussion mailing list.
Kotl/
Autonumbered, structured outliner and hyper-node manager commands. See
Chapter 6 [Koutliner], page 36.
Rolo/
Hierarchical, multi-file rolo lookup and edit commands. See Chapter 7 [HyRolo],
page 48.
Chapter 4: Menus
32
Screen/
Window, frame and buffer display control commands. See Chapter 5 [HyControl], page 33.
Win/
Window configuration management, such as adding and restoring window configurations by name. See Chapter 8 [Window Configurations], page 54.
33
5 HyControl
Hyperbole includes the fastest, easiest-to-use Emacs window and frame management system
available, HyControl, found under the Hyperbole Screen menu. If you use a lot of Emacs
windows or frames (typically, window system windows) then this chapter is for you.
HyControl interactively adjusts the layout of your windows and frames down to the
pixel-level if desired. You adjust the location, size and display elements of your windows
and frames until they look as you like and then simply quit HyControl and go back to work.
Hyperbole binds the key {C-c \} for quick access to HyControl’s window control
menu, if it was not already bound prior to Hyperbole’s initialization; otherwise, the
Screen/WindowsControl minibuffer menu item, {C-h h s w}, will do the same thing. To
start HyControl with the frames menu instead, use Screen/FramesControl, {C-h h s f}.
Once in HyControl, your minibuffer window at the bottom of the selected frame will
display a summary of keys you may use to adjust your windows until you press {q} or
{ESC} to quit from HyControl. The key, {t}, will always toggle between controlling frames
and windows, the submodes of HyControl, with the upper left of the minibuffer prompt
showing which type of control is active.
A number of commands take a single numeric argument, e.g. movement and sizing, which
you can enter by typing a period to clear the argument, followed by any positive number
up to 1000. You may also use the {C-u} universal argument key to apply a multiplier of
4 to the argument, any number of times. Any entry that pushes the argument over 1000,
restarts it, so 10005 would produce an argument of 5.
The table below explains what each key does in HyControl mode. If the explanation does
not say otherwise, then the key applies in both window and frame submodes.
{.}
Clear the argument to a value of 0.
{0-9}
Multiply the argument by 10 and add the digit pressed.
{h}
Increase height by argument lines (line height determined by buffer character
height).
{s}
Shorten height by argument lines.
{w}
Widen by argument characters.
{n}
Narrow by argument characters.
{%}
In FRAME mode, resize frame’s height and width to about argument percent
of the screen size.
{H}
In FRAME mode, resize frame’s height to about argument percent of the screen
size.
{W}
In FRAME mode, resize frame’s width to about argument percent of the screen
size.
{up}
{down}
{left}
{right}
Move frame in the specified direction by argument pixels.
Chapter 5: HyControl
{c}
34
In FRAME mode, with each press, cycle the selected frame’s position clockwise
through the middle of edges and corners of the screen. With an argument of 0,
reset the cycle position to the upper left corner. Respects the pixel edge offsets
returned by hycontrol-get-screen-offsets.
{keypad number}
In FRAME mode, move the frame directly to the screen edge position given
by the numeric keypad layout. For example, 3 moves the frame to the bottom
right corner and 8 moves it to the middle of the top edge. Keypad numeric
keys do not adjust the argument. Respects the pixel edge offsets returned by
hycontrol-get-screen-offsets.
{d}
Delete selected window or frame based on mode.
{D}
Prompt for confirmation and then delete non-selected windows or frames based
on mode.
{o}
Select the next window in the window list, across all visible frames.
{O}
Select the next visible frame.
{[}
Create a new atop window or frame depending on mode. If a frame, it is sized
to the same size as the selected window and offset from the selected frame by
the pixel amounts given by hycontrol-frame-offset.
{]}
Create a new sideways window or frame depending on mode.
{(}
Save the current window or frame configuration based on mode. Whenever,
HyControl is invoked, the current window and frame configurations are saved
automatically. So use this command only if you have changed the configuration
and wish to save it temporarily.
{)}
After confirmation, restore the last saved window or frame configuration based
on mode.
{f}
In WINDOW mode, delete the selected window and redisplay its buffer in a
new frame.
{i}
{j}
{k}
{m}
In Frame mode, expand the selected frame to the associated screen edge based
on key layout. i=top, j=left, k=right and m=bottom screen edge. Respects
the pixel edge offsets returned by hycontrol-get-screen-offsets.
{=}
Make the current frame’s windows or all frames approximately the same size
based on mode. In FRAME mode, all visible frames are set to the size of the
selected frame.
{-}
Make the selected window or frame (based on mode) as small as possible while
still displaying it.
{+}
Make the window or frame (based on mode) as large as possible. In FRAME
mode, a second press of this key restores its size to whatever it was prior to the
first use of this command.
35
{b}
Bury the selected buffer within the buffer list, displaying the next buffer.
{u}
Unbury the bottom buffer in the buffer list and display it in the selected window.
{~}
Swap two buffers between the selected window or frame and one other. In
WINDOW mode, there must be precisely two windows in the selected frame.
In FRAME mode, the second frame mush have a single window.
{Z}
Zoom in selected window or frame text based on mode, increasing default face
size.
{z}
Zoom out selected window or frame text based on mode, increasing default face
size. Zooming supports an argument of between 1 and 9 (any other value sets
the argument to 1). The argument determines the number of sizes by which to
zoom.
FRAME mode zooming requires the separately available zoom-frm.el library.
WINDOW zooming works without this library.
{t}
Toggle between WINDOW and FRAME submodes.
{q or ESC}
Quit from HyControl mode and restore normal key bindings.
The rest of this section goes into some technicalities about HyControl settings. You may
ignore it if you are not familiar with Emacs variables and functions or with customized
Emacs.
HyControl allows placement of frames at screen edges and corners. with the frame cycle
command, {c}, and direct placement matching the layout of the numeric keypad keys, if
available. (Note that a screen may span multiple physical monitors). To prevent widgets
and toolbars at the corners of the screen from being obscured, HyControl can offset each
frame from each screen edge by a fixed number of pixels. These offsets are specified by
the variable, hycontrol-screen-offset-alist and can differ for each type of screen; see
its documentation for details. If you change its value, then call hycontrol-set-screenoffsets to set any new offset values. hycontrol-get-screen-offsets returns the list of
offsets in clockwise order starting from the top edge. Both functions display a minibuffer
message with the current offsets when called interactively.
When HyControl creates a new frame, it automatically sizes it to the same size as the
previously selected frame and offsets it from that frame by the (X . Y) number of pixels
given in the variable, hycontrol-frame-offset.
The source code for the HyControl system is in hycontrol.el within your Hyperbole
source directory, given by hyperb:dir. Presently, you must edit the code to change any of
HyControl’s internal key bindings. Eventually, standard local key bindings will be provided.
You can however bind the two HyControl invocation commands to keys. These commands
are, hycontrol-windows and hycontrol-frames. Generally, you need only one of these
bound to a key since when you press that key, the other command can be reached by
pressing {t}.
36
6 Koutliner
The Hyperbole outliner, the Koutliner (pronounced Kay-outliner), produces structured,
autonumbered documents composed of hierarchies of cells. Each cell has two identifiers, a
relative identifier indicating its present position within the outline and a permanent identifier called an idstamp, suitable for use within hyperlink references to the cell. The idstamp
is typically not displayed but is available when needed. See Section 6.3 [Autonumbering],
page 39.
Cells also store their time of creation and the user who created the cell. User-defined
attributes may also be added to cells. See Section 6.8 [Cell Attributes], page 46.
The outliner works under GNU Emacs, XEmacs or under InfoDock. You can tell whether
you are running a version of Emacs which supports the outliner by pressing {C-h h} to
display the Hyperbole menu ({q} will quit). If you see a ‘Kotl/’ entry in the menu, then
the outliner is available. Otherwise, the outliner does not work with your version of Emacs,
so this section of the manual will not be of interest to you. (The same is true of the
Hyperbole/Outline pulldown menu; if it appears, the outliner is available for use.)
This chapter expands on the information given in the EXAMPLE.kotl file included with
Hyperbole. Use {C-h h k e} to display that file, as pictured on the following page. It is an
actual outline file that explains major outliner operations. You can test out the viewing,
editing and motion commands with this file since a personal copy is made when you invoke
this command.
See Appendix D [Koutliner Keys], page 77, for a full summary of the key bindings and
commands available in the outliner.
Chapter 6: Koutliner
37
Image 6.1: Koutliner Screenshot
6.1 Menu Commands
The Kotl/ menu entry on the Hyperbole minibuffer menu provides access to a number of
major outliner commands:
Menu Item
Command
Description
====================================================================
All
kotl-mode:show-all
Expand all cells
Blanks
kvspec:toggle-blank-lines Toggle blank lines on or off
Create
kfile:find
Edit or create an outline
Downto
kotl-mode:hide-sublevels
Hide cells deeper than a level
Examp
<sample outliner file>
Show self-descriptive example
Hide
kotl-mode:hide-tree
Hide tree with root at point
Info
<outliner documentation>
Show outliner manual section
Kill
kotl-mode:kill-tree
Kill the current tree
Link
klink:create
Create a link to another cell
Overvw
kotl-mode:overview
Show first line of each cell
Show
kotl-mode:show-tree
Show tree with root at point
Top
kotl-mode:top-cells
Collapse to top-level cells
Vspec
kvspec:activate
Set a view specification
====================================================================
Chapter 6: Koutliner
38
The popup and menubar Koutline menu, as displayed on the following page, offers a
more complete set of the Koutliner commands. Experiment with the menu or read the
following sections explaining commands.
Image 6.2: Koutline Menu
6.2 Creating Outlines
In addition to the Kotl/Create menu item, you can create and experiment with outline
files simply by finding a file, {C-x C-f}, with a .kotl suffix. .kot will also work for users
impaired by operating systems with 3-character suffix limitations.
Chapter 6: Koutliner
39
When a new koutline is created, an invisible root cell is added. Its permanent and relative
ids are both 0, and it is considered to be at level 0 in the outline. All visible cells in the
outline are at level 1 or deeper, and thus are descendants of this root cell. Some koutliner
commands prompt for cell numbers as arguments. An argument of 0 makes commands
operate upon the entire outline.
An initial level 1 cell is also created to make it easy to start entering text in the outline.
A koutline always has at least one visible cell in it.
See Section 6.3 [Autonumbering], page 39, which explains how cells are labeled according
to their respective levels in the outline and how these labels are updated as the structure
of the outline changes.
6.3 Autonumbering
See Section 6.5.1 [Adding and Killing], page 40, for information on how to add new cells to
or remove cells from a koutline. As you do this, or as you promote or demote cells within
the outline, the labels preceding the contents of each cell automatically update to reflect
the new structure. These labels are also known as autonumbers and as relative ids because
they change as the structure changes.
The outline structure is shown by these labels and by the indentation of each outline
level. Normally, each deeper level is indented another three characters, to reflect the nesting.
The default autonumbers are called alphanumeric labels because they alternate between
using numbers and letters to distinguish each successive level. Each alphanumeric label
uniquely identifies a cell’s position in an outline, so that there is no need to scan back to
prior cells to see what the current section number of an outline is. This is similar to a
legal numbering scheme but without all the period characters between level numbers. As
an example, 1b3 is equivalent to a legal label of 1.2.3. Both refer to the 3rd cell at level 3,
below the 2nd child of the first cell at level 1. Said another way, this is the 3rd child of the
1st cell’s 2nd child. In other words, it is easier to visualize hierarchies than to talk about
them.
Alphanumeric labels are the default because they are shorter and easier to read aloud
than equivalent legal ones. They also simplify distinguishing between even and odd level
labels because of the alternating character set.
You can change the labeling scheme used in a particular outline with the command {C-c
C-l}. A {?} will show all of the labeling options. The default, alpha labels, legal labels,
and permanent idstamps (permanent cell ids) are all available.
A cell label is normally followed by a period and a space, called the label separator, prior
to the start of the cell contents. You can change the separator for the current outline with
{C-c M-l}. {C-u C-c M-l} will additionally change the default separator value used when
new outlines are created (for the current session only). For example, use the value " " (two
spaces) to get eliminate the trailing period after each cell label. The separator must be at
least two characters long but may be longer.
If you find a separator that you prefer for all outlines, change the separator setting permanently by adding the following line to your Emacs initialization file, ~/.emacs, substituting
for ‘your-separator’:
(setq kview:default-label-separator "your-separator")
Chapter 6: Koutliner
40
6.4 Idstamps
Idstamps (permanent ids) are associated with each cell. They maintain hyperlinks as cells
are reordered within a koutline. See Section 6.7 [Links], page 45. Idstamps may be displayed
in place of the outline level relative ids. Use {C-c C-l id RET}.
An idstamp counter for each outline starts at 0 and is incremented by one each time a
cell is added to the outline. This idstamp stays with the cell no matter where it is moved
within the outline. If the cell is deleted, its idstamp is not reused.
The 0 idstamp is always assigned to the root node of the entire outline. This node is
never visible within the outline, but is used so that the outline may be treated as a single
tree when needed. Idstamps always begin with a 0, as in 012, to distinguish them from
relative ids.
6.5 Editing
Text editing within the Koutliner works just as it does for other buffers, except when you
need to deal with the structural components of an outline. Within the contents of a cell,
all of your standard editing keys should work properly. You can just type in text and the
left and right margins of the lines will be maintained for you. See Section 6.5.4 [Filling],
page 42, for the times when you need to refill a paragraph or to control when filling occurs.
Don’t invoke editing commands with {M-x command-name RET} since the Koutliner uses
differently named commands made to act like the regular editing commands. Koutliner
commands, however, account for the structure and indentation in koutlines.
You may use the mouse to select parts of the contents of a single cell for editing. But
don’t drag across cell boundaries and then edit the selected region, since that will destroy
the outline structure.
6.5.1 Adding and Killing
{C-j} adds a new cell as a successor sibling of the current cell, that is, the next cell at the
same level as the current cell. If you enter a positive number as a prefix argument, that
number of cells will be inserted, all at the same level. {C-u C-j} is handled specially. It
adds a single cell as a child of the current cell. {C-c a} does the same thing. {C-c p} adds
the cell as the successor of the current cell’s parent.
{C-c C-k} kills the current cell and its entire subtree. {C-c k} kills the contents of a
cell from point through the end of the cell; it does not remove the cell itself. {C-u C-c k}
kills the entire contents of the cell regardless of the location of point. You may then yank
the contents into another cell or another buffer with {C-y}.
6.5.2 Relocating and Copying
Demotion is the act of moving a tree down one or more levels in the outline. The new tree
will become either the successor or the first child of the cell which precedes it in the outline.
Promotion is the inverse operation. Note that trees (cells and their entire substructure) are
promoted and demoted, not individual cells.
Trees may be demoted or promoted by pressing TAB or {M-TAB} (or {SHIFT-TAB}) respectively, as in most outliners today. {M-0 TAB} and {M-0 M-TAB} demote and promote
trees and additionally refill each cell that is not specially marked to prevent refilling. See
Chapter 6: Koutliner
41
Section 6.5.4 [Filling], page 42. A positive or negative prefix argument to these commands
promotes or demotes the tree up to a maximum of the number of levels given by the argument. The outline may not support movement of the tree by the number of levels requested,
however, in which case the maximal possible adjustment is made.
{M-1 TAB} behaves specially. It toggles the function of TAB and {M-TAB} so that they
insert a tab and remove the previous character, respectively. This is useful when one is
formatting information within a single cell. When in this mode, {TAB} inserts a literal TAB
character, by default. Set the variable, kotl-mode:indent-tabs-mode, to ‘nil’ if you want
space characters used to form the tab. Use {M-1 TAB} to toggle the TAB and {M-TAB} keys
back to promoting and demoting trees.
For maximum flexibility in rearranging outlines, there are commands that move or copy
entire trees. Each of these commands prompts for the label of the root cell to move or copy
and for a second cell which specifies the new location for the moved or copied tree. You
may either accept the default provided, type in the cell label, or when a mouse is available,
simply double click with the Action Key on the contents of a cell. The Koutliner knows to
use the cell’s label in such cases.
In the following commands, words delimited with <> represent the arguments for which
each command prompts. Note how the use of prefix arguments changes each command’s
behavior from insertion at the sibling level to insertion at the child level.
{C-c c}
Copy <tree> to be the successor of <cell>.
{C-u C-c c}
Copy <tree> to follow as the first child of <cell>.
{C-c C-c} Copy <tree> to be the predecessor of <cell>.
{C-u C-c C-c}
Copy <tree> to be the first child of the parent of <cell>.
{C-c m}
Move <tree> to be the successor of <cell>.
{C-u C-c m}
Move <tree> to follow as the first child of <cell>.
{C-c C-m} Move <tree> to precede <cell>.
{C-u C-c C-m}
Move <tree> to be the first child of the parent of <cell>.
If you have mouse support under Hyperbole, you can move entire trees with mouse clicks.
Click the Assist Key within the indentation to the left of a cell and you will be prompted
for a tree to move. Double click the Action Key within the contents of the root cell of the
tree to move and then double click within the root contents of the tree you want it to follow
as a sucessor.
The Koutliner supports copying and moving within a single outline only right now, so
don’t try to to move trees across different outline files. You can, however, copy an outline
tree to a non-outline buffer with:
{C-c M-c} Copy a <tree> to a non-koutline buffer.
{C-c @}
Copy a <tree> to an outgoing mail message.
Chapter 6: Koutliner
42
You may also import cells into the current koutline from another koutline with the {M-x
kimport:text RET} command. See Section 6.5.7 [Inserting and Importing], page 43.
6.5.3 Moving Around
In addition to normal emacs movement commands, you can move within a cell or from one
cell or tree to another.
{C-c ,}
Move to the beginning of the current cell.
{C-c .}
Move to the end of the current cell.
{C-c C-n} Move to the next visible cell, regardless of level.
{C-c C-p} Move to the previous visible cell, regardless of level.
{C-c C-f} Move forward to this cell’s successor, if any.
{C-c C-b} Move backward to this cell’s predecessor, if any.
{C-c C-d} Move to the first child of the current cell, if any.
{C-c C-u} Move to the parent cell of the current cell, if any.
{C-c <}
Move to the first sibling at the current level within this tree.
{C-c >}
Move to the last sibling at the current level within this tree.
{C-c ^}
Move to the level 1 root cell of the current tree.
{C-c $}
Move to the last cell in the tree rooted at point, regardless of level.
6.5.4 Filling
Filling is the process of distributing words among lines to extend short lines and to reduce
long ones. Commands are provided to fill a paragraph within a cell or to fill a whole cell,
which may have multiple paragraphs.
{M-q} or {M-j} refills a paragraph within a cell so that its lines wrap within the current
margin settings. {C-c M-q} or {C-c M-j} refills all paragraphs within a cell. {C-M-q} or
{C-M-j} refills all cells within a tree. See your InfoDock, XEmacs, or GNU Emacs manual
for information on how to set the left and right margins.
Set the variable, kotl-mode:refill-flag, to ‘t’ if you want moving, promoting, demoting, exchanging, splitting and appending cells to also automatically refill each cell.
Generally, this is not recommended since if you happen to move a cell that you carefully
formatted yet forgot to give a ‘no-fill’ property, then your formatting will be lost.
6.5.5 Transposing
The Koutliner move and copy commands rearrange entire trees. The following two commands, in contrast, exchange the locations of two individual cells.
{C-c e} prompts for two cell addresses and exchanges the cell locations.
{C-c t} does not prompt. It exchanges the current and immediatly prior cell, regardless
of their levels. If there is no prior cell it exchanges the current and next cell.
{M-0 C-c t} exchanges the cells in which point and mark fall. {C-c t} with a non-zero
numeric prefix argument, N, moves the current tree maximally past the next N visible cells.
If there are fewer visible, it makes the current cell the last cell in the outline.
Chapter 6: Koutliner
43
6.5.6 Splitting and Appending
One cell may be split into two adjacent sibling cells with {C-c s}. This leaves the cell
contents preceding point in the current cell, minus any trailing whitespace, and moves the
contents following point to a new sibling cell which is inserted into the outline. {C-u C-c s}
instead adds the new cell as the first child of the original cell, rather than as its successor.
All cell attributes in the original cell are propagated to the new one, aside from the
creation attributes and idstamp.
{C-c +} appends the contents of a specified cell to the end of another cell. It has no
effect on cell attributes, except that if one cell has a ‘no-fill’ attribute, which prevents all
but user requested filling of a cell, then the cell appended to inherits this property. This
helps maintain any special formatting the appended text may have.
6.5.7 Inserting and Importing
The paragraphs of another buffer or file may be inserted into a koutline as a set of cells
by using the {C-x i} command. When prompted, you may use a buffer name or file name
from which to insert; completion is provided for file names only.
The elements from the original buffer are converted into kcells and inserted as the successors of the current cell. If {C-u C-x i} is used, they are instead inserted as the initial
children of the current cell.
For information on mode and suffix-specific conversions performed on file elements
before they are inserted, see the documentation for the variables, kimport:mode-alist
and kimport:suffix-alist. This same conversion process applies if you invoke {M-x
kotl-mode RET} in a non-koutline buffer or if you perform a generic file import as described
later in this section.
Use {M-x kimport:insert-file-contents RET} to insert an entire file into the current
cell following point.
The outliner supports conversion of three types of files into koutline files. You can import
a file into an existing koutline, following the tree at point, or can create a new koutline from
the imported file contents. {M-x kimport:file RET} selects the importation type based on
the buffer or file name suffix of the file to import.
If you want to convert a buffer from some other mode into a koutline and then want to
save the converted buffer back to its original file, thereby replacing the original format, use
{M-x kotl-mode RET}. Remember that you will lose the old format of the buffer when you
do this.
Use one of the following commands when you need explicit control over the type of
importation used on some text. With these commands, your original file remains intact.
Use {M-x kimport:text RET} and you will be prompted for a text buffer or file to import
and the new koutline buffer or file to create from its text. Each paragraph will be imported
as a separate cell, with all imported cells at the same level, since indentation of paragraphs
is presently ignored. This same command can be used to import the contents, attributes
and level structure of cells from another koutline.
Star outlines are standard emacs outlines where each entry begins with one or more
asterisk characters. Use {M-x kimport:star-outline RET} and you will be prompted for
the star outline buffer or file to import and the new koutline buffer or file to create.
Chapter 6: Koutliner
44
(Skip this if you are unfamiliar with the Augment/NLS system originally created at
SRI.) Files exported from the Augment system as text often have alphanumeric statement
identifiers on the right side. You can import such files while maintaining their outline
structure. Use {M-x kimport:aug-post-outline RET} and you will be prompted for the
Augment buffer or file to import and the koutline to create.
6.5.8 Exporting
Koutlines may be exported to other file formats. Presently, the only format supported is
conversion to HTML for publishing on the World-Wide Web.
{M-x kexport:html RET} prompts for the koutline buffer or file to export, the HTML
file or buffer to which to output, and the title to use for the HTML file. Completion of file
names is provided. The conversion will then be done and the output file or buffer will be
written; the output file will not be displayed.
6.6 Viewing
The Koutliner has very flexible viewing facilities to allow you to effectively browse and
study large amounts of material.
6.6.1 Hiding and Showing
Individual cells, branches, or particular levels in the outline may be hidden or shown. These
commands work even when an outline buffer is read-only, e.g. when its file is not checked
out of a version control system yet, so that you can get effective views of an outline without
editing it. Some of these commands affect the current view spec. See Section 6.6.2 [View
Specs], page 45.
{C-c C-h} Hide (collapse) the tree rooted at point.
{C-c C-s} Show (expand) the tree rooted at point.
{C-c C-a} Show (expand) all of the cells in the outline. With a prefix arg, also toggle the
display of blank lines between cells.
{C-x $}
Show all of the cells down to a particular <level>. You are prompted for the
level or a prefix argument may be given.
{C-M-h}
Hide the subtree at point, excluding the root cell.
{M-x kotl-mode:show-subtree}
Show the subtree at point. Use {C-c C-s} to achieve a similar effect; the only
difference is that it will additionally expand the root cell.
{C-c C-o} Show an overview of the outline by showing only the first line of every cell.
With a prefix arg, also toggle the display of blank lines between cells.
{C-c C-t} Show a top-level view of the outline by hiding all cells but those at level 1 and
collapsing the visible cells so that only their first lines are visible. With a prefix
arg, also toggle the display of blank lines between cells.
A click or a press of the Action Key within a cell’s body, but not on a Hyperbole button,
toggles between hiding and showing the tree rooted at point. Try it with either your mouse
or with {M-RET}.
Chapter 6: Koutliner
45
6.6.2 View Specs
View specifications (view specs, for short) are short codes used to control the view of a
koutline. The view specs in effect for an outline are always displayed in the modeline of the
outline’s window, following the outline buffer name, unless the variable, kvspec:string, has
been set to ‘nil’ to disable view spec display. The modeline display appears as <|viewspec>
to aid rapid visual location. The | (pipe character) is also used in links that specify view
specs to indicate the start of a view spec sequence. See Section 6.7 [Links], page 45.
The current view spec is saved whenever the outline is saved. The next time the outline
is read in, the same view spec will be applied.
The rest of this section documents the view spec characters that are presently supported
and explains how to invoke a view spec. There is no user-level means of adding your own
view spec characters, so all other character codes are reserved for future use.
{C-c C-v} prompts for a new view spec setting in which the following codes are valid.
Any invalid characters in a view spec are ignored. Characters are evaluated in an order
meant to do the right thing, even when you use conflicting view spec characters. The
standard initial view spec is <|ben>.
a
Show all cell levels and all lines in cells.
b
Turn on blank lines between cells. Without this character, blank lines will be
turned off. You may also use the {C-c b} key binding to toggle blank lines on
and off independently of any other view settings.
cN
Hide any lines greater than N in each cell. 0 means don’t cutoff any lines.
e
Show ellipses when some content of a cell or its subtree is hidden. Turning this
off may not work in Emacs25; nothing will happen.
lN
Hide cells at levels deeper than N. 0 means don’t hide any cells.
n
Turn on the default label type, as given by the variable, kview:default-labeltype. Normally, this is alphanumeric labels.
n0
Display idstamps, e.g. 086.
n1
Display alpha labels, e.g. 1d3
n.
Display legal labels, e.g. 1.4.3
As a test, use {C-h h k e} to display the example koutline. Then use {C-c C-v} to set
a view spec of ‘c2l1’. This will turn off blank lines, clip each cell after its second line, and
hide all cells below level one.
6.7 Links
Cells may include hyperlinks that refer to other cells or to external sources of information.
Explicit Hyperbole buttons may be created as usual with mouse drags (see Section 2.7.1.1
[By Dragging], page 17). A klink is a special implicit link button, delimited by <> separators,
that jumps to a koutline cell. This section discusses klinks.
Press the Action Key over a klink to follow it. This will flash the klink as a button and
then will display its referent in the other window. If the klink contains a view spec, it will
be applied when the referent is displayed.
Chapter 6: Koutliner
46
There are a number of easy ways to insert klinks into koutlines. If you have mouse
support under Hyperbole, simply click the Action Key within the indentation to the left of
a cell text. If you then double click on some cell, a link to that cell will be inserted where
you started. From a keyboard, use {C-c l} when in a koutline or {C-h h k l} when not in
a koutline to insert a klink. Since klinks are implicit buttons, you may instead type in the
text of the klink just as you see it in the examples below and it will work exactly as if it
had been entered with the insert link command.
There are basically three forms of klinks:
internal
‘<@ 2b=06>’ is an internal klink, since it refers to the koutline in which it is
embedded. When activated, it jumps to the cell within the current outline
which has permanent id ‘06’ and relative id ‘2b’. ‘<@ 06>’ does the same thing,
as does ‘<@ 2b>’, though this latter form will not maintain the link properly
if the cell is moved elsewhere within the outline. The form, ‘<@ 2b=06 |ben>’
additionally sets the view spec of the current outline back to the default value,
with a blank line between each cell and the whole outline visible.
external
The second klink format is an external link to another koutline, such as,
‘<EXAMPLE.kotl, 3=012 |c1e>’, which displays the named file, starting at the
cell 3 (whose permanent identifer is 012), with the view specification of: blank
lines turned off, cutoff after one line per cell, and showing ellipses for cells or
trees which are collapsed.
view spec
The third format sets a view spec for the current koutline. For example,
‘<|ben>’, when activated, sets the view in the current outline to display blank
lines, to use ellipses after collapsed lines and to label cells with the alphanumeric
style.
6.8 Cell Attributes
Attributes are named variables whose values are specific to an outline cell. Thus, each cell
has its own attribute list. Every cell has three standard attributes:
idstamp
The permanent id of the cell, typically used in cross-file hyperlinks that reference
the cell.
creator
The e-mail address of the person who created this cell.
create-time
The time at which the cell was created. This is stored in a form that allows
for easy data comparisons but is displayed in a human readable format, such
as ‘Jan 28 18:27:59 CST 2016’.
{C-c C-i} is the command to add an attribute to or to modify an existing attribute of
the cell at point. Think of it as inserting an attribute value. To remove an attribute from
a cell, set its value to ‘nil’.
The ‘no-fill’ attribute is special. When set to ‘t’, it prevents movement, promotion,
demotion, exchange, split or append commands from refilling the cell, even if the variable,
kotl-mode:refill-flag, is set to ‘t’. It does not prevent you from invoking explicit
commands that refill the cell. See Section 6.5.4 [Filling], page 42.
Chapter 6: Koutliner
47
The attribute lists for the cells in the tree rooted at point may be inspected by pressing
the Assist Key within the contents of a cell. {C-c h} prompts for a cell label and displays
the cell’s attributes. {C-u C-c h} prompts for a cell label and shows the attributes for it
and its subtree; use 0 as the kcell id to see attributes for all visible cells in the outline.
6.9 Koutliner History
Much of the Hyperbole outliner design is based upon concepts pioneered in the Augment/NLS system, [Eng84a]. Augment treated documents as a hierarchical set of nodes,
called statements, rather than cells. Every Augment document utilized this intrinsic structure.
The system could rapidly change the view of a document by collapsing, expanding, generating, clipping, filtering, including or reordering these nodes. It could also map individual
views to multiple workstation displays across a network to aid in distributed, collaborative
work.
These facilities aided greatly in idea structuring, cross-referencing, and knowledge transfer. The Koutliner is a start at bringing these capabilities back into the mainstream of
modern computing culture.
48
7 HyRolo
Hyperbole includes a complete, advanced rolo system, HyRolo, for convenient management
of hierarchical, record-oriented information. Most often this is used for contact management
but it can quickly be adapted to most any record-oriented lookup task, for fast retrieval.
Hyperbole buttons may be included within rolo records and then manually activated
whenever their records are retrieved.
The following subsections explain use and basic customization of this tool.
7.1 Rolo Concepts
HyRolo manages and searches rolo files. A rolo file consists of an optional header which
starts and ends with a line of equal signs (at least three equal signs starting at the beginning
of a line), followed by any non-negative number of rolo records. You must manually add a
header to any rolo file if you want it to have one.
Here is an example of a simple rolo file. The date at the end is automatically added by the
rolo system whenever a new record is added.
==================================================================
PERSONAL ROLO
<Last-Name>, <First> <Email>
W<Work#>
F<Fax#>
==================================================================
*
Smith, John
<[email protected]> W708-555-2001 F708-321-1492
Chief Ether Maintainer, HiHo Industries
05/24/2016
We call rolo records, entries. Entries begin with a delimiter of one or more ‘*’ characters
at the beginning of a line. Entries may be arranged in a hierarchy, where child entries start
with one more ‘*’ character than do their parents. Top-level entries begin with a single ‘*’.
Beyond this initial delimiter, entries are completely free-form text. It is best to use a
"lastname, firstname" format, however, when adding contact entries into a rolo. Then the
rolo system will automatically keep your entries alphabetized as you enter them. You’ll also
be able to resort the entries if you ever need. This ordering is what the rolo will use if you
accept the default entry with which it prompts you when adding a new entry.
Any search done on the rolo scans the full text of each entry. During a search, the rolo
file header separator lines and anything in between are appended to the buffer of matched
entries before any entries are retrieved from the file. Whenever an entry is matched, it
and all of its descendant entries are retrieved. If your emacs version supports textual
highlighting, each search match is highlighted for quick, visual location.
For example, a search on "Company" could retrieve the following:
==================================================================
COMPANY ROLO
==================================================================
*
Company
**
Manager
***
Staffer
Thus, searching for Company retrieves all listed employees. Searching for Manager turns
up all Staffer entries.
Chapter 7: HyRolo
49
7.2 Rolo Menu
The Rolo submenu of the Hyperbole menu offers a full set of commands for searching and
maintaining a personal address book. It looks like so.
Image 7.1: Rolo Menu
Chapter 7: HyRolo
50
The Rolo/ menu entry on the Hyperbole minibuffer menu provides the same set of
commands as the menubar menu, with more concise labels. The Rolo/ menu offers the
following commands:
Menu Item
Command
Description
=====================================================================
Add
hyrolo-add
Adds a rolo entry
Display
hyrolo-display-matches Displays last matches again
Edit
hyrolo-edit
Edits an existing rolo entry
Info
Displays a rolo manual entry
Kill
hyrolo-kill
Deletes a rolo entry
Mail
hyrolo-mail
Mails to an address at point
Order
hyrolo-sort
Sorts all rolo levels
RegexFind
hyrolo-grep
Finds all entries containing
a regular expression
StringFind
hyrolo-fgrep
Finds all entries containing
a string (or logical
expression)
WordFind
hyrolo-word
Finds all entries containing
a string of whole words
Yank
hyrolo-yank
Inserts the first matching
rolo entry at point
=====================================================================
A prefix argument used with any of the find commands listed above limits the search to
a maximum number of matches given by the argument. The search is terminated whenever
that number of matches is found.
For any of the above commands that prompt for a name such as Edit or Add (not the
Find commands), you may use the form parent/child to locate a child entry below a specific
parent. Hence, for a rolo which looked like so:
*
**
***
Company
Manager
Staffer
you could refer to the Staffer entry with the following hierarchical notation, Company/Manager/Staffer. This hierarchical notation is not used in search expressions since
they search the entire rolo anyway. Thus, "Staffer" as a search pattern will find an entry
containing "Staffer" at any level in a hierarchy, like so:
***
Staffer
7.3 Rolo Searching
See Section 7.2 [Rolo Menu], page 49, for the list of rolo search commands. In this section,
the menu item names from the minibuffer menu are used to refer to each command.
The RegexFind menu item searches the rolo list for all entries which contain matches for
a given regular expression. The regular expression syntax used is the same as the one used
within Emacs and across the GNU set of tools. See Section “Syntax of Regular Expressions”
in the GNU Emacs Manual, for full documentation on this format.
Chapter 7: HyRolo
51
The WordFind menu item locates full-word matches so that if you search for ‘product’,
it won’t match to occurrences of ‘production’. It is also handy for more precise name
matching.
The StringFind menu item has two uses. It can find all entry matches for a string
or can execute logical queries for more precise matching. The format of logical queries
is explained here; a simple parenthesis delimited prefix format is used with the following
logical operators.
Operator Name
Number of Arguments
Description
=====================================================================
and
two or more
Match entries with all args
or
two or more
Match entries with any args
xor
two or more
Match entries with 1 arg only
not
one
Match entries without the arg
=====================================================================
For example:
(and Company (not Vice-President))
would match those entries for people associated with ‘Company’ who do not have
‘Vice-President’ titles.
The following example would provide a list of all people marked as clients whose area
codes are outside of 408 and all non-clients within the 408 area code. This could be useful
after all clients within the 408 area code have been contacted and you want to see who else
you should contact.
(xor 408- client)
7.4 Rolo Keys
After a rolo search is performed, point is left in the rolo match buffer, *Hyperbole Rolo*,
which uses hyrolo-mode to simplify browsing many rolo matches. Press {?} when in the
match buffer for a summary of available keys, all of which are documented in this section.
If your emacs version supports textual highlighting, each search match is highlighted
for quick, visual location. {TAB} moves point forward to successive spans of text which
match the search expression. {M-TAB} {SHIFT-TAB} or {r} move point backward to earlier
matches. These keys allow you to quickly find the matching entry of most interest to you
if your search expression failed to narrow the matches sufficiently.
If you want to extend the match expression with some more characters to find a particular
entry, use {M-s}. This performs an interactive search forward for the match expression. You
may add to or delete characters from this expression to find different occurrences or move
to the next match with {C-s}. {C-r} reverses the direction of the search.
If you would like to search for a specific entry name in the match buffer, use {l} to
interactively locate the text immediately following the entry start delimiter, typically one
or more asterisks. This lets you find entries by last name quickly, eliminating other matches.
Standard string, {C-s}, and regular expression, {C-M-s}, interactive search commands are
also available within the rolo match buffer.
Single key outlining commands are also available for browsing matches. If your search
matches a large number of entries, use {t} to get a top-level summary of entries. Only the
Chapter 7: HyRolo
52
first line of each first-level match is shown. If you want to see an overview of all the levels,
use {o} which shows the first line of every entry level. If you want an overview of just the
first two levels, {C-u 2 o} will work.
Press {s} to show (expand) the entry at point. Use {h} to hide (collapse) the entry.
Press {a} to expand all entries in the buffer.
Many other keys are defined to help you move through matching entries.
{b}
Move to the previous entry at the same level as the current entry.
{f}
Move to the next entry at the same level as the current entry.
{n}
Move to the next entry at any level.
{p}
Move to the previous entry at any level.
{u}
Move to the previous entry one level up.
{. or <}
Move to the beginning of the buffer.
{, or >}
Move to the end of the buffer.
{DEL}
Scroll backward a windowful.
{SPC}
Scroll forward a windowful.
Use the {e} key to edit the current entry within your personal rolo file. A datestamp
will automatically be added or updated at the end of the entry, unless this feature has been
turned off via the Cust/Toggle-Rolo-Dates menu item. The variable, hyrolo-edit-hook, is
evaluated after the update of the entry datestamp. This allows programmed modification
of the way rolo edits work. The variable, hyrolo-add-hook, works the same way but is
evaluated when a new entry is first added.
Once you have found an entry of interest and you want to remove the rolo match buffer,
use {q} to quit. This will restore your current frame to its state prior to the rolo search.
7.5 Rolo Settings
The files used in any rolo search are given by the hyrolo-file-list variable, whose default
value is typically ("~/.rolo.otl". Searches scan only your personal rolo file. Any entries
added to this list should be absolute filenames. If a file in the list does not exist or is not
readable, it is skipped. Files are searched in the order in which they appear in the list. In
general, you should leave your personal rolo file as the first entry in the list, since this is
the only file to which the Add command on the rolo menu adds entries.
Hyperbole releases earlier than 4.17 used a different file name for the personal rolo. If
such a file exists, you will be prompted to rename it whenever the Rolo system is loaded.
If you use the Big Brother DataBase (BBDB) Emacs package to capture email addresses and store contact information, the rolo automatically works with it. If BBDB is
loaded before the rolo, then your bbdb-file of contacts is added as the second entry in
hyrolo-file-list and will be searched automatically for any matches by the rolo find
commands. Presently there is no support for editing BBDB entries, just finding them.
For finding matches in the BBDB file only, there are the commands hyrolo-bbdb-fgrep
(string finding) and hyrolo-bbdb-grep (regular expression finding). They may be bound
to keys if desired.
53
Below are the rest of the settings available with the rolo:
hyrolo-highlight-face
If textual highlighting is available in your emacs on your current display type,
the rolo uses the value of hyrolo-highlight-face as the face which highlights
search matches.
hyrolo-kill-buffers-after-use
Rolo file buffers are left around after they are searched, on the assumption that
another search is likely to follow within this emacs session. You may wish to
change this behavior with the following setting: (setq hyrolo-kill-buffersafter-use t).
hyrolo-save-buffers-after-use
After an entry is killed, the modified rolo file is automatically saved. If you
would rather always save files yourself, use this setting: (setq hyrolo-savebuffers-after-use nil).
hyrolo-email-format
When an entry is being added from within a mail reader buffer, the rolo extracts the sender’s name and e-mail address and prompts you with the name
as a default. If you accept the default, it will enter the name and the email
address using the format given by the hyrolo-email-format variable. See its
documentation if you want to change its value.
hyrolo-hdr-regexp
A rolo file may begin with an optional header section which is copied to the
match display buffer whenever any matches are found during a search. The start
and end lines of this header are controlled by the regular expression variable,
hyrolo-hdr-regexp, whose default value is "^===". This allows lines of all
equal signs to visually separate matching entries retrieved from multiple files
during a single search.
hyrolo-entry-regexp
The rolo entry start delimiter is given by the regular expression variable,
hyrolo-entry-regexp, whose default value is "^\*+", i.e. one or more
asterisks at the beginning of a line.
hyrolo-display-format-function
When a rolo search is done, each matching entry is passed through the function given by the variable, hyrolo-display-format-function, before it is displayed. This should be a function of one argument, namely the matching rolo
entry as a string. The string that this function returns is what is displayed
in the rolo match buffer. The default function used is identity which passes
the string through unchanged. If you use the rolo code to search other kinds of
record-oriented data, this variable can be used to format each entry however you
would like to see it displayed. With a little experience, you can quickly write
functions that use local bindings of the rolo entry and file settings to search
all kinds of record-oriented data. There is never a need to learn a complicated
query language.
54
8 Window Configurations
Hyperbole includes the hywconfig.el library which lets you save and restore window configurations, i.e. the layout of windows and buffers displayed within an emacs frame. This
is useful to save a particular working context and then to jump back to it at a later time
during an emacs session. It is also useful during demonstrations to display many informational artifacts all at once, e.g. all of the windows for a particular subsystem. None of
this information is stored between emacs sessions, so your window configurations will last
through only a single session of use. Each window configuration is tied to the emacs frame
in which it is created.
The hywconfig library offers two independent ways of managing window configurations.
The first way associates a name with each stored window configuration. The name may then
be used to retrieve the window configuration later. The second way uses a ring structure to
save window configurations and then allows cycling through the ring of saved configurations,
finally wrapping around to the first entry after the last entry is encountered. Simply stop
when the desired configuration is displayed.
The Win/ menu entry on the Hyperbole top-level menu displays a menu of window
configuration commands:
WinConfig> AddName DeleteName RestoreName PopRing SaveRing YankRing
The operations on this menu are defined as follows.
Menu Item
Command
Description
=====================================================================
AddName
hywconfig-add-by-name
Name current wconfig
DeleteName
hywconfig-delete-by-name
Delete wconfig by name
RestoreName
hywconfig-restore-by-name
Restore wconfig by name
PopRing
hywconfig-delete-pop
Restore and delete wconfig
SaveRing
hywconfig-ring-save
Store wconfig to the ring
YankRing
hywconfig-yank-pop
Restore the next wconfig
=====================================================================
The easiest method is to save and restore window configurations by name, but it requires
that you input the chosen name from the keyboard. Alternately, the ring commands permit
saves and restores using only the mouse, if desired. An earlier chapter (see Chapter 3 [Smart
Keys], page 22) mentions how to save and restore window configurations with the Smart
Keys. Since the ring commands are a bit more complex than their by-name counterparts,
the following paragraphs explain them in more detail.
HyWconfig creates a ring structure that operates just like the Emacs kill-ring (see
Section “Kill Ring” in the GNU Emacs Manual) but its elements are window configurations
rather than text regions. You can add an element to the ring to save the current window
configuration in the selected frame. After several elements are in the ring, you can walk
through all of them in sequence until the desired configuration is restored.
SaveRing executes the hywconfig-ring-save command which saves the current window
configuration to the ring.
YankRing executes the hywconfig-yank-pop command. It restores the window configuration currently pointed to within the ring. It does not delete this configuration from the
55
ring but it does move the pointer to the prior ring element. Repeated calls to this command
thus restore successive window configurations until the ring pointer wraps around. Simply
stop when a desired configuration appears and use {q} to quit from the minibuffer menu.
PopRing calls the hywconfig-delete-pop command. It is used to restore a previously
saved configuration and to delete it from the ring. Simply stop when a desired configuration
appears and use {q} to quit from the minibuffer menu.
The maximum number of elements the ring can hold is set by the hywconfig-ring-max
variable whose default is 10. Any saves beyond this value will delete the oldest element in
the ring before a new one is added.
56
9 Developing with Hyperbole
This chapter is for people who are familiar with Emacs Lisp and wish to customize Hyperbole, to extend it, or to develop other systems using Hyperbole as a base.
9.1 Hook Variables
Hyperbole supplies a number of hook variables that allow you to adjust its basic operations
to meet your own needs, without requiring you to change the code for those operations.
We find it best to always set the value of hook variables either to ‘nil’ or to a list of
function names of no arguments, each of which will be called in sequence when the hook
is triggered. If you use the add-hook function to adjust the value of hooks, it will do this
automatically for you.
Given the name of a function, a Hyperbole hook variable triggered within that function
has the same name as the function with a ‘-hook’ appended. Hyperbole includes the
following hook variables:
hyperbole-init-hook
For customization at Hyperbole initialization time. Use this to load any personal Hyperbole type definitions or key bindings you might have. It is run after
Hyperbole support code is loaded but before Hyperbole is initialized, i.e. prior
to keyboard and mouse bindings.
action-act-hook
Run before each Hyperbole button activation. The variable hbut:current
contains the button to be activated when this is run.
ebut-create-hook
Adds to the Hyperbole explicit button creation process.
ebut-delete-hook
Adds to the Hyperbole explicit button deletion process.
ebut-modify-hook
Executed when an explicit button’s attributes are modified.
hibtypes-begin-load-hook
Executed prior to loading of standard Hyperbole implicit button types. Used to
load site-specific low priority implicit button types since lowest priority ibtypes
are loaded first.
hibtypes-end-load-hook
Executed after loading of standard Hyperbole implicit button types. Used
to load site-specific high priority implicit button types since highest priority
ibtypes are loaded last.
htype-create-hook
Executed whenever a Hyperbole type (e.g. action type or implicit button type)
is added to the environment.
htype-delete-hook
Executed whenever a type is deleted from the environment.
Chapter 9: Developing with Hyperbole
57
kotl-mode-hook
Executed whenever a koutline is created or read in or when kotl-mode is invoked.
hyrolo-add-hook
Executed after the addition of a new rolo entry.
hyrolo-display-hook
Executed when rolo matches are displayed.
hyrolo-edit-hook
Executed after point is successfully moved to an entry to be edited.
hyrolo-mode-hook
Executed when a rolo match buffer is created and put into hyrolo-mode.
hyrolo-yank-reformat-function
A variable whose value may be set to a function of two arguments, START and
END, which give the region of the rolo entry yanked into the current buffer
by the hyrolo-yank command. The function may reformat this region to meet
user-specific needs.
Hyperbole also makes use of a number of standard Emacs hook variables.
find-file-hook
This is called whenever a file is read into a buffer. Hyperbole uses it to highlight
any buttons within files.
write-file-hooks
This is called whenever a buffer is written to a file. Hyperbole uses it to save
modified button attributes associated with any file from the same directory as
the current file.
Hyperbole mail and news facilities also utilize a number of Emacs hook variables. These hide button data and highlight buttons if possible. See the Hyperbole files with ‘mail’ and ‘gnus’ in their names for specific usage of such
hooks.
9.2 Creating Types
To define or redefine a single Hyperbole type, you may either:
• move your Emacs point to within the type definition and use {C-M-x} (eval-defun)
(only works in Emacs Lisp mode);
• or move your point to the end of the last line of the type definition and use {C-x C-e}
(eval-last-sexp) (works in most modes).
The functions from the ‘htype’ class may be applied to any Hyperbole types, if needed.
The following subsections explain the specifics of Hyperbole type definitions which are
beyond standard practice for Emacs Lisp programming. See the definitions of the standard
types in hactypes.el and hibtypes.el for examples.
Chapter 9: Developing with Hyperbole
58
9.2.1 Action Type Creation
New forms of explicit buttons may be created by adding new action types to a Hyperbole
environment. The file, hactypes.el, contains many examples of working action types.
An action type is created, i.e. loaded into the Hyperbole environment, with the (defact)
function (which is an alias for (actype:create)). The calling signature for this function is
given in its documentation; it is the same as that of (defun) except that a documentation
string is required. An interactive calling form is also required if the action type has formal
parameters and is to be used in explicit or global button definitions. Implicit buttons never
use an action type’s interactive form; however, it is good practice to include an interactive
form since the type creator cannot know how users may choose to apply the type.
An action type’s parameters are used differently than those of a function being called.
Its interactive calling form is used to prompt for type-specific button attributes whenever
an explicit button is created. The rest of its body is used when a button with this action
type is activated. Then the button attributes together with the action type body are used
to form an action that is executed in response to the button activation. The action’s result
is returned to the action caller unless it returns ‘nil’, in which case ‘t’ is returned to the
caller to ensure that it registers the performance of the action.
An action type body may perform any computation that uses Emacs Lisp and Hyperbole
functions.
The interactive calling form for an action type is of the same form as that of a regular
Emacs Lisp function definition (see the documentation for the Emacs Lisp (interactive)
form or see Section “Code Characters for ’interactive”’ in the GNU Emacs Lisp Reference
Manual. It may additionally use Hyperbole command character extensions when the form
is given as a string. Each such extension character must be preceded by a plus sign, ‘+’, in
order to be recognized, since such characters may also have different standard interactive
meanings.
The present Hyperbole extension characters are:
+I
Prompts with completion for an existing Info (filename)nodename.
+K
Prompts for an existing kcell identifier, either a full outline level identifier or a
permanent idstamp.
+L
Prompts for a klink specification. See the documentation for the function
(kcell-view:reference) for details of the format of a klink.
+M
Prompts for a mail message date and the file name in which it resides. The
mail parameters prompted for by this character code may change in the future.
+V
Prompts for a Koutliner view specification string, with the current view spec,
if any, as a default.
+X
Prompts with completion for an existing Info index (filename)itemname.
Arguments are read by the functions in Hyperbole’s hargs class, rather than the standard
Lisp read functions, in order to allow direct selection of arguments via the Action Key.
If an action type create is successful, the symbol that Hyperbole uses internally to
reference the type is returned. On failure, ‘nil’ is returned so that you may test whether
or not the operation succeeds.
Chapter 9: Developing with Hyperbole
59
Once you have defined an action type within your present Hyperbole environment, you
can create new explicit buttons which use it. There is no explicit button type beyond its
action type, so no other work is necessary.
Call (actype:delete) to remove an action type from a Hyperbole environment. It takes
a single parameter which should be the same type symbol used in the type definition call
(not the Hyperbole symbol returned by the call).
9.2.2 Implicit Button Types
An implicit button type is created or loaded via the (defib) function (which is an alias for
(ibtype:create)). The calling signature for this function is given in its documentation; it
is the same as that of (defun), but with a number of constraints. The parameter list should
always be empty since no parameters will be used. A documentation string is required; it
is followed by the body of the type.
The body of an implicit button type is a predicate which determines whether or not
point is within an implicit button of the type. If not, the predicate returns ‘nil’. If so,
it may optionally setup to flash the button and then to perform one or more actions. A
call of the form: (ibut:label-set label start-pos end-pos) is used to setup the button
flashing, if desired. This is then typically immediately followed by an action invocation
of the form: (hact 'actype &rest actype-arguments). It is imperative that all actions
(non-predicate code) be invoked through the (hact) function or your ibtypes will not work
properly. (Hyperbole first tests to see if any ibtype matches the current context before
activating any type, so it ensures that (hact) calls are disabled during this testing.) Any
action types used in the definition of an implicit button type may be created before or after
the definition, but obviously, must be defined before any implicit buttons of the given type
are activated; an error will result, otherwise.
If an implicit button type create is successful, the symbol that Hyperbole uses internally
to reference the type is returned. On failure, ‘nil’ is returned so that you may test whether
or not the operation succeeds. Implicit button type names and action type names may be
the same without any conflict. In fact, such naming is encouraged when an implicit button
type is the exclusive user of an action type.
Call (ibtype:delete) to remove an implicit button type from a Hyperbole environment.
It takes a single parameter which should be the same type symbol used in the type definition
call (not the Hyperbole symbol returned by the call). This will not delete the action type
used by the implicit button; that must be done separately.
By default, a request for help on an implicit button will display the button’s attributes
in the same manner as is done for explicit buttons. For some implicit button types, other
forms of help will be more appropriate. If an Emacs Lisp function is defined whose name is
formed from the concatenation of the type name followed by ‘:help’, e.g. my-ibtype:help,
it is used as the assist-action whenever the Assist Key is pressed, to respond to requests
for help on buttons of that type. Any such function should take a single argument of an
implicit button construct. (This is what (ibut:at-p) returns when point is within an
implicit button context.) The button may be queried for its attributes using functions from
the ‘hbut’ and ‘hattr’ classes. See the hib-kbd.el file for an example of a custom help
function.
Chapter 9: Developing with Hyperbole
60
9.3 Explicit Button Technicalities
9.3.1 Button Label Normalization
Hyperbole uses a normalized form of button labels called button keys (or label keys) for
all internal operations. See the documentation for the function (hbut:label-to-key) for
details of the normalization process. The normalized form permits Hyperbole to recognize
buttons that are the same but whose labels appear different from one another, due to text
formatting conventions. For example, all of the following would be recognized as the same
button.
<(fake button)>
Pam>
Pam>
<( fake
button)>
<(fake
button)>
;; <(fake
;;
button)>
/* <( fake
*/
/*
button )> */
The last three examples demonstrate how Hyperbole ignores common fill prefix patterns
that happen to fall within the middle of a button label that spans multiple lines. As long
as such buttons are selected with point at a location within the label’s first line, the button
will be recognized. The variable hbut:fill-prefix-regexps holds the list of fill prefixes
recognized when embedded within button labels. All such prefixes are recognized (one per
button label), regardless of the setting of the Emacs variable, fill-prefix, so no user
intervention is required.
9.3.2 Operational and Storage Formats
Hyperbole uses a terse format to store explicit buttons and a more meaningful one to
show users and to manipulate during editing. The terse format consists solely of button
attribute values whereas the edit format includes an attribute name with each attribute
value. A button in edit format consists of a Lisp symbol together with its attribute list
which holds the attribute names and values. In this way, buttons may be passed along from
function to function simply by passing the symbol to which the button is attached. Most
functions utilize the pre-defined hbut:current symbol by default to store and retrieve the
last encountered button in edit format.
The ‘hbdata’ class handles the terse, stored format. The ‘hbut’, ‘ebut’, and ‘ibut’ classes
work with the name/value format. This separation permits the wholesale replacement of
the storage manager with another, with any interface changes hidden from any Hyperbole
client programming.
9.3.3 Programmatic Button Creation
A common need when developing with Hyperbole is to create or to modify explicit buttons
without user interaction. For example, an application might require the addition of an
explicit summary button to a file for each new mail message a user reads that contains a
Chapter 9: Developing with Hyperbole
61
set of keywords. The user could then check the summary file and jump to desired messages
quickly.
The Hyperbole class ‘ebut’ supports programmatic access to explicit buttons. Examine
it within the hbut.el file for full details. The documentation for (ebut:create) explains
the set of attributes necessary to create an explicit button. For operations over the whole
set of buttons within the visible (non-narrowed) portion of a buffer, use the (ebut:map)
function.
9.4 Encapsulating Systems
A powerful use of implicit button types is to provide a Hyperbole-based interface to external
systems. The basic idea is to interpret patterns output by the application as implicit
buttons.
See the hsys-* files for examples of how to do this. Encapsulations are provided for the
following systems (the systems themselves are not included with Hyperbole):
World-Wide Web
The world-wide web system originally developed at CERN, that now spans the
Internet universe. This is automatically loaded by Hyperbole so that a press of
the Action Key follows a URL.
9.5 Embedding Hyperbole
[NOTE: We have never done this ourselves, though we have done similar things which leads
us to infer that the task should not be difficult.]
The standard Hyperbole user interface has purposely been separated from the Hyperbole
backend to support the development of alternative interfaces and the embedding of Hyperbole functionality within other system prototypes. The Hyperbole backend functionality
that system developers can make use of is called its Application Programming Interface
(API). The API may be used to make server-based calls to Hyperbole when Emacs is run
as a non-interactive (batch) process, with its input/output streams attached to another
process.
The public functions and variables from the following files may be considered the present
Hyperbole API:
hact.el, hargs.el, hbmap.el, hbut.el, hhist.el, hmail.el, hmoccur.el, hpath.el,
htz.el, hypb.el, hyrolo.el, hyrolo-logic.el, hywconfig.el and set.el.
Note when looking at these files, that they are divided into sections that separate one data
abstraction (class) from another. A line of dashes within a class separates public parts of
the class from the private parts that follow the line.
This API does not include the Hyperbole Koutliner, as it has been designed for interactive use, rather than programmatic extensibility. You are welcome, however, to study its
code, below the hyperbole-${hyperb:version}/kotl/ directory.
62
Appendix A Glossary
Concepts pertinent to operational usage of Hyperbole are defined here. See Section “Glossary” in the GNU Emacs Manual, if any emacs-related terms are unfamiliar to you.
Action
An executable behavior associated with a Hyperbole button. Links are a specific
class of actions which display existing entities, such as files. See also Action
Type.
Action Key
See Smart Key.
Action Type
A behavioral specification for use within Hyperbole buttons. Action types usually contain a set of parameters which must be given values for each button
with which they are associated. An action type together with a set of values,
called arguments, is an action. Actype is a synonym for action type.
Activation A request to a Hyperbole button to perform its action. Ordinarily the user
presses a key which selects and activates a button.
Ange-ftp
See Tramp.
Argument A button-specific value fed to a Hyperbole type specification when the button
is activated.
Assist Key
See Smart Key.
Attribute
A named parameter slot associated with a category or type of Hyperbole button.
An attribute value is typically specific to a particular button instance.
Augment
The Augment system, originally named NLS, was a pioneering research and
production system aimed at augmenting human intellect and group knowledge
processing capabilities through integrated tools and organizational development
strategies. This approach led to the invention of much of interactive computing technology decades ahead of other efforts, including: the mouse, chord
keyboards, screen windows, true hypertext, outline processors, groupware, and
digitally signed documents. See Appendix I [References], page 112, which cites
several Douglas Engelbart papers on the subject. The Koutliner demonstrates
a few of the concepts pioneered in Augment.
Buffer
An Emacs buffer is an editable or viewable text, possibly with special formatting
such as an outline or table. It may also be attached to a process, receiving and
updating its text as the process handles changing information.
Button
A selectable Hyperbole construct which performs an action. A button consists
of a set of attributes that includes: a textual label, a category, a type and
zero or more arguments. Explicit buttons also have creator, create time, last
modifier, and last modifier time attributes.
Buttons provide user gateways to information. Users see and interact with button labels; the rest of the button attributes are managed invisibly by Hyperbole
and displayed only in response to user queries.
Appendix A: Glossary
63
Button Activation
See Activation.
Button Attributes
See Attributes.
Button Data
Lists of button attribute values explicitly saved and managed by Hyperbole.
One list for each button created by Hyperbole.
Button File, local
A per-directory file named HYPB that may be used to store any buttons that link
to files within the directory. It may be displayed via a menu selection whenever
a user is within the directory.
Button File, personal
A per-user file named HYPB that stores all global buttons for the user and any
other buttons used to navigate to other information spaces. It may be displayed
via a menu selection at any time.
Button Key
A normalized form of a button label used internally by Hyperbole.
Button Label
A text string that visually indicates a Hyperbole button location and that serves
as its name and unique identifier. Within a buffer, buttons with the same label
are considered separate views of the same button and so behave exactly alike.
Since button labels are simply text strings, they may be embedded within any
text to provide non-linear information or operational access points.
The maximum length of a button label is limited by the variable ebut:max-len.
Button Selection
The act of designating a Hyperbole button upon which to operate. Use the
Action Key to select a button.
Category
A class of Hyperbole buttons: implicit, explicit or global.
Cell
See Kcell.
Children
The set of koutline cells which share a common parent cell and thus, are one
level deeper than the parent.
Chord Keyboard
A keyboard which supports pressing multiple keys simultaneously to produce
a unique chord keystroke for issuing commands to a program. In Engelbart’s
Augment system, mouse keys were used as modifiers for a 5-key chord keyboard
to enable direct manipulation of objects on screen. Hyperbole supports similar
behavior with its hmouse-mod-mode. See Section 3.6 [Smart Key Modifiers],
page 27.
Class
A group of functions and variables with the same prefix in their names, used
to provide an interface to an internal or external Hyperbole abstraction.
Appendix A: Glossary
64
Context
A programmatic or positional state recognized by Hyperbole. We speak of
Smart Key and implicit button contexts. Both are typically defined in terms of
surrounding patterns within a buffer, but may be defined by arbitrary Emacs
Lisp predicates.
Display
See Screen.
Domain
The contexts in which an implicit button type may be found, i.e. where its
predicate is true.
Drag
A mouse button press in one location and following release in another location.
Environment
See Hyperbole Environment.
EFS
See Tramp
Explicit Button
A button created and managed by Hyperbole, associated with a specific action
type. By default, explicit buttons are delimited like this ‘<(fake button)>’.
Direct selection is used to operate upon an explicit button.
Frame
An Emacs frame displays one or more Emacs windows and widgets (menubars,
toolbars, scrollbars). Under a graphical window system, this is a single window
system window. On a dumb terminal, only one frame is visible at a time as
each frame generally fills the whole terminal display, providing a virtual screen
capability. Emacs windows exist within a frame.
Global Button
A form of explicit button which is accessed by name rather than direct selection. Global buttons are useful when one wants quick access to actions such
as jumping to common file locations or for performing sequences of operations.
One need not locate them since they are always available by name, with full
completion offered. All global buttons are stored in the file given by the variable gbut:file and may be activated as regular explicit buttons by visiting
this file. By default, this is the same as the user’s personal button file.
Global Button File
See Button File, personal and Global Button.
Hook Variable
A variable that permits customization of an existing function’s operation without the need to edit the function’s code. See also the documentation for the
function (run-hooks).
HyControl
HyControl, the Hyperbole window and frame control manager, offers fast, single
key manipulation of window and frame creation, deletion, sizing, position and
face zooming (enlarging/shrinking).
Hyperbole The flexible, programmable information management and viewing system documented by this manual. It utilizes a button-action model and supports hypertextual linkages. Hyperbole is all things to all people.
Appendix A: Glossary
65
Hyperbole Environment
A programmatic context within which Hyperbole operates. This includes the
set of Hyperbole types defined and the set of Hyperbole code modules loaded.
It does not include the set of accessible buttons. Although the entire Emacs
environment is available to Hyperbole, we do not speak of this as part of the
Hyperbole environment.
Hypertext A text or group of texts which may be explored in a non-linear fashion through
associative linkages embedded throughout the text. Instead of simply referring
to other pieces of work, hypertext references when followed actually take you
to the works themselves.
HyRolo
HyRolo, the Hyperbole record/contact manager, provides rapid lookup of multiline, hierarchically ordered free form text records. It can also lookup records
from the Big Brother DataBase (BBDB) package.
Implicit Button
A button recognized contextually by Hyperbole. Such buttons contain no button data. See also implicit button type.
Implicit Button Type
A specification of how to recognize and activate implicit buttons of a specific
kind. Implicit button types often utilize structure internal to documents created and managed by tools other than Hyperbole, for example, programming
documentation. Ibtype is a synonym for implicit button type. See also system
encapsulation.
InfoDock
InfoDock is an integrated productivity toolset for software engineers and knowledge workers. It is presently built atop XEmacs and is no longer maintained.
An older version from 1999 may be found at infodock.sf.net. InfoDock has all
the power of emacs, but with an easier to use and more comprehensive menubased user interface. Most objections people raise to using emacs have already
been addressed in InfoDock. InfoDock was meant for people who wanted a
complete, pre-customized environment in one package.
Instance Number
A colon prefaced number appended to the label of a newly created button when
the button’s label duplicates the label of an existing button in the current buffer.
This number makes the label unique and so allows any number of buttons with
the same base label within a single buffer.
Koutline
A hierarchically ordered grouping of cells which may be stored as a file and
viewed and edited as an outline.
Koutliner
Koutliner, the Hyperbole outliner, is a powerful autonumbering outliner with
permanent hypertext anchors for easy hyperlinking and view specs for rapid
outline view alteration.
Kcell
Cells or kcells are elements within koutlines. Each cell may contain textual
and graphical contents, a relative identifier, a permanent identifier and a set of
attributes such as the user who created the cell and the time of creation. See
also Koutliner.
Appendix A: Glossary
Link
66
A reference from a Hyperbole button to an existing (non-computed) entity. The
referenced entity is called a referent. Links are a subset of the types of actions
that Hyperbole buttons support.
Local Button File
See Button File, local.
Minibuffer Window
The one line window at the bottom of a frame where messages and prompts
are displayed.
Minibuffer Menu
A Hyperbole menu displayed in the minibuffer window. Each menu item within
a minibuffer menu begins with a different letter that can be used to invoke the
item (case doesn’t matter). Items that display other menus end with a forward
slash, ‘/’.
Mouse Key
Mouse Button
See Smart Key.
NLS
See Augment.
Node
See Link or Cell.
The OO-Browser
The OO-Browser is a multi-windowed, interactive object-oriented class browser
similar in use to the well-known Smalltalk browsers. It runs inside Emacs. It is
unique in a number of respects foremost of which is that it works well with most
major object-oriented languages in use today. You can switch from browsing in
one language to another in a few seconds. It provides both textual views within
an editor and graphical views under the X window system and Windows. It
includes support for C, C++, Common Lisp and its Object System (CLOS),
Eiffel, Java, Objective-C, Python and Smalltalk.
Outline
See Koutline.
Parent
Any koutline cell which has children.
Predecessor
The previous same level koutline cell with the same parent.
Predicate
A boolean (‘nil’ = false, non-nil = true = ‘t’) Lisp expression typically evaluated as part of a conditional expression. Implicit button types contain predicates that determine whether or not a button of that type is to be found at
point.
Referent
See Link.
Remote Pathname
A file or directory on a system not shared within the local area network.
The built-in Emacs library, Tramp, handles remote pathnames and
Hyperbole uses it to enable viewing and editing of remote paths of the form:
/<user>@<host>:<path> as well as web URLs. Use the Cust/Find-File-URLs
menu option to enable this feature.
Appendix A: Glossary
67
Rolo
See HyRolo.
Root Cell
A koutline cell which has cells below it at lower outline levels. All such cells
share the same root cell.
Screen
The total display area available to Emacs frames. This may consist of multiple
physical monitors arranged into a single virtual display. Screen edges are thus
the outer borders of the virtual display.
Smart Key
A context-sensitive key used within Hyperbole and beyond. There are two
Smart Keys, the Action Key and the Assist Key. The Action Key activates
Hyperbole buttons and scrolls the current buffer line to the top of the window
when pressed at the end of a line.
The Assist Key shows help for Hyperbole buttons and scrolls the current line
to the bottom of the window when pressed at the end of a line.
The {C-h h d s} Doc/SmartKeys menu item displays a full summary of Smart
Key capabilities. See Chapter 3 [Smart Keys], page 22, for complete details.
Smart Menus
Smart Menus are an older in-buffer menu system that worked on dumb terminals
and pre-dated Emacs’ own dumb terminal menu support. They are included
with InfoDock (which is no longer maintained) and are not available separately.
They are not a part of Hyperbole and are not necesary for its use but are still
supported by the Smart Keys.
Source Buffer / File
The buffer or file within which a Hyperbole button is embedded.
Subtree
All of the cells in a koutline which share the same root cell, excluding the root
cell.
Successor
The next same level koutline cell which follows the current cell and shares the
same parent.
System Encapsulation
Use of Hyperbole to provide an improved or consistent user interface to another
system. Typically, implicit button types are defined to recognize and activate
button-type constructs managed by the other system.
Tramp
A remote file access library built-in to Emacs. It does similar things as the
older EFS and ange-ftp packages but uses more secure transfer and works with
more types of hosts. It allows one to use remote pathnames that are accessible
via Internet protocols just like other pathnames, for example when finding a
file. Hyperbole recognizes pathnames of the form, /<user>@<host>:<path>
and web URLs.
Tree
The set of cells in a koutline that share a common root cell, including the root
cell.
URL
A Universal Resource Locator specification used on the World-Wide web to
access documents and services via a multiplicity of protocols.
68
View
A perspective on some information. A view can affect the extent of the information displayed, its format, modes used to operate on it, its display location
and so forth.
View Spec A terse (and to the uninitiated, cryptic) string that specifies a particular view
of a koutline or a link referent. If a view spec is active for a buffer, the view
spec appears within the modeline like so, <|view spec>.
Window
An Emacs window displays a single Emacs buffer within a single frame. Frames
may contain many windows.
69
Appendix B Setup
Hyperbole must be obtained and setup at your site before you can use it. Instructions are
given below. If you are using InfoDock version 4.0.7 or higher, Hyperbole is pre-installed
so you may skip the installation instructions and simply continue with the invocation instructions in this appendix.
B.1 Installation
Once you have Emacs set up at your site, GNU Hyperbole may be installed by using the
Emacs Package Manager. If you are not familiar with it, see Section “Packages” in the
GNU Emacs Manual.
If you have Hyperbole 5.10 or higher installed and simply want to upgrade it, invoke the
Emacs Package Manager with {M-x list-packages RET}, then use the {U} key followed by
the {x} key to upgrade all out-of-date packages, Hyperbole among them. Then skip the
text below and move on to the next section, see Section B.2 [Invocation], page 69.
Otherwise, to download and install the Hyperbole package, you should add several lines
to your personal Emacs initialization file, ~/.emacs. (For further details, see Section “The
Emacs Initialization File” in the GNU Emacs Manual).
Below are the lines to add:
(require 'package)
(setq package-enable-at-startup nil) ;; Prevent double loading of libraries
(package-initialize)
(unless (package-installed-p 'hyperbole)
(package-refresh-contents)
(package-install 'hyperbole))
(require 'hyperbole)
Now save the file and restart Emacs. Hyperbole will then be downloaded and compiled
for use with your version of Emacs; give it a minute or two. You may see a bunch of
compilation warnings but these can be safely ignored.
Now read the next section on Invocation.
B.2 Invocation
Once Hyperbole has been installed for use at your site and loaded into your Emacs session,
it is ready for use. You will see a Hyperbole menu on your menubar and {C-h h} will display
a Hyperbole menu in the minibuffer for quick keyboard or mouse-based selection. Select an
item from this menu by typing the item’s first letter. Use {q} to quit from the menu.
You can invoke Hyperbole’s commands in one of three ways:
• use the Hyperbole entry on your menubar;
• type {C-h h} or {M-x hyperbole RET} to bring up the Hyperbole minibuffer menu;
• use a specific Hyperbole command such as the Action Key, {M-RET}, on a pathname
to display the associated file or directory.
Use {C-h h d d} for an interactive demonstration of standard Hyperbole button capabilities.
Appendix B: Setup
70
Type {C-h h k e} for an interactive demonstration of the Koutliner, Hyperbole’s multilevel autonumbered hypertextual outliner.
To try out HyControl, Hyperbole’s interactive frame and window control system, use
{C-h h s w} for window control or {C-h h s f} for frame control. Pressing {t} switches
between window and frame control once in HyControl. Hyperbole also binds {C-c \} for
quick access to HyControl’s window control menu if it was not already bound prior to
Hyperbole’s initialization. A long video demonstrating most of HyControl’s features is
available at https://youtu.be/M3-aMh1ccJk.
The above are the best interactive ways to learn about Hyperbole. The Hyperbole Manual
is a reference manual, not a simple introduction. It is included in the man/ subdirectory of
the Hyperbole package directory in four forms:
man/hyperbole.info
- online Info browser version
man/hyperbole.html
- web HTML version
man/hyperbole.pdf
- printable version
man/hyperbole.texi
- source form
The Hyperbole package installation places the Info version of this manual where
needed and adds an entry for Hyperbole into the Info directory under the Emacs
category. {C-h h d i} will let you browse the manual. Then use {s} to search
for anything throughout the manual.
For web browsing, point your browser at
${hyperb:dir}/man/hyperbole.html, wherever the Hyperbole package directory is on
your system; often this is: ~/.emacs.d/elpa/hyperbole-${hyperb:version}/.
Advanced users may want to continue on to the next section about configuring Hyperbole’s
behavior.
Appendix B: Setup
71
B.3 Customization
Major Hyperbole user options may be set from the Customize submenu below the Hyperbole
menubar menu, as seen here.
Image B.1: Hyperbole Customize Menu
Alternatively, the minibuffer-based menu, Cust/ may be used.
Generally, you should not need to change anything other than these options. However,
if you like to customize your environment extensively, there are many additional Hyperbole
customization options that may be changed with the Emacs customization interface, see
Section “Easy Customization Interface” in the GNU Emacs Manual. When you save any
changes within this interface, the changes are saved permanently to your personal Emacs
initialization file and are available in future Emacs sessions.
Use Cust/All-Options {C-h h c a} to display an expandable tree of customizable Hyperbole options. Hyperbole’s customizations are further grouped into several sub-categories,
one for the Koutliner, one for the Rolo, etc. You can select either an entire category or
a specfic option and they will appear in another window for editing. Simply follow the
instructions on screen and then press the “Apply and Save” button to make any changes
permanent.
Appendix B: Setup
72
If you know the name of the option you want to edit, you can edit it at any time without
going through the tree of options. Use {M-x customize-variable RET} and then type the
name of the variable and press RET to edit it.
The following sections discuss the customization options most likely to be of interest to
users.
B.3.1 Web Search Engines
The Find/Web menu offers quick access to major web search engines. It is typically bound
to {C-c /} or if not, then {C-h h f w} is always available. Your standard web browser will
be used to return the search results. You can change which browser is used with {C-h h
c w}, the Cust/Web-Search menu. Advanced users can change the search engines listed in
the Find/Web menu with {M-x customize-variable RET hyperbole-web-search-alist
RET}. Changes are automatically reflected in the Hyperbole menus once applied. Remember
each search engine name must begin with a unique letter and each URL must have a %s
format field indicating where to place the web search term when a search is performed.
Advanced users can change the search engines listed by editing the option,
hyperbole-web-search-alist, with {M-x customize-variable RET hyperbole-websearch-alist RET}. Remember each search engine name must begin with a unique letter
and each URL must have a %s format field indicating where to place the web search term
when a search is performed.
B.3.2 Using URLs with Find-File
Hyperbole always recognizes URLs within buffers when the Action Key is pressed on them.
But sometimes it is useful to enter a URL at a prompt and have it displayed. Hyperbole can
recognize ftp and www URLs given to the find-file command (or any other find-file-*
commands). But because there is added overhead with this feature, it is not enabled by
default.
To enable the feature, use the Hyperbole menu item Cust/Find-File-URLs (or FindFile-Accepts-URLs on the Hyperbole/Customize pulldown menu). Either of these toggles
acceptance of URLs. When enabled the string, URLs, appears in the parenthesized minormode section of the modeline.
To enable this feature each time you start the editor, add the following to your personal
initialization file: (hpath:find-file-urls-mode 1).
Both full URLs and abbreviated ones, like www.gnu.org, are recognized. File name
completion does not work with URLs thus you have to type or paste in the entire URL.
This feature will work only if you have the Tramp Emacs Lisp package installed; if you don’t
have Tramp, an error message will be displayed when you try to enable find-file URLs.
B.3.3 Internal Viewers
When given a file name, Hyperbole will by default display the file for editing within an
Emacs buffer. The hpath:internal-display-alist variable can be used to specify file
name patterns, such as matching suffixes, which will invoke a special Emacs Lisp function
to display any matching files within Emacs. This can be used to format raw data files for
convenient display.
Appendix B: Setup
73
For those who want to change this variable, hpath:internal-display-alist is defined in hpath.el. Its value is an association list whose elements are (<file-name-regularexpression> . <function-of-one-arg>) pairs. Any path whose name matches a <file-nameregular-expression> will be displayed by calling the associated <function-of-one-arg> with
the file name as the argument.
By default, this variable handles the following types of files:
Audio Files
Major audio format files are played with the play-sound-file command.
Info Manuals
Files with a .info suffix (may also be compressed) are displayed in the Info
browser.
RDB Files
Files with an .rdb suffix are displayed as relational databases using the RDB
package available with InfoDock.
See Section B.3.4 [External Viewers], page 73, for instructions on associating file names
with external, window-system specific viewers.
B.3.4 External Viewers
If you will be using Hyperbole under a window system, the hpath:get-external-displayalist function in hpath.el supports hyperlinks that open files using external, non-Emacs
tools, e.g. a pdf reader or a vector graphic viewer.
The value returned by hpath:get-external-display-alist is determined based on
the window system supported by the current frame and the version of Emacs in use. This
value is an association list whose elements are (<file-name-regular-expression> . <viewerprogram-or-list>) pairs. Any path whose name matches a <file-name-regular-expression>
will be displayed using the corresponding viewer-program or the first viewer-program found
on the system from a list of programs. If a <viewer-program> entry contains a ‘%s’ string,
the filename to display will be substituted at that point within the string. Otherwise, the
filename will be appended to the <viewer-program> entry. Alternatively, the viewer-program
may be a Lisp function that takes a single filename argument.
The association lists used by this function are stored in variables for each available window system: hpath:external-display-alist-macos, hpath:external-display-alistmswindows, and hpath:external-display-alist-x. Examine and modify these values to
suit your needs.
On systems that have a MIME mailcap file (see www.wikiwand.com/en/Mailcap),
this is used as a fallback set of external viewer associations when none are found within
hpath:get-external-display-alist.
B.3.5 Invisible Text Searches
This is largely for outline modes such as the Koutliner. By default, character-by-character
interactive search on {C-s} will search through invisible/hidden text, making the text temporarily visible until point moves past that hidden part. When a search match is selected,
the surrounding text remains visible.
This command toggles that setting (turns it off if a prefix argument less than or equal
to 0 is given) and makes searches look at only visible text.
Appendix B: Setup
74
B.3.6 Link Variable Substitution
Another option to consider modifying is hpath:variables. This option consists of a list
of Emacs Lisp variable names, each of which may have a pathname or a list of pathnames
as a value. Whenever a Hyperbole file or directory link button is created, its pathname
is compared against the values in hpath:variables. The first match found, if any, is
selected and its associated variable name is substituted into the link pathname, in place of
its literal value. When a link button is activated, potentially at a different site, Hyperbole
replaces each variable within the link pathname with the first matching value from this list
to recreate the literal pathname. Environment variables are also replaced whenever link
paths are resolved.
This permits sharing of links over wide areas, where the variable values differ between
link creator and link activator. The entire process is wholly transparent to the user; it
is explained here simply to help you in deciding whether or not to modify the value of
hpath:variables.
B.3.7 Configuring Button Colors
When Hyperbole is run under a window system together with InfoDock, Emacs, or XEmacs,
it automatically highlights any explicit buttons in a buffer and makes them flash when
selected. The main setting you may want change is the selection of a color (or style)
for button highlighting and button flashing. See the hui-*-b*.el files for lists of potential
colors and the code which supports this behavior. A call to (hproperty:cycle-but-color)
in the hsettings.el file changes the color used to highlight and flash explicit buttons.
Additionally, if hproperty:but-emphasize-p is set to ‘t’, then whenever the mouse
pointer moves over an explicit button, it will be emphasized in a different color or style.
This emphasis is in addition to any non-mouse-sensitive button highlighting.
If you read in a file with explicit buttons before you load Hyperbole, these buttons
won’t be highlighted. Load Hyperbole and then use {M-x hproperty:but-create RET} to
highlight the buttons in the current buffer.
75
Appendix C Global Key Bindings
This appendix summarizes all of Hyperbole’s global key bindings and whether each overrides
any existing binding or not. It also describes how to temporarily disable these bindings and
how to manage whether Hyperbole override local, mode-specific key bindings that hide
global Hyperbole keys.
Here are descriptions of Hyperbole’s default keyboard key bindings:
{M-RET}
Action Key: Invoke the Action Key in the present context.
{C-u M-RET}
Assist Key: Invoke the Assist Key in the present context.
{C-c \}
HyControl: Control windows, frames and buffer display. This binding is made
only if the key is not bound prior to loading Hyperbole.
{C-c /}
Search the Web: Display a minibuffer menu of web search engines. Once an
engine is selected, prompt for a search term and perform the associated search.
This binding is made only if the key is not bound prior to loading Hyperbole;
otherwise, the Find/Web minibuffer menu item, {C-h h f w}, will do the same
thing.
{C-c C-r} Button Rename: Rename an explicit button. This binding is made only if the
key is not bound prior to loading Hyperbole.
{M-o}
Drag Operation: Keyboard emulation of the start and stop of mouse drags to
invoke Smart Key actions. This binding is made only if the key is not bound
prior to loading Hyperbole and if Emacs is run under a window system.
{C-h h}
Hyperbole Mini Menu: Invoke the Hyperbole minibuffer menu, giving access to
many Hyperbole commands.
{C-h A}
Action Key Help: Show what the Action Key will do in the current context.
{C-u C-h A}
Assist Key Help: Show what the Assist Key will do in the same context.
{C-c RET} Mark Things: Mark larger and larger synctactical units in a buffer when invoked
repeatedly, showing in the minibuffer the type of unit marked each time. For
example, if on an opening brace at the start of a C, Java or Javascript function,
this marks the whole function. This binding is made only if the key is not
bound prior to loading Hyperbole.
{C-c .}
Delimited Thing Jump: Jump between the start and end of a delimited thing,
which may be an HTML tag pair. This binding is made only if the key is not
bound prior to loading Hyperbole. See Section 3.4 [Smart Key Thing Selection],
page 26, for more information.
The variable, hkey-init, controls whether or not any Hyperbole global key bindings are
made. It is set to ‘t’ (true) by default in hyperbole.el. This setting means all Hyperbole
key bindings will be initialized when Hyperbole is loaded. If you want to disable these
bindings permanently, simply add (setq hkey-init nil) to your ~/.emacs file prior to
the point at which you load Hyperbole and restart Emacs. Then you will have to choose
the Hyperbole commands that you want to use and bind those to keys.
76
If you ever have a need to temporarily disable the Hyperbole keyboard and mouse bindings, use the hkey-toggle-bindings command. It switches between the Hyperbole key
bindings and those set prior to loading Hyperbole and then back again if invoked once more.
There is no default key binding for this command; use {M-x hkey-toggle-bindings RET}.
Alternatively, you may select a key and bind it as part of any setting of hyperbole-inithook within your personal ~/.emacs file. For example, (add-hook 'hyperbole-init-hook
(lambda () (global-set-key "\C-ch" 'hkey-toggle-bindings))).
Major mode-specific keys take precedence over global key bindings. In some cases, a
major mode will unknowingly override some of the global Hyperbole keys, preventing you
from using them in that mode. By default, Hyperbole automatically prevents this by
checking each time a major mode is invoked and unbinding any mode-specific keys that
interfere with global Hyperbole keys. If you prefer that this not happen permanently, use
{M-x customize-variable RET hkey-init-override-local-keys RET}. Press the Toggle
button to change the value to nil. Then press the “Apply and Save” button.
77
Appendix D Koutliner Keys
This appendix summarizes the specialized key bindings available when editing a koutline
with Hyperbole. Each key is shown together with its command binding and the documentation for that command. Normal emacs editing keys are modified to account for the structure
within outlines. An outliner command which overloads an emacs command named cmd is
named kotl-mode:cmd.
kfile:write {C-x C-w}
Write the current outline to FILE.
klink:create {C-c l}
Insert at point an implicit link to REFERENCE. REFERENCE should be a
cell-ref or a string containing "filename, cell-ref". See the documentation for
(kcell:ref-to-id) for valid cell-ref formats.
kotl-mode:add-cell {C-j}
Add a cell following current cell at optional RELATIVE-LEVEL with CONTENTS string. Optional prefix arg RELATIVE-LEVEL means add as sibling
if nil or >= 0, as child if equal to universal argument, {C-u}, and as sibling of
current cell’s parent, otherwise. If added as sibling of current level, RELATIVELEVEL is used as a repeat count for the number of cells to add.
Return last newly added cell.
kotl-mode:add-child {C-c a}
Add a new cell to current kview as first child of current cell.
kotl-mode:add-parent {C-c p}
Add a new cell to current kview as sibling of current cell’s parent.
kotl-mode:append-cell {C-c +}
Append the CONTENTS-CELL to APPEND-TO-CELL. If neither cell has a
no-fill property and kotl-mode:refill-flag is enabled, then APPEND-TOCELL is refilled.
kotl-mode:back-to-indentation {M-m}
Move point to the first non-read-only non-whitespace character on this line.
kotl-mode:backward-cell {C-c C-b}
Move to prefix ARGth prior cell (same level) within current view. Return
number of cells left to move.
kotl-mode:backward-char {C-b}
Move point backward ARG (or 1) characters and return point.
kotl-mode:backward-kill-word {M-DEL}
Kill up to prefix ARG (or 1) words preceding point within a single cell.
kotl-mode:backward-sentence {M-a}
Move point backward ARG (or 1) sentences and return point.
kotl-mode:backward-word {M-b}
Move point backward ARG (or 1) words and return point.
Appendix D: Koutliner Keys
78
kotl-mode:beginning-of-buffer {M-<}
Move point to beginning of buffer and return point.
kotl-mode:beginning-of-cell {C-c ,}
Move point to beginning of current or ARGth - 1 prior cell and return point.
kotl-mode:beginning-of-line {C-a}
Move point to beginning of current or ARGth - 1 line and return point.
kotl-mode:beginning-of-tree {C-c ^}
Move point to the level 1 root of the current cell’s tree. Leave point at the start
of the cell.
kotl-mode:cell-help {C-c h}
Display a temporary buffer of CELL-REF’s attributes. CELL-REF defaults to
current cell. Optional prefix arg CELLS-FLAG selects the cells to print:
If = 1, print CELL-REF's cell only;
If > 1, print the visible tree rooted at CELL-REF;
If < 1, print all visible cells in current view
(In this last case, CELL-REF is not used).
See also the documentation for kotl-mode:cell-attributes.
kotl-mode:center-line {M-s}
Center the line point is on, within the width specified by fill-column. This
means adjusting the indentation so that it equals the distance between the end
of the text and fill-column.
kotl-mode:center-paragraph {M-S}
Center each nonblank line in the paragraph at or after point. See center-line
for more information.
kotl-mode:copy-after {C-c c}
Copy tree rooted at FROM-CELL-REF to follow tree rooted at TO-CELLREF. If prefix arg CHILD-P is non-nil, make FROM-CELL-REF the first child
of TO-CELL-REF, otherwise make it the sibling following TO-CELL-REF.
Leave point at the start of the root cell of the new tree.
kotl-mode:copy-before {C-c C-c}
Copy tree rooted at FROM-CELL-REF to precede tree rooted at TO-CELLREF. If prefix arg PARENT-P is non-nil, make FROM-CELL-REF the first
child of TO-CELL-REF’s parent, otherwise make it the preceding sibling of
TO-CELL-REF.
Leave point at the start of the root cell of the new tree.
kotl-mode:copy-to-buffer {C-c M-c}
Copy outline tree rooted at CELL-REF to a non-koutline BUFFER. Use 0 to
copy the whole outline buffer.
kotl-mode:copy-to-register {C-x x}
Copy into REGISTER the region START to END. With optional prefix arg
DELETE-FLAG, delete region.
Appendix D: Koutliner Keys
79
kotl-mode:delete-backward-char {DEL}
Delete up to the preceding prefix ARG characters. Return number of characters deleted. Optional KILL-FLAG non-nil means save in kill ring instead of
deleting. Does not delete across cell boundaries.
kotl-mode:delete-blank-lines {C-x C-o}
On blank line within a cell, delete all surrounding blank lines, leaving just one.
On isolated blank line, delete that one. On nonblank line, delete all blank lines
that follow it.
If nothing but whitespace follows point until the end of a cell, delete all whitespace at the end of the cell.
kotl-mode:delete-char {C-d}
Delete up to prefix ARG characters following point. Return number of characters deleted. Optional KILL-FLAG non-nil means save in kill ring instead of
deleting. Does not delete across cell boundaries.
kotl-mode:delete-indentation {M-^}
Join this line to previous and fix up whitespace at join. If there is a fill prefix,
delete it from the beginning of this line. With argument, join this line to the
following line.
kotl-mode:demote-tree {TAB}
Move current tree a maximum of prefix ARG levels lower in current view.
Each cell is refilled iff its no-fill attribute is nil and kotl-mode:refill-flag
is non-nil. With prefix ARG = 0, cells are demoted up to one level and
kotl-mode:refill-flag is treated as true.
kotl-mode:down-level {C-c C-d}
Move down prefix ARG levels lower within current tree.
kotl-mode:end-of-buffer {M->}
Move point to the end of buffer and return point.
kotl-mode:end-of-cell {C-c .}
Move point to end of current or ARGth - 1 succeeding cell and return point.
kotl-mode:end-of-line {C-e}
Move point to end of current or ARGth - 1 line and return point.
kotl-mode:end-of-tree {C-c $}
Move point to the last cell in tree rooted at the current cell. Leave point at the
start of the cell.
kotl-mode:example
Display the Koutliner example file for demonstration use by a user.
kotl-mode:exchange-cells {C-c e}
Exchange CELL-REF-1 with CELL-REF-2 in current view. Don’t move point.
kotl-mode:fill-cell {C-c M-j}
Fill current cell if it lacks the no-fill attribute. With optional JUSTIFY, justify cell as well. IGNORE-COLLAPSED-P is used when caller has already
expanded cell, indicating it is not collapsed.
Appendix D: Koutliner Keys
80
kotl-mode:fill-paragraph {C-x f}
Fill current paragraph within cell. With optional JUSTIFY, justify paragraph
as well. Ignore any non-nil no-fill attribute attached to the cell.
kotl-mode:fill-tree {C-M-j}
Refill each cell within the tree whose root is at point.
kotl-mode:first-sibling {C-c <}
Move point to the first sibling of the present cell. Leave point at the start of
the cell or at its present position if it is already within the first sibling cell.
kotl-mode:fkey-backward-char {C-b} or {left}
Move point backward ARG (or 1) characters and return point.
kotl-mode:fkey-forward-char {C-f} or {right}
Move point forward ARG (or 1) characters and return point.
kotl-mode:fkey-next-line {C-n} or {down}
Move point to ARGth next line and return point.
kotl-mode:fkey-previous-line {C-p} or {up}
Move point to ARGth previous line and return point.
kotl-mode:forward-cell {C-c C-f}
Move to the prefix ARG following cell (same level) within current view. Return
number of cells left to move.
kotl-mode:forward-char {C-f}
Move point forward ARG (or 1) characters and return point.
kotl-mode:forward-para {M-n}
Move to prefix ARGth next cell (any level) within current view.
kotl-mode:forward-paragraph {M-]}
Move to prefix ARG next cell (any level) within current view.
kotl-mode:forward-sentence {M-e}
Move point forward ARG (or 1) sentences and return point.
kotl-mode:forward-word {M-f}
Move point forward ARG (or 1) words and return point.
kotl-mode:goto-cell {C-c g}
Move point to start of cell given by CELL-REF. (See the documentation for
(kcell:ref-to-id), for valid formats.) Return point iff CELL-REF is found
within current view. With a prefix argument, CELL-REF is assigned the argument value for use as an idstamp.
Optional second arg, ERROR-P, non-nil means signal an error if CELL-REF
is not found within current view. Will signal same error if called interactively
when CELL-REF is not found.
kotl-mode:hide-sublevels {C-X $}
Hide all cells in outline at levels deeper than LEVELS-TO-KEEP (a number).
Show any hidden cells within LEVELS-TO-KEEP. 1 is the first level.
Appendix D: Koutliner Keys
81
kotl-mode:hide-subtree {C-M-h}
Hide subtree, ignoring root, at optional CELL-REF (defaults to cell at point).
kotl-mode:hide-tree {C-c BS}
Collapse tree rooted at optional CELL-REF (defaults to cell at point).
kotl-mode:indent-line {TAB}
Indent line relative to the previous one. With optional prefix ARG greater than
1, tab forward ARG times. See the documentation string of ‘kotl-mode:indenttabs-mode’ for details on when tabs are used for indenting.
kotl-mode:indent-region {C-M-\}
Indent each nonblank line in the region from START to END. If there is a fill
prefix, make each line start with the fill prefix. With argument COLUMN,
indent each line to that column. Called from a program, takes three args:
START, END and COLUMN.
kimport:insert-file {C-x i}
Insert each paragraph in IMPORT-FROM as a separate cell in the current
view. Insert as sibling cells following the current cell. IMPORT-FROM may be
a buffer name or file name (file name completion is provided).
kimport:insert-register {C-x r i}
Insert contents of REGISTER at point in current cell. REGISTER is a character naming the register to insert. Normally puts point before and mark after
the inserted text. If optional second arg is non-nil, puts mark before and point
after. Interactively, second arg is non-nil if prefix arg is supplied.
kotl-mode:just-one-space {M-\}
Delete all spaces and tabs around point and leave one space.
kotl-mode:kill-contents {C-c k}
Kill contents of cell from point to cell end. With prefix ARG, kill entire cell
contents.
kotl-mode:kill-line {C-k}
Kill ARG lines from point.
kotl-mode:kill-region {C-w}
Kill region between START and END within a single kcell. With optional
COPY-P equal to t, copy region to kill ring but don’t kill it. With COPY-P
any other non-nil value, return region as a string without affecting the kill ring.
If the buffer is read-only and COPY-P is nil, the region will not be deleted but
it will be copied to the kill ring and then an error will be signaled.
kotl-mode:kill-ring-save {M-w}
Copy region between START and END within a single kcell to kill ring.
kotl-mode:kill-sentence {M-k}
Kill up to prefix ARG (or 1) sentences following point within a single cell.
kotl-mode:kill-tree {C-c C-k}
Kill ARG following trees starting with tree rooted at point. If ARG is a nonpositive number, nothing is done.
Appendix D: Koutliner Keys
82
kotl-mode:kill-word {M-d}
Kill up to prefix ARG words following point within a single cell.
kotl-mode:last-sibling {C-c >}
Move point to the last sibling of the present cell. Leave point at the start of
the cell or at its present position if it is already within the last sibling cell.
kotl-mode:mail-tree {C-c @}
Mail outline tree rooted at CELL-REF. Use "0" for whole outline buffer.
kotl-mode:move-after {C-c m}
Move tree rooted at FROM-CELL-REF to follow tree rooted at TO-CELLREF. If prefix arg CHILD-P is non-nil, make FROM-CELL-REF the first child
of TO-CELL-REF, otherwise make it the sibling following TO-CELL-REF.
With optional COPY-P, copy tree rather than moving it.
Leave point at original location but return the tree’s new start point.
kotl-mode:move-before {C-c RET}
Move tree rooted at FROM-CELL-REF to precede tree rooted at TO-CELLREF. If prefix arg PARENT-P is non-nil, make FROM-CELL-REF the first
child of TO-CELL-REF’s parent, otherwise make it the preceding sibling of
TO-CELL-REF. With optional COPY-P, copy tree rather than moving it.
Leave point at original location but return the tree’s new start point.
kotl-mode:newline {RET}
Insert a newline. With ARG, insert ARG newlines. In Auto Fill mode, if no
numeric arg, break the preceding line if it is too long.
kotl-mode:next-cell {C-c C-n}
Move to prefix ARG next cell (any level) within current view.
kotl-mode:next-line {C-n}
Move point to ARGth next line and return point.
kotl-mode:open-line {C-o}
Insert a newline and leave point before it. With arg N, insert N newlines.
kotl-mode:overview {C-c C-o}
Show only the first line of each cell in the current outline. With a prefix arg,
also toggle the display of blank lines between cells.
kotl-mode:previous-cell {C-c C-p}
Move to prefix ARG previous cell (any level) within current view.
kotl-mode:previous-line {C-p}
Move point to ARGth previous line and return point.
kotl-mode:promote-tree {M-TAB} or {SHIFT-TAB}
Move current tree a maximum of prefix ARG levels higher in current view.
Each cell is refilled iff its no-fill attribute is nil and kotl-mode:refill-flag
is non-nil. With prefix ARG = 0, cells are promoted up to one level and
kotl-mode:refill-flag is treated as true.
Appendix D: Koutliner Keys
83
kotl-mode:scroll-down {M-v}
Scroll text of current window downward ARG lines; or a windowful if no ARG.
kotl-mode:scroll-up {C-v}
Scroll text of current window upward ARG lines; or a windowful if no ARG.
kotl-mode:set-cell-attribute {C-c C-i}
Include ATTRIBUTE VALUE with the current cell or the cell at optional POS.
Replace any existing value that ATTRIBUTE has. When called interactively,
display the setting in the minibuffer as confirmation.
kotl-mode:set-fill-prefix {C-x l}
Set fill prefix to line up to point. With prefix arg TURN-OFF or at begin of
line, turn fill prefix off.
kotl-mode:show-all {C-c C-a}
Show (expand) all cells in current view. With a prefix arg, also toggle the
display of blank lines between cells.
kotl-mode:show-subtree
Show subtree, ignoring root, at optional CELL-REF (defaults to cell at point).
kotl-mode:show-tree {C-c C-s}
Display fully expanded tree rooted at CELL-REF.
kotl-mode:split-cell {C-c s}
Split cell into two cells and move to new cell. Cell contents after point become
part of newly created cell. Default is to create new cell as sibling of current
cell. With optional universal ARG, {C-u}, new cell is added as child of current
cell.
kotl-mode:top-cells {C-c C-t}
Collapse all level 1 cells in view and hide any deeper sublevels. With a prefix
arg, also toggle the display of blank lines between cells.
kotl-mode:transpose-cells {C-c t}
Exchange current and previous visible cells, leaving point after both. If no
previous cell, exchange current with next cell. With prefix ARG, take current
cell and move it past ARG cells. With prefix ARG = 0, interchange the cell
that contains point with the cell that contains mark.
kotl-mode:transpose-chars {C-t}
Interchange characters around point, moving forward one character. With prefix ARG, take character before point and drag it forward past ARG other
characters (backward if ARG negative). If no prefix ARG and at end of line,
the previous two characters are exchanged.
kotl-mode:transpose-lines {C-x C-t}
Exchange current line and previous line, leaving point after both. If no previous
line, exchange current with next line. With prefix ARG, take previous line and
move it past ARG lines. With prefix ARG = 0, interchange the line that
contains point with the line that contains mark.
84
kotl-mode:transpose-words {M-t}
Interchange words around point, leaving point after both words. With prefix
ARG, take word before or around point and drag it forward past ARG other
words (backward if ARG negative). If ARG is zero, the words around or after
point and around or after mark are interchanged.
kotl-mode:up-level {C-c C-u}
Move up prefix ARG levels higher in current outline view.
kotl-mode:yank {C-y}
Reinsert the last stretch of killed text. More precisely, reinsert the stretch of
killed text most recently killed OR yanked. Put point at end, and set mark at
beginning. With just C-u as argument, same but put point at beginning (and
mark at end). With argument N, reinsert the Nth most recently killed stretch
of killed text. See also the command, (kotl-mode:yank-pop).
kotl-mode:yank-pop {M-y}
Replace just-yanked stretch of killed text with a different stretch. This
command is allowed only immediately after a (yank) or a (yank-pop). At
such a time, the region contains a stretch of reinserted previously-killed text.
(yank-pop) deletes that text and inserts in its place a different stretch of
killed text.
With no argument, the previous kill is inserted. With argument N, insert the
Nth previous kill. If N is negative, this is a more recent kill.
The sequence of kills wraps around, so that after the oldest one comes the
newest one.
kotl-mode:zap-to-char {M-z}
Kill up to and including prefix ARGth occurrence of CHAR. Goes backward if
ARG is negative; error if CHAR not found.
kview:set-label-separator {C-c M-l}
Set the LABEL-SEPARATOR (a string) between labels and cell contents for
the current kview. With optional prefix arg SET-DEFAULT-P, the default
separator value used for new outlines is also set to this new value.
kview:set-label-type {C-c C-l}
Change kview’s label display type to NEW-TYPE, updating all displayed labels. See documentation for the kview:default-label-type variable, for valid
values of NEW-TYPE.
kvspec:activate {C-c C-v}
Activate
optional
VIEW-SPEC
or
existing
view
specification
over the current koutline.
VIEW-SPEC must be a string.
See
‘<${hyperb:dir}/kotl/EXAMPLE.kotl, 2b17=048>’ for details on valid view
specs.
kvspec:toggle-blank-lines {C-c b}
Toggle blank lines between cells on or off.
85
Appendix E Smart Key Reference
This appendix documents Hyperbole’s context-sensitive Smart Key operations. It is quite
extensive and is meant for reference rather than sequential reading. See Chapter 3 [Smart
Keys], page 22, for a description of the Smart Keys. That section also describes how to get
context-sensitive Smart Key help, with which you can explore Smart Key operation bit by
bit.
What a Smart Key does depends on the context in which it is used. Smart Key operations
are context-sensitive. Contexts are defined by logic conditionals, e.g. when depressed here,
if this is true, etc. Each Smart Key context is listed in the order in which it will be checked.
The first matching context is always the one applied. Within each context, the actions
performed by the Action and Assist Keys are given.
E.1 Smart Mouse Keys
The contexts and actions in this section, like drags and modeline clicks, apply only if you
have mouse support within Hyperbole. The Smart Key operations in Section E.2 [Smart
Keyboard Keys], page 89, apply to both mouse and keyboard Smart Key usage.
The following section documents what the Smart Mouse Keys do in each context, with
the contexts listed in decreasing order of priority, i.e. the first context to match is the one
that is used. If no matching mouse key context is found, then the keyboard key contexts
are searched in order.
E.1.1 Minibuffer Menu Activation
When clicked within an inactive minibuffer:
ACTION KEY
The Hyperbole minibuffer menu is displayed for selection, by default.
The variable action-key-minibuffer-function controls this behavior.
ASSIST KEY
The buffer, window and frame jump menu is displayed for selection, by default.
You can jump to buffers categorized by major mode, jump to windows by
buffer name, or to frames by name. Manage your windows and frames
quickly with this menu as well. This is the same menu that a click
in a blank area of the modeline displays by default since they are
typically so close together. The variable assist-key-minibuffer-function
controls this behavior.
E.1.2 Thing Selection
In a programming or markup language buffer, when pressed/clicked at
the start or end of a delimited thing (including lists, comments,
strings, arrays/vectors, sets, functions and markup pair tags in a
markup language), and not at the end of a line:
ACTION KEY
Marks the thing for editing.
ASSIST KEY
Marks and kills the thing for yanking elsewhere.
Appendix E: Smart Key Reference
86
Note that the press must be on the first character of the delimiter of the thing.
There are also drag actions that work on delimited things. Delimited things include
parenthesized lists, single and double quoted strings, bracketed arrays/vectors, sets with
braces, programming language functions and markup pair tags (e.g. <div> </div> in
HTML).
If no region is selected when the Action Mouse Key is dragged from a thing delimiter to
another location, it copies the delimited thing to the release point of the drag. The release
location may be in the same or a different buffer but if in the same buffer it must be outside
of the delimited thing itself. Similarly, the Assist Mouse Key kills (cuts) the delimited thing
at its original location and yanks (pastes) it at the new location.
The start of the drag must be on the first character of the starting or ending delimiter.
For strings and comments, the drag must start on the first line of the thing.
Experiment with these drag actions and you will quickly find them easy to use and
indispensable.
E.1.3 Side-by-Side Window Resizing
If dragged from a side-by-side window edge or from the immediate left of
a vertical scroll bar:
ACTION KEY or ASSIST KEY
Resizes adjacent window sides to the point of the drag release.
Appendix E: Smart Key Reference
E.1.4 Modeline Clicks and Drags
If depressed within a window mode line:
ACTION KEY
(1) clicked on the left edge of a window’s modeline, the window’s
buffer is buried (placed at the bottom of the buffer list);
(2) clicked on the right edge of a window’s modeline, the Info
buffer is displayed, or if it is already displayed and the
modeline clicked upon belongs to a window displaying Info,
the Info buffer is hidden;
(3) clicked anywhere within the middle of a window’s modeline,
the function given by ‘action-key-modeline-function’ is called;
(4) dragged vertically from a modeline to within a window, the
modeline is moved to the point of the drag release, thereby
resizing its window and potentially its vertically neighboring
windows.
ASSIST KEY
(1) clicked on the left edge of a window’s modeline, the bottom
buffer in the buffer list is unburied and placed in the window;
(2) clicked on the right edge of a window’s modeline, the summary
of Smart Key behavior is displayed, or if it is already
displayed and the modeline clicked upon belongs to a window
displaying the summary, the summary buffer is hidden;
(3) clicked anywhere within the middle of a window’s modeline,
the function given by ‘assist-key-modeline-function’ is called;
(4) dragged vertically from a modeline to within a window, the
modeline is moved to the point of the drag release, thereby
resizing its window and potentially its vertically neighboring
windows.
E.1.5 Smart Mouse - Drags between Windows
If an active (highlighted) region exists within the editor:
ACTION KEY
Copies and yanks (pastes) the region to the release point in a
different window.
ASSIST KEY
Kills (cuts) and yanks (pastes) the region to the release point
in a different window.
Otherwise, if dragged from inside one window to another:
ACTION KEY
Creates a new link button at the drag start location, linked to the
drag end location. If the drag start position is within a button,
this modifies the button to link to the drag end location.
ASSIST KEY
Swaps buffers in the two windows.
87
Appendix E: Smart Key Reference
E.1.6 Smart Mouse - Drags within a Window
If a region is active and a drag occurs within a single buffer/window:
ACTION KEY
Restores region to before Action Key drag and signals an error.
ASSIST KEY
Restores region to before Action Key drag and signals an error.
(Note that hmouse-x-drag-sensitivity sets the minimal horizontal
movement which registers a drag). If dragged horizontally within a
single window from anywhere but a thing delimiter:
ACTION KEY
Splits the current window, adding a window below.
ASSIST KEY
Deletes the current window if it is not the sole window in the
current frame.
(Note that hmouse-y-drag-sensitivity sets the minimal vertical
movement which registers a drag). If dragged vertically within a
single window from anywhere but a thing delimiter:
ACTION KEY
Splits the current window, adding a window to the right.
ASSIST KEY
Deletes the current window if it is not the sole window in the
current frame.
If dragged diagonally within a single window while depressed
(‘hmouse-x-diagonal-sensitivity’ and ‘hmouse-y-diagonal-sensitivity’ set
the minimal diagonal movements which register a drag):
ACTION KEY
Saves the window configuration for the selected frame onto a ring
of window configurations.
ASSIST KEY
Restores the prior window configuration from the ring. A prefix
argument N specifies the Nth prior configuration from the ring.
88
Appendix E: Smart Key Reference
E.2 Smart Keyboard Keys
E.2.1 Smart Key - Emacs Pushbuttons
When over an Emacs pushbutton:
ACTION KEY
Performs the button action
ASSIST KEY
Displays the help text for the button, if any.
E.2.2 Smart Key - Argument Completion
When prompting for a Hyperbole argument, a press in the minibuffer:
ACTION KEY
Accepts the current minibuffer argument.
ASSIST KEY
Offers completions for the current minibuffer argument.
When reading a Hyperbole menu item or an argument with completion:
ACTION KEY
Returns the value selected at point if any, else nil. If the
value is the same as the contents of the minibuffer, this value is
accepted as the argument for which the minibuffer is presently
prompting; otherwise, the minibuffer is erased and the value is
inserted there, for inspection by the user.
ASSIST KEY
Displays Hyperbole menu item help when an item is selected.
E.2.3 Smart Key - ID Edit Mode
If in ID Edit mode (a package within InfoDock, not included in
Hyperbole, that supports rapid marking, killing, copying, yanking and
display-management):
ACTION KEY or ASSIST KEY
Yanks (pastes) last selected region at point.
E.2.4 Smart Key - Emacs Cross-references (Xrefs)
When over an Emacs cross-reference:
ACTION KEY
Follows the cross-reference to its source definition in another window.
ASSIST KEY
Displays the cross-reference definition in another window but
stays in the current window.
89
Appendix E: Smart Key Reference
90
E.2.5 Smart Key - Smart Scrolling
When pressed at the end of a line but not the end of a buffer:
ACTION KEY
Calls the function given by action-key-eol-function whose
default value is smart-scroll-up. This scrolls up according
to the value of smart-scroll-proportional. If
smart-scroll-proportional is nil or if point is on the top
window line, it scrolls up (forward) a windowful. Otherwise, it tries
to bring the current line to the top of the window, leaving point at
the end of the line and returning t if scrolled, nil if not.
ASSIST KEY
Calls the function given by assist-key-eol-function whose
default value is smart-scroll-down. This scrolls down according
to the value of smart-scroll-proportional. If
smart-scroll-proportional is nil or if point is on the bottom
window line, it scrolls down (backward) a windowful. Otherwise, it tries
to bring the current line to the bottom of the window, leaving point at
the end of the line and returning t if scrolled, nil if not.
E.2.6 Smart Key - Smart Menus
Smart Menus are an older in-buffer menu system that worked on dumb terminals and predated Emacs’ own dumb terminal menu support. They are included with InfoDock (which
is no longer maintained) and are not available separately. They are not a part of Hyperbole
and are not necesary for its use.
When pressed on a Smart Menu item (this is an older in-buffer menu
system that pre-dates Emacs’ own menus):
ACTION KEY
Activates the item.
ASSIST KEY
Displays help for the item.
If the Smart Menu package (part of InfoDock) has been loaded and
‘hkey-always-display-menu’ is non-nil:
ACTION KEY or ASSIST KEY
Pops up a window with a Smart Menu of commands.
The menu displayed is selected by (smart-menu-choose-menu).
Appendix E: Smart Key Reference
E.2.7 Smart Key - Dired Mode
If pressed within a dired-mode (directory editor) buffer:
ACTION KEY
(1) within an entry line, the selected file/directory is displayed
for editing in the other window;
(2) on the first line of the buffer, if any deletes are to be
performed, they are executed after user verification; otherwise,
nothing is done;
(3) on or after the last line in the buffer, this dired invocation
is quit.
ASSIST KEY
(1) on a ~ character, all backup files in the directory are marked
for deletion;
(2) on a # character, all auto-save files in the directory are
marked for deletion;
(3) anywhere else within an entry line, the current entry is marked
for deletion;
(4) on or after the last line in the buffer, all delete marks on
all entries are undone.
E.2.8 Smart Key - Hyperbole Buttons
When pressed on a Hyperbole button:
ACTION KEY
Activates the button.
ASSIST KEY
Displays help for the button, typically a summary of its
attributes.
E.2.9 Smart Key - View Mode
If pressed within a buffer in View major or minor mode:
ACTION KEY
Scrolls the buffer forward a windowful. If at the last line of the
buffer, instead quits from view mode.
ASSIST KEY
Scrolls the buffer backward a windowful.
91
Appendix E: Smart Key Reference
E.2.10 Smart Key - Delimited Things
In a programming or markup language buffer, when pressed/clicked at
the start or end of a delimited thing (including lists, comments,
strings, arrays/vectors, sets, functions and markup pair tags in a
markup language), and not at the end of a line:
ACTION KEY
Marks the thing for editing.
ASSIST KEY
Marks and kills the thing for yanking elsewhere.
Note that the press must be on the first character of the delimiter of
the thing.
There are also drag actions that work on delimited things. If no
region is selected, when the Action Mouse Key is dragged from a thing
delimiter to another location, it copies the thing and yanks it at the
new location. Similarly, the Assist Mouse Key kills the thing at its
original location and yanks it at the new location.
E.2.11 Smart Key - The Koutliner
When pressed within a Hyperbole Koutliner buffer (kotl-mode):
ACTION KEY
(1) at the end of the buffer, uncollapses and unhides all cells in
the view;
(2) within a cell, if its subtree is hidden then shows it,
otherwise hides it;
(3) between cells or within the read-only indentation region to the
left of a cell, begins creation of a klink to some other
outline cell; press the Action Key twice on another cell to
select the link referent cell;
(4) anywhere else, scrolls up a windowful.
ASSIST KEY
(1) at the end of the buffer, collapses all cells and hides all
non-level-one cells;
(2) on a header line but not at the beginning or end, displays the
properties of each following cell in the koutline, starting
with the cell at point;
(3) between cells or within the read-only indentation region to the
left of a cell, prompts to move one tree to a new location in
the outline; press the Action Key twice to select the tree to
move and where to move it;
(4) anywhere else, scrolls down a windowful.
92
Appendix E: Smart Key Reference
93
E.2.12 Smart Key - RDB Mode
If pressed within an rdb-mode buffer which manipulates in-memory,
relational databases (part of InfoDock):
ACTION KEY
(1) on the name of a relation, the relation’s full table is shown;
(2) on an attribute name, all attribute columns aside from this one
are removed from the relation display;
(3) to the left of a tuple (row), the tuple is removed from the display;
(4) on an attribute value, all tuples (rows) which do not contain
the selected attribute value are removed from the current table display;
(5) on or after the last line in the buffer, the current database is redisplayed;
(6) anywhere else (except the end of a line), the last command is undone."
ASSIST KEY
(1) on the name of a relation, the relation is removed from the display;
(2) on an attribute name, the attribute column is removed from the relation
display;
(3) to the left of a tuple (row), the tuple is removed from the display;
(4) on an attribute value, all tuples with the same attribute value are
removed from the display."
E.2.13 Smart Key - Help Buffers
When pressed at the end of a Help buffer:
ACTION KEY or ASSIST KEY
Restores the window configuration prior to the help display.
E.2.14 Smart Key - Identifier Menu Mode
This works only for identifiers defined within the same source file in which they are referenced.
It requires either Emacs’ imenu or XEmacs’ func-menu library and it requires that an index of
identifiers has been built for the current buffer. Other handlers handle identifier references
and definitions across multiple files.
When pressed on an identifier name after an identifier index has been generated:
ACTION KEY
Jumps to the source definition within the current buffer of the identifier at point.
ASSIST KEY
Prompts with completion for an identifier defined within the buffer and then jumps
to the its source definition.
Appendix E: Smart Key Reference
E.2.15 Smart Key - C Source Code
When pressed within a C source code file:
ACTION KEY
Jumps to the definition of a selected C construct:
(1) on a #include statement, the include file is displayed;
this looks for include files using the directory lists
‘smart-c-cpp-include-path’ and
‘smart-c-include-path’;
(2) on a C identifier, the identifier definition is displayed,
assuming the identifier is found within an "etags" generated
tags file within the current directory or any of its ancestor
directories;
(3) if ‘smart-c-use-lib-man’ is non-nil (see its documentation),
the C identifier is recognized as a library symbol, and a man
page is found for the identifier, then the man page is
displayed.
ASSIST KEY
Jumps to the next tag matching an identifier at point.
E.2.16 Smart Key - C++ Source Code
When the OO-Browser has been loaded and the press is within a C++
buffer:
ACTION KEY or ASSIST KEY
Jumps to the definition of the selected C++ construct via
OO-Browser support.
(1) on a #include statement, the include file is displayed;
this looks for include files using the directory lists
‘smart-c-cpp-include-path’ and
‘smart-c-include-path’;
(2) within a method definition before the opening brace, its
declaration is displayed;
(3) within a method declaration, its definition is displayed;
(4) on a class name, the class definition is shown;
(5) on a member reference (past any :: scoping operator), the
member definition or a listing of possible definitions or a
matching declaration (if no definitions exist within the
Environment) is shown;
(6) on a global variable or function identifier, its definition is
shown.
94
Appendix E: Smart Key Reference
When pressed within a C++ source code file (without the OO-Browser):
ACTION KEY
Jumps to the definition of the selected C++ construct:
(1) on a #include statement, the include file is displayed;
this looks for include files using the directory lists
‘smart-c-cpp-include-path’ and
‘smart-c-include-path’;
(2) on a C++ identifier, the identifier definition is displayed,
assuming the identifier is found within an "etags" generated
tags file in the current directory or any of its ancestor
directories;
(3) if ‘smart-c-use-lib-man’ is non-nil (see its documentation),
the C++ identifier is recognized as a library symbol, and a man
page is found for the identifier, then the man page is
displayed.
ASSIST KEY
Jumps to the next tag matching an identifier at point.
E.2.17 Smart Key - Assembly Source Code
When pressed within an assembly source code file:
ACTION KEY
Jumps to the definition of the selected assembly construct:
(1) on an include statement, the include file is displayed;
this looks for include files using the directory list
‘smart-asm-include-path’;
(2) on an identifier, the identifier definition is displayed,
assuming the identifier is found within an "etags" generated
tags file within the current directory or any of its ancestor
directories.
ASSIST KEY
Jumps to the next tag matching an identifier at point.
E.2.18 Smart Key - Lisp Source Code
When pressed on a Lisp symbol within any of these types of buffers
(Lisp code, debugger, compilation, or help):
ACTION KEY
Jumps to the definition of any selected Lisp construct. If on an
Emacs Lisp require, load, or autoload clause and the (find-library)
function is defined, jumps to the library source, if possible.
ASSIST KEY
Jumps to the next tag matching an identifier at point or if
the identifier is an Emacs Lisp symbol, then this displays the
documentation for the symbol.
95
Appendix E: Smart Key Reference
E.2.19 Smart Key - Java Source Code
When the OO-Browser has been loaded and the press is within a Java
buffer:
ACTION KEY or ASSIST KEY
Jumps to the definition of the selected Java construct:
(1) within a commented @see cross-reference, the referent is
displayed;
(2) on a package or import statement, the referent is
displayed; this looks for referent files using the directory
list ‘smart-java-package-path’;
(3) within a method declaration, its definition is displayed;
(4) on a class name, the class definition is shown;
(5) on a unique identifier reference, its definition is shown (when
possible).
When pressed within a Java source code file (without the OO-Browser):
ACTION KEY
Jumps to the definition of the selected Java construct:
(1) within a commented @see cross-reference, the referent is
displayed;
(2) on a package or import statement, the referent is
displayed; this looks for referent files using the directory
list ‘smart-java-package-path’;
(3) on a Java identifier, the identifier definition is displayed,
assuming the identifier is found within an "etags" generated
tags file within the current directory or any of its ancestor
directories.
ASSIST KEY
Jumps to the next tag matching an identifier at point.
E.2.20 Smart Key - JavaScript Source Code
When pressed within a JavaScript source code file:
ACTION KEY
Jumps to the definition of the selected JavaScript identifier,
assuming the identifier is found within an "etags" generated
tags file within the current directory or any of its ancestor
directories.
ASSIST KEY
Jumps to the next tag matching an identifier at point.
96
Appendix E: Smart Key Reference
E.2.21 Smart Key - Python Source Code
When the OO-Browser has been loaded and the press is within a Python
buffer:
ACTION KEY or ASSIST KEY
Jumps to the definition of the selected Python construct:
(1) on an ‘import’ line, the referent is displayed;
(2) within a method declaration, its definition is displayed;
(3) on a class name, the class definition is shown;
(4) on a unique identifier reference, its definition is shown (when
possible).
When pressed within a Python source code file (without the OO-Browser):
ACTION KEY
Jumps to the definition of the selected Python identifier,
assuming the identifier is found within an "etags" generated
tags file within the current directory or any of its ancestor
directories.
ASSIST KEY
Jumps to the next tag matching an identifier at point.
E.2.22 Smart Key - Objective-C Source Code
When the OO-Browser has been loaded and the press is within a
Objective-C buffer:
ACTION KEY or ASSIST KEY
Jumps to the definition of the selected Objective-C construct via
OO-Browser support.
(1) on a #import or #include statement, the include file is
displayed; this looks for include files using the directory
lists ‘objc-cpp-include-path’ and
‘objc-include-path’;
(2) within a method declaration, its definition is displayed;
(3) on a class name, the class definition is shown;
(4) on a member reference (past any :: scoping operator), the
member definition or a listing of possible definitions is
shown;
(5) on a global variable or function identifier, its definition
is shown.
97
Appendix E: Smart Key Reference
When pressed within an Objective-C source code file (without the
OO-Browser):
ACTION KEY
Jumps to the definition of the selected Objective-C construct:
(1) on a #import or #include statement, the include file is
displayed; this looks for include files using the directory
lists ‘objc-cpp-include-path’ and
‘objc-include-path’;
(2) on an Objective-C identifier, the identifier definition is
displayed, assuming the identifier is found within an "etags"
generated tags file in the current directory or any of its
ancestor directories;
(3) if ‘smart-c-use-lib-man’ is non-nil (see its documentation),
the Objective-C identifier is recognized as a library symbol,
and a man page is found for the identifier, then the man page
is displayed.
ASSIST KEY
Jumps to the next tag matching an identifier at point.
E.2.23 Smart Key - Fortran Source Code
When pressed within a Fortran source code file:
ACTION KEY or ASSIST KEY
If on an identifier, the identifier definition (or a definition in
which the identifier appears) is displayed, assuming the identifier
is found within an "etags" generated tags file in the current
directory or any of its ancestor directories.
E.2.24 Smart Key - Occurrence Matches
When pressed within an occur-mode, moccur-mode or amoccur-mode buffer:
ACTION KEY or ASSIST KEY
Jumps to the source buffer and line of the current occurrence.
98
Appendix E: Smart Key Reference
E.2.25 Smart Key - Calendar Mode
When pressed within a calendar-mode buffer:
ACTION KEY
(1) at the end of the buffer, the calendar is scrolled forward 3
months;
(2) to the left of any dates on a calendar line, the calendar is
scrolled backward 3 months;
(3) on a date, the diary entries for the date, if any, are
displayed.
ASSIST KEY
(1) at the end of the buffer, the calendar is scrolled backward 3
months;
(2) to the left of any dates on a calendar line, the calendar is
scrolled forward 3 months;
(3) anywhere else, all dates with marking diary entries are marked
in the calendar window.
E.2.26 Smart Key - Man Page Apropos
When pressed within a man page apropos buffer or listing:
ACTION KEY
(1) on a UNIX man apropos entry, the man page for that entry is
displayed in another window;
(2) on or after the last line, the buffer in the other window is
scrolled up a windowful.
ASSIST KEY
(1) on a UNIX man apropos entry, the man page for that entry is
displayed in another window;
(2) on or after the last line, the buffer in the other window is
scrolled down a windowful.
99
Appendix E: Smart Key Reference
E.2.27 Smart Key - Emacs Outline Mode
If pressed within an outline-mode buffer or when no other context is matched
and outline-minor-mode is enabled:
ACTION KEY
Collapses, expands, and moves outline entries.
(1) after an outline heading has been cut via the Action Key,
pastes the cut heading at point;
(2) at the end of the buffer, shows all buffer text;
(3) at the beginning of a heading line, cuts the headings subtree
from the buffer;
(4) on a header line but not at the beginning or end of the line,
if the headings subtree is hidden, shows it, otherwise hides
it;
(5) anywhere else, scrolls up a windowful.
ASSIST KEY
(1) after an outline heading has been cut via the Action Key,
allows multiple pastes throughout the buffer (the last paste
should be done with the Action Key, not the Assist Key);
(2) at the end of the buffer, hides all bodies in the buffer;
(3) at the beginning of a heading line, cuts the current heading
(sans subtree) from the buffer;
(4) on a header line but not at the beginning or end, if the
heading body is hidden, shows it, otherwise hides it;
(5) anywhere else, scrolls down a windowful.
100
Appendix E: Smart Key Reference
E.2.28 Smart Key - Info Manuals
If pressed within an Info manual node:
ACTION KEY
(1) on the first line of an Info Menu Entry or Cross Reference, the
referenced node is displayed;
(2) on the Up, Next, or Previous entries of a Node Header (first
line), the referenced node is displayed;
(3) on the File entry of a Node Header (first line), the Top node
within that file is displayed;
(4) at the end of the current node, the next node is displayed
(this descends subtrees if the function (Info-global-next)
is bound);
(5) anywhere else (e.g. at the end of a line), the current node
is scrolled up a windowful.
ASSIST KEY
(1) on the first line of an Info Menu Entry or Cross Reference, the
referenced node is displayed;
(2) on the Up, Next, or Previous entries of a Node Header (first
line), the last node in the history list is found;
(3) on the File entry of a Node Header (first line), the DIR
root-level node is found;
(4) at the end of the current node, the previous node is displayed
(this returns from subtrees if the function (Info-global-prev)
is bound);
(5) anywhere else (e.g. at the end of a line), the current node
is scrolled down a windowful.
Use {s} within an Info manual to search for any concept that interests you.
101
Appendix E: Smart Key Reference
E.2.29 Smart Key - Email Composers
If pressed within a Hyperbole-supported mail reader (defined by
‘hmail:reader’) or a mail summary (defined by ‘hmail:lister’) buffer:
ACTION KEY
(1) in a msg buffer within the first line of a message or at the
end of a message, the next undeleted message is displayed;
(2) in a msg buffer within the first line of an Info cross
reference, the referent is displayed;
(3) anywhere else within a msg buffer, the window is scrolled up
one windowful;
(4) in a msg summary buffer on a header entry, the message
corresponding to the header is displayed in the msg window;
(5) in a msg summary buffer, on or after the last line, the
messages marked for deletion are expunged.
ASSIST KEY
(1) in a msg buffer within the first line or at the end of a
message, the previous undeleted message is displayed;
(2) in a msg buffer within the first line of an Info cross
reference, the referent is displayed;
(3) anywhere else within a msg buffer, the window is scrolled down
one windowful;
(4) in a msg summary buffer on a header entry, the message
corresponding to the header is marked for deletion;
(5) in a msg summary buffer on or after the last line, all messages
are marked undeleted.
E.2.30 Smart Key - GNUS Newsreader
If pressed within the Gnus newsgroups listing buffer:
ACTION KEY
(1) on a GNUS-GROUP line, that newsgroup is read;
(2) if ‘gnus-topic-mode’ is active, and on a topic line, the topic is
expanded or collapsed as needed;
(3) to the left of any GNUS-GROUP line, within any of the
whitespace, the current group is unsubscribed or resubscribed;
(4) at the end of the GNUS-GROUP buffer after all lines, the
number of waiting messages per group is updated.
ASSIST KEY
(1) on a GNUS-GROUP line, that newsgroup is read;
(2) if ‘gnus-topic-mode’ is active, and on a topic line, the topic is
expanded or collapsed as needed;
(3) to the left of any GNUS-GROUP line, within any of the
whitespace, the user is prompted for a group name to subscribe
or unsubscribe to;
(4) at the end of the GNUS-GROUP buffer after all lines, the
newsreader is quit.
102
Appendix E: Smart Key Reference
If pressed within a Gnus newsreader subject listing buffer:
ACTION KEY
(1) on a GNUS-SUBJECT line, that article is read, marked deleted,
and scrolled forward;
(2) at the end of the GNUS-SUBJECT buffer, the next undeleted
article is read or the next group is entered.
ASSIST KEY
(1) on a GNUS-SUBJECT line, that article is read and scrolled
backward;
(2) at the end of the GNUS-SUBJECT buffer, the group is exited and
the user is returned to the group listing buffer.
If pressed within a Gnus newsreader article buffer:
ACTION KEY
(1) on the first line or at the end of an article, the next unread
message is displayed;
(2) on the first line of an Info cross reference, the referent is
displayed;
(3) anywhere else, the window is scrolled up a windowful.
ASSIST KEY
(1) on the first line or end of an article, the previous message is
displayed;
(2) on the first line of an Info cross reference, the referent is
displayed;
(3) anywhere else, the window is scrolled down a windowful.
E.2.31 Smart Key - Buffer Menus
If pressed within a listing of buffers (Buffer-menu-mode):
ACTION KEY
(1) on the first column of an entry, the selected buffer is marked
for display;
(2) on the second column of an entry, the selected buffer is marked
for saving;
(3) anywhere else within an entry line, all saves and deletes are
done, and selected buffers are displayed, including the one
just clicked on (if in the OO-Browser, only the selected buffer
is displayed);
(4) on or after the last line in the buffer, all saves and deletes
are done.
ASSIST KEY
(1) on the first or second column of an entry, the selected buffer
is unmarked for display and for saving or deletion;
(2) anywhere else within an entry line, the selected buffer is
marked for deletion;
(3) on or after the last line in the buffer, all display, save, and
delete marks on all entries are undone.
103
Appendix E: Smart Key Reference
If pressed within an interactive buffer menu (ibuffer-mode):
ACTION KEY
(1) on the first or second column of an entry, the selected buffer is
marked for display;
(2) anywhere else within an entry line, all saves and deletes are done, and
selected buffers are displayed, including the one just clicked on (if
within the OO-Browser user interface, only the selected buffer is
displayed);
(3) on the first or last line in the buffer, all deletes are done.
ASSIST KEY
(1) on the first or second column of an entry, the selected buffer is unmarked
for display or deletion;
(2) anywhere else within an entry line, the selected buffer is marked for
deletion;
(3) on the first or last line in the buffer, all display, save, and delete
marks on all entries are undone.
E.2.32 Smart Key - Tar File Mode
If pressed within a tar-mode buffer:
ACTION KEY
(1) on an entry line, the selected file/directory is displayed for
editing in the other window;
(2) on or after the last line in the buffer, if any deletes are to
be performed, they are executed after user verification;
otherwise, this tar file browser is quit.
ASSIST KEY
(1) on an entry line, the current entry is marked for deletion;
(2) on or after the last line in the buffer, all delete marks on
all entries are undone.
E.2.33 Smart Key - Man Pages
If pressed on a cross reference within a man page entry section labeled
NAME, SEE ALSO, or PACKAGES USED, or within a man page C routine
specification (see ‘smart-man-c-routine-ref’) and the man page buffer
has either an attached file or else a man-path local variable
containing its pathname:
ACTION KEY or ASSIST KEY
Displays the man page or source code for the cross reference.
E.2.34 Smart Key - WWW URLs
If pressed on a World-Wide Web universal resource locator (URL):
ACTION KEY
Displays the referent for the URL at point.
ASSIST KEY
Displays help for the ACTION KEY.
104
Appendix E: Smart Key Reference
E.2.35 Smart Key - Rolo Match Buffers
If pressed within an entry in the Rolo search results buffer:
ACTION KEY or ASSIST KEY
The entry is edited in the other window.
E.2.36 Smart Key - Gomoku Game
If pressed within a Gomoku game buffer:
ACTION KEY
Makes a move to the selected space.
ASSIST KEY
Takes back a prior move made at the selected space.
E.2.37 Smart Key - The OO-Browser
If pressed within an OO-Browser implementors, elements or OOBR-FTR tags
buffer after an OO-Browser Environment has been loaded:
ACTION KEY
Jumps to the definition of the item at point.
ASSIST KEY
Displays help for the Action Key context at point.
When pressed within an OO-Browser listing window:
ACTION KEY
(1) in a blank buffer or at the end of a buffer, browser help
information is displayed in the viewer window;
(2) on a default class name, the statically defined instances of
the default class are listed;
(3) at the beginning of a (non-single char) class name, the class’
ancestors are listed;
(4) at the end of an entry line, the listing is scrolled up;
(5) on the ‘...’, following a class name, point is moved to the
class descendency expansion;
(6) before an element entry, the element’s implementors are
listed;
(7) anywhere else on an entry line, the source is displayed for
editing.
105
Appendix E: Smart Key Reference
ASSIST KEY
(1) in a blank buffer, a selection list of buffer files is
displayed;
(2) on a default class name, the statically defined instances of
the default class are listed;
(3) at the beginning of a (non-single char) entry, the class’
descendants are listed;
(4) at the end of an entry line, the listing is scrolled down;
(5) on the ‘...’, following a class name, point is moved to the
class expansion;
(6) anywhere else on a class entry line, the class’ elements are
listed;
(7) anywhere else on an element line, the element’s implementors
are listed;
(8) on a blank line following all entries, the current listing
buffer is exited.
When pressed within the OO-Browser Command Help Menu Buffer:
ACTION KEY
Executes an OO-Browser command whose key binding is at point.
ASSIST KEY
Displays help for an OO-Browser command whose key binding is at
point.
When pressed on an identifier within an OO-Browser source file:
ACTION KEY
Tries to display the identifier definition.
ASSIST KEY
Does nothing.
E.2.38 Smart Key - Default Context
Finally, if pressed within an unrecognized context:
ACTION KEY
Runs the function stored in action-key-default-function.
By default, it just displays an error message. Set it to
hyperbole if you want it to display the Hyperbole
minibuffer menu or hyperbole-popup-menu to popup the
Hyperbole menubar menu.
ASSIST KEY
Runs the function stored in assist-key-default-function.
By default, it just displays an error message. Set it to
hkey-summarize if you want it to display a summary of
Smart Key behavior.
106
107
Appendix F Suggestion or Bug Reporting
If you find any errors in Hyperbole’s operation or documentation, feel free to report them
to <[email protected]>. Be sure to use the {C-h h m r} Msg/Report-Hypb-Bug minibuffer menu item whenever you send a message to this address since that command will
insert important system version information for you.
If you use Hyperbole mail or news support (see Section 2.7.6 [Buttons in Mail], page 20),
a press of your Action Key on the Hyperbole mail list address will insert a description of
your Hyperbole configuration information into your outgoing message, so that you do not
have to type it. Otherwise, be sure to include the version numbers of your editor, Hyperbole
and your window system. Your Hyperbole version number can be found in the top-level
Hyperbole menu.
Below are some tips on how best to structure requests and discussion messages. If you
share information about your use of Hyperbole with others, it will promote broader use and
development of Hyperbole.
• Always use your Subject lines to state the position that your message takes on the
topic that it addresses.
For example, write: “Subject: Typo in top-level Hyperbole minibuffer menu.”
rather than: “Subject: Hyperbole bug”
• Statements end with periods, questions with question marks (typically), and high energy, high impact declarations with exclamation points. These simple rules make all
e-mail communication much easier for recipients to handle appropriately.
• Question messages should normally include your Hyperbole and Emacs version numbers and should clearly explain your problem and surrounding issues. Otherwise, it is
difficult for anyone to answer your question. (Your top-level Hyperbole menu shows its
version number and {M-x emacs-version RET} gives the other.)
• If you ask questions, you should consider adding to the discussion by telling people the
kinds of work you are doing or contemplating doing with Hyperbole. In this way, the
list is not overrun by messages that ask for, but provide no information.
If you have suggestions on how to improve Hyperbole, send them to <[email protected]> ({C-h h m c} minibuffer menu item Msg/Compose-Hypb-Mail). Here are
some issues you might address:
• What did you like and dislike about the system?
• What kinds of tasks, if any, does it seem to help you with?
• What did you think of the Emacs-based user interface?
• How was the Hyperbole Manual and other documentation?
• Was the setup trivial, average or hard?
• What areas of Hyperbole would you like to see expanded/added?
• How does it compare to other hypertext tools you have used?
• Was it easy or difficult to create your own types? Why?
• Did you get any use out of the external system encapsulations?
108
Appendix G Questions and Answers
1. As I discover the Zen of Hyperbole, will I become so enamored of its power that I lose
all control of my physical faculties?
This other-worldly reaction is of course an individual matter. Some people have canceled meditation trips to the Far East after discovering that pressing the Action Key
in random contexts serves a similar purpose much more cheaply. We have not seen
anyone’s mind turn to jelly but with the thinking Hyperbole saves you, you might just
grow a second one. Eventually, you will be at peace and will understand that there is
no adequate description of Hyperbole.
Ok, joking aside, now that we have your attention, here are some serious questions and
answers.
2. Isn’t Org mode the same as Hyperbole?
No, they offer very different capabilities when you compare them a bit more deeply.
In fact, it makes sense to use them together and they are highly compatible. The only
overlap we see is that Org mode has a more limited kind of hyperlinks and offers some
BBDB integration as Hyperbole does.
Initial Smart Key support for Org mode is already in Hyperbole and more will come.
For a list of some differences, see: https://www.emacswiki.org/emacs/Hyperbole.
Org-mode offers traditional Emacs outlining, todo list management, agenda and diary
management, so it is very complementary to Hyperbole. It did not exist when Hyperbole was first developed. Today it is just a matter of having time and resources to
devote to finding ways to integrate the two. We would like to see this happen. If you
would like to see it, offer time or money to help make it happen.
3. How can I change the Smart Mouse Key bindings?
Since the Smart Mouse Keys are set up for use under many different Emacs configurations, there is no easy way to provide user level customization. Any mouse key binding
changes require editing the (hmouse-setup) and (hmouse-get-bindings) functions
in the hmouse-sh.el file.
To make the Smart Keys do new things in particular contexts, define new types of
implicit buttons, see Section 2.3 [Implicit Buttons], page 9.
The hkey-alist and hmouse-alist variables in hui-mouse.el and hui-window.el
must be altered if you want to change what the Smart Keys do in standard contexts. You should then update the Smart Key summary documentation in the file,
man/hkey-help.txt, and then regenerate the readable forms of this manual which
includes that file.
4. What if I get mail with a Hyperbole button type I don’t have?
Or what if someone sends a mail message with a button whose link referent I can’t
access?
You receive an error that an action type is not defined or a link referent is not accessible/readable if you try to use the button. This is hardly different than trying to get
through a locked door without a key; you try the doorknob, find that it is locked, and
then realize that you need to take a different approach or else give up.
109
Like all communication, people need to coordinate, which usually requires an iterative
process. If you get a mail message with a button for which you don’t have the action
type, you mail the sender and request it.
5. How can I modify a number of global buttons in succession?
Rather than typing the name for each, it is quicker to jump to the global button
file and edit the buttons there as you would any explicit buttons. By default, the
ButFile/PersonalFile menu item takes you to the file where global buttons are saved
at the end of the file.
6. Why are button attributes scattered across directories?
When you think of a hyper-space that you depend on every day, you don’t want to have
a single point of failure that can make you incapable of doing work. With Hyperbole,
if some directories become unavailable for a particular time (e.g. the filesystems on
which they reside are dismounted) you can still work elsewhere with minimal effect.
We believe this to be a compelling factor to leave the design with distributed button
attribute storage.
This design also permits the potential addition of buttons to read-only media.
7. Why are action types defined apart from implicit button types?
Any category of button can make use of an action type. Some action types are useful
as behavior definitions for a variety of button categories, so all action types are defined
separately to give them independence from those types which apply them.
For implicit button types that require a lot of code, it is useful to add a module that
includes the implicit button type definition, its action type definition and supporting
code. Then simply load that module into your Emacs session.
110
Appendix H Future Work
This appendix is included for a number of reasons:
• to better allow you to assess whether to work with Hyperbole by providing sketches of
possible additions;
• to direct further development effort towards known needs;
• and to acknowledge known weaknesses in the current system.
If you would like to see some of this work done, consider funding its development.
Without any serious interest from users, progress on these fronts will be slow. Here are
some new features we have in mind, however.
Button Copying, Killing, and Yanking
There is as yet no means of transferring explicit buttons among buffers. We
realize this is a critical need. Users should be able to manipulate text with
embedded buttons in ordinary ways. With this feature, Hyperbole would store
the button attributes as text properties within the buffers so that if a button
is copied, its attributes follow. When a buffer is saved, the attributes also will
be saved.
Koutliner View Mode
This will complement the Koutliner editing mode by using simple one character
keys that normally insert characters to instead modify the view of a Koutline
and to move around in it, for ease of study. Switching between view and edit
modes will also be simple.
Trails
Trails are an extension to the basic history mechanism presently offered by
Hyperbole. Trails will allow a user to capture, edit and store a specific sequence
and set of views of information for later replay by other users. Conditional
branching may also be supported.
Storage of button data within button source files
The current design choice of storing buttons external to the source file was made
under the assumption that people should be able to look at files that contain
Hyperbole buttons with any standard editor or tool and not be bothered by
the ugly button data (since they won’t be able to utilize the buttons anyway,
they don’t need to see or have access to them).
In many contexts, embedding the button data within the source files may be a
better choice, so a provision which would allow selection of either configuration
may be added. Here are some of the PROs and CONs of both design choices:
111
POSITIVE
Button data in source file
Documents can stand alone.
Normal file operations apply.
Simplifies creation and
facility expansion for
structured and multimedia
files.
Button data external to source file
Files can be displayed and
printed exactly as they look.
No special display formatting
is necessary.
NEGATIVE
All edit operators have
to account for file
structure and hide
internal components.
Currently, attributes for
a whole directory are
locked when any button
entry is locked.
Button-based searches and
database-type lookup operations
need only search one file
per directory.
Forms-based Interfaces
This will allow one to create buttons more flexibly. For example, button attributes could be given in any order. Entry of long code sequences, quick note
taking and cross-referencing would also be made easier.
Collaboration Support
From the early stages of Hyperbole design, collaborative work environments
have been considered. A simple facility has demonstrated broadcast of button
activations to a number of workstations on a local area network, so that one
user can lead others around an information space, as during an online design
review. (This facility was never adapted to the current Hyperbole release,
however). Nowadays you could just use a screen sharing program.
112
Appendix I References
[AkMcYo88]
Akscyn, R. M., D. L. McCracken and E. A. Yoder. KMS: A Distributed Hypermedia System for Managing Knowledge in Organizations. Communications
of the ACM, Vol. 31, No. 7, July 1988, pp. 820-835.
[Bro87]
Brown, P. J. Turning Ideas into Products: The Guide System. Proceedings of
Hypertext ’87, November 13-15, 1987, Chapel Hill, NC. ACM: NY, NY, pp.
33-40.
[Con87]
Conklin, Jeff. Hypertext: An Introduction and Survey. IEEE Computer, Vol.
20, No. 9, September 1987, pp. 17-41.
[Eng68]
Engelbart, D., and W. English. A research center for augmenting human intellect. Proceedings of the Fall Joint Computer Conference, 33, 1, AFIPS Press:
Montvale, NJ, 1968, pp. 395-410.
[Eng84a]
Engelbart, D. C. Authorship Provisions in Augment. Proceedings of the 1984
COMPCON Conference (COMPCON ’84 Digest), February 27-March 1, 1984,
San Francisco, CA. IEEE Computer Society Press, Spring, 1984. 465-472.
(OAD,2250,)
[Eng84b]
Engelbart, D. C. Collaboration Support Provisions in Augment. Proceedings of
the AFIPS Office Automation Conference (OAC ’84 Digest), February, 1984,
Los Angeles, CA, 1984. 51-58. (OAD,2221,)
[Fos88]
Foss, C. L. Effective Browsing in Hypertext Systems. Proceedings of the Conference on User-Oriented Content-Based Text and Image Handling (RIAO 88),
March 21-24, MIT, Cambridge MA. Centre de Hautes Etudes Internationales
d’Informatique Documentaire, 1988, pp. 82-98.
[GaSmMe86]
Garrett, N., K. E. Smith and N. Meyrowitz. Intermedia: Issues, Strategies, and
Tactics in the Design of a Hypermedia Document System. Computer-Supported
Cooperative Work (CSCW ’86) Proceedings, December 3-5, Austin, TX, 1986,
pp. 163-174.
[HaMoTr87]
Halasz, F. G., T. P. Moran and R. H. Trigg. NoteCards in a Nutshell. Proceedings of the CHI and GI ’87 Conference on Human Factors in Computing
Systems, Toronto, J. M. Carroll and P. P. Tanner, (editors), ACM: NY, NY,
April 1987, pp. 45-52.
[Har88]
Harvey, G. Understanding HyperCard. Alameda, CA: SYBEX, Inc., 1988.
[KaKaBeLaDr90]
Kaplan, S. J., M. D. Kapor, E. J. Belove, R. A. Landsman, and T. R. Drake.
AGENDA: A personal Information Manager. Communications of the ACM,
No. 33, July 1990, pp. 105-116.
[Nel87a]
Nelson, T. H. Computer Lib/Dream Machines. MicroSoft Press, Redmond,
WA, 1987.
113
[Nel87b]
Nelson, T. H. Literary Machines, Edition 87.1. Available from the Distributors,
702 South Michigan, South Bend, IN 46618, 1987.
[NoDr86]
Norman, D. A. and S. W. Draper, editors. User Centered System Design.
Lawrence Erlbaum Associates: Hillsdale, New Jersey, 1986.
[Shn82]
Shneiderman, B. The future of interactive systems and the emergence of direct
manipulation. Behavior and Information Technology, Vol. 1, 1982, pp. 237256.
[Sta87]
Stallman, R. GNU Emacs Manual. Free Software Foundation, Cambridge: MA,
March 1987.
[Tri86]
Trigg, R., L. Suchman, and F. Halasz. Supporting collaboration in NoteCards.
Proceedings of the CSCW ’86 Conference, Austin, TX, December 1986, pp.
147-153.
[TrMoHa87]
Trigg, R. H., T. P. Moran and F. G. Halasz. Adaptability and Tailorability in NoteCards. Proceedings of INTERACT ’87, Stuttgart, West Germany,
September 1987.
[Wei92]
Weiner, B. PIEmail: A Personalized Information Environment Mail Tool. Department of Computer Science Masters Project, Brown University: Providence,
RI, May 10, 1992.
[YaHaMeDr88]
Yankelovich, N., B. J. Haan, N. Meyrowitz and S. M. Drucker. Intermedia: The
Concept and the Construction of a Seamless Information Environment. IEEE
Computer, Vol. 21, No. 1, January 1988, pp. 81-96.
[YoAkMc89]
Yoder, E. A., R. M. Akscyn and D. L. McCracken. Collaboration in KMS,
A Shared Hypermedia System. Proceedings of the 1989 ACM Conference on
Human Factors in Computer Systems (CHI ’89), April 30-May 4, 1989, Austin,
TX, ACM: NY,NY, 1989, pp. 37-42.
114
Key Index
%
A
% . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Action
Action
Action
Action
Action
Assist
Assist
(
( . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
)
Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Key, cell argument . . . . . . . . . . . . . . . . . . . .
Key, hide or show cell . . . . . . . . . . . . . . . .
Key, klink . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Key, web browsing . . . . . . . . . . . . . . . . . . . . .
Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Key, listing attributes . . . . . . . . . . . . . .
22
41
44
45
10
22
46
B
) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
b . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34, 52
+
C
+ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
c ..............................................
C-c $ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c + . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c , . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26, 42,
C-c / . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31,
C-c < . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c @ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c ^ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c \ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c \ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c b . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-b . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-f . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-k . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-l . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-m . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-o . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-p . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-r . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19,
C-c C-s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-u . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-v . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c C-y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46,
C-c k . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c l . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-c m . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
,
, or > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
–
- . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
.
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
. or < . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
=
= . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
[
[ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
]
] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
~
~ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
0
0-9 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
33
42
43
42
75
75
42
42
41
42
33
75
40
45
41
44
42
41
42
42
44
46
40
39
41
42
44
42
75
44
44
42
45
20
42
75
40
45
41
Key Index
115
C-c M-c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
C-c M-j . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
C-c M-l . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
C-c M-q . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
C-c p . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
C-c RET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26, 75
C-c s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
C-c t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22, 42
C-g . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
C-h A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25, 75
C-h h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29, 75
C-h h c a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
C-h h c d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
C-h h c w . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
C-h h d d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
C-h h d i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
C-h h f w . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72, 75
C-h h g . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
C-h h i a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
C-h h k e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
C-h h m c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
C-h h m r . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
C-h h s f . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
C-h h s w . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
C-h t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
C-j . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
C-M-h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
C-M-j . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
C-M-q . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
C-M-x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
C-t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
C-u c-j . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
C-u C-c c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
C-u C-c C-c. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
C-u C-c C-m. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
C-u C-c h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
C-u C-c k . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
C-u C-c m . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
C-u C-c M-l. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
C-u C-c s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
C-u C-h A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25, 75
C-u C-x i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
C-u M-o . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
C-u M-RET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22, 75
C-x $ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
C-x C-e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
C-x i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
C-x m . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
C-x o . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
C-y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
f . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34, 52
H
h ..............................................
H ..............................................
HyControl, see screen . . . . . . . . . . . . . . . . . . . . . . . .
HyRolo, see rolo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
33
33
33
51
I
i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
J
j . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
K
k . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
keypad number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
L
left . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
M
m ..............................................
M-0 C-c t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M-1 TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M-b . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M-f . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M-j . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M-o . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18,
M-q . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M-RET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22, 44,
M-TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M-x kotl-mode:show-subtree . . . . . . . . . . . . . . . . . .
middle mouse key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
34
42
41
30
30
42
75
42
75
40
44
22
N
n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33, 52
O
o . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
D
d ..............................................
down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
D ..............................................
DEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
F
34
33
34
52
P
p . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Key Index
116
Q
q . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
q or ESC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
R
right . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
rolo, , . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, < . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, b . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, C-r . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, C-s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, DEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, f . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, l . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, M-s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, M-TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, o . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, p . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, q . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, r . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, SHIFT-TAB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, SPC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, u . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
T
t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30, 40
U
u . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35, 52
up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
W
S
s ..............................................
screen, % . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, ( . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, + . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, - . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, = . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, [ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, ] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, ~ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, 0-9 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, b . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, C-c \ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, C-h h s f . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, C-h h s w . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, ESC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, f . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, j . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, k . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
screen, keypad number . . . . . . . . . . . . . . . . . . . . . . . .
screen, left . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
screen, m . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
screen, n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
screen, o . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
screen, O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
screen, q . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
screen, right . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
screen, s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
screen, t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
screen, u . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
screen, up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
screen, w . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
screen, W . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
screen, z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
screen, Z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Shift-. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
shift-left mouse key . . . . . . . . . . . . . . . . . . . . . . . . . 22
shift-middle mouse key . . . . . . . . . . . . . . . . . . . . . . . 22
shift-right mouse key . . . . . . . . . . . . . . . . . . . . . . . . 22
SPC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
33
33
34
34
34
34
33
34
34
34
35
33
34
33
33
33
33
34
33
34
35
34
33
33
34
34
34
34
w . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
W . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Z
z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
117
Function, Variable and File Index
A
C
action-key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
action-key-default-function . . . . . . . . . . . . . . . . 24, 106
action-key-eol-function . . . . . . . . . . . . . . . . . . . . . . . . . 90
action-key-minibuffer-function . . . . . . . . . . . . . . . . . . 85
action-key-modeline. . . . . . . . . . . . . . . . . . . . . . . . . . 25
action-key-modeline-function . . . . . . . . . . . . . . . 25, 87
action-mouse-key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
actype:create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
actype:delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
actypes annot-bib . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
actypes completion . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
actypes eval-elisp . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
actypes exec-kbd-macro. . . . . . . . . . . . . . . . . . . . . . . 14
actypes exec-shell-cmd. . . . . . . . . . . . . . . . . . . . . . . 14
actypes exec-window-cmd . . . . . . . . . . . . . . . . . . . . . 14
actypes function-in-buffer . . . . . . . . . . . . . . . . . . 14
actypes hyp-config . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
actypes hyp-request . . . . . . . . . . . . . . . . . . . . . . . . . . 14
actypes hyp-source . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
actypes kbd-key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
actypes link-to-buffer-tmp . . . . . . . . . . . . . . . . . . 14
actypes link-to-directory . . . . . . . . . . . . . . . . . . . 15
actypes link-to-doc . . . . . . . . . . . . . . . . . . . . . . . . . . 15
actypes link-to-ebut . . . . . . . . . . . . . . . . . . . . . . . . . 15
actypes link-to-elisp-doc . . . . . . . . . . . . . . . . . . . 15
actypes link-to-file . . . . . . . . . . . . . . . . . . . . . . . . . 15
actypes link-to-file-line . . . . . . . . . . . . . . . . . . . 15
actypes link-to-Info-index-item . . . . . . . . . . . . 15
actypes link-to-Info-node . . . . . . . . . . . . . . . . . . . 15
actypes link-to-kcell . . . . . . . . . . . . . . . . . . . . . . . . 15
actypes link-to-kotl . . . . . . . . . . . . . . . . . . . . . . . . . 15
actypes link-to-mail . . . . . . . . . . . . . . . . . . . . . . . . . 15
actypes link-to-regexp-match . . . . . . . . . . . . . . . . 15
actypes link-to-rfc . . . . . . . . . . . . . . . . . . . . . . . . . . 16
actypes link-to-string-match . . . . . . . . . . . . . . . . 16
actypes link-to-texinfo-node . . . . . . . . . . . . . . . . 16
actypes link-to-web-search . . . . . . . . . . . . . . . . . . 16
actypes man-show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
actypes rfc-toc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
actypes text-toc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
actypes www-url. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
add-hook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
assist-key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
assist-key-default-function . . . . . . . . . . . . . . . . . 24, 106
assist-key-eol-function . . . . . . . . . . . . . . . . . . . . . . . . . . 90
assist-key-minibuffer-function . . . . . . . . . . . . . . . . . . 85
assist-key-modeline. . . . . . . . . . . . . . . . . . . . . . . . . . 25
assist-key-modeline-function . . . . . . . . . . . . . . . . 25, 87
assist-mouse-key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
c++-cpp-include-path . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
c++-include-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
class, ebut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60, 61
class, hargs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
class, hattr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
class, hbdata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
class, hbut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59, 60
class, htype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
customize-browse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
customize-variable . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
B
browse-url-browser-function . . . . . . . . . . . . . 10, 13, 16
D
defact. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
defib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
dir, ~/.hyperb. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
dired-jump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
E
ebut:create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
ebut:map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
ebut:max-len . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
emacs-version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
eval-defun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
eval-last-sexp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
F
file,
file,
file,
file,
file,
file,
file,
file,
file,
file,
file,
file,
file,
file,
file,
file,
file,
file,
file,
file,
file,
file,
file,
file,
.emacs . . . . . . . . . . . . . . . . . . . . . . 19, 21, 22, 39, 75
.hypb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
.kotl suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
DEMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
DIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
EXAMPLE.kotl . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
func-menu.el . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
hactypes.el . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57, 58
hbut.el . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58, 61
hib-debbugs.el . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
hib-kbd.el . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
hibtypes.el . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9, 57
hmail.el . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
hmouse-key.el. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
hmouse-sh.el . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
hsettings.el . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
hsys-* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
hui-ep*.el . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
hui-window.el. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
HYPB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
hyperbole.el . . . . . . . . . . . . . . . . . . . . . . . . 19, 21, 29
hywconfig.el . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
man/hyperbole.html . . . . . . . . . . . . . . . . . . . . . . . 70
man/hyperbole.info . . . . . . . . . . . . . . . . . . . . . . . . 70
Function, Variable and File Index
file, man/hyperbole.pdf . . . . . . . . . . . . . . . . . . . . . . . . 70
file, man/hyperbole.texi . . . . . . . . . . . . . . . . . . . . . . . . 70
file, MANIFEST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
fill-column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
fill-prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
find-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
G
gbut:file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
H
hbmap:dir-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
hbmap:filename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
hbut:current. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56, 60
hbut:fill-prefix-regexps . . . . . . . . . . . . . . . . . . . . . . . . . 60
hbut:label-to-key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
hibtypes-social-default-service . . . . . . . . . . . . . . . . . . 12
hkey-alist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
hkey-always-display-menu . . . . . . . . . . . . . . . . . . . . . . 90
hkey-init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
hkey-init-override-local-keys . . . . . . . . . . . . . . . . . . . . 76
hkey-operate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
hkey-summarize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
hkey-toggle-bindings . . . . . . . . . . . . . . . . . . . . . . . . 75
hmail:lister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
hmail:reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
hmouse-alist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
hmouse-context-ibuffer-menu . . . . . . . . . . . . . . . . 25
hmouse-context-menu. . . . . . . . . . . . . . . . . . . . . . . . . . 25
hmouse-get-bindings . . . . . . . . . . . . . . . . . . . . . . . . 108
hmouse-middle-flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
hmouse-mod-mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
hmouse-setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
hmouse-toggle-bindings . . . . . . . . . . . . . . . . . . . . . . 22
hmouse-x-diagonal-sensitivity . . . . . . . . . . . . . . . . . . 88
hmouse-x-drag-sensitivity . . . . . . . . . . . . . . . . . . . . . . 88
hmouse-y-diagonal-sensitivity . . . . . . . . . . . . . . . . . . 88
hmouse-y-drag-sensitivity . . . . . . . . . . . . . . . . . . . . . . 88
hpath:at-p . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
hpath:external-display-alist-macos . . . . . . . . . . . . . . 73
hpath:external-display-alist-mswindows . . . . . . . . . 73
hpath:external-display-alist-x . . . . . . . . . . . . . . . . . . . 73
hpath:find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
hpath:find-file-urls-mode . . . . . . . . . . . . . . . . . . . 72
hpath:get-external-display-alist . . . . . . . . . . . 73
hpath:internal-display-alist . . . . . . . . . . . . . . . . . . . . . 72
hpath:suffixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
hpath:variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
hproperty:but-create . . . . . . . . . . . . . . . . . . . . . . . . 74
hproperty:but-emphasize-p . . . . . . . . . . . . . . . . . . . . . 74
hproperty:cycle-but-color . . . . . . . . . . . . . . . . . . . 74
hui-menu-screen-commands . . . . . . . . . . . . . . . . . . . . 25
hui-select-goto-matching-tag . . . . . . . . . . . . . . . 26
hui-select-thing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
hui-select-thing-with-mouse . . . . . . . . . . . . . . . . 26
hui:ebut-delete-confirm-p . . . . . . . . . . . . . . . . . . . . . . . 19
118
hui:ebut-prompt-for-action . . . . . . . . . . . . . . . . . . . . . 16
hui:ebut-rename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
hycontrol-frame-offset . . . . . . . . . . . . . . . . . . . . . . 34, 35
hycontrol-get-screen-offsets . . . . . . . . . . . . . . . 35
hycontrol-screen-offset-alist . . . . . . . . . . . . . . . . . . . . . 35
hycontrol-set-screen-offsets . . . . . . . . . . . . . . . 35
hypb:rgrep-command. . . . . . . . . . . . . . . . . . . . . . . . . . . 31
hyperb:dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
hyperbole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69, 106
hyperbole-popup-menu . . . . . . . . . . . . . . . . . . . . . . . 106
hyperbole-web-search-alist . . . . . . . . . . . . . . . . . . . . . 72
hyperbole-web-search-browser-function . . . . . . . . . 31
hyrolo-add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
hyrolo-add-hook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
hyrolo-display-matches . . . . . . . . . . . . . . . . . . . . . . 50
hyrolo-edit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
hyrolo-edit-hook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
hyrolo-fgrep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
hyrolo-file-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
hyrolo-grep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
hyrolo-kill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
hyrolo-mail-to . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
hyrolo-sort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
hyrolo-word . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
hyrolo-yank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
hywconfig-add-by-name . . . . . . . . . . . . . . . . . . . . . . . 54
hywconfig-delete-by-name . . . . . . . . . . . . . . . . . . . . 54
hywconfig-delete-pop . . . . . . . . . . . . . . . . . . . . . 54, 55
hywconfig-restore-by-name . . . . . . . . . . . . . . . . . . . 54
hywconfig-ring-max . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
hywconfig-ring-save. . . . . . . . . . . . . . . . . . . . . . . . . . 54
hywconfig-yank-pop . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
I
ibtype:create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
ibtype:delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
ibtypes annot-bib . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ibtypes completion . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
ibtypes cscope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ibtypes ctags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ibtypes debbugs-gnu-mode . . . . . . . . . . . . . . . . . . . . 11
ibtypes debbugs-gnu-query . . . . . . . . . . . . . . . . . . . 12
ibtypes debugger-source . . . . . . . . . . . . . . . . . . . . . 10
ibtypes dir-summary . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ibtypes doc-id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ibtypes elisp-compiler-msg . . . . . . . . . . . . . . . . . . 10
ibtypes etags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ibtypes function-in-buffer . . . . . . . . . . . . . . . . . . 12
ibtypes gnus-push-button . . . . . . . . . . . . . . . . . . . . 10
ibtypes grep-msg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ibtypes hyp-address . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
ibtypes hyp-source . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
ibtypes id-cflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ibtypes Info-node . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ibtypes kbd-key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ibtypes klink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ibtypes mail-address . . . . . . . . . . . . . . . . . . . . . . . . . 10
Function, Variable and File Index
ibtypes man-apropos . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ibtypes markdown-internal-link . . . . . . . . . . . . . 11
ibtypes org-mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ibtypes patch-msg . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ibtypes pathname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
ibtypes pathname-line-and-column . . . . . . . . . . . 12
ibtypes rfc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ibtypes rfc-toc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ibtypes social-reference . . . . . . . . . . . . . . . . . . . . 12
ibtypes texinfo-ref . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ibtypes text-toc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ibtypes www-url. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ibut:at-p . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Info-directory-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Info-global-next . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Info-global-prev . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
interactive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
K
kcell:ref-to-id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
kexport:html . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
kfile:find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
kfile:write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
kill-ring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
kimport:aug-post-outline . . . . . . . . . . . . . . . . . . . . 43
kimport:file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
kimport:insert-file. . . . . . . . . . . . . . . . . . . . . . . . . . 81
kimport:insert-file-contents . . . . . . . . . . . . . . . 43
kimport:insert-register . . . . . . . . . . . . . . . . . . . . . 81
kimport:mode-alist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
kimport:star-outline . . . . . . . . . . . . . . . . . . . . . . . . 43
kimport:suffix-alist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
kimport:text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
klink:create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37, 77
kotl-mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
kotl-mode:add-cell . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
kotl-mode:add-child. . . . . . . . . . . . . . . . . . . . . . . . . . 77
kotl-mode:add-parent . . . . . . . . . . . . . . . . . . . . . . . . 77
kotl-mode:append-cell . . . . . . . . . . . . . . . . . . . . . . . 77
kotl-mode:back-to-indentation . . . . . . . . . . . . . . 77
kotl-mode:backward-cell . . . . . . . . . . . . . . . . . . . . . 77
kotl-mode:backward-char . . . . . . . . . . . . . . . . . . . . . 77
kotl-mode:backward-kill-word . . . . . . . . . . . . . . . 77
kotl-mode:backward-sentence . . . . . . . . . . . . . . . . 77
kotl-mode:backward-word . . . . . . . . . . . . . . . . . . . . . 77
kotl-mode:beginning-of-buffer . . . . . . . . . . . . . . 77
kotl-mode:beginning-of-cell . . . . . . . . . . . . . . . . 78
kotl-mode:beginning-of-line . . . . . . . . . . . . . . . . 78
kotl-mode:beginning-of-tree . . . . . . . . . . . . . . . . 78
kotl-mode:cell-attributes . . . . . . . . . . . . . . . . . . . 78
kotl-mode:cell-help. . . . . . . . . . . . . . . . . . . . . . . . . . 78
kotl-mode:center-line . . . . . . . . . . . . . . . . . . . . . . . 78
kotl-mode:center-paragraph. . . . . . . . . . . . . . . . . . 78
kotl-mode:copy-after . . . . . . . . . . . . . . . . . . . . . . . . 78
kotl-mode:copy-before . . . . . . . . . . . . . . . . . . . . . . . 78
kotl-mode:copy-to-buffer . . . . . . . . . . . . . . . . . . . . 78
kotl-mode:copy-to-register. . . . . . . . . . . . . . . . . . 78
kotl-mode:delete-backward-char . . . . . . . . . . . . . 78
119
kotl-mode:delete-blank-lines . . . . . . . . . . . . . . . 79
kotl-mode:delete-char . . . . . . . . . . . . . . . . . . . . . . . 79
kotl-mode:delete-indentation . . . . . . . . . . . . . . . 79
kotl-mode:demote-tree . . . . . . . . . . . . . . . . . . . . . . . 79
kotl-mode:down-level . . . . . . . . . . . . . . . . . . . . . . . . 79
kotl-mode:end-of-buffer . . . . . . . . . . . . . . . . . . . . . 79
kotl-mode:end-of-cell . . . . . . . . . . . . . . . . . . . . . . . 79
kotl-mode:end-of-line . . . . . . . . . . . . . . . . . . . . . . . 79
kotl-mode:end-of-tree . . . . . . . . . . . . . . . . . . . . . . . 79
kotl-mode:example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
kotl-mode:exchange-cells . . . . . . . . . . . . . . . . . . . . 79
kotl-mode:fill-cell. . . . . . . . . . . . . . . . . . . . . . . . . . 79
kotl-mode:fill-paragraph . . . . . . . . . . . . . . . . . . . . 79
kotl-mode:fill-tree. . . . . . . . . . . . . . . . . . . . . . . . . . 80
kotl-mode:first-sibling . . . . . . . . . . . . . . . . . . . . . 80
kotl-mode:fkey-backward-char . . . . . . . . . . . . . . . 80
kotl-mode:fkey-forward-char . . . . . . . . . . . . . . . . 80
kotl-mode:fkey-next-line . . . . . . . . . . . . . . . . . . . . 80
kotl-mode:fkey-previous-line . . . . . . . . . . . . . . . 80
kotl-mode:forward-cell . . . . . . . . . . . . . . . . . . . . . . 80
kotl-mode:forward-char . . . . . . . . . . . . . . . . . . . . . . 80
kotl-mode:forward-para . . . . . . . . . . . . . . . . . . . . . . 80
kotl-mode:forward-paragraph . . . . . . . . . . . . . . . . 80
kotl-mode:forward-sentence. . . . . . . . . . . . . . . . . . 80
kotl-mode:forward-word . . . . . . . . . . . . . . . . . . . . . . 80
kotl-mode:goto-cell. . . . . . . . . . . . . . . . . . . . . . . . . . 80
kotl-mode:hide-sublevels . . . . . . . . . . . . . . . . 37, 80
kotl-mode:hide-subtree . . . . . . . . . . . . . . . . . . . . . . 80
kotl-mode:hide-tree . . . . . . . . . . . . . . . . . . . . . . 37, 81
kotl-mode:indent-line . . . . . . . . . . . . . . . . . . . . . . . 81
kotl-mode:indent-region . . . . . . . . . . . . . . . . . . . . . 81
kotl-mode:indent-tabs-mode . . . . . . . . . . . . . . . . . . . . 41
kotl-mode:just-one-space . . . . . . . . . . . . . . . . . . . . 81
kotl-mode:kill-contents . . . . . . . . . . . . . . . . . . . . . 81
kotl-mode:kill-line. . . . . . . . . . . . . . . . . . . . . . . . . . 81
kotl-mode:kill-region . . . . . . . . . . . . . . . . . . . . . . . 81
kotl-mode:kill-ring-save . . . . . . . . . . . . . . . . . . . . 81
kotl-mode:kill-sentence . . . . . . . . . . . . . . . . . . . . . 81
kotl-mode:kill-tree . . . . . . . . . . . . . . . . . . . . . . 37, 81
kotl-mode:kill-word. . . . . . . . . . . . . . . . . . . . . . . . . . 81
kotl-mode:last-sibling . . . . . . . . . . . . . . . . . . . . . . 82
kotl-mode:mail-tree. . . . . . . . . . . . . . . . . . . . . . . . . . 82
kotl-mode:move-after . . . . . . . . . . . . . . . . . . . . . . . . 82
kotl-mode:move-before . . . . . . . . . . . . . . . . . . . . . . . 82
kotl-mode:newline . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
kotl-mode:next-cell. . . . . . . . . . . . . . . . . . . . . . . . . . 82
kotl-mode:next-line. . . . . . . . . . . . . . . . . . . . . . . . . . 82
kotl-mode:open-line. . . . . . . . . . . . . . . . . . . . . . . . . . 82
kotl-mode:overview . . . . . . . . . . . . . . . . . . . . . . . 37, 82
kotl-mode:previous-cell . . . . . . . . . . . . . . . . . . . . . 82
kotl-mode:previous-line . . . . . . . . . . . . . . . . . . . . . 82
kotl-mode:promote-tree . . . . . . . . . . . . . . . . . . . . . . 82
kotl-mode:refill-flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
kotl-mode:scroll-down . . . . . . . . . . . . . . . . . . . . . . . 82
kotl-mode:scroll-up. . . . . . . . . . . . . . . . . . . . . . . . . . 83
kotl-mode:set-cell-attribute . . . . . . . . . . . . . . . 83
kotl-mode:set-fill-prefix . . . . . . . . . . . . . . . . . . . 83
kotl-mode:show-all . . . . . . . . . . . . . . . . . . . . . . . 37, 83
Function, Variable and File Index
kotl-mode:show-subtree . . . . . . . . . . . . . . . . . . . . . . 83
kotl-mode:show-tree . . . . . . . . . . . . . . . . . . . . . . 37, 83
kotl-mode:split-cell . . . . . . . . . . . . . . . . . . . . . . . . 83
kotl-mode:top-cells . . . . . . . . . . . . . . . . . . . . . . 37, 83
kotl-mode:transpose-cells . . . . . . . . . . . . . . . . . . . 83
kotl-mode:transpose-chars . . . . . . . . . . . . . . . . . . . 83
kotl-mode:transpose-lines . . . . . . . . . . . . . . . . . . . 83
kotl-mode:transpose-words . . . . . . . . . . . . . . . . . . . 83
kotl-mode:up-level . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
kotl-mode:yank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
kotl-mode:yank-pop . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
kotl-mode:zap-to-char . . . . . . . . . . . . . . . . . . . . . . . 84
kview:default-label-separator . . . . . . . . . . . . . . . . . . . 39
kview:default-label-type . . . . . . . . . . . . . . . . . . . . . . . . 45
kview:set-label-separator . . . . . . . . . . . . . . . . . . . 84
kview:set-label-type . . . . . . . . . . . . . . . . . . . . . . . . 84
kvspec:activate. . . . . . . . . . . . . . . . . . . . . . . . . . . 37, 84
kvspec:string. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
kvspec:toggle-blank-lines . . . . . . . . . . . . . . . 37, 84
120
R
run-hooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
S
selective-display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
sm-notify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
smail:comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
smart-asm-include-path . . . . . . . . . . . . . . . . . . . . . . . . 95
smart-c-cpp-include-path . . . . . . . . . . . . . . . . . . . . . . . 94
smart-c-include-path . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
smart-c-use-lib-man . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
smart-java-package-path . . . . . . . . . . . . . . . . . . . . . . . 96
smart-man-c-routine-ref . . . . . . . . . . . . . . . . . . . . . . . 104
smart-scroll-proportional . . . . . . . . . . . . . . . . . . . . . . . 90
Z
L
locate-command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
M
mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
mail-yank-original . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
O
objc-cpp-include-path . . . . . . . . . . . . . . . . . . . . . . . . . . 97
objc-include-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
zoom-frm.el . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
121
Concept Index
<
<> delimiters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
<@klink> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
<|viewspec> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
|
| . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
A
abbreviated URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13, 16
Action Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Action Key drag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Action Key drag emulation . . . . . . . . . . . . . . . . . . . . . 18
Action Key, cell argument . . . . . . . . . . . . . . . . . . . . . . 41
Action Key, hide or show cell. . . . . . . . . . . . . . . . . . . 44
Action Key, klink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Action Key, web browsing . . . . . . . . . . . . . . . . . . . . . . 10
Action Mouse Key . . . . . . . . . . . . . . . . . . . . . . . . . 86, 92
action type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
action type, creation . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
activating implicit button . . . . . . . . . . . . . . . . . . . . . . . 9
activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
active region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87, 88
actype, link-to-mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
actypes, list of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
alpha labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Ange-ftp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
anonymous ftp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
appending to a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
argument entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
argument, Info index item . . . . . . . . . . . . . . . . . . . . . . 58
argument, Info node . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
argument, kcell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
argument, klink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
argument, koutline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
argument, mail message . . . . . . . . . . . . . . . . . . . . . . . . 58
argument, reading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
argument, use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
argument, view spec . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85, 92
Assist Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Assist Key, listing attributes . . . . . . . . . . . . . . . . . . . 46
Assist Mouse Key . . . . . . . . . . . . . . . . . . . . . . . . . . 86, 92
attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
attribute, adding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
attribute, modifying . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
attribute, no-fill . . . . . . . . . . . . . . . . . . . . . . . . 42, 43, 46
attribute, removing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Augment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47, 62
Augment outline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
autonumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36, 39
B
BBDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
bibliography . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Big Brother DataBase . . . . . . . . . . . . . . . . . . . . . . . . . 52
blank lines, toggle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
boolean expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
breakpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
browsing URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
browsing URLs in find-file. . . . . . . . . . . . . . . . . . . . . . 72
buffer menu . . . . . . . . . . . . . . . . . . . . . . . . . . . 25, 85, 103
bug tracking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
burying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
button action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
button activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
button attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
button attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
button category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
button click . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
button data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
button data saving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
button demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
button emphasis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
button file, directory . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
button file, HYPB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
button file, personal . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
button files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
button flashing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
button help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
button highlighting . . . . . . . . . . . . . . . . . . . . . . . . . 57, 74
button highlighting, forcing . . . . . . . . . . . . . . . . . . . . 74
button instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
button key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
button label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8, 60
button label overlap. . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
button name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
button precedence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
button, attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
button, creation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
button, deleting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
button, explicit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7, 8
button, global . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7, 8
button, help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
button, implicit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7, 9
button, mailing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
button, modifying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
button, moving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
button, multiple lines . . . . . . . . . . . . . . . . . . . . . . . . . . 60
button, posting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20, 21
button, renaming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Concept Index
button, searching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
button, split across lines . . . . . . . . . . . . . . . . . . . . . . . 60
button, summarizing . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
byte compiler error. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
C
C call tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
C flow graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
C/C++ call trees . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
C/C++ cross-reference . . . . . . . . . . . . . . . . . . . . . . . . . . 11
call tree, C. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
cell, adding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
cell, appending . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
cell, attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
cell, collapse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
cell, creating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
cell, creation time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
cell, exchanging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
cell, expand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
cell, filling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
cell, hide subtree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
cell, hiding levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
cell, idstamp 0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38, 40
cell, killing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
cell, label separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
cell, mark and point . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
cell, no-fill attribute . . . . . . . . . . . . . . . . . . . . 42, 43, 46
cell, selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
cell, show all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
cell, show levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
cell, show subtree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
cell, splitting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
cell, top-level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38, 40
cell, transposing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
cell, yanking contents . . . . . . . . . . . . . . . . . . . . . . . . . . 40
change key bindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
changing the view spec . . . . . . . . . . . . . . . . . . . . . . . . . 45
chord keyboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
click, buffer menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
click, button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
click, dired . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
click, end of line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
click, Gnus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
click, hyrolo matches . . . . . . . . . . . . . . . . . . . . . . . . . . 105
click, ibuffer menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
click, Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
click, tar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
click, world-wide web . . . . . . . . . . . . . . . . . . . . . . . . . 104
code block selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
collaboration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
collapse lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
collapsing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85, 92
compiler error. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
completion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9, 27, 89
configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
122
context-sensitive help . . . . . . . . . . . . . . . . . . . . . . . . . . 24
control key modifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
copy and yank . . . . . . . . . . . . . . . . . . . . . . . . . . 86, 87, 92
copy region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
copying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
create-time attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
creating a link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
creating frames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
creator attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
credits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
cross referencing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
cross-reference, Texinfo . . . . . . . . . . . . . . . . . . . . . . . . 10
Cscope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ctags entry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
customize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
customize, rolo additions . . . . . . . . . . . . . . . . . . . . . . . 52
customize, rolo datestamps . . . . . . . . . . . . . . . . . . . . . 52
customize, rolo edits . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
customizing web search menu . . . . . . . . . . . . . . . . . . 72
cut region. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
cutoff lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
D
database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
datestamps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
dbx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
debugging Smart Keys . . . . . . . . . . . . . . . . . . . . . . . . . 28
default label type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
default Smart Key context . . . . . . . . . . . . . . . . . . . . . 24
definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
delimited things. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
demonstration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
demotion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
depress, modeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
diagonal drag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
digital signature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
direct link creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
direct selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
directory editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
dired . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
dired browsing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
disable global key bindings . . . . . . . . . . . . . . . . . . . . . 75
disable Hyperbole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
disable local key override . . . . . . . . . . . . . . . . . . . . . . . 76
display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
display function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
distributed collaboration . . . . . . . . . . . . . . . . . . . . . . . 47
document identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
double click . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
drag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17, 86, 92
drag, diagonal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
drag, horizontal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
drag, side edge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
drag, vertical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
drag, with region . . . . . . . . . . . . . . . . . . . . . . . . . . . 26, 88
Concept Index
123
E
G
e-mail address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10, 46
EFS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
ellipses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Emacs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3, 29
Emacs Lisp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Emacs Lisp compiler error . . . . . . . . . . . . . . . . . . . . . 10
Emacs Lisp variables . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
emacs outline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Emacs support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
enabling URLs in find-file . . . . . . . . . . . . . . . . . . . . . . 72
end of line click . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Engelbart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47, 62
environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . 74
etags entry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
exchanging cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
expanding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
explicit button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7, 8
explicit button, creation . . . . . . . . . . . . . . . . . . . . 17, 60
explicit button, deleting . . . . . . . . . . . . . . . . . . . . . . . . 19
explicit button, formats . . . . . . . . . . . . . . . . . . . . . . . . 60
explicit button, modifying . . . . . . . . . . . . . . . . . . . . . . 19
explicit button, renaming . . . . . . . . . . . . . . . . . . . . . . 19
explicit button, searching . . . . . . . . . . . . . . . . . . . . . . 20
explicit button, storage . . . . . . . . . . . . . . . . . . . . . . . . 60
explicit button, summarizing . . . . . . . . . . . . . . . . . . . 19
exporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
exporting an outline . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
external klink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
external program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
external viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
extracting from tar files . . . . . . . . . . . . . . . . . . . . . . . 104
game, gomoku . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
gdb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
global button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7, 8, 13
global button, modify . . . . . . . . . . . . . . . . . . . . . . . . . 109
glossary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
GNU Emacs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
GNU Hyperbole. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Gnus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20, 21
Gnus browsing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
GNUS push-buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
gomoku . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
grep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Grep. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
grep files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
groupware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
F
file display function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
file, importing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
filename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
fill prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
filling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
find-file, browsing URLs. . . . . . . . . . . . . . . . . . . . . . . . 72
frame creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
frames control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
ftp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10, 12
func-menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85, 92
function menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
H
hashtag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
help buffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
help, menu items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
help, Smart Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
hide levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
hide lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
hide subtree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
hide tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
hiding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
hiding signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
hook variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
horizontal drag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
HTML conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
HTML tag pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
HyControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Hyperbole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Hyperbole API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Hyperbole applications . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Hyperbole data model . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Hyperbole features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Hyperbole help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Hyperbole mail comment . . . . . . . . . . . . . . . . . . . . . . . 20
Hyperbole mail list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Hyperbole main menu . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Hyperbole manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Hyperbole report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Hyperbole types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Hyperbole version . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Hyperbole, embedding . . . . . . . . . . . . . . . . . . . . . . . . . 61
Hyperbole, obtaining . . . . . . . . . . . . . . . . . . . . . . . . 1, 69
Hyperbole, starting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Hyperbole, system encapsulation . . . . . . . . . . . . . . . 61
hyperlink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
hyperlink anchor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
hypertext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3, 62
HyRolo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
hyrolo commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
hyrolo matches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Concept Index
hyrolo menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
hywconfig commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
I
ibtype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
ibtype, actype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
ibtype, argument. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
ibtype, evaluation order . . . . . . . . . . . . . . . . . . . . . . . . 17
ibtype, help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
ibtype, predicate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
ibtype, return val . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
ibtypes, list of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
ibuffer menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25, 103
idea structuring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
idstamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36, 40
idstamp 0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
idstamp attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
idstamp counter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
implicit button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7, 9
implicit button type . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
implicit button types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
importing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
importing a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
inactive minibuffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Info browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Info browsing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Info manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Info node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
InfoDock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29, 65
InfoDock Action Key . . . . . . . . . . . . . . . . . . . . . . . . . . 22
InfoDock Paste Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
InfoDock, obtaining . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
initialization file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
inserting tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
insertion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
instance number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
interactive cmd char, +I . . . . . . . . . . . . . . . . . . . . . . . . 58
interactive cmd char, +K . . . . . . . . . . . . . . . . . . . . . . . 58
interactive cmd char, +L . . . . . . . . . . . . . . . . . . . . . . . 58
interactive cmd char, +M . . . . . . . . . . . . . . . . . . . . . . . 58
interactive cmd char, +V . . . . . . . . . . . . . . . . . . . . . . . 58
interactive cmd char, +X . . . . . . . . . . . . . . . . . . . . . . . 58
interactive computing . . . . . . . . . . . . . . . . . . . . . . . . . . 62
interactive form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
internal klink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
internal viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Internet RFC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10, 11
invoking Hyperbole . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
isearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
issue tracking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
J
jump menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25, 85
124
K
kcell link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
key binding list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
key binding, C-c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
key binding, C-c \ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
key binding, C-c C-r . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
key binding, C-c RET . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
key binding, C-h A. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
key binding, C-h h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
key binding, C-u C-h A . . . . . . . . . . . . . . . . . . . . . . . . 75
key binding, M-o . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
key binding, M-RET . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
key binding, menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
key binding, smart keys . . . . . . . . . . . . . . . . . . . . . . . . 22
key bindings, toggle . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
key sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
keyboard drag emulation . . . . . . . . . . . . . . . . . . . . . . . 18
kill and yank . . . . . . . . . . . . . . . . . . . . . . . . . . . 86, 87, 92
kill region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
klink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10, 45
klink referent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
klink, activating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
klink, external . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
klink, formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
klink, inserting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
klink, internal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
klink, view spec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
knowledge transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
koutline link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
koutline mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Koutliner commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Koutliner, toggle tab behavior . . . . . . . . . . . . . . . . . . 41
L
label separator, changing . . . . . . . . . . . . . . . . . . . . . . . 39
label separator, default . . . . . . . . . . . . . . . . . . . . . . . . . 39
label type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
label type, alpha . . . . . . . . . . . . . . . . . . . . . . . . . . . 39, 45
label type, changing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
label type, idstamps . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
label type, legal . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39, 45
legal labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44, 45
line and column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
link action types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
link button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
link, creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17, 18
link, display function . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
link, pathname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
link, pathname line and column . . . . . . . . . . . . . . . . 12
link, viewer program . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
link, web search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
linking, in-place . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Lisp variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85, 92
listing attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Concept Index
locate files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
logging Smart Key behavior . . . . . . . . . . . . . . . . . . . . 28
logical rolo searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
M
mail address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
mail comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
mail hooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
mail inclusion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
mail reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
mailcap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
mailer initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
mailing an outline. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
mailing buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
man apropos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
man page references . . . . . . . . . . . . . . . . . . . . . . . . . . 104
man pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
margin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
markdown link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
markup pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85, 92
match lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
menu help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
menu item selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
menu item, Act . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
menu item, Activate-Button-at-Point . . . . . . . . . . . 30
menu item, Back-to-Prior-Location . . . . . . . . . . . . . 31
menu item, Cust/All-Options . . . . . . . . . . . . . . . . . . 71
menu item, Cust/Debug-Toggle . . . . . . . . . . . . . . . . 28
menu item, Cust/Msg-Toggle-Ebuts . . . . . . . . 20, 21
menu item, Doc/SmartKeys . . . . . . . . . . . . . . . . . . . . 22
menu item, Find-File-Accepts-URLs . . . . . . . . . . . . 72
menu item, Find-File-URLs . . . . . . . . . . . . . . . . . . . . 72
menu item, FramesControl . . . . . . . . . . . . . . . . . . . . . 33
menu item, GrepFile . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
menu item, Hist. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
menu item, Ibut/Act . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
menu item, Isearch-Invisible . . . . . . . . . . . . . . . . . . . . 73
menu item, LocateFiles . . . . . . . . . . . . . . . . . . . . . . . . 31
menu item, MatchFileBuffers . . . . . . . . . . . . . . . . . . . 31
menu item, OccurHere . . . . . . . . . . . . . . . . . . . . . . . . . 31
menu item, RegexFind . . . . . . . . . . . . . . . . . . . . . . . . . 50
menu item, Remove-This-Menu . . . . . . . . . . . . . . . . 29
menu item, RemoveLines . . . . . . . . . . . . . . . . . . . . . . . 31
menu item, SaveLines . . . . . . . . . . . . . . . . . . . . . . . . . . 31
menu item, StringFind . . . . . . . . . . . . . . . . . . . . . . . . . 50
menu item, Toggle-Isearch-Invisible. . . . . . . . . . . . . 73
menu item, WindowsControl . . . . . . . . . . . . . . . . . . . 33
menu item, WordFind . . . . . . . . . . . . . . . . . . . . . . . . . . 50
menu prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
menu use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
menu, Butfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
menu, Button-File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
menu, Cust . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30, 71
menu, Cust/Web-Search . . . . . . . . . . . . . . . . . . . . . . . 72
menu, Customize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
menu, Doc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
menu, Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . 30
125
menu, EBut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
menu, Explicit-Button . . . . . . . . . . . . . . . . . . . . . . . . . 30
menu, Find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
menu, Find/Web . . . . . . . . . . . . . . . . . . . . . . . 31, 72, 75
menu, Gbut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9, 31
menu, Global-Button . . . . . . . . . . . . . . . . . . . . . . . . 9, 31
menu, Ibut. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
menu, Implicit-Button . . . . . . . . . . . . . . . . . . . . . . . . . 31
menu, KeyBindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
menu, Kotl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
menu, Koutline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
menu, Mail-Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
menu, Msg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
menu, Outline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36, 37
menu, Outline/Example . . . . . . . . . . . . . . . . . . . . . . . . 36
menu, Outliner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
menu, Rolo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
menu, Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
menu, Toggle-Rolo-Dates . . . . . . . . . . . . . . . . . . . . . . . 52
menu, top-level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30, 85
menu, Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
menu, Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31, 72, 75
menu, WinConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
menu, Window-Configurations . . . . . . . . . . . . . . . . . 32
menubar, Hyperbole menu . . . . . . . . . . . . . . . . . . . . . 29
Messages buffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
meta key modifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
MH-e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
middle mouse key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
MIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
minibuffer menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29, 85
minibuffer menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
minibuffer, buffer menu . . . . . . . . . . . . . . . . . . . . . . . . 85
minibuffer, default actions. . . . . . . . . . . . . . . . . . . . . . 85
minibuffer, jump menu . . . . . . . . . . . . . . . . . . . . . . . . . 85
modeline click and drag . . . . . . . . . . . . . . . . . . . . . . . . 25
modeline depress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
modeline, buffer menu . . . . . . . . . . . . . . . . . . . . . . . . . 25
modeline, Info Browser . . . . . . . . . . . . . . . . . . . . . . . . . 25
modeline, jump menu . . . . . . . . . . . . . . . . . . . . . . . . . . 25
modeline, screen command menu . . . . . . . . . . . . . . . 25
modeline, Smart Keys . . . . . . . . . . . . . . . . . . . . . . . . . . 22
modeline, view spec . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
mouse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
mouse bindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
mouse drag, link creation . . . . . . . . . . . . . . . . . . . . . . 17
mouse key bindings . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
mouse key toggle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
mouse paste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
mouse support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
mouse, moving trees . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
moving buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
multiplier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Concept Index
126
N
P
named window configuration . . . . . . . . . . . . . . . . . . . 54
news . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
news comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
news hooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
news reader/poster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
NLS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
no-fill attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
normalized label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
numeric argument. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
paragraph, filling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Paste Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
paste region. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
pasting a region . . . . . . . . . . . . . . . . . . . . . . . . 86, 87, 92
patch output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
pathname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
pathname, line and column. . . . . . . . . . . . . . . . . . . . . 12
permanent identifier . . . . . . . . . . . . . . . . . . . . . . . . 36, 40
pipe character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
posting buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
posting news . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
programming interface . . . . . . . . . . . . . . . . . . . . . . . . . 61
promotion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
proportional scrolling . . . . . . . . . . . . . . . . . . . . . . . 67, 90
O
object-oriented code browsing . . . . . . . . . . . . . . . . . 105
obtaining Hyperbole . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
online library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
OO-Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
option setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
option settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Org mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13, 108
org-mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
outline file suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
outline mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
outline processor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
outline structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
outline, all cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
outline, attribute list . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
outline, conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
outline, creating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
outline, exporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
outline, exporting from . . . . . . . . . . . . . . . . . . . . . . . . . 44
outline, filling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
outline, foreign file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
outline, hiding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
outline, HTML conversion. . . . . . . . . . . . . . . . . . . . . . 44
outline, importing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
outline, importing into . . . . . . . . . . . . . . . . . . . . . . . . . 43
outline, inserting into . . . . . . . . . . . . . . . . . . . . . . . . . . 43
outline, label separator . . . . . . . . . . . . . . . . . . . . . . . . . 39
outline, label type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
outline, mailing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
outline, motion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
outline, overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
outline, show levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
outline, showing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
outline, top-level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
outline, view specs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
outline, viewing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
outliner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
outliner commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
outliner keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
overriding local keys . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
R
rdb-mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
referent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
refilling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
region selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
region, active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
relative autonumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
relative identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
remote file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
remote path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
remote pathnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
remove lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
removing Hyperbole menu . . . . . . . . . . . . . . . . . . . . . 29
Request For Comment . . . . . . . . . . . . . . . . . . . . . . 10, 11
restoring windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
RFC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10, 11
Rmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Rolo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
rolo address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
rolo commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
rolo entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
rolo file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
rolo keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
rolo searching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
rolo, buttons in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
rolo, datestamps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, editing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, extending a match . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, finding matches . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, highlighting matches . . . . . . . . . . . . . . . . . . 51, 53
rolo, interactive searching . . . . . . . . . . . . . . . . . . . . . . 51
rolo, locating a name . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, moving through matches . . . . . . . . . . . . . . . . . . 51
rolo, moving to entries . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, outlining. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
rolo, personal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
rolo, quitting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
root cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38, 40
Concept Index
127
S
T
save lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
saving window configurations. . . . . . . . . . . . . . . . . . . 54
Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
scrolling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67, 90
search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30, 73
search engines menu . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
searching the web . . . . . . . . . . . . . . . . . . . . . . . . . . 31, 75
searching, rolo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
selection, menu items . . . . . . . . . . . . . . . . . . . . . . . . . . 30
set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85, 92
setting the view spec . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
sexp selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
SGML tag pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
show subtree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
show tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
showing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
side drag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
signatures, hiding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Smart Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22, 67, 108
smart key assignments . . . . . . . . . . . . . . . . . . . . . . . . . 22
smart key commands. . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Smart Key debugging . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Smart Key help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Smart Key operation . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Smart Key summary . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Smart Key, default context . . . . . . . . . . . . . . . . 24, 106
Smart Keyboard Keys . . . . . . . . . . . . . . . . . . . . . . . . . 89
Smart Keys as modifiers . . . . . . . . . . . . . . . . . . . . . . . 27
smart marking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Smart Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Smart Mouse Key . . . . . . . . . . . . . . . . . . . . . . . . . . 86, 92
Smart Mouse Key drag . . . . . . . . . . . . . . . . . . . . . . . . 19
Smart Mouse Key toggle . . . . . . . . . . . . . . . . . . . . . . . 22
Smart Mouse Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
smart selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
social media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
social reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
source line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
splitting a cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
stack frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
star outline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
starting Hyperbole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
storage manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
string . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85, 92
submenus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
submodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
subtree, hide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
subtree, show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
swapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
system encapsulation. . . . . . . . . . . . . . . . . . . . . . . . . . . 61
table of contents . . . . . . . . . . . . . . . . . . . . . . . . . . . 11, 16
tabs, inserting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
tags file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
TAGS file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
tar archive browsing . . . . . . . . . . . . . . . . . . . . . . . . . . 104
terminal use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Texinfo cross-reference . . . . . . . . . . . . . . . . . . . . . . . . . 10
Texinfo manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
text file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
thing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85, 92
things . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
toc action type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
toc implicit button type . . . . . . . . . . . . . . . . . . . . . . . . 11
toggle key bindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
toggling blank lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
top-level cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38, 40
top-level menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
top-level view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Tramp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12, 72
transposing cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
tree, copying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
tree, demoting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
tree, exporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
tree, filling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
tree, hide subtree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
tree, killing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
tree, mailing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
tree, moving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
tree, promoting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
tree, show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
tree, show subtree. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
troubleshooting Smart Keys . . . . . . . . . . . . . . . . . . . . 28
type definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
type redefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17, 57
U
unburying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
UNIX manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10, 16, 104
URLs, abbreviated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
URLs, using with find-file . . . . . . . . . . . . . . . . . . . . . . 72
USENET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20, 21
username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Concept Index
V
variable setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
vector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85, 92
version description . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
vertical drag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
view mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
view spec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
view spec klink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
view spec, all lines and levels . . . . . . . . . . . . . . . . . . . 45
view spec, blank lines . . . . . . . . . . . . . . . . . . . . . . . . . . 45
view spec, changing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
view spec, characters . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
view spec, ellipses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
view spec, example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
view spec, label type . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
view spec, lines per cell . . . . . . . . . . . . . . . . . . . . . . . . 45
view spec, setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
view spec, show levels . . . . . . . . . . . . . . . . . . . . . . . . . . 45
VM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
W
W3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
wconfig commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
web pages, displaying . . . . . . . . . . . . . . . . . . . . . . . . . . 72
web search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
web search link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
web search menu . . . . . . . . . . . . . . . . . . . . . . . . . . . 72, 75
window configuration commands . . . . . . . . . . . . . . . 54
window configuration ring . . . . . . . . . . . . . . . . . . . . . . 54
window configurations . . . . . . . . . . . . . . . . . . . . . . . . . 54
window system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
128
windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
windows control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
word wrap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
world-wide web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
World-wide Web . . . . . . . . . . . . . . . . . . . . . . . . . . . 10, 16
WWW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10, 16
X
xdb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
XEmacs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3, 29
XEmacs support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Y
yank region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
yank, reformatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
yanking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86, 87, 92
Z
zooming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35