Hyperbole User Manual
3.3 Implicit Buttons
Implicit buttons are those defined by the natural structure of a
document. They are identified by contextual patterns which limit the
locations or states in which they can appear. Their behavior is
determined by one or more actions which they trigger when activated. An
action is derived from either a Hyperbole action type specification,
3.4 Action Types, or an Emacs Lisp function. Implicit
button types may use the same action types that explicit buttons do.
Implicit buttons never have any button data associated with them. They
are recognized in context based on predicate matches defined within
implicit button types. For example, Hyperbole recognizes file names
enclosed in double quotes and can quickly display their associated files
in response to simple mouse clicks.
See `hibtypes.el' for complete examples. Standard implicit button
types include (in alphabetical order):
annot-bib
-
Displays annotated bibliography entries referenced internally, delimeters = [].
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.
completion
-
Inserts completion at point into minibuffer or other window.
dir-summary
-
Detects filename buttons in files named "MANIFEST" or "DIR".
Displays selected files.
Each file name must be at the beginning of the line and must be followed
by one or more spaces and then another non-space, non-parenthesis, non-brace
character.
doc-id
-
Displays an index entry for a site-specific document given its id. Ids
must be delimited by 'doc-id-start' and 'doc-id-end' and must match the
function given by 'doc-id-p'. This permits creation of catalogued
online libraries. See `${hyperb:dir}/hib-doc-id.el' for more
information.
elisp-compiler-msg
-
Jumps to source code for definition associated with byte-compiler error
message. Works when activated anywhere within an error line.
debugger-source
-
Jumps to source line associated with debugger stack frame or breakpoint lines.
This works with gdb, dbx, and xdb. Such lines are recognized in any buffer.
grep-msg
-
Jumps to line associated with grep or compilation error msgs.
Messages are recognized in any buffer.
hyp-address
-
Turns a Hyperbole e-mail list address into an implicit button which
inserts Hyperbole environment information.
Useful when sending mail to a Hyperbole mail list. See also the
documentation for
actypes::hyp-config.
hyp-source
-
Turns source location entries in Hyperbole reports into buttons that jump to the associated location.
Info-node
-
Makes "(file)node" buttons display the associated Info node.
kbd-key
-
Executes a key sequence delimited by curly braces.
Key sequences should be in human readable form, e.g. {C-b}.
Forms such as {}, {}, and {^b} will not be recognized.
klink
-
Follows a link delimited by <> to a koutline cell.
See documentation for
actypes::link-to-kotl for valid link
specifiers.
mail-address
-
If on an e-mail address in a specific buffer type, mail to that address
in another window. Applies to the rolodex match buffer, any buffer
attached to a file in rolo-file-list, or any buffer with `mail'
or `rolo' (case-insensitive) within its name.
man-apropos
-
UNIX manual
man pages
man apropos
- Makes man apropos entries display associated man pages when selected.
patch-msg
-
Jumps to source code associated with output from the
patch
program. Patch applies diffs to source code.
pathname
-
Makes a delimited, valid pathname display the path entry.
Also works for delimited and non-delimited ange-ftp and efs pathnames.
See
hpath:at-p function documentation for possible delimiters.
See hpath:suffixes variable documentation for suffixes that are
added to or removed from pathname when searching for a valid match.
See hpath:find function documentation and
hpath:display-alist and hpath:find-alist variable
documentation for special file display options.
rfc
-
Retrieves and displays an Internet rfc referenced at point.
Requires ange-ftp or efs when needed for remote retrievals. The
following formats are recognized: RFC822, rfc-822, and RFC 822. The
hpath:rfc variable specifies the location from which to retrieve
RFCs."
rfc-toc
-
Summarizes contents of an Internet rfc from anywhere within rfc buffer.
Each line in summary may be selected to jump to section.
text-toc
-
Jumps to the text file section referenced by a table of contents entry
at point. File name must contain `README' and there must be a
`Table of Contents' or `Contents' label on a line by itself (it may
begin with an asterisk), preceding the table of contents. Each toc
entry must begin with some whitespace followed by one or more asterisk
characters. Each file section name line must start with one or more
asterisk characters at the very beginning of the line.
www-url
-
When not in a w3 browser buffer, follow any non-ftp url (link) at point.
The variable, action-key-url-function, can be used to customize
the url browser that is used.
The Hyperbole Smart Keys offer extensive additional context-sensitive
point-and-click type behavior beyond these standard implicit button
types. See section 4. Smart Keys.
