This is hyperbole.info, produced by makeinfo version 4.6 from
hyperbole.texi.

START-INFO-DIR-ENTRY
* Hyperbole: (hyperbole). Everyday net-centric information management system.
END-INFO-DIR-ENTRY


File: hyperbole.info,  Node: Top,  Next: Introduction,  Prev: (dir),  Up: (dir)

Preface
*******

                         BeOpen.com Hyperbole
              The Everyday Net-centric Information Manager
                      Edition 4.18, July 14, 1999.


Copyright (C) 1996, 1997, 1998, 1999  BeOpen.com

   Hyperbole is available for use, modification, and distribution under
the terms of the GNU General Public License (GPL) Version 1 as
published by the Free Software Foundation, with all rights and
responsibilities thereof.

   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.


       Published by BeOpen.com
       E-mail:    <info@beopen.com>
       Web:       www.beopen.com

   All trademarks referenced herein are trademarks of their respective
holders.

   Mouse click on the following filename to view a sample Hyperbole
screenshot showing excerpts from the Outliner, the Demonstration and the
Rolo: `im/hyperbole-cv.gif'.  Under InfoDock, use the middle mouse
button.  Under XEmacs or Emacs with the Hyperbole system loaded, use
the shift-middle mouse button or shift-left on a two button mouse.
Otherwise, there is no built-in way to view the picture.

   BeOpen.com is the developer and chief support organization for
Hyperbole, InfoDock (a professional-quality turnkey software development
and internet productivity suite) and the OO-Browser (a fast,
multi-language object-oriented code browser).

   BeOpen.com, in tandem with the Open Source community, builds,
supports, funds, and promotes Open Source Software (OSS) solutions for
organizational and individual use.  All of the software we index and
distribute at www.BeOpen.com is Open Source.  The more you visit this
site, the more OSS solutions we can bring you and the better we can
tailor the site to your needs.

                          -------------------

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 site development often requires the use of
many languages: HTML, Java, Javascript, and Perl.  This in itself
prevents its use as the prime means of organizing and interlinking the
constant flows of daily information.

   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 source to destination
of a link).  Hyperbole hyperbuttons not only can link to static
information but can perform arbitrary actions through the use of button
types written in a single, highly interactive language.  Hyperbole adds
all of this power to your written documents, e-mail, news articles,
contact management, outlines and requirements documents, directory
listings, and much more.

   Unlock the power of Hyperbole to make your information work for you.
One system. One language.  One manual.  One company.  One solution.
Learn Hyperbole and start moving further, faster.


                          -------------------

   Hyperbole was designed and written by Bob Weiner of BeOpen.com
Motorola, Inc. helped fund early work.  *Note Obtaining::, for
information on how to obtain Hyperbole.

   We hope you enjoy using Hyperbole and that it improves your
productivity.  If it does, consider sending us a quote that discusses
how it helps you, for use on our web site.  E-mail it to
<quotes@beopen.com>.

   Before we delve into Hyperbole, a number of acknowledgments are in
order.  Peter Wegner and Morris Moore encouraged the growth of this
work.  Doug Engelbart showed us the bigger picture and continues to be
an inspiration.  His life-long quest at augmenting individual and team
capabilities represents a model from which we are beginning to draw.
Chris Nuzum has used Hyperbole since its inception, often demonstrating
its power in creative ways.

* Menu:

* Introduction::
* Smart Keys::
* Buttons::
* Menus::
* Outliner::
* Rolo::
* Window Configurations::
* Developing with Hyperbole::
* Glossary::
* Installation::
* Smart Key Reference::
* Outliner Keys::
* Suggestion or Bug Reporting::
* Questions and Answers::
* Future Work::
* References::
* Key Index::
* Code and File Index::
* Concept Index::


Introduction

* Hyperbole Overview::
* Hyperbole Buttons::
* Discussion Forums::
* Manual Overview::

Smart Keys

* Smart Key Assignments::
* Smart Key Operations::
* Entering Arguments::

Buttons

* Explicit Buttons::
* Global Buttons::
* Implicit Buttons::
* Action Types::
* Button Type Precedence::
* Button Files::
* Utilizing Explicit Buttons::

Utilizing Explicit Buttons

* Creation::
* Renaming::
* Deletion::
* Modification::
* Location::
* Buttons in Mail::
* Buttons in News::

Creation

* By Dragging::                 Creation Via Action Key Drags
* By Menu::                     Creation Via Menus

Outliner

* Menu Commands::
* Creating Outlines::
* Autonumbering::
* Idstamps::
* Editing::
* Viewing::
* Links::
* Cell Attributes::
* Outliner History::

Editing

* Adding and Killing::
* Relocating and Copying::
* Moving Around::
* Filling::
* Transposing::
* Splitting and Appending::
* Inserting and Importing::
* Exporting::

Viewing

* Hiding and Showing::
* View Specs::

Rolo

* Rolo Concepts::
* Rolo Menu::
* Rolo Searching::
* Rolo Keys::
* Rolo Settings::

Developing with Hyperbole

* Hook Variables::
* Creating Types::
* Explicit Button Technicalities::
* Encapsulating Systems::
* Embedding Hyperbole::

Creating Types

* Action Type Creation::
* Implicit Button Types::

Explicit Button Technicalities

* Button Label Normalization::
* Operational and Storage Formats::
* Programmatic Button Creation::

Installation

* Obtaining::
* Installing::
* Configuring::

Configuring

* Using URLs with Find-File::
* Internal Viewers::
* External Viewers::
* Link Variable Substitution::
* Button Colors::

Smart Key Reference

* Smart Mouse Keys::
* Smart Keyboard Keys::


File: hyperbole.info,  Node: Introduction,  Next: Smart Keys,  Prev: Top,  Up: Top

Introduction
************

This manual explains user operation and summarizes basic developer
facilities of Hyperbole.  Hyperbole version 4 provides convenient access
to information and control over its display.  The Hyperbole outliner
offers flexible views and structure manipulation within bodies of
information.

   Throughout this manual, sequences of keystrokes are delimited by
curly braces { }, function names are delimited by parentheses ( ), and
variable names are EMPHASIZED.

   This chapter describes Hyperbole, lists some of its potential
applications, explains how to subscribe to its mail lists, and then
summarizes the structure of the rest of the manual.

* Menu:

* Hyperbole Overview::
* Hyperbole Buttons::
* Discussion Forums::
* Manual Overview::


File: hyperbole.info,  Node: Hyperbole Overview,  Next: Hyperbole Buttons,  Prev: Introduction,  Up: Introduction

Hyperbole Overview
==================

This edition of the Hyperbole Manual is for use with any version 4.17
or greater of Hyperbole.

   Hyperbole (pronounced Hi-per-bo-lee) is an open, efficient, and
programmable hypertextual information management and outliner system.
It is intended for everyday work on any UNIX, Windows, DOS or Mac
platform and runs as a subsystem of InfoDock or Emacs, the powerful text
editing environment.  It works well with InfoDock and the versions of
Emacs that support multiple X or NEXTSTEP windows: Emacs 19 or XEmacs.
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 point-and-click access to Info manuals, ftp
archives, Wide-Area Information Servers (WAIS), and the World-Wide Web
(WWW) hypertext system through encapsulations of software that support
these protocols.

Hyperbole consists of four parts:

_Info Management_
     an interactive information management interface, including a
     powerful rolo, which anyone can use.  It is easy to learn to use
     since it introduces only a few new mechanisms and has a menu
     interface, which may be operated from the keyboard or the mouse;

_Hypertext Outliner_
     an outliner with multi-level autonumbering and permanent
     identifiers attached to each outline node for use as hypertext
     link anchors, plus flexible view specifications that can be
     embedded within links or used interactively;

_Button Types_
     a set of hyper-button types that provides core hypertext and other
     behaviors.  Users can make simple changes to button types.  Emacs
     Lisp programmers can quickly prototype and deliver new types;

_Programming Library_
     a set of programming library classes 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, one can safely
ignore most of the information in this manual.  The `DEMO' file
included in the Hyperbole distribution demonstrates many of Hyperbole's
standard facilities.  It offers a much less technical introduction for
Hyperbole users by supplying good examples of how buttons may be used
and an introduction to the outliner.

   Mouse click on the following filename to view an image of part of the
Hyperbole demonstration: `im/demo.gif'.  Under InfoDock, use the middle
mouse button.  Under XEmacs or Emacs with the Hyperbole system loaded,
use the shift-middle mouse button or shift-left on a two button mouse.
Otherwise, there is no built-in way to view the picture.

   So if this manual is too detailed for your taste, skip it entirely
and jump right into the demonstration, normally by typing {`C-h h d
d'}, assuming Hyperbole has already been installed at your site.  *Note
Installation::, otherwise, for Hyperbole installation and configuration
information.

   Many users, however, will want to do more than browse with Hyperbole,
e.g. create their 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.
*Note Glossary: (xemacs)Glossary, if some emacs-related terms are
unfamiliar to you.


File: hyperbole.info,  Node: Hyperbole Buttons,  Next: Discussion Forums,  Prev: Hyperbole Overview,  Up: Introduction

Hyperbole Buttons
=================

A Hyperbole user works with chunks of information that need to be
organized, interlinked, and processed.  Such chunks can be
hyperbuttons, rolo entries, nodes in an outline, or even database query
results.  This overview discusses buttons only, as other chapters
introduce the other parts of Hyperbole.

   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.  A user always can check
how a button will behave before activating it.  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 one need not be anchored to a
workstation all day).  *Note Smart Keys::.

   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.  *Note Outliner::.

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 that is needed to create a new ling.  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 (*note Outliner::) 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.


File: hyperbole.info,  Node: Discussion Forums,  Next: Manual Overview,  Prev: Hyperbole Buttons,  Up: Introduction

Discussion Forums
=================

If you maintain or use Hyperbole, you should consider purchasing support
from BeOpen.com for it and thereby promoting its further development.
In addition or alternatively, you may join discussions about Hyperbole
at www.BeOpen.com.  Below are some tips on how to best structure support
or discussion messages.


     Always use your Subject: lines to state the position that your message
     takes on the topic that it addresses.
     
     For example, write:
     
          Subject: Basic bug in top-level 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.


File: hyperbole.info,  Node: Manual Overview,  Prev: Discussion Forums,  Up: Introduction

Manual Overview
===============

