Skip to content

man/hyperbole.texi, README.md - Complete HyWiki and install doc; hycontrol.el - Improve cmd prompt layout and handle zoom reset errs #1000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rswgnu merged 4 commits into from
Jul 7, 2026
Merged

man/hyperbole.texi, README.md - Complete HyWiki and install doc; hycontrol.el - Improve cmd prompt layout and handle zoom reset errs #1000

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e01c187
hycontrol.el - Improve cmd prompt layout and handle zoom reset errs
rswgnu Jul 5, 2026
0d62fbe
man/hyperbole.texi, README.md - Complete HyWiki and install doc
rswgnu Jul 7, 2026
c024330
test/hywiki-*.el - Minor HyWiki test improvements
rswgnu Jul 7, 2026
72aaf85
Merge branch 'master' into rsw
rswgnu Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions ChangeLog
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
2026-07-06 Bob Weiner <rsw@gnu.org>

* man/hyperbole.texi (HyWiki): Finish HyWiki manual chapter.
(Elpa In-Development Package Installation): Move before
Elpa Stable given long full release cycles.
(Installation): Add optional (hywiki-mode :all) config.

2026-07-04 Bob Weiner <rsw@gnu.org>

* hycontrol.el (hycontrol-frame-zoom-reset): Handle 'frame not zoomed'
error by displaying a message instead to preven leaving HyControl mode.
(hycontrol--frames-prompt-format, hycontrol--windows-prompt-format):
Reformat for easier readability.

2026-06-30 Mats Lidell <matsl@gnu.org>

* test/hywiki-tests.el (hywiki-display-hywiki-test): Add helper
Expand All @@ -7,6 +21,10 @@

2026-06-30 Bob Weiner <rsw@gnu.org>

* FAST-DEMO: Add link to EmacsATX unscripted demo of Hyperbole.

* man/hyperbole.texi (HyRolo): Add examples of non-contact management usage.

* hui-mini.el (hui:menu-maybe-highlight-item-keys): Fix that in
column layout mode, items in the first column on 2nd and succeeding
lines did not have the first capital letter highlighted because were
Expand Down
62 changes: 33 additions & 29 deletions FAST-DEMO
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@





* GNU Hyperbole Fast Demo by Bob Weiner

Send an email or a testimonial if you like Hyperbole to <rsw@gnu.org>.
Expand Down Expand Up @@ -55,35 +57,37 @@

** Hyperbole Videos

|-----------------------------------------------------+------------------------------|
| GNU Hyperbole Videos | Web Links |
|-----------------------------------------------------+------------------------------|
|-----------------------------------------------------+------------------------------|
| <[Overview and Demo]> | https://youtu.be/WKwZHSbHmPg |
| Sections broken out in the prior table | |
|-----------------------------------------------------+------------------------------|
| <[Quick Introduction]> | https://youtu.be/K1MNUctggwI |
|-----------------------------------------------------+------------------------------|
| <[Top 10 ways Hyperbole amps up Emacs]> | https://youtu.be/BysjfL25Nlc |
|-----------------------------------------------------+------------------------------|
| <[Introduction to Buttons]> | https://youtu.be/zoEht66N2PI |
|-----------------------------------------------------+------------------------------|
| <[Linking Personal Info with Implicit Buttons]> | https://youtu.be/TQ_fG7b1iHI |
|-----------------------------------------------------+------------------------------|
| <[Powerful Productivity with Hyperbole and Org]> | https://youtu.be/BrTpTNEXMyY |
|-----------------------------------------------------+------------------------------|
| <[HyRolo, fast contact/hierarchical record viewer]> | https://youtu.be/xdJGFdgKPFY |
|-----------------------------------------------------+------------------------------|
| <[Using Koutline for stream of thought journaling]> | https://youtu.be/dO-gv898Vmg |
|-----------------------------------------------------+------------------------------|
| <[Build a Zettelkasten with HyRolo]> | https://youtu.be/HdlCK9w-LyQ |
|-----------------------------------------------------+------------------------------|
| <[HyControl, fast Emacs frame and window manager]> | https://youtu.be/M3-aMh1ccJk |
|-----------------------------------------------------+------------------------------|
| <[Writing test cases for GNU Hyperbole]> | https://youtu.be/maNQSKxXIzI |
|-----------------------------------------------------+------------------------------|
| <[Find/Web Search]> | https://youtu.be/8lMlJed0-OM |
|-----------------------------------------------------+------------------------------|
|-----------------------------------------------------+-----------------------------------------|
| GNU Hyperbole Videos | Web Links |
|-----------------------------------------------------+-----------------------------------------|
|-----------------------------------------------------+-----------------------------------------|
| <[Overview and Demo]> | https://youtu.be/WKwZHSbHmPg |
| Sections broken out in the prior table | |
|-----------------------------------------------------+-----------------------------------------|
| <[Unscripted Hyperbole Demo at EmacsATX]> | <yt-play "iuwn8GpRj7w" "0:48" "32:42"> |
|-----------------------------------------------------+-----------------------------------------|
| <[Quick Introduction]> | https://youtu.be/K1MNUctggwI |
|-----------------------------------------------------+-----------------------------------------|
| <[Top 10 ways Hyperbole amps up Emacs]> | https://youtu.be/BysjfL25Nlc |
|-----------------------------------------------------+-----------------------------------------|
| <[Introduction to Buttons]> | https://youtu.be/zoEht66N2PI |
|-----------------------------------------------------+-----------------------------------------|
| <[Linking Personal Info with Implicit Buttons]> | https://youtu.be/TQ_fG7b1iHI |
|-----------------------------------------------------+-----------------------------------------|
| <[Powerful Productivity with Hyperbole and Org]> | https://youtu.be/BrTpTNEXMyY |
|-----------------------------------------------------+-----------------------------------------|
| <[HyRolo, fast contact/hierarchical record viewer]> | https://youtu.be/xdJGFdgKPFY |
|-----------------------------------------------------+-----------------------------------------|
| <[Using Koutline for stream of thought journaling]> | https://youtu.be/dO-gv898Vmg |
|-----------------------------------------------------+-----------------------------------------|
| <[Build a Zettelkasten with HyRolo]> | https://youtu.be/HdlCK9w-LyQ |
|-----------------------------------------------------+-----------------------------------------|
| <[HyControl, fast Emacs frame and window manager]> | https://youtu.be/M3-aMh1ccJk |
|-----------------------------------------------------+-----------------------------------------|
| <[Writing test cases for GNU Hyperbole]> | https://youtu.be/maNQSKxXIzI |
|-----------------------------------------------------+-----------------------------------------|
| <[Find/Web Search]> | https://youtu.be/8lMlJed0-OM |
|-----------------------------------------------------+-----------------------------------------|


