[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/hyperbole bab59c8 25/53: V6.0.2d - Improved README and
|
From: |
Robert Weiner |
|
Subject: |
[elpa] externals/hyperbole bab59c8 25/53: V6.0.2d - Improved README and added git#=branch:file implicit button syntax. |
|
Date: |
Wed, 15 Nov 2017 22:47:02 -0500 (EST) |
branch: externals/hyperbole
commit bab59c881819e5c598a8a8971f127562df44aa0e
Author: Bob Weiner <address@hidden>
Commit: Bob Weiner <address@hidden>
V6.0.2d - Improved README and added git#=branch:file implicit button syntax.
* man/hyperbole.texi (Version): Updated to 6.0.2d and rebuilt output
formats.
* Makefile (README.md.html): Added build rule as part of 'make doc'.
README*: Rewrote the Summary intro paragraph and first two numbered items
in simpler terms
for new users.
* hib-social.el (git-commit-reference): Added new implicit button type to
display a diff for
any commit listed in 'git log' output.
(git-reference): Fixed a few typos and added support for
git#=branch:file syntax
to view (not edit) a file from a specific branch. Hyperbole finds
which project the branch
and file are associated with if a default is not specified. Documented
in this file and DEMO.
---
Changes | 20 +-
DEMO | 13 +-
HY-ABOUT | 2 +-
HY-ANNOUNCE | 2 +-
HY-ANNOUNCE-SHORT | 6 +
HY-NEWS | 4 +
Makefile | 22 +-
README | 50 +-
README.md | 57 ++-
README.md.html | 1337 +++++++++++++++++-----------------------------------
hib-social.el | 120 +++--
hversion.el | 2 +-
hyperbole-pkg.el | 2 +-
man/hyperbole.html | 8 +-
man/hyperbole.info | Bin 438289 -> 438289 bytes
man/hyperbole.pdf | Bin 798604 -> 798598 bytes
man/hyperbole.texi | 8 +-
man/version.texi | 6 +-
18 files changed, 627 insertions(+), 1032 deletions(-)
diff --git a/Changes b/Changes
index f290896..6f50c0d 100644
--- a/Changes
+++ b/Changes
@@ -1,3 +1,17 @@
+2017-10-06 Bob Weiner <address@hidden>
+
+* man/hyperbole.texi (Version): Updated to 6.0.2d and rebuilt output formats.
+
+* Makefile (README.md.html): Added build rule as part of 'make doc'.
+ README*: Rewrote the Summary intro paragraph and first two numbered items in
simpler terms
+ for new users.
+
+* hib-social.el (git-commit-reference): Added new implicit button type to
display a diff for
+ any commit listed in 'git log' output.
+ (git-reference): Fixed a few typos and added support for
git#=branch:file syntax
+ to view (not edit) a file from a specific branch. Hyperbole finds which
project the branch
+ and file are associated with if a default is not specified. Documented in
this file and DEMO.
+
2017-10-05 Bob Weiner <address@hidden>
* hib-social.el (hibtypes-git-build-repos-cache): Fixed to prune matches like
'file-git',
@@ -293,7 +307,7 @@
* DEMO (Git References): Added.
hib-social.el (hibtypes-github-default-project): Renamed from
hibtypes-social-github-default-project.
- (hibtypes-github-default-user): Renamed from
hibtypes-social-githbu-default-user.
+ (hibtypes-github-default-user): Renamed from
hibtypes-social-github-default-user.
(hibtypes-git-default-project): Added.
(hibtypes-git-*, git-reference): Updated to allow
git#project/commit-hashtag references. So now all of the
@@ -311,7 +325,7 @@
* hibtypes.el (grep-msg): Added match to context lines produced by 'grep
-A<num>'
which use '-' around the line number rather than ':'.
(hib-debbugs): Lowered priority below hib-social so it doesn't shadow valid
- social references since it matching is broad.
+ social references since its matching is broad.
* hib-social.el (social-reference, hibtypes-social-regexp): Added missing '-'
character in social-reference matches.
@@ -533,7 +547,7 @@ Python (case-sensitive).
* hpath.el (hpath:substitute-dir): Added support for environment variables
including those with PATH
in their name (colon-separated paths) that should have been there.
- Added call to hpath:exists-p to test path with hpath:suffixes added to fix
bug where
+ Added call to hpath:exists-p to test path with hpath:suffixes added. This
fixed the bug where
"${load-path}/simple.el" did not resolve properly when the file was stored
compressed
as simple.el.gz, for example.
diff --git a/DEMO b/DEMO
index 16da463..9b3e7ea 100644
--- a/DEMO
+++ b/DEMO
@@ -486,14 +486,15 @@ Similarly, again for software developers, git references
work on local
git repositories. If you have a clone of the Hyperbole git repository
on your local system, then you can activate all of the following buttons.
- git#/hyperbole (displays the top directory of the hyperbole
repository)
- git#/hyperbole/55a1f0 (displays hyperbole git commit diff)
- git#=hactypes.el (displays a git-versioned file regardless of
directory)
- gt#55a1f0 (when within a git repo, displays its commit diff)
+ git#/hyperbole (displays the top directory of the hyperbole
repository)
+ git#/hyperbole/55a1f0 (displays hyperbole git commit diff)
+ git#=hactypes.el (displays a git-versioned file regardless of
directory)
+ git#=master:kotl/kview.el (displays file in subdirectory from master branch)
+ gt#55a1f0 (when within a git repo, displays its commit diff)
-The first three examples work anywhere regardless of the buffer since Hyperbole
+The first four examples work anywhere regardless of the buffer since Hyperbole
locates all git repositories for you by repository/project name. If you set a
-default project (see "(hyperbole)git-reference"), then the third example will
+default project (see "(hyperbole)git-reference"), then the last example will
work anywhere as well.
** Grep, Occurrence, Debugger and Compiler Error Buttons, and Cscope Analyzer
diff --git a/HY-ABOUT b/HY-ABOUT
index f0487aa..8bd1ea4 100644
--- a/HY-ABOUT
+++ b/HY-ABOUT
@@ -3,7 +3,7 @@
Designed and Written by Bob Weiner
Maintained by Mats Lidell and Bob Weiner
https://www.gnu.org/software/hyperbole/
- Version 6.0.2c
+ Version 6.0.2d
GNU Hyperbole (pronounced Ga-new Hi-per-bo-lee), or just Hyperbole, is
an efficient and programmable hypertextual information management
diff --git a/HY-ANNOUNCE b/HY-ANNOUNCE
index cfd8e75..0bbf664 100644
--- a/HY-ANNOUNCE
+++ b/HY-ANNOUNCE
@@ -1,4 +1,4 @@
-ANNOUNCE: GNU Hyperbole 6.0.2c for Emacs 24.4 or newer is released
+ANNOUNCE: GNU Hyperbole 6.0.2d for Emacs 24.4 or newer is released
The GNU Hyperbole home page, https://www.gnu.org/software/hyperbole, contains a
number of screenshots of Hyperbole and its menus and links to useful resources.
diff --git a/HY-ANNOUNCE-SHORT b/HY-ANNOUNCE-SHORT
index 5d8ef59..36a444f 100644
--- a/HY-ANNOUNCE-SHORT
+++ b/HY-ANNOUNCE-SHORT
@@ -16,6 +16,12 @@ Hyperbole includes an interactive demo to introduce you to
its features and a
detailed reference manual.
===========================================================================
+* What's New in GNU Hyperbole V6.0.2d
+===========================================================================
+
+See "Changes" file.
+
+===========================================================================
* What's New in GNU Hyperbole V6.0.2
===========================================================================
diff --git a/HY-NEWS b/HY-NEWS
index 877abe3..480fdd8 100644
--- a/HY-NEWS
+++ b/HY-NEWS
@@ -1,6 +1,10 @@
What's New in GNU Hyperbole
by Bob Weiner
+===========================================================================
+* V6.0.2d
+===========================================================================
+
(See "Changes" for more complete details of changes.)
===========================================================================
diff --git a/Makefile b/Makefile
index 9de2078..85fcc5f 100644
--- a/Makefile
+++ b/Makefile
@@ -32,14 +32,16 @@
# USAGE: For those installing GNU Hyperbole, use:
# make help
#
-# For OO-Browser maintainers:
-# To assemble a Hyperbole Emacs package for testing:
+# To build only the output formats of the Hyperbole manual:
+# make doc
+#
+# To assemble a Hyperbole Emacs package for testing:
# make pkg
-# To release a Hyperbole Emacs package to ELPA and ftp.gnu.org:
+#
+# To release a Hyperbole Emacs package to ELPA and ftp.gnu.org:
# make release
#
# The Hyperbole Manual is included in the package in four forms:
-#
# "man/hyperbole.info" - GNU browsable version
# "man/hyperbole.html" - Web browsable version
# "man/hyperbole.pdf" - Printable version
@@ -52,7 +54,7 @@
# This ver setup won't work under any make except GNU make, so set it manually.
#HYPB_VERSION = "`head -3 hversion.el | tail -1 | sed -e 's/.*|\(.*\)|.*/\1/'`"
-HYPB_VERSION = 6.0.2c
+HYPB_VERSION = 6.0.2d
# Emacs executable used to byte-compile .el files into .elc's.
# Possibilities include: emacs, infodock, xemacs, etc.
@@ -240,11 +242,11 @@ TAGS: $(EL_TAGS)
version: doc
@ echo ""
@ echo "Any fgrep output means the version number has not been updated
in that file."
- fgrep -L $(HYPB_VERSION) Makefile HY-ABOUT HY-ANNOUNCE HY-NEWS
hversion.el hyperbole-pkg.el man/hyperbole.texi man/version.texi
+ fgrep -L $(HYPB_VERSION) Makefile HY-ABOUT HY-ANNOUNCE
HY-ANNOUNCE-SHORT HY-NEWS hversion.el hyperbole-pkg.el man/hyperbole.texi
man/version.texi
@ echo ""
-# Build the Info, HTML and Postscript versions of the user manual.
-doc: info html pdf
+# Build the Info, HTML and Postscript versions of the user manual and
README.md.html.
+doc: info html pdf README.md.html
info: $(man_dir)/hyperbole.info
$(man_dir)/hyperbole.info: $(man_dir)/hyperbole.texi $(man_dir)/version.texi
$(man_dir)/hkey-help.txt
@@ -258,6 +260,10 @@ pdf: $(man_dir)/hyperbole.pdf
$(man_dir)/hyperbole.pdf: $(man_dir)/hyperbole.texi $(man_dir)/version.texi
$(man_dir)/hkey-help.txt
cd $(man_dir) && $(TEXI2PDF) hyperbole.texi
+# github-markdown is an npm, installed with: npm install markdown-to-html -g
+README.md.html: README.md
+ github-markdown README.md > README.md.html
+
# Generate a Hyperbole package suitable for distribution via the Emacs package
manager.
pkg: package
package: git-pull doc kotl/kotl-loaddefs.el
$(pkg_dir)/hyperbole-$(HYPB_VERSION).tar.sig
diff --git a/README b/README
index eb14211..cfd23b6 100644
--- a/README
+++ b/README
@@ -27,52 +27,58 @@ written by Bob Weiner. It is maintained by him and Mats
Lidell.
===========================================================================
GNU Hyperbole (pronounced Ga-new Hi-per-bo-lee), or just Hyperbole, is an
-efficient and programmable hypertextual information management system
-implemented as a GNU Emacs package. It is a toolkit and user interface for
-viewing, retrieving and interlinking all kinds of textual information,
-utilizing Emacs for editing most of that information. Thus, you can build
-new classes of applications with it, but most people will just use it to
-speed their day-to-day information management needs.
-
-Hyperbole works well on GNU Emacs 24.4 or above. It is designed and written
-by Bob Weiner. It is maintained by him and Mats Lidell. Its main
-distribution site is: https://www.gnu.org/software/hyperbole/. If any term
-in here is new or unfamiliar to you, you can look it up in the Hyperbole
-Glossary.
+easy-to-use, yet powerful and programmable hypertextual information
+management system implemented as a GNU Emacs package. It offers rapid views
+and interlinking of all kinds of textual information, utilizing Emacs for
+editing. It can dramatically increase your productivity and greatly reduce
+the number of keyboard/mouse keys you'll need to work efficiently.
Hyperbole lets you:
-1. Create your own button types and use buttons of those types to launch
-arbitrary actions. One action type is a link to a file;
+1. Quickly create hyperlink buttons either from the keyboard or by dragging
+between a source and destination window with a mouse button depressed.
+Later activate buttons by pressing/clicking on them or by giving the name of
+the button.
+
+2. Activate many kinds of `implicit buttons' recognized by context within
+text buffers, e.g. URLs, grep output lines, and git commits. A single key
+or mouse button automatically does the right thing in dozens of contexts;
+just press and go.
-2. Build outlines with multi-level numbered outline nodes, e.g. 1.4.8.6,
+3. Build outlines with multi-level numbered outline nodes, e.g. 1.4.8.6,
that all renumber automatically as any node or tree is moved in the
outline. Each node also has a permanent hyperlink anchor that you can
reference from any other node;
-3. Manage all your contacts quickly with hierarchical categories and embed
+4. Manage all your contacts quickly with hierarchical categories and embed
hyperlinks within each entry. Or create an archive of documents with
hierarchical entries and use the same search mechanism to quickly find any
matching entry;
-4. Use single keys to easily manage your Emacs windows or frames and quickly
+5. Use single keys to easily manage your Emacs windows or frames and quickly
retrieve saved window and frame configurations;
-5. Search for things in your current buffers, in a directory tree or across
+6. Search for things in your current buffers, in a directory tree or across
major web search engines with the touch of a few keys.
The common thread in all these features is making retrieval, management and
display of information fast and easy. That is Hyperbole's purpose.
-For a more extensive summary of Hyperbole with text and images, see the
-Hyperbole home page: https://www.gnu.org/software/hyperbole. If you have
-already downloaded Hyperbole, see the "HY-ABOUT" file for a text-only
-description and overview of Hyperbole.
+Hyperbole works well on GNU Emacs 24.4 or above. It is designed and written
+by Bob Weiner. It is maintained by him and Mats Lidell. Its main
+distribution site is: https://www.gnu.org/software/hyperbole. If any term in
+here is new or unfamiliar to you, you can look it up in the Hyperbole Manual
+Glossary.
===========================================================================
* Files
===========================================================================
+For a more extensive summary of Hyperbole with text and images, see the
+Hyperbole home page: https://www.gnu.org/software/hyperbole. If you have
+already downloaded Hyperbole, see the "HY-ABOUT" file for a longer
+description and overview of Hyperbole.
+
See "DEMO" for a demonstration of standard Hyperbole button capabilities.
This is the best way to initially interactively learn about Hyperbole after
installing it.
diff --git a/README.md b/README.md
index 28f44f7..14d93d3 100644
--- a/README.md
+++ b/README.md
@@ -23,40 +23,39 @@
## Summary
-`GNU Hyperbole` (pronounced Ga-new Hi-per-bo-lee), or just
-`Hyperbole`, is an efficient and programmable hypertextual information
-management system implemented as a GNU Emacs package. It is a toolkit
-and user interface for viewing, retrieving and interlinking all kinds
-of textual information, utilizing Emacs for editing most of that
-information. Thus, you can build new classes of applications with it,
-but most people use it to speed their day-to-day information
-management and retrieval needs.
-
-Hyperbole works well on GNU Emacs 24.4 or above. It is designed and
-written by Bob Weiner. It is maintained by him and Mats Lidell. Its
-main distribution site is: <https://www.gnu.org/software/hyperbole/>.
-If any term in here is new or unfamiliar to you, you can look it up in the
-[Hyperbole Glossary](man/hyperbole.html#Glossary).
+`GNU Hyperbole` (pronounced Ga-new Hi-per-bo-lee), or just `Hyperbole`,
+is an easy-to-use, yet powerful and programmable hypertextual information
+management system implemented as a GNU Emacs package. It offers rapid views
+and interlinking of all kinds of textual information, utilizing Emacs for
+editing. It can dramatically increase your productivity and greatly reduce
+the number of keyboard/mouse keys you'll need to work efficiently.
Hyperbole lets you:
- 1. Create your own button types and use buttons of those types to
- launch arbitrary actions. One action type is a link to a file;
+ 1. Quickly create hyperlink buttons either from the keyboard or by dragging
+ between a source and destination window with a mouse button depressed.
+ Later activate buttons by pressing/clicking on them or by giving the
+ name of the button.
+
+ 2. Activate many kinds of `implicit buttons` recognized by context
+ within text buffers, e.g. URLs, grep output lines, and git commits.
+ A single key or mouse button automatically does the right thing in
+ dozens of contexts; just press and go.
- 2. Build outlines with multi-level numbered outline nodes,
- e.g. 1.4.8.6, that all renumber automatically as any node or tree is
- moved in the outline. Each node also has a permanent hyperlink anchor
- that you can reference from any other node;
+ 3. Build outlines with multi-level numbered outline nodes, e.g. 1.4.8.6,
+ that all renumber automatically as any node or tree is moved in the
+ outline. Each node also has a permanent hyperlink anchor that you can
+ reference from any other node;
- 3. Manage all your contacts quickly with hierarchical categories and
+ 4. Manage all your contacts quickly with hierarchical categories and
embed hyperlinks within each entry. Or create an archive of documents
- with hierarchical entries and use the same search mechanism to
quickly find
- any matching entry;
+ with hierarchical entries and use the same search mechanism to quickly
+ find any matching entry;
- 4. Use single keys to easily manage your Emacs windows or frames
- and quickly retrieve saved window and frame configurations;
+ 5. Use single keys to easily manage your Emacs windows or frames and
+ quickly retrieve saved window and frame configurations;
- 5. Search for things in your current buffers, in a directory tree or
+ 6. Search for things in your current buffers, in a directory tree or
across major web search engines with the touch of a few keys.
The common thread in all these features is making retrieval,
@@ -89,6 +88,12 @@ only one thing than Hyperbole is not for you, but if you
would
rather learn fewer packages and get more work done faster, then
Hyperbole is for you.
+Hyperbole works well on GNU Emacs 24.4 or above. It is designed and
+written by Bob Weiner. It is maintained by him and Mats Lidell. Its
+main distribution site is: <https://www.gnu.org/software/hyperbole/>.
+If any term in here is new or unfamiliar to you, you can look it up in the
+[Hyperbole Glossary](man/hyperbole.html#Glossary).
+
Hyperbole is available for [download and installation](#installation)
through the GNU Emacs package manager.
diff --git a/README.md.html b/README.md.html
index d0ca55d..3313e74 100644
--- a/README.md.html
+++ b/README.md.html
@@ -1,1091 +1,606 @@
-<!DOCTYPE html>
-<html>
-
-<head>
-
-<meta charset="utf-8">
-<title>README</title>
-
-
-<style type="text/css">
-body {
- font-family: Helvetica, arial, sans-serif;
- font-size: 14px;
- line-height: 1.6;
- padding-top: 10px;
- padding-bottom: 10px;
- background-color: white;
- padding: 30px; }
-
-body > *:first-child {
- margin-top: 0 !important; }
-body > *:last-child {
- margin-bottom: 0 !important; }
-
-a {
- color: #4183C4; }
-a.absent {
- color: #cc0000; }
-a.anchor {
- display: block;
- padding-left: 30px;
- margin-left: -30px;
- cursor: pointer;
- position: absolute;
- top: 0;
- left: 0;
- bottom: 0; }
-
-h1, h2, h3, h4, h5, h6 {
- margin: 20px 0 10px;
- padding: 0;
- font-weight: bold;
- -webkit-font-smoothing: antialiased;
- cursor: text;
- position: relative; }
-
-h1 tt, h1 code {
- font-size: inherit; }
-
-h2 tt, h2 code {
- font-size: inherit; }
-
-h3 tt, h3 code {
- font-size: inherit; }
-
-h4 tt, h4 code {
- font-size: inherit; }
-
-h5 tt, h5 code {
- font-size: inherit; }
-
-h6 tt, h6 code {
- font-size: inherit; }
-
-h1 {
- font-size: 28px;
- color: black; }
-
-h2 {
- font-size: 24px;
- border-bottom: 1px solid #cccccc;
- color: black; }
-
-h3 {
- font-size: 18px; }
-
-h4 {
- font-size: 16px; }
-
-h5 {
- font-size: 14px; }
-
-h6 {
- color: #777777;
- font-size: 14px; }
-
-p, blockquote, ul, ol, dl, li, table, pre {
- margin: 15px 0; }
-
-hr {
- background: transparent
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAYAAAAECAYAAACtBE5DAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyJpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYwIDYxLjEzNDc3NywgMjAxMC8wMi8xMi0xNzozMjowMCAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4g
[...]
- border: 0 none;
- color: #cccccc;
- height: 4px;
- padding: 0;
-}
-
-body > h2:first-child {
- margin-top: 0;
- padding-top: 0; }
-body > h1:first-child {
- margin-top: 0;
- padding-top: 0; }
- body > h1:first-child + h2 {
- margin-top: 0;
- padding-top: 0; }
-body > h3:first-child, body > h4:first-child, body > h5:first-child, body >
h6:first-child {
- margin-top: 0;
- padding-top: 0; }
-
-a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4,
a:first-child h5, a:first-child h6 {
- margin-top: 0;
- padding-top: 0; }
-
-h1 p, h2 p, h3 p, h4 p, h5 p, h6 p {
- margin-top: 0; }
-
-li p.first {
- display: inline-block; }
-li {
- margin: 0; }
-ul, ol {
- padding-left: 30px; }
-
-ul :first-child, ol :first-child {
- margin-top: 0; }
-
-dl {
- padding: 0; }
- dl dt {
- font-size: 14px;
- font-weight: bold;
- font-style: italic;
- padding: 0;
- margin: 15px 0 5px; }
- dl dt:first-child {
- padding: 0; }
- dl dt > :first-child {
- margin-top: 0; }
- dl dt > :last-child {
- margin-bottom: 0; }
- dl dd {
- margin: 0 0 15px;
- padding: 0 15px; }
- dl dd > :first-child {
- margin-top: 0; }
- dl dd > :last-child {
- margin-bottom: 0; }
-
-blockquote {
- border-left: 4px solid #dddddd;
- padding: 0 15px;
- color: #777777; }
- blockquote > :first-child {
- margin-top: 0; }
- blockquote > :last-child {
- margin-bottom: 0; }
-
-table {
- padding: 0;border-collapse: collapse; }
- table tr {
- border-top: 1px solid #cccccc;
- background-color: white;
- margin: 0;
- padding: 0; }
- table tr:nth-child(2n) {
- background-color: #f8f8f8; }
- table tr th {
- font-weight: bold;
- border: 1px solid #cccccc;
- margin: 0;
- padding: 6px 13px; }
- table tr td {
- border: 1px solid #cccccc;
- margin: 0;
- padding: 6px 13px; }
- table tr th :first-child, table tr td :first-child {
- margin-top: 0; }
- table tr th :last-child, table tr td :last-child {
- margin-bottom: 0; }
-
-img {
- max-width: 100%; }
-
-span.frame {
- display: block;
- overflow: hidden; }
- span.frame > span {
- border: 1px solid #dddddd;
- display: block;
- float: left;
- overflow: hidden;
- margin: 13px 0 0;
- padding: 7px;
- width: auto; }
- span.frame span img {
- display: block;
- float: left; }
- span.frame span span {
- clear: both;
- color: #333333;
- display: block;
- padding: 5px 0 0; }
-span.align-center {
- display: block;
- overflow: hidden;
- clear: both; }
- span.align-center > span {
- display: block;
- overflow: hidden;
- margin: 13px auto 0;
- text-align: center; }
- span.align-center span img {
- margin: 0 auto;
- text-align: center; }
-span.align-right {
- display: block;
- overflow: hidden;
- clear: both; }
- span.align-right > span {
- display: block;
- overflow: hidden;
- margin: 13px 0 0;
- text-align: right; }
- span.align-right span img {
- margin: 0;
- text-align: right; }
-span.float-left {
- display: block;
- margin-right: 13px;
- overflow: hidden;
- float: left; }
- span.float-left span {
- margin: 13px 0 0; }
-span.float-right {
- display: block;
- margin-left: 13px;
- overflow: hidden;
- float: right; }
- span.float-right > span {
- display: block;
- overflow: hidden;
- margin: 13px auto 0;
- text-align: right; }
-
-code, tt {
- margin: 0 2px;
- padding: 0 5px;
- white-space: nowrap;
- border: 1px solid #eaeaea;
- background-color: #f8f8f8;
- border-radius: 3px; }
-
-pre code {
- margin: 0;
- padding: 0;
- white-space: pre;
- border: none;
- background: transparent; }
-
-.highlight pre {
- background-color: #f8f8f8;
- border: 1px solid #cccccc;
- font-size: 13px;
- line-height: 19px;
- overflow: auto;
- padding: 6px 10px;
- border-radius: 3px; }
-
-pre {
- background-color: #f8f8f8;
- border: 1px solid #cccccc;
- font-size: 13px;
- line-height: 19px;
- overflow: auto;
- padding: 6px 10px;
- border-radius: 3px; }
- pre code, pre tt {
- background-color: transparent;
- border: none; }
-
-sup {
- font-size: 0.83em;
- vertical-align: super;
- line-height: 0;
-}
-* {
- -webkit-print-color-adjust: exact;
-}
address@hidden screen and (min-width: 914px) {
- body {
- width: 854px;
- margin:0 auto;
- }
-}
address@hidden print {
- table, pre {
- page-break-inside: avoid;
- }
- pre {
- word-wrap: break-word;
- }
-}
-</style>
-
-<style type="text/css">
-
-code[class*="language-"],
-pre[class*="language-"] {
- color: black;
- background: none;
- text-shadow: 0 1px white;
- font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
- text-align: left;
- white-space: pre;
- word-spacing: normal;
- word-break: normal;
- word-wrap: normal;
- line-height: 1.5;
-
- -moz-tab-size: 4;
- -o-tab-size: 4;
- tab-size: 4;
-
- -webkit-hyphens: none;
- -moz-hyphens: none;
- -ms-hyphens: none;
- hyphens: none;
-}
-
-pre[class*="language-"]::-moz-selection, pre[class*="language-"]
::-moz-selection,
-code[class*="language-"]::-moz-selection, code[class*="language-"]
::-moz-selection {
- text-shadow: none;
- background: #b3d4fc;
-}
-
-pre[class*="language-"]::selection, pre[class*="language-"] ::selection,
-code[class*="language-"]::selection, code[class*="language-"] ::selection {
- text-shadow: none;
- background: #b3d4fc;
-}
-
address@hidden print {
- code[class*="language-"],
- pre[class*="language-"] {
- text-shadow: none;
- }
-}
-
-/* Code blocks */
-pre[class*="language-"] {
- padding: 1em;
- margin: .5em 0;
- overflow: auto;
-}
-
-:not(pre) > code[class*="language-"],
-pre[class*="language-"] {
- background: #f5f2f0;
-}
-
-/* Inline code */
-:not(pre) > code[class*="language-"] {
- padding: .1em;
- border-radius: .3em;
- white-space: normal;
-}
-
-.token.comment,
-.token.prolog,
-.token.doctype,
-.token.cdata {
- color: slategray;
-}
-
-.token.punctuation {
- color: #999;
-}
-
-.namespace {
- opacity: .7;
-}
-
-.token.property,
-.token.tag,
-.token.boolean,
-.token.number,
-.token.constant,
-.token.symbol,
-.token.deleted {
- color: #905;
-}
-
-.token.selector,
-.token.attr-name,
-.token.string,
-.token.char,
-.token.builtin,
-.token.inserted {
- color: #690;
-}
-
-.token.operator,
-.token.entity,
-.token.url,
-.language-css .token.string,
-.style .token.string {
- color: #a67f59;
- background: hsla(0, 0%, 100%, .5);
-}
-
-.token.atrule,
-.token.attr-value,
-.token.keyword {
- color: #07a;
-}
-
-.token.function {
- color: #DD4A68;
-}
-
-.token.regex,
-.token.important,
-.token.variable {
- color: #e90;
-}
-
-.token.important,
-.token.bold {
- font-weight: bold;
-}
-.token.italic {
- font-style: italic;
-}
-
-.token.entity {
- cursor: help;
-}
-</style>
-
-
-</head>
-
-<body>
-
-<h1 id="toc_0">GNU Hyperbole 6.0.2 - The Everyday Hypertextual Information
Manager</h1>
-
-<!-- START doctoc generated TOC -->
+<h1>
+<a
id="user-content-gnu-hyperbole-602---the-everyday-hypertextual-information-manager"
class="anchor"
href="#gnu-hyperbole-602---the-everyday-hypertextual-information-manager"
aria-hidden="true"><span aria-hidden="true" class="octicon
octicon-link"></span></a>GNU Hyperbole 6.0.2 - The Everyday Hypertextual
Information Manager</h1>
<p><strong>Table of Contents</strong></p>
-
<ul>
<li><a href="#summary">Summary</a></li>
<li><a href="#mailing-lists">Mailing Lists</a></li>
<li><a href="#ftp-and-git">Ftp and Git Source Code-only Downloads</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#invocation">Invocation</a></li>
-<li><a href="#components">Hyperbole Components</a></li>
-<li><a href="#buttons">Hyperbole Buttons</a></li>
-<li><a href="#features">Important Features</a></li>
-<li><a href="#uses">Hyperbole Uses</a></li>
+<li><a href="#hyperbole-components">Hyperbole Components</a></li>
+<li><a href="#hyperbole-buttons">Hyperbole Buttons</a></li>
+<li><a href="#important-features">Important Features</a></li>
+<li><a href="#hyperbole-uses">Hyperbole Uses</a></li>
<li><a href="#files">Files</a></li>
<li><a href="#programmer-quick-reference">Programmer Quick Reference</a></li>
<li><a href="#user-quotes">User Quotes</a></li>
<li><a href="#why-was-hyperbole-developed">Why was Hyperbole
developed?</a></li>
</ul>
-<!-- END doctoc generated TOC -->
-
-<p><img src="man/im/hyperbole-cv.png" alt="Hyperbole screenshot of the
Koutliner, DEMO file and HyRolo"></p>
-
-<h2 id="summary">Summary</h2>
-
-<p><code>GNU Hyperbole</code> (pronounced Ga-new Hi-per-bo-lee), or just
-<code>Hyperbole</code>, is an efficient and programmable hypertextual
information
-management system implemented as a <a
href="http://www.gnu.org/software/emacs/";>GNU Emacs</a>
-package. It is a toolkit and user interface for viewing, retrieving and
-interlinking all kinds of textual information, utilizing Emacs for
-editing most of that information. Thus, you can build new classes of
-applications with it, but most people use it to
-speed their day-to-day information management and retrieval needs.</p>
-
-<p>Hyperbole works well on GNU Emacs 24.4 or above. It is designed and
-written by Bob Weiner. It is maintained by him and Mats Lidell. Its
-main distribution site is:
-<a
href="https://www.gnu.org/software/hyperbole/";>https://www.gnu.org/software/hyperbole/</a>.
-If any term in here is new or unfamiliar to you, you can look it up in the
-<a href="man/hyperbole.html#Glossary">Hyperbole Glossary</a>.</p>
-
+<p><a href="man/im/hyperbole-cv.png" target="_blank"><img
src="man/im/hyperbole-cv.png" alt="Hyperbole screenshot of the Koutliner, DEMO
file and HyRolo" style="max-width:100%;"></a></p>
+<h2>
+<a id="user-content-summary" class="anchor" href="#summary"
aria-hidden="true"><span aria-hidden="true" class="octicon
octicon-link"></span></a>Summary</h2>
+<p><code>GNU Hyperbole</code> (pronounced Ga-new Hi-per-bo-lee), or just
<code>Hyperbole</code>,
+is an easy-to-use, yet powerful and programmable hypertextual information
+management system implemented as a GNU Emacs package. It offers rapid views
+and interlinking of all kinds of textual information, utilizing Emacs for
+editing. It can dramatically increase your productivity and greatly reduce
+the number of keyboard/mouse keys you'll need to work efficiently.</p>
<p>Hyperbole lets you:</p>
-
<ol>
- <li>Create your own button types and use buttons of those types to
- launch arbitrary actions. One action type is a link to a file;</li>
-
- <li>Build outlines with multi-level numbered outline nodes,
- e.g. 1.4.8.6, that all renumber automatically as any node or tree is
- moved in the outline. Each node also has a permanent hyperlink anchor
- that you can reference from any other node;</li>
-
- <li>Manage all your contacts quickly with hierarchical categories and
- embed hyperlinks within each entry. Or create an archive of documents
- with hierarchical entries and use the same search mechanism to quickly
find
- any matching entry;</li>
-
- <li>Use single keys to easily manage your Emacs windows or frames
- and quickly retrieve saved window and frame configurations;</li>
-
- <li>Search for things in your current buffers, in a directory tree or
- across major web search engines with the touch of a few keys.</li>
+<li>
+<p>Quickly create hyperlink buttons either from the keyboard or by dragging
+between a source and destination window with a mouse button depressed.
+Later activate buttons by pressing/clicking on them or by giving the
+name of the button.</p>
+</li>
+<li>
+<p>Activate many kinds of <code>implicit buttons</code> recognized by context
+within text buffers, e.g. URLs, grep output lines, and git commits.
+A single key or mouse button automatically does the right thing in
+dozens of contexts; just press and go.</p>
+</li>
+<li>
+<p>Build outlines with multi-level numbered outline nodes, e.g. 1.4.8.6,
+that all renumber automatically as any node or tree is moved in the
+outline. Each node also has a permanent hyperlink anchor that you can
+reference from any other node;</p>
+</li>
+<li>
+<p>Manage all your contacts quickly with hierarchical categories and
+embed hyperlinks within each entry. Or create an archive of documents
+with hierarchical entries and use the same search mechanism to quickly
+find any matching entry;</p>
+</li>
+<li>
+<p>Use single keys to easily manage your Emacs windows or frames and
+quickly retrieve saved window and frame configurations;</p>
+</li>
+<li>
+<p>Search for things in your current buffers, in a directory tree or
+across major web search engines with the touch of a few keys.</p>
+</li>
</ol>
-
-<p>The common thread in all these features is making retrieval, management
- and display of information fast and easy. That is Hyperbole's
- purpose. It may be broad but it works amazingly well. If it is
- textual information, Hyperbole can work with it. In contrast to Org
- mode, Hyperbole works across all Emacs modes and speeds your work by
- turning all kinds of references into clickable hyperlinks and allowing
- you to create new hyperlinks by dragging between two windows.
- The <a href="https://www.emacswiki.org/emacs/Hyperbole";>Hyperbole wiki
page</a>
- explains the many ways it differs from and is complementary to Org
mode.</p>
-
+<p>The common thread in all these features is making retrieval,
+management and display of information fast and easy. That is
+Hyperbole's purpose. It may be broad but it works amazingly well. If
+it is textual information, Hyperbole can work with it. In contrast to
+Org mode, Hyperbole works across all Emacs modes and speeds your work
+by turning all kinds of references into clickable hyperlinks and
+allowing you to create new hyperlinks by dragging between two windows.
+The <a href="https://www.emacswiki.org/emacs/Hyperbole";>Hyperbole wiki page</a>
+explains the many ways it differs from and is complementary to Org
+mode.</p>
<p>Hyperbole allows hypertext buttons to be embedded within unstructured
- and structured files, mail messages and news articles. It offers
- intuitive keyboard and mouse-based control of information display
- within multiple windows. It also provides point-and-click access to
- World-Wide Web URLs, Info manuals, ftp archives, etc.</p>
-
-<p>Hyperbole includes easy-to-use, powerful hypertextual button types that
- work without the need for a markup language. Hyperbole's button types
- are written in Lisp and can be wholly independent of the web, i.e. web
- links are one type of Hyperbole link, not fundamental to its link
- architecture. However, Hyperbole is a great assistant when editing
- HTML or Javascript or when browsing web pages and links.</p>
-
+and structured files, mail messages and news articles. It offers
+intuitive keyboard and mouse-based control of information display
+within multiple windows. It also provides point-and-click access to
+World-Wide Web URLs, Info manuals, ftp archives, etc.</p>
+<p>Hyperbole includes easy-to-use, powerful hypertextual button types
+without the need to learn a markup language. Hyperbole's button types
+are written in Lisp and can be wholly independent of the web, i.e. web
+links are one type of Hyperbole link, not fundamental to its link
+architecture. However, Hyperbole is a great assistant when editing
+HTML or Javascript or when browsing web pages and links.</p>
<p>Hyperbole is something to be experienced and interacted with, not
- understood from reading alone. If you like an Emacs package to do
- only one thing than Hyperbole is not for you, but if you would rather
- learn fewer packages and get more work done faster, then Hyperbole is
- for you.</p>
-
+understood from reading alone. If you like an Emacs package to do
+only one thing than Hyperbole is not for you, but if you would
+rather learn fewer packages and get more work done faster, then
+Hyperbole is for you.</p>
+<p>Hyperbole works well on GNU Emacs 24.4 or above. It is designed and
+written by Bob Weiner. It is maintained by him and Mats Lidell. Its
+main distribution site is: <a
href="https://www.gnu.org/software/hyperbole/";>https://www.gnu.org/software/hyperbole/</a>.
+If any term in here is new or unfamiliar to you, you can look it up in the
+<a href="man/hyperbole.html#Glossary">Hyperbole Glossary</a>.</p>
<p>Hyperbole is available for <a href="#installation">download and
installation</a>
- through the GNU Emacs package manager.</p>
-
-<h2 id="mailing-lists">Mailing Lists</h2>
+through the GNU Emacs package manager.</p>
+<h2>
+<a id="user-content-mailing-lists" class="anchor" href="#mailing-lists"
aria-hidden="true"><span aria-hidden="true" class="octicon
octicon-link"></span></a>Mailing Lists</h2>
+<pre><code>- address@hidden - User list for GNU Hyperbole
-<dl>
- <dt><strong>address@hidden</strong></dt>
- <dd>User list for GNU Hyperbole
- (<a href="http://lists.gnu.org/mailman/listinfo/hyperbole-users";>info
- and subscription</a>,
- <a href="http://lists.gnu.org/pipermail/hyperbole-users/";>web
archive</a>).
- </dd>
- <dt><strong>address@hidden</strong></dt>
- <dd>List for bug reporting
- (<a href="http://lists.gnu.org/mailman/listinfo/bug-hyperbole";>info
- and subscription</a>,
- <a href="http://lists.gnu.org/archive/html/bug-hyperbole/";>web
archive</a>).
- </dd>
-</dl>
+ [info and
subscription](http://lists.gnu.org/mailman/listinfo/hyperbole-users)
+ [web archive](http://lists.gnu.org/pipermail/hyperbole-users/)
-<h2 id="ftp-and-git">Ftp and Git Source Code-only Downloads</h2>
+- address@hidden - List for bug reporting
+ [info and
subscription](http://lists.gnu.org/mailman/listinfo/bug-hyperbole)
+ [web archive](http://lists.gnu.org/archive/html/bug-hyperbole/)
+</code></pre>
+<h2>
+<a id="user-content-ftp-and-git-source-code-only-downloads" class="anchor"
href="#ftp-and-git-source-code-only-downloads" aria-hidden="true"><span
aria-hidden="true" class="octicon octicon-link"></span></a>Ftp and Git Source
Code-only Downloads</h2>
<p>To explore the released Hyperbole source code rather than installing it for
use,
- download a tar.gz source archive from either:</p>
-
-<ul><li><a
href="ftp://ftp.gnu.org/gnu/hyperbole/";>ftp://ftp.gnu.org/gnu/hyperbole/</a></li></ul>
-
-<p>or</p>
-
-<ul><li><a
href="http://ftpmirror.gnu.org/hyperbole/";>http://ftpmirror.gnu.org/hyperbole/</a></li></ul>
+download a tar.gz source archive from either:</p>
+<pre><code>- [ftp://ftp.gnu.org/gnu/hyperbole/]()
+- [http://ftpmirror.gnu.org/hyperbole/]()
+</code></pre>
<p>which will find the closest mirror of the GNU ftp site and show it to
you.</p>
-
-<p>If you want to follow along with Hyperbole development and
- maintain a copy/clone of the current version-controlled git tree,
- use the <a href="https://savannah.gnu.org/git/?group=hyperbole";>command
listed here</a>
- to clone the Hyperbole project tree.</p>
-
-<h2 id="installation">Installation</h2>
-
+<p>If you want to follow along with Hyperbole development and maintain a
+copy/clone of the current version-controlled git tree, use the
+<a href="https://savannah.gnu.org/git/?group=hyperbole";>command listed here</a>
+to clone the Hyperbole project tree.</p>
+<h2>
+<a id="user-content-installation" class="anchor" href="#installation"
aria-hidden="true"><span aria-hidden="true" class="octicon
octicon-link"></span></a>Installation</h2>
<p>Once you have Emacs set up at your site, GNU Hyperbole may be
installed by using the Emacs Package Manager. If you are not
familiar with it, see the Packages section of the GNU Emacs Manual,
-<a
href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Packages.html";>Emacs
Packages</a>. </p>
-
+<a
href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Packages.html";>Emacs
Packages</a>.</p>
<p>If you have Hyperbole 5.10 or higher already installed and simply want to
upgrade it, invoke the Emacs Package Manager with {M-x list-packages RET},
then use the {U} key followed by the {x} key to upgrade all out-of-date
packages, Hyperbole among them. Then skip the text below and move on to
the next section, <a href="#invocation">Invocation</a>.</p>
-
<p>Otherwise, to download and install the Hyperbole package, you should
add several lines to your personal Emacs initialization file,
-typically "~/.emacs". For further details, see <a
href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Init-File.html";>Emacs
Init
+typically "~/.emacs". For further details, see <a
href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Init-File.html";>Emacs
Init
File</a>.</p>
-
<p>Below are the lines to add:</p>
-
-<div><pre><code class="language-none">(require 'package)
+<pre><code>(require 'package)
(setq package-enable-at-startup nil) ;; Prevent double loading of libraries
(package-initialize)
(unless (package-installed-p 'hyperbole)
(package-refresh-contents)
(package-install 'hyperbole))
-(require 'hyperbole)</code></pre></div>
-
+(require 'hyperbole)
+</code></pre>
<hr>
-
<p>Now save the file and then 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.</p>
-
-<h2 id="invocation">Invocation</h2>
-
+<h2>
+<a id="user-content-invocation" class="anchor" href="#invocation"
aria-hidden="true"><span aria-hidden="true" class="octicon
octicon-link"></span></a>Invocation</h2>
<p>Once Hyperbole has been installed for use at your site and loaded into your
Emacs session, it is ready for use. You will see a Hyperbole menu on your
menubar and {C-h h} will display a Hyperbole menu in the minibuffer for
quick keyboard-based selection.</p>
-
<p>You can invoke Hyperbole commands in one of three ways:</p>
-
<p>use the Hyperbole menu on your menubar;</p>
-
-<p><img src="man/im/menu-hyperbole.png" alt="Hyperbole Menubar Menu"></p>
-
+<p><a href="man/im/menu-hyperbole.png" target="_blank"><img
src="man/im/menu-hyperbole.png" alt="Hyperbole Menubar Menu"
style="max-width:100%;"></a></p>
<p>type {C-h h} or {M-x hyperbole RET} to bring up the Hyperbole main menu
- in the minibuffer window, for fast keyboard or mouse-based selection;
- select an item from this menu by typing the item's first letter; use {q}
- to quit from the menu.</p>
-
+in the minibuffer window, for fast keyboard or mouse-based selection;
+select an item from this menu by typing the item's first letter; use {q}
+to quit from the menu.</p>
<p>use a specific Hyperbole command such as an Action Key click {M-RET} on
- a pathname to display the associated file or directory.</p>
-
+a pathname to display the associated file or directory.</p>
<p>Use {C-h h d d} for an interactive demonstration of standard Hyperbole
button capabilities.</p>
-
-<p><img src="man/im/demo.png" alt="Hyperbole screenshot of the DEMO"></p>
-
+<p><a href="man/im/demo.png" target="_blank"><img src="man/im/demo.png"
alt="Hyperbole screenshot of the DEMO" style="max-width:100%;"></a></p>
<p>{C-h h k e} offers a interactive demonstration of the Koutliner,
Hyperbole's multi-level autonumbered hypertextual outliner.</p>
-
-<p><img src="man/im/koutliner.png" alt="Hyperbole screenshot of the
Koutliner"></p>
-
+<p><a href="man/im/koutliner.png" target="_blank"><img
src="man/im/koutliner.png" alt="Hyperbole screenshot of the Koutliner"
style="max-width:100%;"></a></p>
<p>To try out HyControl, Hyperbole's interactive frame and window control
system, use {C-h h s w} for window control or {C-h h s f} for frame
control. {t} switches between window and frame control once in one of
-them. Hyperbole also binds {C-c \} for quick access to HyControl's
+them. Hyperbole also binds {C-c } for quick access to HyControl's
window control menu if it was not already bound prior to Hyperbole's
-initialization. Here is a <a href="https://youtu.be/M3-aMh1ccJk";>long
video</a>
-demonstrating most of HyControl's features.</p>
-
+initialization. A long video demonstrating most of HyControl's
+features is available at <a
href="https://youtu.be/M3-aMh1ccJk";>https://youtu.be/M3-aMh1ccJk</a>.</p>
<p>The above are the best interactive ways to learn about Hyperbole.
Hyperbole also includes the Hyperbole Manual, a full reference manual,
-not a simple introduction. It is included in the "man/" subdirectory
+not a simple introduction. It is included in the "man/" subdirectory
of the Hyperbole package directory in four forms:</p>
-
<p><a href="man/hyperbole.info">hyperbole.info</a> - online Info browser
version<br>
<a href="man/hyperbole.html">hyperbole.html</a> - web HTML version<br>
<a href="man/hyperbole.pdf">hyperbole.pdf</a> - printable version<br>
-<a href="man/hyperbole.texi">hyperbole.texi</a> - source form </p>
-
+<a href="man/hyperbole.texi">hyperbole.texi</a> - source form</p>
<p>The Hyperbole package installation places the Info version of this manual
where needed and adds an entry for Hyperbole into the Info directory under
the Emacs category. {C-h h d i} will let you browse the manual. For web
-browsing, point your browser at "${hyperb:dir}/man/hyperbole.html",
+browsing, point your browser at "${hyperb:dir}/man/hyperbole.html",
wherever the Hyperbole package directory is on your system; often this is:
-"~/.emacs.d/elpa/hyperbole-${hyperb:version}/".</p>
-
-<h2 id="components">Hyperbole Components</h2>
-
+"~/.emacs.d/elpa/hyperbole-${hyperb:version}/".</p>
+<h2>
+<a id="user-content-hyperbole-components" class="anchor"
href="#hyperbole-components" aria-hidden="true"><span aria-hidden="true"
class="octicon octicon-link"></span></a>Hyperbole Components</h2>
<p>Hyperbole consists of five parts:</p>
-
<ol>
-<li><p><strong>Buttons and Smart Keys</strong>: A set of hyperbutton types
which supply
- core hypertext and other behaviors. Buttons may be added to
- documents (explicit buttons) with a simple drag between windows,
- no markup language needed. Implicit buttons are patterns
- automatically recognized within text that perform actions,
- e.g. bug#24568 displays the bug status information for that bug
- number.</p>
-
-<p>These actions may be links or arbitrary Lisp expressions. So for
- example, you could create your own button type of Wikipedia
- searches that jumped to the named Wikipedia page whenever point was
- within text of the form [wp<search term>].
- You define the pattern so {<search term>} might do
- the same thing if you preferred. And this works within any Emacs
- buffer you want it to, regardless of major or minor mode.</p>
-
+<li>
+<p><strong>Buttons and Smart Keys</strong>: A set of hyperbutton types which
supply
+core hypertext and other behaviors. Buttons may be added to
+documents (explicit buttons) with a simple drag between windows,
+no markup language needed. Implicit buttons are patterns
+automatically recognized within text that perform actions,
+e.g. bug#24568 displays the bug status information for that bug
+number.</p>
+<p>These actions may be links or arbitrary Lisp expressions. So
+for example, you could create your own button type of
+Wikipedia searches that jumped to the named Wikipedia page
+whenever point was within text of the form [wp].
+You define the pattern so {} might do the same
+thing if you preferred. And this works within any Emacs
+buffer you want it to, regardless of major or minor mode.</p>
<p>Buttons are accessed by clicking on them or referenced by name
- (global buttons), so they can be activated regardless of what is
- on screen. Users can make simple changes to button types and
- those familiar with Emacs Lisp can prototype and deliver new
- types quickly with just a few lines of code.</p>
-
+(global buttons), so they can be activated regardless of what is
+on screen. Users can make simple changes to button types and
+those familiar with Emacs Lisp can prototype and deliver new
+types quickly with just a few lines of code.</p>
<p>Hyperbole includes two special `Smart Keys', the Action Key
- and the Assist Key, that perform an extensive array of
- context-sensitive operations across emacs usage, including
- activating and showing help for Hyperbole buttons. In many
- popular Emacs modes, they allow you to perform common, sometimes
- complex operations without having to use a different key for each
- operation. Just press a Smart Key and the right thing happens;</p></li>
-
-<li><p><strong>Contact and Text Finder</strong>: an interactive textual
information
- management interface, including fast, flexible file and text
- finding commands. A powerful, hierarchical contact manager,
- HyRolo, which anyone can use is also included. It is easy to
- learn to use since it introduces only a few new mechanisms and
- has a menu interface, which may be operated from the keyboard or
- the mouse.</p>
-
-<p><img src="man/im/menu-rolo.png" alt="HyRolo Menubar Menu"></p></li>
-
-<li><p><strong>Screen Control</strong>: Hyperbole includes HyControl, the
- fastest, easiest-to-use window and frame control available for GNU
- Emacs. 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;</p>
-
-<p>The broader vision for HyControl is to support persistent window
- and frame configurations as link targets. Then a user will be able to
- create the views of information he wants and store them as links for
- rapid display. Work remains to implement this feature but it helps
- explain the connection of HyControl to the rest of Hyperbole;</p></li>
-
-<li><p><strong>The Koutliner</strong>: an advanced outliner with multi-level
- autonumbering and permanent ids attached to each outline node for
- use as hypertext link anchors, per node properties and flexible
- view specifications that can be embedded within links or used
- interactively;</p></li>
-
-<li><p><strong>Programming Library</strong>: a set of programming library
classes for
- system developers who want to integrate Hyperbole with another
- user interface or as a back-end to a distinct system. (All of
- Hyperbole is written in Emacs Lisp for ease of modification.
- Hyperbole has been engineered for real-world usage and is well
- structured).</p></li>
+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;</p>
+</li>
+<li>
+<p><strong>Contact and Text Finder</strong>: an interactive textual information
+management interface, including fast, flexible file and text
+finding commands. A powerful, hierarchical contact manager,
+HyRolo, which anyone can use is also included. It is easy to
+learn to use since it introduces only a few new mechanisms and
+has a menu interface, which may be operated from the keyboard or
+the mouse.</p>
+<p><a href="man/im/menu-rolo.png" target="_blank"><img
src="man/im/menu-rolo.png" alt="HyRolo Menubar Menu"
style="max-width:100%;"></a></p>
+</li>
+<li>
+<p><strong>Screen Control</strong>: Hyperbole includes HyControl, the fastest,
+easiest-to-use window and frame control available for GNU
+Emacs. 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;</p>
+<p>The broader vision for HyControl is to support persistent
+window and frame configurations as link targets. Then a user
+will be able to create the views of information he wants and
+store them as links for rapid display. Work remains to
+implement this feature but it helps explain the connection of
+HyControl to the rest of Hyperbole;</p>
+</li>
+<li>
+<p><strong>The Koutliner</strong>: an advanced outliner with multi-level
+autonumbering and permanent ids attached to each outline node for
+use as hypertext link anchors, per node properties and flexible
+view specifications that can be embedded within links or used
+interactively;</p>
+</li>
+<li>
+<p><strong>Programming Library</strong>: a set of programming library classes
for
+system developers who want to integrate Hyperbole with another
+user interface or as a back-end to a distinct system. (All of
+Hyperbole is written in Emacs Lisp for ease of modification.
+Hyperbole has been engineered for real-world usage and is well
+structured).</p>
+</li>
</ol>
-
-<p>We find Hyperbole's parts are more powerful as one package,
- i.e. the sum is greater than the parts, so we don't offer them
- separately. Hyperbole is free software, however, so you may modify it
- as you see fit.</p>
-
-<h2 id="buttons">Hyperbole Buttons</h2>
-
+<p>We find Hyperbole's parts are more powerful as one package, i.e. the
+sum is greater than the parts, so we don't offer them separately.
+Hyperbole is free software, however, so you may modify it as you see
+fit.</p>
+<h2>
+<a id="user-content-hyperbole-buttons" class="anchor"
href="#hyperbole-buttons" aria-hidden="true"><span aria-hidden="true"
class="octicon octicon-link"></span></a>Hyperbole Buttons</h2>
<p>A Hyperbole hypertext user works with buttons; he may create, modify, move
or delete buttons. Each button performs a specific action, such as linking
to a file or executing a shell command.</p>
-
<p>There are three categories of Hyperbole buttons:</p>
-
<ol>
- <li><p><em>Explicit Buttons</em>
- created by Hyperbole, accessible from within a single document; </p></li>
- <li><p><em>Global Buttons</em>
- created by Hyperbole, accessible anywhere within a user's
- network of documents;</p></li>
- <li><p><em>Implicit Buttons</em>
- 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.</p></li>
+<li>
+<p><em>Explicit Buttons</em>
+created by Hyperbole, accessible from within a single document;</p>
+</li>
+<li>
+<p><em>Global Buttons</em>
+created by Hyperbole, accessible anywhere within a user's
+network of documents;</p>
+</li>
+<li>
+<p><em>Implicit Buttons</em>
+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.</p>
+</li>
</ol>
-
<p>Hyperbole buttons may be clicked upon with a mouse to activate them or to
describe their actions. Thus, a user can always check how a button will act
before activating it. Buttons may also be activated from a keyboard. (In
fact, virtually all Hyperbole operations, including menu usage, may be
performed from any standard terminal interface, so one can use it on distant
machines that provide limited display access).</p>
-
<p>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, organizing each bit as time allows.
The Hyperbole Koutliner and HyRolo tools organize textual hierarchies and
may also contain links to external information sources.</p>
-
-<h2 id="features">Important Features</h2>
-
+<h2>
+<a id="user-content-important-features" class="anchor"
href="#important-features" aria-hidden="true"><span aria-hidden="true"
class="octicon octicon-link"></span></a>Important Features</h2>
<p>Some of Hyperbole's most important features include:</p>
-
<ul>
- <li><p>Buttons may link to information or may execute commands, such as
- computing a complex value or communicating with external
programs;</p></li>
- <li><p>Buttons are quick and easy to create with no programming nor
- markup needed. One simply drags between a button source location
- and a link destination to create or to modify a link button. The
- same result can be achieved from the keyboard.</p></li>
- <li><p>Buttons may be embedded within email messages and activated from
- Emacs mail readers; hyperlinks may include variables so that they
- work at different locations where the variable settings differ;</p></li>
- <li><p>Koutlines allow rapid browsing, editing and movement of chunks of
- information organized into trees (hierarchies) and offer links
- that include viewspecs which determine how documents are to be
- displayed, e.g. show just the first two lines of all levels in a
- Koutline;</p></li>
- <li><p>Other hypertext and information retrieval systems may be
- encapsulated under a Hyperbole user interface very easily.</p></li>
+<li>
+<p>Buttons may link to information or may execute commands, such as
+computing a complex value or communicating with external programs;</p>
+</li>
+<li>
+<p>Buttons are quick and easy to create with no programming nor
+markup needed. One simply drags between a button source location
+and a link destination to create or to modify a link button. The
+same result can be achieved from the keyboard.</p>
+</li>
+<li>
+<p>Buttons may be embedded within email messages and activated from
+Emacs mail readers; hyperlinks may include variables so that they
+work at different locations where the variable settings differ;</p>
+</li>
+<li>
+<p>Koutlines allow rapid browsing, editing and movement of chunks of
+information organized into trees (hierarchies) and offer links
+that include viewspecs which determine how documents are to be
+displayed, e.g. show just the first two lines of all levels in a
+Koutline;</p>
+</li>
+<li>
+<p>Other hypertext and information retrieval systems may be
+encapsulated under a Hyperbole user interface very easily.</p>
+</li>
</ul>
-
-<h2 id="uses">Hyperbole Uses</h2>
-
+<h2>
+<a id="user-content-hyperbole-uses" class="anchor" href="#hyperbole-uses"
aria-hidden="true"><span aria-hidden="true" class="octicon
octicon-link"></span></a>Hyperbole Uses</h2>
<p>Typical Hyperbole applications include:</p>
-
<ul>
- <li><p><em>Personal Information Management</em><br>
- Overlapping link paths provide a variety of views into an
- information space. A single key press activates buttons
- regardless of their types, making navigation easy.</p>
-
- <p>A search facility locates buttons in context and permits quick
- selection.</p></li>
- <li><p><em>Documentation Browsing</em><br>
- Embedding cross-references in a favorite documentation format.</p>
-
- <p>Addition of a point-and-click interface to existing
documentation.</p>
-
- <p>Linkage of code and design documents. Jumping to the definition
- of an identifier from its use within code or its reference within
- documentation.</p></li>
- <li><p><em>Brainstorming</em><br>
- Capture of ideas and then quick reorganization with the Hyperbole
- Koutliner. Link to related ideas, eliminating the need to copy
- and paste information into a single place.</p></li>
- <li><p><em>Help/Training Systems</em><br>
- Creation of tutorials with embedded buttons that show students how
- things work while explaining the concepts, e.g. an introduction
- to UNIX commands. This technique can be much more effective than
- descriptions alone.</p></li>
- <li><p><em>Archive Managers</em><br>
- Supplementation of programs that manage archives from incoming
- information stream, having them add topic-based buttons that
- link to the archive holdings. Users can then search and create
- their own links to archive entries.</p></li>
+<li>
+<p><em>Personal Information Management</em><br>
+Overlapping link paths provide a variety of views into an
+information space. A single key press activates buttons
+regardless of their types, making navigation easy.</p>
+<p>A search facility locates buttons in context and permits quick
+selection.</p>
+</li>
+<li>
+<p><em>Documentation Browsing</em><br>
+Embedding cross-references in a favorite documentation format.</p>
+<p>Addition of a point-and-click interface to existing documentation.</p>
+<p>Linkage of code and design documents. Jumping to the definition
+of an identifier from its use within code or its reference within
+documentation.</p>
+</li>
+<li>
+<p><em>Brainstorming</em><br>
+Capture of ideas and then quick reorganization with the Hyperbole
+Koutliner. Link to related ideas, eliminating the need to copy
+and paste information into a single place.</p>
+</li>
+<li>
+<p><em>Help/Training Systems</em><br>
+Creation of tutorials with embedded buttons that show students how
+things work while explaining the concepts, e.g. an introduction
+to UNIX commands. This technique can be much more effective than
+descriptions alone.</p>
+</li>
+<li>
+<p><em>Archive Managers</em><br>
+Supplementation of programs that manage archives from incoming
+information stream, having them add topic-based buttons that
+link to the archive holdings. Users can then search and create
+their own links to archive entries.</p>
+</li>
</ul>
-
-<h2 id="files">Files</h2>
-
+<h2>
+<a id="user-content-files" class="anchor" href="#files"
aria-hidden="true"><span aria-hidden="true" class="octicon
octicon-link"></span></a>Files</h2>
<p>See the <a href="HY-ABOUT">HY-ABOUT</a> file for a description and overview
of Hyperbole.</p>
-
<p>See the <a href="HY-ABOUT">HY-NEWS</a> file for a summary of new features
in this release.</p>
-
<p>See the <a href="INSTALL">INSTALL</a> file for installation and invocation
instructions.</p>
-
<p>See the <a href="HY-COPY">HY-COPY</a> and <a href="COPYING">COPYING</a>
files for license information.</p>
-
<p>See the <a href="MANIFEST">MANIFEST</a> file for summaries of Hyperbole
distribution files.</p>
-
<p>See <a href="DEMO">DEMO</a> for a demonstration of standard Hyperbole
button capabilities.
This is the best way to initially interactively learn about Hyperbole after
installing it.</p>
-
-<p>Various forms of the Hyperbole are below the "man/"
subdirectory.</p>
-
-<h2 id="programmer-quick-reference">Programmer Quick Reference</h2>
-
+<p>Various forms of the Hyperbole are below the "man/" subdirectory.</p>
+<h2>
+<a id="user-content-programmer-quick-reference" class="anchor"
href="#programmer-quick-reference" aria-hidden="true"><span aria-hidden="true"
class="octicon octicon-link"></span></a>Programmer Quick Reference</h2>
<p><a href="MANIFEST">MANIFEST</a> summarizes most of the files in the
distribution.</p>
-
<p>See <a href="DEMO">DEMO</a> for a demonstration of standard Hyperbole button
capabilities. This is the best way to initially interactively learn
about Hyperbole. The Hyperbole Manual is a reference manual, not a
simple introduction.</p>
-
<p>Naming conventions:</p>
-
<ul>
-<li><p>All Hyperbole-specific code files begin with an `h', aside from the
-Koutliner files which are in the kotl/ subdirectory and begin with a
`k'.</p></li>
-<li><p>Hyperbole user-interface files begin with `hui-' or `hmous'.</p></li>
-<li><p>Files that define implicit button types begin with `hib'.</p></li>
-<li><p>Encapsulations of foreign systems begin with `hsys-'.</p></li>
+<li>
+<p>All Hyperbole-specific code files begin with an 'h', aside from the
+Koutliner files which are in the kotl/ subdirectory and begin with a 'k'.</p>
+</li>
+<li>
+<p>Hyperbole user-interface files begin with 'hui-' or 'hmous'.</p>
+</li>
+<li>
+<p>Files that define implicit button types begin with 'hib'.</p>
+</li>
+<li>
+<p>Encapsulations of foreign systems begin with 'hsys-'.</p>
+</li>
</ul>
-
<p>Most of the standard Emacs user interface for Hyperbole is located in
<a href="hui.el">hui.el</a>. Most of the Hyperbole application programming
interface can be found in <a href="hbut.el">hbut.el</a>. <a
href="hbdata.el">hbdata.el</a>
encapsulates the button attribute storage implemented by Hyperbole.
<a href="hmail.el">hmail.el</a> provides a basic abstract interface for
integrating mail readers other than Rmail into Hyperbole.</p>
-
-<p>See the <a href="man/hyperbole.html#Questions-and-Answers">Hyperbole
Questions and Answers</a> appendix in the Hyperbole manual for information on
how
+<p>See the [Hyperbole Questions and Answers](man/hyperbole.html#Questions
+and Answers) appendix in the Hyperbole manual for information on how
to alter the default context-sensitive Hyperbole key bindings (Smart
Keys).</p>
-
-<h2 id="user-quotes">User Quotes</h2>
-
+<h2>
+<a id="user-content-user-quotes" class="anchor" href="#user-quotes"
aria-hidden="true"><span aria-hidden="true" class="octicon
octicon-link"></span></a>User Quotes</h2>
<p>*** MAN I love Hyperbole!!! Wow! ***</p>
-
-<div><pre><code class="language-none"> -- Ken Olstad
- Cheyenne Software, Inc.</code></pre></div>
-
+<pre><code> -- Ken Olstad
+ Cheyenne Software, Inc.
+</code></pre>
<hr>
-
<p>I <em>love</em> koutlines.</p>
-
-<div><pre><code class="language-none"> -- Bob Glickstein
- Z-Code Software Corporation</code></pre></div>
-
+<pre><code> -- Bob Glickstein
+ Z-Code Software Corporation
+</code></pre>
<hr>
-
<p>One of the nicest things about Hyperbole is that it's available
- everywhere. Org-mode is a mode and its features are only available in
- Org files. For instance if you dropped into `eshell' or `ansi-term' and
- did `ls', you can move point to any of the directory's contents, do M-RET
- (or Shift-Button2) and jump to that file. And that's just one example.
- Note that this means that all Hyperbole functionality is available in
- Org files as well. To me, except for the Hyperbole outliner, that means
- complementary not conflicting. It's Hyperbole *and* org-mode, not
- Hyperbole vs. org-mode.
-
+everywhere. Org-mode is a mode and its features are only available in
+Org files. For instance if you dropped into <code>eshell' or</code>ansi-term'
and
+did `ls', you can move point to any of the directory's contents, do M-RET
+(or Shift-Button2) and jump to that file. And that's just one example.
+Note that this means that all Hyperbole functionality is available in
+Org files as well. To me, except for the Hyperbole outliner, that means
+complementary not conflicting. It's Hyperbole <em>and</em> org-mode, not
+Hyperbole vs. org-mode.</p>
<p>Additionally, off the bat, I found it very well documented and for me
- that's a proxy for the quality of a package. The maintainers are quite
- responsive. There's plenty more functionality that I haven't uncovered yet
- but due to the ease of installation and the quality of the documentation,
- digging into it is actually fun.</p>
-
-<div><pre><code class="language-none"> -- Aditya Siram
-</code></pre></div>
+that's a proxy for the quality of a package. The maintainers are quite
+responsive. There's plenty more functionality that I haven't uncovered yet
+but due to the ease of installation and the quality of the documentation,
+digging into it is actually fun.</p>
+<pre><code> -- Aditya Siram
+</code></pre>
<hr>
-
<p>For me, Emacs isn't Emacs without Hyperbole. I have depended on Hyperbole
- daily since 1992, when I first started using it to manage my development
- environment. It didn't take long before I could summon almost any
- information I needed directly from within my editing environment with an
- implicit button. Since I almost never have to slow down to look for
- things--one context-dependent button usually produces exactly what I need
- --I am able to maintain focus on the task I am working on and complete it
- more quickly. With its gestural interface, seamless integration with other
- Emacs packages and incredibly useful set of core features. I think that
- Hyperbole is one of the best designed and most easily extensible software
- products I have ever come across. It is certainly the one which has made
- the biggest improvement in my personal productivity.</p>
-
-<div><pre><code class="language-none"> -- Chris Nuzum
- Co-founder, Traction Software, Inc.</code></pre></div>
-
+daily since 1992, when I first started using it to manage my development
+environment. It didn't take long before I could summon almost any
+information I needed directly from within my editing environment with an
+implicit button. Since I almost never have to slow down to look for
+things--one context-dependent button usually produces exactly what I need
+--I am able to maintain focus on the task I am working on and complete it
+more quickly. With its gestural interface, seamless integration with other
+Emacs packages and incredibly useful set of core features. I think that
+Hyperbole is one of the best designed and most easily extensible software
+products I have ever come across. It is certainly the one which has made
+the biggest improvement in my personal productivity.</p>
+<pre><code> -- Chris Nuzum
+ Co-founder, Traction Software, Inc.
+</code></pre>
<hr>
-
<p>I've found Hyperbole (in conjunction with XEmacs) to be very useful
- for signal processing algorithm development.</p>
-
+for signal processing algorithm development.</p>
<p>For me, it has almost completely obsoleted the engineering notebook:
- I keep a set of files with ideas, algorithms, and results, linked
- together and to the implementation in C++ files. Using XEmacs'
- support for embedding graphics, I've written a mode that accepts
- image tags (formatted like HTML), and reads in GIF files to display
- plots. I have another program that converts the file to HTML (not
- perfect, but adequate), so I can put any aspect of development on
- our internal web for others to see.</p>
-
-<div><pre><code class="language-none"> -- Farzin Guilak
- Protocol Systems, Inc., Engineer</code></pre></div>
-
+I keep a set of files with ideas, algorithms, and results, linked
+together and to the implementation in C++ files. Using XEmacs'
+support for embedding graphics, I've written a mode that accepts
+image tags (formatted like HTML), and reads in GIF files to display
+plots. I have another program that converts the file to HTML (not
+perfect, but adequate), so I can put any aspect of development on
+our internal web for others to see.</p>
+<pre><code> -- Farzin Guilak
+ Protocol Systems, Inc., Engineer
+</code></pre>
<hr>
-
<p>I am blind and have been using Hyperbole since 1992. I used to use a PC as
- a talking terminal attached to a UNIX system, but then I developed
- Emacspeak which lets me use Emacs and Hyperbole from standard UNIX
- workstations with an attached voice synthesizer.</p>
-
+a talking terminal attached to a UNIX system, but then I developed
+Emacspeak which lets me use Emacs and Hyperbole from standard UNIX
+workstations with an attached voice synthesizer.</p>
<p>My main uses are:</p>
-
<ol>
-<li><p>Global and implicit buttons for jumping to ftp sites.</p></li>
-<li><p>The contact manager with Emacspeak support.</p></li>
-<li><p>Explicit buttons as part of comments made about a structured document.
- Each button jumps to the document section referred to by the comment.
- This is very, very useful.</p></li>
-<li><p>The Hyperbole Koutliner, which I find a very useful tool. I've
- implemented Emacspeak extensions to support it.</p>
-
-<div><pre><code class="language-none"> -- TV Raman
- Google Inc.</code></pre></div></li>
+<li>
+<p>Global and implicit buttons for jumping to ftp sites.</p>
+</li>
+<li>
+<p>The contact manager with Emacspeak support.</p>
+</li>
+<li>
+<p>Explicit buttons as part of comments made about a structured document.
+Each button jumps to the document section referred to by the comment.
+This is very, very useful.</p>
+</li>
+<li>
+<p>The Hyperbole Koutliner, which I find a very useful tool. I've
+implemented Emacspeak extensions to support it.</p>
+<pre><code> -- TV Raman
+ Google Inc.
+</code></pre>
+</li>
</ol>
-
<hr>
-
<p>I've been a grateful Hyperbole user for a few years now. Hyperbole's
- flexibility and ease of use is a marvel.</p>
-
+flexibility and ease of use is a marvel.</p>
<p>Mainly, I write easy little implicit button types (and corresponding action
- types) to make my life easier. For example, I have an implicit button type
- to bury certain buffers when I click at their bottoms, one that recognizes
- a bug report record in various contexts and edits it, one that links pieces
- of test output in a log file to the corresponding test case source code
- (EXTREMELY helpful in interpreting test output), others that support our
- homegrown test framework, one that handles tree dired mode the way I'd
- like, one that completely handles wico menus (I've also overloaded the
- wconfig actions triggered by diagonal mouse drags with wicos actions), and
- a couple that support interaction with BBDB.</p>
-
+types) to make my life easier. For example, I have an implicit button type
+to bury certain buffers when I click at their bottoms, one that recognizes
+a bug report record in various contexts and edits it, one that links pieces
+of test output in a log file to the corresponding test case source code
+(EXTREMELY helpful in interpreting test output), others that support our
+homegrown test framework, one that handles tree dired mode the way I'd
+like, one that completely handles wico menus (I've also overloaded the
+wconfig actions triggered by diagonal mouse drags with wicos actions), and
+a couple that support interaction with BBDB.</p>
<p>Other than that, I keep a global button file with 30 or so explicit buttons
- that do various little things, and I index saved mail messages by putting
- explicit link-to-mail buttons in an outline file.</p>
-
-<div><pre><code class="language-none"> -- Ken Olstad
- Cheyenne Software, Inc.</code></pre></div>
-
+that do various little things, and I index saved mail messages by putting
+explicit link-to-mail buttons in an outline file.</p>
+<pre><code> -- Ken Olstad
+ Cheyenne Software, Inc.
+</code></pre>
<hr>
-
<p>In general, Hyperbole is an embeddable, highly extensible hypertext
- tool. As such, I find it very useful. As it stands now, Hyperbole is
- particularly helpful for organizing ill-structured or loosely coupled
- information, in part because there are few tools geared for this purpose.
- Hyperbole also possesses a lot of potential in supporting a wider
- spectrum of structuredness, ranging from unstructured to highly
- structured environments, as well as structural changes over time.</p>
-
+tool. As such, I find it very useful. As it stands now, Hyperbole is
+particularly helpful for organizing ill-structured or loosely coupled
+information, in part because there are few tools geared for this purpose.
+Hyperbole also possesses a lot of potential in supporting a wider
+spectrum of structuredness, ranging from unstructured to highly
+structured environments, as well as structural changes over time.</p>
<p>Major Uses:</p>
-
<ul>
-<li><p>Menu interface to our own collaborative support environment called
+<li>
+<p>Menu interface to our own collaborative support environment called
CoReView: This interface brings together all top-level user commands
into a single partitioned screen, and allows the end user to interact
-with the system using simple mouse-clicking instead of the meta-x key.</p></li>
-<li><p>Gateway to internet resources: this includes links to major Internet
+with the system using simple mouse-clicking instead of the meta-x key.</p>
+</li>
+<li>
+<p>Gateway to internet resources: this includes links to major Internet
archive sites of various types of information. Links are made at both
-directory and file levels.</p></li>
-<li><p>Alternative directory organizer: The hierarchical nature of the Unix
+directory and file levels.</p>
+</li>
+<li>
+<p>Alternative directory organizer: The hierarchical nature of the Unix
file system sometimes makes it difficult to find things quickly and
easily using directory navigational tools such as dired. Hyperbole
-enables me to create various "profile" views of my directory tree,
with
-entries in these views referring to files anywhere in the hierarchy.</p></li>
-<li><p>Organizing and viewing online documentation: using Hyperbole along with
-Hyper-man and Info makes it truly easy to look up online
documentation.</p></li>
-<li><p>Other desktop organization tasks: including links to various mail
+enables me to create various "profile" views of my directory tree, with
+entries in these views referring to files anywhere in the hierarchy.</p>
+</li>
+<li>
+<p>Organizing and viewing online documentation: using Hyperbole along with
+Hyper-man and Info makes it truly easy to look up online documentation.</p>
+</li>
+<li>
+<p>Other desktop organization tasks: including links to various mail
folders, saved newsgroup conversation threads, online note-taker,
emacs-command invocations, etc.</p>
-
-<div><pre><code class="language-none"> -- Dadong Wan
- University of Hawaii</code></pre></div></li>
+<pre><code> -- Dadong Wan
+ University of Hawaii
+</code></pre>
+</li>
</ul>
-
<hr>
-
<p>Hyperbole is the first hyper-link system I've run across that is
- actually part of the environment I use regularly, namely Emacs. The
- complete flexibility of the links is both impressive and expected -- the
- idea of making the link itself programmable is clever, and given that one
- assumes the full power of Emacs. Being able to send email with buttons
- in it is a very powerful capability. Using ange-ftp mode, one can make
- file references "across the world" as easily as normal file
references.</p>
-
-<div><pre><code class="language-none"> -- Mark Eichin
- Cygnus Support</code></pre></div>
-
+actually part of the environment I use regularly, namely Emacs. The
+complete flexibility of the links is both impressive and expected -- the
+idea of making the link itself programmable is clever, and given that one
+assumes the full power of Emacs. Being able to send email with buttons
+in it is a very powerful capability. Using ange-ftp mode, one can make
+file references "across the world" as easily as normal file references.</p>
+<pre><code> -- Mark Eichin
+ Cygnus Support
+</code></pre>
<hr>
-
<p>I just wanted to say how much I enjoy using the Hyperbole Koutliner.
- It is a great way to quickly construct very readable technical documents
- that I can pass around to others. Thanks for the great work. </p>
-
-<div><pre><code class="language-none"> -- Jeff Fried
- Informix</code></pre></div>
-
+It is a great way to quickly construct very readable technical documents
+that I can pass around to others. Thanks for the great work.</p>
+<pre><code> -- Jeff Fried
+ Informix
+</code></pre>
<hr>
-
<p>The Hyperbole system provides a nice interface to exploring corners of
- Unix that I didn't know existed before.</p>
-
-<div><pre><code class="language-none"> -- Craig Smith
</code></pre></div>
-
-<h2 id="why-was-hyperbole-developed">Why was Hyperbole developed?</h2>
-
+Unix that I didn't know existed before.</p>
+<pre><code> -- Craig Smith
+</code></pre>
+<h2>
+<a id="user-content-why-was-hyperbole-developed" class="anchor"
href="#why-was-hyperbole-developed" aria-hidden="true"><span aria-hidden="true"
class="octicon octicon-link"></span></a>Why was Hyperbole developed?</h2>
<p>Hyperbole was originally designed to aid in research aimed at Personalized
Information production/retrieval Environments (PIEs). Hyperbole was a
PIE Manager that provided services to PIE Tools. PIEmail, a mail reader was
the only PIE Tool developed as part of this research but Hyperbole has
greatly expanded since then and has long been a production quality toolset.</p>
-
<p>An examination of many hypertext environments as background research did
not turn up any that seemed suitable for the research envisioned, mainly
due to the lack of rich, portable programmer and user environments. We also
tired of trying to manage our own distributed information pools with standard
UNIX tools. And so Hyperbole was conceived and raved about until it
got its name.</p>
-
<p>Since then Hyperbole has proved indispensible at improving information
access and organization in daily use over many years. Why not start
improving your information handling efficiency today?</p>
-
<p>-- The End --</p>
-</body>
-
-</html>
diff --git a/hib-social.el b/hib-social.el
index 2a2c516..6078f39 100644
--- a/hib-social.el
+++ b/hib-social.el
@@ -42,17 +42,9 @@
;; Git (local) reference links
;;
;; git#branches List branches in current
repo/project
-;; git#commits List commits in current
project
+;; git#commits List and browse commits for
current project
;; git#tags List tags in current project
;;
-;; git#=hibtypes.el Edit any local git-versioned
file
-;; in another window; file must
match
-;; to the last part of a pathname
-;; git#=partial-path/file
-;; git#=/path/file Both work, constraining the
lookup more.
-;; git#=hyperbole.pdf Typically displays Hyperbole
manual
-;; in an external viewer
-;;
;; git#/hyperbole From any buffer, dired on the
top
;; directory of the local
hyperbole
;; project (notice no =)
@@ -66,6 +58,9 @@
;; is inside a git project with
commit
;; hashtag 55a1f0
;;
+;; commit 55a1f0 Commits listed in 'git log'
output
+;; also display diffs.
+;;
;; (setq hibtypes-git-default-project "hyperbole")
;; git#55a1f0 From any buffer, once the
above default
;; is set, display current
project's local
@@ -79,6 +74,21 @@
;; git#commit/55a1f0
;; git#branch/master
;; git#tag/hyperbole-6.0.2
+;;
+;; To edit and view git managed files (note the =):
+;;
+;; git#=hibtypes.el Edit any local git-versioned
file
+;; in another window; file must
match
+;; to the last part of a pathname
+;; git#=partial-path/file
+;; git#=/path/file Both work, constraining the
lookup more.
+;; git#=hyperbole.pdf Typically displays Hyperbole
manual
+;; in an external viewer
+;;
+;; git#=master:hyperbole.el View a file or other entity
from a specific branch
+;; git#=master:kotl/kview.el View a branch file located in
a project subdirectory
+;;
+
;; Github (remote) reference links
;;
@@ -182,8 +192,9 @@
)
"Alist of (social-media-service-regexp . url-with-%s-for-username)
elements.")
-(defconst hibtypes-git-project-regexp
"/?[[:alnum:]]*[-=._/[:alnum:]]*[-=_[:alnum:]]")
-(defconst hibtypes-git-file-regexp "=[-=._/[:alnum:]]*[-=_/[:alnum:]]")
+;; Assume at least a 2-character project name
+(defconst hibtypes-git-project-regexp
"/?[[:alnum:]]+[-=._/[:alnum:]]*[-=_[:alnum:]]")
+(defconst hibtypes-git-file-regexp "=[-=.:_/[:alnum:]]*[-=_/[:alnum:]]")
(defconst hibtypes-social-regexp
(concat "\\([[:alpha:]]*\\)\\(address@hidden)"
@@ -199,7 +210,7 @@ See `ibtypes::social-reference' for format details.")
;;; ************************************************************************
(defib social-reference ()
- "Displays the web page associated with a social hashtag or username
reference at point.
+ "Display the web page associated with a social hashtag or username reference
at point.
Reference format is:
[facebook|git|github|instagram|address@hidden<reference> or
[fb|gt|gh|in|address@hidden<reference>.
@@ -221,8 +232,8 @@ listed in `hibtypes-social-inhibit-modes'."
(and (eq major-mode 'markdown-mode)
(hargs:delimited "(" ")"))))
(save-excursion
- (if (looking-at "address@hidden/._[:alnum:]]")
- (skip-chars-backward "address@hidden/._[:alnum:]"))
+ (if (looking-at "address@hidden/.:_[:alnum:]]")
+ (skip-chars-backward "address@hidden/.:_[:alnum:]"))
(and (looking-at hibtypes-social-regexp)
;; Ensure prefix matches to a social web service
(save-match-data
@@ -360,6 +371,13 @@ PROJECT value is provided, it defaults to the value of
;;; Local git repository commit references
+(defib git-commit-reference ()
+ "Display the diff for a git commit reference, e.g. \"commit a55e21\",
typically produced by git log."
+ (if (save-excursion
+ (beginning-of-line)
+ (looking-at "\\s-*commit \\([0-9a-f]+\\)$"))
+ (hact #'git-reference (match-string-no-properties 1))))
+
(defvar hibtypes-git-repos-cache
(expand-file-name "Local-Git-Repos" hbmap:dir-user)
"Filename of cache of local git repository directories found by
`locate-command'.")
@@ -453,13 +471,13 @@ PROJECT value is provided, it defaults to the value of
`hibtypes-git-default-project'."
(cond ((or (null reference) (equal reference ""))
(error "(git-reference): Git commit hashtag must not be empty"))
- ((string-match "\\`=\\(address@hidden)\\'" reference)
+ ((string-match "\\`=\\([^:address@hidden)\\'" reference)
;; =file
(git-find-file (match-string-no-properties 1 reference)))
(t (let ((case-fold-search t)
(shell-cmd-to-format (assoc-default "git"
hibtypes-social-hashtag-alist #'string-match)))
(when shell-cmd-to-format
- (cond ((string-match "\\`\\(branch\\|commit\\|tag\\)/" reference)
+ (cond ((string-match "\\`\\(=\\)\\|\\(branch\\|commit\\|tag\\)/"
reference)
;; [branch | commit | tag]/ref-item
nil)
((string-match
"\\`/?\\([^/address@hidden)/\\([0-9a-f]+\\)\\'" reference)
@@ -482,7 +500,7 @@ PROJECT value is provided, it defaults to the value of
;; the user is prompted to have it built when necessary.
(project-dir (or (and project (file-readable-p project)
(file-directory-p project) project)
(locate-dominating-file default-directory
".git"))))
- (unless (stringp project)
+ (unless (or (stringp project) (= (aref reference 0) ?=))
(unless (setq project (cond (project-dir
(file-name-nondirectory (directory-file-name project-dir)))
((stringp
hibtypes-git-default-project)
hibtypes-git-default-project)))
@@ -494,19 +512,34 @@ PROJECT value is provided, it defaults to the value of
;; All branches, commits or commit tags reference
(setq ref-type reference
reference ""))
- ((string-match "\\`\\(commit\\)/" reference)
+ ((string-match "\\`=?\\(commit\\)/" reference)
;; Specific reference preceded by keyword commit.
- (setq ref-type (substring reference 1 (match-end 1))
+ (setq ref-type "commit"
reference (substring reference (match-end 0))))
- ((string-match "\\`[0-9a-f]+\\'" reference)
+ ((string-match "\\`=?[0-9a-f]+\\'" reference)
;; Commit reference
(setq ref-type "commit"))
- (t
+ ((string-match "\\`\\(=?\\(branch\\|tag\\)/\\)\\|="
reference)
;; Specific branch or commit tag reference
- (setq ref-type "tree/")
- (when (string-match "\\`\\(branch\\|tag\\)/"
reference)
- ;; If preceded by optional keyword, remove that
from the reference.
- (setq reference (substring reference (match-end
0)))))))
+ (setq ref-type "tree"
+ reference (substring reference (match-end 0)))
+ ;; reference now might be branch-name:subpath or just
branch-name.
+ ;; (subpath by itself was handled by git-find-file up
above).
+ ;; If reference contains subpath, expand it with
hibtypes-git-find.
+ (let (branch-name
+ file
+ path)
+ (if (string-match ":" reference)
+ (setq branch-name (substring reference 0
(match-beginning 0))
+ file (substring reference (match-end 0))
+ path (hibtypes-git-find file)
+ reference (concat branch-name ":" file))
+ (setq path default-directory))
+ (setq project-dir (or project-dir (and path
(locate-dominating-file path ".git")))
+ project (or project (and project-dir
(file-name-nondirectory project-dir))
+ hibtypes-git-default-project))))
+ (t
+ (setq ref-type "tree"))))
(when (or (null project-dir) (equal project-dir ""))
(if (and project
;; Maybe the Hyperbole git project cache is
@@ -519,21 +552,26 @@ PROJECT value is provided, it defaults to the value of
(when (equal project-dir "") (setq project-dir nil))
(cond ((and project-dir (file-readable-p project-dir)
(file-directory-p project-dir))
(if reference
- ;; Display commit diffs in a help buffer
- ;; Ensure these do not invoke
with-output-to-temp-buffer a second time.
- (let ((temp-buffer-show-hook)
- (temp-buffer-show-function))
- (setq cmd
- (pcase ref-type
- ("branches" (format shell-cmd-to-format
project-dir "branch -la" ""))
- ("commits" (format shell-cmd-to-format
project-dir "log --abbrev-commit --pretty=oneline" ""))
- ("tags" (format shell-cmd-to-format
project-dir "tag -l" ""))
- (t (format shell-cmd-to-format
project-dir "show" reference))))
- (with-help-window (format "*git %s %s%s%s*"
project ref-type
- (if (not (equal
reference "")) " " "")
- reference)
- (princ (format "Command: %s\n\n" cmd))
- (princ (shell-command-to-string cmd))))
+ (if (and (equal ref-type "commits") (fboundp
'vc-print-root-log))
+ (let ((default-directory project-dir))
+ (vc-print-root-log))
+ ;; Display commit diffs in a help buffer
+ ;; Ensure these do not invoke
with-output-to-temp-buffer a second time.
+ (let ((temp-buffer-show-hook)
+ (temp-buffer-show-function))
+ (setq cmd
+ (pcase ref-type
+ ("branches" (format shell-cmd-to-format
project-dir "branch -la" ""))
+ ("commits" (format shell-cmd-to-format
project-dir "log --abbrev-commit --pretty=oneline" ""))
+ ("tags" (format shell-cmd-to-format
project-dir "tag -l" ""))
+ (t (format shell-cmd-to-format
project-dir "show" reference))))
+ (with-help-window (format "*git%s%s %s%s%s*"
+ (if (equal project
"") "" " ")
+ project ref-type
+ (if (equal reference
"") "" " ")
+ reference)
+ (princ (format "Command: %s\n\n" cmd))
+ (princ (shell-command-to-string cmd)))))
;; Project-only reference, run dired on the project
home directory
(hpath:display-buffer (dired-noselect
(file-name-as-directory
project-dir)))))
@@ -567,7 +605,7 @@ Return nil if no match is found."
(cond
;; Try to find in current directory tree first...
((and (fboundp 'locate-dominating-file)
- (setq root (locate-dominating-file default-directory "\.git"))
+ (setq root (locate-dominating-file default-directory ".git"))
(hibtypes-git-find-execute "find" root file)))
;; then in default project tree...
((and hibtypes-git-default-project
diff --git a/hversion.el b/hversion.el
index 7986148..db0092e 100644
--- a/hversion.el
+++ b/hversion.el
@@ -23,7 +23,7 @@
;;; Public variables
;;; ************************************************************************
-(defconst hyperb:version "6.0.2c" "GNU Hyperbole revision number.")
+(defconst hyperb:version "6.0.2d" "GNU Hyperbole revision number.")
;;;###autoload
(defvar hyperb:microcruft-os-p
diff --git a/hyperbole-pkg.el b/hyperbole-pkg.el
index d796c78..f4a7caf 100644
--- a/hyperbole-pkg.el
+++ b/hyperbole-pkg.el
@@ -1,5 +1,5 @@
;; -*- no-byte-compile: t -*-
-(define-package "hyperbole" "6.0.2c" "GNU Hyperbole: The Everyday Hypertextual
Information Manager"
+(define-package "hyperbole" "6.0.2d" "GNU Hyperbole: The Everyday Hypertextual
Information Manager"
'((emacs "24.4"))
:url "http://www.gnu.org/software/hyperbole";
:keywords '("comm" "convenience" "files" "frames" "hypermedia" "languages"
diff --git a/man/hyperbole.html b/man/hyperbole.html
index a6ddc4f..1c0d964 100644
--- a/man/hyperbole.html
+++ b/man/hyperbole.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
<html>
<!-- This manual is for GNU Hyperbole
-(Edition 6.0.2c, Published October 4, 2017).
+(Edition 6.0.2d, Published October 6, 2017).
Copyright (C) 1989-2016 Free Software Foundation, Inc.
@@ -322,8 +322,8 @@ WITHOUT ANY WARRANTY, without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</P>
<PRE>
-Edition 6.0.2c
-Printed October 4, 2017.
+Edition 6.0.2d
+Printed October 6, 2017.
Published by the Free Software Foundation, Inc.
Author: Bob Weiner
@@ -737,7 +737,7 @@ Next: <a href="#Buttons" accesskey="n"
rel="next">Buttons</a>, Previous: <a href
<h2 class="chapter">1 Introduction</h2>
<p>This edition of the GNU Hyperbole Manual is for use with any version
-6.0.2c or greater of GNU Hyperbole. Hyperbole runs atop GNU Emacs 24.3
+6.0.2d or greater of GNU Hyperbole. Hyperbole runs atop GNU Emacs 24.3
or higher. It will trigger an error if your Emacs is older.
</p>
<p>This chapter summarizes the structure of the rest of the manual,
diff --git a/man/hyperbole.info b/man/hyperbole.info
index 3bf76ab..7ac02ce 100644
Binary files a/man/hyperbole.info and b/man/hyperbole.info differ
diff --git a/man/hyperbole.pdf b/man/hyperbole.pdf
index cc125e8..9d6a97a 100644
Binary files a/man/hyperbole.pdf and b/man/hyperbole.pdf differ
diff --git a/man/hyperbole.texi b/man/hyperbole.texi
index a84a81b..110b99c 100644
--- a/man/hyperbole.texi
+++ b/man/hyperbole.texi
@@ -151,8 +151,8 @@ WITHOUT ANY WARRANTY, without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</P>
<PRE>
-Edition 6.0.2c
-Printed October 4, 2017.
+Edition 6.0.2d
+Printed October 6, 2017.
Published by the Free Software Foundation, Inc.
Author: Bob Weiner
@@ -176,7 +176,7 @@ Printed October 4, 2017.
@center The Everyday Hypertextual Information Manager
address@hidden Edition 6.0.2c, October 4, 2017.
address@hidden Edition 6.0.2d, October 6, 2017.
@sp 2
@noindent
@@ -444,7 +444,7 @@ Smart Keyboard Keys
@chapter Introduction
This edition of the GNU Hyperbole Manual is for use with any version
-6.0.2c or greater of GNU Hyperbole. Hyperbole runs atop GNU Emacs 24.3
+6.0.2d 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,
diff --git a/man/version.texi b/man/version.texi
index 253bec7..a7d8584 100644
--- a/man/version.texi
+++ b/man/version.texi
@@ -1,4 +1,4 @@
address@hidden UPDATED October 4, 2017
address@hidden UPDATED October 6, 2017
@set UPDATED-MONTH OCT 2017
address@hidden EDITION 6.0.2c
address@hidden VERSION 6.0.2c
address@hidden EDITION 6.0.2d
address@hidden VERSION 6.0.2d
- [elpa] externals/hyperbole 9b2d75a 53/53: Merge branch 'externals/hyperbole' of git+ssh://git.sv.gnu.org/srv/git/emacs/elpa into externals/hyperbole, (continued)
- [elpa] externals/hyperbole 9b2d75a 53/53: Merge branch 'externals/hyperbole' of git+ssh://git.sv.gnu.org/srv/git/emacs/elpa into externals/hyperbole, Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole a76d502 34/53: Hyperbole 6.0.2f pre-release, Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole 450688e 39/53: Corrected mouse-position and mouse-pixel-position to return selected frame; added key sequences with args support., Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole 55a1f04 06/53: 2017-09-18 Bob Weiner <address@hidden>, Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole ff2c292 20/53: Minor bug fixes for Koutlines; updated Hyperbole manual version, Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole 5d6b9cd 05/53: 2017-09-10 Bob Weiner <address@hidden>, Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole ce6fa24 41/53: Updated HY-NEWS with all new features for next major release., Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole 152e2be 47/53: Highlighted explicit buttons when yanked; fixed region location bugs with hmouse-drag-thing and region kill, copy and yank, Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole 8fbfc1b 35/53: Renamed @ command functions to hycontrol-windows-grid. Updated manual and DEMO with newest commands., Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole aba412a 32/53: HyControl changes: now a global minor mode; added @ window grid creation command; inverted selected mode-line for emphasis, Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole bab59c8 25/53: V6.0.2d - Improved README and added git#=branch:file implicit button syntax.,
Robert Weiner <=
- [elpa] externals/hyperbole 7503a3d 37/53: Action Mouse Key drag to modeline splits destination window before displaying the target item/buffer; added css to format Hyperbole HTML manual, Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole 1aec56c 27/53: Added drags between frames and outside Emacs, new mode-line drags, dired item drags,, Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole 2be4dd0 48/53: Fixed a bunch of small issues and released Hyperbole 7., Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole 9792af9 36/53: Added global {C-c @} binding. Fixed some mouse handling bugs. Mostly finalized DEMO and manual., Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole 671408e 38/53: Prep and bug fixes for next major release; fixed Smart Mouse Key point location issue; renamed to kotl/kotl-autoloads.el, Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole 705d254 43/53: Many bug fixes; added HyRolo DEMO section; many Hyperbole Manual updates including images, Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole 6e80e7a 30/53: V6.0.2e: Rewrote HyControl for improved generality, event handling and to support key bindings., Robert Weiner, 2017/11/15
- [elpa] externals/hyperbole caf91d4 50/53: Merge branch 'master' of http://git.savannah.gnu.org/r/hyperbole into externals/hyperbole, Robert Weiner, 2017/11/15