What's New in V9.0.1
** ACE WINDOW PACKAGE INTEGRATION - fast window and buffer switching
*** After installing the ace-window package and loading Hyperbole, execute
(hkey-ace-window-setup "\M-o") to enable the following capabilities:
*** Fast Window Links: The hkey-window-link command quickly creates links
to other windows:
{M-o w <window>} - creates an explicit button linked to point in <window>
{C-u M-o w <window>} - creates an unnamed implicit button linked to point
in <window>
{M-1 M-o w <window>} - creates a named implicit button linked to point
in <window>
See "(hyperbole)Create Link Button".
** ACTION AND ASSIST (SMART) KEYS (See "(hyperbole)Smart Keys").
*** Angle Bracket and Braces Thing Selection: In text and fundamental modes,
an Action Key press on an angle bracket or a curly brace selects the
region between a matching pair. See "(hyperbole)Smart Key Thing
Selection".
*** Drag Button Referents to Specific Windows: Just as you previously could
drag Dired or Buffer Menu items to display in a specific window, you
can now do the same with Hyperbole Buttons. Action or Assist Key drag
from a Hyperbole button and release in another window where you want
the button's referent (or the result of its action) displayed. If you
release the Smart Key outside of an Emacs window, the referent is
displayed in a new frame. See "(hyperbole)Displaying Items".
Visual pulsing of the source line and the destination buffer highlights
the transfer taking place (hmouse-pulse-flag controls this).
Dragging a button to a modeline splits the window of the modeline and
displays the referent in the leftmost or uppermost of the split windows.
*** Drag to Create Implicit Link Buttons: An Assist Mouse Key drag across
windows (when not starting from a draggable item) creates an implicit
link button with an action type determined by the referent at the point
of button release. This parallels the same Action Mouse Key drag which
creates explicit link buttons. See "(hyperbole)creating implicit
links".
Previously this drag would swap buffers in windows. Now you must drag
from open space in a modeline of the depress window to the buffer text
in the release window to swap buffers in windows.
Alternatively, with two windows in a frame, you can create an implicit
link button from point to the point of the other buffer with {C-h h i l}.
*** Hyperbole Symbol Tags: Hyperbole now includes a pre-built TAGS file so
that an Action Key press on any Hyperbole symbol jumps to its
definition without the need for any additional support. This also
works on Hyperbole type names (which have a hidden prefix) in a help
buffer where an Action Key press displays the type definition.
*** Lisp Load, Autoload and Require Expressions: Action Key press on any
named target in such expressions displays the associated library.
*** Lisp Action Button Help: Action Buttons that utilize regular Lisp
functions (rather than Hyperbole Action Types) can now have :help
functions run with a press of the Assist Key on such buttons. See
"(hyperbole)Action Buttons".
*** Smart Dired: Action Key subdirectory selection at point now works on
any dired header line, not just the first one. Use {i} to insert
multiple subdirectories in Dired mode. Smart Key end-of-line behavior
is no longer specified in Dired mode but handled globally for
consistency across modes. See "(hyperbole)Smart Key - Dired Mode".
** ACTION TYPES (See "(hyperbole)Action Types").
*** display-boolean, display-value, display-variable: Made all of these
interactive, so can be used as button actypes. See "(hyperbole)
actypes display-boolean".
*** Long Action Buttons: The length limit on action buttons has been removed
to allow for long, multi-line sexpressions.
** DOCUMENTATION
*** Hyperbole Concepts: New writeup in Koutline format for those who
want a quick read about how Hyperbole concepts all interrelate.
View it with {C-h h d c}.
*** Action Types: Add newer types and updated existing doc summaries
in the Hyperbole manual. See "(hyperbole)Action Types".
*** Doc Viewing: Updated to display many files from the Doc> menu in Org
mode, so can cycle through expanding and collapsing entries with TAB
when point is at the beginning of the buffer, allowing you to view
just the sections of interest. View minor mode is also enabled so
you can scroll forward and backward with SPC and DEL.
This includes DEMO, FAST-DEMO, HY-ABOUT, HY-NEWS and the Hyperbole
Files MANIFEST.
*** Emacs 2023 Talk Videos:
- Hyperbole Amps Up Emacs: Org slide file is included in
"HY-TALK/HYPERAMP.org" with the video at
"https://emacsconf.org/2023/talks/hyperamp/".
- Koutline for Stream of Thought Journaling: The video is at
"https://emacsconf.org/2023/talks/koutline/".
- What I learned by writing test cases for GNU Hyperbole: The video
is at "https://emacsconf.org/2023/talks/test/".
*** Emacs 2022 Talk Videos:
- Hyperbole and Org Mode: Org slide file is included in
"HY-TALK/HYPERORG.org" with the video at
"https://emacsconf.org/2022/talks/hyperorg/".
- Linking Personal Info with Implicit Buttons: The video is at
"https://emacsconf.org/2022/talks/buttons/".
- Build a Zettelkasten with HyRolo: The video is at
"https://emacsconf.org/2022/talks/rolodex/".
*** FAST-DEMO: Add ERT multiple test run
example.
*** New Menu Key Doc: Documented these Hyperbole minibuffer menu keys:
- {Q} always quits from the menu without selecting anything
- {X} both quits from the menu and disables Hyperbole minor
mode; {C-h h} re-enables it. See "(hyperbole)menu,
entry/exit commands".
*** Updated 150-page Reference Manual: Includes multiple indexes for easy
cross-referencing, Info viewer version and PDF for printing. View it:
- with the Emacs Info reader: {C-h h d i}.
- locally with a web browser: <browse-url "man/hyperbole.html">
- in pdf form: "man/hyperbole.pdf".
Some of the updates include:
**** HyRolo Searching: Update this section with doc on auto-expansion and
how to hide entries again.
**** Ibut Menu: Document in the manual, notably the new Ibut/Create menu
item. See "(hyperbole)menu, Ibut/Create". For the Ibut/Link menu
item, see "(hyperbole)menu, Ibut/Link".
**** Implicit Button Types: Add doc for 'hib-python-traceback'
and 'hyrolo-stuck-msg'. See "(hyperbole)Implicit Button Types".
**** Link Menu Items: With two windows on screen, link from source window
point to referent window point. Do a similar thing when more windows
are on screen via an Action Mouse Key drag between windows. See
"(hyperbole)Smart Mouse Drags between Windows".
**** Manual Glossary: Added Ace Window, Consult, Org Mode, and Org Roam
entries. See "(hyperbole)Glossary".
**** Smart Key - Org Mode: Expanded with doc for more extensive behavior.
See "(hyperbole)Smart Key - Org Mode".
*** README.md: Unify this as the only readme file and remove "README".
** EXPLICIT BUTTONS (See "(hyperbole)Explicit Buttons").
*** Ebut/Link Menu Item {C-h h e l}: Inserts a named ebutton that links to
point in another window. See "(hyperbole)menu item, Ebut/Link".
** GLOBAL BUTTONS (See "(hyperbole)Global Buttons").
*** Gbut/Link Menu Item: A single name creates a new global link button
to point. See "(hyperbole)menu item, Gbut/Link".
*** Auto Save: Automatically save the global button file after any edit.
** HYCONTROL (See "(hyperbole)HyControl").
*** I/J/K/M Key Bindings: In Window Control mode, move directionally
(based on QUERTY keyboard layout) among windows in the selected frame.
In Frame Control mode, move directionally among active frames. These
keys utilize and prompt to install the windmove and framemove packages
if not installed. See "(hyperbole)I/J/K/M".
** HYPERBOLE SYSTEM (See "(hyperbole)").
*** Any Colorized Display: Face display and colorization of Hyperbole
buttons now works on any display capable of displaying colors. See
"(hyperbole)Button Colors".
*** Create Buttons in Current Buffer: Stop prompting for a source buffer
when creating a Hyperbole button. Always use the current buffer and
point. See "(hyperbole)Creation".
*** DuckDuckGo Web Search: {C-h h f w k} runs a DuckDuckGo web search.
*** Hyperbole Keys Defer to Current Modes: Hyperbole bindings of {C-c RET},
{C-c .}, {C-c @}, and {C-c /} defer to any major mode, like org-mode,
outline-mode or kotl-mode that binds them to other commands. This also
works for outline-minor-mode.
*** Improved Button Help: {C-h A} now says whether a button is explicit or
implicit. For implicit buttons, it displays the doc from both its
implicit button type and its associated action type.
{C-h A} now also works on Emacs push-buttons and text property
buttons, displaying their attributes and associated action. See
"(hyperbole)Smart Key help".
*** Flymake Lint Warning Display: The new "hsys-flymake" library provides
commands to display the flymake warning at point as well as the full list
of warnings for the current buffer. See "(hyperbole)Smart Key - Flymake
Mode" for details.
*** Makefile (eln): Use echo target for showing build info as part of the
eln build.
(echo): Show Emacs location and version in build environment
info.
(lint): Use "package-lint" to lint Hyperbole source code.
*** mhtml-mode Markup Selection: Hyperbole's matching markup pair selection,
copying and movement now works with Emacs' builtin mhtml-mode. See
"(hyperbole)HTML tag pair".
*** Native Compilation: Hyperbole now may be natively compiled (.eln files).
It works around an Emacs bug where async native comp of a package being
installed does not load "hyperbole-autoloads.el". When building
Hyperbole without a package manager, 'make eln' now builds it natively.
*** Natively Compiled Functions as Action Types: Now may be used as
Hyperbole button action types. See "(hyperbole)Action Types".
*** Warnings Removed: Almost all byte-compiler and native compiler warnings
have been eliminated when building the Hyperbole package. None of the
remaining warnings should affect use of Hyperbole. Most open Hyperbole
issues have also been resolved.
*** XEmacs: Removed old XEmacs-compatibility code; everyone should use GNU
Emacs nowadays.
** HYROLO (See "(hyperbole)HyRolo").
*** Koutline and Markdown File Support: The hyrolo-file-list' can now contain Koutline or Markdown files and will search their outline entries just like it does for Org and Emacs outline files. The markdown-mode'
package will be auto-installed if a Markdown file is searched by HyRolo.
See "(hyperbole)HyRolo Concepts".
*** hyrolo-file-list Support for File Wildcards, Variables and Dirs:
The `hyrolo-file-list' variable that HyRolo uses to determine the files
to search for pattern matches may not contain file patterns itself.
If you include file wildcards in pathnames and `find-file-wildcards' is
non-nil (the default), they will be expanded into matching files
internally by HyRolo. See "(emacs)Wildcards".
If you include an Environment variable or Emacs Lisp variable with the
${var} format in a path, it will be resolved prior to searching the path.
Variables with values that include multiple paths, e.g. PATH, are resolved
to the first existing entry that matches. See "(hyperbole)pathname".
If you include an existing directory (invalid ones are ignored) in your
hyrolo list, hyrolo will search recursively across all of its files
that match `hyrolo-file-suffix-regexp'. See `hpath.el#hpath:expand-list'.
HyRolo will display a detailed error list if any invalid file type is
included in the `hyrolo-file-list' after expansion. See
`hyrolo-any-file-type-problem-p'.
*** HyRolo Match Buffer Key Bindings:
Improved movement keys:
- {TAB} Move to next search match; works across all supported file types
- {b} Move backward at the same outline level
- {f} Move forward at the same outline level
- {n} Move to the next visible outline heading
- {p} Move to the previous visible outline heading
- {u} Move up a heading level
- {,} Move to the beginning of the current entry
- {.} Move to the end of the current entry
- {[} Move to previous @loc> line of previous file header
- {]} Move to next @loc> line of next file header
Improved hide/show commands now work when in file headers:
- {h} Hide the rest of the file header and matches after this line
- {s} Show all of the file header and matches
See "(hyperbole)HyRolo Keys".
*** Koutline Fast Search: Koutlines may now be included in `hyrolo-file-list'
and individual cells extracted properly with any HyRolo query. Then the
interactive commands:
{t} show the top-level (highest matching level) matches
{o} show an outline of matches
{s} show/expand current match
{h} hide current match
{f/b/n/p} move to another match
all work on Koutline cells displayed in the match buffer. See
"(hyperbole)HyRolo Concepts".
*** Match Buffer Name Change: Changed match buffer name from "Hyperbole
Rolo" to "HyRolo".
*** Auto-Expand Hidden Text: Whenever point moves into a hidden/invisible part
of the HyRolo buffer, the entire tree of entries below that point is
auto-expanded/shown. Presently, there is no auto-hide functionality.
You must press {h} to hide entries or an entire file of matches when in
the file header.
*** Editing Entries Jumps to Current Position: The {e} command in the HyRolo
match buffer now lets you edit the current point within the entry's source
buffer, rather than jumping to the start of the entry.
*** New HyRolo menu items ConsultFind and HelmFind: These appear when you
independently load the consult' or helm-org-rifle' package.
These menu items then use the related interactive search functions to
search over the HyRolo file list.
ConsultFind utilizes `consult-ripgrep' or `consult-grep'. HelmFind uses
the helm-org-rifle package and searches over .org and .otl files
exclusively. See "(hyperbole)ConsultFind".
*** .otl and .outl Suffixed Files: Setup to auto-invoke `outline-mode'.
*** hyrolo-date-format Empty String: Setting this variable to an empty string
will disable adding and updating modification dates in HyRolo entries.
*** hyrolo-hdr-and-entry-regexp: Rename to 'hyrolo-hdr-and-entry-regexp' and
in 'hyrolo-mode' extend its value to include all multiple trailing whitespace
chars after the entry delimiter.
Make variable `hyrolo-entry-regexp' which does not match to file headers.
** IMPLICIT BUTTONS (See "(hyperbole)Implicit Buttons").
*** Action Button Result Display: Action buttons now display in the
minibuffer the result of evaluating any type of action expression,
using Lisp readable values.
*** Compilation and Grep Error Lines: Error lines in the Emacs Regression
Test buffer, ert, are now supported, as well as the 'Compiling
', 'Loading ' and 'In ' lines as well as source
line references from Emacs Lisp native compilation within the
Async-native-compile-log buffer.
Added support for ERT "Test <symbol>" lines to jump to the def of the
symbol and for symbol and pathname references from backtraces in ERT
output.
Added jumping to the referenced location from Ruby traceback stack
messages.
*** Emacs Regression Test Runs: New 'hyperbole-run-test-definition' implicit
button type defined in "hypb-ert.el". An Action Key press on the first
line of an ert test definition (ert-deftest) within the test name,
evaluates the definition and runs the test; this ensures that the latest
version is always run. An Assist Key press does likewise but runs the
test with edebug, stepping through it. This also works for tests defined
with `ert-deftest-async' from the "ert-async" package. See also "#Action
Link Types to Run Tests".
With the optional package, "ert-results", the Smart Keys can be used
within the ERT results buffer to filter the display and to show the
documentation for each test. See "(hyperbole)Smart Key - ERT Results
Mode".
*** Highlighting of Ibut Names: New property:ibut-face' used to highlight any <[name]> prefixing an implicit button. All hproperty functions now support this face as well as the hproperty:but-face' used for explicit
buttons.
*** Info Nodes: Better handling of embedded double quotes and added support
for HTML " quoting.
*** Improved # and Embedded Space Path Handling: If a path exists, don't
treat its # hash marks as section markers, notably for #autosave# files.
Allow for unquoted filenames with spaces in them in ls listings in shell
buffers (assume files are tab-delimited).
*** Ibut/Create Menu Item {C-h h i c}: Creates a named/labeled implicit
button of any type. Separates the name and the implicit button with
" - ". See "(hyperbole)menu item, Ibut/Create".
*** Ibut/Link Menu Item {C-h h i l} - Inserts an ibutton that links to point
in another window. With a C-u prefix argument, prompts for a name as
well. See "(hyperbole)menu item, Ibut/Link".
*** Jump to Lisp Identifier Definition in More Buffers: Lisp identifiers are
now recognized as programming etags in the Warnings byte-compilation
buffer and in Flymake log and diagnostics buffers.
*** Path Implicit Buttons: Much improved relative path handling, including
expanding into executable paths when pathname is prefixed by ! or &,
and handling info paths outside `Info-directory-list', like
"man/hyperbole.info". Also, prioritize 'load-path' and 'exec-path' above
'Info-directory-list' within 'hpath:variables' when expanding pathnames.
Remove outdated 'Info-directory' from 'hpath:variables' as well.
Automatically invoke `outline-mode' on files with ".outl" suffix;
previously, only ".otl" suffixes did this.
*** Read-only Context Errors: Trigger errors when trying to create an
implicit button with point on read-only text, read-only Org contexts,
explicit buttons, or emacs push-buttons.
*** Relative Info Paths: Info files with relative pathnames outside of the
`Info-directory-list' now resolve properly, e.g. "man/hyperbole.info".
*** Table of Contents Sections: Hyperbole now recognizes TOCs in any text
derived major mode with the text-toc implicit button type. An Action
Key press on a line with a section name displays the section according
to the Hyperbole referent display setting, typically leaving the TOC
untouched in the selected window. This also works in Internet standard
RFC buffers.
*** Youtube Snippet Links: Compact Action Buttons to play parts or whole
Youtube videos and to search for videos by keyword. See
"hsys-youtube.el".
** KOUTLINER (See "(hyperbole)Koutliner").
*** New Klink Format: Hash character, #, may now be used to separate a
pathname from a Koutline cell reference. Both <koutline-path#cell-ref> and
"koutline-path#cell-ref" work, e.g. "${hyperb:dir}/kotl/EXAMPLE.kotl#2a"
*** Link to Cell Headings: A cell heading is a string at the beginning of the
editable portion of a cell that ends with a colon or a newline. Links
to complete heading names now work: "${hyperb:dir}/kotl/EXAMPLE.kotl#Klinks"
*** {M-S-} and {M-S-}: Org compatibility - Add tree promote and
demote commands to these keys (same as existing {M-} and
{M-} keys). See "(hyperbole)Promoting and Demoting".
*** {C-c s} Deletes Surrounding Whitespace: When a cell is split, it now deletes
surrounding whitespace before performing the split.
*** Star Outline Import Indented Headings: Added support for Emacs/Org
star-based headings whose stars do not start at the beginning of a line,
i.e. are indented. See "(hyperbole)Inserting and Importing".
*** Transpose Lines Down: Add 'kotl-mode:transpose-lines-down' command.
** MENUS (See "(hyperbole)Menus").
*** Minibuffer Menu Changes:
- Instant Link Creation:
Ebut/Link - Inserts a named ebutton that links to point in another
window. See "(hyperbole)menu item, Ebut/Link".
Gbut/Link - A single name creates a new global link button to point.
See "(hyperbole)menu item, Gbut/Link".
Ibut/Link - Inserts an ibutton that links to point in another window.
With a C-u prefix argument, prompts for a name as well. See
"(hyperbole)menu item, Ibut/Link".
- Reload Menus and Smart Keys: Action Key press on top-level menu prefix
reloads Hyperbole minibuffer menus and Smart Key handlers to reflect
any recent edits.
- Multi-line Menus: When a menu line is too long for the screen, it is
automatically split into multiple lines and aligned by column for
ease of access.
*** Move Prefix Arg Number of Items: {M-b} and {M-f} move backward and
forward by the number of items specified by any given prefix argument,
as do {TAB} and {Shift-TAB}. See "(hyperbole)minibuffer menu".
** ORG MODE INTEGRATION (See "(hyperbole)Smart Key - Org Mode").
*** Automatic Fix of Mixed Org Versions: Loading Hyperbole (via its
hyperb:init' function) automatically detects and resolves the hard-to-fix problem when some older builtin Org libraries are loaded before a newer version of the Org package is loaded. The fix utilizes libraries exclusively from the newer Org package. See the doc for hsys-org-fix-version'.
*** Org Links Outside Org Buffers: The `org-link' actype now opens links
found inside and outside of Org buffers.
*** Interactive Org Directory Consult Grep: {M-x hsys-org-consult-grep
RET} interactively greps your `org-directory' files with live in-buffer
display as you move through matching lines.
*** Interactive Org-Roam DB Consult Grep: {M-x hsys-org-roam-consult-grep
RET} interactively greps org-roam files with live in-buffer display as
you move through matching lines. It uses the automatically installed
consult-org-roam package when invoked. See
"(hyperbole)hsys-org-roam-consult-grep".
*** Org and Org Roam IDs: New org-id' implicit button type and link-to-org-id-marker' action type that jump to the referent of an Org
ID or Org Roam ID at point. If a marker does not yet exist, there is
the `link-to-org-id' action type. An Action Key drag across windows
ending at an Org ID will create a link button with this last action
type, which will jump to the ID's definition regardless of whether the
link was to the definition or a reference. See "(hyperbole) ibtypes
org-id".
*** Org Code Blocks: On a header :dir directory, the Action Key displays
that directory in dired. The Assist Key anywhere in the header removes
any results for the code block. Smart Keys work the same when on a
#+RESULTS header as when on a code source header. Smart Key tag
lookup now works in Org code blocks. Smart Keys on Org internal
targets now work just as they do on radio button targets.
*** HyRolo Integration with Org 9.7 and Up: Support "org-fold.el" and other
newer features fo Org mode.
*** Todo Cycling: An Action Key press on an Org mode todo state keyword,
cycles to the next state. An Assist Key press in the same place cycles
to the next set of states, if any.
*** Bobp Hyperbole Doc File Cycling: Allow for org global cycling at the start
of a buffer on a non-heading line within Hyperbole Doc/ files when displayed
from Hyperbole menu items.
*** {C-c /}: The Hyperbole {C-c /} web search binding defers to the org-mode
binding, org-show-todo-tree', when in Org mode, but uses the improved Hyperbole command version, hsys-org-todo-occur', which allows filtering
to specific todo states.
** TEST CASES (See "${hyperb:dir}/test").
*** Hyperbole Automated Testing: Over 400 automated test cases. Simply run
'make test-all' or 'make test' from the command-line when in the
Hyperbole source directory and you should see all tests pass. If any
fail, you can press the Action Key to see the source of the failure.
Full testing is supported under POSIX systems only. See "Makefile" and
"test/MANIFEST".
*** The Hyperbole team's CI/CD process automatically runs all test cases
against Emacs major versions 27, 28 and 29 and the current master
branch tip whenever a Hyperbole code change is checked in against git.
*** ERT Test Case Symbols Jump to Definition: In Elisp and Lisp interaction
buffers, the Action Key jumps to the definition of any such symbol while
the Assist Key displays the symbol's documentation. This requires that
a TAGS table be built in the project root directory with the following
etags command-line option:
etags --regex={lisp}'/(ert-deftest[ \t]+([^ \t\n\r\f()]+)/'
For the Hyperbole source code itself, you can do this via 'make tags' from
within the Hyperbole source directory, `hyperb:dir'.
*** Run Hyperbole Tests via Make: Use the 'test' target and provide a pattern
of test names to match like so:
make test test=hyrolo
to run just the HyRolo associated tests.
To enable, full backtraces and not truncated ones, add 'FULL_BT=' at the end:
make test test=hyrolo FULL_BT=
*** QA: Many quality improvements across Hyperbole and integration with
Emacs updates with backward compatibility from Emacs 27 through Emacs
29 releases.
** WINDOW GRIDS (See "(hyperbole)grid of windows").
*** Grid by File Pattern: Fixed so prompt for a string pattern rather than
a file name and forced use of full pathnames to avoid improper relative
path resolution.
Updated to use prefix arg as grid size or to autosize when not given or
given an invalid value.
See "(hyperbole)hycontrol-windows-grid-by-file-pattern".
Full Changelog: hyperbole-8.0.2pre...hyperbole-9.0.1