diff --git a/README.md.html b/README.md.html index 652d3c2a..2bbe44a0 100644 --- a/README.md.html +++ b/README.md.html @@ -5,35 +5,9 @@ look here.]

[We work on Hyperbole as a gift to the Emacs community and request you send us a thank you or a testimonial describing your usage if you -like Hyperbole to rsw@gnu.org].

- +like Hyperbole to rsw@gnu.org].

+

[TOC]

Hyperbole screenshot of the Koutliner, DEMO file and HyRolo

Reference Manual

diff --git a/README.toc.md b/README.toc.md index 06944880..5a387fb0 100644 --- a/README.toc.md +++ b/README.toc.md @@ -7,28 +7,7 @@ send us a thank you or a testimonial describing your usage if you like Hyperbole to [rsw@gnu.org](mailto:rsw@gnu.org)]. - - -- [GNU Hyperbole 9.1.0 - The Everyday Hypertextual Information Manager](#gnu-hyperbole-902pre---the-everyday-hypertextual-information-manager) - - [Reference Manual](#reference-manual) - - [Videos](#videos) - - [Articles](#articles) - - [Summary](#summary) - - [Installation](#installation) - - [Invocation](#invocation) - - [Hyperbole Manual](#hyperbole-manual) - - [Mailing Lists](#mailing-lists) - - [Ftp and Git Repository Downloads](#ftp-and-git-repository-downloads) - - [Hyperbole Components](#hyperbole-components) - - [Hyperbole Buttons](#hyperbole-buttons) - - [Important Features](#important-features) - - [Hyperbole Uses](#hyperbole-uses) - - [Files](#files) - - [Programmer Quick Reference](#programmer-quick-reference) - - [User Quotes](#user-quotes) - - [Why was Hyperbole developed?](#why-was-hyperbole-developed) - - +[TOC] ![Hyperbole screenshot of the Koutliner, DEMO file and HyRolo](man/im/hyperbole-cv.png) diff --git a/install-test/elpa-devel-emacs b/install-test/elpa-devel-emacs index 95c735eb..580fa8ef 100644 --- a/install-test/elpa-devel-emacs +++ b/install-test/elpa-devel-emacs @@ -3,6 +3,9 @@ (require 'package) (add-to-list 'package-archives '("gnu-devel" . "https://elpa.gnu.org/devel/")) +(when (version< emacs-version "29") + (package-install 'use-package)) + (unless (locate-library "hyperbole") (package-install 'hyperbole)) diff --git a/install-test/elpa-emacs b/install-test/elpa-emacs index 6539dfac..989c7005 100644 --- a/install-test/elpa-emacs +++ b/install-test/elpa-emacs @@ -1,6 +1,10 @@ ;;; -*- mode: emacs-lisp; lexical-binding: t; -*- (require 'package) + +(when (version< emacs-version "29") + (package-install 'use-package)) + (unless (locate-library "hyperbole") (package-install 'hyperbole)) diff --git a/install-test/install-test.sh b/install-test/install-test.sh index e2448cfd..93d1413b 100755 --- a/install-test/install-test.sh +++ b/install-test/install-test.sh @@ -40,4 +40,7 @@ else fi # Debug - after install -[[ -n "$debug" ]] && bash +if [[ -n "$debug" ]] +then + bash +fi diff --git a/install-test/melpa-releases-emacs b/install-test/melpa-releases-emacs index a6cb1599..f5dfff77 100644 --- a/install-test/melpa-releases-emacs +++ b/install-test/melpa-releases-emacs @@ -4,6 +4,9 @@ (add-to-list 'package-archives '("melpa-releases" . "https://releases.melpa.org/packages/")) (setq package-pinned-packages '((hyperbole . "melpa-releases"))) +(when (version< emacs-version "29") + (package-install 'use-package)) + (unless (locate-library "hyperbole") (package-install 'hyperbole)) diff --git a/install-test/melpa-snapshots-emacs b/install-test/melpa-snapshots-emacs index 6d003dc7..ccad0b79 100644 --- a/install-test/melpa-snapshots-emacs +++ b/install-test/melpa-snapshots-emacs @@ -2,6 +2,10 @@ (require 'package) (add-to-list 'package-archives '("melpa-snapshots" . "https://snapshots.melpa.org/packages/")) + +(when (version< emacs-version "29") + (package-install 'use-package)) + (setq package-pinned-packages '((hyperbole . "melpa-snapshots"))) (unless (locate-library "hyperbole") diff --git a/install-test/straight-emacs b/install-test/straight-emacs index a5cdaf96..6d979208 100644 --- a/install-test/straight-emacs +++ b/install-test/straight-emacs @@ -20,4 +20,7 @@ :host nil :repo "https://git.savannah.gnu.org/git/hyperbole.git")) +(when (version< emacs-version "29") + (straight-use-package 'use-package)) + ;;; End straight-emacs diff --git a/install-test/tarball-emacs b/install-test/tarball-emacs index 30c6f700..aef21138 100644 --- a/install-test/tarball-emacs +++ b/install-test/tarball-emacs @@ -1,6 +1,11 @@ ;;; -*- mode: emacs-lisp; lexical-binding: t; -*- ;; tarball -- hyperbole installed from a tar ball +(require 'package) + +(when (version< emacs-version "29") + (package-install 'use-package)) + (unless (and (featurep 'hyperbole) hyperbole-mode) (push (expand-file-name "hyperbole" (getenv "HOME")) load-path) (require 'hyperbole) diff --git a/man/hy-package.el b/man/hy-package.el deleted file mode 100644 index 0e51d47a..00000000 --- a/man/hy-package.el +++ /dev/null @@ -1,100 +0,0 @@ -;;; hy-package.el --- Hyperbole package.el installation and configuration instructions -*- lexical-binding: t; -*- -;; -;; Author: Bob Weiner -;; -;; Orig-Date: 15-Jul-26 at 12:28:58 -;; Last-Mod: 25-Jul-26 at 22:25:11 by Mats Lidell -;; -;; SPDX-License-Identifier: GPL-3.0-or-later -;; -;; Copyright (C) 2026 Free Software Foundation, Inc. -;; See the "../HY-COPY" file for license information. -;; -;; This file is part of GNU Hyperbole. - -;;; ************************************************************************ -;;; Requirements -;;; ************************************************************************ - -(require 'package) - -;;; ************************************************************************ -;;; Section 1: package.el setup -;;; ************************************************************************ - -;;; ======================================================================== -;;; NOTE: This section is only if you have not yet setup the package.el -;;; package manager. If you have, ignore this and skip to "#Section 2" -;;; for the Hyperbole `use-package' recipe. -;;; ======================================================================== - -;; Step 1: Add the function definition below near the top of your -;; "~/.emacs" or "~/.emacs.d/early-init.el" file. - -;; Step 2: Add a call to the function below its definition: -;; (setup-package) - -(defun setup-package () - (require 'package) - (setq package-enable-at-startup nil) ;; Prevent double loading of libraries - (add-to-list 'package-archives - ;; Leave only one of the following two lines uncommented - '("elpa-devel" . "https://elpa.gnu.org/devel/")) - ;; '("elpa" . "https://elpa.gnu.org/packages/")) - (unless (and (boundp 'package--initialized) package--initialized) - (package-initialize)) - ;; To ensure you have the latest index of packages, you'll have to - ;; uncomment the next line. It is commented because retrieving the - ;; list is slow. - ;; (package-refresh-contents) - ) - -;;; ************************************************************************ -;;; Section 2: package.el Hyperbole installation and configuration -;;; ************************************************************************ - -;; Step 1: Add the following expression to your "~/.emacs" or -;; "~/.emacs.d/init.el" file. - -(use-package hyperbole - - ;; ensure Hyperbole is installed - :ensure t - - ;; Initialize the global HyWiki minor mode to one of these values: - ;; :all - highlights and makes HyWikiWord links active in - ;; all text and programming buffer comments - ;; :pages - highlights and makes HyWikiWord links active in - ;; only within HyWiki page buffers - ;; nil - leaves HyWiki mode disabled. - :config - (progn - ;; Older Hyperbole releases do not have HyWiki - (when (fboundp 'hywiki-mode) - (hywiki-mode :all)) - - ;; Initialize the global Hyperbole minor mode to one of these values: - ;; 1 - enabled on startup so the Action and Assist Smart Keys are active - ;; 0 - off until you toggle it on - ;; If you left hywiki-mode enabled above, that enables hyperbole-mode too. - (unless (and (fboundp 'hywiki-mode) hywiki-mode) - (hyperbole-mode 1))) - - :bind - (("M-RET" . hkey-either) - ;; Uncomment the next binding if you want to emulate Hyperbole mouse drag - ;; events from your keyboard. - ;; See "https://www.gnu.org/s/hyperbole/man/hyperbole.html#Keyboard-Drags". - ;; ("M-o" . hkey-operate) - ) - - ;; Customize how Hyperbole and Org mode share the M-RET key: - ;; t - With hyperbole-mode enabled, Hyperbole controls the key - ;; 'buttons - With hyperbole-mode enabled, Hyperbole controls the key - ;; only when on a button or link; otherwise, Org controls it - ;; nil - In Org mode, Org controls the key - :custom - (hsys-org-enable-smart-keys t) - ) - -;;; End diff --git a/man/hy-straight.el b/man/hy-straight.el deleted file mode 100644 index 69aee1cb..00000000 --- a/man/hy-straight.el +++ /dev/null @@ -1,78 +0,0 @@ -;;; hy-straight.el --- Hyperbole Straight installation and configuration instructions -*- lexical-binding: t; -*- -;; -;; Author: Bob Weiner -;; -;; Orig-Date: 15-Jul-26 at 12:28:58 -;; Last-Mod: 25-Jul-26 at 22:25:45 by Mats Lidell -;; -;; SPDX-License-Identifier: GPL-3.0-or-later -;; -;; Copyright (C) 2026 Free Software Foundation, Inc. -;; See the "../HY-COPY" file for license information. -;; -;; This file is part of GNU Hyperbole. - -;;; ************************************************************************ -;;; Section 1: Straight setup -;;; ************************************************************************ - -;;; ======================================================================== -;;; NOTE: This section is only if you have not yet setup the Straight -;;; package manager. If you have, ignore this and skip to "#Section 2" -;;; for the Hyperbole `straight-use-package' recipe. -;;; ======================================================================== - -;; Step 1: Add the function definition below near the top of your -;; "~/.emacs" or "~/.emacs.d/early-init.el" file. - -;; Step 2: Add a call to the function below its definition: -;; (setup-straight) - -(defun setup-straight () - (when (< emacs-major-version 28) - (error "Hyperbole requires Emacs 28 or above, not %d" - emacs-major-version)) - (defvar bootstrap-version) - - ;; Prevent double loading of libraries - (setq package-enable-at-startup nil) - - (let ((bootstrap-file - (expand-file-name "straight/repos/straight.el/bootstrap.el" - user-emacs-directory)) - (bootstrap-version 5)) - (unless (file-exists-p bootstrap-file) - (with-current-buffer - (url-retrieve-synchronously - "https://raw.githubusercontent.com/raxod502/straight.el/develop/install.el" - 'silent 'inhibit-cookies) - (goto-char (point-max)) - (eval-print-last-sexp))) - (load bootstrap-file nil 'nomessage))) - -;;; ************************************************************************ -;;; Section 2: Straight Hyperbole installation and configuration -;;; ************************************************************************ - -;; Step 1: Add the following expression to your "~/.emacs" or -;; "~/.emacs.d/init.el" file. - -(straight-use-package - '(hyperbole - :host nil - - :repo "https://git.savannah.gnu.org/git/hyperbole.git" - - :config - (progn - (hywiki-mode :all) - (unless hywiki-mode - (hyperbole-mode 1))) - - :bind - (("M-RET" . hkey-either)) - - :custom - (hsys-org-enable-smart-keys t))) - -;;; End diff --git a/man/hyperbole.html b/man/hyperbole.html index ccdeeee0..015b5c3a 100644 --- a/man/hyperbole.html +++ b/man/hyperbole.html @@ -1,10 +1,10 @@ - + - + @@ -361,10 +358,8 @@
- +

GNU Hyperbole

@@ -386,7 +381,7 @@

GNU Hyperbole Edition 9.1.0 -Printed July 27, 2026. +Printed September 22, 2026. Published by the Free Software Foundation, Inc. Author: Bob Weiner @@ -438,297 +433,296 @@

GNU Hyperbole -
+ -
+

Table of Contents


- +

1 Introduction

This edition of the GNU Hyperbole Manual is for use with any version @@ -775,17 +769,15 @@

1 Introduction -
  • Manual Overview
  • -
  • Motivation
  • -
  • Hyperbole Overview
  • -
  • Mail Lists
  • +
  • Manual Overview
  • +
  • Motivation
  • +
  • Hyperbole Overview
  • +
  • Mail Lists

  • - +

    1.1 Manual Overview

    Hyperbole is an efficient, programmable hypertextual information management @@ -882,10 +874,8 @@

    1.1 Manual Overview - +

    1.2 Motivation

    Database vendors apply tremendous resources to help solve corporate @@ -923,10 +913,8 @@

    1.2 Motivation - +

    1.3 Hyperbole Overview

    @@ -962,12 +950,13 @@

    1.3 Hyperbole Overview -

    Hyperbole is something to be experienced and interacted with, not understood -from reading alone. It installs normally as a single Emacs package with no -dependencies outside of built-in Emacs libraries, see Installation. Most -of Hyperbole is a single global minor mode that you can activate and -deactivate at will. And it can be uninstalled quickly as well if need be, so -there is no risk in giving it a spin. +

    Hyperbole is something to be experienced and interacted with, not +understood from reading alone. It installs normally as a single Emacs +package with no dependencies outside of built-in Emacs libraries, +see Installation and Configuration. Most of Hyperbole is a single +global minor mode that you can activate and deactivate at will. And +it can be uninstalled quickly as well if need be, so there is no risk +in giving it a spin.

    Once you have it installed, try the interactive demo with {C-h h d d}. In fact, if you have Hyperbole loaded and you use the Emacs Info reader to @@ -1168,10 +1157,8 @@

    1.3 Hyperbole Overview

    - +

    1.4 Mail Lists

    If you use Hyperbole, you may join the mailing list @@ -1184,10 +1171,8 @@

    1.4 Mail Lists - +

    2 Usage

    Once Hyperbole has been installed for use at your site, loaded into your @@ -1197,16 +1182,14 @@

    2 Usage -
  • Invocation
  • -
  • Documentation
  • -
  • Hyperbole Hooks
  • +
  • Invocation
  • +
  • Documentation
  • +
  • Hyperbole Hooks

  • - +

    2.1 Invocation

    You can invoke Hyperbole’s commands in one of three ways: @@ -1230,16 +1213,22 @@

    2.1 Invocation + + + -

    {C-h h} enables Hyperbole if it has been disabled and displays a -Hyperbole menu in the minibuffer for quick keyboard or mouse-based -selection. Select an item from this menu by typing the item’s first -capital letter. Use {Q} (note this is capitalized) to quit from -the minibuffer menu while leaving Hyperbole enabled. Use {X} -(note this is capitalized) to quit from the minibuffer menu and -disable Hyperbole’s minor mode. + +

    {C-h h} enables Hyperbole if it has been disabled and displays +the top-level Hyperbole menu in the minibuffer for quick keyboard or +mouse-based selection. Within any Hyperbole minibuffer menu, select +an item by typing the item’s first capital letter. Use {Q} (note +this is capitalized) to quit from the minibuffer menu while leaving +Hyperbole enabled. Use {X} (note this is capitalized) to quit +from the minibuffer menu and disable Hyperbole’s minor mode. Use +{?} to get help on all of the items in the current menu. A +second {?} will hide this help.

    Use {C-h h d d} for an interactive demonstration of standard Hyperbole button capabilities. @@ -1262,10 +1251,8 @@

    2.1 Invocation - +

    2.2 Documentation

    @@ -1302,10 +1289,8 @@

    2.2 Documentation - +

    2.3 Hyperbole Hooks

    @@ -1332,10 +1317,8 @@

    2.3 Hyperbole Hooks - +

    3 Smart Keys

    @@ -1355,20 +1338,18 @@

    3 Smart Keys
    - +

    3.1 Smart Key Bindings

    @@ -1437,10 +1418,8 @@

    3.1 Smart Key Bindings

    - +

    3.2 Smart Key Operations

    @@ -1651,10 +1630,8 @@

    3.2 Smart Key Operations

    - +

    3.3 Smart Key Argument Selection

    @@ -1717,10 +1694,8 @@

    3.3 Smart Key Argu

    - +

    3.4 Smart Key Debugging

    Typically, {C-h A} and {C-u C-h A} which show Action and @@ -1757,10 +1732,8 @@

    3.4 Smart Key Debugging

    - +

    3.5 Smart Key Thing Selection

    @@ -1852,10 +1825,8 @@

    3.5 Smart Key Thing S

    - +

    3.6 Smart Mouse Key Modeline Clicks

    Smart Mouse Key clicks on a window’s modeline offer many powerful browsing @@ -1994,10 +1965,8 @@

    3.6 Smart Mouse

    - +

    3.7 Smart Mouse Key Drags

    @@ -2010,18 +1979,16 @@

    3.7 Smart Mouse Key Drags


    - +

    3.7.1 Creating and Deleting Windows

    @@ -2048,10 +2015,8 @@

    3.7.1 Creating

    - +

    3.7.2 Saving and Restoring Window Configurations

    @@ -2075,10 +2040,8 @@

    3

    - +

    3.7.3 Resizing Windows

    @@ -2094,10 +2057,8 @@

    3.7.3 Resizing Windows

    - +

    3.7.4 Moving Frames

    @@ -2125,10 +2086,8 @@

    3.7.4 Moving Frames - +

    3.7.5 Dragging Buffers, Windows and Items

    Smart Mouse Key drags let you display buffers and windows however you want @@ -2138,18 +2097,16 @@

    3.7.5


    - +

    3.7.5.1 Swapping Buffers

    @@ -2171,10 +2128,8 @@

    3.7.5.1 Swapping Buffers

    - +

    3.7.5.2 Displaying Buffers

    @@ -2193,10 +2148,8 @@

    3.7.5.2 Displaying Buf

    - +

    3.7.5.3 Cloning Windows

    @@ -2212,10 +2165,8 @@

    3.7.5.3 Cloning Windows

    - +

    3.7.5.4 Displaying Items

    @@ -2248,10 +2199,8 @@

    3.7.5.4 Displaying Items

    - +

    3.7.5.5 Keyboard Drags

    @@ -2450,10 +2399,8 @@

    3.7.5.5 Keyboard Drags

    - +

    4 Buttons

    @@ -2524,20 +2471,18 @@

    4 Buttons
    - +

    4.1 Explicit Buttons

    @@ -2609,10 +2554,8 @@

    4.1 Explicit Buttons - +

    4.2 Global Buttons

    @@ -2688,10 +2631,8 @@

    4.2 Global Buttons - +

    4.3 Implicit Buttons

    @@ -2812,15 +2753,13 @@

    4.3 Implicit Buttons -
  • Implicit Button Types
  • -
  • Action Buttons
  • +
  • Implicit Button Types
  • +
  • Action Buttons

  • - +

    4.3.1 Implicit Button Types

    @@ -2966,7 +2905,7 @@

    4.3.1 Implicit Button denote-link

    Denote is an Emacs package for note taking that uses time-stamped, descriptive file naming conventions to label and locate notes. Hyperbole -provides an expanded set of denote-specific link formats via this +provides an expanded set of denote-specific link formats via this reference types.

    If on a denote id with optional #section, jump to its associated note. @@ -3401,7 +3340,7 @@

    4.3.1 Implicit Button
    markdown-internal-link

    Display any in-file Markdown link referent. Pathnames and urls are handled elsewhere. -

    +

    @@ -3638,10 +3577,8 @@

    4.3.1 Implicit Button

    - +

    4.3.2 Action Buttons

    @@ -3735,10 +3672,8 @@

    4.3.2 Action Buttons

    - +

    4.4 Button Files

    @@ -3787,10 +3722,8 @@

    4.4 Button Files - +

    4.5 Action Types

    @@ -3825,7 +3758,7 @@

    4.5 Action Typescompletion

    Insert a completion at point into the minibuffer or a buffer. -Unless point is at the end of buffer or if a completion has already been +Unless point is at the end of buffer or if a completion has already been inserted, in which case, delete the completions window.

    @@ -3902,7 +3835,7 @@

    4.5 Action Types

    If given, PROJECT overrides any project value in REFERENCE. If no PROJECT -value is provided, it defaults to the value of hibtypes-git-default-project. +value is provided, it defaults to the value of hibtypes-git-default-project.

    @@ -4241,10 +4174,8 @@

    4.5 Action Types - +

    4.6 Button Type Precedence

    @@ -4279,10 +4210,8 @@

    4.6 Button Type Preceden

    - +

    4.7 Utilizing Explicit Buttons

    Explicit buttons are a fundamental building block for creating personal @@ -4292,20 +4221,18 @@

    4.7 Utilizing Explic


    - +

    4.7.1 Creation

    Creating explicit buttons is fun and easy. You can always try them out @@ -4326,16 +4253,14 @@

    4.7.1 Creation -
  • Creation Via Menus
  • -
  • Creation Via Buffer Link
  • -
  • Creation Via Assist Key Drags
  • +
  • Creation Via Menus
  • +
  • Creation Via Buffer Link
  • +
  • Creation Via Assist Key Drags

  • - +

    4.7.1.1 Creation Via Menus

    @@ -4373,10 +4298,8 @@

    4.7.1.1 Creation Via Men

    - +

    4.7.1.3 Creation Via Assist Key Drags

    @@ -4483,10 +4404,8 @@

    4.7.1.3 Creat

    - +

    4.7.2 Renaming

    @@ -4518,10 +4437,8 @@

    4.7.2 Renaming - +

    4.7.3 Deletion

    @@ -4541,10 +4458,8 @@

    4.7.3 Deletion - +

    4.7.4 Editing

    @@ -4563,10 +4478,8 @@

    4.7.4 Editing - +

    4.7.5 Searching and Summarizing

    @@ -4601,10 +4514,8 @@

    4.7.5 Searching an

    - +

    4.7.6 Buttons in Mail

    @@ -4708,10 +4619,8 @@

    4.7.6 Buttons in Mail

    - +

    4.7.7 Buttons in News

    @@ -4759,10 +4668,8 @@

    4.7.7 Buttons in News

    - +

    - +

    E.1.7 Smart Mouse Drags outside a Window

    @@ -12259,23 +11881,21 @@

    E.1.7 Sma

    - +

    E.2 Smart Keyboard Keys