Remember that the `DEMO' file included in the Hyperbole distribution
demonstrates many of Hyperbole's standard facilities.  *Note
Introduction::, for more details.

   *Note Glossary::, 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.

   *Note Installation::, 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.

   *Note Suggestion or Bug Reporting::, 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.  *Note Questions
and Answers::.  *Note References::, if you are interested in classic
articles on hypertext.

   *Note Smart Keys::, for an explanation of the innovative,
context-sensitive mouse and keyboard Action and Assist Keys offered by
Hyperbole.  *Note Smart Key Reference::, for a complete reference on
what the Action and Assist Keys do in each particular context that they
recognize.

   (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.)

   *Note Buttons::, for an overview of Hyperbole buttons and how to use
them.

   *Note Menus::, for summaries of Hyperbole menu commands and how to
use the minibuffer-based menus that work on dumb terminals, PCs or
workstations.

   *Note Entering Arguments::, for special support that Hyperbole
provides for entering arguments when prompted for them.

   *Note Outliner::, for concept and usage information on the
autonumbered, hypertextual outliner.  *Note Outliner Keys::, for a full
summary of the outliner commands that are bound to keys.

   *Note Rolo::, for concept and usage information on the rapid lookup,
hierarchical, free text record management system included with
Hyperbole.

   *Note Window Configurations::, for instructions on how to save and
restore the set of buffers and windows that appear with 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.

   *Note Developing with Hyperbole::, if you are a developer who is
comfortable with Lisp.

   *Note Future Work::, for future directions in Hyperbole's evolution.


File: hyperbole.info,  Node: Smart Keys,  Next: Buttons,  Prev: Introduction,  Up: Top

Smart Keys
**********

Hyperbole supports two special "Smart Keys" that perform
context-sensitive operations: the Action Key and the Assist Key.  By
default, 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 should use the middle mouse key as the
Action Key, instead.)

* Menu:

* Smart Key Assignments::
* Smart Key Operations::
* Entering Arguments::


File: hyperbole.info,  Node: Smart Key Assignments,  Next: Smart Key Operations,  Prev: Smart Keys,  Up: Smart Keys

Smart Key Assignments
=====================

Mouse configuration of the Smart Keys is automatic for InfoDock and
XEmacs under the X window system and for GNU Emacs versions 18 and 19
under X, OpenWindows, NEXTSTEP, SunView and Apollo's Display Manager,
assuming your Emacs program has been built with support for any of these
window systems.  The command, `hmouse-shift-buttons', may be used to
select between shifted and unshifted Smart Mouse Keys.

   By default (if HKEY-INIT is set to `t' in `hyperbole.el'), then
{`M-<RET>'} may also be used as the Action Key and {`C-u M-<RET>'} may
be used as the Assist Key.  In many read-only modes like Dired (the
directory editor and file manager) and Rmail (the mail reader), {<RET>}
also functions as the Action Key and {`C-u <RET>'} functions as the
Assist Key.  These keys allow context-sensitive operation from any
keyboard.

   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.

   When Hyperbole is installed, a key may be bound which allows you to
switch between the Smart Key mouse bindings and your prior ones.  {`C-h
w hmouse-toggle-bindings <RET>'} should show you any key which performs
this command.  If no key binding has been established or if you prefer
one of your own, simply select a key and bind it within your `~/.emacs'
file.  For example, `(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.)


File: hyperbole.info,  Node: Smart Key Operations,  Next: Entering Arguments,  Prev: Smart Key Assignments,  Up: Smart Keys

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.

   You can get a summary of what the Smart Keys do in all of their
different contexts by pressing the Assist Key in the right corner
(within the rightmost 3 characters) of a window modeline or by using
the Hyperbole Doc/SmartKy menu entry.

   The following table is an example of this summary.  Much of the
browsing power of Hyperbole comes from use of the Smart Keys, so you
should spend some time practicing how to use them.  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 point and click and let Hyperbole do the rest.

   *Note Smart Key Reference::, for extensive reference documentation
on the Smart Keys.

     =============================================================================
                                                   Smart Keys
     Context                         Action Key                 Assist Key
     =============================================================================
     Hyperbole
       On a 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 an outline cell        Collapses and expands      Shows tree props
       Left of an outline cell       Creates a klink            Moves a tree
       Wrolo 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
     
     Mouse-only Control
       Modeline down & wind release  Resizes window height      <- same
       Drag from shared window side
         or from left of scroll bar  Resizes window width       <- same
       Drag between windows          Creates/modifies a link    Swaps wind buffers
       Horizontal drag within window
         Left to right               Scrolls to buffer end      Splits wind across
         Right to left               Scrolls to buffer begin    Deletes window
       Vertical drag within window   Splits window sideways     <- same
       Diagonal drag within window   Saves ring window-config   Restores config
       Click in modeline
         Left window edge            Buries buffer              Unburies bot buf
         Right window edge           Info                       Smart Key summary
         Otherwise                   Action Key hook            Assist Key hook
     
     Special Modes
       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
       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
       `ctags' file entry            Jumps to source line       Button help
       Etags `TAGS' 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
       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
       Buffer Menu                   Saves, deletes and displays buffers
     
     Emacs Info Reader
       Menu Entry or Cross Ref       To referent                <- same
       Up, Next or Prev Header       To referent                To prior node
       File entry of Header          To top node                To (DIR) node
       End of current node           To next node               To previous node
       Anywhere else                 Scrolls up a windowful     Scrolls wind down
     
     Subsystems
       Calendar                      Scrolls or shows appts     Scrolls/marks date
       Dired Mode                    Views and deletes files from dir listing
       GNUS News Reader              Toggles group subscriptions, gets new news,
                                       and browses articles
       Mail reader and Summaries     Browses, deletes and expunges messages
       OO-Browser                    Browses classes and elements
       Tar Mode                      Views and edits files from tar archive files
     
     Any other context (defaults)    Hyperbole minibuffer menu   Smart Key summary
                                       or under InfoDock,
                                       Invalid context message
     =============================================================================

   Note how the last line in the table explains the default behavior of
the Smart Keys.  That is what they do when they cannot find a context
match for your current location.  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.

   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 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 click is
necessary before an argument is accepted and processed.  *Note Entering
Arguments::, for more details on this subject.

   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.

   By default (if HKEY-INIT is left set to `t' in `hsite.el'), then
{`C-h A'} will display this same context-sensitive help for the Action
Key while {`C-u C-h A'} will display the help for the Assist Key.  Note
that {`C-h a'} will perform a function unrelated to Hyperbole, so you
must press the shift key when you type the `A' character.


File: hyperbole.info,  Node: Entering Arguments,  Prev: Smart Key Operations,  Up: Smart Keys

Entering Arguments
==================

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 the Action Key again at the same
point (click with a mouse) 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 *Note Completion: (xemacs)Completion.  Remember to use
{`?'} to see what your possibilities for an argument are.  Once you
have a list of possible completions on screen, double press the Action
Key on any one to enter it as the argument.


File: hyperbole.info,  Node: Buttons,  Next: Menus,  Prev: Smart Keys,  Up: Top

Buttons
*******

This chapter explains the user-level notion of Hyperbole buttons.
Hyperbole buttons which are stored in files persist across Emacs
sessions, so they provide a convenient means of linking from one
information source to another.

* Menu:

* Explicit Buttons::
* Global Buttons::
* Implicit Buttons::
* Action Types::
* Button Type Precedence::
* Button Files::
* Utilizing Explicit Buttons::


File: hyperbole.info,  Node: Explicit Buttons,  Next: Global Buttons,  Prev: Buttons,  Up: Buttons

Explicit Buttons
================

Hyperbole creates and manages _explicit buttons_ which look like this
`<(fake button)>' to a Hyperbole user.  They are quickly recognizable,
yet relatively non-distracting as one scans the text in which they are
embedded.  The text between the `<(' and `)>' delimiters is called the
"button label".  Spacing between words within a button label is
irrelevant to Hyperbole, so button labels may wrap across several lines
without causing a problem.

   Hyperbole stores the "button data" that gives an explicit button its
behavior, separately from the button label, in a file named `.hypb'
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.  *Note Smart Keys::.

   Explicit buttons may be freely moved about within the buffer in which
they are created.  (No present support exists for moving buttons between
buffers).  A single button may also appear multiple times within the
same buffer; one simply copies the button label with its delimiters to
a new location in such cases.

   Each explicit button is assigned an action type that determines the
actions it performs.  "Link action types" connect buttons to particular
types of referents.  "Activation" of such buttons then displays the
referents.

   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.


File: hyperbole.info,  Node: Global Buttons,  Next: Implicit Buttons,  Prev: Explicit Buttons,  Up: Buttons

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 simply explicit buttons which may be activated or otherwise operated
upon by entering their labels 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?  Create an `exec-kbd-macro' button with
an easy to type name and then you can activate it whenever the need
arises.


File: hyperbole.info,  Node: Implicit Buttons,  Next: Action Types,  Prev: Global Buttons,  Up: Buttons

Implicit Buttons
================

Implicit buttons are those defined by the natural structure of a
document.  They are identified by contextual patterns found within
documents.  Their behavior is determined by one or more actions which
they trigger when activated.  An action is derived from either a
Hyperbole action type specification (*note Action Types::) or an Emacs
Lisp function.  Implicit button types may use the same action types that
explicit buttons use.

   Implicit buttons never have any button data associated with them.
They are recognized in context based on predicate matches (boolean
conditionals defined within implicit button types.  For example,
Hyperbole recognizes file names enclosed in double quotes and can
quickly display their associated files in response to simple mouse
clicks.

See the Hyperbole file, `hibtypes.el', for complete examples of
implicit button types.  Standard implicit button types are listed below
in the order in which Hyperbole tries to match to the types when looking
for an implicit button.

`completion'
     Inserts the completion at point into the minibuffer or the other
     window.

`Info-node'
     Makes "(file)node" buttons display the associated Info node.

`www-url'
     When not in a w3 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.beopen.com, 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 or Info node associated with Texinfo @xref,
     @pxref or @ref at point.  If point is within the braces of the
     reference, the Info node is shown.  If it 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.

`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 ROLO-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.

`grep-msg'
     Jumps to a line associated with grep or compilation error messages.
     Messages are recognized in any buffer.

`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.

`pathname'
     Makes a valid pathname display the path entry.  Also works for
     delimited and non-delimited ange-ftp and efs pathnames and Texinfo
     `' entries.  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 removed from the pathname when
     searching for a valid match.  See the function documentation for
     `hpath:find' for special file display options.

`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 (man -k) display associated man pages
     when selected.

`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 sending mail to a BeOpen.com address.  See
     also the documentation for `actypes::hyp-config'.

`rfc'
     Retrieves and displays an Internet rfc referenced at point.
     Requires ange-ftp or EFS when needed for remote 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 a key sequence delimited by curly braces.  Key sequences
     should be in human readable form, e.g. {`C-b'}.  Forms such as
     {}, {}, and {^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 cross-reference 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.

`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.

`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.el' package has been loaded and the current major mode
     is one handled by `func-menu'.

`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.  See `${hyperb:dir}/hib-doc-id.el'
     for more information.


   The Hyperbole Smart Keys offer extensive additional context-sensitive
point-and-click type behavior beyond these standard implicit button
types.  *Note Smart Keys::.


File: hyperbole.info,  Node: Action Types,  Next: Button Type Precedence,  Prev: Implicit Buttons,  Up: Buttons

Action Types
============

"Action types" supply action procedures that specify button behavior.
Each action type may be used by any category of button: global,
explicit, or implicit.  The arguments 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, 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 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'.

`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-node'
     Displays an Info NODE.  NODE must be a string of the form,
     `(file)nodename'.

`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.

`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 BUFFER-P 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 the ange-ftp or EFS
     packages for remote 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 BUFFER-P 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.

`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 the interpreter can
evaluate.


File: hyperbole.info,  Node: Button Type Precedence,  Next: Button Files,  Prev: Action Types,  Up: Buttons

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.  *Note Creating Types::, for
information on how to develop or modify types.


File: hyperbole.info,  Node: Button Files,  Next: Utilizing Explicit Buttons,  Prev: Button Type Precedence,  Up: Buttons

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, we call "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 standard
button files.  Its standard value is `HYPB'.)

   A personal button file may serve as a user's own roadmap to
frequently used resources.  Selection of the ButFile/PersonalFile menu
item 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 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 directory-specific 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.


File: hyperbole.info,  Node: Utilizing Explicit Buttons,  Prev: Button Files,  Up: Buttons

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.

* Menu:

* Creation::
* Renaming::
* Deletion::
* Modification::
* Location::
* Buttons in Mail::
* Buttons in News::


File: hyperbole.info,  Node: Creation,  Next: Renaming,  Prev: Utilizing Explicit Buttons,  Up: Utilizing Explicit Buttons

Creation
--------

* Menu:

* By Dragging::                 Creation Via Action Key Drags
* By Menu::                     Creation Via Menus


File: hyperbole.info,  Node: By Dragging,  Next: By Menu,  Prev: Creation,  Up: Creation

Creation Via Action Key Drags
.............................

The most efficient way to create an explicit button interactively is to
use the mouse Action 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 mouse Action Key at the source
point for the button, drag to the other window and release the mouse
Action Key at the start point of the link referent.  The process becomes
quite simple with a little practice. (*Note Creation Via Menus: By
Menu, for a more detailed explanation of the explicit button creation
process.)

   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
label and will display a message in the minibuffer indicating both the
button name and its action/link type.

   If you run Emacs under a window system, 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.


File: hyperbole.info,  Node: By Menu,  Prev: By Dragging,  Up: Creation

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
help 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.  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 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 *Note Entering Arguments::, to
select the link referent.


File: hyperbole.info,  Node: Renaming,  Next: Deletion,  Prev: Creation,  Up: Utilizing Explicit Buttons

Renaming
--------

Once an explicit button has been created, its label text must be
treated specially.  Any inter-word 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 invoke the rename command again.  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.  Your site installation may include such a
key.  {`C-h w hui:ebut-rename <RET>'} should show you any key it is on.
If no key binding has been established or if you prefer one of your
own, simply bind it within your `~/.emacs' file.  We recommend the
{`C-c C-r'} key, as in: `(global-set-key "\C-c\C-r" 'hui:ebut-rename)'.


File: hyperbole.info,  Node: Deletion,  Next: Modification,  Prev: Renaming,  Up: Utilizing Explicit Buttons

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.


File: hyperbole.info,  Node: Modification,  Next: Location,  Prev: Deletion,  Up: Utilizing Explicit Buttons

Modification
------------

Ebut/Modify prompts you with each of the elements from the button's
attributes list and allows you to modify each in turn.

   There is a quicker way to modify explicit link buttons, however.
Simply drag with the mouse Action 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.  *Note Creation::.


File: hyperbole.info,  Node: Location,  Next: Buttons in Mail,  Prev: Modification,  Up: Utilizing Explicit Buttons

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.  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.


File: hyperbole.info,  Node: Buttons in Mail,  Next: Buttons in News,  Prev: Location,  Up: Utilizing Explicit Buttons

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.

   Hyperbole automatically supports the following mail readers: Rmail
(*note Top: (rmail)Top.), VM (*note Introduction: (vm)Introduction.),
PIEmail, 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 (*note The Gnus Newsreader: (gnus)Top.).  (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 act just
like 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 non-Hyperbole 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.

   In order to alert readers of your mail messages that you can handle
Hyperbole mail buttons, the system automatically inserts a comment into
each mail message that you compose to announce this fact.  The variable,
SMAIL:COMMENT controls this behavior.  See its documentation for
technical details.  By default, it produces a message of the form:

     Comments: 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.  If you don't want any
message at all, add the following to your `~/.emacs' file before the
point at which you load Hyperbole.

     (setq smail:comment nil)

   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 *Note Entering Arguments::.


File: hyperbole.info,  Node: Buttons in News,  Prev: Buttons in Mail,  Up: Utilizing Explicit Buttons

Buttons in News
---------------

Explicit buttons may be embedded within outgoing USENET news articles
and may be activated from within the Gnus news reader.  This support is
enabled by default within `hsite.el' by autoloading the `hgnus.el' file.

   All Hyperbole support should work just as it does when reading or
sending mail.  *Note Buttons in Mail::.  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
automatically inserts into news postings the same comment that is
included within mail messages.  *Note Buttons in Mail::, for details and
an explanation of how to turn this feature off.


File: hyperbole.info,  Node: Menus,  Next: Outliner,  Prev: Buttons,  Up: Top

Menus
*****

Under InfoDock, XEmacs, and Emacs 19, 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.

   Mouse click on the following filename to view an image of part of the
Hyperbole demonstration: `im/menu-hyperbole.gif'.  Under InfoDock, use
the middle mouse button.  Under XEmacs or Emacs with the Hyperbole
system loaded, use the shift-middle mouse button or shift-left on a two
button mouse.  Otherwise, there is no built-in way to view the picture.

   This section discusses only the specialized "minibuffer menus" that
appear in the minibuffer window and that work with all emacs versions on
all display devices.  Minibuffer menu items may be selected from either
the keyboard or the mouse.  When used with the keyboard, they provide
rapid command access similar to key bindings.

   The top-level Hyperbole menu is invoked from a key given in your
`hsite.el' file (by default, {`C-h h'}).  The menu will appear in the
minibuffer and should look mostly like so:

     Hy4>  Act Butfile/ Cust/ Doc/ Ebut/ Gbut/ Hist Ibut/ Msg/ Otl/ Rolo/ Win/

The above menu items have the following effects:

*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, 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.  *Note Configuring::.

*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.

*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 mail and news messaging support commands.  Use
     this to send mail to a Hyperbole support/discussion address.

*Otl/*
     Autonumbered, structured outliner and hyper-node manager commands.
     *Note Outliner::.

*Rolo/*
     Hierarchical, multi-file rolo lookup and edit commands.  *Note
     Rolo::.

*Win/*
     Window configuration management, such as adding and restoring
     window configurations by name. *Note Window Configurations::.


   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,
you must use {`C-t'}.  This allows you to browse the submenus and then
return to the top.  You can quit without selecting an item by using
{`q'}.  {`C-g'} aborts whether you are at a menu prompt or any other
Hyperbole prompt.


File: hyperbole.info,  Node: Outliner,  Next: Rolo,  Prev: Menus,  Up: Top

Outliner
********

The Hyperbole outliner, also known as 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.  *Note Autonumbering::.

   Cells also store their time of creation and the user who created the
cell.  User-defined attributes may also be added to cells.  *Note Cell
Attributes::.

   The outliner works under GNU Emacs version 19 or higher, XEmacs
version 19.9 or higher or under InfoDock.  You can tell whether you are
running a version of Emacs which supports the outliner by hitting {`C-h
h'} to display the Hyperbole menu ({`q'} will quit).  If you see an
`Otl/' 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 o 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.

   *Note Outliner Keys::, for a full summary of the key bindings and
commands available in the outliner.

   Mouse click on the following filename to view an image of part of the
Hyperbole demonstration: `im/koutliner.gif'.  Under InfoDock, use the
middle mouse button.  Under XEmacs or Emacs with the Hyperbole system
loaded, use the shift-middle mouse button or shift-left on a two button
mouse.  Otherwise, there is no built-in way to view the picture.

* Menu:

* Menu Commands::
* Creating Outlines::
* Autonumbering::
* Idstamps::
* Editing::
* Viewing::
* Links::
* Cell Attributes::
* Outliner History::


File: hyperbole.info,  Node: Menu Commands,  Next: Creating Outlines,  Prev: Outliner,  Up: Outliner

Menu Commands
=============

The Otl/ 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
     ====================================================================

   The popup and menubar Koutliner 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.

   Mouse click on the following filename to view an image of part of the
Hyperbole demonstration: `im/menu-koutline.gif'.  Under InfoDock, use
the middle mouse button.  Under XEmacs or Emacs with the Hyperbole
system loaded, use the shift-middle mouse button or shift-left on a two
button mouse.  Otherwise, there is no built-in way to view the picture.


File: hyperbole.info,  Node: Creating Outlines,  Next: Autonumbering,  Prev: Menu Commands,  Up: Outliner

Creating Outlines
=================

In addition to the Otl/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.

   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.

   *Note Autonumbering::, 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.


File: hyperbole.info,  Node: Autonumbering,  Next: Idstamps,  Prev: Creating Outlines,  Up: Outliner

Autonumbering
=============

*Note Adding and Killing::, 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.  Legal labels, partial alpha labels (single level autonumbering
where only the last part of the level number is shown, as commonly seen
in other outliner products), idstamps (permanent cell ids), and star
outline level labels (Emacs asterisk-based outline labeling) are all
available.  Or you may choose to turn autonumbering off.  Cells are
still indented to reflect the outline structure whether or not labels
are displayed.

   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")


File: hyperbole.info,  Node: Idstamps,  Next: Editing,  Prev: Autonumbering,  Up: Outliner

Idstamps
========

Idstamps (permanent ids) are associated with each cell.  They maintain
hyperlinks as cells are reordered within a koutline.  *Note Links::.
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.


File: hyperbole.info,  Node: Editing,  Next: Viewing,  Prev: Idstamps,  Up: Outliner

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.  *Note Filling::,
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.

* Menu:

* Adding and Killing::
* Relocating and Copying::
* Moving Around::
* Filling::
* Transposing::
* Splitting and Appending::
* Inserting and Importing::
* Exporting::


File: hyperbole.info,  Node: Adding and Killing,  Next: Relocating and Copying,  Prev: Editing,  Up: Editing

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'}.


File: hyperbole.info,  Node: Relocating and Copying,  Next: Moving Around,  Prev: Adding and Killing,  Up: Editing

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>'}
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.  *Note Filling::.  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
shift 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.

   You may also import cells into the current koutline from another
koutline with the {`M-x kimport:text <RET>'} command.  *Note Inserting
and Importing::.


File: hyperbole.info,  Node: Moving Around,  Next: Filling,  Prev: Relocating and Copying,  Up: Editing

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.


File: hyperbole.info,  Node: Filling,  Next: Transposing,  Prev: Moving Around,  Up: Editing

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 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.


File: hyperbole.info,  Node: Transposing,  Next: Splitting and Appending,  Prev: Filling,  Up: Editing

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.


File: hyperbole.info,  Node: Splitting and Appending,  Next: Inserting and Importing,  Prev: Transposing,  Up: Editing

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.


File: hyperbole.info,  Node: Inserting and Importing,  Next: Exporting,  Prev: Splitting and Appending,  Up: Editing

Inserting and Importing
-----------------------

The elements 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, though
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 kotl-mode: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.

   (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.


File: hyperbole.info,  Node: Exporting,  Prev: Inserting and Importing,  Up: Editing

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.


File: hyperbole.info,  Node: Viewing,  Next: Links,  Prev: Editing,  Up: Outliner

Viewing
=======

The Koutliner has very flexible viewing facilities to allow you to
effectively browse and study large amounts of material.

* Menu:

* Hiding and Showing::
* View Specs::


File: hyperbole.info,  Node: Hiding and Showing,  Next: View Specs,  Prev: Viewing,  Up: Viewing

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.
*Note View Specs::.

`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.

`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.  This also turns off blank lines between cells to
     maximize the density of information.

`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.  This does not turn off blank lines.

   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>'}.


File: hyperbole.info,  Node: View Specs,  Prev: Hiding and Showing,  Up: Viewing

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.  *Note Links::.

   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.

`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-LABEL-TYPE.  Normally, this is alphanumeric labels.

`n0'
     Display idstamps.

`n1'
     Display alpha labels.

`n2'
     Display partial alpha labels (don't use this, as full alpha labels
     are better).

`n.'
     Display legal labels.

`n*'
     Display star labels.  A level three cell would have three
     asterisks as a label, for example.

`n~'
     Turn off labels.  (This removes the `n' viewspec from the
     modeline.)

   As a test, use {`C-h h o 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.


File: hyperbole.info,  Node: Links,  Next: Cell Attributes,  Prev: Viewing,  Up: Outliner

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 (*note Creation Via Action Key Drags: By
Dragging.).  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.

   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 o
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 show 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.


File: hyperbole.info,  Node: Cell Attributes,  Next: Outliner History,  Prev: Links,  Up: Outliner

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 1994".

   {`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.  *Note Filling::.

   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.


File: hyperbole.info,  Node: Outliner History,  Prev: Cell Attributes,  Up: Outliner

Outliner 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.


File: hyperbole.info,  Node: Rolo,  Next: Window Configurations,  Prev: Outliner,  Up: Top

Rolo
****

Hyperbole includes a complete, advanced rolo system, Wrolo, for
convenient management of hierarchical, record-oriented information.

   Hyperbole buttons may be included within rolo records and then
manually activated whenever their records are retrieved.

   See the description at the top of the `wrolo.el' file for details on
programmatic interfacing to the rolo.  The following subsections
explain use and basic customization of this tool.

* Menu:

* Rolo Concepts::
* Rolo Menu::
* Rolo Searching::
* Rolo Keys::
* Rolo Settings::


File: hyperbole.info,  Node: Rolo Concepts,  Next: Rolo Menu,  Prev: Rolo,  Up: Rolo

Rolo Concepts
=============

The rolo 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.

     ==================================================================
                               PERSONAL ROLO
     <Last-Name>, <First>  <Email>        W<Work#>       F<Fax#>
     ==================================================================
     *   Smith, John       <js@hiho.com> W708-555-2001  F708-321-1492
             Chief Ether Maintainer, HiHo Industries
             05/24/1999

   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 sort them whenever you desire.  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.


File: hyperbole.info,  Node: Rolo Menu,  Next: Rolo Searching,  Prev: Rolo Concepts,  Up: Rolo

Rolo Menu
=========

The Rolo submenu of the Hyperbole menu offers a full set of commands
for searching and maintaining a personal rolo.  It looks like so.

   Mouse click on the following filename to view an image of part of the
Hyperbole demonstration: `im/menu-rolo.gif'.  Under InfoDock, use the
middle mouse button.  Under XEmacs or Emacs with the Hyperbole system
loaded, use the shift-middle mouse button or shift-left on a two button
mouse.  Otherwise, there is no built-in way to view the picture.

   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 supplies the following commands:

     Menu Item       Command               Description
     =====================================================================
     Add             rolo-add              Adds a rolo entry
     Display         rolo-display-matches  Displays last matches again
     Edit            rolo-edit             Edits an existing rolo entry
     Info                                  Displays a rolo manual entry
     Kill            rolo-kill             Deletes a rolo entry
     Mail            rolo-mail             Mails to an address at point
     Order           rolo-sort             Sorts all rolo levels
     RegexFind       rolo-grep             Finds all entries containing
                                             a regular expression
     StringFind      rolo-fgrep            Finds all entries containing
                                             a string (or logical
                                             expression)
     WordFind        rolo-word             Finds all entries containing
                                             a string of whole words
     Yank            rolo-yank             Inserts the first matching
                                             rolo entry at point
     =====================================================================

   A prefix argument used with either 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, 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.  Do not use this hierarchical
notation in search expressions since the whole rolo will be searched
anyway.  Thus, "Staffer" as a search pattern will find an entry
containing "Staffer" at any level in a hierarchy, like so:

     ***      Staffer


File: hyperbole.info,  Node: Rolo Searching,  Next: Rolo Keys,  Prev: Rolo Menu,  Up: Rolo

Rolo Searching
==============

*Note Rolo Menu::, 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 to 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.  *Note Syntax of Regular Expressions:
(xemacs)Regexps, for full documentation on this format.

   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)


File: hyperbole.info,  Node: Rolo Keys,  Next: Rolo Settings,  Prev: Rolo Searching,  Up: Rolo

Rolo Keys
=========

After a rolo search is performed, point is left in the "rolo match
buffer", `*Hyperbole Rolo*', which uses `wrolo-mode' to simplify
browsing many rolo matches.  Press {`?'} when in the match buffer for a
summary of available keys.

   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>'} or {`r'} moves 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.  {`C-r'}
reverses the direction of the search.

   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 overview of all the entries.  Each entry is
collapsed so that only its first line shows.  Press {`s'} to show
(expand) the entry at point.  Use {`h'} to hide (collapse) the entry
again.  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 entry at point in the rolo match
buffer.  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, WROLO-EDIT-HOOK, is
evaluated after the update of the entry datestamp.  This allows
programmed modification of the way rolo edits work.  The variable,
WROLO-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.


File: hyperbole.info,  Node: Rolo Settings,  Prev: Rolo Keys,  Up: Rolo

Rolo Settings
=============

The files used in any rolo search are given by the ROLO-FILE-LIST
variable, whose default value is `("~/.rolo.otl")', so that searches
initially scan only your personal rolo.  Any entries added to this list
should be file pathnames.  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 textual highlighting is available in your emacs on your current
display type, the rolo uses the value of ROLO-HIGHLIGHT-FACE as the
face which highlights search matches.

   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 rolo-kill-buffers-after-use t)'.

   After an entry is killed, the modified rolo file is automatically
saved.  If you would rather always save files yourself, use this
setting: `(setq rolo-save-buffers-after-use nil)'.

   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
ROLO-EMAIL-FORMAT variable.  See its documentation if you want to
change its value.

   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, ROLO-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.

   The rolo entry start delimiter is given by the regular expression
variable, ROLO-ENTRY-REGEXP, whose default value is "^\*+", i.e.  one
or more asterisks at the beginning of a line.

   When a rolo search is done, each matching entry is passed through the
function given by the variable, ROLO-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.


File: hyperbole.info,  Node: Window Configurations,  Next: Developing with Hyperbole,  Prev: Rolo,  Up: Top

Window Configurations
*********************

Hyperbole includes the `wconfig.el' package which lets you save and
restore window configurations, i.e. the window layout 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 pull up 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.

   The wconfig library offers two distinct means of managing window
configurations.  The first means associates a name with each stored
window configuration.  The name may then be used to retrieve the window
configuration later.  The second means uses a ring structure to save
window configurations and then allows browsing through the ring of
saved configurations, finally wrapping around to the first entry after
the last entry is encountered.

   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         wconfig-add-by-name       Name current wconfig
     DeleteName      wconfig-delete-by-name    Delete wconfig with a name
     RestoreName     wconfig-restore-by-name   Restore wconfig with a name
     
     PopRing         wconfig-delete-pop        Restore and delete wconfig
     SaveRing        wconfig-ring-save         Store wconfig to the ring
     YankRing        wconfig-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.
The ring commands permit saves and restores through mouse interaction
only, if so desired.  An earlier chapter (*note Smart Keys::) 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.

   Wconfig creates a ring structure that operates just like the Emacs
KILL-RING (*note Kill Ring: (xemacs)Kill Ring.) but its elements are
window configurations rather than text regions.  You can add an element
to the ring to save the current window configuration.  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 `wconfig-ring-save' command which saves the
current window configuration to the ring.

   YankRing executes the `wconfig-yank-pop' command.  It restores the
window configuration from the currently pointed to configuration in the
ring.  It does not delete this configuration from the 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 `wconfig-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
WCONFIG-RING-MAX variable whose default is 10.  Any saves beyond this
value cause deletion of the oldest element in the ring before a new one
is added.


File: hyperbole.info,  Node: Developing with Hyperbole,  Next: Glossary,  Prev: Window Configurations,  Up: Top

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.

* Menu:

* Hook Variables::
* Creating Types::
* Explicit Button Technicalities::
* Encapsulating Systems::
* Embedding Hyperbole::


File: hyperbole.info,  Node: Hook Variables,  Next: Creating Types,  Prev: Developing with Hyperbole,  Up: Developing with Hyperbole

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:

HYPERB:INIT-HOOK
     For customization at Hyperbole initialization time.  Use this to
     load any personal Hyperbole type definitions you might have.  It
     is run after Hyperbole support code is loaded but before Hyperbole
     session initializations take place.

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.

KOTL-MODE-HOOK
     Executed whenever a koutline is created or read in or when
     kotl-mode is invoked.

WROLO-ADD-HOOK
     Executed after the addition of a new rolo entry.

WROLO-DISPLAY-HOOK
     Executed when rolo matches are displayed.

WROLO-EDIT-HOOK
     Executed after point is successfully moved to an entry to be
     edited.

WROLO-MODE-HOOK
     Executed when a rolo match buffer is created and put into
     wrolo-mode.

WROLO-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 rolo-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-HOOKS
     This is called whenever a file is read into a buffer.  Hyperbole
     uses it to highlight any buttons within files when run under any X
     or NEXTSTEP window system versions of Emacs, XEmacs or InfoDock.

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.


File: hyperbole.info,  Node: Creating Types,  Next: Explicit Button Technicalities,  Prev: Hook Variables,  Up: Developing with Hyperbole

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.

* Menu:

* Action Type Creation::
* Implicit Button Types::


File: hyperbole.info,  Node: Action Type Creation,  Next: Implicit Button Types,  Prev: Creating Types,  Up: Creating Types

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 button definitions.  Implicit buttons never use an action
type's interactive form.  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).  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 standard interactive meanings.

The present Hyperbole extension characters are:

*+I*
     Prompts for an existing Info node name and file.

*+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.


   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.

   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).


File: hyperbole.info,  Node: Implicit Button Types,  Prev: Action Type Creation,  Up: Creating Types

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 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.


File: hyperbole.info,  Node: Explicit Button Technicalities,  Next: Encapsulating Systems,  Prev: Creating Types,  Up: Developing with Hyperbole

Explicit Button Technicalities
==============================

* Menu:

* Button Label Normalization::
* Operational and Storage Formats::
* Programmatic Button Creation::


File: hyperbole.info,  Node: Button Label Normalization,  Next: Operational and Storage Formats,  Prev: Explicit Button Technicalities,  Up: Explicit Button Technicalities

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)>     <( fake      button)>
     
       Pam>  <(fake
       Pam>    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.


File: hyperbole.info,  Node: Operational and Storage Formats,  Next: Programmatic Button Creation,  Prev: Button Label Normalization,  Up: Explicit Button Technicalities

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.


File: hyperbole.info,  Node: Programmatic Button Creation,  Prev: Operational and Storage Formats,  Up: Explicit Button Technicalities

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 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.


File: hyperbole.info,  Node: Encapsulating Systems,  Next: Embedding Hyperbole,  Prev: Explicit Button Technicalities,  Up: Developing with Hyperbole

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.

_WAIS_
     The Wide Area Information Systems full text-retrieval system
     orginally developed at Thinking Machines and then later at WAIS
     Inc.


File: hyperbole.info,  Node: Embedding Hyperbole,  Prev: Encapsulating Systems,  Up: Developing with Hyperbole

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', `set.el', `wconfig.el',
`wrolo.el', and `wrolo-logic.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 outliner, as it has been
designed for interactive use, rather than programmatic extensibility.
You are welcome, however, to study its code, below the
`hyperbole/kotl/' directory.


File: hyperbole.info,  Node: Glossary,  Next: Installation,  Prev: Developing with Hyperbole,  Up: Top

Glossary
********

Concepts pertinent to operational usage of Hyperbole are defined here.
*Note Glossary: (xemacs)Glossary, 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 `EFS'

`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, screen
     windows, true hypertext, outline processors, groupware, and
     digitally signed documents.  *Note References::, which cites
     several Douglas Engelbart papers on the subject.  The Koutliner
     demonstrates a few of the concepts pioneered in Augment.

`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.

`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.

`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.

`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.

`Domain'
     The contexts in which an implicit button type may be found, i.e.
     where its predicate is true.

`ebut:max-len'
     See `Button Label'.

`Environment'
     See `Hyperbole Environment'.

`EFS'
     The successor to ange-ftp.  It does the same thing as ange-ftp but
     works with more types of ftp hosts.  It is a standard Emacs Lisp
     package which allows one to use pathnames that are accessible via
     the Internet File Transfer Protocol (ftp) just like other
     pathnames, for example when finding a file.  Hyperbole recognizes
     both ange-ftp pathnames of the form, `/<user>@<host>:<path>' and
     ftp URLs used on the World-Wide Web.

`Explicit Button'
     A button created and managed by Hyperbole.  By default, explicit
     buttons are delimited like this `<(fake button)>'.  Direct
     selection is used to operate upon an explicit button.

`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)'.

`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.

`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.

`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'.

`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'.

`Link'
     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'.

`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'.

`Rolo'
     Wrolo, the Hyperbole record manager, provides rapid lookup of
     multi-line, hierarchically ordered free form text records.

`Root Cell'
     A koutline cell which has cells below it at lower outline levels.
     All such cells share the same root cell.

`Smart Key'
     A context-sensitive key used within Hyperbole and beyond.
     Actually, there are two Smart Keys, the Action Key and the Assist
     Key.  The Action Key, typically bound to the shift-middle mouse
     key (or shift-left mouse key on a 2-button mouse), 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,
     typically bound to the shift-right mouse key, explains what a
     Hyperbole button does or scrolls the current line to the bottom of
     the window when pressed at the end of a line.  (Use the Hyperbole
     Cust menu or see the documentation for the variable,
     SMART-SCROLL-PROPORTIONAL, for information on how to make these
     keys scroll forward and backward a windowful at a time).

     To see what a Smart Key will do within a particular context,
     depress and hold the Smart Mouse Key at the point desired and
     depress the other Smart Mouse Key.  A buffer containing a
     description of its contextual function will then be displayed.
     You may release the two keys in any order after you have depressed
     them both.  The Doc/SmartKy menu item displays a summary of Smart
     Key functions in each context.

`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.

`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.

`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>.

`Wrolo'
     See `Rolo'.



File: hyperbole.info,  Node: Installation,  Next: Smart Key Reference,  Prev: Glossary,  Up: Top

Installation
************

Hyperbole must be obtained and installed at your site before you can use
it.  Instructions for installing Hyperbole are in the `HY-README' file
in the root directory of the Hyperbole distribution, i.e. below
`hyperbole/'.  If you are using BeOpen.com InfoDock version 4.0.7 or
higher, Hyperbole is pre-installed so you can skip the installation
instructions and simply continue on through the configuration
instructions in this section.

   We hope you enjoy using Hyperbole and that it improves your
productivity.  If it does, consider sending us a quote that discusses
how it helps you, for use on our web site.  E-mail it to
<quotes@beopen.com>.

   If you want to customize the basic Hyperbole initialization sequence
for yourself rather than the users at your site, you should make a
personal copy of the `hsite-ex.el' file that is a part of the Hyperbole
distribution, modify it the way you want, and then load it.  (*Note
Hook Variables::, if you are familiar with Emacs Lisp.)

* Menu:

* Obtaining::
* Installing::
* Configuring::


File: hyperbole.info,  Node: Obtaining,  Next: Installing,  Prev: Installation,  Up: Installation

Obtaining
=========

The latest production release of Hyperbole is always available for
download from www.BeOpen.com.  Professional releases of Hyperbole may
also be purchased there to help support development; they include
Hyperbole with full source code, a printed copy of this manual and
installation support.  Ongoing technical support and automatic upgrades
are available separately.  Further contact information may be found at
the beginning of this manual.

   Once you have obtained a Hyperbole distribution archive, move the
archive to the directory below which you want the `hyperbole/'
production directory installed.

   If you have obtained the Hyperbole distribution in gzipped, tar
archive format (.tgz suffix), then unpack the archive to create the
`hyperbole/' directory by using the GNU version of the `zcat' program,
sometimes called `gzcat' or the `gunzip' program:

        zcat beopen-hyperbole*tgz | tar xvf -
     or
        gunzip beopen-hyperbole*tgz; tar xvf beopen-hyperbole*tar

   Alternatively, if you have obtained the Hyperbole distribution in
zipped format (.zip suffix), then use your favorite unzip utility to
create the `hyperbole/' directory.


File: hyperbole.info,  Node: Installing,  Next: Configuring,  Prev: Obtaining,  Up: Installation

Installing
==========

You may want to explore the Hyperbole configuration options before
installing it.  *Note Configuring::.  If you just want to get up and
running quickly, however, there is no need to configure anything, just
follow these instructions to install Hyperbole.

   See the _Installation / Configuration_ section in the `HY-README'
file of the `hyperbole' directory for instructions on installing and
building Hyperbole.

The Hyperbole Manual may be viewed on the web at www.BeOpen.com.  The
manual is included in the distribution in two forms:

     `man/hyperbole.info'   - online Info browser version
     `man/hyperbole.texi'   - source form

The Hyperbole installation procedure places the Info version of the
manual where needed.  Under InfoDock and XEmacs, a pointer to this
manual is also added to your Info directory tree.  Under GNU Emacs you
may need to manually add an Info directory entry for the Hyperbole
manual in your Info `dir' file (the `*' should be placed in the first
column of the file):

     * Hyperbole::  Everyday net-centric information management system.
         Use {C-h h d d} for a demonstration.  Includes Smart Key
         context-sensitive mouse and keyboard support, a powerful contact
         manager, an autonumbered outliner with hyperlink anchors for each
         outline entry, and extensible hypertext facilities including
         hyperlinks in mail and news messages.

   You have now completed the installation of Hyperbole.  Once
installed, you can invoke Hyperbole with {`C-h h'} or {`M-x hyperbole
<RET>'} to bring up the Hyperbole main menu in the minibuffer window
and to display the Hyperbole menu on your menubar, if any.


File: hyperbole.info,  Node: Configuring,  Prev: Installing,  Up: Installation

Configuring
===========

Major Hyperbole user options may be set from the Customization submenu
below the Hyperbole menubar menu, as seen here.

   Mouse click on the following filename to view an image of part of the
Hyperbole demonstration: `im/menu-customization.gif'.  Under InfoDock,
use the middle mouse button.  Under XEmacs or Emacs with the Hyperbole
system loaded, use the shift-middle mouse button or shift-left on a two
button mouse.  Otherwise, there is no built-in way to view the picture.

Alternatively, the minibuffer-based menu, Cust/ may be used.

   There are many additional Hyperbole configuration options that may be
changed by editing the `hyperbole.el' and `hsite.el' files in the
`hyperbole/' directory.  The following sections discuss the
configuration options most likely to be of interest to users.

* Menu:

* Using URLs with Find-File::
* Internal Viewers::
* External Viewers::
* Link Variable Substitution::
* Button Colors::


File: hyperbole.info,  Node: Using URLs with Find-File,  Next: Internal Viewers,  Prev: Configuring,  Up: Configuring

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).
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 Find-File-Accepts-URLs on the
Hyperbole/Customization pulldown menu).  Either of these toggles
acceptance of URLs.  When enabled the string, URLs, appears in the
parenthesized minor-mode section of the modeline.

   To enable this feature each time you start the editor, add the
following to your personal initialization file:
`(hyperb:find-file-urls-mode 1)'.

   Both full URLs and abbreviated ones, like www.BeOpen.com, 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 EFS (Extended File System) Emacs Lisp package installed; if
you don't have EFS, an error message will be displayed when you try to
enable find-file URLs.


File: hyperbole.info,  Node: Internal Viewers,  Next: External Viewers,  Prev: Using URLs with Find-File,  Up: Configuring

Internal Viewers
----------------

When given a file name, Hyperbole will by default display the file for
editing within an Emacs buffer.  The HPATH: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.

   Configure the HPATH:DISPLAY-ALIST variable in `hsite.el'.  Its value
is an association list whose elements are
(<file-name-regular-expression> . <function-of-one-arg>) pairs.  Any
path whose name matches a <file-name-regular-expression> will be
displayed by calling the associated <function-of-one-arg> with the file
name as the argument.

   *Note External Viewers::, for instructions on associating file names
with external, window-system specific viewers.


File: hyperbole.info,  Node: External Viewers,  Next: Link Variable Substitution,  Prev: Internal Viewers,  Up: Configuring

External Viewers
----------------

If you will be using Hyperbole under a window system, you may want to
configure the HPATH:FIND-ALIST variable in `hsite.el' to support
hyperlinks which open files using non-Emacs tools, e.g. a fax reader or
a bitmap viewer.

   The value of HPATH:FIND-ALIST is determined when Hyperbole is
initialized based upon the current window system and the version of
Emacs in use.  The value is an association list whose elements are
(<file-name-regular-expression> . <viewer-program-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.  See the "x-suffixes" and "nextstep-suffixes"
settings within the definition of HPATH:FIND-ALIST as examples.


File: hyperbole.info,  Node: Link Variable Substitution,  Next: Button Colors,  Prev: External Viewers,  Up: Configuring

Link Variable Substitution
--------------------------

Another `hsite.el' options 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, 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 may 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.


File: hyperbole.info,  Node: Button Colors,  Prev: Link Variable Substitution,  Up: Configuring

Configuring Button Colors
-------------------------

When Hyperbole is run under a window system together with InfoDock,
Emacs 19, 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 `hsite.el' file changes
the color used to highlight and flash explicit buttons.

   Additionally, if HPROPERTY:BUT-EMPHASIZE-P is set to `t' in
`hsite.el', 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.


File: hyperbole.info,  Node: Smart Key Reference,  Next: Outliner Keys,  Prev: Installation,  Up: Top

Smart Key Reference
*******************

This appendix supplies complete documentation on Smart Key operation.
It is quite extensive and is meant for reference rather than sequential
reading.  *Note Smart Keys::, 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.

   Smart Key operations are context-sensitive.  Contexts are described
herein as 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
listed.

* Menu:

* Smart Mouse Keys::
* Smart Keyboard Keys::


File: hyperbole.info,  Node: Smart Mouse Keys,  Next: Smart Keyboard Keys,  Prev: Smart Key Reference,  Up: Smart Key Reference

Smart Mouse Keys
================

Smart Key drags and modeline presses are supported only when running
under a window system with mouse key support.  So keep in mind that the
operations in this section apply only if you have mouse support within
Hyperbole.  The Smart Key operations in *Note Smart Keyboard Keys::,
apply to both mouse and keyboard Smart Key usage.

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.

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.

If dragged horizontally within a single window
(`hmouse-x-drag-sensitivity' sets the minimal horizontal movement which
registers a drag):
  ACTION KEY
     Goes to the end of the buffer if the drag was to the right,
     otherwise goes to the beginning of the buffer.
  ASSIST KEY
     Splits the window vertically if the drag was to the right,
     otherwise deletes the window.

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 functions listed in `action-key-modeline-hook' are 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 functions listed in `assist-key-modeline-hook' are 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.

If dragged vertically within a single window while depressed
(`hmouse-y-drag-sensitivity' sets the minimal vertical movement which
registers a drag):
  ACTION KEY or ASSIST KEY
     Splits the current window into two side-by-side windows.

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 current window configuration 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.

If an active (highlighted) region exists within the editor:
  ACTION KEY or ASSIST KEY
     Pastes the region within the window clicked upon.


File: hyperbole.info,  Node: Smart Keyboard Keys,  Prev: Smart Mouse Keys,  Up: Smart Key Reference

Smart Keyboard Keys
===================

When prompting for a Hyperbole argument, a press in the minibuffer:
  ACTION KEY
     Accepts the current minibuffer argument.
  ASSIST KEY
     Offers completion help 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.

If in ID-edit mode (a package from BeOpen.com that supports
rapid killing, copying, yanking and display-management):
  ACTION KEY or ASSIST KEY
     Yanks (pastes) last selected region at point.

When pressed at the end of a line but not the end of a buffer:
  ACTION KEY
     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, scrolls up (forward) a windowful.  Otherwise, tries to
     bring the current line to the top of the window.  Leaves point at
     the end of the line and returns t if scrolled, nil if not.
  ASSIST KEY
     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, scrolls down (backward) a windowful.  Otherwise, tries
     to bring the current line to the bottom of the window.  Leaves
     point at the end of the line and returns t if scrolled, nil if not.

When pressed on a Smart Menu item:
  ACTION KEY
    Activates the item.
  ASSIST KEY
    Displays help for the item.

When pressed on a Hyperbole button:
  ACTION KEY
     Activates the button.
  ASSIST KEY
     Displays help for the button, typically a summary of its
     attributes.

If the Smart Menu package 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).

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.

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 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.

When pressed at the end of a Help buffer:
  ACTION KEY or ASSIST KEY
    Restores the window configuration prior to the help display.

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-dirs' and `smart-c-include-dirs';
     (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.

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-dirs';
     (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.

When pressed on a Lisp symbol within a Lisp code buffer:
  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 using
     the "wtags" package and the identifier is an Emacs Lisp symbol,
     then this displays the documentation for the symbol.

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-dirs';
     (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-dirs';
     (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.

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-dirs' and `smart-c-include-dirs';
     (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.

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-dirs' and `smart-c-include-dirs';
     (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.

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-dirs' and `objc-include-dirs';
     (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.

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-dirs' and `objc-include-dirs';
     (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.

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.

When pressed within an occur-mode or moccur-mode buffer:
  ACTION KEY or ASSIST KEY
     Jumps to the source buffer and line of the current occurrence.

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.

When pressed within a man page apropos buffer:
  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.

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.
  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.

If pressed within an outline-mode buffer or when `selective-display' is
non-nil:
  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.

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.

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.

If pressed within the Gnus newsgroups listing buffer:
  ACTION KEY
     (1) on a GNUS-GROUP line, that newsgroup is read;
     (2) to the left of any GNUS-GROUP line, within any of the
         whitespace, the current group is unsubscribed or resubscribed;
     (3) 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) 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;
     (3) at the end of the GNUS-GROUP buffer after all lines, the
         newsreader is quit.

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.

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.

If pressed within a dired-mode buffer:
  ACTION KEY
     (1) within 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 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.

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.

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.

If pressed on a World-Wide Web universal resource locator:
  ACTION KEY
     Displays the referent for the URL at point.
  ASSIST KEY
     Goes back to a previously displayed web page.

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.

If pressed within an entry in the wrolo search matches buffer:
  ACTION KEY or ASSIST KEY
     The entry is edited in the other window.

If pressed within an unrecognized context:
  ACTION KEY
     Runs the function stored in ACTION-KEY-DEFAULT-FUNCTION.
  ASSIST KEY
     Runs the function stored in ASSIST-KEY-DEFAULT-FUNCTION.


File: hyperbole.info,  Node: Outliner Keys,  Next: Suggestion or Bug Reporting,  Prev: Smart Key Reference,  Up: Top

Outliner 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, RELATIVE-LEVEL 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-TO-CELL 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.

`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-CELL-REF.  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-CELL-REF.  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.

`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.

`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.

`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:indent-tabs-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.

`kotl-mode: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).

`kotl-mode:insert-register  {C-c 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 non-positive number, nothing is done.

`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-CELL-REF.  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-CELL-REF.  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.

`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}'
     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.

`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.

`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.

`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.

`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.



File: hyperbole.info,  Node: Suggestion or Bug Reporting,  Next: Questions and Answers,  Prev: Outliner Keys,  Up: Top

Suggestion or Bug Reporting
***************************

If you find any errors in Hyperbole's operation or documentation, feel
free to report them to <hyperbole@beopen.com>.  Be sure to use the
Msg/Compose-Hypb-Mail 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 (*note Buttons in Mail::) a
click with 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 your editor, Hyperbole and window system versions in
your message.  Your Hyperbole version number can be found in the
top-level Hyperbole menu.

   Please use your subject line to state the position that your message
takes on the topic that it addresses, e.g. send "Subject: Basic bug in
top-level Hyperbole menu." rather than "Subject: Hyperbole bug".  This
simple rule makes all e-mail communication much easier.

   If you have suggestions on how to improve Hyperbole, send them to the
same address.  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?


File: hyperbole.info,  Node: Questions and Answers,  Next: Future Work,  Prev: Suggestion or Bug Reporting,  Up: Top

Questions and Answers
*********************

_How can I change the Smart Mouse Key bindings?_
     Since the Smart Mouse Keys are set up for use under five different
     Emacs configurations, there is no easy way to provide user level
     customization.  The command, `(hmouse-shift-buttons)', can be used
     to select between shifted and unshifted Smart Mouse Keys.  Any
     other mouse key binding changes must be done by editing the
     `(hmouse-setup)' and `(hmouse-get-bindings)' functions in the
     `hmouse-sh.el' and `hmouse-reg.el' files.

     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 particular contexts.  You should then update the
     Smart Key summary documentation in the file, `etc/hypb-mouse.txt',
     and potentially the same summary in this manual.

_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.

     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.

_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.

_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 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.

_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.



File: hyperbole.info,  Node: Future Work,  Next: References,  Prev: Questions and Answers,  Up: Top

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.  This
     will be implemented only for versions of Emacs 19 and higher.  It
     will 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.

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.

Outliner View Mode
     This will complement the outliner editing mode by using simple one
     character keys that normally insert characters to instead modify
     the view of an outline and to move around in it, for ease of study.
     Switching between view and edit modes will also be simple.

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:

                POSITIVE                        NEGATIVE
     
     Button data in source file
                Documents can stand alone.      All edit operators have
                Normal file operations apply.   to account for file
                                                structure and hide
                Simplifies creation and         internal components.
                facility expansion for
                structured and multimedia
                files.
     
     Button data external to source file
                Files can be displayed and      Currently, attributes for
                printed exactly as they look.   a whole directory are
                No special display formatting   locked when any button
                is necessary.                   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.)



File: hyperbole.info,  Node: References,  Next: Key Index,  Prev: Future Work,  Up: Top

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.

[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. 237-256.

[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.



File: hyperbole.info,  Node: Key Index,  Next: Code and File Index,  Prev: References,  Up: Top

Key Index
*********

* Menu:

* ,:                                     Rolo Keys.
* .:                                     Rolo Keys.
* <:                                     Rolo Keys.
* <DEL>:                                 Rolo Keys.
* <SPC>:                                 Rolo Keys.
* <TAB>:                                 Relocating and Copying.
* >:                                     Rolo Keys.
* a:                                     Rolo Keys.
* Action Key:                            Smart Keys.
* Action Key, cell argument:             Relocating and Copying.
* Action Key, hide or show cell:         Hiding and Showing.
* Action Key, klink:                     Links.
* Action Key, web browsing:              Implicit Buttons.
* Assist Key:                            Smart Keys.
* Assist Key, listing attributes:        Cell Attributes.
* b:                                     Rolo Keys.
* C-c $:                                 Moving Around.
* C-c +:                                 Splitting and Appending.
* C-c ,:                                 Moving Around.
* C-c .:                                 Moving Around.
* C-c <:                                 Moving Around.
* C-c >:                                 Moving Around.
* C-c @:                                 Relocating and Copying.
* C-c ^:                                 Moving Around.
* C-c a:                                 Adding and Killing.
* C-c b:                                 View Specs.
* C-c c:                                 Relocating and Copying.
* C-c C-a:                               Hiding and Showing.
* C-c C-b:                               Moving Around.
* C-c C-c:                               Relocating and Copying.
* C-c C-d:                               Moving Around.
* C-c C-f:                               Moving Around.
* C-c C-h:                               Hiding and Showing.
* C-c C-i:                               Cell Attributes.
* C-c C-k:                               Adding and Killing.
* C-c C-l:                               Autonumbering.
* C-c C-m:                               Relocating and Copying.
* C-c C-n:                               Moving Around.
* C-c C-o:                               Hiding and Showing.
* C-c C-p:                               Moving Around.
* C-c C-r:                               Renaming.
* C-c C-s:                               Hiding and Showing.
* C-c C-t:                               Hiding and Showing.
* C-c C-u:                               Moving Around.
* C-c C-v:                               View Specs.
* C-c C-y:                               Buttons in Mail.
* C-c e:                                 Transposing.
* C-c h:                                 Cell Attributes.
* C-c k:                                 Adding and Killing.
* C-c l:                                 Links.
* C-c m:                                 Relocating and Copying.
* C-c M-c:                               Relocating and Copying.
* C-c M-j:                               Filling.
* C-c M-l:                               Autonumbering.
* C-c M-q:                               Filling.
* C-c p:                                 Adding and Killing.
* C-c s:                                 Splitting and Appending.
* C-c t <1>:                             Transposing.
* C-c t:                                 Smart Key Assignments.
* C-g:                                   Menus.
* C-h A:                                 Smart Key Operations.
* C-h h <1>:                             Installing.
* C-h h:                                 Menus.
* C-h t:                                 Hyperbole Overview.
* C-j:                                   Adding and Killing.
* C-M-h:                                 Hiding and Showing.
* C-M-j:                                 Filling.
* C-M-q:                                 Filling.
* C-M-x:                                 Creating Types.
* C-r:                                   Rolo Keys.
* C-t:                                   Menus.
* C-u C-c c:                             Relocating and Copying.
* C-u C-c C-c:                           Relocating and Copying.
* C-u C-c C-m:                           Relocating and Copying.
* C-u C-c h:                             Cell Attributes.
* C-u C-c k:                             Adding and Killing.
* C-u C-c m:                             Relocating and Copying.
* C-u C-c M-l:                           Autonumbering.
* C-u C-c s:                             Splitting and Appending.
* C-u c-j:                               Adding and Killing.
* C-u C-x i:                             Inserting and Importing.
* C-u M-<RET>:                           Smart Key Assignments.
* C-u M-o:                               By Dragging.
* C-x $:                                 Hiding and Showing.
* C-x C-e:                               Creating Types.
* C-x i:                                 Inserting and Importing.
* C-x m:                                 Buttons in Mail.
* C-x o:                                 By Dragging.
* C-y:                                   Adding and Killing.
* e:                                     Rolo Keys.
* f:                                     Rolo Keys.
* h:                                     Rolo Keys.
* M-0 C-c t:                             Transposing.
* M-1 <TAB>:                             Relocating and Copying.
* M-<RET> <1>:                           Hiding and Showing.
* M-<RET>:                               Smart Key Assignments.
* M-<TAB>:                               Relocating and Copying.
* M-j:                                   Filling.
* M-o:                                   By Dragging.
* M-q:                                   Filling.
* M-s:                                   Rolo Keys.
* M-TAB:                                 Rolo Keys.
* n:                                     Rolo Keys.
* p:                                     Rolo Keys.
* q <1>:                                 Rolo Keys.
* q:                                     Menus.
* r:                                     Rolo Keys.
* s:                                     Rolo Keys.
* t:                                     Rolo Keys.
* TAB:                                   Rolo Keys.
* u:                                     Rolo Keys.


File: hyperbole.info,  Node: Code and File Index,  Next: Concept Index,  Prev: Key Index,  Up: Top

Code and File Index
*******************

* Menu:

* action-key:                            Smart Key Assignments.
* action-key-default-function <1>:       Smart Key Operations.
* action-key-default-function:           Smart Keyboard Keys.
* action-key-modeline-hook:              Smart Mouse Keys.
* action-mouse-key:                      Smart Key Assignments.
* action:act-hook:                       Hook Variables.
* actype:create:                         Action Type Creation.
* actype:delete:                         Action Type Creation.
* actypes::annot-bib:                    Action Types.
* actypes::completion:                   Action Types.
* actypes::eval-elisp:                   Action Types.
* actypes::exec-kbd-macro:               Action Types.
* actypes::exec-shell-cmd:               Action Types.
* actypes::exec-window-cmd:              Action Types.
* actypes::function-in-buffer:           Action Types.
* actypes::hyp-config:                   Action Types.
* actypes::hyp-request:                  Action Types.
* actypes::hyp-source:                   Action Types.
* actypes::kbd-key:                      Action Types.
* actypes::link-to-buffer-tmp:           Action Types.
* actypes::link-to-directory:            Action Types.
* actypes::link-to-doc:                  Action Types.
* actypes::link-to-ebut:                 Action Types.
* actypes::link-to-elisp-doc:            Action Types.
* actypes::link-to-file:                 Action Types.
* actypes::link-to-file-line:            Action Types.
* actypes::link-to-Info-node:            Action Types.
* actypes::link-to-kcell:                Action Types.
* actypes::link-to-kotl:                 Action Types.
* actypes::link-to-mail:                 Action Types.
* actypes::link-to-regexp-match:         Action Types.
* actypes::link-to-rfc:                  Action Types.
* actypes::link-to-string-match:         Action Types.
* actypes::link-to-texinfo-node:         Action Types.
* actypes::man-show:                     Action Types.
* actypes::rfc-toc:                      Action Types.
* actypes::text-toc:                     Action Types.
* actypes::www-url:                      Action Types.
* add-hook:                              Hook Variables.
* assist-key:                            Smart Key Assignments.
* assist-key-default-function <1>:       Smart Key Operations.
* assist-key-default-function:           Smart Keyboard Keys.
* assist-key-modeline-hook:              Smart Mouse Keys.
* assist-mouse-key:                      Smart Key Assignments.
* browse-url-browser-function <1>:       Action Types.
* browse-url-browser-function:           Implicit Buttons.
* c++-cpp-include-dirs:                  Smart Keyboard Keys.
* c++-include-dirs:                      Smart Keyboard Keys.
* class, ebut <1>:                       Programmatic Button Creation.
* class, ebut:                           Operational and Storage Formats.
* class, hargs:                          Action Type Creation.
* class, hattr:                          Implicit Button Types.
* class, hbdata:                         Operational and Storage Formats.
* class, hbut <1>:                       Operational and Storage Formats.
* class, hbut:                           Implicit Button Types.
* class, htype:                          Creating Types.
* defact:                                Action Type Creation.
* defib:                                 Implicit Button Types.
* dir, ~/.hyperb:                        Button Files.
* ebut:create:                           Programmatic Button Creation.
* ebut:create-hook:                      Hook Variables.
* ebut:delete-hook:                      Hook Variables.
* ebut:map:                              Programmatic Button Creation.
* ebut:max-len:                          Glossary.
* ebut:modify-hook:                      Hook Variables.
* emacs-version:                         Discussion Forums.
* eval-defun:                            Creating Types.
* eval-last-sexp:                        Creating Types.
* file, .hypb:                           Explicit Buttons.
* file, .kotl suffix:                    Creating Outlines.
* file, .~/.emacs:                       Renaming.
* file, DEMO:                            Hyperbole Overview.
* file, DIR:                             Implicit Buttons.
* file, EXAMPLE.kotl:                    Outliner.
* file, func-menu.el:                    Implicit Buttons.
* file, hactypes.el <1>:                 Action Type Creation.
* file, hactypes.el:                     Creating Types.
* file, hbut.el <1>:                     Action Type Creation.
* file, hbut.el:                         Programmatic Button Creation.
* file, hgnus.el:                        Buttons in News.
* file, hib-kbd.el:                      Implicit Button Types.
* file, hibtypes.el <1>:                 Creating Types.
* file, hibtypes.el:                     Implicit Buttons.
* file, hmail.el:                        Buttons in Mail.
* file, hmouse-key.el:                   Questions and Answers.
* file, hmouse-reg.el:                   Questions and Answers.
* file, hmouse-sh.el:                    Questions and Answers.
* file, hsite.el <1>:                    Renaming.
* file, hsite.el <2>:                    External Viewers.
* file, hsite.el <3>:                    Buttons in News.
* file, hsite.el <4>:                    Button Colors.
* file, hsite.el <5>:                    Internal Viewers.
* file, hsite.el <6>:                    Configuring.
* file, hsite.el <7>:                    Smart Key Assignments.
* file, hsite.el <8>:                    Installation.
* file, hsite.el:                        Installing.
* file, hsys-*:                          Encapsulating Systems.
* file, hui-ep*.el:                      Button Colors.
* file, hui-window.el:                   Questions and Answers.
* file, hversion.el:                     Installing.
* file, HY-README:                       Installation.
* file, HYPB:                            Menus.
* file, hyperbole.el <1>:                Installing.
* file, hyperbole.el:                    Configuring.
* file, Makefile:                        Installing.
* file, man/hyperbole.info:              Installing.
* file, man/hyperbole.texi:              Installing.
* file, MANIFEST:                        Implicit Buttons.
* file, wconfig.el:                      Window Configurations.
* file, wrolo.el:                        Rolo.
* file, ~/.emacs <1>:                    Smart Key Assignments.
* file, ~/.emacs <2>:                    Buttons in Mail.
* file, ~/.emacs <3>:                    Installing.
* file, ~/.emacs:                        Autonumbering.
* fill-column:                           Outliner Keys.
* fill-prefix:                           Button Label Normalization.
* find-file:                             Using URLs with Find-File.
* find-file-hooks:                       Hook Variables.
* gbut:file:                             Glossary.
* hbmap:dir-user:                        Button Files.
* hbmap:filename:                        Button Files.
* hbut:current <1>:                      Hook Variables.
* hbut:current:                          Operational and Storage Formats.
* hbut:fill-prefix-regexps:              Button Label Normalization.
* hbut:label-to-key:                     Button Label Normalization.
* hibtypes:begin-load-hook:              Hook Variables.
* hibtypes:end-load-hook:                Hook Variables.
* hkey-alist:                            Questions and Answers.
* hkey-always-display-menu:              Smart Keyboard Keys.
* hkey-init <1>:                         Smart Key Operations.
* hkey-init:                             Smart Key Assignments.
* hkey-operate:                          By Dragging.
* hmail:lister:                          Smart Keyboard Keys.
* hmail:reader:                          Smart Keyboard Keys.
* hmouse-alist:                          Questions and Answers.
* hmouse-get-bindings:                   Questions and Answers.
* hmouse-setup:                          Questions and Answers.
* hmouse-shift-buttons <1>:              Smart Key Assignments.
* hmouse-shift-buttons:                  Questions and Answers.
* hmouse-toggle-bindings:                Smart Key Assignments.
* hmouse-x-diagonal-sensitivity:         Smart Mouse Keys.
* hmouse-x-drag-sensitivity:             Smart Mouse Keys.
* hmouse-y-diagonal-sensitivity:         Smart Mouse Keys.
* hmouse-y-drag-sensitivity:             Smart Mouse Keys.
* hpath:at-p:                            Implicit Buttons.
* hpath:display-alist:                   Internal Viewers.
* hpath:find:                            Implicit Buttons.
* hpath:find-alist:                      External Viewers.
* hpath:suffixes:                        Implicit Buttons.
* hpath:variables:                       Link Variable Substitution.
* hproperty:but-create:                  Button Colors.
* hproperty:but-emphasize-p:             Button Colors.
* hproperty:cycle-but-color:             Button Colors.
* htype:create-hook:                     Hook Variables.
* htype:delete-hook:                     Hook Variables.
* hui:ebut-delete-confirm-p:             Deletion.
* hui:ebut-prompt-for-action:            Action Types.
* hui:ebut-rename:                       Renaming.
* hyperb:dir:                            Installing.
* hyperb:find-file-urls-mode:            Using URLs with Find-File.
* hyperb:init-hook:                      Hook Variables.
* hyperbole:                             Installing.
* ibtype:create:                         Implicit Button Types.
* ibtype:delete:                         Implicit Button Types.
* ibtypes::annot-bib:                    Implicit Buttons.
* ibtypes::completion:                   Implicit Buttons.
* ibtypes::cscope:                       Implicit Buttons.
* ibtypes::ctags:                        Implicit Buttons.
* ibtypes::debugger-source:              Implicit Buttons.
* ibtypes::dir-summary:                  Implicit Buttons.
* ibtypes::doc-id:                       Implicit Buttons.
* ibtypes::elisp-compiler-msg:           Implicit Buttons.
* ibtypes::etags:                        Implicit Buttons.
* ibtypes::function-in-buffer:           Implicit Buttons.
* ibtypes::gnus-push-button:             Implicit Buttons.
* ibtypes::grep-msg:                     Implicit Buttons.
* ibtypes::hyp-address:                  Implicit Buttons.
* ibtypes::hyp-source:                   Implicit Buttons.
* ibtypes::id-cflow:                     Implicit Buttons.
* ibtypes::Info-node:                    Implicit Buttons.
* ibtypes::kbd-key:                      Implicit Buttons.
* ibtypes::klink:                        Implicit Buttons.
* ibtypes::mail-address:                 Implicit Buttons.
* ibtypes::man-apropos:                  Implicit Buttons.
* ibtypes::patch-msg:                    Implicit Buttons.
* ibtypes::pathname:                     Implicit Buttons.
* ibtypes::rfc:                          Implicit Buttons.
* ibtypes::rfc-toc:                      Implicit Buttons.
* ibtypes::texinfo-ref:                  Implicit Buttons.
* ibtypes::text-toc:                     Implicit Buttons.
* ibtypes::www-url:                      Implicit Buttons.
* ibut:at-p:                             Implicit Button Types.
* Info-directory-list:                   Installing.
* Info-global-next:                      Smart Keyboard Keys.
* Info-global-prev:                      Smart Keyboard Keys.
* interactive:                           Action Type Creation.
* kcell:ref-to-id:                       Action Types.
* kexport:html:                          Exporting.
* kfile:find:                            Menu Commands.
* kfile:write:                           Outliner Keys.
* kill-ring:                             Window Configurations.
* kimport:aug-post-outline:              Inserting and Importing.
* kimport:file:                          Inserting and Importing.
* kimport:mode-alist:                    Inserting and Importing.
* kimport:star-outline:                  Inserting and Importing.
* kimport:suffix-alist:                  Inserting and Importing.
* kimport:text:                          Inserting and Importing.
* klink:create <1>:                      Outliner Keys.
* klink:create:                          Menu Commands.
* kotl-mode:                             Inserting and Importing.
* kotl-mode-hook:                        Hook Variables.
* kotl-mode:add-cell:                    Outliner Keys.
* kotl-mode:add-child:                   Outliner Keys.
* kotl-mode:add-parent:                  Outliner Keys.
* kotl-mode:append-cell:                 Outliner Keys.
* kotl-mode:back-to-indentation:         Outliner Keys.
* kotl-mode:backward-cell:               Outliner Keys.
* kotl-mode:backward-char:               Outliner Keys.
* kotl-mode:backward-kill-word:          Outliner Keys.
* kotl-mode:backward-sentence:           Outliner Keys.
* kotl-mode:backward-word:               Outliner Keys.
* kotl-mode:beginning-of-buffer:         Outliner Keys.
* kotl-mode:beginning-of-cell:           Outliner Keys.
* kotl-mode:beginning-of-line:           Outliner Keys.
* kotl-mode:beginning-of-tree:           Outliner Keys.
* kotl-mode:cell-attributes:             Outliner Keys.
* kotl-mode:cell-help:                   Outliner Keys.
* kotl-mode:center-line:                 Outliner Keys.
* kotl-mode:center-paragraph:            Outliner Keys.
* kotl-mode:copy-after:                  Outliner Keys.
* kotl-mode:copy-before:                 Outliner Keys.
* kotl-mode:copy-to-buffer:              Outliner Keys.
* kotl-mode:copy-to-register:            Outliner Keys.
* kotl-mode:delete-backward-char:        Outliner Keys.
* kotl-mode:delete-blank-lines:          Outliner Keys.
* kotl-mode:delete-char:                 Outliner Keys.
* kotl-mode:delete-indentation:          Outliner Keys.
* kotl-mode:demote-tree:                 Outliner Keys.
* kotl-mode:down-level:                  Outliner Keys.
* kotl-mode:end-of-buffer:               Outliner Keys.
* kotl-mode:end-of-cell:                 Outliner Keys.
* kotl-mode:end-of-line:                 Outliner Keys.
* kotl-mode:end-of-tree:                 Outliner Keys.
* kotl-mode:example:                     Outliner Keys.
* kotl-mode:exchange-cells:              Outliner Keys.
* kotl-mode:fill-cell:                   Outliner Keys.
* kotl-mode:fill-paragraph:              Outliner Keys.
* kotl-mode:fill-tree:                   Outliner Keys.
* kotl-mode:first-sibling:               Outliner Keys.
* kotl-mode:fkey-backward-char:          Outliner Keys.
* kotl-mode:fkey-forward-char:           Outliner Keys.
* kotl-mode:fkey-next-line:              Outliner Keys.
* kotl-mode:fkey-previous-line:          Outliner Keys.
* kotl-mode:forward-cell:                Outliner Keys.
* kotl-mode:forward-char:                Outliner Keys.
* kotl-mode:forward-para:                Outliner Keys.
* kotl-mode:forward-paragraph:           Outliner Keys.
* kotl-mode:forward-sentence:            Outliner Keys.
* kotl-mode:forward-word:                Outliner Keys.
* kotl-mode:goto-cell:                   Outliner Keys.
* kotl-mode:hide-sublevels <1>:          Outliner Keys.
* kotl-mode:hide-sublevels:              Menu Commands.
* kotl-mode:hide-subtree:                Outliner Keys.
* kotl-mode:hide-tree <1>:               Menu Commands.
* kotl-mode:hide-tree:                   Outliner Keys.
* kotl-mode:indent-line:                 Outliner Keys.
* kotl-mode:indent-region:               Outliner Keys.
* kotl-mode:indent-tabs-mode:            Relocating and Copying.
* kotl-mode:insert-file:                 Outliner Keys.
* kotl-mode:insert-file-contents:        Inserting and Importing.
* kotl-mode:insert-register:             Outliner Keys.
* kotl-mode:just-one-space:              Outliner Keys.
* kotl-mode:kill-contents:               Outliner Keys.
* kotl-mode:kill-line:                   Outliner Keys.
* kotl-mode:kill-region:                 Outliner Keys.
* kotl-mode:kill-ring-save:              Outliner Keys.
* kotl-mode:kill-sentence:               Outliner Keys.
* kotl-mode:kill-tree <1>:               Menu Commands.
* kotl-mode:kill-tree:                   Outliner Keys.
* kotl-mode:kill-word:                   Outliner Keys.
* kotl-mode:last-sibling:                Outliner Keys.
* kotl-mode:mail-tree:                   Outliner Keys.
* kotl-mode:move-after:                  Outliner Keys.
* kotl-mode:move-before:                 Outliner Keys.
* kotl-mode:newline:                     Outliner Keys.
* kotl-mode:next-cell:                   Outliner Keys.
* kotl-mode:next-line:                   Outliner Keys.
* kotl-mode:open-line:                   Outliner Keys.
* kotl-mode:overview <1>:                Menu Commands.
* kotl-mode:overview:                    Outliner Keys.
* kotl-mode:previous-cell:               Outliner Keys.
* kotl-mode:previous-line:               Outliner Keys.
* kotl-mode:promote-tree:                Outliner Keys.
* kotl-mode:refill-flag:                 Filling.
* kotl-mode:scroll-down:                 Outliner Keys.
* kotl-mode:scroll-up:                   Outliner Keys.
* kotl-mode:set-cell-attribute:          Outliner Keys.
* kotl-mode:set-fill-prefix:             Outliner Keys.
* kotl-mode:show-all <1>:                Menu Commands.
* kotl-mode:show-all:                    Outliner Keys.
* kotl-mode:show-subtree:                Outliner Keys.
* kotl-mode:show-tree <1>:               Menu Commands.
* kotl-mode:show-tree:                   Outliner Keys.
* kotl-mode:split-cell:                  Outliner Keys.
* kotl-mode:top-cells <1>:               Menu Commands.
* kotl-mode:top-cells:                   Outliner Keys.
* kotl-mode:transpose-cells:             Outliner Keys.
* kotl-mode:transpose-chars:             Outliner Keys.
* kotl-mode:transpose-lines:             Outliner Keys.
* kotl-mode:transpose-words:             Outliner Keys.
* kotl-mode:up-level:                    Outliner Keys.
* kotl-mode:yank:                        Outliner Keys.
* kotl-mode:yank-pop:                    Outliner Keys.
* kotl-mode:zap-to-char:                 Outliner Keys.
* kview:default-label-separator:         Autonumbering.
* kview:default-label-type:              View Specs.
* kview:set-label-separator:             Outliner Keys.
* kview:set-label-type:                  Outliner Keys.
* kvspec:activate <1>:                   Outliner Keys.
* kvspec:activate:                       Menu Commands.
* kvspec:string:                         View Specs.
* kvspec:toggle-blank-lines <1>:         Menu Commands.
* kvspec:toggle-blank-lines:             Outliner Keys.
* mail:                                  Buttons in Mail.
* mail-yank-original:                    Buttons in Mail.
* objc-cpp-include-dirs:                 Smart Keyboard Keys.
* objc-include-dirs:                     Smart Keyboard Keys.
* rolo-add:                              Rolo Menu.
* rolo-display-format-function:          Rolo Settings.
* rolo-display-matches:                  Rolo Menu.
* rolo-edit:                             Rolo Menu.
* rolo-email-format:                     Rolo Settings.
* rolo-entry-regexp:                     Rolo Settings.
* rolo-fgrep:                            Rolo Menu.
* rolo-file-list:                        Rolo Settings.
* rolo-grep:                             Rolo Menu.
* rolo-hdr-regexp:                       Rolo Settings.
* rolo-highlight-face:                   Rolo Settings.
* rolo-kill:                             Rolo Menu.
* rolo-kill-buffers-after-use:           Rolo Settings.
* rolo-mail-to:                          Rolo Menu.
* rolo-save-buffers-after-use:           Rolo Settings.
* rolo-sort:                             Rolo Menu.
* rolo-word:                             Rolo Menu.
* rolo-yank:                             Rolo Menu.
* run-hooks:                             Glossary.
* selective-display:                     Smart Keyboard Keys.
* sm-notify:                             Action Types.
* smail:comment:                         Buttons in Mail.
* smart-asm-include-dirs:                Smart Keyboard Keys.
* smart-c-cpp-include-dirs:              Smart Keyboard Keys.
* smart-c-include-dirs:                  Smart Keyboard Keys.
* smart-c-use-lib-man:                   Smart Keyboard Keys.
* smart-java-package-dirs:               Smart Keyboard Keys.
* smart-man-c-routine-ref:               Smart Keyboard Keys.
* smart-scroll-proportional <1>:         Smart Keyboard Keys.
* smart-scroll-proportional:             Glossary.
* wconfig-add-by-name:                   Window Configurations.
* wconfig-delete-by-name:                Window Configurations.
* wconfig-delete-pop:                    Window Configurations.
* wconfig-restore-by-name:               Window Configurations.
* wconfig-ring-max:                      Window Configurations.
* wconfig-ring-save:                     Window Configurations.
* wconfig-yank-pop:                      Window Configurations.
* write-file-hooks:                      Hook Variables.
* wrolo-add-hook <1>:                    Hook Variables.
* wrolo-add-hook:                        Rolo Keys.
* wrolo-display-hook:                    Hook Variables.
* wrolo-edit-hook <1>:                   Hook Variables.
* wrolo-edit-hook:                       Rolo Keys.
* wrolo-mode-hook:                       Hook Variables.
* wrolo-yank-reformat-function:          Hook Variables.


File: hyperbole.info,  Node: Concept Index,  Prev: Code and File Index,  Up: Top

Concept Index
*************

* Menu:

* .tgz distribution:                     Obtaining.
* .zip distribution:                     Obtaining.
* <> delimiters:                         Links.
* <@ klink>:                             Links.
* <|viewspec>:                           View Specs.
* abbreviated URLs:                      Using URLs with Find-File.
* action:                                Action Types.
* Action Key:                            Smart Keys.
* Action Key drag:                       By Dragging.
* Action Key, cell argument:             Relocating and Copying.
* Action Key, hide or show cell:         Hiding and Showing.
* Action Key, klink:                     Links.
* Action Key, web browsing:              Implicit Buttons.
* action type:                           Action Types.
* action type, creation:                 Action Type Creation.
* activation:                            Smart Key Operations.
* active region:                         Smart Mouse Keys.
* actype, link-to-mail:                  Buttons in Mail.
* actypes, list of:                      Action Types.
* address:                               Implicit Buttons.
* alpha labels:                          Autonumbering.
* ange-ftp:                              Implicit Buttons.
* anonymous ftp:                         Top.
* API:                                   Embedding Hyperbole.
* appending to a cell:                   Splitting and Appending.
* argument entry:                        Entering Arguments.
* argument, Info node:                   Action Type Creation.
* argument, kcell:                       Action Type Creation.
* argument, klink:                       Action Type Creation.
* argument, koutline:                    Action Type Creation.
* argument, mail message:                Action Type Creation.
* argument, reading:                     Action Type Creation.
* argument, use:                         Action Types.
* argument, view spec:                   Action Type Creation.
* Assist Key:                            Smart Keys.
* Assist Key, listing attributes:        Cell Attributes.
* attribute:                             Cell Attributes.
* attribute, adding:                     Cell Attributes.
* attribute, modifying:                  Cell Attributes.
* attribute, no-fill <1>:                Splitting and Appending.
* attribute, no-fill <2>:                Cell Attributes.
* attribute, no-fill:                    Filling.
* attribute, removing:                   Cell Attributes.
* Augment <1>:                           Glossary.
* Augment:                               Outliner History.
* Augment outline:                       Inserting and Importing.
* autoloading Hyperbole:                 Installing.
* autonumber <1>:                        Autonumbering.
* autonumber:                            Outliner.
* bibliography:                          Implicit Buttons.
* blank lines, toggle:                   View Specs.
* breakpoint:                            Implicit Buttons.
* browsing URLs:                         Using URLs with Find-File.
* browsing URLs in find-file:            Using URLs with Find-File.
* buffer menu:                           Smart Keyboard Keys.
* building Hyperbole:                    Installing.
* button:                                Hyperbole Buttons.
* button action:                         Action Types.
* button activation:                     Smart Key Operations.
* button attribute:                      Explicit Buttons.
* button attributes:                     Operational and Storage Formats.
* button category:                       Hyperbole Buttons.
* button click:                          Smart Keyboard Keys.
* button data:                           Explicit Buttons.
* button data saving:                    Hook Variables.
* button demo:                           Hyperbole Overview.
* button emphasis:                       Button Colors.
* button file, directory:                Button Files.
* button file, HYPB:                     Menus.
* button file, personal:                 Button Files.
* button files:                          Button Files.
* button flashing:                       Button Colors.
* button help:                           Smart Key Operations.
* button highlighting <1>:               Hook Variables.
* button highlighting:                   Button Colors.
* button highlighting, forcing:          Button Colors.
* button instance:                       By Menu.
* button key:                            Button Label Normalization.
* button label <1>:                      Global Buttons.
* button label <2>:                      Button Label Normalization.
* button label:                          Explicit Buttons.
* button label overlap:                  Button Type Precedence.
* button precedence:                     Button Type Precedence.
* button, attributes:                    Modification.
* button, creation:                      By Dragging.
* button, deleting:                      Deletion.
* button, explicit <1>:                  Hyperbole Buttons.
* button, explicit:                      Explicit Buttons.
* button, global <1>:                    Global Buttons.
* button, global:                        Hyperbole Buttons.
* button, help:                          Location.
* button, implicit <1>:                  Implicit Buttons.
* button, implicit:                      Hyperbole Buttons.
* button, mailing:                       Buttons in Mail.
* button, modifying:                     Modification.
* button, moving:                        Explicit Buttons.
* button, multiple lines:                Button Label Normalization.
* button, posting <1>:                   Buttons in News.
* button, posting:                       Buttons in Mail.
* button, renaming:                      Renaming.
* button, searching:                     Location.
* button, split across lines:            Button Label Normalization.
* button, summarizing:                   Location.
* byte compiler error:                   Implicit Buttons.
* C call tree:                           Implicit Buttons.
* C flow graph:                          Implicit Buttons.
* C/C++ call trees:                      Implicit Buttons.
* C/C++ cross-reference:                 Implicit Buttons.
* call tree, C:                          Implicit Buttons.
* cell, adding:                          Adding and Killing.
* cell, appending:                       Splitting and Appending.
* cell, attribute:                       Cell Attributes.
* cell, collapse:                        Hiding and Showing.
* cell, creating:                        Adding and Killing.
* cell, creation time:                   Cell Attributes.
* cell, exchanging:                      Transposing.
* cell, expand:                          Hiding and Showing.
* cell, filling:                         Filling.
* cell, hide subtree:                    Hiding and Showing.
* cell, hiding levels:                   View Specs.
* cell, idstamp 0 <1>:                   Creating Outlines.
* cell, idstamp 0:                       Idstamps.
* cell, killing:                         Adding and Killing.
* cell, label separator:                 Autonumbering.
* cell, mark and point:                  Transposing.
* cell, no-fill attribute <1>:           Cell Attributes.
* cell, no-fill attribute <2>:           Splitting and Appending.
* cell, no-fill attribute:               Filling.
* cell, selection:                       Editing.
* cell, show all:                        Hiding and Showing.
* cell, show levels:                     Hiding and Showing.
* cell, show subtree:                    Hiding and Showing.
* cell, splitting:                       Splitting and Appending.
* cell, top-level <1>:                   Creating Outlines.
* cell, top-level:                       Idstamps.
* cell, transposing:                     Transposing.
* cell, yanking contents:                Adding and Killing.
* changing the view spec:                View Specs.
* click, buffer menu:                    Smart Keyboard Keys.
* click, button:                         Smart Keyboard Keys.
* click, dired:                          Smart Keyboard Keys.
* click, end of line:                    Smart Keyboard Keys.
* click, Gnus:                           Smart Keyboard Keys.
* click, Info:                           Smart Keyboard Keys.
* click, tar:                            Smart Keyboard Keys.
* click, world-wide web:                 Smart Keyboard Keys.
* click, wrolo matches:                  Smart Keyboard Keys.
* collaboration:                         Outliner History.
* collapse lines:                        View Specs.
* collapsing:                            Hiding and Showing.
* compiler error:                        Implicit Buttons.
* completion <1>:                        Implicit Buttons.
* completion:                            Entering Arguments.
* configuration <1>:                     Installing.
* configuration:                         Configuring.
* context:                               Implicit Buttons.
* context-sensitive help:                Smart Key Operations.
* copying:                               Relocating and Copying.
* create-time attribute:                 Cell Attributes.
* creator attribute:                     Cell Attributes.
* credits:                               Top.
* cross referencing:                     Outliner History.
* cross-reference, Texinfo:              Implicit Buttons.
* Cscope:                                Implicit Buttons.
* ctags entry:                           Implicit Buttons.
* customization <1>:                     Menus.
* customization:                         Configuring.
* customization, init:                   Installation.
* customization, rolo additions:         Rolo Keys.
* customization, rolo datestamps:        Rolo Keys.
* customization, rolo edits:             Rolo Keys.
* cutoff lines:                          View Specs.
* datestamps:                            Rolo Keys.
* dbx:                                   Implicit Buttons.
* default label type:                    View Specs.
* demonstration:                         Hyperbole Overview.
* demotion:                              Relocating and Copying.
* depress, modeline:                     Smart Mouse Keys.
* diagonal drag:                         Smart Mouse Keys.
* digital signature:                     Glossary.
* direct selection:                      Entering Arguments.
* dired browsing:                        Smart Keyboard Keys.
* display function:                      Internal Viewers.
* distributed collaboration:             Outliner History.
* document identifier:                   Implicit Buttons.
* double click:                          Entering Arguments.
* drag:                                  By Dragging.
* drag, diagonal:                        Smart Mouse Keys.
* drag, horizontal:                      Smart Mouse Keys.
* drag, side edge:                       Smart Mouse Keys.
* drag, vertical:                        Smart Mouse Keys.
* e-mail address <1>:                    Cell Attributes.
* e-mail address:                        Implicit Buttons.
* EFS <1>:                               Implicit Buttons.
* EFS:                                   Using URLs with Find-File.
* ellipses:                              View Specs.
* Emacs 19 <1>:                          Menus.
* Emacs 19:                              Hyperbole Overview.
* Emacs 19 support:                      Button Colors.
* Emacs Lisp:                            Hyperbole Overview.
* Emacs Lisp compiler error:             Implicit Buttons.
* Emacs Lisp variables:                  Link Variable Substitution.
* emacs outline:                         Inserting and Importing.
* enabling URLs in find-file:            Using URLs with Find-File.
* end of line click:                     Smart Keyboard Keys.
* Engelbart <1>:                         Outliner History.
* Engelbart:                             Glossary.
* environment variables:                 Link Variable Substitution.
* etags entry:                           Implicit Buttons.
* exchanging cells:                      Transposing.
* expanding:                             Hiding and Showing.
* explicit button <1>:                   Hyperbole Buttons.
* explicit button:                       Explicit Buttons.
* explicit button, creation <1>:         By Dragging.
* explicit button, creation:             Programmatic Button Creation.
* explicit button, deleting:             Deletion.
* explicit button, formats:              Operational and Storage Formats.
* explicit button, modifying:            Modification.
* explicit button, renaming:             Renaming.
* explicit button, searching:            Location.
* explicit button, storage:              Operational and Storage Formats.
* explicit button, summarizing:          Location.
* exporting:                             Exporting.
* exporting an outline:                  Relocating and Copying.
* external klink:                        Links.
* external program:                      External Viewers.
* external viewer:                       External Viewers.
* extracting from tar files:             Smart Keyboard Keys.
* file display function:                 Internal Viewers.
* file, importing:                       Inserting and Importing.
* filename:                              Implicit Buttons.
* fill prefix:                           Button Label Normalization.
* filling:                               Filling.
* find-file, browsing URLs:              Using URLs with Find-File.
* ftp:                                   Implicit Buttons.
* func-menu:                             Implicit Buttons.
* functions:                             Implicit Buttons.
* game, gomoku:                          Smart Keyboard Keys.
* gdb:                                   Implicit Buttons.
* global button <1>:                     Hyperbole Buttons.
* global button <2>:                     Button Files.
* global button:                         Global Buttons.
* global button, modify:                 Questions and Answers.
* GNU Emacs:                             Hyperbole Overview.
* Gnus <1>:                              Buttons in News.
* Gnus:                                  Buttons in Mail.
* Gnus browsing:                         Smart Keyboard Keys.
* GNUS push-buttons:                     Implicit Buttons.
* gomoku:                                Smart Keyboard Keys.
* grep:                                  Implicit Buttons.
* groupware:                             Glossary.
* gunzip:                                Obtaining.
* gzcat:                                 Obtaining.
* help, menu items:                      Menus.
* help, Smart Key:                       Smart Key Operations.
* hide levels:                           View Specs.
* hide lines:                            View Specs.
* hide subtree:                          Hiding and Showing.
* hide tree:                             Hiding and Showing.
* hiding:                                Hiding and Showing.
* hiding signatures:                     Implicit Buttons.
* history:                               Menus.
* hook variables:                        Hook Variables.
* horizontal drag:                       Smart Mouse Keys.
* HTML conversion:                       Exporting.
* HY-README file:                        Installation.
* Hyperbole:                             Hyperbole Overview.
* Hyperbole API:                         Embedding Hyperbole.
* Hyperbole applications:                Hyperbole Buttons.
* Hyperbole data model:                  Explicit Buttons.
* Hyperbole features:                    Hyperbole Buttons.
* Hyperbole help:                        Smart Key Operations.
* Hyperbole mail comment:                Buttons in Mail.
* Hyperbole mail list:                   Implicit Buttons.
* Hyperbole main menu:                   Installing.
* Hyperbole manual:                      Installing.
* Hyperbole report:                      Implicit Buttons.
* Hyperbole support:                     Top.
* Hyperbole types:                       Creating Types.
* Hyperbole version:                     Suggestion or Bug Reporting.
* Hyperbole, autoloading:                Installing.
* Hyperbole, building:                   Installing.
* Hyperbole, embedding:                  Embedding Hyperbole.
* Hyperbole, initializing:               Installing.
* Hyperbole, loading:                    Installing.
* Hyperbole, obtaining <1>:              Top.
* Hyperbole, obtaining:                  Obtaining.
* Hyperbole, starting:                   Installing.
* Hyperbole, system encapsulation:       Encapsulating Systems.
* hyperlink:                             Links.
* hyperlink anchor:                      Outliner.
* hypertext <1>:                         Glossary.
* hypertext:                             Hyperbole Overview.
* ibtype:                                Implicit Button Types.
* ibtype, actype:                        Implicit Button Types.
* ibtype, argument:                      Implicit Button Types.
* ibtype, evaluation order:              Button Type Precedence.
* ibtype, help:                          Implicit Button Types.
* ibtype, predicate:                     Implicit Button Types.
* ibtype, return val:                    Implicit Button Types.
* ibtypes, list of:                      Implicit Buttons.
* idea structuring:                      Outliner History.
* idstamp <1>:                           Idstamps.
* idstamp:                               Outliner.
* idstamp 0:                             Idstamps.
* idstamp attribute:                     Cell Attributes.
* idstamp counter:                       Idstamps.
* implicit button <1>:                   Hyperbole Buttons.
* implicit button:                       Implicit Buttons.
* implicit button type:                  Implicit Button Types.
* importing:                             Inserting and Importing.
* importing a file:                      Inserting and Importing.
* Info browsing:                         Smart Keyboard Keys.
* Info manual:                           Installing.
* Info node:                             Implicit Buttons.
* InfoDock:                              Menus.
* InfoDock Action Key:                   Smart Key Assignments.
* InfoDock Paste Key:                    Smart Key Assignments.
* InfoDock, obtaining:                   Top.
* initialization file:                   Autonumbering.
* initializing Hyperbole:                Installing.
* inserting tabs:                        Relocating and Copying.
* insertion:                             Inserting and Importing.
* installation <1>:                      Installation.
* installation:                          Installing.
* instance number:                       By Menu.
* interactive cmd char, +I:              Action Type Creation.
* interactive cmd char, +K:              Action Type Creation.
* interactive cmd char, +L:              Action Type Creation.
* interactive cmd char, +M:              Action Type Creation.
* interactive cmd char, +V:              Action Type Creation.
* interactive computing:                 Glossary.
* interactive form:                      Action Type Creation.
* internal klink:                        Links.
* internal viewer:                       Internal Viewers.
* Internet RFC:                          Implicit Buttons.
* invoking Hyperbole:                    Installing.
* kcell link:                            Implicit Buttons.
* key binding, smart keys:               Smart Key Assignments.
* key sequence:                          Implicit Buttons.
* klink <1>:                             Links.
* klink:                                 Implicit Buttons.
* klink referent:                        Links.
* klink, activating:                     Links.
* klink, external:                       Links.
* klink, formats:                        Links.
* klink, inserting:                      Links.
* klink, internal:                       Links.
* klink, view spec:                      Links.
* knowledge transfer:                    Outliner History.
* koutline link:                         Implicit Buttons.
* koutline mode:                         Inserting and Importing.
* Koutliner commands:                    Menu Commands.
* label separator, changing:             Autonumbering.
* label separator, default:              Autonumbering.
* label type:                            View Specs.
* label type, alpha <1>:                 View Specs.
* label type, alpha:                     Autonumbering.
* label type, asterisk:                  View Specs.
* label type, changing:                  Autonumbering.
* label type, idstamps:                  View Specs.
* label type, legal <1>:                 Autonumbering.
* label type, legal:                     View Specs.
* label type, no labels:                 View Specs.
* label type, partial alpha:             View Specs.
* label type, star:                      View Specs.
* legal labels:                          Autonumbering.
* level <1>:                             Hiding and Showing.
* level:                                 View Specs.
* link:                                  Links.
* link, creation <1>:                    By Dragging.
* link, creation:                        By Menu.
* link, display function:                Internal Viewers.
* link, pathname:                        Implicit Buttons.
* link, viewer program:                  External Viewers.
* linking, in-place:                     Explicit Buttons.
* Lisp variables:                        Link Variable Substitution.
* listing attributes:                    Cell Attributes.
* loading Hyperbole:                     Installing.
* logical rolo searches:                 Rolo Searching.
* mail address:                          Cell Attributes.
* mail comment:                          Buttons in Mail.
* mail hooks:                            Hook Variables.
* mail inclusion:                        Buttons in Mail.
* mail reader:                           Buttons in Mail.
* mailer initialization:                 Buttons in Mail.
* mailing an outline:                    Relocating and Copying.
* mailing buttons:                       Buttons in Mail.
* man apropos:                           Implicit Buttons.
* man page references:                   Smart Keyboard Keys.
* man pages:                             Implicit Buttons.
* margin:                                Filling.
* menu help:                             Menus.
* menu item, Find-File-Accepts-URLs:     Using URLs with Find-File.
* menu item, Find-File-URLs:             Using URLs with Find-File.
* menu item, RegexFind:                  Rolo Searching.
* menu item, Remove-This-Menu:           Menus.
* menu item, StringFind:                 Rolo Searching.
* menu item, WordFind:                   Rolo Searching.
* menu use:                              Menus.
* menu, Act:                             Menus.
* menu, ButFile:                         Menus.
* menu, Cust <1>:                        Configuring.
* menu, Cust:                            Menus.
* menu, Doc:                             Menus.
* menu, EBut:                            Menus.
* menu, Global Buttons:                  Menus.
* menu, History:                         Menus.
* menu, Implicit Buttons:                Menus.
* menu, Message:                         Menus.
* menu, Outline <1>:                     Outliner.
* menu, Outline:                         Menu Commands.
* menu, Outline/Example:                 Outliner.
* menu, Outliner:                        Menus.
* menu, Rolo:                            Menus.
* menu, Toggle-Rolo-Dates:               Rolo Keys.
* menu, top-level:                       Menus.
* menu, Types:                           Menus.
* menu, Window Configurations:           Menus.
* menu, Windows:                         Menus.
* menubar, Hyperbole menu:               Menus.
* MH-e:                                  Buttons in Mail.
* minibuffer menus:                      Menus.
* modeline depress:                      Smart Mouse Keys.
* modeline, view spec:                   View Specs.
* mouse:                                 Glossary.
* mouse key bindings:                    Questions and Answers.
* mouse key toggle:                      Smart Key Assignments.
* mouse paste:                           Smart Key Assignments.
* mouse support:                         Smart Keys.
* mouse, moving trees:                   Relocating and Copying.
* moving buttons:                        Explicit Buttons.
* named window configuration:            Window Configurations.
* news:                                  Buttons in Mail.
* news comment:                          Buttons in News.
* news hooks:                            Hook Variables.
* news reader/poster:                    Buttons in News.
* NLS:                                   Outliner History.
* no-fill attribute:                     Cell Attributes.
* normalized label:                      Button Label Normalization.
* obtaining Hyperbole:                   Obtaining.
* online library:                        Implicit Buttons.
* option settings:                       Menus.
* outline file suffix:                   Creating Outlines.
* outline mode:                          Inserting and Importing.
* outline processor:                     Glossary.
* outline structure:                     Autonumbering.
* outline, all cells:                    Hiding and Showing.
* outline, attribute list:               Cell Attributes.
* outline, conversion:                   Inserting and Importing.
* outline, creating:                     Creating Outlines.
* outline, exporting:                    Relocating and Copying.
* outline, exporting from:               Exporting.
* outline, filling:                      Filling.
* outline, foreign file:                 Inserting and Importing.
* outline, hiding:                       Hiding and Showing.
* outline, HTML conversion:              Exporting.
* outline, importing:                    Relocating and Copying.
* outline, importing into:               Inserting and Importing.
* outline, inserting into:               Inserting and Importing.
* outline, label separator:              Autonumbering.
* outline, label type:                   Autonumbering.
* outline, mailing:                      Relocating and Copying.
* outline, motion:                       Moving Around.
* outline, overview:                     Hiding and Showing.
* outline, show levels:                  Hiding and Showing.
* outline, showing:                      Hiding and Showing.
* outline, top-level:                    Hiding and Showing.
* outline, view specs:                   View Specs.
* outline, viewing:                      Viewing.
* outliner:                              Outliner.
* outliner commands:                     Menu Commands.
* outliner keys:                         Outliner Keys.
* overview:                              Hiding and Showing.
* paragraph, filling:                    Filling.
* Paste Key:                             Smart Key Assignments.
* pasting a region:                      Smart Mouse Keys.
* patch output:                          Implicit Buttons.
* pathname:                              Implicit Buttons.
* permanent identifier <1>:              Outliner.
* permanent identifier:                  Idstamps.
* PIEmail:                               Buttons in Mail.
* pipe character:                        View Specs.
* posting buttons:                       Buttons in Mail.
* posting news:                          Buttons in News.
* programming interface:                 Embedding Hyperbole.
* promotion:                             Relocating and Copying.
* proportional scrolling <1>:            Smart Keyboard Keys.
* proportional scrolling:                Glossary.
* README file:                           Installation.
* reference:                             Implicit Buttons.
* refilling:                             Filling.
* relative autonumber:                   Outliner.
* relative identifier:                   Autonumbering.
* remote path:                           Implicit Buttons.
* removing Hyperbole menu:               Menus.
* Request For Comment:                   Implicit Buttons.
* restoring windows:                     Window Configurations.
* RFC:                                   Implicit Buttons.
* RMAIL:                                 Buttons in Mail.
* rolo:                                  Rolo.
* rolo address:                          Implicit Buttons.
* rolo commands:                         Rolo Menu.
* rolo entry:                            Rolo Concepts.
* rolo file:                             Rolo Concepts.
* rolo keys:                             Rolo Keys.
* rolo menu:                             Rolo Menu.
* rolo searching:                        Rolo Searching.
* rolo, buttons in:                      Rolo.
* rolo, datestamps:                      Rolo Keys.
* rolo, editing:                         Rolo Keys.
* rolo, extending a match:               Rolo Keys.
* rolo, finding matches:                 Rolo Keys.
* rolo, highlighting matches <1>:        Rolo Keys.
* rolo, highlighting matches:            Rolo Settings.
* rolo, interactive searching:           Rolo Keys.
* rolo, moving through matches:          Rolo Keys.
* rolo, moving to entries:               Rolo Keys.
* rolo, outlining:                       Rolo Keys.
* rolo, personal:                        Rolo Settings.
* rolo, quitting:                        Rolo Keys.
* root cell <1>:                         Idstamps.
* root cell:                             Creating Outlines.
* saving window configurations:          Window Configurations.
* scrolling <1>:                         Smart Keyboard Keys.
* scrolling:                             Glossary.
* searching, rolo:                       Rolo Searching.
* setting the view spec:                 View Specs.
* show subtree:                          Hiding and Showing.
* show tree:                             Hiding and Showing.
* showing:                               Hiding and Showing.
* side drag:                             Smart Mouse Keys.
* signatures, hiding:                    Implicit Buttons.
* site initialization:                   Installing.
* Smart Key <1>:                         Questions and Answers.
* Smart Key <2>:                         Glossary.
* Smart Key:                             Smart Keys.
* smart key assignments:                 Smart Key Assignments.
* smart key commands:                    Smart Key Assignments.
* Smart Key help:                        Smart Key Operations.
* Smart Key operation:                   Smart Key Operations.
* Smart Key toggle:                      Smart Key Assignments.
* Smart Key, default context <1>:        Smart Key Operations.
* Smart Key, default context:            Smart Keyboard Keys.
* Smart Keyboard Keys:                   Smart Keyboard Keys.
* Smart Mouse Key drag:                  Modification.
* Smart Mouse Keys:                      Smart Mouse Keys.
* source line:                           Implicit Buttons.
* splitting a cell:                      Splitting and Appending.
* stack frame:                           Implicit Buttons.
* star outline:                          Inserting and Importing.
* starting Hyperbole:                    Installing.
* storage manager:                       Operational and Storage Formats.
* submenus:                              Menus.
* subtree, hide:                         Hiding and Showing.
* subtree, show:                         Hiding and Showing.
* support:                               Top.
* system encapsulation:                  Encapsulating Systems.
* table of contents <1>:                 Action Types.
* table of contents:                     Implicit Buttons.
* tabs, inserting:                       Relocating and Copying.
* tag:                                   Implicit Buttons.
* tags file:                             Implicit Buttons.
* TAGS file:                             Implicit Buttons.
* tar archive:                           Obtaining.
* tar archive browsing:                  Smart Keyboard Keys.
* terminal use:                          Hyperbole Buttons.
* Texinfo cross-reference:               Implicit Buttons.
* Texinfo manual:                        Installing.
* text file:                             Inserting and Importing.
* toc action type:                       Action Types.
* toc implicit button type:              Implicit Buttons.
* toggling blank lines:                  View Specs.
* top-level cell <1>:                    Idstamps.
* top-level cell:                        Creating Outlines.
* top-level view:                        Hiding and Showing.
* transposing cells:                     Transposing.
* tree, copying:                         Relocating and Copying.
* tree, demoting:                        Relocating and Copying.
* tree, exporting:                       Relocating and Copying.
* tree, filling:                         Filling.
* tree, hide subtree:                    Hiding and Showing.
* tree, killing:                         Adding and Killing.
* tree, mailing:                         Relocating and Copying.
* tree, moving:                          Relocating and Copying.
* tree, promoting:                       Relocating and Copying.
* tree, show:                            Hiding and Showing.
* tree, show subtree:                    Hiding and Showing.
* type definition:                       Creating Types.
* type redefinition <1>:                 Button Type Precedence.
* type redefinition:                     Creating Types.
* uncompressing archives:                Obtaining.
* UNIX manual:                           Implicit Buttons.
* unpacking archives:                    Obtaining.
* URL <1>:                               Smart Keyboard Keys.
* URL <2>:                               Implicit Buttons.
* URL:                                   Action Types.
* URLs, abbreviated:                     Using URLs with Find-File.
* URLs, using with find-file:            Using URLs with Find-File.
* USENET <1>:                            Buttons in Mail.
* USENET:                                Buttons in News.
* variables:                             Hook Variables.
* version description:                   Suggestion or Bug Reporting.
* vertical drag:                         Smart Mouse Keys.
* view:                                  Viewing.
* view spec:                             View Specs.
* view spec klink:                       Links.
* view spec, all lines and levels:       View Specs.
* view spec, blank lines:                View Specs.
* view spec, changing:                   View Specs.
* view spec, characters:                 View Specs.
* view spec, ellipses:                   View Specs.
* view spec, example:                    View Specs.
* view spec, label type:                 View Specs.
* view spec, lines per cell:             View Specs.
* view spec, setting:                    View Specs.
* view spec, show levels:                View Specs.
* VM:                                    Buttons in Mail.
* W3:                                    Smart Keyboard Keys.
* wconfig commands:                      Window Configurations.
* web pages, displaying:                 Using URLs with Find-File.
* window configuration commands:         Window Configurations.
* window configuration ring:             Window Configurations.
* window configurations:                 Window Configurations.
* window system:                         External Viewers.
* windows:                               Glossary.
* word wrap:                             Filling.
* World-wide Web:                        Action Types.
* world-wide web:                        Smart Keyboard Keys.
* World-wide Web:                        Implicit Buttons.
* wrolo:                                 Rolo.
* wrolo commands:                        Rolo Menu.
* wrolo matches:                         Smart Keyboard Keys.
* wrolo menu:                            Rolo Keys.
* WWW <1>:                               Implicit Buttons.
* WWW:                                   Action Types.
* xdb:                                   Implicit Buttons.
* XEmacs <1>:                            Hyperbole Overview.
* XEmacs:                                Menus.
* XEmacs support:                        Button Colors.
* yank, reformatting:                    Hook Variables.
* zcat:                                  Obtaining.
* zip file:                              Obtaining.
* |:                                     View Specs.



Tag Table:
Node: Top198
Node: Introduction6799
Node: Hyperbole Overview7655
Node: Hyperbole Buttons11449
Node: Discussion Forums16483
Node: Manual Overview18119
Node: Smart Keys21042
Node: Smart Key Assignments21666
Node: Smart Key Operations24053
Node: Entering Arguments31663
Node: Buttons33195
Node: Explicit Buttons33686
Node: Global Buttons35514
Node: Implicit Buttons36412
Node: Action Types44257
Node: Button Type Precedence50902
Node: Button Files52412
Node: Utilizing Explicit Buttons54465
Node: Creation54948
Node: By Dragging55216
Node: By Menu57119
Node: Renaming59197
Node: Deletion60554
Node: Modification61254
Node: Location61842
Node: Buttons in Mail63220
Node: Buttons in News66736
Node: Menus68403
Node: Outliner72739
Node: Menu Commands75036
Node: Creating Outlines76989
Node: Autonumbering78133
Node: Idstamps81189
Node: Editing82078
Node: Adding and Killing83260
Node: Relocating and Copying84202
Node: Moving Around87927
Node: Filling89003
Node: Transposing90033
Node: Splitting and Appending90845
Node: Inserting and Importing91868
Node: Exporting94904
Node: Viewing95488
Node: Hiding and Showing95762
Node: View Specs97454
Node: Links100096
Node: Cell Attributes102686
Node: Outliner History104306
Node: Rolo105190
Node: Rolo Concepts105833
Node: Rolo Menu108326
Node: Rolo Searching111215
Node: Rolo Keys113276
Node: Rolo Settings115987
Node: Window Configurations119203
Node: Developing with Hyperbole123192
Node: Hook Variables123656
Node: Creating Types127333
Node: Action Type Creation128235
Node: Implicit Button Types131920
Node: Explicit Button Technicalities135054
Node: Button Label Normalization135375
Node: Operational and Storage Formats136840
Node: Programmatic Button Creation138034
Node: Encapsulating Systems138975
Node: Embedding Hyperbole139908
Node: Glossary141490
Node: Installation154507
Node: Obtaining155675
Node: Installing156958
Node: Configuring158753
Node: Using URLs with Find-File159795
Node: Internal Viewers161144
Node: External Viewers162135
Node: Link Variable Substitution163391
Node: Button Colors164582
Node: Smart Key Reference165764
Node: Smart Mouse Keys166667
Node: Smart Keyboard Keys170476
Node: Outliner Keys193789
Node: Suggestion or Bug Reporting213138
Node: Questions and Answers215017
Node: Future Work218284
Node: References222431
Node: Key Index226712
Node: Code and File Index233168
Node: Concept Index254902

End Tag Table
