\input texinfo @c -*- coding: utf-8 -*- @c $Id$ @c hyperbole.texi --- The GNU Hyperbole Manual @c Usage: Hardcopy man from TeX; Info man from `texinfo-format-buffer'. @c @c Author: Bob Weiner @c @c Orig-Date: 6-Nov-91 at 11:18:03 @c %**start of header (This is for running Texinfo on a region.) @setfilename hyperbole.info @settitle GNU Hyperbole Manual @c %**end of header (This is for running Texinfo on a region.) @c Emacs documentation style settings @c @documentencoding UTF-8 @c These two require Texinfo 5.0 or later, so we use the older @c equivalent @set variables supported in 4.11 and hence. @ignore @codequotebacktick on @codequoteundirected on @end ignore @set txicodequoteundirected @set txicodequotebacktick @include version.texi @ifnotinfo @macro bkbd {arg} @kbd{@{\arg\@}} @end macro @end ifnotinfo @ifinfo @macro bkbd {arg} @t{@{\arg\@}} @end macro @end ifinfo @macro kitem {key} @kindex \key\ @item @bkbd{\key\} @end macro @macro kitemx {key} @kindex \key\ @itemx @bkbd{\key\} @end macro @copying This manual is for GNU Hyperbole (Edition @value{EDITION}, Published @value{UPDATED}). Copyright @copyright{} 1989-2019 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation. @sp 1 GNU Hyperbole sofware is distributed under the terms of the GNU General Public License version 3 or later, as published by the Free Software Foundation, Inc. @sp 1 GNU Hyperbole is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY, without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. @sp 1 See the GNU General Public License for more details in the file, ``COPYING'', within the Hyperbole package directory. @end quotation @end copying @dircategory Emacs @direntry * Hyperbole: (hyperbole). The Everyday Hypertextual Information Manager. Use @{C-h h d d@} for a demonstration. GNU Hyperbole offers context-sensitive mouse and keyboard keys that do the right thing, a powerful contact manager, an advanced, auto- numbered outliner with hyperlink anchors for each outline cell, and easily editable and extensible hyperlink buttons, even embeddable within mail and news messages.@ @end direntry @c @c Comment the @set smallbook line out if you want to print on letter sized paper. @c Smallbook formats for 7x9.25 inch book-sized printing. @c @set smallbook @ifset smallbook @smallbook @end ifset @synindex vr fn @iftex @kbdinputstyle code @end iftex @titlepage @sp 6 @title GNU Hyperbole Manual @sp 1 @subtitle The Everyday Hypertextual Information Manager @sp 1 @center @image{im/hyperbole-cv,4in,,Sample Hyperbole Screenshot} @author Bob Weiner @page @vskip 0pt plus 1filll @insertcopying @sp 2 @example Published by the Free Software Foundation, Inc. Author: Bob Weiner E-mail: (This is a mail list). Web: www.gnu.org/software/hyperbole @end example @sp 2 The body of the manual was written in Emacs and laid out using the GNU Texinfo markup language. @end titlepage @summarycontents @contents @c @setchapternewpage odd @node Top, Introduction, (dir), (dir) @unnumbered GNU Hyperbole @ifhtml @html

GNU Hyperbole

The Everyday Hypertextual Information Manager

Say thanks if you like Hyperbole.

Copyright © 1989-2019 Free Software Foundation, Inc.

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

GNU Hyperbole is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY, without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Edition 7.0.3b
Printed August 11, 2019.

  Published by the Free Software Foundation, Inc.
  Author:    Bob Weiner
  E-mail:    <hyperbole-users@@gnu.org> (This is a mail list).
  Web:       www.gnu.org/software/hyperbole
Screenshot of the Hyperbole Koutliner, Demonstration and HyRolo



@end html @sp 1 @center -------------------- @sp 1 @end ifhtml @ifinfo @center GNU Hyperbole @center The Everyday Hypertextual Information Manager @center Say thanks: https://saythanks.io/to/rswgnu @sp 2 @noindent Copyright @copyright{} 1989-2019 Free Software Foundation, Inc. GNU Hyperbole is available for use, modification, and distribution under the terms of the GNU General Public License (GPL) Version 3 or later, as published by the Free Software Foundation, Inc., with all rights and responsibilities thereof. GNU Hyperbole is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY, without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. @sp 2 @example Edition 7.0.3b Augut 11, 2019 Published by the Free Software Foundation, Inc. Author: Bob Weiner E-mail: (This is a mail list). Web: www.gnu.org/software/hyperbole @end example @float Image,image:Sample @caption{Sample Hyperbole screenshot of the Koutliner, DEMO file and HyRolo} @image{im/hyperbole-cv,6in,,Sample Hyperbole Screenshot} @end float @sp 1 @center -------------------- @sp 1 @end ifinfo @cindex credits @cindex Hyperbole, obtaining @cindex anonymous ftp GNU Hyperbole was designed and written by Bob Weiner. @xref{Setup}, for information on how to obtain and to install Hyperbole. This manual explains user operation and summarizes basic developer facilities of GNU Hyperbole. Hyperbole provides convenient access to information, control over its display and easy linking of items across documents and across the web. The Hyperbole Koutliner offers flexible views and structure manipulation within bodies of information. We hope you enjoy using Hyperbole and that it improves your productivity. If it does, consider sending us a quote or short note discussing how it helps you. We may use your submission to help promote further use of Hyperbole; all submissions will be considered freely reusable and will fall under the same license as Hyperbole. E-mail your quote to . We volunteer our time on Hyperbole and love to hear user stories in addition to any problem reports. Before we delve into Hyperbole, a number of acknowledgments are in order. Peter Wegner and Morris Moore encouraged the growth of this work. Douglas Engelbart showed us the bigger picture and will forever be an inspiration. His life-long quest at augmenting individual and team capabilities represents a model from which we continue to draw. Chris Nuzum has used Hyperbole since its inception, often demonstrating its power in creative ways. Many thanks to Mats Lidell, a long-time Hyperbole user, who has helped maintain it throughout the years. The Koutliner is dedicated to my lovely wife, Kathy. @menu * Introduction:: * Smart Keys:: * Buttons:: * Menus:: * HyControl:: * Koutliner:: * HyRolo:: * Window Configurations:: * Developing with Hyperbole:: * Glossary:: * Setup:: * Global Key Bindings:: * Koutliner Keys:: * Smart Key Reference:: * Suggestion or Bug Reporting:: * Questions and Answers:: * Future Work:: * References:: * Key Index:: * Function:: * Concept Index:: @detailmenu --- The Detailed Node Listing --- Introduction * Manual Overview:: * Motivation:: * Hyperbole Overview:: * Mail Lists:: Smart Keys * Smart Key Bindings:: * Smart Key Operations:: * Smart Key Argument Selection:: * Smart Key Debugging:: * Smart Key Thing Selection:: * Smart Mouse Key Modeline Clicks:: * Smart Mouse Key Drags:: Smart Mouse Key Drags * Creating and Deleting Windows:: * Saving and Restoring Window Configurations:: * Resizing Windows:: * Dragging Buffers:: Dragging Buffers, Windows and Items * Swapping Buffers:: * Displaying Buffers:: * Cloning Windows:: * Displaying File and Buffer Items:: * Keyboard Drags:: Buttons * Explicit Buttons:: * Global Buttons:: * Implicit Buttons:: * Button Files:: * Action Types:: * Button Type Precedence:: * Utilizing Explicit Buttons:: Implicit Buttons * Implicit Button Type Summaries:: Utilizing Explicit Buttons * Creation:: * Renaming:: * Deletion:: * Modification:: * Searching and Summarizing:: * Buttons in Mail:: * Buttons in News:: Creation * By Dragging:: Creation Via Action Key Drags * By Menu:: Creation Via Menus Koutliner * Menu Commands:: * Creating Outlines:: * Autonumbering:: * Idstamps:: * Editing:: * Viewing:: * Links:: * Cell Attributes:: * Koutliner 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:: HyRolo * HyRolo Concepts:: * HyRolo Menu:: * HyRolo Searching:: * HyRolo Keys:: * HyRolo 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:: Setup * Installation:: * Invocation:: * Customization:: Customization * Referent Display:: * Internal Viewers:: * External Viewers:: * Link Variable Substitution:: * Web Search Engines:: * Using URLs with Find-File:: * Invisible Text Searches:: * Button Colors:: Smart Key Reference * Smart Mouse Keys:: * Smart Keyboard Keys:: Smart Mouse Keys * Minibuffer Menu Activation:: * Thing Selection:: * Side-by-Side Window Resizing:: * Modeline Clicks and Drags:: * Smart Mouse Drags between Windows:: * Smart Mouse Drags within a Window:: * Smart Mouse Drags outside a Window:: Smart Keyboard Keys * Smart Key - Company Mode:: * Smart Key - Treemacs:: * Smart Key - Emacs Pushbuttons:: * Smart Key - Argument Completion:: * Smart Key - ID Edit Mode:: * Smart Key - Emacs Cross-references (Xrefs):: * Smart Key - Smart Scrolling:: * Smart Key - Smart Menus:: * Smart Key - Dired Mode:: * Smart Key - Hyperbole Buttons:: * Smart Key - View Mode:: * Smart Key - Delimited Things:: * Smart Key - The Koutliner:: * Smart Key - RDB Mode:: * Smart Key - Help Buffers:: * Smart Key - Pages Directory Mode:: * Smart Key - Python Source Code:: * Smart Key - Identifier Menu Mode :: * Smart Key - C Source Code:: * Smart Key - C++ Source Code:: * Smart Key - Assembly Source Code:: * Smart Key - Lisp Source Code:: * Smart Key - Java Source Code:: * Smart Key - JavaScript Source Code:: * Smart Key - Objective-C Source Code:: * Smart Key - Fortran Source Code:: * Smart Key - Occurrence Matches:: * Smart Key - Calendar Mode:: * Smart Key - Man Page Apropos:: * Smart Key - Emacs Outline Mode:: * Smart Key - Info Manuals:: * Smart Key - Email Composers:: * Smart Key - GNUS Newsreader:: * Smart Key - Buffer Menus:: * Smart Key - Tar File Mode:: * Smart Key - Man Pages:: * Smart Key - WWW URLs:: * Smart Key - HyRolo Match Buffers:: * Smart Key - Image Thumbnails:: * Smart Key - Gomoku Game:: * Smart Key - The OO-Browser:: * Smart Key - Default Context:: @end detailmenu @end menu @node Introduction, Smart Keys, Top, Top @chapter Introduction This edition of the GNU Hyperbole Manual is for use with any version 7.0.3b or greater of GNU Hyperbole. Hyperbole runs atop GNU Emacs 24.3 or higher. It will trigger an error if your Emacs is older. This chapter summarizes the structure of the rest of the manual, describes Hyperbole, lists some of its potential applications, and explains how to subscribe to its mail lists. Throughout this manual, sequences of keystrokes are delimited by curly braces @kbd{@{ @}}, function and variable names use this @code{typeface}. @menu * Manual Overview:: * Motivation:: * Hyperbole Overview:: * Mail Lists:: @end menu @node Manual Overview, Motivation, Introduction, Introduction @section Manual Overview @cindex file, DEMO @cindex Hyperbole demo @cindex demo file @cindex tutorial This is a reference manual with extensive details about Hyperbole use. If you prefer a simpler, more interactive introduction to Hyperbole, the @file{DEMO} file included in the Hyperbole distribution demonstrates many of Hyperbole's standard facilities without the need to read through this reference manual. The DEMO is a good way to rapidly understand some of what Hyperbole can do for you. Once Hyperbole is installed, (@pxref{Setup}), you can access the DEMO with the key sequence @bkbd{C-h h d d}. @xref{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 helps throughout Hyperbole use. @xref{Setup}, 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. @xref{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, @pxref{Questions and Answers}. If you are interested in classic articles on hypertext, @pxref{References}. @xref{Smart Keys}, for an explanation of the innovative, context-sensitive mouse and keyboard Action and Assist Keys offered by Hyperbole. @xref{Smart Key Reference}, for a complete reference on what the Action and Assist Keys do in each particular context that they recognize. @xref{Smart Key Argument Selection}, for how Hyperbole speeds selection of prompted for arguments. 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. @xref{Buttons}, for an overview of Hyperbole buttons and how to use them. @xref{Menus}, for summaries of Hyperbole menu commands and how to use the minibuffer-based menus that work on dumb terminals, PCs or workstations. @xref{HyControl}, for how to quickly and interactively control your Emacs windows and frames and what they display. @xref{Koutliner}, for concept and usage information on the autonumbered, hypertextual outliner. @xref{Koutliner Keys}, for a full summary of the outliner commands that are bound to keys. @xref{HyRolo}, for concept and usage information on the rapid lookup, hierarchical, free text record management system included with Hyperbole. @xref{Window Configurations}, for instructions on how to save and restore the set of buffers and windows that appear within a frame. This feature lets you switch among working contexts easily, even on a dumb terminal. Such configurations last only throughout a single session of editor usage. @xref{Developing with Hyperbole}, if you are a developer who is comfortable with Lisp. @xref{Future Work}, for future directions in Hyperbole's evolution. @node Motivation, Hyperbole Overview, Manual Overview, Introduction @section Motivation Database vendors apply tremendous resources to help solve corporate information management problems. But the information that people deal with in their everyday worklife is seldom stored away in neatly defined database schemas. Instead it is scattered among local and remote files, e-mail messages, faxes, voice mail and web pages. The rise of the web has demonstrated how hypertext technologies can be used to build massive organized repositories of scattered information. But assembling information for the web still remains a great challenge and the data formats of the web are too structured to deal with the great variety of information that people process. Modern web development requires the use of many languages: HTML, JavaScript, and CSS. This in itself prevents its use as the prime means of organizing and interlinking the constant flows of daily information. GNU Hyperbole takes a distinctly different approach. It has its own hypertext technology that can interface perfectly with web links but which are much easier to create (simply drag from the source to the destination of a link to create a new hyperlink). Hyperbole hyperbuttons can link not only to static information but can perform arbitrary actions (through the use of button types written in a single, highly interactive language, Emacs Lisp). Hyperbole adds all of this power to your written documents, e-mail, news articles, contact management, outlines, directory listings, and much more. Hyperbole works well with the very latest versions of GNU Emacs across every editing and viewing mode in Emacs. Unlock the power of GNU Hyperbole to make your information work for you. One system. One language. One manual. One solution. Learn Hyperbole and start moving further, faster. @node Hyperbole Overview, Mail Lists, Motivation, Introduction @section Hyperbole Overview @cindex GNU Hyperbole @cindex Hyperbole @cindex hypertext @cindex Emacs Lisp @cindex Emacs GNU Hyperbole (pronounced Ga-new Hi-per-bo-lee), or just Hyperbole, is an efficient, programmable hypertextual information management system. It is intended for everyday work on any GNU Emacs platform. Hyperbole allows hypertext buttons to be embedded within unstructured and structured files, mail messages and news articles. It offers intuitive mouse-based control of information display within multiple windows. It also provides point-and-click access to Info manuals, ftp archives, and the World-Wide Web (WWW). @page @noindent Hyperbole consists of five parts: @table @emph @item Buttons and Smart Keys Hyperbole hyperlink and other kinds of buttons (explicit buttons) may be added to documents with a simple drag between windows, no markup language needed. Implicit buttons are patterns automatically recognized within existing text that perform actions, e.g. bug#24568 displays the bug status information for that Emacs bug number, without the need for any additional markup. Global buttons are buttons that are activated by name from anywhere within Emacs. @xref{Buttons}. Buttons are accessed by clicking on them or referenced by name (global buttons), so they can be activated regardless of what is on screen. Users create and activate Hyperbole buttons; Emacs Lisp programmers easily can develop new button types and actions. Hyperbole includes two special @dfn{Smart Keys}, the Action Key and the Assist Key, that perform an extensive array of context-sensitive operations across emacs usage, including activating and showing help for Hyperbole buttons. In many popular Emacs modes, they allow you to perform common, sometimes complex operations without having to use a different key for each operation. Just press a Smart Key and the right thing happens. @xref{Smart Keys}; @item Contact and Text Finder an interactive, textual information management interface, including fast, flexible file and text finding commands. A powerful, hierarchical contact manager, @pxref{HyRolo}, which anyone can use, is also included. It is easy to learn since it introduces only a few new mechanisms and has a menu interface, which may be operated from the keyboard or the mouse; it may also be used to look up any record-based information and Hyperbole buttons may be embedded in any records; @item Screen Control the fastest, easiest-to-use window and frame control available for GNU Emacs, @pxref{HyControl}. With just a few keystrokes, you can shift from increasing a window's height by 5 lines to moving a frame by 220 pixels or immediately moving it to a screen corner. Text in each window or frame may be enlarged or shrunk (zoomed) for easy viewing, plus many other features; this allows Hyperbole to quickly control the way information is presented on-screen; @item Hypertextual Outliner an advanced outliner, @pxref{Koutliner}, with multi-level autonumbering and permanent identifiers attached to each outline node for use as hypertext link anchors, per node properties and flexible view specifications that can be included in links or used interactively; @item Programming Library a set of programming libraries, @pxref{Developing with Hyperbole}, 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). @end table @kindex C-h h d d @vindex file, DEMO @cindex demonstration @cindex button demo Hyperbole may be used simply for browsing through documents pre-configured with Hyperbole buttons, in which case, you can safely ignore most of the information in this manual. Jump right into the Hyperbole demonstration by typing @bkbd{C-h h d d}, assuming Hyperbole has been installed at your site. If you need to install Hyperbole, @pxref{Setup}, for Hyperbole installation and configuration information. The demo offers a much less technical introduction to Hyperbole by supplying good examples of use. @float Image,image:Demo @caption{Hyperbole Minibuffer Menu and Demonstration Screenshot} @image{im/demo,6in,,Hyperbole Minibuffer Menu and Demonstration Screenshot} @end float @sp 1 @cindex GNU Emacs @kindex C-h t You likely will want to do more than browse with Hyperbole, e.g.@: create your own buttons. The standard Hyperbole button editing user interface is Emacs-based, so a basic familiarity with the Emacs editing model is useful. The material covered in the Emacs tutorial, normally bound to @bkbd{C-h t}, is more than sufficient as background. @xref{Glossary,,,emacs,the GNU Emacs Manual}, if some emacs-related terms are unfamiliar to you. @cindex Hyperbole features A Hyperbole user works with chunks of information that need to be organized, interlinked, and processed. Such chunks can be hyperbuttons, address book contacts, items in an outline, or even database query results. Hyperbole does not enforce any particular hypertext or information management model, but instead allows you to organize your information in large or small chunks as you see fit. The Hyperbole outliner organizes information into hierarchies which may also contain links to external information sources. @xref{Koutliner}. @noindent Some of Hyperbole's most significant features are: @itemize @bullet @item Buttons may link to information or may execute functions, such as starting or communicating with external programs; @item A simple mouse drag from a button source location to its link destination is often all that is needed to create a new link. The keyboard can also be used to emulate such drags; @item Buttons may be embedded within electronic mail messages; @item Outlines allow rapid browsing, editing and movement of chunks of information organized into trees (hierarchies); @item Other hypertext and information retrieval systems may be encapsulated under a Hyperbole user interface (a number of samples are provided). @end itemize @cindex Hyperbole applications @noindent Typical Hyperbole applications include: @table @emph @item personal information management Hyperlinks provide a variety of views into an information space. A search facility locates hyperbuttons in context and permits quick selection. @item 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. @item brainstorming The Hyperbole outliner (@pxref{Koutliner}) is an effective tool for capturing ideas and then quickly reorganizing them in a meaningful way. Links to related ideas are easy to create so the need to copy and paste information is greatly reduced. @item 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. @item 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. @end table @node Mail Lists, , Hyperbole Overview, Introduction @section Mail Lists If you use Hyperbole, you may join the mailing list to discuss Hyperbole with users and maintainers. There is a separate mail list to report problems or bugs with Hyperbole, . For more details, @pxref{Suggestion or Bug Reporting}. @node Smart Keys, Buttons, Introduction, Top @chapter Smart Keys @cindex Smart Key @cindex mouse support @cindex Action Key @cindex Assist Key @cindex middle mouse key @vindex hmouse-middle-flag @kindex Action Key @kindex Assist Key Hyperbole offers two special @dfn{Smart Keys}, the Action Key and the Assist Key, that perform an extensive array of context-sensitive operations across emacs usage. In many popular modes, they allow you to perform common, sometimes complex operations without having to use a different key for each operation. Just press a Smart Key and the right thing happens. This chapter explains typical uses of the Smart Keys. @xref{Smart Key Reference}, for complete descriptions of their behavior in all contexts. @menu * Smart Key Bindings:: * Smart Key Operations:: * Smart Key Argument Selection:: * Smart Key Debugging:: * Smart Key Thing Selection:: * Smart Mouse Key Modeline Clicks:: * Smart Mouse Key Drags:: @end menu @node Smart Key Bindings, Smart Key Operations, Smart Keys, Smart Keys @section Smart Key Bindings @kindex C-u M-@key{RET} @kindex M-@key{RET} From the keyboard, @bkbd{M-@key{RET}} is the Action Key and @bkbd{C-u M-@key{RET}} is the Assist Key. These keys allow context-sensitive operation from any keyboard. @c Removed the following in Hyperbole 6.00 since it was not consistent @c across all read-only modes and the standard bindings are easy @c enough to use. @c @c In many read-only modes like Dired (the directory editor and file @c manager) and Rmail (the mail reader), @{@key{RET}@} also functions as @c the Action Key and @bkbd{C-u @key{RET}} functions as the Assist Key. @kindex shift-middle mouse key @kindex shift-left mouse key @kindex shift-right mouse key @kindex middle mouse key @vindex hmouse-middle-flag From the mouse, the @dfn{Action Key} is bound to your shift-middle mouse key (or shift-left on a 2-button mouse). The @dfn{Assist Key} is bound to your shift-right mouse key, assuming Hyperbole is run under an external window system. @findex hmouse-add-unshifted-smart-keys @cindex unshifted mouse bindings @cindex unshifted mouse keys @cindex mouse keys, unshifted @cindex smart keys, unshifted If you set the variable, @code{hmouse-middle-flag}, to @samp{t} before loading Hyperbole, then you may also use the middle mouse key as the Action Key). If you want both the middle mouse key as the Action Key and the right mouse key as the Assist Key for ease of use, then within your personal @file{~/.emacs} file, add: @code{(add-hook 'hyperbole-init-hook 'hmouse-add-unshifted-smart-keys)} and then restart Emacs. @cindex key binding, smart keys @cindex smart key commands @cindex smart key assignments @findex action-key @findex assist-key @findex action-mouse-key @findex assist-mouse-key @findex hkey-either If you prefer other key assignments, simply bind the commands @code{action-key} and @code{assist-key} to keyboard keys. Hyperbole binds @bkbd{M-@key{RET}} to the command @code{hkey-either}. It allows for a single key binding for both commands; a prefix argument, such as @bkbd{C-u}, then invokes @code{assist-key}. You may also bind @code{action-mouse-key} and @code{assist-mouse-key} to other mouse keys, though you won't be able to execute mouse drag actions with such key bindings. Mouse configuration of the Smart Keys is automatic for GNU Emacs under Mac OS X, the X Window System and MS Windows assuming your emacs program has been built with support for any of these window systems. @vindex file, .emacs @findex hyperbole-toggle-bindings @cindex change key bindings @cindex toggle key bindings @cindex key bindings, toggle @cindex disable Hyperbole @kindex C-c h If you ever need to temporarily disable the Hyperbole keyboard and mouse bindings, use the @code{hyperbole-toggle-bindings} command. It switches between the Hyperbole key bindings and those set prior to loading Hyperbole and then back again if invoked once more. There is no default key binding for this command; use @bkbd{M-x hyperbole-toggle-bindings @key{RET}}. Alternatively, you may select a key and bind it as part of any setting of @code{hyperbole-init-hook} within your personal @file{~/.emacs} file. For example, @code{(add-hook 'hyperbole-init-hook (lambda () (global-set-key "\C-ch" 'hyperbole-toggle-bindings)))}. @c @cindex Paste Key @c @cindex mouse paste @c @cindex InfoDock Action Key @c @cindex InfoDock Paste Key @c Under InfoDock, the middle mouse key is normally used as the Action Key @c and the meta-middle mouse key is used as the Paste Key. If you prefer @c that the middle mouse key be used as the Paste Key, then you will want to @c toggle the mouse bindings. InfoDock includes a built-in way to do this @c via its Options/Mouse/Mouse-Paste-on-Middle-Key menu item. (Keep in @c mind though that the Action Key will paste any active region within the @c editor when the Action Key is clicked; it will not paste selections from @c other applications). @node Smart Key Operations, Smart Key Argument Selection, Smart Key Bindings, Smart Keys @section Smart Key Operations @cindex button activation @cindex activation @cindex button help @cindex help, button 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. @cindex Smart Key operation @cindex menu item, Doc/SmartKeys @cindex Smart Key summary @cindex modeline, Smart Keys The Hyperbole Doc/SmartKeys menu entry, @bkbd{C-h h d s}, displays a summary of what the Smart Keys do in all of their different contexts. Alternatively, a click of the Assist Mouse Key in the right corner of a window modeline (within the rightmost 3 characters) toggles between displaying this summary and hiding it. Reference this summary whenever you need it. The following table is the same summary. Much of the browsing power of Hyperbole comes from the use of the Smart Keys, so spend some time practicing how to use them. Study what modeline clicks and window drag actions do as these will give you a lot of power without much effort. This table may appear daunting at first, but as you practice and notice that the Smart Keys do just a few context-sensitive things per editor mode, you will find it easy to just press or point and click and let Hyperbole do the right thing in each context. @ifnothtml @format @smallexample @include hkey-help.txt @end smallexample @end format @end ifnothtml @ifhtml @format @example @include hkey-help.txt @end example @end format @end ifhtml @noindent @xref{Smart Key Reference}, for extensive reference documentation on the Smart Keys. @vindex action-key-default-function @vindex assist-key-default-function @cindex Smart Key, default context @cindex default Smart Key context Note how the last line in the table explains that the default behavior of the Smart Keys in an unknown context is to report an error. You can change these behaviors by setting two variables. See the documentation for the variables @code{action-key-default-function} and @code{assist-key-default-function} for information on how to customize the behavior of the Smart Keys within default contexts. @cindex Smart Key help @cindex help, Smart Key @cindex context-sensitive help 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. @kindex C-h A @kindex C-u C-h A On the keyboard, @bkbd{C-h A} displays this same context-sensitive help for the Action Key while @bkbd{C-u C-h A} displays the help for the Assist Key. Note that @bkbd{C-h a} performs a function unrelated to Hyperbole, so you must press the shift key when you type the @key{A} character. @node Smart Key Argument Selection, Smart Key Debugging, Smart Key Operations, Smart Keys @section Smart Key Argument Selection @cindex Hyperbole help A prime design criterion of Hyperbole's user interface is that you should be able to see what an operation will do before using it. The Assist Key typically shows you what a button or minibuffer menu item will do before you activate it. Hyperbole also displays the result of directly selecting an argument value with the Action Key, to provide feedback as to whether the correct item has been selected. A second press/click is necessary before an argument is accepted and processed. @cindex argument entry @cindex direct selection @cindex double click Many Hyperbole commands prompt you for arguments. The standard Hyperbole user interface has an extensive core of argument types that it recognizes. Whenever Hyperbole is prompting you for an argument, it knows the type that it needs and provides some error checking to help you get it right. More importantly, it allows you to press the Action Key within an entity that you want to use as an argument and it will grab the appropriate thing and show it to you at the input prompt within the minibuffer. If you press (click with a mouse) the Action Key on the same thing again, it accepts the entity as the argument and moves on. Thus, a double click registers a desired argument. Double-quoted strings, pathnames, mail messages, Info nodes, dired listings, buffers, numbers, completion items and so forth are all recognized at appropriate times. All of the argument types mentioned in the documentation for the Emacs Lisp @code{interactive} function are recognized. Experiment a little and you will quickly get used to this direct selection technique. @cindex completion Wherever possible, standard Emacs completion is offered, as described in @ref{Completion,,,emacs,the GNU Emacs Manual}. Remember to use @bkbd{?} to see what your possibilities for an argument are. Once you have a list of possible completions on screen, press the Action Key twice on any item to enter it as the argument. @node Smart Key Debugging, Smart Key Thing Selection, Smart Key Argument Selection, Smart Keys @section Smart Key Debugging Typically, @bkbd{C-h A} and @bkbd{C-u C-h A} which show Action and Assist Key help for the current context, are sufficient for seeing how the Smart Keys behave no matter where they are used. @kindex C-h h c d @cindex Smart Key debugging @cindex menu item, Cust/Debug-Toggle @cindex debugging Smart Keys @cindex troubleshooting Smart Keys @cindex Messages buffer @cindex logging Smart Key behavior However, if a Smart Key ever behaves differently than you think it should or if you want to test how the Smart Keys respond in a new context, then the Smart Key debugging flag may be of use. You toggle it on and off with @bkbd{C-h h c d} (minibuffer menu Cust/Debug-Toggle). Once enabled, this displays a message in the minibuffer each time the Action or Assist Key is released, showing the context of the press and its associated action, so you can see exactly what is happening whenever you use a Smart Key. These messages are all prefaced with ``(HyDebug)'' and logged to the ``*Messages*'' buffer for later viewing. @kindex C-h h m c @kindex C-h h m r If you do find a problem with the Smart Keys and want to report a bug, use @bkbd{C-h h m r} to compose an email message to the bug-hyperbole list. Hyperbole will automatically include all of the ``(HyDebug)'' messages from your current emacs session into your email. Similarly, when you compose an email to the hyperbole-users mailing list with @bkbd{C-h h m c}, these messages are also included. @node Smart Key Thing Selection, Smart Mouse Key Modeline Clicks, Smart Key Debugging, Smart Keys @section Smart Key Thing Selection @cindex sexp selection @cindex code block selection @cindex selection @cindex smart selection @cindex smart marking @cindex region selection @cindex things @cindex delimited things Hyperbole has some radically cool ways to select regions of structured text or source code and to copy or move them between buffers with a single mouse drag or two key presses. A great deal of smarts are built-in so that it does the right thing most of the time; many other attempts at similar behavior such as @file{thing.el} fail to deal with many file format complexities. We use the term @dfn{things} to refer to structured entities that Hyperbole can select. These include: delimited pairs of (), @{@}, <>, [] and quote marks, source code functions, source code comments and matching tag pairs in HTML and SGML modes. @dfn{Delimited things} are those things that contain a selectable delimiter such as an opening parenthesis. @cindex HTML tag pair @cindex SGML tag pair The best way to mark a delimited thing is to move your cursor to the starting delimiter of the thing and then press the Action Key. Typically, you will see the thing highlight. You can then operate upon it as you would any Emacs region. In many cases, you can do the same thing upon the closing delimiter, but this is not as reliable. An Action Key press on the start of an HTML or SGML tag pair marks the entire region span of the pair. If you use the Assist Key instead, it will mark and kill (delete) the thing. @cindex drag, with region @cindex kill region @cindex yank region @cindex cut region @cindex copy region @cindex paste region Even better are Smart Mouse Key thing drags which let you copy or move delimited things in one operation without having to select a region. To copy, simply drag with the Action Key from a thing's opening delimiter and release somewhere outside of the thing, either within the same window or within another window. The thing will be copied to the point of release. If you want to move a thing, simply perform the same drag but with the Assist Mouse Key. Ensure that you do not move any explicit buttons from one buffer to another as that does not work. @noindent Hyperbole also binds two convenience keys for working with things. @kindex C-c @key{RET} @findex hui-select-thing @findex hui-select-thing-with-mouse The first such key is @bkbd{C-c @key{RET}} @code{hui-select-thing} which selects bigger and bigger syntactic regions with each successive use. Double or triple clicks of the Selection Key (left mouse key) do the same thing. The first press selects a region based upon the character at point. For example, with point over an opening or closing grouping character, such as @{ or @}, the whole grouping is selected, e.g. a C function. When on an _ or - within a programming language identifier name, the whole name is selected. The type of selection is displayed in the minibuffer as feedback. When using a language in which indentation determines nesting level like Python, a double click on the first alpha character of a line, such as an if statement, selects the current clause (until the next line at the same or lesser indentation). Use @bkbd{C-g} to unmark the region when done. Use, @code{hui-select-thing-with-mouse} if you want to bind this to a different mouse key to use single clicks instead of double clicks. @kindex C-c . @findex hui-select-goto-matching-tag The second convenience key is bound only in HTML/web mode. @bkbd{C-c .} @code{hui-select-goto-matching-tag} jumps between the opening and closing tag of a pair. It moves point to the start of the tag paired with the closest tag that point is within or which it precedes. A second press moves point to the matching tag of the pair, allowing you to quickly jump back and forth between opening and closing tags. @node Smart Mouse Key Modeline Clicks, Smart Mouse Key Drags, Smart Key Thing Selection, Smart Keys @section Smart Mouse Key Modeline Clicks Smart Mouse Key clicks on a window's modeline offer many powerful browsing features, including directory editing (dired), user manual browsing, and window, buffer and frame selection. Generally, only Hyperbole-specific modeline actions are discussed herein. @itemize @bullet @item Leftmost Character @cindex bury buffer @cindex unbury buffer @cindex modeline, bury buffer @cindex modeline, unbury buffer @cindex modeline, leftmost character Action Key clicks on the first (usually blank) character of the modeline bury the current buffer in the buffer list and display the next buffer in the list. Assist Key clicks do the reverse and unbury the bottom buffer. @cindex modeline, next buffer @cindex modeline, prev buffer A similar effect can be achieved with the standard Emacs mouse 1 (left) and 3 (right) buttons on the Buffer ID element of modeline to cycle through previous and next buffers, respectively. This may be easier to use since you can click anywhere on the buffer identifier. @item Buffer ID Element @cindex dired @cindex directory editor @findex dired-jump @cindex modeline, dired @cindex buffer id @cindex modeline, buffer id @cindex dragging items, dired On the left part of the modeline is the buffer identification, generally the name of the buffer in use. An Action Key click on that switches the window to edit the buffer's directory using dired. Then Action Key clicks on directory items in the dired buffer display the items selected in other windows. An Action Key drag from an item to another window displays the item in that window. An Action Key click on the first line in a dired buffer which contains the current directory path, specifically on any ancestor part of the path (the part to the left of the click point), starts another dired session on the ancestor directory. Click at the end of this line or on the last line to end the dired session (bury its buffer). @cindex Treemacs @cindex file viewer, Treemacs If you use the Treemacs file viewer Emacs package, you can configure Hyperbole to use this instead of Dired when you click on a modeline buffer id. Since this is a customization option, it may be changed permanently like so. Use @bkbd{M-x customize-set-variable @key{RET} action-key-modeline-buffer-id-function @key{RET}}. Change the value to @code{smart-treemacs-modeline}. Then press @key{RET}. To change it back to Hyperbole's default, use the value, @code{dired-jump}. @item Large Blank Area @cindex buffer menu @cindex modeline, buffer menu @cindex jump menu @cindex modeline, jump menu @cindex dragging items, buffer menu An Action Mouse Key click in a blank area of a window modeline (away from left and right edges) toggles between displaying and hiding a list of all buffers. Once displayed, an Action Key click on a buffer item will display it in another window. You can drag items to specific windows for display as well. Alternatively, you may (1) display the buffer menu, (2) use its @bkbd{m} command to mark buffers, and (3) use the Hyperbole @bkbd{@@} command to display the marked buffers in a grid of popup windows whose number of rows and columns you specify at the prompt or via a prefix argument. This also works in @code{ibuffer-menu} and @code{dired} modes. @xref{HyControl}. An Assist Key click in the blank area of the modeline displays a quick access menu of display-oriented commands. You can jump to buffers categorized by major mode, jump to windows by buffer name, or to frames by name. Manage your windows and frames quickly with this menu as well. As always with Hyperbole, just try it and you'll begin to wonder how you lived without it before. @item Right Corner @cindex Info browser @cindex modeline click and drag @cindex modeline, Info Browser A click of the Action Mouse Key in the right corner of a window modeline (within the rightmost 3 characters) displays or hides the GNU Info Manual Browser, giving you quick point and click access to an amazing wealth of documentation, since the Action Key also browses through these manuals and follows their hyperlinked cross-references. A click of the Assist Key in the same location displays or hides the Smart Key summary, as noted earlier. @item Customizable Variables @vindex action-key-modeline-function @vindex assist-key-modeline-function @findex action-key-modeline @findex assist-key-modeline @findex hmouse-context-menu @findex hmouse-context-ibuffer-menu @cindex ibuffer menu Hyperbole modeline mouse click actions are controlled by the two functions, @code{action-key-modeline} and @code{assist-key-modeline}. If you know a little Emacs Lisp you can change these to do whatever you like. When a Smart Key press is on a blank part of a modeline but not at the left or right, the function given by one of these two variables is executed: @code{action-key-modeline-function} or @code{assist-key-modeline-function}. By default, the Action Key toggles between displaying and hiding the buffer menu. If you like the more advanced features of @code{Ibuffer Mode}, you can change the buffer menu to use that with the following in your Emacs initialization file: @code{(setq action-key-modeline-function #'hmouse-context-ibuffer-menu)}. To set it back to the default use: @code{(setq action-key-modeline-function #'hmouse-context-menu)}. @findex hui-menu-screen-commands @cindex modeline, screen command menu The default @code{assist-key-modeline-function} is to pop up a menu of convenient screen commands that lets you select buffers grouped by major mode, use HyControl, or jump to specific windows, window configurations or frames. Since these are customization options, they may be change permanently like so. Use @bkbd{M-x customize-set-variable @key{RET} assist-key-modeline-function @key{RET}}. Change the value to your desired command. Then press @key{RET}. @end itemize @node Smart Mouse Key Drags, , Smart Mouse Key Modeline Clicks, Smart Keys @section Smart Mouse Key Drags @cindex smart mouse key drag @cindex Action Mouse Key drag @cindex Assist Mouse Key drag @cindex drag, Smart Mouse Key As mentioned in the section on Thing Selection, Hyperbole Smart Mouse Key drag actions can be quite useful. This section summarizes other drag contexts and actions; for complete documentation, @pxref{Smart Mouse Keys}. @menu * Creating and Deleting Windows:: * Saving and Restoring Window Configurations:: * Resizing Windows:: * Dragging Buffers:: @end menu @node Creating and Deleting Windows, Saving and Restoring Window Configurations, Smart Mouse Key Drags, Smart Mouse Key Drags @subsection Creating and Deleting Windows @cindex drag, horizontal @cindex horizontal drag @cindex drag, vertical @cindex vertical drag Horizontal and vertical drags of the Smart Mouse Keys are used to split and delete Emacs windows. An Action Mouse Key horizontal drag of five or more characters in either direction within a single window creates a new window by splitting the current window into two windows, one atop the other. An Action Mouse Key vertical drag in either direction splits the current window into two side-by-side windows. A horizontal or vertical drag of the Assist Mouse Key within a single window, deletes that window. @kindex C-x + @cindex rebalance windows @cindex windows, rebalance If you split windows many times and then delete a number of the windows, you'll be left with windows of differing heights. Use @bkbd{C-x +} to re-balance the sizes of the remaining windows, so they are fairly even. @node Saving and Restoring Window Configurations, Resizing Windows, Creating and Deleting Windows, Smart Mouse Key Drags @subsection Saving and Restoring Window Configurations @cindex window configuration drag @cindex drag, window configuration @cindex drag, diagonal @cindex diagonal drag A window configuration consists of the set of windows within a single Emacs frame. This includes their locations, buffers, and the scrolled positions of their buffers. Hyperbole allows you to save and restore window configurations with simple diagonal mouse drags within a single window. A diagonal drag in any direction of the Action Key saves the current window configuration to a ring of window configurations, just like the Emacs text kill ring. (@xref{Kill Ring,,,emacs, the Emacs Manual}). Each diagonal drag in any direction of the Assist Key restores a prior saved window configuration from the ring. Window configurations are restored in reverse order of the way they were saved. Since a ring is circular, after the oldest element is restored, the newest element will again be restored and so on. @node Resizing Windows, Dragging Buffers, Saving and Restoring Window Configurations, Smart Mouse Key Drags @subsection Resizing Windows @cindex resizing windows @cindex drag, resize window Emacs windows may be resized by dragging their window separators (modelines or vertical side lines) within a frame. Simply depress either Smart Mouse Key on a modeline or near a window side, hold it down while you drag to a new location and then release. The window separator will then jump to the location of release. Basically, just drag the window separator to where you want it. Nowadays a better version of Emacs window resizing exists on the left mouse key. A drag with this key from a blank area of a modeline or a window side divider shows visible feedback as the window is resized. But if you are always using the Smart Mouse Keys, you may prefer to use them for resizing windows as well. Note that you cannot drag the bottom-most modeline; you would have to resize the frame to move the bottom of that window up. @node Dragging Buffers, , Resizing Windows, Smart Mouse Key Drags @subsection Dragging Buffers, Windows and Items Smart Mouse Key drags let you display buffers and windows however you want them. Dired and buffer-menu items may also be displayed in specific locations with drags. Below we explore these drag actions. @menu * Swapping Buffers:: * Displaying Buffers:: * Cloning Windows:: * Displaying File and Buffer Items:: * Keyboard Drags:: @end menu @node Swapping Buffers, Displaying Buffers, Dragging Buffers, Dragging Buffers @subsubsection Swapping Buffers @cindex swap buffers @cindex window, swap buffer @cindex buffer, swap @cindex drag, buffer swap Swapping buffer locations is quick and easy with Hyperbole. Simply drag from one window to another with the Assist Key (not the Action Key). This works across frames as well. If you have just two windows in an Emacs frame, you can swap their buffers from the keyboard. Use this Hyperbole minibuffer menu key sequence involving the tilde key to swap the buffers and quit from the Hyperbole minibuffer menu: @bkbd{C-h h s w ~ q}. @node Displaying Buffers, Cloning Windows, Swapping Buffers, Dragging Buffers @subsubsection Displaying Buffers @cindex buffer, copy @cindex copy buffer @cindex drag, copy buffer What if you want to display the same buffer in another window and not swap buffers? Depress the Action Mouse Key in the open area of the modeline of the source window and drag to the text area of the destination window. Voila, the buffer appears in the new location as well as the old one. If you want a new window where you release (so the original destination window's buffer stays onscreen), just drag to a window's modeline; that window will be split before the buffer is displayed. @node Cloning Windows, Displaying File and Buffer Items, Displaying Buffers, Dragging Buffers @subsubsection Cloning Windows @cindex clone window @cindex window, clone @cindex drag, clone window To clone a window with its buffer to a new frame, simply drag the Action Mouse Key from the window to outside of Emacs and release the key. A new frame will be created, selected and sized according to the original window. Do the same thing with the Assist Mouse Key and the original window will be deleted as well, unless it is the only window in that frame. @node Displaying File and Buffer Items, Keyboard Drags, Cloning Windows, Dragging Buffers @subsubsection Displaying File and Buffer Items @cindex dired item drag @cindex buffer menu item drag @cindex Treemacs item drag @cindex drag, dired item @cindex drag, buffer menu item @cindex drag, Treemacs item You can also drag items to other windows with the Action Key in Dired, Buffer Menu, Ibuffer and Treemacs listing buffers, rather than the buffers themselves. Drag with the Action Mouse Key and the selected item will be displayed in any Emacs window in which you release. Drag outside Emacs and it will be displayed in a new frame. To display the last item you want within the listing window itself, press and release the Action Key on that item after dragging your other items to their respective windows. Remember that you can emulate these drags from the keyboard when needed, @pxref{Keyboard Drags}. So now you can put a bunch of buffers and files on your screen wherever you like. Typically, a brief visual pulse is shown first at the source item and then in the destination window, to help you see that the transfer has been made. An Assist Key Drag will move the the item list buffer to the destination (swapping buffers), just as it does with other buffers. @node Keyboard Drags, , Displaying File and Buffer Items, Dragging Buffers @subsubsection Keyboard Drags @kindex M-o @kindex C-u M-o @kindex C-x o @findex hkey-operate @cindex drag emulation @cindex emulation, drag @cindex keyboard drags If you run Emacs under a window system and there is no prior key binding on @bkbd{M-o} when you load Hyperbole, then many Action Key drags can be emulated from the keyboard. To do so, press @bkbd{M-o}, the @code{hkey-operate} command, at the button source location, move to the link destination, e.g.@: with @bkbd{C-x o}, and then press @bkbd{M-o} again. This simulates a depress and release of the Action Key. @bkbd{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. @findex ace-window @findex hkey-ace-window-setup @cindex ace-window @cindex window by letter @cindex jump to window by letter @cindex keyboard, jump to window For even faster keyboard-based display of items and drag emulations, use the Emacs package @code{ace-window} (see @url{https://elpa.gnu.org/packages/ace-window.html}). The ace-window package assigns short letter IDs to each Emacs window and lets you jump to or operate upon a specific window by giving its ID. Hyperbole can add commands to ace-window that replace the two-step drag emulation key described above with a single key sequence that does not require moving to the drag target window since it is specified by ID as part of the command. To enable this feature, in your Emacs initialization file after Hyperbole is initialized, if you do not have a key bound for @code{ace-window}, then call: @code{(hkey-ace-window-setup \"\M-o\")} to bind it to @bkbd{M-o}, replacing Hyperbole's default @code{hkey-operate} command there (because ace-window can emulate the drags performed by @code{hkey-operate}). If you already have a key bound for @code{ace-window}, then just ensure it is initialized by calling @code{(hkey-ace-window-setup)} without a key argument. @cindex link creation from keyboard @cindex keyboard link creation @kindex M-o i @kindex M-o m @kindex M-o r @kindex M-o t @cindex drag item @cindex replace window buffer @cindex swap window buffers @cindex throw item @cindex buffer replace @cindex buffers swap @cindex item drag @cindex item throw After setup, the leftmost character or two of each window's modeline will show the ID to type to use that window as the drag destination. Then whenever point is on an item you want displayed in another window, use @bkbd{M-o i } and watch the magic happen. If you want to display multiple items in different windows, instead use the @bkbd{M-o t } key sequence to @emph{throw} the item to the window. To @emph{replace} the selected window's buffer with that of another window, use @bkbd{M-o r }. To instead @emph{swap} the selected window's buffer with that of another window, use @bkbd{M-o m }. In summary: @table @asis @item M-o i insert listing item at point into ; if not on a listing item, trigger an error @item M-o m swap the buffers in the selected window and @item M-o r replace the selected (current) window's buffer with that of @item M-o t throw listing item at point or current buffer to @end table @c ------- @c @node Smart Mouse Key Modifiers, , Smart Mouse Key Drags, Smart Keys @c @section Smart Mouse Key Modifiers @c For advanced users of Emacs and Hyperbole, there is @code{hmouse-mod-mode}, @c a global minor mode which turns the Action Mouse Key into a @key{Control} @c modifier key and the Assist Mouse Key into a @key{Meta} modifier key. This @c allows for better keyboard energy balance across hands and is useful for @c reducing carpal tunnel stress. It may also be used with a @dfn{chord @c keyboard} in one hand and a mouse in the other to point at things while @c simultaneously operating upon them. @c @findex hmouse-mod-mode @c @vindex hmouse-mod-mode @c @cindex Smart Keys as modifiers @c @cindex control key modifier @c @cindex meta key modifier @c @cindex chord keyboards @c Use the @code{hmouse-mod-mode} global minor mode to enable this feature. @c @bkbd{C-u M-x hmouse-mod-mode @key{RET}} enables it and adds @c @samp{HyMod} to the list of modeline minor modes. @bkbd{C-u 0 M-x @c hmouse-mod-mode @key{RET}} disables it and @bkbd{M-x @c hmouse-mod-mode @key{RET}} toggles it on and off. @c When enabled, if the Action Mouse Key is held down while alpha characters @c are typed, they are translated into @key{Control} keys instead. The @c Assist Key translates them into @key{Meta} keys. When both Smart @c Keys are depressed, @key{Control-Meta} keys are produced. The @c commands bound to the characters produced are then run. For example, @c Action Key + @bkbd{a} runs the function for @bkbd{C-a}. If no @c keys are typed while the Smart Keys are down, they operate as @c normally under Hyperbole. @c The code for Smart Key modifiers can be found in @c @file{$@{hyperb:dir@}/hmouse-mod.el}. @node Buttons, Menus, Smart Keys, Top @chapter Buttons @cindex button This chapter explains use of Hyperbole @emph{buttons}. There are several kinds of Hyperbole buttons: buttons that are created one at a time and stored in files (@dfn{explicit buttons}); buttons that can be activated by name anytime (@dfn{global buttons}); and buttons defined by textual patterns where one definition can create an infinite number of buttons (@dfn{implicit buttons}). Hyperbole buttons are embedded within textual documents; they may be created, modified, moved or deleted. Each button performs a specific action, such as linking to a file or executing a shell command. @cindex button, explicit @cindex button, global @cindex button, implicit @cindex button category @cindex explicit button @cindex global button @cindex implicit button @noindent There are three categories of Hyperbole buttons: @table @dfn @item explicit buttons created by Hyperbole, accessible from within a single document; @item global buttons created by Hyperbole, specific to each user, and accessible anywhere within a user's network of documents; @item 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). @end table 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 typing their names, rather than by direct selection, the means used to activate explicit and implicit buttons. @noindent To summarize: @example Button Category Active Within Activation Means Managed By ======================================================================== Explicit a single document direct selection Hyperbole Global any document typing its name Hyperbole Implicit a matching context direct selection other tools @end example @cindex terminal use A click on a Hyperbole button may activate it or describe its actions, depending on which mouse key is used. Buttons may also be activated from a keyboard. (In fact, many Hyperbole operations, including menu usage, may be performed from any standard character terminal interface, so you need not be anchored to a desktop all day). @xref{Smart Keys}. There is also a key that shows you how a button will behave before you activate it, @pxref{Smart Key Operations}. @menu * Explicit Buttons:: * Global Buttons:: * Implicit Buttons:: * Button Files:: * Action Types:: * Button Type Precedence:: * Utilizing Explicit Buttons:: @end menu @node Explicit Buttons, Global Buttons, Buttons, Buttons @section Explicit Buttons @cindex explicit button @cindex button, explicit @cindex button label @cindex button name @cindex label, button @cindex name, button Hyperbole creates and manages @dfn{explicit buttons} which perform specific actions when activated (typically through a button press). They look like this @samp{<(fake button)>}. They are quickly recognizable, yet relatively non-distracting as you scan the text in which they are embedded. The text between the @samp{<(} and @samp{)>} delimiters is called the @dfn{button label} or @dfn{button name}. Spacing between words within a button label is irrelevant to Hyperbole. Button labels may wrap across several lines without causing a problem; just be sure to select the first line of the button to activate it. Explicit buttons may be added to any editable text file; for source code files, simply place buttons within comments. Buttons that you use for quick navigation to websites or other things you do often should be added to your personal button file. @xref{Button Files}. @cindex button, moving @cindex moving buttons Explicit buttons may be freely moved about within the buffer in which they are created. (No present support exists for moving buttons between buffers; support the Hyperbole project if you would like to help make this happen). A single button may also appear multiple times within the same buffer; simply copy the button label with its delimiters to a new location if you need another copy of it. For details on how to create, activate, delete or modify explicit buttons, @pxref{Utilizing Explicit Buttons}. @cindex link button @cindex referent Each explicit button is assigned an action type that determines the actions it performs. @dfn{Link action types} connect buttons to particular types of @dfn{referents}, the targets of their links. Link action type names all begin with @code{link-}. Link action button referents are displayed when such buttons are activated with a press or a click. @xref{Action Types}, for a list of standard action types including link types. @cindex linking, in-place @cindex Hyperbole data model 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 data to integrate it with Hyperbole. @cindex button data @cindex button attribute @vindex file, .hypb Hyperbole stores the @dfn{button data} that gives an explicit button its behavior, separately from the button label, in a file named @file{.hypb} (@file{_hypb} under MS Windows) within the same directory as the file in which the button is created. Thus, all files in the same directory share a common button data file. Button data is comprised of individual @dfn{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. @node Global Buttons, Implicit Buttons, Explicit Buttons, Buttons @section Global Buttons @cindex global button @cindex button, global @cindex button label @cindex label, button 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 @dfn{global buttons}, which are buttons that may be activated or otherwise operated upon by typing their labels/names when they are prompted for, rather than selecting the buttons within a buffer. If you want a permanent link to a file section that you can follow at any time, you can use a global button. Or what about an Emacs keyboard macro that you use frequently? Create an @code{exec-kbd-macro} button with an easy to type name and then you can activate it whenever the need arises. @kindex C-h h g @cindex menu, Gbut @cindex menu, Global-Button Global buttons are managed with the Hyperbole Gbut/ menu accessed with @bkbd{C-h h g}. The Create item, @bkbd{C-h h g c}, prompts for a global button name, an action type, and the action's associated arguments, such as a file to link to. It then creates the button. To activate the button, use the Act menu item, @bkbd{C-h h g a}. Type the button's name and its action will be executed. Global buttons are actually explicit buttons stored at the end of your personal button file, @pxref{Button Files}. You can always go into that file and activate, edit or annotate these buttons with comments. @cindex bookmarks Emacs has a built-in feature similar to Global Buttons called Bookmarks. Bookmarks store places in files or link to URLs, so they are more limited than Hyperbole's global buttons and cannot utilize all of Hyperbole's capabilities for performing actions. @xref{Bookmarks,,,emacs, the Emacs Manual}, for details on bookmarks. @node Implicit Buttons, Button Files, Global Buttons, Buttons @section Implicit Buttons @cindex button, implicit @cindex implicit button @dfn{Implicit buttons} are virtual buttons recognized within the natural structure of a document. For example, a web URL button that displays its link or an email address button that starts a mail message to the associated address. Implicit buttons are identified by contextual patterns found within documents. An @dfn{Implicit button type} identifies a pattern or state that when matched triggers an @emph{action} associated with the implicit button type. The action is specified by either a Hyperbole action type (@pxref{Action Types}) or an Emacs Lisp function. Implicit button types may use the same action types that explicit buttons use. As an example, the pathname implicit button type matches to any existing local filename or directory name and its action displays the associated file or directory, typically in another window. @vindex file, hibtypes.el @cindex context @cindex boolean expressions @cindex activating implicit button @cindex menu item, Ibut/Act @kindex C-h h i a Unlike explicit buttons, implicit buttons have no individual button data other than their text and optional labels. You use implicit button types which include boolean expressions (predicates) that match to both the label and the context required of any button of the type. Each time a Smart Key is pressed at a location, Hyperbole evaluates the predicates from the list of implicit button types and the first one that evaluates true is selected and its associated action is triggered. Alternatively, you can use the Ibut/Act menu item, @bkbd{C-h h i a}, to activate any implicit button found at the current point. All of this happens transparently and is easy to use once you try it. The Hyperbole Smart Keys offer additional extensive context-sensitive point-and-click type behavior beyond implicit button types. @xref{Smart Key Operations}. @cindex implicit button labels @cindex labeling implicit buttons @cindex naming implicit buttons Individual implicit buttons may be labeled, allowing activation by name or use as a link target by other buttons. Here is a pathname button with a label of 'My Emacs Files': @example <[My Emacs Files]>: "~/.emacs.d" @end example The label is delimited by @samp{<[} and @samp{]>} and can be followed by any number of :, - or = separator characters, including none. You can activate the button either from its label or its text. With point on an implicit button, @bkbd{C-h h i l} will label it or you may simply type the label and delimiters manually. @menu * Implicit Button Type Summaries:: @end menu @node Implicit Button Type Summaries, , Implicit Buttons, Implicit Buttons @subsection Implicit Button Type Summaries @cindex ibtypes, list of @cindex implicit button types Below, standard implicit button types are listed in the order in which Hyperbole tries to match to the types when looking for an implicit button; @bkbd{C-h h i t @key{RET}} provides similar information. See the Hyperbole file, @file{hibtypes.el}, for complete examples of implicit button types (they are listed in increasing order of priority). @table @code @findex ibtypes completion @cindex completion @item completion Inserts the completion at point (from a completions buffer) into the minibuffer or the other window. @findex ibtypes hyp-source @cindex Hyperbole report @item hyp-source Turns source location entries following an `@@loc>' line in Hyperbole reports into buttons that jump to the associated location. For example, @bkbd{C-h h d d C-h h e h o} summarizes the properties of the explicit buttons in the @file{DEMO} file and each button in that report buffer behaves the same as the corresponding button in the original @file{DEMO} file. @findex ibtypes hyp-address @cindex Hyperbole mail list @item hyp-address Within a mail or Usenet news composer window, makes a Hyperbole support/discussion e-mail address insert Hyperbole environment and version information. This is useful when sending mail to a Hyperbole discussion mail list. See also the documentation for @code{actypes::hyp-config}. For example, an Action Mouse Key click on in a mail composer window would activate this implicit button type. @findex ibtypes Info-node @cindex Info node @item Info-node Makes a "(filename)nodename" button display the associated Info node. Also makes a "(filename)itemname" button display the associated Info index item. Examples are "(hyperbole)Implicit Buttons" and ``(hyperbole)C-c /''. @findex ibtypes www-url @cindex URL @cindex World-wide Web @cindex WWW @cindex Action Key, web browsing @kindex Action Key, web browsing @vindex browse-url-browser-function @item www-url When not in an Emacs web browser buffer, follows any non-ftp URL (link) at point. The variable, @code{browse-url-browser-function}, may be used to customize which URL browser is called. Terse URLs which lack a protocol prefix, like www.gnu.org, are also recognized. @findex ibtypes gnus-push-button @cindex GNUS push-buttons @cindex hiding signatures @cindex signatures, hiding @item gnus-push-button Activates GNUS-specific article push-buttons, e.g. for hiding signatures. GNUS is a news and mail reader. @findex ibtypes texinfo-ref @cindex Texinfo cross-reference @cindex cross-reference, Texinfo @item texinfo-ref Displays Texinfo, Info node or help associated with Texinfo node, menu item, @@xref, @@pxref, @@ref, @@code, @@findex, @@var or @@vindex at point. If point is within the braces of a cross-reference, the associated Info node is shown. If point is to the left of the braces but after the @@ symbol and the reference is to a node within the current Texinfo file, then the Texinfo node is shown. For @@code, @@findex, @@var and @@vindex references, the associated documentation string is displayed. @findex ibtypes mail-address @cindex e-mail address @cindex rolo address @cindex address @item mail-address If on an e-mail address in a specific buffer type, compose mail to that address in another window. Applies to the rolo match buffer, any buffer attached to a file in @code{hyrolo-file-list}, or any buffer with @file{mail} or @file{rolo} (case-insensitive) within its name. @findex ibtypes patch-msg @cindex patch output @item patch-msg Jumps to the source code associated with output from the @samp{patch} program. Patch applies diffs to source code. @findex ibtypes elisp-compiler-msg @cindex byte compiler error @cindex Emacs Lisp compiler error @cindex compiler error @item elisp-compiler-msg Jumps to the source code for a definition associated with an Emacs Lisp byte-compiler error message. Works when activated anywhere within an error line. @findex ibtypes debugger-source @cindex gdb @cindex dbx @cindex xdb @cindex stack frame @cindex breakpoint @cindex source line @item 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. @findex ibtypes ripgrep-msg @cindex grep @cindex ripgrep @cindex match lines @item ripgrep-msg Jumps to line associated with a ripgrep (rg) line numbered msg. Ripgrep outputs each pathname once followed by all matching lines in that pathname. Messages are recognized in any buffer (other than a helm completion buffer). @findex ibtypes ipython-stack-frame @cindex ipython @cindex stack frame @item ipython-stack-frame Jumps to line associated with an ipython stack frame line numbered msg. ipython outputs each pathname once followed by all matching lines in that pathname. Messages are recognized in any buffer (other than a helm completion buffer). @findex ibtypes grep-msg @cindex grep @cindex compiler error @cindex match lines @item grep-msg Jumps to a line associated with grep or compilation error messages. Messages are recognized in any buffer. @findex ibtypes link-to-ibut @cindex implicit button link @cindex link to implicit button @cindex ilink @item link-to-ibut At point, activates a link to an implicit button within the current buffer. Recognizes the format ’ ’>’, e.g. . @findex ibtypes link-to-gbut @cindex global button link @cindex link to global button @cindex glink @item link-to-gbut At point, activates a link to a global button. The global button’s action is executed in the context of the current buffer. Recognizes the format ’ ’>’, e.g. . @findex ibtypes link-to-ebut @cindex explicit button link @cindex link to explicit button @cindex elink @item link-to-ebut At point, activates a link to an explicit button within the current buffer. Recognizes the format ’ ’>’, e.g. . @findex ibtypes klink @cindex klink @cindex koutline link @cindex kcell link @item klink Follows a link delimited by <> to a koutline cell. See the documentation for @code{actypes::link-to-kotl} for valid link specifiers. @findex ibtypes man-apropos @cindex UNIX manual @cindex man pages @cindex man apropos @item man-apropos Makes man apropos entries (from @samp{man -k}) display associated man pages when selected. @findex ibtypes rfc @cindex Internet RFC @cindex Request For Comment @cindex RFC @cindex remote file @cindex ftp @item rfc Retrieves and displays an Internet rfc referenced at point. The following formats are recognized: RFC822, rfc-822, and RFC 822. The @code{hpath:rfc} variable specifies the location from which to retrieve RFCs. Requires the Emacs builtin Tramp library for ftp file retrievals. @findex ibtypes kbd-key @cindex key sequence @cindex sequence of keys @item kbd-key Executes a key series (series of key sequences) found around point, delimited by curly braces, @{@}, if any. Key series should be in human readable form, e.g.@: @bkbd{C-x C-b}. Formats such as @{^x^b@} will not be recognized. Any key sequence must be a string of one of the following: @itemize @bullet @item a Hyperbole minibuffer menu item key sequence, @item a HyControl key sequence, @item a M-x extended command, @item or a valid key sequence together with its interactive arguments. @end itemize @findex ibtypes dir-summary @vindex file, MANIFEST @vindex file, DIR @item dir-summary Detects filename buttons in files named "MANIFEST" or "DIR". Displays selected files. Each filename 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. @findex ibtypes text-toc @cindex table of contents @cindex toc implicit button type @item text-toc Jumps to the text file section referenced by a table of contents entry at point. The filename of the current buffer must contain @file{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. @findex ibtypes cscope @cindex C/C++ call trees @cindex C/C++ cross-reference @cindex Cscope @item 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 open source cscope program available from http://cscope.sf.net. Otherwise, does nothing. @findex ibtypes etags @cindex etags entry @cindex TAGS file @cindex tag @item 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. @findex ibtypes ctags @cindex ctags entry @cindex tags file @item 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. Emacs uses the newer, more flexible Etags format. @findex ibtypes id-cflow @cindex C call tree @cindex call tree, C @cindex C flow graph @item id-cflow Expands or collapses C call trees and jumps to code definitions. Requires cross-reference tables built by the external @code{cxref} program. @findex ibtypes rfc-toc @cindex Internet RFC @cindex Request For Comment @cindex RFC @cindex table of contents @item 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. @findex ibtypes markdown-internal-link @cindex markdown link @item markdown-internal-link Displays any in-file Markdown link referent. Pathnames and urls are handled elsewhere. @findex ibtypes git-reference @cindex git reference @cindex version control @vindex hibtypes-git-default-project @item git-reference Displays the git entity associated with REFERENCE and optional PROJECT. See @file{DEMO#Git (Local) References} for examples. REFERENCE is a string of one of the following forms: @itemize @bullet @item @item /?/ @item /. @end itemize is one of these: @table @asis @item one of the words: branches, commits, or tags the associated items are listed @item one of the words: branch, commit, or tag followed by a '/' and item id the item is shown @item a commit reference given by a hex number, 55a1f0 the commit diff is displayed @item a branch or tag reference given by an alphanumeric name, e.g. hyper20 the files in the branch are listed. @end table @vindex hibtypes-git-default-project If given, PROJECT overrides any project value in REFERENCE. If no PROJECT value is provided, it defaults to the value of @code{hibtypes-git-default-project}. @findex ibtypes git-commit-reference @cindex git commit reference @cindex version control @item git-commit-reference Displays the diff for a git commit reference, e.g. commit a55e21, typically produced by git log. @findex ibtypes github-reference @cindex github reference @cindex version control @vindex hibtypes-github-default-project @vindex hibtypes-github-default-user @item github-reference Displays the Github entity associated with REFERENCE and optional USER and PROJECT. See @file{../DEMO#Github (Remote) References} for examples. REFERENCE is a string of one of the following forms: @itemize @bullet @item @item // @item / @item /. @end itemize is one of these: @table @asis @item @bullet{} one of the words: branches, commits, issues, pulls, or tags the associated items are listed @item @bullet{} one of the words: branch, commit, issue, pull or tag followed by a '/' and item id the item is shown @item @bullet{} an issue reference given by a positive integer, e.g. @emph{92} or prefaced with @emph{GH-}, like GH-92 the issue is displayed @item @bullet{} a commit reference given by a hex number, 55a1f0 the commit diff is displayed @item @bullet{} a branch or tag reference given by an alphanumeric name, e.g. hyper20 the files in the branch are listed. @end table @vindex hibtypes-github-default-user USER defaults to the value of @code{hibtypes-github-default-user}. If given, PROJECT overrides any project value in REFERENCE. If no PROJECT value is provided, it defaults to the value of @code{hibtypes-github-default-project}. @findex ibtypes gitlab-reference @cindex gitlab reference @cindex version control @vindex hibtypes-gitlab-default-project @vindex hibtypes-gitlab-default-user @item gitlab-reference Displays the Gitlab entity associated with REFERENCE and optional USER and PROJECT. See @file{../DEMO#Gitlab (Remote) References} for examples. REFERENCE is a string of one of the following forms: @itemize @bullet @item @item // @item / @item //. or @item / (where a group is a colection of projects) @end itemize is one of these: @table @asis @item @bullet{} one of the words: activity, analytics, boards or kanban, branches, commits, contributors, groups, issues or list, jobs, labels, merge_requests, milestones, pages, pipelines, pipeline_charts, members or people or staff, projects, pulls, schedules, snippets, status or tags the associated items are listed @item @bullet{} one of the words: branch, commit(s), issue(s), milestone(s), pull(s), snippet(s) or tag(s) followed by a '/' or '=' and an item-id the item is shown @item @bullet{} an issue reference given by a positive integer, e.g. @emph{92} or prefaced with @emph{GL-}, like GL-92 the issue is displayed @item @bullet{} a commit reference given by a hex number, 55a1f0 the commit diff is displayed @item @bullet{} a branch or tag reference given by an alphanumeric name, e.g. hyper20 the files in the branch are listed. @end table @vindex hibtypes-gitlab-default-user USER defaults to the value of @code{hibtypes-gitlab-default-user}. If given, PROJECT overrides any project value in REFERENCE. If no PROJECT value is provided, it defaults to the value of @code{hibtypes-gitlab-default-project}. @findex ibtypes social-reference @cindex hashtag @cindex username @cindex social media @cindex social reference @vindex hibtypes-social-default-service @item social-reference Displays the web page associated with a social media hashtag or username reference at point. Reference format is: @example [facebook|instagram|twitter]?[#@@] or [fb|in|tw]?[#@@] @end example @noindent For example, @samp{fb@@someuser} displays the home page for facebook user @samp{someuser} and @samp{in#hashtag} displays photos with the hashtag @samp{hashtag}. The first part of the label for a button of this type is the social media service name. The service name defaults to the value of @code{hibtypes-social-default-service} (default value of ``twitter'') when not given, so #hashtag would be the same as twitter#hashtag. @findex ibtypes debbugs-gnu-mode @cindex bug tracking @cindex issue tracking @item debbugs-gnu-mode Debbugs is a client-server issue tracker used by GNU free software projects, including Hyperbole, to manage issues and maintain threads of discussion around them. You issues queries to a Debbugs server and it returns a listing entry for each matching issue. When on a GNU Debbugs listing entry in @code{debbugs-gnu-mode}, an Action Key press displays the discussion of the selected issue; an Assist Key press pretty prints the status of the issue to a window below the listing window. @findex ibtypes debbugs-gnu-query @item debbugs-gnu-query Debbugs queries may be issued by activating this implicit button type. It displays the results of a Gnu debbugs query based on the string at point and works in most kinds of buffers. If the query includes a single id number, it displays the original message submission for that id and allows browsing of the followup discussion. The following buffer text formats are accepted (with point prior to any attribute): @smallexample bug#id-number, bug# id-number, bug #id-number or bug id-number bug?attr1=val1&attr2=val2&attr3=val3 bug#id-number?attr1=val1&attr2=val2&attr3=val3 @end smallexample @vindex file, hib-debbugs.el @noindent Note that @emph{issue} or @emph{debbugs} may be used as well in place of @emph{bug}. See the documentation at the top of the @file{hib-debbugs.el} file for detailed query format information. @findex ibtypes annot-bib @cindex bibliography @cindex reference @item 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. @c Handled instead by @xref{Smart Key - Identifier Menu Mode}. @c @findex ibtypes imenu-item @c @vindex file, imenu.el @c @cindex identifier menu @c @cindex imenu @c @item imenu-item @c Displays the in-buffer definition of an identifier that point is within or after, else nil. @c This triggers only when imenu has already been used to generate an in-buffer item index. @findex ibtypes function-in-buffer @vindex file, func-menu.el @cindex function menu @cindex func-menu @item function-in-buffer Returns the function name defined within this buffer that point is within or after, else @samp{nil}. This triggers only when the func-menu library has been loaded and the current major mode is one handled by func-menu. @cindex link, pathname line and column @cindex line and column @cindex pathname, line and column @findex ibtypes pathname-line-and-column @item pathname-line-and-column Makes a valid pathname:line-num[:column-num] pattern display the path at line-num and optional column-num. Also works for remote pathnames. @findex ibtypes pathname @findex hpath:at-p @findex hpath:find @vindex hpath:suffixes @cindex Tramp @cindex ftp @cindex pathname @cindex remote path @cindex filename @cindex link, pathname @item pathname Makes a valid pathname display the path entry. Also works for delimited and non-delimited remote pathnames, Texinfo @@file@{@} entries, and hash-style link references to HTML, Markdown or Emacs outline headings, and MSWindows paths (see @file{$@{hyperb:dir@}/DEMO#POSIX and MSWindows Paths} for details). Emacs Lisp library files (filenames without any directory component that end in .el and .elc) are looked up using the @code{load-path} directory list. @noindent See the function documentation for @code{hpath:at-p} for possible delimiters. See the variable documentation for @code{hpath:suffixes} for suffixes that are added to or removed from the pathname when searching for a valid match. See the function documentation for @code{hpath:find} for special file display options. @findex ibtypes org-mode @cindex org-mode @cindex Org mode @cindex radio target @cindex code block @kindex C-c C-c @kindex M-RET @findex org-ctrl-c-ctrl-c @findex org-meta-return @item org-mode For users of Emacs Org mode, Hyperbole does quite a few things. First, the Action Key follows internal links in Org mode files. When pressed on a link referent/target, the link definition is displayed, allowing two-way navigation between definitions and targets. Second, the Action Key follows Org mode external links. The Assist Key displays help when pressed on an Org mode link. Third, within a radio target definition, the Action Key jumps to the first occurrence of an associated radio target. Fourth, when point is on an outline heading in Org mode, the Action Key cycles the view of the subtree at point and the Assist Key cycles the view of all headings in the buffer. Fifth, with point on the first line of a code block definition, the Action Key executes the code block via the Org mode standard binding of @bkbd{C-c C-c}, @code{org-ctrl-c-ctrl-c}. In any other context besides the end of a line, the Action Key invokes the Org mode standard binding of @bkbd{M-RET}, @code{org-meta-return}. @findex ibtypes doc-id @cindex online library @cindex document identifier @item doc-id Displays a document from a local document library given its id. Ids must be delimited by @code{doc-id-start} and @code{doc-id-end} and must match the function given by @code{doc-id-p}. (Note that this implicit button type is not installed by default. You must manually configure it and load it from the file, @file{@code{$@{hyperb:dir@}}/hib-doc-id.el}). See the commentary at the top of that file for more information. @end table @node Button Files, Action Types, Implicit Buttons, Buttons @section Button Files @cindex button files It is often convenient to create files filled with buttons as a means of navigating distributed information pools or for other purposes. These files can also serve as useful roadmaps that guide a user through both unfamiliar and highly familiar information spaces. Files that are created specifically for this purpose are called @dfn{Hyperbole button files}. @vindex hbmap:filename @cindex button file, personal @cindex button file, directory The Hyperbole menu system provides quick access to two types of these button files: personal and directory-specific, through the ButFile menu. (The variable, @code{hbmap:filename}, contains the base name of these button files. Its standard value is @file{HYPB}.) @vindex dir, ~/.hyperb @vindex hbmap:dir-user @cindex global button A personal button file may serve as a user's own roadmap to frequently used resources, like a personal home page. Selection of the ButFile/PersonalFile menu item, @bkbd{C-h h b p}, displays this file for editing. The default personal button file is stored within the directory given by the @code{hbmap:dir-user} variable whose standard value is @file{~/.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, @bkbd{C-h h b d}, displays the button file for the current directory; this provides an easy means of updating this file when working on a file within the same directory. If you want to view some other directory-specific button file, simply use the normal Emacs file finding commands. If you want group and site-specific button files, simply place links to such files at the top of your personal button file and do so for your colleagues. This provides a flexible means of connecting to such resources. @node Action Types, Button Type Precedence, Button Files, Buttons @section Action Types @cindex action type @cindex argument, use @cindex action @cindex button action @dfn{Action types} are special functions that specify Hyperbole button behaviors. Each action type may be used by any category of button: global, explicit, or implicit. The arguments 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 @dfn{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. @cindex actypes, list of @noindent The standard action types included with Hyperbole in alphabetical order are: @table @code @findex actypes annot-bib @item annot-bib Follows an internal reference KEY within an annotated bibliography, delimiters = [ ]. @findex actypes completion @item completion Inserts a completion at point into the minibuffer or a buffer. Unless point is at the end of buffer or if a completion has already been inserted, in which case the completions window is deleted. @findex actypes eval-elisp @item eval-elisp Evaluates a Lisp expression LISP-EXPR. @findex actypes exec-kbd-macro @item 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. @findex actypes exec-shell-cmd @item 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. @findex actypes exec-window-cmd @item exec-window-cmd Asynchronously executes an external window-based SHELL-CMD string. @findex actypes function-in-buffer @item function-in-buffer Displays the definition of function NAME found at POS in the current buffer. @findex actypes hyp-config @item hyp-config Inserts Hyperbole configuration and debugging information at the end of the current buffer or within optional OUT-BUF. @findex actypes hyp-request @item hyp-request Inserts help for composing a Hyperbole support/discussion message into the current buffer or the optional OUT-BUF. @findex actypes hyp-source @item hyp-source Displays a buffer or file from a line beginning with @code{hbut:source-prefix}. @findex actypes kbd-key @item kbd-key Executes the function binding for KEY-SEQUENCE, delimited by @{@}. Returns @samp{t} if a KEY-SEQUENCE has a binding, else @samp{nil}. @cindex link action types @findex actypes link-to-buffer-tmp @item link-to-buffer-tmp Displays a BUFFER. This type of link generally can only be used within a single editor session. Use @code{link-to-file} instead for a permanent link. @findex actypes link-to-directory @item link-to-directory Displays a DIRECTORY in Dired mode. @findex actypes link-to-doc @item 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 @code{doc-id-indices}, an error is signalled. @findex actypes link-to-ebut @item link-to-ebut Performs an action given by an explicit button, specified by KEY and KEY-FILE. @findex actypes link-to-elisp-doc @item link-to-elisp-doc Displays the documentation for FUNC-SYMBOL. @findex actypes link-to-file @item link-to-file Displays a file given by PATH scrolled to optional POINT. If POINT is given, the buffer is displayed with POINT at the top of the window. @findex actypes link-to-file-line @item link-to-file-line Displays a file given by PATH scrolled to LINE-NUM. @findex actypes link-to-gbut @item link-to-gbut Performs an action given by an existing global button, specified by KEY. @findex actypes link-to-Info-index-item @item link-to-Info-index-item Displays an Info index ITEM cross-reference. ITEM must be a string of the form (filename)item-name. During button creation, completion for both filename and item-name is available. Filename may be given without the .info suffix." @findex actypes link-to-Info-node @item link-to-Info-node Displays an Info NODE. NODE must be a string of the form (filename)nodename. During button creation, completion for both filename and nodename is available. Filename may be given without the .info suffix. @findex actypes link-to-ibut @item link-to-ibut Performs an action given by an implicit button, specified by KEY-FILE, KEY and optional POINT. @findex actypes link-to-kcell @findex kcell:ref-to-id @item link-to-kcell Displays a Hyperbole outline cell, given by FILE and CELL-REF, at the top of a window. See the documentation for @code{(kcell:ref-to-id)} for valid CELL-REF formats. @noindent If FILE is @samp{nil}, the current buffer is used. If CELL-REF is @samp{nil}, the first cell in the view is shown. @findex actypes link-to-kotl @item 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: @example < pathname [, cell-ref] > < [-!&] pathname > < @@ cell-ref > @end example @noindent See the documentation for @code{(kcell:ref-to-id)} for valid cell-ref formats. @findex actypes link-to-mail @item link-to-mail Displays a mail message with MAIL-MSG-ID from optional MAIL-FILE. See the documentation for the variable @code{hmail:init-function} for information on how to specify the mail reader to use. @findex actypes link-to-regexp-match @item 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 @samp{t} if found, signals an error if not. @findex actypes link-to-rfc @item link-to-rfc Retrieves and displays an Internet rfc given by RFC-NUM. RFC-NUM may be a string or an integer. @findex actypes link-to-string-match @item 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 @samp{t} if found, @samp{nil} if not. @findex actypes link-to-texinfo-node @item link-to-texinfo-node Displays the Texinfo node with NODENAME (a string) from the current buffer. @findex actypes link-to-web-search @cindex link, web search @cindex web search link @item link-to-web-search Searches web SERVICE-NAME for SEARCH-TERM. Uses @code{hyperbole-web-search-alist} to match each service to its search url. Uses @code{hyperbole-web-search-browser-function} and the @code{browse-url} package to display search results. @findex actypes man-show @vindex sm-notify @item man-show Displays a man page on TOPIC, which may be of the form @samp{(
}). If using the Superman manual entry package, see the documentation for @code{sm-notify} to control where the man page is displayed. @findex actypes rfc-toc @item 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. @findex actypes text-toc @cindex table of contents @cindex toc action type @item text-toc Jumps to the text file SECTION referenced by a table of contents entry at point. @findex actypes www-url @cindex URL @cindex World-wide Web @cindex WWW @vindex browse-url-browser-function @item www-url Follows a link given by a URL. The variable, @code{browse-url-browser-function}, customizes the url browser that is used. Valid values of this variable include @code{browse-url-default-browser} and @code{browse-url-generic}. See its documentation string for details. @end table @cindex action @vindex hui:ebut-prompt-for-action 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, @code{hui:ebut-prompt-for-action} should be set to @samp{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 @samp{nil} value should be entered for the action. An action may be any Lisp form that Emacs Lisp can evaluate. @node Button Type Precedence, Utilizing Explicit Buttons, Action Types, Buttons @section Button Type Precedence @cindex button precedence @cindex precedence, buttons @cindex button label overlap 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. @cindex ibtype, evaluation order 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 @dfn{domains}, those contexts in which their predicates are true, only the first matching type is used. The type predicates are tested in @emph{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. @cindex type redefinition 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. @xref{Creating Types}, for information on how to develop or modify types. @node Utilizing Explicit Buttons, , Button Type Precedence, Buttons @section 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:: * Searching and Summarizing:: * Buttons in Mail:: * Buttons in News:: @end menu @node Creation, Renaming, Utilizing Explicit Buttons, Utilizing Explicit Buttons @subsection Creation Creating explicit buttons is fun and easy. You can always try them out immediately after creating them or can utilize the Assist Key to verify what buttons do. There are two ways to create them: by dragging between windows with the Action Mouse Key or by using the Hyperbole menus. @menu * By Dragging:: Creation Via Action Key Drags * By Menu:: Creation Via Menus @end menu @node By Dragging, By Menu, Creation, Creation @subsubsection Creation Via Action Key Drags @cindex explicit button creation @cindex button creation @cindex creating buttons @cindex link creation @cindex creating links @cindex direct link creation @cindex mouse drag, link creation @cindex drag @cindex Action Key drag The most efficient way to create an explicit link button interactively is to use the Action Mouse Key to drag from a non-read-only button source window to a window showing its desired link referent. More specifically, you should split your current Emacs frame into two windows: one which contains the point at which you want a button to be inserted and another which shows the point to which you want to link. Depress the Action Mouse Key at the source point for the button (anywhere but on a paired delimiter such as double quotes or parentheses). Then drag to the other window and release the Action Mouse Key at the start point of the link referent. The process becomes quite simple with a little practice. (@xref{By Menu, Creation Via Menus}, for a more detailed explanation of the explicit button creation process). If a region was selected prior to the start of the drag, it is used as the button label, otherwise, you are prompted for the label. Then Hyperbole uses the link referent context to determine the type of link to make. If there are a few different types of links which are applicable from the context, you will be prompted with a list of the types. Simply use the Action Key or the first letter of the link type to select one of the type names and to finish the link creation. Hyperbole will then insert explicit button delimiters around the button label and will display a message in the minibuffer indicating the button label, its action/link type, and any arguments, notably the thing to which it links. The following table shows the type of link that will be created based upon the referent context in which the Action Key is released. @format @example Referent Context Link Type ---------------------------------------------------- Global Button link-to-gbut Explicit Button link-to-ebut Implicit Button link-to-ibut Info Index Item link-to-Info-index-item Info Node link-to-Info-node Mail Reader Message link-to-mail Directory Name link-to-directory Filename link-to-file Koutline Cell link-to-kcell Outline Heading link-to-string-match Buffer attached to File link-to-file Buffer without File link-to-buffer-tmp @end example @end format @node By Menu, , By Dragging, Creation @subsubsection 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 @bkbd{?} completion list key to see the available types. The type selected determines any following values for which you are prompted. @cindex button instance @cindex instance number If a previous button with the same label exists in the same buffer, Hyperbole will add an @dfn{instance number} to the label when it adds the delimiters so that the name is unique. Thus, you don't have to worry about accidental button name conflicts. If you want the same button to appear in multiple places within the buffer, just enter the label again and delimit it yourself or copy and paste the button with its delimiters. Hyperbole will interpret all occurrences of the same delimited label within a buffer as the same button. @cindex link, creation 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 @code{link-to-} and then use the direct selection techniques mentioned in @ref{Smart Key Argument Selection}, to select the link referent. @node Renaming, Deletion, Creation, Utilizing Explicit Buttons @subsection Renaming @cindex explicit button renaming @cindex button 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 to invoke the rename command again after the edit. The second invocation will actually rename the button. If instead the command is originally invoked outside of any explicit button, it will prompt for the button label to replace and the label to replace it with and then will perform the renaming. All occurrences of the same button in the buffer will be renamed. @vindex file, .emacs @vindex file, hyperbole.el @kindex C-c C-r @findex hui:ebut-rename The rename command may be invoked from the Hyperbole menu via Ebut/Rename. A faster method is to use a key bound to the @code{hui:ebut-rename} command. Hyperbole typically binds this to @bkbd{C-c C-r}. @bkbd{C-h w hui:ebut-rename @key{RET}} will show what if any key runs it. If no key binding has been established or if you prefer one of your own, simply bind it within your @file{~/.emacs} file: @code{(global-set-key "\C-c\C-r" 'hui:ebut-rename)}. @node Deletion, Modification, Renaming, Utilizing Explicit Buttons @subsection Deletion @cindex explicit button deletion @cindex button 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. @vindex hui:ebut-delete-confirm-p Presently there is no way to recover a deleted button; it must be recreated. Therefore, the @code{hui:ebut-delete-confirm-p} variable is true by default, causing Hyperbole to require confirmation before interactively deleting explicit buttons. Set it to @samp{nil} if you prefer no confirmation. @node Modification, Searching and Summarizing, Deletion, Utilizing Explicit Buttons @subsection Modification @cindex explicit button modification @cindex button modification @cindex Smart Mouse Key drag @cindex button attributes Ebut/Modify prompts you with each of the elements from the button's attributes list and allows you to modify each in turn. Ebut/Edit does the exact same thing and is there for people who prefer that term. There is a quicker way to modify explicit link buttons, however. Simply drag with the Action Mouse Key from within the button label to a link destination in a different window, just as you would when creating a new button with a mouse drag. Remember that drags may also be emulated from the keyboard. @xref{Creation}. @node Searching and Summarizing, Buttons in Mail, Modification, Utilizing Explicit Buttons @subsection Searching and Summarizing @cindex explicit button summary @cindex button summary @cindex button help 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. @cindex explicit button searching @cindex button searching 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. @node Buttons in Mail, Buttons in News, Searching and Summarizing, Utilizing Explicit Buttons @subsection Buttons in Mail @kindex C-x m @findex mail @cindex menu item, Cust/Msg-Toggle-Ebuts Hyperbole supports embedding buttons within electronic mail messages composed in Emacs. An enhanced mail reader may then be used to activate the buttons within messages just like any other buttons. Because this involves complex changes to mail support functions, this feature is disabled by default. Use the Cust/Msg-Toggle-Ebuts minibuffer menu item to enable it. @cindex button mailing @cindex button posting @cindex mailing buttons @cindex posting buttons @cindex mail reader @cindex mailer initialization @cindex Rmail @cindex VM @cindex MH-e @cindex Gnus @cindex USENET @cindex news @vindex file, hmail.el Hyperbole supports the following mail readers: Rmail (@pxref{Rmail,,Reading Mail with Rmail,emacs, the GNU Emacs Manual}), VM (@pxref{Introduction,,,vm, the VM Manual}) and MH-e. Button inclusion and activation within USENET news articles is also supported in the same fashion via the Gnus news reader if available at your site (@pxref{Top,,The Gnus Newsreader,gnus, the Gnus Manual}). (The @file{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.) @vindex mail-yank-original @kindex C-c C-y @cindex mail inclusion 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 @code{(mail-yank-original)} command bound to @bkbd{C-c C-y}. From a user's perspective, buttons are created in precisely the same way as in any other buffer. They also appear just like any other buttons to both the message sender and the reader who uses the Hyperbole enhanced readers. Button operation may be tested any time before a message is sent. A person who does not use Hyperbole enhanced mail readers can still send messages with embedded buttons since mail composing is independent of any mail reader choice. Hyperbole buttons embedded within received mail messages behave as do any other buttons. The mail does not contain any of the action type definitions used by the buttons, so the receiver must have these or she will receive an error when she activates the buttons. Buttons which appear in message @emph{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. @vindex smail:comment @cindex mail comment @cindex Hyperbole mail comment In order to alert readers of your mail messages that you can handle Hyperbole mail buttons, you can set the variable, @code{smail:comment}, to an expression that automatically inserts a comment into each outgoing message to announce this fact. See its documentation for technical details. By default, no comment is added. To have a comment line added to your outgoing message, add the following to to your @file{~/.emacs} file before the point at which you load Hyperbole. @lisp (setq smail:comment (format "Comments: GNU Hyperbole mail buttons accepted, v%s.\n" hyperb:version)) @end lisp @noindent This will produce the following line in outgoing messages: @example Comments: GNU Hyperbole mail buttons accepted, vX.X.X. @end example @vindex file, .emacs @noindent where the X's indicate your Hyperbole version number. You can cut this out of particular messages before you send them when need be. @cindex actype, link-to-mail 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 @code{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 @ref{Smart Key Argument Selection}. @node Buttons in News, , Buttons in Mail, Utilizing Explicit Buttons @subsection Buttons in News @cindex button posting @cindex news reader/poster @cindex posting news @cindex Gnus @cindex USENET @vindex file, hyperbole.el @cindex menu item, Cust/Msg-Toggle-Ebuts Explicit buttons may be embedded within outgoing USENET news articles and may be activated from within the Gnus news reader. Because this involves complex changes to news support functions, this feature is disabled by default. Use the Cust/Msg-Toggle-Ebuts minibuffer menu item to enable it (enabling it for mail also enables it for news and vice versa). Once enabled, all Hyperbole support should work just as it does when reading or sending mail. @xref{Buttons in Mail}. When reading news, buttons which appear in message @emph{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. @cindex news comment In order to alert readers of your postings that they may send you personal replies with embedded Hyperbole buttons, the system inserts into news postings the same comment that is included within mail messages, if enabled. @xref{Buttons in Mail}, for details and an explanation of how to turn this feature on. @node Menus, HyControl, Buttons, Top @chapter Menus @cindex Emacs @cindex Hyperbole menubar menu @cindex Hyperbole pulldown menu @cindex menu use @cindex pulldown menu @cindex menubar, Hyperbole menu @cindex menu item, Remove-This-Menu @cindex removing Hyperbole menu Pulldown and popup menus are available to invoke Hyperbole commands, including those from the HyRolo and the Koutliner. These menus operate like any other application menus and are fairly self-explanatory. Use the @code{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. Here is the Hyperbole Menubar Menu and its Find submenu. @float Image,image:Hyperbole Menu @caption{Hyperbole Menubar Menu} @image{im/menu-hyperbole,,5in,Hyperbole Menu} @end float @page @float Image,image:Find Menu @caption{Find Menubar Menu} @image{im/menu-find,,5in,Find Menu} @end float @sp 1 @findex hyperbole-popup-menu @cindex popup menu @cindex hyperbole popup menu The Hyperbole popup menu, @code{hyperbole-popup-menu}, replicates the Hyperbole menubar menu. It can be bound to a mouse key but is not bound to one by default. It can also be assigned as the default Action or Assist Key action to use when no matching context is found. @xref{Smart Key - Default Context}, for details. @cindex minibuffer menus The rest of this section discusses only the specialized @dfn{minibuffer menus} which appear in the minibuffer window and work with all emacs versions on all display devices. They provide similar capabilities to those of the Hyperbole menubar but additionally allow for fast menu item selection via the keyboard or mouse. When used with the keyboard, they provide command access similar to key bindings. @kindex C-h h @cindex minibuffer menu @vindex file, hyperbole.el @cindex invoking Hyperbole @cindex starting Hyperbole @cindex Hyperbole, starting @cindex Hyperbole main menu The top-level Hyperbole minibuffer menu is invoked from a key given in your @file{hyperbole.el} file (by default, @bkbd{C-h h}) or with a click of the Action Mouse Key in the minibuffer when it is inactive. It should look like this: @smallexample @noindent Hy> Act Butfile/ Cust/ Doc/ Ebut/ Find/ Gbut/ Hist Ibut/ Kotl/ Msg/ Rolo/ Screen/ Win/ @end smallexample @cindex submenus @cindex menu help @cindex help, menu items @cindex menu item selection @cindex selection, menu items @kindex @key{TAB} @kindex M-f @kindex Shift- @kindex M-b All menu items are selected via the first character of their names (letter case does not matter), with presses of the Action Key or by using @{@key{TAB}@} or @bkbd{M-f} to move forward an item, @bkbd{Shift-@key{TAB}} or @bkbd{M-b} to move backward an item and @{@key{RET}@} to select the current item. A press of the Assist Key on an item displays help for the item, including the action that it performs. "/" at the end of an item name indicates that it brings up a submenu. @kindex C-t @kindex q @kindex C-g @cindex menu, top-level @cindex top-level menu @cindex menu prefix While a menu is active, to re-activate the top-level Hyperbole menu, use @bkbd{C-t} or press the Action Key while on the menu prefix (before the @samp{>} character). This allows you to browse the submenus and then return to the top menu. You can quit without selecting an item by using @bkbd{q} or pressing @{@key{RET}@} when at the end of a menu. @bkbd{C-g} aborts from the minibuffer whether you are at a menu prompt or any other Hyperbole prompt. @noindent The top-level Hyperbole minibuffer menu items serve the following purposes: @table @strong @cindex menu item, Act @cindex menu item, Activate-Button-at-Point @item 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. @cindex menu, Button-File @cindex menu, Butfile @cindex button file, HYPB @vindex file, HYPB @item Butfile/ Easy access to a directory-specific or personal file of buttons. @file{HYPB} is the name of the directory-specific button file and @file{~/.hyperb/HYPB} is the personal file of global buttons. These are good places to begin experimenting with button creation. @cindex menu, Customize @cindex menu, Cust @cindex customize @cindex option settings @item Cust/ Hyperbole option customization. This includes whether ftp and www URLs are recognized by the @code{find-file} commands, where Hyperbole link referents are displayed, where URLs are displayed, where web search results are displayed, whether date stamps are added to rolo entries, and whether to use proportional or windowful scrolling when a Smart Key is pressed at the end of a line. @xref{Customization}. @cindex menu, KeyBindings @cindex key binding, menu @cindex mouse bindings The @samp{KeyBindings/} submenu allows individual changes to each keyboard key that Hyperbole binds for its commands, notably the Action Key. @xref{Smart Key Bindings}, for more information. @xref{Global Key Bindings}, for complete descriptions of Hyperbole's global key bindings, how to temporarily disable them and how to manage its overriding of local bindings that hide global Hyperbole keys. @cindex menu, Explicit-Button @cindex menu, EBut @item 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. @cindex menu, Documentation @cindex menu, Doc @cindex menu, Types @item 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. @cindex Find @cindex Grep @cindex menu, Find @cindex search @item Find/ Buffer and file line finding commands and web searching. This menu brings together many existing line finding commands that are difficult to recall quickly when needed, simplifying finding and then jumping to matching lines by using the Action Key. It includes commands for filtering a buffer to just those lines that either match or do not match a regular expression. It also includes a submenu for quick access to popular web search engines. Below are each of the commands on the Find menu. @cindex match lines @cindex remove lines @cindex save lines @cindex locate files @cindex grep files @cindex menu item, GrepFile @cindex menu item, LocateFiles @cindex menu item, MatchFileBuffers @cindex menu item, OccurHere @cindex menu item, RemoveLines @cindex menu item, SaveLines @vindex hypb:rgrep-command @vindex locate-command @itemize @bullet @item GrepFiles - Show numbered line matches for a regexp in all non-backup, non-auto-save files below the current directory. If in an Emacs Lisp mode buffer and no PREFIX-ARG is given, limit search to only .el and .el.gz files. Set @code{hypb:rgrep-command} to change the grep command or options. @item LocateFiles - Prompt for a pattern and display a list of all matching pathnames found throughout the file system. On Mac OS X, this uses Spotlight (the @code{mdfind} command); on UNIX, it uses the @code{locate} command. Within the resulting *Locate* buffer, Find/Grep-Files will find matching lines within only these paths (files and directories). @item MatchFileBuffers - Show numbered line matches for regexp in all file-based buffers. @item OccurHere - Show numbered line matches for regexp from this buffer. @item RemoveLines - Following point, remove all lines that match regexp. @item SaveLines - Following point, keep only lines that match regexp. @cindex menu, Find/Web @cindex menu, Web @cindex searching the web @cindex web search @kindex C-c / @vindex hyperbole-web-search-browser-function @item Web/ - Select a search engine and term and search with them. Hyperbole binds the key @bkbd{C-c /} for quick access to this menu, if it is not already bound prior to Hyperbole's initialization. The Cust/Web-Search menu sets the option, @code{hyperbole-web-search-browser-function}, which determines whether web search results are displayed within Emacs or with an external web browser. A short video introduction to the Find/Web menu may be found at @url{https://youtu.be/8lMlJed0-OM}. The Find/Web menu looks like this: @smallexample @noindent Web> Amazon Bing Dictionary Elisp Facebook Google Hub(git) Images Maps RFCs StackOverflow Twitter Wikipedia Youtube @end smallexample @end itemize @cindex menu, Global-Button @cindex menu, Gbut @item Gbut/ All global button commands. Global buttons are accessed by name rather than by direct selection. The Hyperbole menubar menu also includes an activation menu item for each global button. @cindex menu item, Back-to-Prior-Location @cindex menu item, Hist @cindex history @item Hist Return to previous positions in the button traversal history. @cindex menu, Implicit-Button @cindex menu, Ibut @item Ibut/ All implicit button commands. @cindex menu, Mail-Lists @cindex menu, Msg @item Msg/ Hyperbole-specific email messaging commands. Use this to send mail to a Hyperbole discussion mailing list. @cindex menu, Outliner @cindex menu, Koutline @cindex menu, Kotl @item Kotl/ Autonumbered, structured outliner commands with per-node hyperlink anchors. @xref{Koutliner}. @cindex menu, Rolo @item Rolo/ Hierarchical, multi-file contact manager lookup and edit commands. @xref{HyRolo}. @cindex menu, Screen @item Screen/ Window, frame and buffer display control commands. @xref{HyControl}. @cindex menu, Window-Configurations @cindex menu, WinConfig @item Win/ Window configuration management commands, such as adding and restoring window configurations by name. @xref{Window Configurations}. @end table @node HyControl, Koutliner, Menus, Top @chapter HyControl @cindex windows control @cindex frames control @cindex HyControl @cindex invoking HyControl @cindex starting HyControl @cindex screen @cindex display Hyperbole includes the fastest, easiest-to-use Emacs window and frame management system available, HyControl, found under the Hyperbole Screen menu. If you use a lot of Emacs windows or frames (typically, window system windows) then this chapter is for you. HyControl interactively adjusts the layout of your windows and frames down to the pixel-level if desired. You adjust the location, size and display elements of your windows and frames until they look as you like and then simply quit HyControl and go back to work. @kindex C-c \ @kindex screen, C-c \ @kindex C-h h s w @kindex screen, C-h h s w @kindex C-h h s f @kindex screen, C-h h s f @cindex menu item, WindowsControl @cindex menu item, FramesControl Hyperbole binds the key @bkbd{C-c \\} for quick access to HyControl's window control menu, if it was not already bound prior to Hyperbole's initialization; otherwise, the Screen/WindowsControl minibuffer menu item, @bkbd{C-h h s w}, will do the same thing. To start HyControl with the frames menu instead, use Screen/FramesControl, @bkbd{C-h h s f}. @cindex submodes @kindex screen, t @kindex screen, q @kindex screen, Q Once in HyControl, your minibuffer window at the bottom of the selected frame will display a summary of keys you may use to adjust your windows until you press @bkbd{q} or @bkbd{Q} to quit from HyControl. The key, @bkbd{t}, will always toggle between controlling frames and windows, the @dfn{submodes} of HyControl, with the upper left of the minibuffer prompt showing which type of control is active. @cindex numeric argument @cindex multiplier A number of commands take a single numeric argument, e.g. movement and sizing, which you can enter by typing a period to clear the argument, followed by any positive number up to 1000. You may also use the @bkbd{C-u} universal argument key to apply a multiplier of 4 to the argument, any number of times. Any entry that pushes the argument over 1000, restarts it, so 10005 would produce an argument of 5. @noindent The table below explains what each key does in HyControl mode. If the explanation does not say otherwise, then the key applies in both window and frame submodes. @table @asis @cindex HyControl help @kindex HyControl, see screen @kindex screen, ? @kitem ? Toggle whether HyControl displays key binding help in the minibuffer. @kindex HyControl, see screen @kindex screen, . @kitem . Clear the prefix argument to a value of 0. @kindex screen, 0-9 @kitem 0-9 Multiply the prefix argument by 10 and add the digit pressed. @cindex windows grid @cindex grid of windows @cindex HyControl windows grid @kindex screen, @@ @kitem @@ Display a @dfn{grid of windows} in the selected frame sized according to the prefix argument or via a prompted input. Left digit of the argument is the number of grid rows and the right digit is the number of grid columns to display. @float Image,image:2x3-Windows-Grid @caption{2x3 Windows Grid} @image{im/wgrid-2x3,5.2in,,2x3 Windows Grid} @end float @sp 1 If the prefix argument is 0, prompt for a major mode whose buffers should be displayed first in the grid windows, then prompt for the grid size. Otherwise, prompt for the grid size if the prefix argument is an invalid size. @vindex hycontrol-display-buffer-predicate-list With a current buffer in Dired, Buffer Menu or IBuffer mode that contains marked items, the buffers associated with those items are displayed first in the grid (unless the prefix argument is 0). Then the most recently used buffers are displayed in each window, first selecting only those buffers which match any of the predicate expressions in @code{hycontrol-display-buffer-predicate-list}. (The default predicate list chooses buffers with attached files). Then, if there are not enough buffers for all windows, the buffers that failed to match to any predicate are used. In all cases, buffers whose names start with a space are ignored. When done, this resets the persistent prefix argument to 1 to prevent following commands from using the often large grid size argument. If you ever need to experiment with different sized window grids, use @bkbd{M-x hycontrol-window-grid-repeatedly @key{RET}}. It will repeatedly prompt you for a grid size and then display it. When you are done, simply press @bkbd{@key{RET}} to exit. @cindex frame resize @vindex hycontrol-frame-widths @kindex screen, a @kitem a Cycle through common width adjustments of a frame, such as 25% and 50%. Widths are given in screen percentages by the list @code{hycontrol-frame-widths} and typically go from widest to narrowest. @vindex hycontrol-frame-heights @kindex screen, A @kitem A Cycle through common height adjustments of a frame, such as 33.3% and 75%. Heights are given in screen percentages by the list @code{hycontrol-frame-heights} and typically go from tallest to shortest. @kindex screen, h @kitem h Increase height by argument lines (line height determined by buffer character height). @kindex screen, s @kitem s Shorten height by argument lines. @kindex screen, w @kitem w Widen by argument characters. @kindex screen, n @kitem n Narrow by argument characters. @kindex screen, % @kitem % In FRAMES mode, resize frame's height and width to about argument percent of the screen size. @kindex screen, H @kitem H In FRAMES mode, resize frame's height to about argument percent of the screen size. @kindex screen, W @kitem W In FRAMES mode, resize frame's width to about argument percent of the screen size. @kindex screen, up @kindex screen, down @kindex screen, left @kindex screen, right @kitem up @kitemx down @kitemx left @kitemx right Move frame in the specified direction by argument pixels. @cindex frame relocate @kindex screen, c @kitem c With each press, cycle the selected frame's position clockwise through the middle of edges and corners of the screen. With an argument of 0, reset the cycle position to the upper left corner. Respects the pixel edge offsets returned by @code{hycontrol-get-screen-offsets}. @cindex delete frame @cindex frame, delete @kindex screen, d @kitem d Delete selected window or frame based on mode. @kindex screen, D @kitem D Prompt for confirmation and then delete non-selected windows or frames based on mode. @cindex frame, lower @cindex lower frame @kindex screen, l @kitem l In FRAMES mode, lower the selected frame below all other Emacs session frames. @cindex frame, other @cindex other frame @cindex other window @cindex window, other @kindex screen, o @kitem o Select the next window in the window list, across all visible frames. @kindex screen, O @kitem O Select the next visible frame. @cindex keypad @cindex numeric keypad @kindex screen, keypad number @kitem keypad number In FRAMES mode, move the frame directly to the screen edge position given by the numeric keypad layout. For example, 3 moves the frame to the bottom right corner and 8 moves it to the middle of the top edge. Keypad numeric keys do not adjust the argument. Respects the pixel edge offsets returned by @code{hycontrol-get-screen-offsets}. @cindex virtual numeric keypad @kindex screen, p @kitem p Display a virtual numeric keypad for emulating a keypad on keyboards without one. Each digit key operates just as a numeric keypad key would. @cindex frame, raise @cindex raise frame @kindex screen, r @kitem r In FRAMES mode, raise the selected frame above all other Emacs session frames. @cindex window, make @cindex make window @vindex hycontrol-frame-offset @kindex screen, [ @kitem [ Create a new atop window or frame depending on mode. If a frame, it is sized to the same size as the selected window and offset from the selected frame by the pixel amounts given by @code{hycontrol-frame-offset}. @kindex screen, ] @kitem ] Create a new sideways window or frame depending on mode. @cindex frame configuration @cindex window configuration @kindex screen, ( @kitem ( Save the current window or frame configuration based on mode. Whenever, HyControl is invoked, the current window and frame configurations are saved automatically. So use this command only if you have changed the configuration and wish to save it temporarily. @kindex screen, ) @kitem ) After confirmation, restore the last saved window or frame configuration based on mode. @cindex window, clone @cindex clone window @vindex hycontrol-keep-window-flag @kindex screen, f @kitem f Clone the selected window to a new similarly sized frame. @kindex screen, F @kitem F Clone the selected window to a new similarly sized frame. Delete the original window unless there is only one window in the source frame or if @code{hycontrol-keep-window-flag} is non-nil. @cindex frame, to edge @cindex frame, percentage resize @cindex resize frame percentage @kindex screen, i @kindex screen, j @kindex screen, k @kindex screen, m @kitem i @kitemx j @kitemx k @kitemx m Expand the selected frame to the respective screen edge based on U.S. keyboard key layout. i=top, j=left, k=right and m=bottom screen edge. If already at the edge, adjusts the perpendicular dimension to ARG percent of the screen (50% by default if ARG is 1 or nil) but keep it at the screen edge. Respects the pixel edge offsets returned by @code{hycontrol-get-screen-offsets}. @cindex balance windows @cindex windows, balance @cindex equalize windows @cindex windows, equalize @kindex screen, = @kitem = After confirmation, in WINDOWS mode, make the current frame's windows approximately the same size. In FRAMES mode, make all visible frames the size of the selected frame. @cindex shrink window @cindex window, shrink @kindex screen, - @kitem - In WINDOWS mode, shrink window to its smallest possible number of lines to display the entire buffer, if possible. Otherwise or if the window is already displaying all of its lines, shrink it to about one line, if possible. @cindex frame, shrink @cindex shrink frame In FRAMES mode, make the frame as small as possible while still displaying it. @cindex window, maximize @cindex maximize window @cindex frame, maximize @cindex maximize frame @kindex screen, + @kitem + Make the window or frame (based on mode) as large as possible. In FRAMES mode, a second press of this key restores its size to whatever it was prior to the first use of this command. @cindex burying @cindex unburying @cindex buffer, bury @cindex buffer, unbury @kindex screen, b @kitem b Bury the selected buffer within the buffer list, displaying the next buffer. @kindex screen, u @kitem u Unbury the bottom buffer in the buffer list and display it in the selected window. @cindex swapping @cindex buffer, swap @kindex screen, ~ @kitem ~ Swap two buffers between the selected window or frame and one other. In WINDOWS mode, there must be precisely two windows in the selected frame. In FRAMES mode, the second frame must have a single window. @cindex zooming @cindex window, zoom @cindex frame, zoom @findex zoom-frm.el @kindex screen, Z @kitem Z Zoom in selected window or frame text based on mode, increasing default face size. @kindex screen, z @kitem z Zoom out selected window or frame text based on mode, increasing default face size. Zooming supports an argument of between 1 and 9 (any other value sets the argument to 1). The argument determines the number of sizes by which to zoom. FRAMES mode zooming requires the separately available @file{zoom-frm.el} library. WINDOWS zooming works without this library. @cindex HyControl switch modes @cindex HyControl toggle modes @cindex toggle HyControl mode @kindex screen, t @kitem t Toggle between WINDOWS and FRAMES submodes. @cindex HyControl quit @cindex HyControl exit @cindex quit HyControl @cindex exit HyControl @kindex screen, q @kitem q Quit from HyControl mode and restore normal key bindings. @end table @sp 1 The rest of this section goes into some technicalities about HyControl settings. You may ignore it if you are not familiar with Emacs variables and functions or with customized Emacs. @cindex HyControl edge placement @cindex HyControl corner placement HyControl allows placement of frames at screen edges and corners with the frame cycle command, @bkbd{c}, and direct placement using the layout of the numeric keypad keys, if available, or the @kbd{p} virtual keypad key otherwise. (Note that a screen may span multiple physical monitors). @cindex HyControl screen edge offsets @cindex screen, edge offsets @vindex hycontrol-screen-offset-alist @findex hycontrol-set-screen-offsets @findex hycontrol-get-screen-offsets To prevent widgets and toolbars at the corners of the screen from being obscured, HyControl can offset each frame from each screen edge by a fixed number of pixels. These offsets are specified by the variable,@code{hycontrol-screen-offset-alist} and can differ for each type of screen; see its documentation for details. If you change its value, then call @code{hycontrol-set-screen-offsets} to set any new offset values. @code{hycontrol-get-screen-offsets} returns the list of offsets in clockwise order starting from the top edge. Both functions display a minibuffer message with the current offsets when called interactively. @vindex hycontrol-frame-offset @cindex frame, make @cindex make frame When HyControl creates a new frame, it automatically sizes it to the same size as the previously selected frame and offsets it from that frame by the (X . Y) number of pixels given in the variable, @code{hycontrol-frame-offset}. @cindex file, hycontrol.el @findex hycontrol-enable-frames-mode @findex hycontrol-enable--windows-mode The source code for the HyControl system is in @file{hycontrol.el} within your Hyperbole source directory, given by @code{hyperb:dir}. HyControl uses standard Emacs keymaps, so any keys can be rebound. Remember that Hyperbole typically binds @bkbd{C-c \\} to the windows control menu, but if you would like to bind either of the two HyControl minor mode invocation commands to keys, they are, @code{hycontrol-enable-windows-mode} and @code{hycontrol-enable-frames-mode}. Generally, you need only one of these bound to a key since when you press that key, the other command can be reached by pressing @bkbd{t}. @node Koutliner, HyRolo, HyControl, Top @chapter Koutliner @cindex outliner @cindex autonumber @cindex relative autonumber @cindex permanent identifier @cindex idstamp @cindex hyperlink anchor The Hyperbole outliner, the Koutliner (pronounced Kay-outliner), produces structured, autonumbered documents composed of hierarchies of cells. Each @dfn{cell} has two identifiers, a @dfn{relative identifier} indicating its present position within the outline and a @dfn{permanent identifier} called an @dfn{idstamp}, suitable for use within hyperlink references to the cell. The idstamp is typically not displayed but is available when needed. @xref{Autonumbering}. Cells also store their time of creation and the user who created the cell. User-defined attributes may also be added to cells. @xref{Cell Attributes}. @vindex file, EXAMPLE.kotl @cindex menu, Outline/Example @kindex C-h h k e This chapter expands on the information given in the @file{EXAMPLE.kotl} file included with Hyperbole. Use @bkbd{C-h h k e} to display that file, as pictured on the following page. It is an actual outline file that explains major outliner operations. You can test out the viewing, editing and motion commands with this file since a personal copy is made when you invoke this command. @xref{Koutliner Keys}, for a full summary of the key bindings and commands available in the Koutliner. @float Image,image:Koutliner @caption{Koutliner Screenshot} @image{im/koutliner,6in,,Koutliner Screenshot} @end float @sp 1 @menu * Menu Commands:: * Creating Outlines:: * Autonumbering:: * Idstamps:: * Editing:: * Viewing:: * Links:: * Cell Attributes:: * Koutliner History:: @end menu @page @node Menu Commands, Creating Outlines, Koutliner, Koutliner @section Menu Commands The Kotl/ menu entry on the Hyperbole minibuffer menu provides access to a number of major Koutliner commands: @cindex outliner commands @cindex Koutliner commands @cindex Koutliner menu @cindex menu, Koutliner @findex kotl-mode:show-all @findex kvspec:toggle-blank-lines @findex kfile:find @findex kotl-mode:hide-sublevels @findex kotl-mode:hide-tree @findex kotl-mode:kill-tree @findex klink:create @findex kotl-mode:overview @findex kotl-mode:show-tree @findex kotl-mode:top-cells @findex kvspec:activate @example 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 Show self-descriptive example Hide kotl-mode:hide-tree Hide tree with root at point Info 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 ==================================================================== @end example @page @kindex C-mouse-3 @cindex popup menu, Koutliner @cindex menubar menu, Koutliner The popup and menubar Koutline menu, as displayed here, offers a more complete set of the Koutliner commands. @bkbd{C-mouse-3} pops up the mode-specific menu in Emacs. Experiment with the menu or read the following sections explaining commands. @float Image,image:Koutline Menu @caption{Koutline Menu} @image{im/menu-koutline,,6in,Koutline Menu} @end float @sp 1 @node Creating Outlines, Autonumbering, Menu Commands, Koutliner @section Creating Outlines @cindex outline file suffix @cindex outline, creating @vindex file, .kotl suffix In addition to the Kotl/Create menu item, you can create and experiment with outline files simply by finding a file, @bkbd{C-x C-f}, with a @file{.kotl} suffix. @file{.kot} will also work for users impaired by operating systems with 3-character suffix limitations. @cindex root cell @cindex top-level cell @cindex cell, top-level @cindex cell, idstamp 0 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. @xref{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. @node Autonumbering, Idstamps, Creating Outlines, Koutliner @section Autonumbering @cindex autonumber @cindex relative identifier @xref{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 @dfn{autonumbers} and as @dfn{relative ids} because they change as the structure changes. @cindex outline structure 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. @cindex label type, alpha @cindex label type, legal @cindex alpha labels @cindex legal labels @cindex outline, label type The default autonumbers are called @dfn{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. @kindex koutliner, C-c C-l @cindex label type, changing You can change the labeling scheme used in a particular outline with the command @bkbd{C-c C-l}. A @bkbd{?} will show all of the labeling options. The default, alpha labels, legal labels, and permanent idstamps (permanent cell ids) are all available. @cindex label separator, changing @cindex cell, label separator @cindex outline, label separator @kindex koutliner, C-c M-l @kindex koutliner, C-u C-c M-l A cell label is normally followed by a period and a space, called the @dfn{label separator}, prior to the start of the cell contents. You can change the separator for the current outline with @bkbd{C-c M-l}. @bkbd{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. @vindex file, .emacs @cindex initialization file 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, @file{~/.emacs}, substituting for `your-separator': @cindex label separator, default @vindex kview:default-label-separator @lisp (setq kview:default-label-separator "your-separator") @end lisp @node Idstamps, Editing, Autonumbering, Koutliner @section Idstamps @cindex permanent identifier @cindex idstamp Idstamps (permanent ids) are associated with each cell. They maintain hyperlinks as cells are reordered within a koutline. @xref{Links}. Idstamps may be displayed in place of the outline level relative ids. Use @bkbd{C-c C-l id @key{RET}}. @cindex idstamp counter 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. @cindex root cell @cindex top-level cell @cindex cell, top-level @cindex cell, idstamp 0 @cindex idstamp 0 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. @node Editing, Viewing, Idstamps, Koutliner @section 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. @xref{Filling}, for the times when you need to refill a paragraph or to control when filling occurs. Don't invoke editing commands with @bkbd{M-x command-name @key{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. @cindex cell, selection 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:: @end menu @node Adding and Killing, Relocating and Copying, Editing, Editing @subsection Adding and Killing @kindex koutliner, C-j @kindex koutliner, C-u c-j @kindex koutliner, C-c a @kindex koutliner, C-c p @cindex cell, adding @cindex cell, creating @bkbd{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. @bkbd{C-u C-j} is handled specially. It adds a single cell as a child of the current cell. @bkbd{C-c a} does the same thing. @bkbd{C-c p} adds the cell as the successor of the current cell's parent. @kindex koutliner, C-c C-k @kindex koutliner, C-c k @kindex koutliner, C-u C-c k @kindex koutliner, C-y @cindex cell, killing @cindex cell, yanking contents @cindex tree, killing @bkbd{C-c C-k} kills the current cell and its entire subtree. @bkbd{C-c k} kills the contents of a cell from point through the end of the cell; it does not remove the cell itself. @bkbd{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 @bkbd{C-y}. @node Relocating and Copying, Moving Around, Adding and Killing, Editing @subsection Relocating and Copying @cindex promotion @cindex demotion @cindex tree, promoting @cindex tree, demoting @dfn{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. @dfn{Promotion} is the inverse operation. Note that trees (cells and their entire substructure) are promoted and demoted, not individual cells. @kindex koutliner, @key{TAB} @kindex koutliner, M-@key{TAB} Trees may be demoted or promoted by pressing @key{TAB} or @bkbd{M-@key{TAB}} (or @bkbd{@key{SHIFT}-@key{TAB}}) respectively, as in most outliners today. @bkbd{M-0 @key{TAB}} and @bkbd{M-0 M-@key{TAB}} demote and promote trees and additionally refill each cell that is not specially marked to prevent refilling. @xref{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 adjustment is made. @kindex koutliner, M-1 @key{TAB} @cindex inserting tabs @cindex tabs, inserting @vindex kotl-mode:indent-tabs-mode @cindex Koutliner, toggle tab behavior @bkbd{M-1 @key{TAB}} behaves specially. It toggles the function of @key{TAB} and @bkbd{M-@key{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, @bkbd{@key{TAB}} inserts a literal TAB character, by default. Set the variable, @code{kotl-mode:indent-tabs-mode}, to @samp{nil} if you want space characters used to form the tab. Use @bkbd{M-1 @key{TAB}} to toggle the @key{TAB} and @bkbd{M-@key{TAB}} keys back to promoting and demoting trees. @cindex tree, copying @cindex tree, moving @cindex Action Key, cell argument @kindex koutliner, Action Key, cell argument 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. @table @asis @kitem C-c c Copy to be the successor of . @kitem C-u C-c c Copy to follow as the first child of . @kitem C-c C-c Copy to be the predecessor of . @kitem C-u C-c C-c Copy to be the first child of the parent of . @kitem C-c m Move to be the successor of . @kitem C-u C-c m Move to follow as the first child of . @kitem C-c C-m Move to precede . @kitem C-u C-c C-m Move to be the first child of the parent of . @end table @cindex mouse, moving trees 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: @cindex tree, exporting @cindex outline, exporting @cindex tree, mailing @cindex outline, mailing @cindex exporting an outline @cindex mailing an outline @table @asis @kitem C-c M-c Copy a to a non-koutline buffer. @kitem C-c @@ Copy a to an outgoing mail message. @end table @cindex outline, importing @cindex copying You may also import cells into the current koutline from another koutline with the @bkbd{M-x kimport:text @key{RET}} command. @xref{Inserting and Importing}. @node Moving Around, Filling, Relocating and Copying, Editing @subsection Moving Around @cindex outline, motion In addition to normal emacs movement commands, you can move within a cell or from one cell or tree to another. @table @asis @kitem C-c , Move to the beginning of the current cell. @kitem C-c . Move to the end of the current cell. @kitem C-c C-n Move to the next visible cell, regardless of level. @kitem C-c C-p Move to the previous visible cell, regardless of level. @kitem C-c C-f Move forward to this cell's successor, if any. @kitem C-c C-b Move backward to this cell's predecessor, if any. @kitem C-c C-d Move to the first child of the current cell, if any. @kitem C-c C-u Move to the parent cell of the current cell, if any. @kitem C-c < Move to the first sibling at the current level within this tree. @kitem C-c > Move to the last sibling at the current level within this tree. @kitem C-c ^ Move to the level 1 root cell of the current tree. @kitem C-c $ Move to the last cell in the tree rooted at point, regardless of level. @end table @node Filling, Transposing, Moving Around, Editing @subsection Filling @cindex outline, filling @cindex filling @cindex word wrap @dfn{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. @cindex filling @cindex cell, filling @cindex paragraph, filling @cindex tree, filling @cindex margin @kindex koutliner, M-q @kindex koutliner, M-j @kindex koutliner, C-c M-q @kindex koutliner, C-c M-j @kindex koutliner, C-M-q @kindex koutliner, C-M-j @bkbd{M-q} or @bkbd{M-j} refills a paragraph within a cell so that its lines wrap within the current margin settings. @bkbd{C-c M-q} or @bkbd{C-c M-j} refills all paragraphs within a cell. @bkbd{C-M-q} or @bkbd{C-M-j} refills all cells within a tree. See the GNU Emacs manual for information on how to set the left and right margins. @vindex kotl-mode:refill-flag @cindex refilling @cindex attribute, no-fill @cindex cell, no-fill attribute Set the variable, @code{kotl-mode:refill-flag}, to @samp{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. @node Transposing, Splitting and Appending, Filling, Editing @subsection Transposing The Koutliner move and copy commands rearrange entire trees. The following two commands, in contrast, exchange the locations of two individual cells. @kindex koutliner, C-c e @cindex cell, transposing @cindex cell, exchanging @cindex exchanging cells @cindex transposing cells @bkbd{C-c e} prompts for two cell addresses and exchanges the cell locations. @kindex koutliner, C-c t @bkbd{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. @cindex cell, mark and point @kindex koutliner, M-0 C-c t @bkbd{M-0 C-c t} exchanges the cells in which point and mark fall. @bkbd{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. @node Splitting and Appending, Inserting and Importing, Transposing, Editing @subsection Splitting and Appending @cindex splitting a cell @cindex cell, splitting @kindex koutliner, C-c s @kindex koutliner, C-u C-c s One cell may be split into two adjacent sibling cells with @bkbd{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. @bkbd{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. @kindex koutliner, C-c + @cindex cell, appending @cindex appending to a cell @cindex attribute, no-fill @cindex cell, no-fill attribute @bkbd{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. @node Inserting and Importing, Exporting, Splitting and Appending, Editing @subsection Inserting and Importing @cindex outline, inserting into @cindex outline, importing into @cindex importing @cindex insertion @kindex koutliner, C-x i @cindex outline, foreign file The paragraphs of another buffer or file may be inserted into a koutline as a set of cells by using the @bkbd{C-x i} command. When prompted, you may use a buffer name or filename from which to insert; completion is provided for filenames only. @kindex koutliner, C-u C-x i The elements from the original buffer are converted into kcells and inserted as the successors of the current cell. If @bkbd{C-u C-x i} is used, they are instead inserted as the initial children of the current cell. @vindex kimport:mode-alist @vindex kimport:suffix-alist @cindex outline, conversion @findex kotl-mode @cindex outline mode @cindex koutline mode @cindex file, importing @cindex importing a file For information on mode and suffix-specific conversions performed on file elements before they are inserted, see the documentation for the variables, @code{kimport:mode-alist} and @code{kimport:suffix-alist}. This same conversion process applies if you invoke @bkbd{M-x kotl-mode @key{RET}} in a non-koutline buffer or if you perform a generic file import as described later in this section. @findex kimport:insert-file-contents Use @bkbd{M-x kimport:insert-file-contents @key{RET}} to insert an entire file into the current cell following point. @findex kimport:file 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. @bkbd{M-x kimport:file @key{RET}} selects the importation type based on the buffer or filename suffix of the file to import. @findex kotl-mode 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 @bkbd{M-x kotl-mode @key{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. @findex kimport:text @cindex text file Use @bkbd{M-x kimport:text @key{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. @findex kimport:star-outline @cindex emacs outline @cindex star outline Star outlines are standard emacs outlines where each entry begins with one or more asterisk characters. Use @bkbd{M-x kimport:star-outline @key{RET}} and you will be prompted for the star outline buffer or file to import and the new koutline buffer or file to create. @cindex Augment outline @findex kimport:aug-post-outline (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 @bkbd{M-x kimport:aug-post-outline @key{RET}} and you will be prompted for the Augment buffer or file to import and the koutline to create. @node Exporting, , Inserting and Importing, Editing @subsection Exporting @cindex outline, exporting from @cindex outline, HTML conversion @cindex exporting @cindex HTML conversion @findex kexport:html Koutlines may be @dfn{exported} to other file formats. Presently, the only format supported is conversion to HTML for publishing on the World-Wide Web. @bkbd{M-x kexport:html @key{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 filenames is provided. The conversion will then be done and the output file or buffer will be written; the output file will not be displayed. @node Viewing, Links, Editing, Koutliner @section Viewing @cindex outline, viewing @cindex view 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:: @end menu @node Hiding and Showing, View Specs, Viewing, Viewing @subsection Hiding and Showing @cindex outline, hiding @cindex outline, showing @cindex collapsing @cindex expanding @cindex hiding @cindex 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. @xref{View Specs}. @c Emacs (as of Emacs 26) will sometimes undo the narrowing of an indirect buffer @c when outline items are hidden or shown. Don't mention or add this feature until @c this bug is fixed. @c @c @cindex cloning @c @cindex outline, cloning @c @cindex outline, multiple views @c @kindex koutliner, C-x 4 c @c If you want to see multiple perspectives of the same Koutline, use @c @{@{C-x 4 c}@} to create a clone of any current Koutline. Any edits @c made to the original buffer or the clone are shared but when you alter @c the view in one, it does not affect the other, so you can expand and @c collapse or change viewspecs to create different perspectives. @noindent Here are the major commands for showing and hiding Koutline cells. @table @asis @cindex hide tree @cindex tree, show @kitem C-c C-h Hide (collapse) the tree rooted at point. @cindex show tree @cindex tree, show @kitem C-c C-s Show (expand) the tree rooted at point. @cindex outline, all cells @cindex cell, show all @kitem C-c C-a Show (expand) all of the cells in the outline. With a prefix arg, also toggle the display of blank lines between cells. @cindex level @cindex cell, show levels @cindex outline, show levels @kitem C-x $ Show all of the cells down to a particular . You are prompted for the level or a prefix argument may be given. @cindex subtree, hide @cindex tree, hide subtree @cindex cell, hide subtree @cindex hide subtree @kitem C-M-h Hide the subtree at point, excluding the root cell. @cindex subtree, show @cindex tree, show subtree @cindex cell, show subtree @cindex show subtree @kitem M-x kotl-mode:show-subtree Show the subtree at point. Use @bkbd{C-c C-s} to achieve a similar effect; the only difference is that it will additionally expand the root cell. @cindex overview @cindex outline, overview @kitem C-c C-o Show an overview of the outline by showing only the first line of every cell. With a prefix arg, also toggle the display of blank lines between cells. @cindex top-level view @cindex outline, top-level @kitem C-c C-t Show a top-level view of the outline by hiding all cells but those at level 1 and collapsing the visible cells so that only their first lines are visible. With a prefix arg, also toggle the display of blank lines between cells. @end table @kindex koutliner, Action Key, hide or show cell @cindex Action Key, hide or show cell @cindex cell, collapse @cindex cell, expand @kindex koutliner, M-@key{RET} 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 @bkbd{M-@key{RET}}. @node View Specs, , Hiding and Showing, Viewing @subsection View Specs @cindex view spec @cindex modeline, view spec @vindex kvspec:string @cindex pipe character @cindex | @cindex <|viewspec> @dfn{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, @code{kvspec:string}, has been set to @samp{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. @xref{Links}. @cindex outline, view specs 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. @kindex koutliner, C-c C-v @cindex view spec, setting @cindex view spec, changing @cindex changing the view spec @cindex setting the view spec @bkbd{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>. @cindex view spec, characters @table @kbd @cindex view spec, all lines and levels @item a Show all cell levels and all lines in cells. @kindex koutliner, C-c b @cindex blank lines, toggle @cindex view spec, blank lines @kindex koutliner, C-c b @cindex toggling blank lines @item b Turn on blank lines between cells. Without this character, blank lines will be turned off. You may also use the @bkbd{C-c b} key binding to toggle blank lines on and off independently of any other view settings. @cindex view spec, lines per cell @cindex hide lines @cindex collapse lines @cindex cutoff lines @item cN Hide any lines greater than N in each cell. 0 means don't cutoff any lines. @cindex ellipses @cindex view spec, ellipses @item e Show ellipses when some content of a cell or its subtree is hidden. This cannot be turned off. @cindex level @cindex cell, hiding levels @cindex hide levels @cindex view spec, show levels @item lN Hide cells at levels deeper than N. 0 means don't hide any cells. @cindex label type @cindex view spec, label type @vindex kview:default-label-type @cindex default label type @item n Turn on the default label type, as given by the variable, @code{kview:default-label-type}. Normally, this is alphanumeric labels. @cindex label type, idstamps @item n0 Display idstamps, e.g. 086. @cindex label type, alpha @item n1 Display alpha labels, e.g. 1d3 @cindex label type, legal @item n. Display legal labels, e.g. 1.4.3 @end table @cindex view spec, example As a test, use @bkbd{C-h h k e} to display the example koutline. Then use @bkbd{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. @node Links, Cell Attributes, Viewing, Koutliner @section Links @cindex link @cindex hyperlink @cindex klink @cindex <> delimiters 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 (@pxref{By Dragging, Creation Via Action Key Drags}). A @dfn{klink} is a special implicit link button, delimited by <> separators, that jumps to a koutline cell. This section discusses klinks. @kindex koutliner, Action Key, klink @cindex Action Key, klink @cindex klink, activating @cindex klink referent 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. @cindex klink, inserting @kindex koutliner, C-c l 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 @bkbd{C-c l} when in a koutline or @bkbd{C-h h k l} when not in a koutline to insert a klink. Since klinks are implicit buttons, you may instead type in the text of the klink just as you see it in the examples below and it will work exactly as if it had been entered with the insert link command. @cindex klink, formats @noindent There are basically three forms of klinks: @table @emph @cindex internal klink @cindex klink, internal @cindex <@@ klink> @item internal @samp{<@@ 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'. @samp{<@@ 06>} does the same thing, as does @samp{<@@ 2b>}, though this latter form will not maintain the link properly if the cell is moved elsewhere within the outline. The form, @samp{<@@ 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. @cindex external klink @cindex klink, external @item external The second klink format is an external link to another koutline, such as, @samp{}, which displays the named file, starting at the cell 3 (whose permanent identifer is 012), with the view specification of: blank lines turned off, cutoff after one line per cell, and showing ellipses for cells or trees which are collapsed. @cindex klink, view spec @cindex view spec klink @item view spec The third format sets a view spec for the current koutline. For example, @samp{<|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. @end table @node Cell Attributes, Koutliner History, Links, Koutliner @section Cell Attributes @cindex cell, attribute @cindex attribute @dfn{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: @table @emph @cindex idstamp attribute @item idstamp The permanent id of the cell, typically used in cross-file hyperlinks that reference the cell. @cindex creator attribute @cindex e-mail address @cindex mail address @item creator The e-mail address of the person who created this cell. @cindex create-time attribute @cindex cell, creation time @item 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 @samp{Jan 28 18:27:59 CST 2019}. @end table @kindex koutliner, C-c C-i @cindex attribute, adding @cindex attribute, modifying @cindex attribute, removing @bkbd{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 @samp{nil}. @cindex attribute, no-fill @cindex cell, no-fill attribute @cindex no-fill attribute The `no-fill' attribute is special. When set to @samp{t}, it prevents movement, promotion, demotion, exchange, split or append commands from refilling the cell, even if the variable, @code{kotl-mode:refill-flag}, is set to @samp{t}. It does not prevent you from invoking explicit commands that refill the cell. @xref{Filling}. @kindex koutliner, Assist Key, listing attributes @cindex Assist Key, listing attributes @cindex listing attributes @cindex outline, attribute list @kindex koutliner, C-c h @kindex koutliner, C-u C-c h 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. @bkbd{C-c h} prompts for a cell label and displays the cell's attributes. @bkbd{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. @node Koutliner History, , Cell Attributes, Koutliner @section Koutliner History @cindex NLS @cindex Augment @cindex Engelbart Much of the Hyperbole outliner design is based upon concepts pioneered in the Augment/NLS system, @cite{[Eng84a]}. Augment treated documents as a hierarchical set of nodes, called statements, rather than cells. Every Augment document utilized this intrinsic structure. @cindex distributed collaboration @cindex collaboration 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. @cindex knowledge transfer @cindex idea structuring @cindex cross referencing 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. @node HyRolo, Window Configurations, Koutliner, Top @chapter HyRolo @cindex Rolo @cindex HyRolo Hyperbole includes a complete, advanced rolo system, HyRolo, for convenient management of hierarchical, record-oriented information. Most often this is used for contact management but it can quickly be adapted to most any record-oriented lookup task requiring fast retrieval. @cindex rolo, buttons in Hyperbole buttons may be included within rolo records and then manually activated whenever their records are retrieved in a search. @noindent The following subsections explain use and basic customization of this tool. @menu * HyRolo Concepts:: * HyRolo Menu:: * HyRolo Searching:: * HyRolo Keys:: * HyRolo Settings:: @end menu @node HyRolo Concepts, HyRolo Menu, HyRolo, HyRolo @section HyRolo Concepts @cindex rolo file @cindex rolo entry HyRolo manages and searches rolo files. A @dfn{rolo file} consists of an optional header that starts and ends with a line of equal signs (at least three equal signs starting at the beginning of a line), followed by zero or more rolo records. You must manually add a header to any rolo file if you want it to have one. @noindent Here is an example of a simple rolo file. The date at the end is automatically added by HyRolo whenever a new record is added. @example @group ================================================================== PERSONAL ROLO , W F ================================================================== * Smith, John W708-555-2001 F708-321-1492 Chief Ether Maintainer, HiHo Industries 05/24/2019 @end group @end example We call rolo records, @dfn{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 HyRolo will automatically keep your entries alphabetized as you enter them. Then you can sort the entries if you ever need. This ordering is what the rolo will use if you accept the default entry with which it prompts you when adding a new entry. Any search done on the rolo scans the full text of each entry. During a search, the rolo file header separator lines and anything in between are appended to the buffer of matched entries before any entries are retrieved from the file. Whenever an entry is matched, it and all of its descendant entries are retrieved. If your emacs version supports textual highlighting, each search match is highlighted for quick, visual location. @noindent For example, a search on "Company" could retrieve the following: @example @group ================================================================== COMPANY ROLO ================================================================== * Company ** Manager *** Staffer @end group @end example @noindent Thus, searching for Company retrieves all listed employees. Searching for Manager turns up all Staffer entries. @node HyRolo Menu, HyRolo Searching, HyRolo Concepts, HyRolo @section Rolo Menu @noindent The Rolo submenu of the Hyperbole menu offers a full set of commands for searching and maintaining a personal address book. It looks like so. @float Image,image:Rolo Menu @caption{HyRolo Menu} @image{im/menu-rolo,,3.5in,HyRolo Menu} @end float @page @cindex Rolo menu @cindex HyRolo menu @cindex menu, HyRolo @cindex menu, Rolo @kindex C-mouse-3 @cindex popup menu, HyRolo @cindex popup menu, Rolo @cindex menubar menu, HyRolo @cindex menubar menu, Rolo The Rolo/ menu entry on the Hyperbole minibuffer menu provides the same set of commands as the menubar and popup menus, with more concise labels. @bkbd{C-mouse-3} pops up the mode-specific menu in Emacs. Experiment with the menu or read the following sections explaining commands. The minibuffer Rolo/ menu offers the following commands: @cindex Rolo commands @cindex HyRolo commands @findex hyrolo-add @findex hyrolo-display-matches @findex hyrolo-edit @findex hyrolo-kill @findex hyrolo-mail-to @findex hyrolo-sort @findex hyrolo-grep @findex hyrolo-fgrep @findex hyrolo-word @findex hyrolo-yank @example @group Menu Item Command Description ===================================================================== Add hyrolo-add Adds a hyrolo entry Display hyrolo-display-matches Displays last matches again Edit hyrolo-edit Edits an existing hyrolo entry Info Displays a hyrolo manual entry Kill hyrolo-kill Deletes a hyrolo entry Mail hyrolo-mail Mails to an address at point Order hyrolo-sort Sorts all hyrolo levels RegexFind hyrolo-grep Finds all entries containing a regular expression StringFind hyrolo-fgrep Finds all entries containing a string (or logical expression) WordFind hyrolo-word Finds all entries containing a string of whole words Yank hyrolo-yank Inserts the first matching hyrolo entry at point ===================================================================== @end group @end example A prefix argument used with any of the find commands listed above limits the search to a maximum number of matches given by the argument. The search is terminated whenever that number of matches is found. For any of the above commands that prompt for a name such as Edit or Add (not the Find commands), you may use the form parent/child to locate a child entry below a specific parent. Hence, for a HyRolo which looks like so: @example @group * Company ** Manager *** Staffer @end group @end example @noindent you can refer to the Staffer entry with the following hierarchical notation, Company/Manager/Staffer. This hierarchical notation is not used in search expressions since they search the entire HyRolo anyway. Thus, "Staffer" as a search pattern will find an entry containing "Staffer" at any level in a hierarchy, like so: @example *** Staffer @end example @node HyRolo Searching, HyRolo Keys, HyRolo Menu, HyRolo @section HyRolo Searching @cindex rolo searching @cindex searching, rolo @cindex menu item, RegexFind @cindex menu item, WordFind @cindex menu item, StringFind @xref{HyRolo Menu}, for the list of HyRolo search commands. In this section, the menu item names from the minibuffer menu are used to refer to each command. The @code{RegexFind} menu item searches the rolo list for all entries which contain matches for a given regular expression. The regular expression syntax used is the same as the one used within Emacs and across the GNU set of tools. @xref{Regexps,,Syntax of Regular Expressions, emacs, the GNU Emacs Manual}, for full documentation on this format. The @code{WordFind} menu item locates full-word matches so that if you search for @samp{product}, it won't match to occurrences of @samp{production}. It is also handy for more precise name matching. @cindex logical rolo searches The @code{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. @example @group 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 ===================================================================== @end group @end example @noindent For example: @example (and Company (not Vice-President)) @end example @noindent would match those entries for people associated with @samp{Company} who do not have @samp{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. @example (xor 408- client) @end example @node HyRolo Keys, HyRolo Settings, HyRolo Searching, HyRolo @section HyRolo Keys @cindex hyrolo menu @cindex rolo keys After a rolo search is performed, point is left in the @dfn{rolo match buffer}, @file{*Hyperbole Rolo*}, which uses @code{hyrolo-mode} to simplify browsing many rolo matches. Press @bkbd{?} when in the match buffer for a summary of available keys, all of which are documented in this section. @kindex HyRolo, see rolo @kindex rolo, @key{TAB} @kindex rolo, M-@key{TAB} @kindex rolo, @key{SHIFT}-@key{TAB} @kindex rolo, r @cindex rolo, highlighting matches @cindex rolo, finding matches @cindex rolo, moving through matches If your emacs version supports textual highlighting, each search match is highlighted for quick, visual location. @{@key{TAB}@} moves point forward to successive spans of text which match the search expression. @bkbd{M-@key{TAB}} @bkbd{@key{SHIFT}-@key{TAB}} or @bkbd{r} move point backward to earlier matches. These keys allow you to quickly find the matching entry of most interest to you if your search expression failed to narrow the matches sufficiently. @kindex rolo, M-s @kindex rolo, C-s @kindex rolo, C-r @kindex rolo, l @cindex rolo, extending a match @cindex rolo, interactive searching @cindex rolo, locating a name If you want to extend the match expression with some more characters to find a particular entry, use @bkbd{M-s}. This performs an interactive search forward for the match expression. You may add to or delete characters from this expression to find different occurrences or move to the next match with @bkbd{C-s}. @bkbd{C-r} reverses the direction of the search. If you would like to search for a specific entry name in the match buffer, use @bkbd{l} to interactively locate the text immediately following the entry start delimiter, typically one or more asterisks. This lets you find entries by last name quickly, eliminating other matches. Standard string, @bkbd{C-s}, and regular expression, @bkbd{C-M-s}, interactive search commands are also available within the rolo match buffer. @kindex rolo, a @kindex rolo, h @kindex rolo, o @kindex rolo, s @kindex rolo, t @cindex rolo, outlining Single key outlining commands are also available for browsing matches. If your search matches a large number of entries, use @bkbd{t} to get a top-level summary of entries. Only the first line of each first-level match is shown. If you want to see an overview of all the levels, use @bkbd{o} which shows the first line of every entry level. If you want an overview of just the first two levels, @bkbd{C-u 2 o} will work. Press @bkbd{s} to show (expand) the entry at point. Use @bkbd{h} to hide (collapse) the entry. Press @bkbd{a} to expand all entries in the buffer. @noindent Many other keys are defined to help you move through matching entries. @cindex rolo, moving to entries @table @asis @kindex rolo, b @kitem b Move to the previous entry at the same level as the current entry. @kindex rolo, f @kitem f Move to the next entry at the same level as the current entry. @kindex rolo, n @kitem n Move to the next entry at any level. @kindex rolo, p @kitem p Move to the previous entry at any level. @kindex rolo, u @kitem u Move to the previous entry one level up. @kindex rolo, . @kindex rolo, < @kitem . or < Move to the beginning of the buffer. @kindex rolo, , @kindex rolo, > @kitem , or > Move to the end of the buffer. @kindex rolo, @key{DEL} @kitem @key{DEL} Scroll backward a windowful. @kindex rolo, @key{SPC} @kitem @key{SPC} Scroll forward a windowful. @end table @kindex rolo, e @cindex rolo, editing @cindex datestamps @cindex rolo, datestamps @cindex customize, rolo datestamps @cindex menu, Toggle-Rolo-Dates @cindex customize, rolo edits @cindex customize, rolo additions @vindex hyrolo-edit-hook @vindex hyrolo-add-hook Use the @bkbd{e} key to edit the current entry within your personal rolo file. A datestamp will automatically be added or updated at the end of the entry, unless this feature has been turned off via the Cust/Toggle-Rolo-Dates menu item. The variable, @code{hyrolo-edit-hook}, is evaluated after the update of the entry datestamp. This allows programmed modification of the way rolo edits work. The variable, @code{hyrolo-add-hook}, works the same way but is evaluated when a new entry is first added. @kindex rolo, q @cindex rolo, quitting Once you have found an entry of interest and you want to remove the rolo match buffer, use @bkbd{q} to quit. This will restore your current frame to its state prior to the rolo search. @node HyRolo Settings, , HyRolo Keys, HyRolo @section HyRolo Settings @vindex hyrolo-file-list @cindex rolo, personal The files used in any rolo search are given by the @code{hyrolo-file-list} variable, whose default value is typically @code{("~/.rolo.otl"}. Searches scan only your personal rolo file. Any entries added to this list should be absolute filenames. If a file in the list does not exist or is not readable, it is skipped. Files are searched in the order in which they appear in the list. In general, you should leave your personal rolo file as the first entry in the list, since this is the only file to which the Add command on the rolo menu adds entries. Hyperbole releases earlier than 4.17 used a different filename for the personal rolo. If such a file exists, you will be prompted to rename it whenever the HyRolo system is loaded. @cindex BBDB @cindex Big Brother DataBase If you use the Big Brother DataBase (BBDB) Emacs package to capture email addresses and store contact information, the rolo automatically works with it. If the BBDB package is loaded before HyRolo, then your @code{bbdb-file} of contacts is added as the second entry in @code{hyrolo-file-list} and will be searched automatically for any matches by the rolo find commands. Presently there is no support for editing BBDB entries, just finding them. For finding matches within only BBDB, there are the commands @code{hyrolo-bbdb-fgrep} (string finding) and @code{hyrolo-bbdb-grep} (regular expression finding). They may be bound to keys if desired. @cindex contacts, Google @cindex Google Contacts @cindex Gmail Contacts If you use Google/Gmail Contacts, you can configure the HyRolo to query your Google Contacts for matches. First you must download and install the external @file{google-contacts} package using the Emacs Package Manager. Then you must install the non-Emacs GNU Privacy Guard (GPG) package from @url{https://gnupg.org} so that the @file{gpg} or @file{gpg2} executable is in your command-line search path. Once these are in place, either restart Emacs or use @bkbd{M-x hyrolo-initialize-file-list @key{RET}} to add Google Contacts to your searches. When you next do a search, you will be prompted for your Google Contacts password and may also have to enter an authorization code that will be displayed on your screen. After authorization, your your information will be cached so that you are not prompted for it again within this Emacs session. @findex hyrolo-google-contacts-fgrep @findex hyrolo-google-contacts-grep For finding matches within only Google Contacts, there are the commands @code{hyrolo-google-contacts-fgrep} (string finding) and @code{hyrolo-google-contacts-grep} (regular expression finding). They may be bound to keys if desired. @vindex hyrolo-google-contacts-flag If you ever need to disable Google Contacts usage, there is a flag, @code{hyrolo-google-contacts-flag}, which when set to @samp{nil} disables searching of your Google Contacts. @noindent Below are the rest of the settings available with HyRolo: @vtable @code @cindex rolo, highlighting matches @item hyrolo-highlight-face If textual highlighting is available in your emacs on your current display type, the rolo uses the value of @code{hyrolo-highlight-face} as the face which highlights search matches. @item hyrolo-kill-buffers-after-use HyRolo 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: @code{(setq hyrolo-kill-buffers-after-use t)}. @item hyrolo-save-buffers-after-use After an entry is killed, the modified rolo file is automatically saved. If you would rather always save files yourself, use this setting: @code{(setq hyrolo-save-buffers-after-use nil)}. @item hyrolo-email-format When an entry is being added from within a mail reader buffer, the rolo extracts the sender's name and e-mail address and prompts you with the name as a default. If you accept the default, it will enter the name and the email address using the format given by the @code{hyrolo-email-format} variable. See its documentation if you want to change its value. @item hyrolo-hdr-regexp A rolo file may begin with an optional header section which is copied to the match display buffer whenever any matches are found during a search. The start and end lines of this header are controlled by the regular expression variable, @code{hyrolo-hdr-regexp}, whose default value is "^===". This allows lines of all equal signs to visually separate matching entries retrieved from multiple files during a single search. @item hyrolo-entry-regexp The rolo entry start delimiter is given by the regular expression variable, @code{hyrolo-entry-regexp}, whose default value is "^\*+", i.e.@: one or more asterisks at the beginning of a line. @item hyrolo-display-format-function When a rolo search is done, each matching entry is passed through the function given by the variable, @code{hyrolo-display-format-function}, before it is displayed. This should be a function of one argument, namely the matching rolo entry as a string. The string that this function returns is what is displayed in the rolo match buffer. The default function used is @code{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. @end vtable @node Window Configurations, Developing with Hyperbole, HyRolo, Top @chapter Window Configurations @cindex window configurations @cindex restoring windows @cindex saving window configurations @vindex file, hywconfig.el This chapter explains Hyperbole's @file{hywconfig.el} library. It lets you save and restore window configurations, i.e@. the layout of windows and buffers displayed within an emacs frame. This is useful to save a particular working context and then to jump back to it at a later time during an emacs session. It is also useful during demonstrations to display many informational artifacts all at once, e.g.@: all of the windows for a particular subsystem. None of this information is stored between emacs sessions, so your window configurations will last through only a single session of use. Each window configuration is tied to the emacs frame in which it is created. The hywconfig library offers two independent ways of managing window configurations. The first way associates a name with each stored window configuration. The name may then be used to retrieve the window configuration later. The second way uses a ring structure to save window configurations and then allows cycling through the ring of saved configurations, finally wrapping around to the first entry after the last entry is encountered. Simply stop when the desired configuration is displayed. The Win/ menu entry on the Hyperbole top-level menu displays a menu of hywconfig window configuration commands: @verbatim WinConfig> AddName DeleteName RestoreName PopRing SaveRing YankRing @end verbatim @noindent The operations on this menu are defined as follows. @cindex hywconfig commands @cindex wconfig commands @cindex window configuration commands @cindex named window configuration @cindex window configuration ring @findex hywconfig-add-by-name @findex hywconfig-delete-by-name @findex hywconfig-restore-by-name @findex hywconfig-delete-pop @findex hywconfig-ring-save @findex hywconfig-yank-pop @example @group Menu Item Command Description ===================================================================== AddName hywconfig-add-by-name Name current wconfig DeleteName hywconfig-delete-by-name Delete wconfig by name RestoreName hywconfig-restore-by-name Restore wconfig by name PopRing hywconfig-delete-pop Restore and delete wconfig SaveRing hywconfig-ring-save Store wconfig to the ring YankRing hywconfig-yank-pop Restore the next wconfig ===================================================================== @end group @end example The easiest method to save and restore window configurations shown here is by name, but it requires that you type the chosen name. Instead, the ring commands permit saves and restores using only the mouse. Since the ring commands are a bit more complex than their by-name counterparts, the following paragraphs explain them in more detail. @vindex kill-ring HyWconfig creates a ring structure that operates just like the Emacs @code{kill-ring} (@pxref{Kill Ring,,,emacs,the GNU Emacs Manual}) but its elements are window configurations rather than text regions. You can add an element to the ring to save the current window configuration in the selected frame. After several elements are in the ring, you can walk through all of them in sequence until the desired configuration is restored. @findex hywconfig-ring-save SaveRing executes the @code{hywconfig-ring-save} command which saves the current window configuration to the ring. @findex hywconfig-yank-pop YankRing executes the @code{hywconfig-yank-pop} command. It restores the window configuration currently pointed to within 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 @bkbd{q} to quit from the minibuffer menu. @findex hywconfig-delete-pop PopRing calls the @code{hywconfig-delete-pop} command. It is used to restore a previously saved configuration and to delete it from the ring. Simply stop when a desired configuration appears and use @bkbd{q} to quit from the minibuffer menu. @vindex hywconfig-ring-max The maximum number of elements the ring can hold is set by the @code{hywconfig-ring-max} variable whose default is 10. Any saves beyond this value will delete the oldest element in the ring before a new one is added. @node Developing with Hyperbole, Glossary, Window Configurations, Top @chapter 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:: @end menu @node Hook Variables, Creating Types, Developing with Hyperbole, Developing with Hyperbole @section Hook Variables @cindex variables @cindex 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. @findex add-hook We find it best to always set the value of hook variables either to @samp{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 @code{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 @samp{-hook} appended. Hyperbole includes the following hook variables: @vtable @code @item hyperbole-init-hook For customization at Hyperbole initialization time. Use this to load any personal Hyperbole type definitions or key bindings you might have. It is run after Hyperbole support code is loaded but before Hyperbole is initialized, i.e. prior to keyboard and mouse bindings. @item action-key-depress-hook @itemx assist-key-depress-hook Run after an Action or Assist Mouse Key depress is detected. @item action-key-release-hook @itemx assist-key-release-hook Run after an Action or Assist Mouse Key release is detected, before any associated action is executed. @vindex hbut:current @item action-act-hook Run before each Hyperbole button activation. The variable @code{hbut:current} contains the button to be activated when this is run. @item ebut-create-hook Adds to the Hyperbole explicit button creation process. @item ebut-delete-hook Adds to the Hyperbole explicit button deletion process. @item ebut-modify-hook Executed when an explicit button's attributes are modified. @item 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. @item 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. @item htype-create-hook Executed whenever a Hyperbole type (e.g.@: action type or implicit button type) is added to the environment. @item htype-delete-hook Executed whenever a type is deleted from the environment. @item kotl-mode-hook Executed whenever a koutline is created or read in or when kotl-mode is invoked. @item hyrolo-add-hook Executed after the addition of a new rolo entry. @item hyrolo-display-hook Executed when rolo matches are displayed. @item hyrolo-edit-hook Executed after point is successfully moved to an entry to be edited. @item hyrolo-mode-hook Executed when a rolo match buffer is created and put into hyrolo-mode. @cindex yank, reformatting @item hyrolo-yank-reformat-function A variable whose value may be set to a function of two arguments, START and END, which give the region of the rolo entry yanked into the current buffer by the hyrolo-yank command. The function may reformat this region to meet user-specific needs. @end vtable @noindent Hyperbole also makes use of a number of standard Emacs hook variables. @vtable @code @cindex button highlighting @item find-file-hook This is called whenever a file is read into a buffer. Hyperbole uses it to highlight any buttons within files. @cindex button data saving @item 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. @cindex mail hooks @cindex news hooks 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. @end vtable @node Creating Types, Explicit Button Technicalities, Hook Variables, Developing with Hyperbole @section Creating Types @cindex type definition @cindex type redefinition @noindent To define or redefine a single Hyperbole type, you may either: @itemize @bullet @kindex C-M-x @findex eval-defun @kindex C-x C-e @findex eval-last-sexp @item move your Emacs point to within the type definition and use @bkbd{C-M-x} @code{(eval-defun)} (only works in Emacs Lisp mode); @item or move your point to the end of the last line of the type definition and use @bkbd{C-x C-e} @code{(eval-last-sexp)} (works in most modes). @end itemize @cindex Hyperbole types @vindex class, htype The functions from the @samp{htype} class may be applied to any Hyperbole types, if needed. @vindex file, hactypes.el @vindex file, hibtypes.el 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 @file{hactypes.el} and @file{hibtypes.el} for examples. @menu * Action Type Creation:: * Implicit Button Types:: @end menu @node Action Type Creation, Implicit Button Types, Creating Types, Creating Types @subsection Action Type Creation @findex actype:create @vindex file, hactypes.el @vindex file, hbut.el New forms of explicit buttons may be created by adding new action types to a Hyperbole environment. The file, @file{hactypes.el}, contains many examples of working action types. @cindex action type, creation @findex defact @findex actype:create An action type is created, i.e.@: loaded into the Hyperbole environment, with the @code{(defact)} function (which is an alias for @code{(actype:create)}). The calling signature for this function is given in its documentation; it is the same as that of @code{(defun)} except that a documentation string is required. An interactive calling form is also required if the action type has formal parameters and is to be used in explicit or global button definitions. Implicit buttons never use an action type's interactive form; however, it is good practice to include an interactive form since the type creator cannot know how users may choose to apply the type. An action type's parameters are used differently than those of a function being called. Its interactive calling form is used to prompt for type-specific button attributes whenever an explicit button is created. The rest of its body is used when a button with this action type is activated. Then the button attributes together with the action type body are used to form an action that is executed in response to the button activation. The action's result is returned to the action caller unless it returns @samp{nil}, in which case @samp{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. @cindex interactive form @findex interactive 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 @code{(interactive)} form or @pxref{Interactive Codes,,Code Characters for 'interactive',elisp, the GNU Emacs Lisp Reference Manual}. It may additionally use Hyperbole command character extensions when the form is given as a string. Each such extension character @emph{must} be preceded by a plus sign, @samp{+}, in order to be recognized, since such characters may also have different standard interactive meanings. @noindent The present Hyperbole extension characters are: @table @code @cindex argument, Info node @cindex interactive cmd char, +I @item +I Prompts with completion for an existing Info (filename)nodename. @cindex argument, kcell @cindex argument, koutline @cindex interactive cmd char, +K @item +K Prompts for an existing kcell identifier, either a full outline level identifier or a permanent idstamp. @cindex argument, klink @cindex interactive cmd char, +L @item +L Prompts for a klink specification. See the documentation for the function @code{(kcell-view:reference)} for details of the format of a klink. @cindex interactive cmd char, +M @cindex argument, mail message @item +M Prompts for a mail message date and the filename in which it resides. The mail parameters prompted for by this character code may change in the future. @cindex argument, view spec @cindex interactive cmd char, +V @item +V Prompts for a Koutliner view specification string, with the current view spec, if any, as a default. @cindex argument, Info index item @cindex interactive cmd char, +X @item +X Prompts with completion for an existing Info index (filename)itemname. @end table @vindex class, hargs @cindex argument, reading Arguments are read by the functions in Hyperbole's @code{hargs} class, rather than the standard Lisp @code{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, @samp{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. @findex actype:delete Call @code{(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). @node Implicit Button Types, , Action Type Creation, Creating Types @subsection Implicit Button Types @cindex implicit button type @cindex ibtype @findex defib @findex ibtype:create An implicit button type is created or loaded via the @code{(defib)} function (which is an alias for @code{(ibtype:create)}). The calling signature for this function is given in its documentation; it is the same as that of @code{(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. @cindex ibtype, predicate @cindex ibtype, argument @cindex ibtype, return val @cindex ibtype, actype 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 @samp{nil}. If so, it may optionally setup to flash the button and then to perform one or more actions. A call of the form: @code{(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: @code{(hact 'actype &rest actype-arguments)}. It is imperative that all actions (non-predicate code) be invoked through the @code{(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 @code{(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, @samp{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. @findex ibtype:delete Call @code{(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. @cindex ibtype, help @findex ibut:at-p @vindex class, hattr @vindex class, hbut @vindex file, hib-kbd.el 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 @samp{:help}, e.g.@: @code{my-ibtype:help}, it is used as the assist-action whenever the Assist Key is pressed, to respond to requests for help on buttons of that type. Any such function should take a single argument of an implicit button construct. (This is what @code{(ibut:at-p)} returns when point is within an implicit button context.) The button may be queried for its attributes using functions from the @samp{hbut} and @samp{hattr} classes. See the @file{hib-kbd.el} file for an example of a custom help function. @node Explicit Button Technicalities, Encapsulating Systems, Creating Types, Developing with Hyperbole @section Explicit Button Technicalities @menu * Button Label Normalization:: * Operational and Storage Formats:: * Programmatic Button Creation:: @end menu @node Button Label Normalization, Operational and Storage Formats, Explicit Button Technicalities, Explicit Button Technicalities @subsection Button Label Normalization @cindex normalized label @cindex button label @cindex button key @vindex hbut:label-to-key Hyperbole uses a normalized form of button labels called button keys (or label keys) for all internal operations. See the documentation for the function @code{(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. @example <(fake button)> <( fake button)> Pam> <(fake Pam> button)> ;; <(fake ;; button)> /* <( fake */ /* button )> */ @end example @vindex hbut:fill-prefix-regexps @vindex fill-prefix @cindex fill prefix @cindex button, multiple lines @cindex button, split across lines 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 @code{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, @code{fill-prefix}, so no user intervention is required. @node Operational and Storage Formats, Programmatic Button Creation, Button Label Normalization, Explicit Button Technicalities @subsection Operational and Storage Formats @cindex explicit button formats @cindex explicit button storage @cindex storage manager @cindex button attributes @vindex hbut:current 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 @code{hbut:current} symbol by default to store and retrieve the last encountered button in edit format. @vindex class, hbdata @vindex class, ebut @vindex class, hbut The @samp{hbdata} class handles the terse, stored format. The @samp{hbut}, @samp{ebut}, and @samp{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. @node Programmatic Button Creation, , Operational and Storage Formats, Explicit Button Technicalities @subsection Programmatic Button Creation @cindex explicit 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. @vindex class, ebut @vindex file, hbut.el @findex ebut:create @findex ebut:map The Hyperbole class @samp{ebut} supports programmatic access to explicit buttons. Examine it within the @file{hbut.el} file for full details. The documentation for @code{(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 @code{(ebut:map)} function. @node Encapsulating Systems, Embedding Hyperbole, Explicit Button Technicalities, Developing with Hyperbole @section Encapsulating Systems @vindex file, hsys-* @cindex Hyperbole, system encapsulation @cindex system encapsulation 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 @file{hsys-*} files for examples of how to do this. Encapsulations are provided for the following systems (the systems themselves are not included with Hyperbole): @table @emph @item 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. @end table @node Embedding Hyperbole, , Encapsulating Systems, Developing with Hyperbole @section 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.] @cindex Hyperbole API @cindex API @cindex programming interface @cindex Hyperbole, embedding 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: @noindent @file{hact.el}, @file{hargs.el}, @file{hbmap.el}, @file{hbut.el}, @file{hhist.el}, @file{hmail.el}, @file{hmoccur.el}, @file{hpath.el}, @file{htz.el}, @file{hypb.el}, @file{hyrolo.el}, @file{hyrolo-logic.el}, @file{hywconfig.el} and @file{set.el}. @noindent Note when looking at these files, that they are divided into sections that separate one data abstraction (class) from another. A line of dashes within a class separates public parts of the class from the private parts that follow the line. This API does not include the Hyperbole Koutliner, as it has been designed for interactive use, rather than programmatic extensibility. You are welcome, however, to study its code, below the @file{hyperbole-$@{hyperb:version@}/kotl/} directory. @node Glossary, Setup, Developing with Hyperbole, Top @appendix Glossary @cindex glossary @cindex definitions Concepts pertinent to operational usage of Hyperbole are defined here. @xref{Glossary,,,emacs,the GNU Emacs Manual}, if any emacs-related terms are unfamiliar to you. @table @b @item Action An executable behavior associated with a Hyperbole button. @dfn{Links} are a specific class of actions which display existing entities, such as files. See also @b{Action Type}. @item Action Key See @b{Smart Key}. @item 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 @dfn{action}. @dfn{Actype} is a synonym for action type. @item Activation A request to a Hyperbole button to perform its action. Ordinarily the user presses a key which selects and activates a button. @item Argument A button-specific value fed to a Hyperbole type specification when the button is activated. @item Assist Key See @b{Smart Key}. @item Attribute A named parameter slot associated with a category or type of Hyperbole button. An @emph{attribute value} is typically specific to a particular button instance. @cindex Augment @cindex hypertext @cindex interactive computing @cindex mouse @cindex windows @cindex hypertext @cindex outline processor @cindex groupware @cindex digital signature @cindex Engelbart @item Augment The Augment system, originally named NLS, was a pioneering research and production system aimed at augmenting human intellect and group knowledge processing capabilities through integrated tools and organizational development strategies. This approach led to the invention of much of interactive computing technology decades ahead of other efforts, including: the mouse, chord keyboards, screen windows, true hypertext, outline processors, groupware, and digitally signed documents. @xref{References}, which cites several Douglas Engelbart papers on the subject. The Koutliner demonstrates a few of the concepts pioneered in Augment. @item Buffer An Emacs buffer is an editable or viewable text, possibly with special formatting such as an outline or table. It may also be attached to a process, receiving and updating its text as the process handles changing information. @item 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. @emph{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. @item Button Activation See @b{Activation}. @item Button Attributes See @b{Attributes}. @item Button Data Lists of button attribute values explicitly saved and managed by Hyperbole. One list for each button created by Hyperbole. @item Button File, local A per-directory file named @file{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. @item Button File, personal A per-user file named @file{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. @item Button Key A normalized form of a @b{button label} used internally by Hyperbole. @item 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. @vindex ebut:max-len The maximum length of a button label is limited by the variable @code{ebut:max-len}. @item Button Selection The act of designating a Hyperbole button upon which to operate. Use the Action Key to select a button. @item Category A class of Hyperbole buttons: implicit, explicit or global. @item Cell See @code{Kcell}. @item Children The set of koutline cells which share a common parent cell and thus, are one level deeper than the parent. @c @item Chord Keyboard @c A keyboard which supports pressing multiple keys simultaneously to produce @c a unique chord keystroke for issuing commands to a program. In Engelbart's @c Augment system, mouse keys were used as modifiers for a 5-key chord @c keyboard to enable direct manipulation of objects on screen. Hyperbole @c supports similar behavior with its @code{hmouse-mod-mode}. @xref{Smart @c Mouse Key Modifiers}. @item 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. @item 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. @item Display See @b{Screen}. @item Domain The contexts in which an implicit button type may be found, i.e.@: where its predicate is true. @item Drag A mouse button press in one location and following release in another location. @item Environment See @b{Hyperbole Environment}. @item Explicit Button A button created and managed by Hyperbole, associated with a specific action type. By default, explicit buttons are delimited like this @samp{<(fake button)>}. Direct selection is used to operate upon an explicit button. @item Frame An Emacs frame displays one or more Emacs windows and widgets (menubars, toolbars, scrollbars). Under a graphical window system, this is a single window system window. On a dumb terminal, only one frame is visible at a time as each frame generally fills the whole terminal display, providing a virtual screen capability. Emacs windows exist within a frame. @vindex gbut:file @item Global Button A Hyperbole 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 @code{gbut:file} and may be activated with the Action Key when editing this file. By default, this is the same as the user's personal button file. @item Global Button File See @b{Button File, personal} and @b{Global Button}. @item Grid See @b{Windows Grid}. @findex run-hooks @item 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 @code{(run-hooks)}. @item HyControl HyControl, the Hyperbole window and frame control manager, offers fast, single key manipulation of window and frame creation, deletion, sizing, position and face zooming (enlarging/shrinking). @item 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. @item 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. @item 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. @item HyRolo HyRolo, the Hyperbole record/contact manager, provides rapid lookup of multi-line, hierarchically ordered free form text records. It can also lookup records from Google/GMail Contacts and the Big Brother DataBase (BBDB) package. @item Implicit Button A button recognized contextually by Hyperbole. Such buttons contain no button data but may have an optional preceding label that looks like this: @samp{<[label]>}. See also @b{implicit button type}. @item 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. @b{Ibtype} is a synonym for implicit button type. See also @b{system encapsulation}. @cindex InfoDock @item InfoDock InfoDock was an integrated productivity toolset for software engineers and knowledge workers built atop XEmacs; it is no longer maintained or updated. An older version from 1999 may be found at infodock.sf.net. InfoDock has much of the power of GNU Emacs, but with an easier to use and more comprehensive menu-based user interface. Most objections people raise to using emacs have already been addressed in InfoDock. InfoDock was meant for people who wanted a complete, pre-customized environment in one package. @item 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. @item Jedi See also @url{https://tkf.github.io/emacs-jedi/latest/}. Jedi is a Emacs package for Python completion, definition and documentation lookup. @item Key Sequence A single sequence of keys that can invoke an Emacs command. @item Key Series A series of one or more Emacs key sequences delimited by braces that Hyperbole processes when activated as an implicit button, as if the keys were typed in by the user. @item Koutline A hierarchically ordered grouping of cells which may be stored as a file and viewed and edited as an outline. @item 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. @item 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 @b{Koutliner}. @item Link A reference from a Hyperbole button to an existing (non-computed) entity. The referenced entity is called a @dfn{referent}. Links are a subset of the types of actions that Hyperbole buttons support. @item Local Button File See @b{Button File, local}. @item Minibuffer Window The one line window at the bottom of a frame where messages and prompts are displayed. @item 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, @samp{/}. @item Mouse Key @itemx Mouse Button See @b{Smart Key}. @item NLS See @b{Augment}. @item Node See @b{Link} or @b{Cell}. @item The OO-Browser See also @url{https://www.gnu.org/software/oo-browser}. The GNU OO-Browser is a multi-windowed, interactive object-oriented class browser similar in use to the well-known Smalltalk browsers. It runs inside Emacs. It is unique in a number of respects foremost of which is that it works well with most major object-oriented languages in use today. You can switch from browsing in one language to another in a few seconds. It provides both textual views within an editor and graphical views under the X window system and Windows. It includes support for C, C++, Common Lisp and its Object System (CLOS), Eiffel, Java, Objective-C, Python and Smalltalk. Hyperbole provides the mouse support for the OO-Browser, providing Smart Keys that utilize the OO-Browser's capabilities both when it is displayed on screen and when editing code. @item Outline See @b{Koutline}. @item Parent Any koutline cell which has children. @item Predecessor The previous same level koutline cell with the same parent. @item Predicate A boolean (@samp{nil} = false, non-nil = true = @samp{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. @item Referent See @b{Link}. @item Remote Pathname A file or directory on a system not shared within the local area network. The built-in Emacs library, @b{Tramp}, handles remote pathnames and Hyperbole uses it to enable viewing and editing of remote paths of the form: @file{/:@@:} as well as web URLs. Use the Cust/Find-File-URLs menu option to enable this feature. @item Rolo See @b{HyRolo}. @item Root Cell A koutline cell which has cells below it at lower outline levels. All such cells share the same root cell. @cindex Screen @item Screen The total display area available to Emacs frames. This may consist of multiple physical monitors arranged into a single virtual display. Screen edges are thus the outer borders of the virtual display. @cindex Smart Key @cindex proportional scrolling @cindex scrolling @item Smart Key A context-sensitive key used within Hyperbole and beyond. There are two Smart Keys, the Action Key and the Assist Key. The Action Key activates Hyperbole buttons and scrolls the current buffer line to the top of the window when pressed at the end of a line. The Assist Key shows help for Hyperbole buttons and scrolls the current line to the bottom of the window when pressed at the end of a line. The @bkbd{C-h h d s} Doc/SmartKeys menu item displays a full summary of Smart Key capabilities. @xref{Smart Keys}, for complete details. @item Smart Menus Smart Menus are an older in-buffer menu system that worked on dumb terminals and pre-dated Emacs' own dumb terminal menu support. They are included with InfoDock (which is no longer maintained) and are not available separately. They are not a part of Hyperbole and are not necesary for its use but are still supported by the Smart Keys. @item Source Buffer / File The buffer or file within which a Hyperbole button is embedded. @item Subtree All of the cells in a koutline which share the same root cell, excluding the root cell. @item Successor The next same level koutline cell which follows the current cell and shares the same parent. @item 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. @item Tramp A remote file access library built-in to Emacs. It uses secure transfer and works with many types of hosts. It allows you to use remote pathnames that are accessible via Internet protocols just like other pathnames, for example when finding a file. Hyperbole recognizes pathnames of the form, @file{/:@@:} and web URLs. @item Tree The set of cells in a koutline that share a common root cell, including the root cell. @item URL A Universal Resource Locator specification used on the World-Wide web to access documents and services via a multiplicity of protocols. @item 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. @item 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>. @item Window An Emacs window displays a single Emacs buffer within a single frame. Frames may contain many windows. @item Windows Grid A feature of HyControl invoked with @bkbd{@@} which creates, lays out and populates a grid of a specified size of new Emacs windows, e.g. 4 rows by 3 columns, each displaying a different buffer chosen by a set of user specifiable filters. @end table @node Setup, Global Key Bindings, Glossary, Top @appendix Setup Hyperbole must be obtained and setup at your site before you can use it. Instructions are given below. If you are using InfoDock version 4.0.7 or higher, Hyperbole is pre-installed so you may skip the installation instructions and simply continue with the invocation instructions in this appendix. @menu * Installation:: * Invocation:: * Customization:: @end menu @node Installation, Invocation, Setup, Setup @section Installation @cindex installation @cindex obtaining Hyperbole @cindex Hyperbole, obtaining Once you have Emacs set up at your site, GNU Hyperbole may be installed by using the Emacs Package Manager. If you are not familiar with it, @pxref{Packages,,,emacs,the GNU Emacs Manual}. If you have Hyperbole installed and simply want to upgrade it, invoke the Emacs Package Manager with @bkbd{M-x list-packages @key{RET}}, then use the @bkbd{U} key followed by the @bkbd{x} key to upgrade all out-of-date packages, Hyperbole among them. Then skip the text below and move on to the next section, @pxref{Invocation}. Otherwise, to download and install the Hyperbole package, you should add several lines to your personal Emacs initialization file, @file{~/.emacs}. (For further details, @pxref{Init File,,The Emacs Initialization File,emacs, the GNU Emacs Manual}). @noindent Below are the lines to add: @lisp (require 'package) ;; Prevent double loading of libraries (setq package-enable-at-startup nil) (package-initialize) (unless (package-installed-p 'hyperbole) (package-refresh-contents) (package-install 'hyperbole)) (require 'hyperbole) @end lisp Now save the file and restart Emacs. Hyperbole will then be downloaded and compiled for use with your version of Emacs; give it a minute or two. You may see a bunch of compilation warnings but these can be safely ignored. @noindent Now read the next section on Invocation. @node Invocation, Customization, Installation, Setup @section Invocation Once Hyperbole has been installed for use at your site and loaded into your Emacs session, it is ready for use. You will see a Hyperbole menu on your menubar and @bkbd{C-h h} will display a Hyperbole menu in the minibuffer for quick keyboard or mouse-based selection. Select an item from this menu by typing the item's first letter. Use @bkbd{q} to quit from the menu. @noindent You can invoke Hyperbole's commands in one of three ways: @itemize @bullet @item use the Hyperbole entry on your menubar; @findex hyperbole @item type @bkbd{C-h h} or @bkbd{M-x hyperbole @key{RET}} to display the Hyperbole minibuffer menu; @item use a specific Hyperbole command, for example, a press of @bkbd{M-@key{RET}} on a pathname to display the associated file or directory. @end itemize Use @bkbd{C-h h d d} for an interactive demonstration of standard Hyperbole button capabilities. Type @bkbd{C-h h k e} for an interactive demonstration of the Koutliner, Hyperbole's multi-level autonumbered hypertextual outliner. To try out HyControl, Hyperbole's interactive frame and window control system, use @bkbd{C-h h s w} for window control or @bkbd{C-h h s f} for frame control. Pressing @bkbd{t} switches between window and frame control once in HyControl. Hyperbole also binds @bkbd{C-c \\} for quick access to HyControl's window control menu if it was not already bound prior to Hyperbole's initialization. A long video demonstrating most of HyControl's features is available at @url{https://youtu.be/M3-aMh1ccJk}. @vindex Info-directory-list @vindex hyperb:dir @cindex Hyperbole manual @noindent The above are the best interactive ways to learn about Hyperbole. The Hyperbole Manual is a reference manual, not a simple introduction. It is included in the @file{man/} subdirectory of the Hyperbole package directory in four forms: @cindex Info manual @cindex Texinfo manual @vindex file, man/hyperbole.info @vindex file, man/hyperbole.html @vindex file, man/hyperbole.pdf @vindex file, man/hyperbole.texi @example @file{man/hyperbole.info} - online Info browser version @file{man/hyperbole.html} - web HTML version @file{man/hyperbole.pdf} - printable version @file{man/hyperbole.texi} - source form @end example @kindex C-h h d i The Hyperbole package installation places the Info version of this manual where needed and adds an entry for Hyperbole into the Info directory under the Emacs category. @bkbd{C-h h d i} will let you browse the manual. Then use @bkbd{s} to search for anything throughout the manual. For web browsing, point your browser at @file{@code{$@{hyperb:dir@}}/man/hyperbole.html}, wherever the Hyperbole package directory is on your system; often this is: @file{~/.emacs.d/elpa/hyperbole-$@{hyperb:version@}/}. @noindent Advanced users may want to continue on to the next section about configuring Hyperbole's behavior. @page @node Customization, , Invocation, Setup @section Customization @cindex menu, Cust @cindex configuration @cindex customization Major Hyperbole user options may be set from the Customize submenu below the Hyperbole menubar menu, as seen here. @float Image,image:Customize Menu @caption{Hyperbole Customize Menu} @image{im/menu-customization,,3.5in,Hyperbole Customize Menu} @end float @sp 1 @noindent Alternatively, the minibuffer-based menu, Cust/ may be used. @cindex customization @cindex option setting @cindex variable setting Generally, you should not need to change anything other than these options. However, if you like to customize your environment extensively, there are many additional Hyperbole customization options that may be changed with the Emacs customization interface, @pxref{Easy Customization,,Easy Customization Interface,emacs, the GNU Emacs Manual}. When you save any changes within this interface, the changes are saved permanently to your personal Emacs initialization file and are available in future Emacs sessions. @findex customize-browse @cindex menu item, Cust/All-Options @kindex C-h h c a Use Cust/All-Options @bkbd{C-h h c a} to display an expandable tree of customizable Hyperbole options. Hyperbole's customizations are further grouped into several sub-categories, one for the Koutliner, one for the HyRolo, etc. You can select either an entire category or a specfic option and they will appear in another window for editing. Simply follow the instructions on screen and then press the ``Apply and Save'' button to make any changes permanent. @findex customize-variable If you know the name of the option you want to edit, you can edit it at any time without going through the tree of options. Use @bkbd{M-x customize-variable @key{RET}} and then type the name of the variable and press @key{RET} to edit it. The following sections discuss the customization options most likely to be of interest to users. @menu * Referent Display:: * Internal Viewers:: * External Viewers:: * Link Variable Substitution:: * Web Search Engines:: * Using URLs with Find-File:: * Invisible Text Searches:: * Button Colors:: @end menu @node Referent Display, Internal Viewers, Customization, Customization @subsection Referent Display @vindex hpath:display-where @cindex referent display @cindex link display @cindex display where @cindex display outside Emacs @cindex where to display @cindex image display @cindex internal display @cindex external display Hyperbole lets you control where link referents are displayed. It also permits setting a specific Emacs function or external program to display them. There are four categories of referents, each with its own display setting, listed in decreasing order of priority. All of these variables are defined within @file{hpath.el}. @example Referent Category Variable Setting ======================================================================== Internal Image Display hpath:native-image-suffixes Internal Custom Display hpath:internal-display-alist External Display hpath:external-display-alist Internal Standard Display hpath:display-where @end example @noindent Continue reading the next sections for information on how referents are displayed internally and externally. @node Internal Viewers, External Viewers, Referent Display, Customization @subsection Internal Viewers @vindex hpath:internal-display-alist @cindex file display function @cindex display function @cindex internal viewer @cindex link, display function @cindex internal image display @vindex hpath:native-image-suffixes @cindex internal custom display @vindex hpath:internal-display-alist @cindex internal standard display @vindex hpath:display-where When given a filename to display, Hyperbole first checks if its suffix is matched by @code{hpath:native-image-suffixes}. If so and if the function @code{image-mode} is defined, it uses that mode together with the value of @code{hpath:display-where} to display the image within an Emacs buffer. If no match is found, the @code{hpath:internal-display-alist} variable is checked for a filename match. Its value is an association list whose elements are ( . ) pairs. Any path whose name matches a will be displayed by calling the associated with the filename as the argument. The first regular expression that matches each filename is the one used. This can be used to format raw data files for convenient display. By default, this setting handles the following types of files: @table @emph @item Audio Files Major audio format files are played with the @code{play-sound-file} command. @item Info Manuals Files with a @file{.info} suffix (may also be compressed) are displayed in the Info browser. @item RDB Files Files with an @file{.rdb} suffix are displayed as relational databases using the RDB package available with InfoDock. @end table @cindex menu, Cust/Referents @kindex C-h h c r Links to standard files, those which don't match any special referent category described earlier, are displayed in an Emacs window specified by the @code{hpath:display-where} setting. It may be changed with the Cust/Referents @bkbd{C-h h c r} menu. @noindent Available options are: @table @emph @item @bullet{} Any-Frame Display in the selected window of another existing frame @item @bullet{} Current-Win Display in the selected (current) window @item @bullet{} Diff-Frame-One-Win Display in the selected window of another existing frame, deleting its other windows @item @bullet{} New-Frame Display in a new single window frame @item @bullet{} Other-Win Display in another, possibly new window of the selected frame (this is the default) @item @bullet{} Single-Win Display in a window of the selected frame and delete its other windows @end table @page @noindent Alternatively, you can use the Hyperbole menubar menu as shown here: @float Image,image:Menu-Display-Referents @caption{Display Referents Menu} @image{im/menu-display-referents,6in,,Display Referents Menu} @end float @sp 1 @xref{External Viewers}, for instructions on associating filenames with external, window-system specific viewers. @node External Viewers, Link Variable Substitution, Internal Viewers, Customization @subsection External Viewers @findex hpath:get-external-display-alist @vindex hpath:external-display-alist-macos @vindex hpath:external-display-alist-mswindows @vindex hpath:external-display-alist-x @cindex window system @cindex external program @cindex external viewer @cindex link, viewer program @cindex external display @vindex hpath:external-display-alist If you use Hyperbole under a window system, the @code{hpath:get-external-display-alist} function in @file{hpath.el} supports hyperlinks that open files using external, non-Emacs tools, e.g.@: a pdf reader or a vector graphics viewer. The value returned by @code{hpath:get-external-display-alist} is determined based on the window system supported by the current frame and the version of Emacs in use. This value is an association list whose elements are ( . ) pairs. Any path whose name matches a will be displayed using the corresponding viewer-program or the first viewer-program found on the system from a list of programs. If a entry contains a @samp{%s} string, the filename to display is substituted at that point within the string. Otherwise, the filename is appended to the entry. Alternatively, the viewer-program may be a Lisp function that takes a single filename argument. The association lists used by this function are stored in variables for each available window system: @code{hpath:external-display-alist-macos}, @code{hpath:external-display-alist-mswindows}, and @code{hpath:external-display-alist-x}. Examine and modify these values to suit your needs. @c @cindex MIME @c @cindex mailcap @c @cindex external viewer @c On systems that have a MIME mailcap file (see @c @file{www.wikiwand.com/en/Mailcap}), this is used as a fallback @c set of external viewer associations when none are found @c within @code{hpath:get-external-display-alist}. @node Link Variable Substitution, Web Search Engines, External Viewers, Customization @subsection Link Variable Substitution @vindex hpath:variables @cindex environment variables @cindex Emacs Lisp variables @cindex Lisp variables Another option to consider modifying is @code{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 @code{hpath:variables}. The first match found, if any, is selected and its associated variable name is substituted into the link pathname, in place of its literal value. When a link button is activated, potentially at a different site, Hyperbole replaces each variable in the link pathname with the first matching value from this list to recreate the literal pathname. Environment variables are also replaced whenever link paths are resolved. This permits sharing of links over wide areas, where the variable values differ between link creator and link activator. The entire process is wholly transparent to the user; it is explained here simply to help you in deciding whether or not to modify the value of @code{hpath:variables}. @node Web Search Engines, Using URLs with Find-File, Link Variable Substitution, Customization @subsection Web Search Engines @cindex menu, Find/Web @cindex menu, Web @cindex menu, Cust/Web-Search @kindex C-h h c w @kindex C-h h f w @vindex hyperbole-web-search-alist @cindex search engines menu @cindex web search menu @cindex customizing web search menu The Find/Web menu offers quick access to major web search engines. It is typically bound to @bkbd{C-c /} or if not, then @bkbd{C-h h f w} is always available. Your standard web browser will be used to return the search results. Advanced users can change the search engines listed in the Find/Web menu with @bkbd{M-x customize-variable @key{RET} hyperbole-web-search-alist @key{RET}}. Changes are automatically reflected in the Hyperbole menus once applied. Remember each search engine name must begin with a unique letter and each URL must have a %s format field indicating where to place the web search term when a search is performed. @page You can change which browser is used with @bkbd{C-h h c w}, the Cust/Web-Search menu. Below is the equivalent Hyperbole menubar menu. @float Image,image:Web-Search-Browser-Menu @caption{Web Search Browser Menu} @image{im/menu-web-search-browser,6in,,Web Search Browser Menu} @end float @sp 1 @node Using URLs with Find-File, Invisible Text Searches, Web Search Engines, Customization @subsection Using URLs with Find-File @findex find-file @cindex find-file, browsing URLs @cindex browsing URLs @cindex URLs, using with find-file @cindex web pages, displaying @cindex remote pathnames 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 @code{find-file} command (or any other @code{find-file-*} commands). But because there is added overhead with this feature, it is not enabled by default. @cindex menu item, Find-File-URLs @cindex menu item, Find-File-Accepts-URLs To enable the feature, use the Hyperbole menu item Cust/Find-File-URLs (or Find-File-Accepts-URLs on the Hyperbole/Customize pulldown menu). Either of these toggles acceptance of URLs. When enabled the string, URLs, appears in the parenthesized minor-mode section of the modeline. @findex hpath:find-file-urls-mode @cindex enabling URLs in find-file @cindex browsing URLs in find-file To enable this feature each time you start the editor, add the following to your personal initialization file after initializing Hyperbole: @code{(hpath:find-file-urls-mode 1)}. @cindex abbreviated URLs @cindex URLs, abbreviated @cindex Tramp Both full URLs and abbreviated ones, like @file{www.gnu.org}, are recognized. filename completion does not work with URLs; you have to type or paste in the entire URL. This feature will work only if you have the builtin Tramp Emacs Lisp package; if you don't have Tramp, an error message will be displayed when you try to enable find-file URLs. @kindex C-h h c u @cindex menu, Cust/URL-Display The web browser used to display URLs may be set with the minibuffer menu Cust/URL-Display @bkbd{C-h h c u} or with this Hyperbole menubar menu. @float Image,image:URL-Browser-Menu @caption{URL Browser Menu} @image{im/menu-url-browser,6in,,URL Browser Menu} @end float @sp 1 @node Invisible Text Searches, Button Colors, Using URLs with Find-File, Customization @subsection Invisible Text Searches @cindex menu item, Isearch-Invisible @cindex menu item, Toggle-Isearch-Invisible @cindex isearch @cindex search This is largely for outline modes such as the Koutliner. By default, character-by-character interactive search on @bkbd{C-s} will search through invisible/hidden text, making the text temporarily visible until point moves past that hidden part. When a search match is selected, the surrounding text remains visible. You can temporarily disable searching of hidden text by typing @bkbd{M-s i} while in an incremental search. This key sequence toggles that setting and makes searches look at only visible text (or the reverse when invoked again). The setting lasts only through the current interactive search. @node Button Colors, , Invisible Text Searches, Customization @subsection Configuring Button Colors @cindex Emacs support @cindex button highlighting @cindex highlighting buttons @cindex button flashing @cindex flashing buttons @vindex file, hui-ep*.el @vindex file, hsettings.el @findex hproperty:cycle-but-color When Hyperbole is run under a window system, 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 @file{hui-*-b*.el} files for lists of potential colors and the code which supports this behavior. A call to @code{(hproperty:cycle-but-color)} in the @file{hsettings.el} file changes the color used to highlight and flash explicit buttons. @vindex hproperty:but-highlight-flag Whether or not buttons are highlighted is controlled by @code{hproperty:but-highlight-flag}, which defaults to @samp{t}. To disable highlighting, change this setting in @file{hsettings.el} or use Hyperbole menu item, Cust/All-Options, and select the Hyperbole Buttons group to edit its options. @findex hproperty:but-create If you read in a file with explicit buttons before you load Hyperbole, these buttons won't be highlighted. Load Hyperbole and then use @bkbd{M-x hproperty:but-create @key{RET}} to highlight the buttons in the current buffer. @cindex button emphasis @vindex hproperty:but-emphasize-flag Additionally, if @code{hproperty:but-emphasize-flag} is set to @samp{t}, then whenever the mouse pointer moves over an explicit button, it will be emphasized in a different color or style. This emphasis is in addition to any non-mouse-sensitive button highlighting. @node Global Key Bindings, Koutliner Keys, Setup, Top @appendix Global Key Bindings @noindent @cindex key binding list This appendix summarizes all of Hyperbole's global key bindings and whether each overrides any existing binding or not. It also describes how to temporarily disable these bindings and how to manage whether Hyperbole overrides local, mode-specific key bindings that hide global Hyperbole keys. These bindings can be viewed and edited from either the Cust/KeyBindings minibuffer menu or from the Hyperbole menubar menu as shown here: @float Image,image:Change-Key-Bindings @caption{Global Key Bindings Menu} @image{im/menu-key-bindings,6in,,Change Key Bindings} @end float @sp 1 @noindent Below are descriptions of Hyperbole's default keyboard key bindings: @table @asis @cindex key binding, M-@key{RET} @kitem M-@key{RET} Action Key: Invoke the Action Key in the present context. @kitem C-u M-@key{RET} Assist Key: Invoke the Assist Key in the present context. @cindex key binding, C-c \ @kitem C-c @backslashchar{} HyControl: Control windows, frames and buffer display. This binding is made only if the key is not bound prior to loading Hyperbole. @kindex C-c / @kindex C-h h f w @cindex menu, Find/Web @cindex menu, Web @cindex searching the web @cindex web search menu @kitem C-c / Search the Web: Display a minibuffer menu of web search engines. Once an engine is selected, prompt for a search term and perform the associated search. This binding is made only if the key is not bound prior to loading Hyperbole; otherwise, the Find/Web minibuffer menu item, @bkbd{C-h h f w}, will do the same thing. @kindex C-c @@ @cindex key binding, C-c @@ @cindex windows grid @cindex grid of windows @kitem C-c @@ Display a grid of windows in the selected frame, sized according to the prefix argument. The left digit of the argument is the number of grid rows and the right digit is the number of grid columns. The argument is prompted for if not given. This binding is made only if the key is not bound prior to loading Hyperbole. For further details, see the @bkbd{@@} key binding description in @ref{HyControl}. @cindex key binding, C-c C-r @kitem C-c C-r Button Rename: Rename an explicit button. This binding is made only if the key is not bound prior to loading Hyperbole. @cindex key binding, M-o @kitem M-o Drag Operation: Keyboard emulation of the start and stop of mouse drags to invoke Smart Key actions. This binding is made only if the key is not bound prior to loading Hyperbole and if Emacs is run under a window system. @cindex key binding, C-h h @kitem C-h h Hyperbole Mini Menu: Invoke the Hyperbole minibuffer menu, giving access to many Hyperbole commands. @cindex key binding, C-h A @cindex key binding, C-u C-h A @kitem C-h A Action Key Help: Show what the Action Key will do in the current context. @kitem C-u C-h A Assist Key Help: Show what the Assist Key will do in the same context. @cindex key binding, C-c @key{RET} @kitem C-c @key{RET} Mark Things: Mark larger and larger synctactical units in a buffer when invoked repeatedly, showing in the minibuffer the type of unit marked each time. For example, if on an opening brace at the start of a C, Java or Javascript function, this marks the whole function. This binding is made only if the key is not bound prior to loading Hyperbole. @cindex key binding, C-c . @kitem C-c . Delimited Thing Jump: Jump between the start and end of a delimited thing, which may be an HTML tag pair. This binding is made only if the key is not bound prior to loading Hyperbole. @xref{Smart Key Thing Selection}, for more information. @end table @vindex hkey-init @cindex disable global key bindings The variable, @code{hkey-init}, controls whether or not any Hyperbole global key bindings are made. It is set to @samp{t} (true) by default in @file{hyperbole.el}. This setting means all Hyperbole key bindings will be initialized when Hyperbole is loaded. If you want to disable these bindings permanently, simply add @code{(setq hkey-init nil)} to your @file{~/.emacs} file prior to the point at which you load Hyperbole and restart Emacs. Then you will have to choose the Hyperbole commands that you want to use and bind those to keys. @vindex file, .emacs @findex hyperbole-toggle-bindings @cindex change key bindings @cindex toggle key bindings @cindex key bindings, toggle @cindex disable Hyperbole @kindex C-c h If you ever have a need to temporarily disable the Hyperbole keyboard and mouse bindings, use the @code{hyperbole-toggle-bindings} command. It switches between the Hyperbole key bindings and those set prior to loading Hyperbole and then back again if invoked once more. There is no default key binding for this command; use @bkbd{M-x hyperbole-toggle-bindings @key{RET}}. Alternatively, you may select a key and bind it as part of any setting of @code{hyperbole-init-hook} within your personal @file{~/.emacs} file. For example, @code{(add-hook 'hyperbole-init-hook (lambda () (global-set-key "\C-ch" 'hyperbole-toggle-bindings)))}. @vindex file, .emacs @findex hmouse-toggle-bindings @cindex mouse key toggle @cindex Smart Mouse Key toggle @kindex C-c t If you want to restore only the mouse bindings that existed before Hyperbole was loaded, use the @code{hmouse-toggle-bindings} command. It switches between the Hyperbole mouse key bindings and those set prior to loading Hyperbole and then back again if invoked once more. There is no default key binding for this command; use @bkbd{M-x hmouse-toggle-bindings @key{RET}}. Alternatively, you may select a key and bind it as part of any setting of @code{hyperbole-init-hook} within your personal @file{~/.emacs} file. For example, @code{(add-hook 'hyperbole-init-hook (lambda () (global-set-key "\C-ct" 'hmouse-toggle-bindings)))}. @vindex hkey-init-override-local-keys @cindex overriding local keys @cindex disable local key override Major mode-specific keys take precedence over global key bindings. In some cases, a major mode will unknowingly override some of the global Hyperbole keys, preventing you from using them in that mode. By default, Hyperbole automatically prevents this by checking each time a major mode is invoked and unbinding any mode-specific keys that interfere with global Hyperbole keys. If you prefer that this not happen permanently, use @bkbd{M-x customize-variable @key{RET} hkey-init-override-local-keys @key{RET}}. Press the Toggle button to change the value to @code{nil}. Then press the ``Apply and Save'' button. @node Koutliner Keys, Smart Key Reference, Global Key Bindings, Top @appendix Koutliner Keys @cindex 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 @emph{cmd} is named @emph{kotl-mode:cmd}. @table @code @findex kfile:write @item kfile:write @bkbd{C-x C-w} Write the current outline to FILE. @findex klink:create @item klink:create @bkbd{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 @code{(kcell:ref-to-id)} for valid cell-ref formats. @findex kotl-mode:add-cell @item kotl-mode:add-cell @bkbd{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, @bkbd{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. @findex kotl-mode:add-child @item kotl-mode:add-child @bkbd{C-c a} Add a new cell to current kview as first child of current cell. @findex kotl-mode:add-parent @item kotl-mode:add-parent @bkbd{C-c p} Add a new cell to current kview as sibling of current cell's parent. @findex kotl-mode:append-cell @item kotl-mode:append-cell @bkbd{C-c +} Append the CONTENTS-CELL to APPEND-TO-CELL. If neither cell has a no-fill property and @code{kotl-mode:refill-flag} is enabled, then APPEND-TO-CELL is refilled. @findex kotl-mode:back-to-indentation @item kotl-mode:back-to-indentation @bkbd{M-m} Move point to the first non-read-only non-whitespace character on this line. @findex kotl-mode:backward-cell @item kotl-mode:backward-cell @bkbd{C-c C-b} Move to prefix ARGth prior cell (same level) within current view. Return number of cells left to move. @findex kotl-mode:backward-char @item kotl-mode:backward-char @bkbd{C-b} Move point backward ARG (or 1) characters and return point. @findex kotl-mode:backward-kill-word @item kotl-mode:backward-kill-word @bkbd{M-DEL} Kill up to prefix ARG (or 1) words preceding point within a single cell. @findex kotl-mode:backward-sentence @item kotl-mode:backward-sentence @bkbd{M-a} Move point backward ARG (or 1) sentences and return point. @findex kotl-mode:backward-word @item kotl-mode:backward-word @bkbd{M-b} Move point backward ARG (or 1) words and return point. @findex kotl-mode:beginning-of-buffer @item kotl-mode:beginning-of-buffer @bkbd{M-<} Move point to beginning of buffer and return point. @findex kotl-mode:beginning-of-cell @item kotl-mode:beginning-of-cell @bkbd{C-c ,} Move point to beginning of current or ARGth - 1 prior cell and return point. @findex kotl-mode:beginning-of-line @item kotl-mode:beginning-of-line @bkbd{C-a} Move point to beginning of current or ARGth - 1 line and return point. @findex kotl-mode:beginning-of-tree @item kotl-mode:beginning-of-tree @bkbd{C-c ^} Move point to the level 1 root of the current cell's tree. Leave point at the start of the cell. @findex kotl-mode:cell-help @item kotl-mode:cell-help @bkbd{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: @example 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). @end example @findex kotl-mode:cell-attributes @noindent See also the documentation for @code{kotl-mode:cell-attributes}. @findex kotl-mode:center-line @vindex fill-column @item kotl-mode:center-line @bkbd{M-s} Center the line point is on, within the width specified by @code{fill-column}. This means adjusting the indentation so that it equals the distance between the end of the text and @code{fill-column}. @findex kotl-mode:center-paragraph @item kotl-mode:center-paragraph @bkbd{M-S} Center each nonblank line in the paragraph at or after point. See @code{center-line} for more information. @findex kotl-mode:copy-after @item kotl-mode:copy-after @bkbd{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. @findex kotl-mode:copy-before @item kotl-mode:copy-before @bkbd{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. @findex kotl-mode:copy-to-buffer @item kotl-mode:copy-to-buffer @bkbd{C-c M-c} Copy outline tree rooted at CELL-REF to a non-koutline BUFFER. Use 0 to copy the whole outline buffer. @findex kotl-mode:copy-to-register @item kotl-mode:copy-to-register @bkbd{C-x x} Copy into REGISTER the region START to END. With optional prefix arg DELETE-FLAG, delete region. @findex kotl-mode:delete-backward-char @item kotl-mode:delete-backward-char @{@key{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. @findex kotl-mode:delete-blank-lines @item kotl-mode:delete-blank-lines @bkbd{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. @findex kotl-mode:delete-char @item kotl-mode:delete-char @bkbd{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. @findex kotl-mode:delete-indentation @item kotl-mode:delete-indentation @bkbd{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. @findex kotl-mode:demote-tree @item kotl-mode:demote-tree @{@key{TAB}@} Move current tree a maximum of prefix ARG levels lower in current view. Each cell is refilled iff its @emph{no-fill} attribute is nil and @code{kotl-mode:refill-flag} is non-nil. With prefix ARG = 0, cells are demoted up to one level and @code{kotl-mode:refill-flag} is treated as true. @findex kotl-mode:down-level @item kotl-mode:down-level @bkbd{C-c C-d} Move down prefix ARG levels lower within current tree. @findex kotl-mode:end-of-buffer @item kotl-mode:end-of-buffer @bkbd{M->} Move point to the end of buffer and return point. @findex kotl-mode:end-of-cell @item kotl-mode:end-of-cell @bkbd{C-c .} Move point to end of current or ARGth - 1 succeeding cell and return point. @findex kotl-mode:end-of-line @item kotl-mode:end-of-line @bkbd{C-e} Move point to end of current or ARGth - 1 line and return point. @findex kotl-mode:end-of-tree @item kotl-mode:end-of-tree @bkbd{C-c $} Move point to the last cell in tree rooted at the current cell. Leave point at the start of the cell. @findex kotl-mode:example @item kotl-mode:example Display the Koutliner example file for demonstration use by a user. @findex kotl-mode:exchange-cells @item kotl-mode:exchange-cells @bkbd{C-c e} Exchange CELL-REF-1 with CELL-REF-2 in current view. Don't move point. @findex kotl-mode:fill-cell @item kotl-mode:fill-cell @bkbd{C-c M-j} Fill current cell if it lacks the @emph{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. @findex kotl-mode:fill-paragraph @item kotl-mode:fill-paragraph @bkbd{C-x f} Fill current paragraph within cell. With optional JUSTIFY, justify paragraph as well. Ignore any non-nil @emph{no-fill} attribute attached to the cell. @findex kotl-mode:fill-tree @item kotl-mode:fill-tree @bkbd{C-M-j} Refill each cell within the tree whose root is at point. @findex kotl-mode:first-sibling @item kotl-mode:first-sibling @bkbd{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. @findex kotl-mode:fkey-backward-char @item kotl-mode:fkey-backward-char @bkbd{C-b} or @bkbd{left} Move point backward ARG (or 1) characters and return point. @findex kotl-mode:fkey-forward-char @item kotl-mode:fkey-forward-char @bkbd{C-f} or @bkbd{right} Move point forward ARG (or 1) characters and return point. @findex kotl-mode:fkey-next-line @item kotl-mode:fkey-next-line @bkbd{C-n} or @bkbd{down} Move point to ARGth next line and return point. @findex kotl-mode:fkey-previous-line @item kotl-mode:fkey-previous-line @bkbd{C-p} or @bkbd{up} Move point to ARGth previous line and return point. @findex kotl-mode:forward-cell @item kotl-mode:forward-cell @bkbd{C-c C-f} Move to the prefix ARG following cell (same level) within current view. Return number of cells left to move. @findex kotl-mode:forward-char @item kotl-mode:forward-char @bkbd{C-f} Move point forward ARG (or 1) characters and return point. @findex kotl-mode:forward-para @item kotl-mode:forward-para @bkbd{M-n} Move to prefix ARGth next cell (any level) within current view. @findex kotl-mode:forward-paragraph @item kotl-mode:forward-paragraph @bkbd{M-]} Move to prefix ARG next cell (any level) within current view. @findex kotl-mode:forward-sentence @item kotl-mode:forward-sentence @bkbd{M-e} Move point forward ARG (or 1) sentences and return point. @findex kotl-mode:forward-word @item kotl-mode:forward-word @bkbd{M-f} Move point forward ARG (or 1) words and return point. @findex kotl-mode:goto-cell @item kotl-mode:goto-cell @bkbd{C-c g} Move point to start of cell given by CELL-REF. (See the documentation for @code{(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. @findex kotl-mode:hide-sublevels @item kotl-mode:hide-sublevels @bkbd{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. @findex kotl-mode:hide-subtree @item kotl-mode:hide-subtree @bkbd{C-M-h} Hide subtree, ignoring root, at optional CELL-REF (defaults to cell at point). @findex kotl-mode:hide-tree @item kotl-mode:hide-tree @bkbd{C-c BS} Collapse tree rooted at optional CELL-REF (defaults to cell at point). @findex kotl-mode:indent-line @item kotl-mode:indent-line @{@key{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. @findex kotl-mode:indent-region @item kotl-mode:indent-region @bkbd{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. @findex kimport:insert-file @item kimport:insert-file @bkbd{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 filename (filename completion is provided). @findex kimport:insert-register @item kimport:insert-register @bkbd{C-x r i} Insert contents of REGISTER at point in current cell. REGISTER is a character naming the register to insert. Normally puts point before and mark after the inserted text. If optional second arg is non-nil, puts mark before and point after. Interactively, second arg is non-nil if prefix arg is supplied. @findex kotl-mode:just-one-space @item kotl-mode:just-one-space @bkbd{M-\\} Delete all spaces and tabs around point and leave one space. @findex kotl-mode:kill-contents @item kotl-mode:kill-contents @bkbd{C-c k} Kill contents of cell from point to cell end. With prefix ARG, kill entire cell contents. @findex kotl-mode:kill-line @item kotl-mode:kill-line @bkbd{C-k} Kill ARG lines from point. @findex kotl-mode:kill-region @item kotl-mode:kill-region @bkbd{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. @findex kotl-mode:kill-ring-save @item kotl-mode:kill-ring-save @bkbd{M-w} Copy region between START and END within a single kcell to kill ring. @findex kotl-mode:kill-sentence @item kotl-mode:kill-sentence @bkbd{M-k} Kill up to prefix ARG (or 1) sentences following point within a single cell. @findex kotl-mode:kill-tree @item kotl-mode:kill-tree @bkbd{C-c C-k} Kill ARG following trees starting with tree rooted at point. If ARG is a non-positive number, nothing is done. @findex kotl-mode:kill-word @item kotl-mode:kill-word @bkbd{M-d} Kill up to prefix ARG words following point within a single cell. @findex kotl-mode:last-sibling @item kotl-mode:last-sibling @bkbd{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. @findex kotl-mode:mail-tree @item kotl-mode:mail-tree @bkbd{C-c @@} Mail outline tree rooted at CELL-REF. Use "0" for whole outline buffer. @findex kotl-mode:move-after @item kotl-mode:move-after @bkbd{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. @findex kotl-mode:move-before @item kotl-mode:move-before @bkbd{C-c @key{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. @findex kotl-mode:newline @item kotl-mode:newline @{@key{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. @findex kotl-mode:next-cell @item kotl-mode:next-cell @bkbd{C-c C-n} Move to prefix ARG next cell (any level) within current view. @findex kotl-mode:next-line @item kotl-mode:next-line @bkbd{C-n} Move point to ARGth next line and return point. @findex kotl-mode:open-line @item kotl-mode:open-line @bkbd{C-o} Insert a newline and leave point before it. With arg N, insert N newlines. @findex kotl-mode:overview @item kotl-mode:overview @bkbd{C-c C-o} Show only the first line of each cell in the current outline. With a prefix arg, also toggle the display of blank lines between cells. @findex kotl-mode:previous-cell @item kotl-mode:previous-cell @bkbd{C-c C-p} Move to prefix ARG previous cell (any level) within current view. @findex kotl-mode:previous-line @item kotl-mode:previous-line @bkbd{C-p} Move point to ARGth previous line and return point. @findex kotl-mode:promote-tree @item kotl-mode:promote-tree @bkbd{M-@key{TAB}} or @bkbd{@key{SHIFT}-@key{TAB}} Move current tree a maximum of prefix ARG levels higher in current view. Each cell is refilled iff its @emph{no-fill} attribute is nil and @code{kotl-mode:refill-flag} is non-nil. With prefix ARG = 0, cells are promoted up to one level and @code{kotl-mode:refill-flag} is treated as true. @findex kotl-mode:scroll-down @item kotl-mode:scroll-down @bkbd{M-v} Scroll text of current window downward ARG lines; or a windowful if no ARG. @findex kotl-mode:scroll-up @item kotl-mode:scroll-up @bkbd{C-v} Scroll text of current window upward ARG lines; or a windowful if no ARG. @findex kotl-mode:set-cell-attribute @item kotl-mode:set-cell-attribute @bkbd{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. @findex kotl-mode:set-fill-prefix @item kotl-mode:set-fill-prefix @bkbd{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. @findex kotl-mode:show-all @item kotl-mode:show-all @bkbd{C-c C-a} Show (expand) all cells in current view. With a prefix arg, also toggle the display of blank lines between cells. @findex kotl-mode:show-subtree @item kotl-mode:show-subtree Show subtree, ignoring root, at optional CELL-REF (defaults to cell at point). @findex kotl-mode:show-tree @item kotl-mode:show-tree @bkbd{C-c C-s} Display fully expanded tree rooted at CELL-REF. @findex kotl-mode:split-cell @item kotl-mode:split-cell @bkbd{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, @bkbd{C-u}, new cell is added as child of current cell. @findex kotl-mode:top-cells @item kotl-mode:top-cells @bkbd{C-c C-t} Collapse all level 1 cells in view and hide any deeper sublevels. With a prefix arg, also toggle the display of blank lines between cells. @findex kotl-mode:transpose-cells @item kotl-mode:transpose-cells @bkbd{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. @findex kotl-mode:transpose-chars @item kotl-mode:transpose-chars @bkbd{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. @findex kotl-mode:transpose-lines @item kotl-mode:transpose-lines @bkbd{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. @findex kotl-mode:transpose-words @item kotl-mode:transpose-words @bkbd{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. @findex kotl-mode:up-level @item kotl-mode:up-level @bkbd{C-c C-u} Move up prefix ARG levels higher in current outline view. @findex kotl-mode:yank @item kotl-mode:yank @bkbd{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, @code{(kotl-mode:yank-pop)}. @findex kotl-mode:yank-pop @item kotl-mode:yank-pop @bkbd{M-y} Replace just-yanked stretch of killed text with a different stretch. This command is allowed only immediately after a @code{(yank)} or a @code{(yank-pop)}. At such a time, the region contains a stretch of reinserted previously-killed text. @code{(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. @findex kotl-mode:zap-to-char @item kotl-mode:zap-to-char @bkbd{M-z} Kill up to and including prefix ARGth occurrence of CHAR. Goes backward if ARG is negative; error if CHAR not found. @findex kview:set-label-separator @item kview:set-label-separator @bkbd{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. @findex kview:set-label-type @item kview:set-label-type @bkbd{C-c C-l} Change kview's label display type to NEW-TYPE, updating all displayed labels. See documentation for the @code{kview:default-label-type} variable, for valid values of NEW-TYPE. @findex kvspec:activate @item kvspec:activate @bkbd{C-c C-v} Activate optional VIEW-SPEC or existing view specification over the current koutline. VIEW-SPEC must be a string. See @samp{<@code{$@{hyperb:dir@}}/kotl/EXAMPLE.kotl, 2b17=048>} for details on valid view specs. @findex kvspec:toggle-blank-lines @item kvspec:toggle-blank-lines @bkbd{C-c b} Toggle blank lines between cells on or off. @end table @node Smart Key Reference, Suggestion or Bug Reporting, Koutliner Keys, Top @appendix Smart Key Reference This appendix documents Hyperbole's context-sensitive Smart Key operations. It is quite extensive and is meant for reference rather than sequential reading. @xref{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. What a Smart Key does depends on the context in which it is used. Smart Key operations are context-sensitive. Contexts are defined by logic conditionals, e.g.@: when depressed here, if this is true, etc. Each Smart Key context is listed in the order in which it will be checked. The first matching context is always the one applied. Within each context, the actions performed by the Action and Assist Keys are given. @menu * Smart Mouse Keys:: * Smart Keyboard Keys:: @end menu @node Smart Mouse Keys, Smart Keyboard Keys, Smart Key Reference, Smart Key Reference @section Smart Mouse Keys @cindex Smart Mouse Keys The contexts and actions in this section, like drags and modeline clicks, apply only if you have mouse support within Hyperbole. The Smart Key operations in @ref{Smart Keyboard Keys}, apply to both mouse and keyboard Smart Key usage. The following section documents what the Smart Mouse Keys do in each context, with the contexts listed in decreasing order of priority, i.e. the first context to match is the one that is used. If no matching mouse key context is found, then the keyboard key contexts are searched in order. @menu * Minibuffer Menu Activation:: * Thing Selection:: * Side-by-Side Window Resizing:: * Modeline Clicks and Drags:: * Smart Mouse Drags between Windows:: * Smart Mouse Drags within a Window:: * Smart Mouse Drags outside a Window:: @end menu @node Minibuffer Menu Activation, Thing Selection, Smart Mouse Keys, Smart Mouse Keys @subsection Minibuffer Menu Activation @cindex menu, top-level @cindex minibuffer menu @cindex buffer menu @cindex minibuffer, buffer menu @cindex minibuffer, default actions @cindex jump menu @cindex minibuffer, jump menu @cindex inactive minibuffer @vindex action-key-minibuffer-function @vindex assist-key-minibuffer-function @format @group When clicked within an inactive minibuffer: ACTION KEY The Hyperbole minibuffer menu is displayed for selection, by default. The variable @code{action-key-minibuffer-function} controls this behavior. ASSIST KEY The buffer, window and frame jump menu is displayed for selection, by default. You can jump to buffers categorized by major mode, jump to windows by buffer name, or to frames by name. Manage your windows and frames quickly with this menu as well. This is the same menu that a click in a blank area of the modeline displays by default since they are typically so close together. The variable @code{assist-key-minibuffer-function} controls this behavior. @end group @end format @node Thing Selection, Side-by-Side Window Resizing, Minibuffer Menu Activation, Smart Mouse Keys @subsection Thing Selection @cindex thing @cindex list @cindex comment @cindex string @cindex array @cindex vector @cindex set @cindex function @cindex markup pair @format @group In a programming or markup language buffer, when pressed/clicked at the start or end of a delimited thing (including lists, comments, strings, arrays/vectors, sets, functions and markup pair tags in a markup language), and not at the end of a line: ACTION KEY Marks the thing for editing. ASSIST KEY Marks and kills the thing for yanking elsewhere. @end group @end format @noindent Note that the press must be on the first character of the delimiter of the thing. @cindex Smart Mouse Key @cindex Action Mouse Key @cindex Assist Mouse Key @cindex drag @cindex copy and yank @cindex kill and yank @cindex yanking @cindex pasting a region There are also @emph{drag} actions that work on delimited things. Delimited things include parenthesized lists, single and double quoted strings, bracketed arrays/vectors, sets with braces, programming language functions and markup pair tags (e.g.
in HTML). If no region is selected when the Action Mouse Key is dragged from a thing delimiter to another location, it copies the delimited thing to the release point of the drag. The release location may be in the same or a different buffer but if in the same buffer it must be outside of the delimited thing itself. Similarly, the Assist Mouse Key kills (cuts) the delimited thing at its original location and yanks (pastes) it at the new location. The start of the drag must be on the first character of the starting or ending delimiter. For strings and comments, the drag must start on the first line of the thing. Experiment with these drag actions and you will quickly find them easy to use and indispensable. @node Side-by-Side Window Resizing, Modeline Clicks and Drags, Thing Selection, Smart Mouse Keys @subsection Side-by-Side Window Resizing @cindex drag, side edge @cindex side drag @format @group 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. @end group @end format @node Modeline Clicks and Drags, Smart Mouse Drags between Windows, Side-by-Side Window Resizing, Smart Mouse Keys @subsection Modeline Clicks and Drags @cindex depress, modeline @cindex modeline depress @vindex action-key-modeline-function @vindex assist-key-modeline-function @format @group If depressed within a window modeline: ACTION KEY (1) clicked on the first blank character 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 on the buffer id of a window's modeline, dired is run on the current directory, replacing the window's buffer; successive clicks walk up the directory tree (4) clicked anywhere within the middle of a window's modeline, the function given by @code{action-key-modeline-function} is called; (5) 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. (6) dragged other than straight vertically from a modeline to another window, duplicate the modeline's window buffer to the window of release. (7) dragged from a modeline to outside of Emacs, create a new frame sized to match the selected window with the same buffer. @end group @end format @format @group ASSIST KEY (1) clicked on the first blank character 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 on the buffer id of a window's modeline, the next buffer in sequence is displayed in the window (4) clicked anywhere within the middle of a window's modeline, the function given by @code{assist-key-modeline-function} is called; (5) 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. (6) dragged other than straight vertically from a modeline to another window, swap buffers in the two windows. (7) dragged from a modeline to outside of Emacs, create a new frame sized to match the selected window with the same buffer. If there is only one window in the source frame or if @code{hycontrol-keep-window-flag} is non-nil, leave the original window and just clone it into the new frame;otherwise, delete the original window. @end group @end format @format @group If dragged from a window and released within a window modeline: ACTION KEY (1) If depress was on a buffer name in Buffer-menu/ibuffer mode or on a file/directory in dired mode, splits the release window and displays the item in the original release window. (2) Otherwise, splits the release window and displays the depress window's buffer in the original release window. ASSIST KEY Swaps buffers in the two windows. @end group @end format @node Smart Mouse Drags between Windows, Smart Mouse Drags within a Window, Modeline Clicks and Drags, Smart Mouse Keys @subsection Smart Mouse Drags between Windows @cindex active region @cindex copy and yank @cindex kill and yank @cindex yanking @cindex pasting a region @format @group If an active (highlighted) region exists within the editor: ACTION KEY Copies and yanks (pastes) the region to the release point in a different window. ASSIST KEY Kills (cuts) and yanks (pastes) the region to the release point in a different window. @end group @end format @format @group Otherwise, if dragged from inside one window to another: ACTION KEY (1) If depress was on a buffer name in Buffer-menu/ibuffer mode or on a file/directory in dired mode, displays the item in window of release. See @code{hmouse-drag-item-mode-forms} for how to allow for draggable items in other modes. (2) Otherwise, 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 Swap buffers in the two windows. @end group @end format @node Smart Mouse Drags within a Window, Smart Mouse Drags outside a Window, Smart Mouse Drags between Windows, Smart Mouse Keys @subsection Smart Mouse Drags within a Window @cindex active region @cindex region, active @cindex drag, with region @format @group If a region is active and a drag occurs within a single buffer/window: ACTION KEY Restores region to before Action Key drag and signals an error. ASSIST KEY Restores region to before Action Key drag and signals an error. @end group @end format @cindex drag, horizontal @cindex horizontal drag @vindex hmouse-x-drag-sensitivity @format @group (Note that @code{hmouse-x-drag-sensitivity} sets the minimal horizontal movement which registers a drag). If dragged horizontally within a single window from anywhere but a thing delimiter: ACTION KEY Splits the current window, adding a window below. ASSIST KEY Deletes the current window if it is not the sole window in the current frame. @end group @end format @cindex drag, vertical @cindex vertical drag @vindex hmouse-y-drag-sensitivity @format @group (Note that @code{hmouse-y-drag-sensitivity} sets the minimal vertical movement which registers a drag). If dragged vertically within a single window from anywhere but a thing delimiter: ACTION KEY Splits the current window, adding a window to the right. ASSIST KEY Deletes the current window if it is not the sole window in the current frame. @end group @end format @cindex drag, diagonal @cindex diagonal drag @vindex hmouse-x-diagonal-sensitivity @vindex hmouse-y-diagonal-sensitivity @format @group If dragged diagonally within a single window while depressed (`hmouse-x-diagonal-sensitivity' and `hmouse-y-diagonal-sensitivity' set the minimal diagonal movements which register a drag): ACTION KEY Saves the window configuration for the selected frame onto a ring of window configurations. ASSIST KEY Restores the prior window configuration from the ring. A prefix argument N specifies the Nth prior configuration from the ring. @end group @end format @node Smart Mouse Drags outside a Window, , Smart Mouse Drags within a Window, Smart Mouse Keys @subsection Smart Mouse Drags outside a Window @vindex hmouse-drag-item-mode-forms @vindex hycontrol-keep-window-flag @cindex dragging items @cindex dragging outside Emacs @cindex window, clone @cindex clone window @cindex window, move @cindex move window @format @group If dragged from an Emacs window to outside of Emacs: ACTION KEY (1) If depress was on a buffer name in Buffer-menu/ibuffer mode or on a file/directory in dired mode, display the item in a new frame. See @code{hmouse-drag-item-mode-forms} for how to allow for draggable items in other modes. (2) If depress was anywhere else, create a new frame sized to match the selected window with the same buffer. ASSIST KEY Create a new frame sized to match the selected window with the same buffer. If there is only one window in the source frame or if @code{hycontrol-keep-window-flag} is non-nil, leave the original window and just clone it into the new frame; otherwise, delete the original window. @end group @end format @node Smart Keyboard Keys, , Smart Mouse Keys, Smart Key Reference @section Smart Keyboard Keys @menu * Smart Key - Company Mode:: * Smart Key - Treemacs:: * Smart Key - Emacs Pushbuttons:: * Smart Key - Argument Completion:: * Smart Key - ID Edit Mode:: * Smart Key - Emacs Cross-references (Xrefs):: * Smart Key - Smart Scrolling:: * Smart Key - Smart Menus:: * Smart Key - Dired Mode:: * Smart Key - Hyperbole Buttons:: * Smart Key - View Mode:: * Smart Key - Delimited Things:: * Smart Key - The Koutliner:: * Smart Key - RDB Mode:: * Smart Key - Help Buffers:: * Smart Key - Pages Directory Mode:: * Smart Key - Python Source Code:: * Smart Key - Identifier Menu Mode :: * Smart Key - C Source Code:: * Smart Key - C++ Source Code:: * Smart Key - Assembly Source Code:: * Smart Key - Lisp Source Code:: * Smart Key - Java Source Code:: * Smart Key - JavaScript Source Code:: * Smart Key - Objective-C Source Code:: * Smart Key - Fortran Source Code:: * Smart Key - Occurrence Matches:: * Smart Key - Calendar Mode:: * Smart Key - Man Page Apropos:: * Smart Key - Emacs Outline Mode:: * Smart Key - Info Manuals:: * Smart Key - Email Composers:: * Smart Key - GNUS Newsreader:: * Smart Key - Buffer Menus:: * Smart Key - Tar File Mode:: * Smart Key - Man Pages:: * Smart Key - WWW URLs:: * Smart Key - HyRolo Match Buffers:: * Smart Key - Image Thumbnails:: * Smart Key - Gomoku Game:: * Smart Key - The OO-Browser:: * Smart Key - Default Context:: @end menu @node Smart Key - Company Mode, Smart Key - Treemacs, Smart Keyboard Keys, Smart Keyboard Keys @subsection Smart Key - Company Mode @cindex company-mode @cindex completion Company mode is an extensive in-buffer completion framework, often used to complete programming identifiers. @format @group When company-mode is active: ACTION KEY Displays selected item's definition. ASSIST KEY Displays the documentation, if any, for the selected item. @end group @end format @node Smart Key - Treemacs, Smart Key - Emacs Pushbuttons, Smart Key - Company Mode, Smart Keyboard Keys @subsection Smart Key - Treemacs @cindex Treemacs Treemacs is an add-on Emacs package that offers a fixed, per-frame, graphical window for hierarchically browsing and operating upon directories, files and programming tags within files. Use the Emacs package manager to install it and then invoke it with @bkbd{M-x treemacs @key{RET}} and quit with @bkbd{q}. @noindent Treemacs items may be dragged with the Action Key to other windows for display. @xref{Displaying File and Buffer Items}. @format @group When in a Treemacs file browser buffer: ACTION KEY or ASSIST KEY (1) on an entry icon, the treemacs TAB command is run to expand and collapse the entry; (2) elsewhere within an entry line, the item is displayed for editing, normally in another window; (3) at the end of an entry line: if an Action Key press, invokes @code{action-key-eol-function}, typically to scroll up proportionally; if an Assist Key press, invokes @code{assist-key-eol-function}, typically to scroll down proportionally; (4) on the first line of the buffer (other than the end of line), dired is run on the current directory of this Treemacs; (5) at the end of the first or last line of the buffer, this Treemacs invocation is quit. @end group @end format @node Smart Key - Emacs Pushbuttons, Smart Key - Argument Completion, Smart Key - Treemacs, Smart Keyboard Keys @subsection Smart Key - Emacs Pushbuttons @format @group When over an Emacs pushbutton: ACTION KEY Performs the button action ASSIST KEY Displays the help text for the button, if any. @end group @end format @node Smart Key - Argument Completion, Smart Key - ID Edit Mode, Smart Key - Emacs Pushbuttons, Smart Keyboard Keys @subsection Smart Key - Argument Completion @cindex Smart Keyboard Keys @format @group When prompting for a Hyperbole argument, a press in the minibuffer: ACTION KEY Accepts the current minibuffer argument. ASSIST KEY Offers completions for the current minibuffer argument. @end group @end format @cindex completion @format @group 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. @end group @end format @node Smart Key - ID Edit Mode, Smart Key - Emacs Cross-references (Xrefs), Smart Key - Argument Completion, Smart Keyboard Keys @subsection Smart Key - ID Edit Mode @format @group If in ID Edit mode (a package within InfoDock, not included in Hyperbole, that supports rapid marking, killing, copying, yanking and display-management): ACTION KEY or ASSIST KEY Yanks (pastes) last selected region at point. @end group @end format @node Smart Key - Emacs Cross-references (Xrefs), Smart Key - Smart Scrolling, Smart Key - ID Edit Mode, Smart Keyboard Keys @subsection Smart Key - Emacs Cross-references (Xrefs) @format @group When over an Emacs cross-reference: ACTION KEY Follows the cross-reference to its source definition in another window. ASSIST KEY Displays the cross-reference definition in another window but stays in the current window. @end group @end format @node Smart Key - Smart Scrolling, Smart Key - Smart Menus, Smart Key - Emacs Cross-references (Xrefs), Smart Keyboard Keys @subsection Smart Key - Smart Scrolling @vindex smart-scroll-proportional @cindex proportional scrolling @cindex scrolling @cindex click, end of line @cindex end of line click @vindex action-key-eol-function @vindex assist-key-eol-function @format @group When pressed at the end of a line but not the end of a buffer: ACTION KEY Calls the function given by @code{action-key-eol-function} whose default value is @code{smart-scroll-up}. This scrolls up according to the value of @code{smart-scroll-proportional}. If @code{smart-scroll-proportional} is nil or if point is on the top window line, it scrolls up (forward) a windowful. Otherwise, it tries to bring the current line to the top of the window, leaving point at the end of the line and returning t if scrolled, nil if not. @end group @end format @format @group ASSIST KEY Calls the function given by @code{assist-key-eol-function} whose default value is @code{smart-scroll-down}. This scrolls down according to the value of @code{smart-scroll-proportional}. If @code{smart-scroll-proportional} is nil or if point is on the bottom window line, it scrolls down (backward) a windowful. Otherwise, it tries to bring the current line to the bottom of the window, leaving point at the end of the line and returning t if scrolled, nil if not. @end group @end format @node Smart Key - Smart Menus, Smart Key - Dired Mode, Smart Key - Smart Scrolling, Smart Keyboard Keys @subsection Smart Key - Smart Menus Smart Menus are an older in-buffer menu system that worked on dumb terminals and pre-dated Emacs' own dumb terminal menu support. They are included with InfoDock (which is no longer maintained) and are not available separately. They are not a part of Hyperbole and are not necesary for its use. @format @group When pressed on a Smart Menu item (this is an older in-buffer menu system that pre-dates Emacs' own menus): ACTION KEY Activates the item. ASSIST KEY Displays help for the item. @end group @end format @vindex hkey-always-display-menu @cindex Smart Menu @format @group If the Smart Menu package (part of InfoDock) has been loaded and `hkey-always-display-menu' is non-nil: ACTION KEY or ASSIST KEY Pops up a window with a Smart Menu of commands. The menu displayed is selected by (smart-menu-choose-menu). @end group @end format @page @node Smart Key - Dired Mode, Smart Key - Hyperbole Buttons, Smart Key - Smart Menus, Smart Keyboard Keys @subsection Smart Key - Dired Mode @cindex click, dired @cindex drag, dired @cindex dired browsing @cindex DisplayHere mode @format @group If pressed within a dired-mode (directory editor) buffer: ACTION KEY (1) within an entry line, the selected file/directory is displayed for editing, normally in another window but if an entry has been dragged for display in another window, then this entry is displayed in the current window (DisplayHere minor mode is shown in the mode-line; use @bkbd{g} to disable it) (2) on the first line of the buffer: (a) within the leading whitespace, then if any deletes are to be performed, they are executed after user verification; otherwise, nothing is done; (b) otherwise, dired is run in another window on the ancestor directory of the current directory path up through the location of point; if point is before the first character, then the / root directory is used. (3) on or after the last line in the buffer or at the end of the first line, this dired invocation is quit. @end group @end format @format @group 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 or at the end of the first line, all delete marks on all entries are undone. @end group @end format @node Smart Key - Hyperbole Buttons, Smart Key - View Mode, Smart Key - Dired Mode, Smart Keyboard Keys @subsection Smart Key - Hyperbole Buttons @cindex click, button @cindex button click @format @group When pressed on a Hyperbole button: ACTION KEY Activates the button. ASSIST KEY Displays help for the button, typically a summary of its attributes. @end group @end format @node Smart Key - View Mode, Smart Key - Delimited Things, Smart Key - Hyperbole Buttons, Smart Keyboard Keys @subsection Smart Key - View Mode @cindex view mode @format @group 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. @end group @end format @page @node Smart Key - Delimited Things, Smart Key - The Koutliner, Smart Key - View Mode, Smart Keyboard Keys @subsection Smart Key - Delimited Things @cindex thing @cindex list @cindex comment @cindex string @cindex array @cindex vector @cindex set @cindex function @cindex markup pair @format @group In a programming or markup language buffer, when pressed/clicked at the start or end of a delimited thing (including lists, comments, strings, arrays/vectors, sets, functions and markup pair tags in a markup language), and not at the end of a line: ACTION KEY Marks the thing for editing. ASSIST KEY Marks and kills the thing for yanking elsewhere. Note that the press must be on the first character of the delimiter of the thing. @cindex Smart Mouse Key @cindex Action Mouse Key @cindex Assist Mouse Key @cindex drag @cindex copy and yank @cindex kill and yank @cindex yanking @cindex pasting a region There are also drag actions that work on delimited things. If no region is selected, when the Action Mouse Key is dragged from a thing delimiter to another location, it copies the thing and yanks it at the new location. Similarly, the Assist Mouse Key kills the thing at its original location and yanks it at the new location. @end group @end format @node Smart Key - The Koutliner, Smart Key - RDB Mode, Smart Key - Delimited Things, Smart Keyboard Keys @subsection Smart Key - The Koutliner @format @group 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. @end group @end format @format @group 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. @end group @end format @page @node Smart Key - RDB Mode, Smart Key - Help Buffers, Smart Key - The Koutliner, Smart Keyboard Keys @subsection Smart Key - RDB Mode @cindex rdb-mode @cindex database @format @group If pressed within an rdb-mode buffer which manipulates in-memory, relational databases (part of InfoDock): ACTION KEY (1) on the name of a relation, the relation's full table is shown; (2) on an attribute name, all attribute columns aside from this one are removed from the relation display; (3) to the left of a tuple (row), the tuple is removed from the display; (4) on an attribute value, all tuples (rows) which do not contain the selected attribute value are removed from the current table display; (5) on or after the last line in the buffer, the current database is redisplayed; (6) anywhere else (except the end of a line), the last command is undone." @end group @end format @format @group ASSIST KEY (1) on the name of a relation, the relation is removed from the display; (2) on an attribute name, the attribute column is removed from the relation display; (3) to the left of a tuple (row), the tuple is removed from the display; (4) on an attribute value, all tuples with the same attribute value are removed from the display." @end group @end format @node Smart Key - Help Buffers, Smart Key - Pages Directory Mode, Smart Key - RDB Mode, Smart Keyboard Keys @subsection Smart Key - Help Buffers @cindex help buffer @format @group When pressed at the end of a Help buffer: ACTION KEY or ASSIST KEY Restores the window configuration prior to the help display. @end group @end format @node Smart Key - Pages Directory Mode, Smart Key - Python Source Code, Smart Key - Help Buffers, Smart Keyboard Keys @subsection Smart Key - Pages Directory Mode @format @group Pages-directory-mode is used in special buffers that contain title lines extracted from files consisting of titled, page-delimited contents, e.g. Info files. @noindent When pressed on a pages-directory-mode entry line: ACTION KEY Jumps to the associated line in the pages file that contains the entry. ASSIST KEY Jumps to the associated line in the pages file that contains the entry. @end group @end format @page @node Smart Key - Python Source Code, Smart Key - Identifier Menu Mode , Smart Key - Pages Directory Mode, Smart Keyboard Keys @subsection Smart Key - Python Source Code @format @group When the Jedi identifier server or the OO-Browser has been loaded and the press is within a Python buffer: ACTION KEY or ASSIST KEY Jumps to the definition of the selected Python construct: (1) on an `import' line, the referent is displayed; (2) within a method declaration, its definition is displayed; (3) on a class name, the class definition is shown; (4) on a unique identifier reference, its definition is shown (when possible). @end group @end format @format @group When pressed within a Python source code file (without the OO-Browser): ACTION KEY Jumps to the definition of the selected Python identifier, assuming the identifier is found within an "etags" generated tags file within the current directory or any of its ancestor directories. ASSIST KEY Jumps to the next tag matching an identifier at point. @end group @end format @node Smart Key - Identifier Menu Mode , Smart Key - C Source Code, Smart Key - Python Source Code, Smart Keyboard Keys @subsection Smart Key - Identifier Menu Mode @format @group This works only for identifiers defined within the same source file in which they are referenced. It requires either Emacs' imenu library and it requires that an index of identifiers has been built for the current buffer. Other handlers handle identifier references and definitions across multiple files. @noindent When pressed on an identifier name after an identifier index has been generated: ACTION KEY Jumps to the source definition within the current buffer of the identifier at point. ASSIST KEY Prompts with completion for an identifier defined within the buffer and then jumps to the its source definition. @end group @end format @page @node Smart Key - C Source Code, Smart Key - C++ Source Code, Smart Key - Identifier Menu Mode , Smart Keyboard Keys @subsection Smart Key - C Source Code @vindex smart-c-cpp-include-path @vindex smart-c-include-path @vindex smart-c-use-lib-man @format @group When pressed within a C source code file: ACTION KEY Jumps to the definition of a selected C construct: (1) on a #include statement, the include file is displayed; this looks for include files using the directory lists `smart-c-cpp-include-path' and `smart-c-include-path'; (2) on a C identifier, the identifier definition is displayed, assuming the identifier is found within an "etags" generated tags file within the current directory or any of its ancestor directories; (3) if `smart-c-use-lib-man' is non-nil (see its documentation), the C identifier is recognized as a library symbol, and a man page is found for the identifier, then the man page is displayed. ASSIST KEY Jumps to the next tag matching an identifier at point. @end group @end format @node Smart Key - C++ Source Code, Smart Key - Assembly Source Code, Smart Key - C Source Code, Smart Keyboard Keys @subsection Smart Key - C++ Source Code @vindex c++-cpp-include-path @vindex c++-include-path @format @group When the OO-Browser has been loaded and the press is within a C++ buffer: ACTION KEY or ASSIST KEY Jumps to the definition of the selected C++ construct via OO-Browser support. (1) on a #include statement, the include file is displayed; this looks for include files using the directory lists `smart-c-cpp-include-path' and `smart-c-include-path'; (2) within a method definition before the opening brace, its declaration is displayed; (3) within a method declaration, its definition is displayed; (4) on a class name, the class definition is shown; (5) on a member reference (past any :: scoping operator), the member definition or a listing of possible definitions or a matching declaration (if no definitions exist within the Environment) is shown; (6) on a global variable or function identifier, its definition is shown. @end group @end format @page @format @group When pressed within a C++ source code file (without the OO-Browser): ACTION KEY Jumps to the definition of the selected C++ construct: (1) on a #include statement, the include file is displayed; this looks for include files using the directory lists `smart-c-cpp-include-path' and `smart-c-include-path'; (2) on a C++ identifier, the identifier definition is displayed, assuming the identifier is found within an "etags" generated tags file in the current directory or any of its ancestor directories; (3) if `smart-c-use-lib-man' is non-nil (see its documentation), the C++ identifier is recognized as a library symbol, and a man page is found for the identifier, then the man page is displayed. ASSIST KEY Jumps to the next tag matching an identifier at point. @end group @end format @node Smart Key - Assembly Source Code, Smart Key - Lisp Source Code, Smart Key - C++ Source Code, Smart Keyboard Keys @subsection Smart Key - Assembly Source Code @vindex smart-asm-include-path @format @group When pressed within an assembly source code file: ACTION KEY Jumps to the definition of the selected assembly construct: (1) on an include statement, the include file is displayed; this looks for include files using the directory list `smart-asm-include-path'; (2) on an identifier, the identifier definition is displayed, assuming the identifier is found within an "etags" generated tags file within the current directory or any of its ancestor directories. ASSIST KEY Jumps to the next tag matching an identifier at point. @end group @end format @node Smart Key - Lisp Source Code, Smart Key - Java Source Code, Smart Key - Assembly Source Code, Smart Keyboard Keys @subsection Smart Key - Lisp Source Code @format @group @cindex change-log-mode @cindex lisp identifier @cindex elisp identifier When pressed on a Lisp symbol within any of these types of buffers (Lisp code, debugger, compilation, or help) or in change-log-mode on an Emacs Lisp bound identifier: ACTION KEY Jumps to the definition of any selected Lisp construct. If on an Emacs Lisp require, load, or autoload clause and the (find-library) function is defined, jumps to the library source, if possible. ASSIST KEY Jumps to the next tag matching an identifier at point or if the identifier is an Emacs Lisp symbol, then this displays the documentation for the symbol. @end group @end format @node Smart Key - Java Source Code, Smart Key - JavaScript Source Code, Smart Key - Lisp Source Code, Smart Keyboard Keys @subsection Smart Key - Java Source Code @vindex smart-java-package-path @format @group When the OO-Browser has been loaded and the press is within a Java buffer: ACTION KEY or ASSIST KEY Jumps to the definition of the selected Java construct: (1) within a commented @@see cross-reference, the referent is displayed; (2) on a package or import statement, the referent is displayed; this looks for referent files using the directory list `smart-java-package-path'; (3) within a method declaration, its definition is displayed; (4) on a class name, the class definition is shown; (5) on a unique identifier reference, its definition is shown (when possible). @end group @end format @format @group When pressed within a Java source code file (without the OO-Browser): ACTION KEY Jumps to the definition of the selected Java construct: (1) within a commented @@see cross-reference, the referent is displayed; (2) on a package or import statement, the referent is displayed; this looks for referent files using the directory list `smart-java-package-path'; (3) on a Java identifier, the identifier definition is displayed, assuming the identifier is found within an "etags" generated tags file within the current directory or any of its ancestor directories. ASSIST KEY Jumps to the next tag matching an identifier at point. @end group @end format @node Smart Key - JavaScript Source Code, Smart Key - Objective-C Source Code, Smart Key - Java Source Code, Smart Keyboard Keys @subsection Smart Key - JavaScript Source Code @format @group When pressed within a JavaScript source code file: ACTION KEY Jumps to the definition of the selected JavaScript identifier, assuming the identifier is found within an "etags" generated tags file within the current directory or any of its ancestor directories. ASSIST KEY Jumps to the next tag matching an identifier at point. @end group @end format @node Smart Key - Objective-C Source Code, Smart Key - Fortran Source Code, Smart Key - JavaScript Source Code, Smart Keyboard Keys @subsection Smart Key - Objective-C Source Code @vindex objc-cpp-include-path @vindex objc-include-path @format @group When the OO-Browser has been loaded and the press is within a Objective-C buffer: ACTION KEY or ASSIST KEY Jumps to the definition of the selected Objective-C construct via OO-Browser support. (1) on a #import or #include statement, the include file is displayed; this looks for include files using the directory lists `objc-cpp-include-path' and `objc-include-path'; (2) within a method declaration, its definition is displayed; (3) on a class name, the class definition is shown; (4) on a member reference (past any :: scoping operator), the member definition or a listing of possible definitions is shown; (5) on a global variable or function identifier, its definition is shown. @end group @end format @format @group When pressed within an Objective-C source code file (without the OO-Browser): ACTION KEY Jumps to the definition of the selected Objective-C construct: (1) on a #import or #include statement, the include file is displayed; this looks for include files using the directory lists `objc-cpp-include-path' and `objc-include-path'; (2) on an Objective-C identifier, the identifier definition is displayed, assuming the identifier is found within an "etags" generated tags file in the current directory or any of its ancestor directories; (3) if `smart-c-use-lib-man' is non-nil (see its documentation), the Objective-C identifier is recognized as a library symbol, and a man page is found for the identifier, then the man page is displayed. ASSIST KEY Jumps to the next tag matching an identifier at point. @end group @end format @node Smart Key - Fortran Source Code, Smart Key - Occurrence Matches, Smart Key - Objective-C Source Code, Smart Keyboard Keys @subsection Smart Key - Fortran Source Code @format @group 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. @end group @end format @node Smart Key - Occurrence Matches, Smart Key - Calendar Mode, Smart Key - Fortran Source Code, Smart Keyboard Keys @subsection Smart Key - Occurrence Matches @format @group When pressed within an occur-mode, moccur-mode or amoccur-mode buffer: ACTION KEY or ASSIST KEY Jumps to the source buffer and line of the current occurrence. @end group @end format @node Smart Key - Calendar Mode, Smart Key - Man Page Apropos, Smart Key - Occurrence Matches, Smart Keyboard Keys @subsection Smart Key - Calendar Mode @format @group 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. @end group @end format @node Smart Key - Man Page Apropos, Smart Key - Emacs Outline Mode, Smart Key - Calendar Mode, Smart Keyboard Keys @subsection Smart Key - Man Page Apropos @format @group When pressed within a man page apropos buffer or listing: ACTION KEY (1) on a UNIX man apropos entry, the man page for that entry is displayed in another window; (2) on or after the last line, the buffer in the other window is scrolled up a windowful. ASSIST KEY (1) on a UNIX man apropos entry, the man page for that entry is displayed in another window; (2) on or after the last line, the buffer in the other window is scrolled down a windowful. @end group @end format @page @node Smart Key - Emacs Outline Mode, Smart Key - Info Manuals, Smart Key - Man Page Apropos, Smart Keyboard Keys @subsection Smart Key - Emacs Outline Mode @vindex selective-display @format @group If pressed within an outline-mode buffer or when no other context is matched and outline-minor-mode is enabled: ACTION KEY Collapses, expands, and moves outline entries. (1) after an outline heading has been cut via the Action Key, pastes the cut heading at point; (2) at the end of the buffer, shows all buffer text; (3) at the beginning of a heading line, cuts the headings subtree from the buffer; (4) on a header line but not at the beginning or end of the line, if the headings subtree is hidden, shows it, otherwise hides it; (5) anywhere else, invokes @code{action-key-eol-function}, typically to scroll 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, invokes @code{assist-key-eol-function}, typically to scroll down a windowful. @end group @end format @node Smart Key - Info Manuals, Smart Key - Email Composers, Smart Key - Emacs Outline Mode, Smart Keyboard Keys @subsection Smart Key - Info Manuals @format @group @cindex click, Info @cindex Info browsing @findex Info-global-next @findex Info-global-prev 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. @end group @end format @format @group 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. @noindent Use @bkbd{s} within an Info manual to search for any concept that interests you. @end group @end format @node Smart Key - Email Composers, Smart Key - GNUS Newsreader, Smart Key - Info Manuals, Smart Keyboard Keys @subsection Smart Key - Email Composers @vindex hmail:reader @vindex hmail:lister @format @group 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. @end group @end format @format @group 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. @end group @end format @node Smart Key - GNUS Newsreader, Smart Key - Buffer Menus, Smart Key - Email Composers, Smart Keyboard Keys @subsection Smart Key - GNUS Newsreader @cindex click, Gnus @cindex Gnus browsing @format @group If pressed within the Gnus newsgroups listing buffer: ACTION KEY (1) on a GNUS-GROUP line, that newsgroup is read; (2) if `gnus-topic-mode' is active, and on a topic line, the topic is expanded or collapsed as needed; (3) to the left of any GNUS-GROUP line, within any of the whitespace, the current group is unsubscribed or resubscribed; (4) at the end of the GNUS-GROUP buffer after all lines, the number of waiting messages per group is updated. @end group @end format @format @group ASSIST KEY (1) on a GNUS-GROUP line, that newsgroup is read; (2) if `gnus-topic-mode' is active, and on a topic line, the topic is expanded or collapsed as needed; (3) to the left of any GNUS-GROUP line, within any of the whitespace, the user is prompted for a group name to subscribe or unsubscribe to; (4) at the end of the GNUS-GROUP buffer after all lines, the newsreader is quit. @end group @end format @format @group 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. @end group @end format @format @group 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. @end group @end format @format @group 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. @end group @end format @format @group 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. @end group @end format @node Smart Key - Buffer Menus, Smart Key - Tar File Mode, Smart Key - GNUS Newsreader, Smart Keyboard Keys @subsection Smart Key - Buffer Menus @cindex click, buffer menu @cindex buffer menu @format @group 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. @end group @end format @format @group 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. @end group @end format @cindex click, ibuffer menu @cindex ibuffer menu @format @group If pressed within an interactive buffer menu (ibuffer-mode): ACTION KEY (1) on the first or second column of an entry, the selected buffer is marked for display; (2) anywhere else within an entry line, all saves and deletes are done, and selected buffers are displayed, including the one just clicked on (if within the OO-Browser user interface, only the selected buffer is displayed); (3) on the first or last line in the buffer, all deletes are done. @end group @end format @format @group ASSIST KEY (1) on the first or second column of an entry, the selected buffer is unmarked for display or deletion; (2) anywhere else within an entry line, the selected buffer is marked for deletion; (3) on the first or last line in the buffer, all display, save, and delete marks on all entries are undone. @end group @end format @node Smart Key - Tar File Mode, Smart Key - Man Pages, Smart Key - Buffer Menus, Smart Keyboard Keys @subsection Smart Key - Tar File Mode @cindex click, tar @cindex tar archive browsing @cindex extracting from tar files @format @group 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. @end group @end format @format @group 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. @end group @end format @node Smart Key - Man Pages, Smart Key - WWW URLs, Smart Key - Tar File Mode, Smart Keyboard Keys @subsection Smart Key - Man Pages @cindex man page references @vindex smart-man-c-routine-ref @format @group 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. @end group @end format @node Smart Key - WWW URLs, Smart Key - HyRolo Match Buffers, Smart Key - Man Pages, Smart Keyboard Keys @subsection Smart Key - WWW URLs @cindex click, world-wide web @cindex W3 @cindex URL @vindex browse-url-browser-function @cindex World-wide Web @cindex WWW @kindex C-h h c u @cindex menu, Cust/URL-Display @format @group If pressed on a World-Wide Web universal resource locator (URL): ACTION KEY Displays the referent for the URL at point using the web browser given by the variable, @code{browse-url-browser-function}. Adjust this setting with the Cust/URL-Display @bkbd{C-h h c u} menu. ASSIST KEY Displays help for the ACTION KEY. @end group @end format @node Smart Key - HyRolo Match Buffers, Smart Key - Image Thumbnails, Smart Key - WWW URLs, Smart Keyboard Keys @subsection Smart Key - HyRolo Match Buffers @cindex click, hyrolo matches @cindex hyrolo matches @format @group If pressed within an entry in the HyRolo search results buffer: ACTION KEY or ASSIST KEY The entry is edited in the other window. @end group @end format @node Smart Key - Image Thumbnails, Smart Key - Gomoku Game, Smart Key - HyRolo Match Buffers, Smart Keyboard Keys @subsection Smart Key - Image Thumbnails @cindex images @cindex thumbnails @cindex dired, images @vindex image-dired-external-viewer @format @group If pressed within a Dired Image Thumbnail buffer: ACTION KEY Selects the chosen thumbnail and scales its image for display in another Emacs window. ASSIST KEY Selects thumbnail and uses the external viewer named by @code{image-dired-external-viewer} to display it. @end group @end format @node Smart Key - Gomoku Game, Smart Key - The OO-Browser, Smart Key - Image Thumbnails, Smart Keyboard Keys @subsection Smart Key - Gomoku Game @cindex game, gomoku @cindex gomoku @format @group 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. @end group @end format @node Smart Key - The OO-Browser, Smart Key - Default Context, Smart Key - Gomoku Game, Smart Keyboard Keys @subsection Smart Key - The OO-Browser @cindex OO-Browser @cindex object-oriented code browsing @format @group 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. @end group @end format @format @group 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. @end group @end format @format @group 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. @end group @end format @format @group 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. @end group @end format @format @group When pressed on an identifier within an OO-Browser source file: ACTION KEY Tries to display the identifier definition. ASSIST KEY Does nothing. @end group @end format @node Smart Key - Default Context, , Smart Key - The OO-Browser, Smart Keyboard Keys @subsection Smart Key - Default Context @vindex action-key-default-function @vindex assist-key-default-function @findex hyperbole @findex hyperbole-popup-menu @findex hkey-summarize @cindex Smart Key, default context @format @group Finally, if pressed within an unrecognized context: ACTION KEY Runs the function stored in @code{action-key-default-function}. By default, it just displays an error message. Set it to @code{hyperbole} if you want it to display the Hyperbole minibuffer menu or @code{hyperbole-popup-menu} to popup the Hyperbole menubar menu. ASSIST KEY Runs the function stored in @code{assist-key-default-function}. By default, it just displays an error message. Set it to @code{hkey-summarize} if you want it to display a summary of Smart Key behavior. @end group @end format @node Suggestion or Bug Reporting, Questions and Answers, Smart Key Reference, Top @appendix Suggestion or Bug Reporting @cindex version description @cindex Hyperbole version If you find any errors in Hyperbole's operation or documentation, feel free to report them to . Be sure to use the @bkbd{C-h h m r} Msg/Report-Hypb-Bug minibuffer menu item whenever you send a message to this address since that command will insert important system version information for you. If you use Hyperbole mail or news support (@pxref{Buttons in Mail}), a press of your Action Key on the Hyperbole mail list address will insert a description of your Hyperbole configuration information into your outgoing message, so that you do not have to type it. Otherwise, be sure to include the version numbers of your editor, Hyperbole and your window system. Your Hyperbole version number can be found in the top-level Hyperbole menu. Below are some tips on how best to structure requests and discussion messages. If you share information about your use of Hyperbole with others, it will promote broader use and development of Hyperbole. @itemize @bullet @item Always use your Subject lines to state the position that your message takes on the topic that it addresses. @display For example, write: ``Subject: Typo in top-level Hyperbole minibuffer menu.'' rather than: ``Subject: Hyperbole bug'' @end display @item 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. @vindex emacs-version @item 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 @bkbd{M-x emacs-version @key{RET}} gives the other.) @item 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. @end itemize If you have suggestions on how to improve Hyperbole, send them to (@bkbd{C-h h m c} minibuffer menu item Msg/Compose-Hypb-Mail). Here are some issues you might address: @itemize @bullet @item What did you like and dislike about the system? @item What kinds of tasks, if any, does it seem to help you with? @item What did you think of the Emacs-based user interface? @item How was the Hyperbole Manual and other documentation? @item Was the setup trivial, average or hard? @item What areas of Hyperbole would you like to see expanded/added? @item How does it compare to other hypertext tools you have used? @item Was it easy or difficult to create your own types? Why? @item Did you get any use out of the external system encapsulations? @end itemize @node Questions and Answers, Future Work, Suggestion or Bug Reporting, Top @appendix Questions and Answers @enumerate @item As I discover the Zen of Hyperbole, will I become so enamored of its power that I lose all control of my physical faculties? This other-worldly reaction is of course an individual matter. Some people have canceled meditation trips to the Far East after discovering that pressing the Action Key in random contexts serves a similar purpose much more cheaply. We have not seen anyone's mind turn to jelly but with the cognition Hyperbole saves you, you might just grow a second one. Eventually, you will be at peace and will understand that there is no adequate description of Hyperbole. Just let it flow through you. @noindent Ok, joking aside, now that we have your attention, here are some serious questions and answers. @cindex Org mode @item Isn't Org mode the same as Hyperbole? No, they offer very different capabilities when you compare them a bit more deeply. In fact, it makes sense to use them together and they are highly compatible. The only overlap we see is that Org mode has a more limited kind of hyperlinks and offers some BBDB integration as Hyperbole does. Initial Smart Key support for Org mode is already in Hyperbole and more will come. For a list of some differences, see: @url{https://www.emacswiki.org/emacs/Hyperbole}. Org-mode offers traditional Emacs outlining, todo list management, agenda and diary management, so it is very complementary to Hyperbole. It did not exist when Hyperbole was first developed. Today it is just a matter of having time and resources to devote to finding ways to integrate the two. We would like to see this happen. If you would like to see it, offer time or money to help make it happen. @cindex Smart Key @cindex mouse key bindings @findex hmouse-setup @findex hmouse-get-bindings @vindex file, hmouse-sh.el @item How can I change the Smart Mouse Key bindings? @findex hmouse-setup @findex hmouse-get-bindings Since the Smart Mouse Keys are set up for use under many different Emacs configurations, there is no easy way to provide user level customization. Any mouse key binding changes require editing the @code{(hmouse-setup)} and @code{(hmouse-get-bindings)} functions in the @file{hmouse-sh.el} file. @vindex file, hmouse-key.el @vindex file, hui-window.el @vindex hkey-alist @vindex hmouse-alist To make the Smart Keys do new things in particular contexts, define new types of implicit buttons, @pxref{Implicit Buttons}. The @code{hkey-alist} and @code{hmouse-alist} variables in @file{hui-mouse.el} and @file{hui-window.el} must be altered if you want to change what the Smart Keys do in standard contexts. You should then update the Smart Key summary documentation in the file, @file{man/hkey-help.txt}, and then regenerate the readable forms of this manual which includes that file. @item 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. @cindex global button, modify @item How can I modify a number of global buttons in succession? Rather than typing the name for each, it is quicker to jump to the global button file and edit the buttons there as you would any explicit buttons. By default, the ButFile/PersonalFile menu item takes you to the file where global buttons are saved at the end of the file. @item Why are button attributes scattered across directories? When you think of a hyper-space that you depend on every day, you don't want to have a single point of failure that can make you incapable of doing work. With Hyperbole, if some directories become unavailable for a particular time (e.g.@: the filesystems on which they reside are dismounted) you can still work elsewhere with minimal effect. We believe this to be a compelling factor to leave the design with distributed button attribute storage. This design also permits the potential addition of buttons to read-only media. @item Why are action types defined apart from implicit button types? Any category of button can make use of an action type. Some action types are useful as behavior definitions for a variety of button categories, so all action types are defined separately to give them independence from those types which apply them. For implicit button types that require a lot of code, it is useful to add a module that includes the implicit button type definition, its action type definition and supporting code. Then simply load that module into your Emacs session. @end enumerate @node Future Work, References, Questions and Answers, Top @appendix Future Work @noindent This appendix is included for a number of reasons: @itemize @bullet @item to better allow you to assess whether to work with Hyperbole by providing sketches of possible additions; @item to direct further development effort towards known needs; @item and to acknowledge known weaknesses in the current system. @end itemize Without any serious interest from users, progress on these fronts will be slow. Here are some new features we have in mind, however. @table @asis @item Button Copying, Killing, and Yanking There is as yet no means of transferring explicit buttons among buffers. We realize this is an important need. Users should be able to manipulate text with embedded buttons in ordinary ways. With this feature, Hyperbole would store the button attributes as text properties within the buffers so that if a button is copied, its attributes follow. When a buffer is saved, the attributes also will be saved. @item Koutliner View Mode This will complement the Koutliner editing mode by using simple one character keys that normally insert characters to instead modify the view of a Koutline and to move around in it, for ease of study. Switching between view and edit modes will also be simple. @item Direct Manipulation Hyperbole is designed to let you rapidly navigate and manipulate large, distributed information spaces. Being able to directly manipulate entities in these spaces will accelerate understanding and production of new information. Already Hyperbole lets you drag buffers, windows, files, and directories and place them where you like. But there is much more that can be done to allow for higher-level browsing and information organization. @item 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. @item 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: @sp 1 @end table @example @group 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. @end group @end example @sp 2 @table @asis @item 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. @item Collaboration Support From the early stages of Hyperbole design, collaborative work environments have been considered. A simple facility has demonstrated broadcast of button activations to a number of workstations on a local area network, so that one user can lead others around an information space, as during an online design review. (This facility was never adapted to the current Hyperbole release, however). Nowadays you could just use a screen sharing program. @end table @node References, Key Index, Future Work, Top @appendix References @table @b @item [AkMcYo88] Akscyn, R. M., D. L. McCracken and E. A. Yoder. KMS: A Distributed Hypermedia System for Managing Knowledge in Organizations. @emph{Communications of the ACM}, Vol. 31, No. 7, July 1988, pp. 820-835. @item [Bro87] Brown, P. J. Turning Ideas into Products: The Guide System. @emph{Proceedings of Hypertext '87}, November 13-15, 1987, Chapel Hill, NC. ACM: NY, NY, pp. 33-40. @item [Con87] Conklin, Jeff. Hypertext: An Introduction and Survey. @emph{IEEE Computer}, Vol. 20, No. 9, September 1987, pp. 17-41. @item [Eng68] Engelbart, D., and W. English. A research center for augmenting human intellect. @emph{Proceedings of the Fall Joint Computer Conference}, 33, 1, AFIPS Press: Montvale, NJ, 1968, pp. 395-410. @item [Eng84a] Engelbart, D. C. Authorship Provisions in Augment. @emph{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,) @item [Eng84b] Engelbart, D. C. Collaboration Support Provisions in Augment. @emph{Proceedings of the AFIPS Office Automation Conference (OAC '84 Digest)}, February, 1984, Los Angeles, CA, 1984. 51-58. (OAD,2221,) @item [Fos88] Foss, C. L. Effective Browsing in Hypertext Systems. @emph{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. @item [GaSmMe86] Garrett, N., K. E. Smith and N. Meyrowitz. Intermedia: Issues, Strategies, and Tactics in the Design of a Hypermedia Document System. @emph{Computer-Supported Cooperative Work (CSCW '86) Proceedings}, December 3-5, Austin, TX, 1986, pp. 163-174. @item [HaMoTr87] Halasz, F. G., T. P. Moran and R. H. Trigg. NoteCards in a Nutshell. @emph{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. @item [Har88] Harvey, G. @emph{Understanding HyperCard.} Alameda, CA: SYBEX, Inc., 1988. @item [KaKaBeLaDr90] Kaplan, S. J., M. D. Kapor, E. J. Belove, R. A. Landsman, and T. R. Drake. AGENDA: A personal Information Manager. @emph{Communications of the ACM}, No. 33, July 1990, pp. 105-116. @item [Nel87a] Nelson, T. H. @emph{Computer Lib/Dream Machines.} MicroSoft Press, Redmond, WA, 1987. @item [Nel87b] Nelson, T. H. @emph{Literary Machines, Edition 87.1}. Available from the Distributors, 702 South Michigan, South Bend, IN 46618, 1987. @item [NoDr86] Norman, D. A. and S. W. Draper, editors. @emph{User Centered System Design.} Lawrence Erlbaum Associates: Hillsdale, New Jersey, 1986. @item [Shn82] Shneiderman, B. The future of interactive systems and the emergence of direct manipulation. @emph{Behavior and Information Technology}, Vol. 1, 1982, pp. 237-256. @item [Sta87] Stallman, R. @emph{GNU Emacs Manual.} Free Software Foundation, Cambridge: MA, March 1987. @item [Tri86] Trigg, R., L. Suchman, and F. Halasz. Supporting collaboration in NoteCards. @emph{Proceedings of the CSCW '86 Conference}, Austin, TX, December 1986, pp. 147-153. @item [TrMoHa87] Trigg, R. H., T. P. Moran and F. G. Halasz. Adaptability and Tailorability in NoteCards. @emph{Proceedings of INTERACT '87}, Stuttgart, West Germany, September 1987. @item [Wei92] Weiner, B. @emph{PIEmail: A Personalized Information Environment Mail Tool.} Department of Computer Science Masters Project, Brown University: Providence, RI, May 10, 1992. @item [YaHaMeDr88] Yankelovich, N., B. J. Haan, N. Meyrowitz and S. M. Drucker. Intermedia: The Concept and the Construction of a Seamless Information Environment. @emph{IEEE Computer}, Vol. 21, No. 1, January 1988, pp. 81-96. @item [YoAkMc89] Yoder, E. A., R. M. Akscyn and D. L. McCracken. Collaboration in KMS, A Shared Hypermedia System. @emph{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. @end table @c *************************** @c Indices @c *************************** @node Key Index, Function, References, Top @unnumbered Key Index @printindex ky @node Function, Concept Index, Key Index, Top @unnumbered Function, Variable and File Index @printindex fn @node Concept Index, , Function, Top @unnumbered Concept Index @printindex cp @bye @c Local Variables: @c eval: (outline-minor-mode 1) @c eval: (modify-syntax-entry ?: "_") @c End: