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]

This edition of the GNU Hyperbole Manual is for use with any version @@ -775,17 +769,15 @@
Hyperbole is an efficient, programmable hypertextual information management @@ -882,10 +874,8 @@
Database vendors apply tremendous resources to help solve corporate @@ -923,10 +913,8 @@
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 @@
If you use Hyperbole, you may join the mailing list @@ -1184,10 +1171,8 @@
Once Hyperbole has been installed for use at your site, loaded into your @@ -1197,16 +1182,14 @@
You can invoke Hyperbole’s commands in one of three ways: @@ -1230,16 +1213,22 @@
{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 @@
Typically, {C-h A} and {C-u C-h A} which show Action and @@ -1757,10 +1732,8 @@
Smart Mouse Key clicks on a window’s modeline offer many powerful browsing @@ -1994,10 +1965,8 @@
Smart Mouse Key drags let you display buffers and windows however you want @@ -2138,18 +2097,16 @@
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 @@
markdown-internal-linkDisplay any in-file Markdown link referent. Pathnames and urls are handled elsewhere. -
+completion ¶
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.
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.
Explicit buttons are a fundamental building block for creating personal @@ -4292,20 +4221,18 @@
Creating explicit buttons is fun and easy. You can always try them out @@ -4326,16 +4253,14 @@
The top-level Hyperbole minibuffer menu is invoked from a key given in your -hyperbole.el file (by default, {C-h h}) or with a click -of the Action Mouse Key in the minibuffer when it is inactive. It should -look like this: +
The top-level Hyperbole minibuffer menu is invoked from a key given in
+your use-package configuration or if not specified, defaults to
+{C-h h}). A click of the Action Mouse Key in the minibuffer when
+it is inactive will also bring up this menu and continued clicks
+select items. Use {?} to toggle showing/hiding help for all of
+the current menu items.
+
The minibuffer menu should look like this:
Hy> Act Butfile/ Cust/ Doc/ Ebut/ Find/ Gbut/ HyWiki/ Ibut/ Kotl/ Msg/ Rolo/ Screen/ @@ -4828,7 +4739,7 @@5 Menus - + @@ -4982,7 +4893,7 @@
5 Menushui-select-rgrep-command to change the grep command or options. -
LocateFiles - Prompt for a pattern and display a list of all + LocateFiles - Prompt for a pattern and display a list of all matching pathnames found throughout the file system. On Mac OS X, this uses Spotlight (the mdfindcommand); on UNIX, it uses @@ -5087,10 +4998,8 @@5 Menus - +
6 HyWiki ¶
@@ -5121,17 +5030,15 @@6 HyWiki -
HyWikiWords -HyWiki Mode -Publishing a HyWiki -HyWiki Menu +HyWikiWords +HyWiki Mode +Publishing a HyWiki +HyWiki Menu
- +6.1 HyWikiWords ¶
@@ -5154,17 +5061,15 @@6.1 HyWikiWords -
Creating HyWikiWords -HyWikiWord Specs -HyWikiWord Referent Types -Using HyWikiWords +Creating HyWikiWords +HyWikiWord Specs +HyWikiWord Referent Types +Using HyWikiWords
- +6.1.3 HyWikiWord Referent Types ¶
HyWikiWords link to HyWiki pages by default. But there are many other @@ -5241,10 +5142,8 @@
6.1.3 HyWikiWord R
- +6.1.4 Using HyWikiWords ¶
@@ -5321,7 +5220,7 @@6.1.4 Using HyWikiWords(hywiki-active-in-current-buffer-p) must return non-‘nil’ for this to activate. - +
If the associated HyWiki referent is a page, create it automatically unless it is the first HyWiki page to be created, in which case, prompt the user whether to create it, to prevent any unexpected HyWiki @@ -5333,10 +5232,8 @@
6.1.4 Using HyWikiWords
- +6.2 HyWiki Mode ¶
@@ -5416,10 +5313,8 @@6.2 HyWiki Mode - +
6.3 Publishing a HyWiki ¶
@@ -5466,10 +5361,8 @@6.3 Publishing a HyWiki
- +6.4 HyWiki Menu ¶
The HyWiki minibuffer menu at {C-h h h} offers quick access to important HyWiki features. @@ -5815,10 +5708,8 @@
6.4 HyWiki Menu - +
7 HyNote ¶
@@ -5846,10 +5737,8 @@7 HyNote - +
8 HyControl ¶
@@ -6400,10 +6289,8 @@8 HyControl
- +9 Koutliner ¶
@@ -6446,22 +6333,20 @@9 Koutliner -
Menu Commands -Creating Outlines -Autonumbering -Idstamps -Editing Outlines -Viewing Outlines -Klinks -Cell Attributes -Koutliner History +Menu Commands +Creating Outlines +Autonumbering +Idstamps +Editing Outlines +Viewing Outlines +Klinks +Cell Attributes +Koutliner History
- +9.1 Menu Commands ¶
The Kotl/ menu entry on the Hyperbole minibuffer menu provides access to @@ -6520,10 +6405,8 @@
9.1 Menu Commands - +
9.2 Creating Outlines ¶
@@ -6557,10 +6440,8 @@9.2 Creating Outlines
- +9.3 Autonumbering ¶
@@ -6636,10 +6517,8 @@9.3 Autonumbering - +
9.4 Idstamps ¶
@@ -6669,10 +6548,8 @@9.4 Idstamps
- +9.5 Editing Outlines ¶
Text editing within the Koutliner works just as it does for other @@ -6695,22 +6572,20 @@
9.5 Editing Outlines -
Adding and Killing -Promoting and Demoting -Relocating and Copying -Moving Around -Filling -Transposing -Splitting and Appending -Inserting and Importing -Exporting +Adding and Killing +Promoting and Demoting +Relocating and Copying +Moving Around +Filling +Transposing +Splitting and Appending +Inserting and Importing +Exporting
- +9.5.4 Moving Around ¶
@@ -7015,10 +6884,8 @@9.5.4 Moving Around - +
9.5.5 Filling ¶
@@ -7062,10 +6929,8 @@9.5.5 Filling - +
9.5.6 Transposing ¶
The Koutliner move and copy commands rearrange entire trees. The @@ -7096,10 +6961,8 @@
9.5.6 Transposing - +
9.5.7 Splitting and Appending ¶
@@ -7130,10 +6993,8 @@9.5.7 Splitting and
- +9.5.9 Exporting ¶
@@ -7267,10 +7126,8 @@9.5.9 Exporting - +
9.6 Viewing Outlines ¶
@@ -7280,15 +7137,13 @@9.6 Viewing Outlines -
Hiding and Showing -View Specs +Hiding and Showing +View Specs
- +9.6.2 View Specs ¶
@@ -7494,10 +7347,8 @@9.6.2 View Specs - +
9.7 Klinks ¶
@@ -7636,10 +7487,8 @@9.7 Klinks
- +9.8 Cell Attributes ¶
@@ -7721,10 +7570,8 @@9.8 Cell Attributes - +
9.9 Koutliner History ¶
@@ -7754,10 +7601,8 @@9.9 Koutliner History
- +10 HyRolo ¶
@@ -7782,18 +7627,16 @@10 HyRolo -
HyRolo Concepts -Rolo Menu -HyRolo Searching -HyRolo Keys -HyRolo Settings +HyRolo Concepts +Rolo Menu +HyRolo Searching +HyRolo Keys +HyRolo Settings
- +10.1 HyRolo Concepts ¶
@@ -7881,10 +7724,8 @@10.1 HyRolo Concepts - +
10.2 Rolo Menu ¶
The Rolo submenu of the Hyperbole menu offers a full set of commands @@ -7989,10 +7830,8 @@
10.2 Rolo Menu
- +10.3 HyRolo Searching ¶
@@ -8005,7 +7844,7 @@10.3 HyRolo Searching -
The
RegexFindmenu item searches the rolo list for all entries +The
RegexFindmenu item searches the rolo list for all entries which contain matches for a given regular expression. The regular expression syntax used is the same as the one used within Emacs and across the GNU set of tools. See Syntax of Regular @@ -8078,10 +7917,8 @@10.3 HyRolo Searching
- +10.4 HyRolo Keys ¶
@@ -8271,10 +8108,8 @@10.4 HyRolo Keys - +
10.5 HyRolo Settings ¶
@@ -8418,7 +8253,7 @@10.5 HyRolo Settings
hyrolo-hdr-and-entry-regexp¶@@ -8443,10 +8278,8 @@ The rolo entry start delimiter is given by the regular expression -variable,
hyrolo-hdr-and-entry-regexp, whose default value is "^\*+", i.e. +variable,hyrolo-hdr-and-entry-regexp, whose default value is "^\*+", i.e. one or more asterisks at the beginning of a line.10.5 HyRolo Settings - +
11 Window Configurations ¶
@@ -8547,10 +8380,8 @@11 Window Configurations<
- +12 Developing with Hyperbole ¶
This chapter is for people who wish to customize Hyperbole, to extend @@ -8562,18 +8393,16 @@
12 Developing with Hy
-
- Hook Variables
-- Creating Types
-- Explicit Button Technicalities
-- Encapsulating Systems
-- Embedding Hyperbole
+- Hook Variables
+- Creating Types
+- Explicit Button Technicalities
+- Encapsulating Systems
+- Embedding Hyperbole
- +12.1 Hook Variables ¶
@@ -8710,10 +8539,8 @@12.1 Hook Variables - +
12.2 Creating Types ¶
@@ -8746,15 +8573,13 @@12.2 Creating Types -
Creating Action Types -Creating Implicit Button Types +Creating Action Types +Creating Implicit Button Types
- +12.2.2 Creating Implicit Button Types ¶
Implicit buttons leverage the same action types used by explicit and @@ -8910,16 +8733,14 @@
12.2.2 Creati
-
- Action Button Link Types
-- Implicit Button Link Types
-- Programmatic Implicit Button Types
+- Action Button Link Types
+- Implicit Button Link Types
+- Programmatic Implicit Button Types
- +12.2.2.1 Action Button Link Types ¶
The simplest way to create a new implicit link type (from which any @@ -8977,10 +8798,8 @@
12.2.2.1 Action
- +12.2.2.2 Implicit Button Link Types ¶
If you understand Emacs regular expressions (see Syntax of @@ -9028,7 +8847,7 @@
-12.2.2.2 Impli buttons perform a grep-like function over a current repo’s git log entries. The buttons use this format: [<text to match>].
The following defines the button type called
search-git-logwith a +The following defines the button type called
search-git-logwith a a key series action surrounded by braces:
(defil search-git-log "[<" ">]" ".*" "{M-: (hypb:fgrep-git-log \"\\&\") RET}")@@ -9056,10 +8875,8 @@12.2.2.2 Impli
- +12.3 Explicit Button Technicalities ¶
-
- Button Label Normalization
-- Operational and Storage Formats
-- Programmatic Button Creation
+- Button Label Normalization
+- Operational and Storage Formats
+- Programmatic Button Creation
- +Appendix A Glossary ¶
@@ -10134,52 +9937,46 @@Appendix A Glossary - +
Appendix B Setup ¶
Hyperbole must be obtained and setup at your site before you can -use it. Instructions are given below. If you are using InfoDock -version 4.0.7 or higher, Hyperbole is pre-installed so you may skip -the installation instructions and simply continue with the -next section about customizing Hyperbole’s behavior. +use it. Instructions are given below.
-- -B.1 Installation ¶
++ +B.1 Installation and Configuration ¶
-There are multiple package managers you can use to install Hyperbole once -you have GNU Emacs set up at your site. Choose one based on your needs. +
Hyperbole can be installed using Emacs’ package manager, from its +development repository or manually from the tarball archive.
-After installing Hyperbole, read the next section on Invocation. +
After installing and configuring Hyperbole, read the next section on Invocation.
-
- Elpa Latest or Release Package Installation (Emacs Package Manager)
-- Git Latest Package Installation (Straight Package Manager)
-- Manual Tarball Archive Installation (SFTP)
+- Elpa and Melpa Latest or Release Package Installation (Emacs Package Manager)
+- Git Latest Package Installation
+- Manual Tarball Archive Installation (SFTP)
-- -B.1.1 Elpa Latest or Release Package Installation (Emacs Package Manager) ¶
++ +B.1.1 Elpa and Melpa Latest or Release Package Installation (Emacs Package Manager) ¶
+ + @@ -10193,270 +9990,80 @@
Once you have Emacs set up at your site, you may install GNU Hyperbole using the Emacs Package Manager. If you are not familiar with it, -see Packages in the GNU Emacs Manual. Releases are done with -care and occur once in awhile. In between, there is are -regression-tested latest distributions packaged from the -in-development code branch; these may be many months and features -ahead of the release branch. -
-Therefore, consider using the Elpa Latest package; it pulls from the -latest Hyperbole development branch tip and uses the builtin Emacs -package manager. Since Hyperbole is a mature package, this is fine to -use and update on a day-to-day basis. But new features are tested on -this branch and once in awhile it may break for a short time before a -fix is pushed. -
-With this branch you’ll be able to submit bug reports and feature -requests but will not be able to submit pull requests for changes to -the developers; use the Git Latest Package, described in the next -section, instead for that. -
-If you have Hyperbole 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, see Invocation. -
-Otherwise, to download and install the Hyperbole package, you should -add the following Lisp to your Emacs initialization file, as described -below. It installs the Elpa Latest package; there is one commented -line in the configuration that you can switch out to pull from the -older Elpa production release package. (For further details, -see The Emacs Initialization File in the GNU Emacs -Manual). +see Packages in the GNU Emacs Manual.
-
---;;; 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 -
- -Now save the file and restart Emacs. Hyperbole will then be downloaded -and compiled for use with your version of Emacs; give it a minute or two. +
Install Hyperbole like this:
++
M-x package-install RET hyperbole RET+Stable releases are done with care and occur once in awhile. In between, +there is are regression-tested latest distributions packaged +from the in-development code branch; these may be many months and +features ahead of the release branch. +
+Therefore, consider using the GNU-devel ELPA package; it pulls from the +latest Hyperbole development branch tip. Since Hyperbole is a mature +package, this is fine to use and update on a day-to-day basis. But +new features are tested on this branch and once in awhile it may break +for a short time before a fix is pushed. +
+If you prefer Hyperbole is also available from MELPA. +
+For installing from GNU-devel ELPA, MELPA releases or MELPA snapshots +add the respective archive to package-archives in your init +file, see see The Emacs Initialization File in the GNU Emacs +Manual. +
+GNU-devel ELPA: +
++
(add-to-list 'package-archives '("gnu-devel". "https://elpa.gnu.org/devel/") t)+MELPA Releases: +
++
(add-to-list 'package-archives '("melpa-releases" . "https://releases.melpa.org/packages/") t)+MELPA Snapshots: +
++
(add-to-list 'package-archives '("melpa-snapshots" . "https://snapshots.melpa.org/packages/") t)+If you prefer to automate the install of Hyperbole you can also add +the following lines to your init file after setting +package-archives. Then Hyperbole will be installed when Emacs is +started if not available. +
++(require 'package) +(unless (package-installed-p 'hyperbole) + (package-install 'hyperbole)) +
- -B.1.2 Git Latest Package Installation (Straight Package Manager) ¶
+ +B.1.2 Git Latest Package Installation ¶
+ + -If you potentially want to contribute to Hyperbole development and send -pull requests to the Hyperbole development team or to try out new -features still in testing, you can use the Straight package manager. It -pulls the latest Hyperbole source code directly from its git repository. -This also gives you a clean installation process without showing you any -minor byte compilation warnings. -
-If you have Hyperbole 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, see Invocation. -
-Otherwise, to download and install the Hyperbole package, you should add -the following Lisp to your Emacs initialization file, as described below. -(For further details, see The Emacs Initialization File in the GNU Emacs Manual). -
-
---;;; 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 -
-Now save the file and restart Emacs. Hyperbole will then be downloaded -and compiled for use with your version of Emacs; give it a minute or two. +
Some package manager support downloading directly from a git +repository. This is the url to the repository: +
++
https://git.savannah.gnu.org/git/hyperbole.git+For further details check your package managers documentation related +to using a git repository.
- +-B.1.3 Manual Tarball Archive Installation (SFTP) ¶
If you are old-school, don’t like package managers, and prefer doing @@ -10483,38 +10090,99 @@
<
make binto byte-compile the Hyperbole lisp files. Then add the following -lines to your personal Emacs initialization file, ~/.emacs: +lines to your personal init file:
--(unless (and (featurep 'hyperbole) hyperbole-mode) - (when (< emacs-major-version 28) - (error "Hyperbole requires Emacs 28 or above, not %d" - emacs-major-version)) - (push "<directory-ending-with-hyperbole-where-you-unpacked>" +(push "<directory-ending-with-hyperbole-where-you-unpacked>" load-path) - (require 'hyperbole) - (hyperbole-mode 1) - ;; Allow HyWikiWords in text buffers and programming buffer comments, - ;; not just in HyWiki pages, by uncommenting the next line. - ;; (hywiki-mode :all) - )Restart Emacs and you should see the
Hypbhyperbole minor mode -indicator in your modeline after startup. -
-