* Introduction
Expand Down
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ otherwise, skip to the next section.
Long video that covers most of Hyperbole;
Hyperlink timestamps to watch each section

- [Unscripted Hyperbole Demo at EmacsATX](https://youtu.be/iuwn8GpRj7w)
On-the-fly demo of Hyperbole subsystems, showing broad capabilities and
how it differs from Org mode. Watch demo from timestamps: 00:48 to 32:42.

- [Quick Introduction](https://youtu.be/K1MNUctggwI)

- [Top 10 ways Hyperbole amps up Emacs](https://emacsconf.org/2023/talks/hyperamp/)
Expand Down Expand Up @@ -215,6 +219,9 @@ Below are the lines to add:
(package-refresh-contents)
(package-install 'hyperbole))
(hyperbole-mode 1)
;; Allow HyWikiWords in text buffers and programming buffer comments
;; by uncommenting the next line.
;; (hywiki-mode :all)

----

Expand Down
80 changes: 43 additions & 37 deletions README.md.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
<li><a href="#summary">Summary</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#invocation">Invocation</a></li>
<li><a href="#hyperbole-manual">Hyperbole Manual</a></li>
<li><a href="#mailing-lists">Mailing Lists</a></li>
<li><a href="#ftp-and-git-repository-downloads">Ftp and Git Repository
Downloads</a></li>
Expand Down Expand Up @@ -53,6 +54,10 @@ <h2 id="videos">Videos</h2>
<li><p><a href="https://youtu.be/WKwZHSbHmPg">Overview and Demo</a> Long
video that covers most of Hyperbole; Hyperlink timestamps to watch each
section</p></li>
<li><p><a href="https://youtu.be/iuwn8GpRj7w">Unscripted Hyperbole Demo
at EmacsATX</a> On-the-fly demo of Hyperbole subsystems, showing broad
capabilities and how it differs from Org mode. Watch demo from
timestamps: 00:48 to 32:42.</p></li>
<li><p><a href="https://youtu.be/K1MNUctggwI">Quick
Introduction</a></p></li>
<li><p><a href="https://emacsconf.org/2023/talks/hyperamp/">Top 10 ways
Expand Down Expand Up @@ -80,6 +85,8 @@ <h2 id="videos">Videos</h2>
</ul>
<h2 id="articles">Articles</h2>
<ul>
<li><p><a href="https://mike.hostetlerhome.com/emacs-hyperbole">The
Emacs Hyperbole</a></p></li>
<li><p><a href="https://kirankp.com/blog/gnu-hyperbole/">HyWiki: My
Favorite Part of Hyperbole</a></p></li>
<li><p><a
Expand Down Expand Up @@ -233,7 +240,10 @@ <h2 id="installation">Installation</h2>
(unless (package-installed-p &#39;hyperbole)
(package-refresh-contents)
(package-install &#39;hyperbole))
(hyperbole-mode 1)</code></pre>
(hyperbole-mode 1)
;; Allow HyWikiWords in text buffers and programming buffer comments
;; by uncommenting the next line.
;; (hywiki-mode :all)</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
Expand Down Expand Up @@ -277,10 +287,9 @@ <h2 id="hyperbole-manual">Hyperbole Manual</h2>
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 version<br />
<a href="man/hyperbole.pdf">hyperbole.pdf</a> - printable version<br />
<a href="man/hyperbole.texi">hyperbole.texi</a> - source version</p>
version <a href="man/hyperbole.html">hyperbole.html</a> - web version <a
href="man/hyperbole.pdf">hyperbole.pdf</a> - printable version <a
href="man/hyperbole.texi">hyperbole.texi</a> - source version</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
Expand Down Expand Up @@ -443,33 +452,30 @@ <h2 id="important-features">Important Features</h2>
<h2 id="hyperbole-uses">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>
<li><p><em>Personal Information Management</em> 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>
<li><p><em>Documentation Browsing</em> 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>Brainstorming</em> 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> 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> 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>
<p>See the <a href="HY-ABOUT">HY-ABOUT</a> file for a description and
Expand Down Expand Up @@ -519,13 +525,13 @@ <h2 id="user-quotes">User Quotes</h2>
<p>Hyperbole is a wonderful package, I love the feeling of the deep,
well-thought out, poised engineering. It may be from the 90s, but it
feels like a breath of fresh air to me.</p>
<pre><code> -- de_sonnaz on reddit </code></pre>
<pre><code> -- de_sonnaz on reddit</code></pre>
<p>*** MAN I love Hyperbole!!! Wow! ***</p>
<pre><code> -- Ken Olstad
<pre><code> -- Ken Olstad
Cheyenne Software, Inc.</code></pre>
<hr />
<p>I <em>love</em> koutlines.</p>
<pre><code> -- Bob Glickstein
<pre><code> -- Bob Glickstein
Z-Code Software Corporation</code></pre>
<hr />
<p>One of the nicest things about Hyperbole is that it's available
Expand All @@ -542,7 +548,7 @@ <h2 id="user-quotes">User Quotes</h2>
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>
<pre><code> -- Aditya Siram</code></pre>
<hr />
<p>GNU Hyperbole is a game-changer for your mental model of information
management and personal productivity. Even if you don't use it you
Expand Down Expand Up @@ -573,7 +579,7 @@ <h2 id="user-quotes">User Quotes</h2>
Client6502 opens the relevant conversation. Hyperbole provides a really
useful set of power tools. If Emacs is your preferred productivity
environment, it's definitely worth getting familiar with it.</p>
<pre><code> -- Chris Nuzum
<pre><code> -- Chris Nuzum
Co-founder, Traction Softwarea, Inc.</code></pre>
<hr />
<p>I've found Hyperbole (in conjunction with XEmacs) to be very useful
Expand All @@ -586,7 +592,7 @@ <h2 id="user-quotes">User Quotes</h2>
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
<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
Expand All @@ -602,7 +608,7 @@ <h2 id="user-quotes">User Quotes</h2>
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
<pre><code> -- TV Raman
Google Inc.</code></pre></li>
</ol>
<hr />
Expand All @@ -622,7 +628,7 @@ <h2 id="user-quotes">User Quotes</h2>
<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>
<pre><code> -- Ken Olstad
<pre><code> -- Ken Olstad
Cheyenne Software, Inc.</code></pre>
<hr />
<p>In general, Hyperbole is an embeddable, highly extensible hypertext
Expand Down Expand Up @@ -654,7 +660,7 @@ <h2 id="user-quotes">User Quotes</h2>
<li><p>Other desktop organization tasks: including links to various mail
folders, saved newsgroup conversation threads, online note-taker,
emacs-command invocations, etc.</p>
<pre><code> -- Dadong Wan
<pre><code> -- Dadong Wan
University of Hawaii</code></pre></li>
</ul>
<hr />
Expand All @@ -666,18 +672,18 @@ <h2 id="user-quotes">User Quotes</h2>
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
<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>
<pre><code> -- Jeff Fried
<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>
<pre><code> -- Craig Smith </code></pre>
<pre><code> -- Craig Smith</code></pre>
<h2 id="why-was-hyperbole-developed">Why was Hyperbole developed?</h2>
<p>Hyperbole was originally designed to aid in research aimed at
Personalized Information production/retrieval Environments (PIEs).
Expand Down
Loading