[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/hyperbole 64294de59f 3/3: Merge pull request #584 from
|
From: |
ELPA Syncer |
|
Subject: |
[elpa] externals/hyperbole 64294de59f 3/3: Merge pull request #584 from rswgnu/rsw |
|
Date: |
Mon, 2 Sep 2024 03:58:27 -0400 (EDT) |
branch: externals/hyperbole
commit 64294de59fa6f3e7b8127d72081ae7ceaa8276d5
Merge: 5dbd852f10 b1641e5fe6
Author: Robert Weiner <rsw@gnu.org>
Commit: GitHub <noreply@github.com>
Merge pull request #584 from rswgnu/rsw
Hyperbole Manual - Add initial short HyNote chapter
---
ChangeLog | 22 ++++
hui-menu.el | 37 ++++---
hui-mini.el | 78 +++++++++-----
hynote.el | 51 +++++----
hyrolo.el | 13 +--
hyrolo.py | 3 +-
hywiki.el | 2 +-
man/dir | 14 ++-
man/hyperbole.html | 302 ++++++++++++++++++++++++++++++++++++++---------------
man/hyperbole.info | Bin 653988 -> 659075 bytes
man/hyperbole.pdf | Bin 1397687 -> 1404276 bytes
man/hyperbole.texi | 112 ++++++++++++++++----
12 files changed, 447 insertions(+), 187 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 35cae96434..9a4c5c60c8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,25 @@
+2024-09-01 Bob Weiner <rsw@gnu.org>
+
+* man/dir (File): Narrow width to better fit with out Info entries.
+
+* hyrolo.el (hyrolo-org-mode): Prioritize Org 9.7 folding-spec config
+ over earlier versions to fix a bug that used the wrong version.
+
+* hui-menu.el (infodock-hyperbole-menu):
+ hui-mini.el (hui:menu-hywiki): Allow customizing the HyWiki menus and
+ define its Consult items only when consult-grep is fboundp.
+
+* hynote.el (hynote-get-file): Add secondary markdown file suffixes.
+ (hynote-file-suffix-list): Add this variable and use in above
+ function.
+ (hynote-file-suffix-regexp): Add this variable and use in
+ `hynote-get-files'.
+ (require 'hyrolo): Remove.
+
+* man/hyperbole.texi (Glossary): Add HyNote entry and HyWiki entry reference
+ to its two ibtypes.
+ (HyNote): Add a short chapter on this.
+
2024-08-30 Bob Weiner <rsw@gnu.org>
* hibtypes.el (hyp-manual): Fix to strip spaces around section for both .html
diff --git a/hui-menu.el b/hui-menu.el
index 77a3dd2aa9..28e11a7cf4 100644
--- a/hui-menu.el
+++ b/hui-menu.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 28-Oct-94 at 10:59:44
-;; Last-Mod: 19-Aug-24 at 23:28:31 by Bob Weiner
+;; Last-Mod: 1-Sep-24 at 14:12:37 by Bob Weiner
;;
;; SPDX-License-Identifier: GPL-3.0-or-later
;;
@@ -301,6 +301,26 @@ Return t if cutoff, else nil."
:style toggle :selected hkey-debug]))
"Untitled menu of Hyperbole options.")
+(defconst hui-menu-hywiki
+ (delq nil
+ (list
+ ["Manual" (id-info "(hyperbole)HyWiki") t]
+ "----"
+ ["Activate" hywiki-word-activate t]
+ ["Create" hywiki-add-page-and-display t]
+ ["Edit" hywiki-find-page t]
+ (when (fboundp 'consult-grep) ;; allow for autoloading
+ ["Grep-Consult" hywiki-consult-grep t])
+ ["Help" hkey-help t]
+ ["Link" hywiki-add-link t]
+ hui-menu-org-meta-return-options
+ ["HyWiki-Mode-Toggle" hywiki-mode t]
+ ["Publish" hywiki-publish-to-html t]
+ ["Tag-Find" hywiki-tags-view t]
+ (when (fboundp 'consult-grep) ;; allow for autoloading
+ ["WikiWord-Consult" hywiki-word-consult-grep t])))
+ "Menu items for HyWiki editing and publishing.")
+
(defvar infodock-hyperbole-menu nil)
;;; ************************************************************************
@@ -447,20 +467,7 @@ REBUILD-FLAG is non-nil, in which case the menu is
rebuilt."
["Help" gbut:help t]
["Link" hui:gbut-link-directly t]
["Rename" hui:gbut-rename t])
- (list "HyWiki"
- ["Manual" (id-info "(hyperbole)HyWiki") t]
- "----"
- ["Activate" hywiki-word-activate t]
- ["Create" hywiki-add-page-and-display t]
- ["Edit" hywiki-find-page t]
- ["Grep-Consult" hywiki-consult-grep t]
- ["Help" hkey-help t]
- ["Link" hywiki-add-link t]
- hui-menu-org-meta-return-options
- ["HyWiki-Mode-Toggle" hywiki-mode t]
- ["Publish" hywiki-publish-to-html t]
- ["Tag-Find" hywiki-tags-view t]
- ["WikiWord-Consult" hywiki-word-consult-grep t])
+ (cons "HyWiki" hui-menu-hywiki)
'("Implicit-Button"
["Manual" (id-info "(hyperbole)Implicit Buttons") t]
"----"
diff --git a/hui-mini.el b/hui-mini.el
index 280a861f18..452519ff59 100644
--- a/hui-mini.el
+++ b/hui-mini.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 15-Oct-91 at 20:13:17
-;; Last-Mod: 19-Aug-24 at 23:29:29 by Bob Weiner
+;; Last-Mod: 1-Sep-24 at 19:46:18 by Bob Weiner
;;
;; SPDX-License-Identifier: GPL-3.0-or-later
;;
@@ -28,10 +28,11 @@
;;; ************************************************************************
(defvar hargs:reading-type) ; "hargs.el"
-(defvar hui:menu-mode-map) ; "hui.el"
(defvar hbmap:dir-user) ; "hbmap.el"
(defvar hbmap:filename) ; "hbmap.el"
-(defvar hui:menu-rolo) ; "hui.el"
+(defvar hui:menu-hywiki nil) ; "hui-mini.el"
+(defvar hui:menu-mode-map) ; "hui-mini.el"
+(defvar hui:menu-rolo nil) ; "hui-mini.el"
(defvar hyperbole-mode-map) ; "hyperbole.el"
(defvar hyrolo-add-hook) ; "hyrolo.el"
(defvar hyrolo-edit-hook) ; "hyrolo.el"
@@ -860,32 +861,7 @@ command instead. Typically prevents clashes over {\\`C-c'
/}."
"Display manual section on global buttons.")
("Link" hui:gbut-link-directly "Add a named global button link to
point in other/another window.")
("Rename" hui:gbut-rename "Rename a global button.")))
- '(hywiki .
- (("HyWiki>")
- ("Act" hywiki-word-activate
- "Activate HyWikiWord link at point or emulate a press of a Smart
Key.")
- ("Create" hywiki-add-page-and-display
- "Create and display a new HyWiki page. Shows existing page names
to aid in new naming.")
- ("Edit" hywiki-find-page
- "Prompt with completion for and display a HyWiki page ready for
editing.")
- ("GrepConsult" hywiki-consult-grep
- "Grep over HyWiki pages with interactive consult-grep.")
- ("Help" hkey-help
- "Report on a HyWikiWord's attributes.")
- ("Info" (id-info "(hyperbole)HyWiki")
- "Display Hyperbole manual section on HyWiki.")
- ("Link" hywiki-add-link
- "Prompt for and add a link at point to a HyWiki page.")
- ("ModeToggle" hywiki-mode
- "Toggle whether HyWikiWords are highlighted and active in buffers
outside of the HyWiki page directory.")
- ("Org-M-RET/" (menu . cust-org)
- "Set how much of Hyperbole Smart Key behavior is enabled in Org
mode.")
- ("Publish" hywiki-publish-to-html
- "Publish modified pages in the HyWiki to HTML; prefix arg to publish
all pages.")
- ("TagFind" hywiki-tags-view
- "Find HyWiki Org tags.")
- ("WikiWordConsult" hywiki-word-consult-grep
- "Use `hywiki-consult-grep' to show occurrences of a prompted for
HyWikiWord.")))
+ (cons 'hywiki hui:menu-hywiki)
'(ibut .
(("IButton>")
("Act" hui:ibut-act
@@ -993,6 +969,50 @@ command instead. Typically prevents clashes over {\\`C-c'
/}."
;;; Public Customizations - must come after menus are defined
;;; ************************************************************************
+(unless hui:menu-hywiki
+ (makunbound 'hui:menu-hywiki))
+(defcustom hui:menu-hywiki
+ (delq nil
+ (list
+ '("HyWiki>")
+ '("Act" hywiki-word-activate
+ "Activate HyWikiWord link at point or emulate a press of a Smart
Key.")
+ '("Create" hywiki-add-page-and-display
+ "Create and display a new HyWiki page. Shows existing page names
to aid in new naming.")
+ '("Edit" hywiki-find-page
+ "Prompt with completion for and display a HyWiki page ready for
editing.")
+ (when (fboundp 'consult-grep) ;; allow for autoloading
+ '("GrepConsult" hywiki-consult-grep
+ "Grep over HyWiki pages with interactive consult-grep."))
+ '("Help" hkey-help
+ "Report on a HyWikiWord's attributes.")
+ '("Info" (id-info "(hyperbole)HyWiki")
+ "Display Hyperbole manual section on HyWiki.")
+ '("Link" hywiki-add-link
+ "Prompt for and add a link at point to a HyWiki page.")
+ '("ModeToggle" hywiki-mode
+ "Toggle whether HyWikiWords are highlighted and active in buffers
outside of the HyWiki page directory.")
+ '("Org-M-RET/" (menu . cust-org)
+ "Set how much of Hyperbole Smart Key behavior is enabled in Org
mode.")
+ '("Publish" hywiki-publish-to-html
+ "Publish modified pages in the HyWiki to HTML; prefix arg to publish
all pages.")
+ '("TagFind" hywiki-tags-view
+ "Find HyWiki Org tags.")
+ (when (fboundp 'consult-grep) ;; allow for autoloading
+ '("WikiWordConsult" hywiki-word-consult-grep
+ "Use `hywiki-consult-grep' to show occurrences of a prompted for
HyWikiWord."))))
+ "*Hyperbole minibuffer HyWiki menu items of the form:
+\(LABEL-STRING ACTION-SEXP DOC-STR)."
+ :set (lambda (var value)
+ (if (fboundp #'hyperbole-minibuffer-menu)
+ (progn (set-default var value)
+ (hyperbole-minibuffer-menu))
+ (set-default var value)))
+ :type '(cons (list string) (repeat (list string sexp string)))
+ :group 'hyperbole-buttons)
+
+(unless hui:menu-rolo
+ (makunbound 'hui:menu-rolo))
(defcustom hui:menu-rolo
(delq nil
(list
diff --git a/hynote.el b/hynote.el
index 76b3a590f9..4a01fff18f 100644
--- a/hynote.el
+++ b/hynote.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 23-Jun-24 at 12:50:37
-;; Last-Mod: 30-Jun-24 at 11:27:57 by Bob Weiner
+;; Last-Mod: 1-Sep-24 at 14:26:02 by Bob Weiner
;;
;; SPDX-License-Identifier: GPL-3.0-or-later
;;
@@ -14,9 +14,9 @@
;;; Commentary:
;;
-;; This is a start on Hyperbole's note taking system, HyNote, which
-;; presently simply provides an experience similar to HyWikiWords
-;; for Org and Org Roam file and headline links. In the future, it
+;; HyNote is a start on Hyperbole's note taking system. It presently
+;; simply provides an experience similar to HyWikiWords for Org
+;; directory and Org Roam file and headline links. In the future, it
;; will also provide a universal way to easily link to information
;; across many file formats.
;;
@@ -44,9 +44,26 @@
;;; ************************************************************************
(require 'hbut)
-(require 'hyrolo)
(require 'hywiki)
+;;; ************************************************************************
+;;; Public variables
+;;; ************************************************************************
+
+(defvar hynote-directory-list '("~/org/" "~/org-roam/")
+ "Directories in which to find HyNote Org files.")
+
+(defvar hynote-file-suffix-list
+ '(".kotl" ".kot" ".md" ".markdown" ".mkd" ".mdown" ".mkdn" ".mdwn"
+ ".org" ".otl" ".outl")
+ "List of valid filename suffixes to search for HyNotes.
+If you change this value, you must regenerate `hynote-file-suffix-regexp'.")
+
+(defvar hynote-file-suffix-regexp
+ (concat "\\(" (string-join (mapcar #'regexp-quote hynote-file-suffix-list)
"\\|")
+ "\\)$")
+ "Regular expression matching valid filename suffixes to search for HyNotes.")
+
;;; ************************************************************************
;;; Public Implicit Button and Action Types
;;; ************************************************************************
@@ -73,10 +90,11 @@ is true. This may require that (hywiki-mode) has been
enabled."
(ibut:label-set file-stem-name start end)
(hact 'hynote-find-file file section)))))))
+;;;###autoload
(defun hynote-find-file (file &optional section)
- "Display an existing FILE starting at SECTION.
+ "Display an existing HyNote FILE starting at SECTION.
SECTION must be the name of a heading from the FILE and should begin
-with \"#\", though this function will add \"#\" if missing.
+with \"#\", though this function will add \"#\" if it is missing.
Return the absolute path to any file successfully found, else nil.
After successfully finding a file and reading it into a buffer, run
@@ -91,8 +109,9 @@ After successfully finding a file and reading it into a
buffer, run
(run-hooks 'hynote-find-file-hook)
file))
+;;;###autoload
(defun hynote-find-file-stem (file-stem-name)
- "Display an existing FILE-STEM-NAME from `hynote-directory-list'.
+ "Display an existing HyNote FILE-STEM-NAME from `hynote-directory-list'.
Return the absolute path to any file successfully found, else nil.
After successfully finding a file and reading it into a buffer, run
@@ -111,36 +130,28 @@ After successfully finding a file and reading it into a
buffer, run
(run-hooks 'hynote-find-file-hook)
file)))))
-;;; ************************************************************************
-;;; Public variables
-;;; ************************************************************************
-
-(defvar hynote-directory-list '("~/org/" "~/org-roam/")
- "Directories in which to find HyNote Org files.")
-
;;; ************************************************************************
;;; Public functions
;;; ************************************************************************
(defun hynote-get-file (file-stem-name)
"Return existing file path in `hynote-directory-list' from FILE-STEM-NAME.
-File name must end with standard suffixes from `hyrolo-file-suffix-regexp'.
+File name must end with default suffixes from `hynote-file-suffix-list'.
No validation of FILE-STEM-NAME is done."
;; Remove any #section from `file-stem-name'
(setq file-stem-name (if (string-match "#" file-stem-name)
(substring file-stem-name 0 (match-beginning 0))
file-stem-name))
- (locate-file file-stem-name hynote-directory-list
- '(".kotl" ".kot" ".md" ".org" ".otl" ".outl")))
+ (locate-file file-stem-name hynote-directory-list hynote-file-suffix-list))
(defun hynote-get-files ()
- "Return `hynote-directory-list' files ending with
`hyrolo-file-suffix-regexp'.
+ "Return `hynote-directory-list' files ending with
`hynote-file-suffix-regexp'.
File names returned are relative to `hynote-directory-list'."
(mapcan
(lambda (dir)
(make-directory dir t)
(when (file-readable-p dir)
- (directory-files dir nil (concat "^[^#]+" hyrolo-file-suffix-regexp))))
+ (directory-files dir nil (concat "^[^#]+" hynote-file-suffix-regexp))))
hynote-directory-list))
(defun hynote-get-file-stems ()
diff --git a/hyrolo.el b/hyrolo.el
index 903edbc0c2..8380297a76 100644
--- a/hyrolo.el
+++ b/hyrolo.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 7-Jun-89 at 22:08:29
-;; Last-Mod: 8-Aug-24 at 23:53:10 by Mats Lidell
+;; Last-Mod: 1-Sep-24 at 19:04:11 by Bob Weiner
;;
;; SPDX-License-Identifier: GPL-3.0-or-later
;;
@@ -3054,11 +3054,12 @@ Any non-nil value returned is a cons of (<entry-name> .
<entry-source>)."
(when (eq org-fold-core-style 'overlays)
(hypb:add-to-invisibility-spec '(org-hide-block . t)))
(org-fold-core-set-folding-spec-property
- (if (boundp 'org-link--link-folding-spec)
- ;; Org pre-9.7
- (car org-link--link-folding-spec)
- ;; Org 9.7 and up
- (caar org-fold-core--specs))
+ (cond ((boundp 'org-fold-core--specs)
+ ;; Org 9.7 and up
+ (caar org-fold-core--specs))
+ ((boundp 'org-link--link-folding-spec)
+ ;; Org pre-9.7
+ (car org-link--link-folding-spec)))
:visible (not org-link-descriptive)))
(setq-local hyrolo-entry-regexp "^\\(\\*+\\)\\([ \t\n\r]+\\)"
diff --git a/hyrolo.py b/hyrolo.py
index 09c80fc8b2..5f3b2e656f 100644
--- a/hyrolo.py
+++ b/hyrolo.py
@@ -8,7 +8,7 @@
# Author: Bob Weiner
#
# Orig-Date: 1-Apr-24 at 01:45:27
-# Last-Mod: 16-Apr-24 at 23:12:28 by Bob Weiner
+# Last-Mod: 1-Sep-24 at 12:25:38 by Bob Weiner
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
@@ -169,5 +169,6 @@ def main():
args.files = ["~/.rolo.otl"]
find_matching_entries(args.match_string, args.files)
+
if __name__ == '__main__':
main()
diff --git a/hywiki.el b/hywiki.el
index a4dbacdcea..14bc157ff3 100644
--- a/hywiki.el
+++ b/hywiki.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 21-Apr-24 at 22:41:13
-;; Last-Mod: 24-Aug-24 at 11:36:20 by Mats Lidell
+;; Last-Mod: 1-Sep-24 at 12:20:24 by Bob Weiner
;;
;; SPDX-License-Identifier: GPL-3.0-or-later
;;
diff --git a/man/dir b/man/dir
index 533255d83a..a4e3642e3e 100644
--- a/man/dir
+++ b/man/dir
@@ -16,9 +16,13 @@ File: dir, Node: Top This is the top of the INFO tree
Emacs
* Hyperbole: (hyperbole). The Everyday Hypertextual Information Manager.
- Use {C-h h d d} for a demonstration. GNU Hyperbole offers context-
- sensitive mouse and keyboard keys that do the right thing, a powerful
- contact manager, an advanced, auto-numbered outliner with hyperlink
- anchors for each outline cell, and easily editable and extensible
- hyperlink buttons, even embeddable within mail and news messages.
+ Use {C-h h d d} for a demonstration.
+ GNU Hyperbole offers context-sensitive
+ mouse and keyboard keys that do the right
+ thing, a powerful personal Wiki generator,
+ contact manager, an advanced, auto-numbered
+ outliner with hyperlink anchors for each
+ outline cell, and easily editable and extensible
+ hyperlink buttons, even embeddable within mail
+ and news messages.
diff --git a/man/hyperbole.html b/man/hyperbole.html
index 4faf4a9fda..948282e705 100644
--- a/man/hyperbole.html
+++ b/man/hyperbole.html
@@ -4,7 +4,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual is for GNU Hyperbole
-(Edition 9.0.2pre, Published August, 2024).
+(Edition 9.0.2pre, Published September, 2024).
Copyright (C) 1989-2023 Free Software Foundation, Inc.
@@ -95,7 +95,7 @@ Next: <a href="#Introduction" accesskey="n"
rel="next">Introduction</a>, Previou
<CENTER><H3><A HREF="mailto:rsw@gnu.org";>Say thanks or send a testimonial if
you like Hyperbole.</A></H3></CENTER>
-<P>Copyright © 1989-2023 Free Software Foundation, Inc.</P>
+<P>Copyright © 1989-2024 Free Software Foundation, Inc.</P>
<P>GNU Hyperbole is available for use, modification, and distribution under
the terms of the GNU General Public License (GPL) Version 3 or later,
@@ -108,7 +108,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</P>
<PRE>
Edition 9.0.2pre
-Printed August 19, 2024.
+Printed September 1, 2024.
Published by the Free Software Foundation, Inc.
Author: Bob Weiner
@@ -170,7 +170,7 @@ Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>,
Previous: <a href="#T
<span id="Introduction-1"></span><h2 class="chapter">1 Introduction</h2>
<p>This edition of the GNU Hyperbole Manual is for use with any version
-9.0.1 or greater of GNU Hyperbole. Hyperbole runs atop GNU Emacs 27.1
+9.0.2pre or greater of GNU Hyperbole. Hyperbole runs atop GNU Emacs 27.2
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,
@@ -2343,6 +2343,13 @@ not installed by default. You must manually configure
it and load it from
the file, <samp><code>${hyperb:dir}</code>/hib-doc-id.el</samp>). See the
commentary
at the top of that file for more information.
</p>
+<span id="index-ibtypes-hywiki_002dexisting_002dword"></span>
+<span id="index-hywiki-existing-word"></span>
+</dd>
+<dt><span><code>hywiki-existing-word</code></span></dt>
+<dd><p>When on a HyWiki word with an existing page, display its page and
+optional section.
+</p>
<span id="index-ibtypes-completion"></span>
<span id="index-completion-1"></span>
</dd>
@@ -2748,6 +2755,21 @@ as the reference. References must be delimited by
square brackets, must
begin with a word constituent character, and must not be in buffers
whose names begin with a ‘ ’ or ‘*’ character.
</p>
+<span id="index-ibtypes-hyp_002dhtml_002dmanual"></span>
+<span id="index-hyperbole-manual-ibtype"></span>
+</dd>
+<dt><span><code>hyp-manual</code></span></dt>
+<dd><p>When on a Hyperbole manual file path, display it. For example,
+display <samp>hyperbole.html#Smart Keys</samp> in a web browser using the
+local html version of the Hyperbole manual. When on
+<samp>hyperbole.texi#Smart Keys</samp>, jump to the <em>Smart Keys</em> node
+in the local Texinfo manual. Without a node name, go to the initial,
+top node.
+</p>
+<p>Info file links like <samp>hyperbole.info#Smart Keys</samp> are handled by
+the <code>Info-node</code> implicit button type and displayed in the Emacs
+Info browser.
+</p>
<span id="index-ibtypes-www_002durl"></span>
<span id="index-URL"></span>
<span id="index-World_002dwide-Web"></span>
@@ -2898,6 +2920,25 @@ given by the <code><test-name></code> argument, an
unquoted name.
tracebacks may be on a line just below the source reference line so
since not on a Hyperbole button, move back a line and check for a
source reference line again.
+</p>
+<span id="index-ibtypes-hywiki_002dword"></span>
+<span id="index-hywiki-word"></span>
+</dd>
+<dt><span><code>hywiki-word</code></span></dt>
+<dd><p>When on a HyWiki word, display its page and optional section. If the
+associated HyWiki page does not exist, create it automatically.
+</p>
+<span id="index-ibtypes-hynote_002dfile"></span>
+<span id="index-hywiki_002dactive_002din_002dcurrent_002dbuffer_002dp"></span>
+<span id="index-hywiki_002dmode-2"></span>
+<span id="index-hynote-file"></span>
+<span id="index-hywiki_002dmode"></span>
+</dd>
+<dt><span><code>hynote-file</code></span></dt>
+<dd><p>When on a HyNote file name stem, display the file and its optional
+section. This type is active only in buffers where
+<code>hywiki-active-in-current-buffer-p</code> is true. This may require
+that the global minor mode <code>hywiki-mode</code> has been enabled.
</p></dd>
</dl>
@@ -4414,7 +4455,7 @@ window configurations by name. See <a
href="#Window-Configurations">Window Conf
<div class="chapter" id="HyWiki">
<div class="header">
<p>
-Next: <a href="#HyControl" accesskey="n" rel="next">HyControl</a>, Previous:
<a href="#Menus" accesskey="p" rel="prev">Menus</a>, Up: <a href="#Top"
accesskey="u" rel="up">GNU Hyperbole</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Key-Index"
title="Index" rel="index">Index</a>]</p>
+Next: <a href="#HyNote" accesskey="n" rel="next">HyNote</a>, Previous: <a
href="#Menus" accesskey="p" rel="prev">Menus</a>, Up: <a href="#Top"
accesskey="u" rel="up">GNU Hyperbole</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Key-Index"
title="Index" rel="index">Index</a>]</p>
</div>
<span id="HyWiki-1"></span><h2 class="chapter">6 HyWiki</h2>
@@ -4426,9 +4467,10 @@ Next: <a href="#HyControl" accesskey="n"
rel="next">HyControl</a>, Previous: <a
<p>HyWiki is Hyperbole’s markup-free, personal Wiki system for
note-taking and automatic HyWikiWord highlighting and hyperlinking.
It uses Org mode for note taking and adds automatic hyperlinking and
-highlighting of HyWikiWords within Org files in <code>hywiki-directory</code>
-(default = <samp>~/hywiki</samp>). With <kbd>{C-h h h p}</kbd> you can publish
-your entire HyWiki to an HTML directory for export to the web.
+highlighting of HyWikiWords in Org files within
+<code>hywiki-directory</code> (default = <samp>~/hywiki</samp>). With
<kbd>{C-h h
+h p}</kbd> you can publish any updated part of your HyWiki to an HTML
+directory for export to the web.
</p>
<ul class="section-toc">
@@ -4503,9 +4545,9 @@ or not. When activating a link with a section reference,
you will get
an error if the section does not exist.
</p>
<span id="index-HyWikiWord_002c-outside-the-wiki"></span>
-<span id="index-hywiki_002dmode"></span>
-<span id="index-toggle-hywiki_002dmode"></span>
<span id="index-hywiki_002dmode-1"></span>
+<span id="index-toggle-hywiki_002dmode"></span>
+<span id="index-hywiki_002dmode-3"></span>
<span id="index-C_002dh-h-h-t"></span>
<p>HyWikiWords can also be highlighted and treated as hyperlinks in
non-special text and programming buffers outside of the
@@ -4568,7 +4610,7 @@ HyWikiWords recognized everywhere, add them to the custom
setting,
<code>hywiki-highlight-all-in-prog-modes</code> (default =
<code>'(lisp-interaction-mode)</code>).
</p>
-<span id="index-ibtypes-hywiki_002dword"></span>
+<span id="index-ibtypes-hywiki_002dword-1"></span>
<span id="index-ibtype-hywiki_002dword"></span>
<p>HyWiki adds one implicit button type to Hyperbole: <code>hywiki-word</code>,
which creates and displays HyWikiWord pages. This is one of the lowest
@@ -4640,6 +4682,11 @@ It looks like this:
<pre class="example">HyWiki> Act Create Edit GrepConsult Help Info Link
ModeToggle Org-M-RET/ Publish TagFind WikiWordConsult
</pre></div>
+<p>The GrepConsult and WikiWordConsult items appear only when the Consult
+package is installed prior to loading Hyperbole. These commands are
+especially useful as they allow for fast line-level searching across
+many files with interactive search pattern narrowing.
+</p>
<p>Below are descriptions of each menu item.
</p>
<span id="index-hywiki_002dconsult_002dgrep"></span>
@@ -4648,31 +4695,39 @@ It looks like this:
<dl compact="compact">
<dt><span>Act</span></dt>
<dd><p>Activate HyWikiWord link at point.
-</p></dd>
+</p>
+</dd>
<dt><span>Create</span></dt>
<dd><p>Create and display a new HyWiki page. Shows existing page names to aid
in new naming.
-</p></dd>
+</p>
+</dd>
<dt><span>Edit</span></dt>
<dd><p>Prompt with completion for and display a HyWiki page ready for editing.
-</p></dd>
+</p>
+</dd>
<dt><span>GrepConsult</span></dt>
<dd><p>Grep over HyWiki pages with interactive
<code>hywiki-consult-grep</code>.
-</p></dd>
+</p>
+</dd>
<dt><span>Help</span></dt>
<dd><p>Report on a HyWikiWord’s attributes.
-</p></dd>
+</p>
+</dd>
<dt><span>Info</span></dt>
<dd><p>Display Hyperbole manual section on HyWiki.
-</p></dd>
+</p>
+</dd>
<dt><span>Link</span></dt>
<dd><p>Prompt for and add a link at point to a HyWiki page.
-<span id="index-hywiki_002dmode-2"></span>
+</p>
+<span id="index-hywiki_002dmode-4"></span>
<span id="index-HyWiki-mode"></span>
<span id="index-HyWikiWords-outside-hywiki_002ddirectory"></span>
-</p></dd>
+</dd>
<dt><span>ModeToggle</span></dt>
<dd><p>Toggle global minor mode <code>hywiki-mode</code> that enables
HyWikiWord hyperlinks
in buffers outside of <code>hywiki-directory</code>.
+</p>
<span id="index-C_002dh-h-h-o"></span>
<span id="index-HyWiki_002c-C_002dh-h-h-o"></span>
<span id="index-C_002dh-h-h-c-1"></span>
@@ -4683,7 +4738,7 @@ in buffers outside of <code>hywiki-directory</code>.
<span id="index-Org-M_002dRET-customize-1"></span>
<span id="index-override-Org-M_002dRET-3"></span>
<span id="index-Org-M_002dRET-override-2"></span>
-</p></dd>
+</dd>
<dt><span>Org-M-RET/</span></dt>
<dd><p>Menu to customize contexts in which Hyperbole Action and Assist Keys
override Org’s <kbd>{M-<span class="key">RET</span>}</kbd> command. The
default is
@@ -4692,29 +4747,64 @@ make the Action Key create new HyWiki pages when
pressed on as-yet
undefined HyWikiWords; otherwise, you must use <kbd>{C-h h h c}</kbd> to
create a
new HyWiki page instead. Use ‘<samp>None</samp>’ if you want to
use Org’s <kbd>{M-<span class="key">RET</span>}</kbd> command in every
context within Org mode.
-</p></dd>
+</p>
+</dd>
<dt><span>Publish</span></dt>
<dd><p>Publish modified pages in the HyWiki to HTML; prefix arg to publish all
pages.
+</p>
<span id="index-HyWiki-tag-search"></span>
<span id="index-search_002c-HyWiki-tag"></span>
-</p></dd>
+</dd>
<dt><span>TagFind</span></dt>
<dd><p>Find a matching Org tag across all HyWiki pages.
-</p></dd>
+</p>
+</dd>
<dt><span>WikiWordConsult</span></dt>
<dd><p>Use <code>hywiki-consult-grep</code> to show occurrences of a prompted
for HyWikiWord.
</p></dd>
</dl>
+
<hr>
</div>
</div>
+<div class="chapter" id="HyNote">
+<div class="header">
+<p>
+Next: <a href="#HyControl" accesskey="n" rel="next">HyControl</a>, Previous:
<a href="#HyWiki" accesskey="p" rel="prev">HyWiki</a>, Up: <a href="#Top"
accesskey="u" rel="up">GNU Hyperbole</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Key-Index"
title="Index" rel="index">Index</a>]</p>
+</div>
+<span id="HyNote-1"></span><h2 class="chapter">7 HyNote</h2>
+<span id="index-HyNote"></span>
+<span id="index-notes"></span>
+<p>HyNote is a start on Hyperbole’s note taking system. HyNote supports
+Org, Markdown, Koutline and Emacs Outline file formats.
+</p>
+<span id="index-hynote_002ddirectory_002dlist"></span>
+<span id="index-ibtypes-hynote_002dfile-1"></span>
+<span id="index-ibtype-hynote_002dfile"></span>
+<p>Presently HyNote simply provides an experience similar to the HyWiki
+for Org and Org Roam file name stems and headline links for files
+found in the directories of <code>hynote-directory-list</code>, which
+defaults to the default Org and Org Roam directories. For example, if
+the file <samp>~/Org/hyperbole-cmds.org</samp> has a headline,
+‘<samp>hyrolo-fgrep Command</samp>’, then
"hyperbole-cmds#hyrolo-fgrep Command"
+in any file will link to that headline. See the documentation for the
+implicit button type that HyNote defines, <code>hynote-file</code>.
+</p>
+<p>In the future, HyNote will also provide a universal way to easily link to
+information across many file formats.
+</p>
+<p>See also <a href="#HyWiki">HyWiki</a>.
+</p>
+
+<hr>
+</div>
<div class="chapter" id="HyControl">
<div class="header">
<p>
-Next: <a href="#Koutliner" accesskey="n" rel="next">Koutliner</a>, Previous:
<a href="#HyWiki" accesskey="p" rel="prev">HyWiki</a>, Up: <a href="#Top"
accesskey="u" rel="up">GNU Hyperbole</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Key-Index"
title="Index" rel="index">Index</a>]</p>
+Next: <a href="#Koutliner" accesskey="n" rel="next">Koutliner</a>, Previous:
<a href="#HyNote" accesskey="p" rel="prev">HyNote</a>, Up: <a href="#Top"
accesskey="u" rel="up">GNU Hyperbole</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Key-Index"
title="Index" rel="index">Index</a>]</p>
</div>
-<span id="HyControl-1"></span><h2 class="chapter">7 HyControl</h2>
+<span id="HyControl-1"></span><h2 class="chapter">8 HyControl</h2>
<span id="index-windows-control"></span>
<span id="index-frames-control"></span>
<span id="index-HyControl"></span>
@@ -4834,7 +4924,7 @@ buffers with attached files and displays those.
<div class="float"><span id="image_003a2x3_002dWindows_002dGrid"></span>
<img src="im/wgrid-2x3.png" alt="2x3 Windows Grid">
-<div class="float-caption"><p><strong>Image 7.1: </strong>2x3 Windows
Grid</p></div></div><br>
+<div class="float-caption"><p><strong>Image 8.1: </strong>2x3 Windows
Grid</p></div></div><br>
<p>With a prefix argument of 0, the user is prompted for a major mode name and
the windows grid size. Only those buffers with the named major mode are
@@ -5307,7 +5397,7 @@ press that key, the other command can be reached by
pressing <kbd>{t}</kbd>.
<p>
Next: <a href="#HyRolo" accesskey="n" rel="next">HyRolo</a>, Previous: <a
href="#HyControl" accesskey="p" rel="prev">HyControl</a>, Up: <a href="#Top"
accesskey="u" rel="up">GNU Hyperbole</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Key-Index"
title="Index" rel="index">Index</a>]</p>
</div>
-<span id="Koutliner-1"></span><h2 class="chapter">8 Koutliner</h2>
+<span id="Koutliner-1"></span><h2 class="chapter">9 Koutliner</h2>
<span id="index-outliner"></span>
<span id="index-autonumber"></span>
@@ -5345,7 +5435,7 @@ commands available in the Koutliner.
<div class="float"><span id="image_003aKoutliner"></span>
<img src="im/koutliner.png" alt="Koutliner Screenshot">
-<div class="float-caption"><p><strong>Image 8.1: </strong>Koutliner
Screenshot</p></div></div><br>
+<div class="float-caption"><p><strong>Image 9.1: </strong>Koutliner
Screenshot</p></div></div><br>
@@ -5366,7 +5456,7 @@ commands available in the Koutliner.
<p>
Next: <a href="#Creating-Outlines" accesskey="n" rel="next">Creating
Outlines</a>, Previous: <a href="#Koutliner" accesskey="p"
rel="prev">Koutliner</a>, Up: <a href="#Koutliner" accesskey="u"
rel="up">Koutliner</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Menu-Commands-1"></span><h3 class="section">8.1 Menu Commands</h3>
+<span id="Menu-Commands-1"></span><h3 class="section">9.1 Menu Commands</h3>
<p>The Kotl/ menu entry on the Hyperbole minibuffer menu provides access to
a number of major Koutliner commands:
@@ -5420,7 +5510,7 @@ read the following sections explaining commands.
<div class="float"><span id="image_003aKoutline-Menu"></span>
<img src="im/menu-koutline.png" alt="Koutline Menu">
-<div class="float-caption"><p><strong>Image 8.2: </strong>Koutline
Menu</p></div></div><br>
+<div class="float-caption"><p><strong>Image 9.2: </strong>Koutline
Menu</p></div></div><br>
<hr>
</div>
@@ -5429,7 +5519,7 @@ read the following sections explaining commands.
<p>
Next: <a href="#Autonumbering" accesskey="n" rel="next">Autonumbering</a>,
Previous: <a href="#Menu-Commands" accesskey="p" rel="prev">Menu Commands</a>,
Up: <a href="#Koutliner" accesskey="u" rel="up">Koutliner</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Key-Index" title="Index" rel="index">Index</a>]</p>
</div>
-<span id="Creating-Outlines-1"></span><h3 class="section">8.2 Creating
Outlines</h3>
+<span id="Creating-Outlines-1"></span><h3 class="section">9.2 Creating
Outlines</h3>
<span id="index-outline-file-suffix"></span>
<span id="index-outline_002c-creating"></span>
@@ -5466,7 +5556,7 @@ structure of the outline changes.
<p>
Next: <a href="#Idstamps" accesskey="n" rel="next">Idstamps</a>, Previous: <a
href="#Creating-Outlines" accesskey="p" rel="prev">Creating Outlines</a>, Up:
<a href="#Koutliner" accesskey="u" rel="up">Koutliner</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Key-Index" title="Index" rel="index">Index</a>]</p>
</div>
-<span id="Autonumbering-1"></span><h3 class="section">8.3 Autonumbering</h3>
+<span id="Autonumbering-1"></span><h3 class="section">9.3 Autonumbering</h3>
<span id="index-autonumber-1"></span>
<span id="index-relative-identifier"></span>
@@ -5545,7 +5635,7 @@ initialization file, <samp>~/.emacs</samp>, substituting
for ‘your-separat
<p>
Next: <a href="#Editing-Outlines" accesskey="n" rel="next">Editing
Outlines</a>, Previous: <a href="#Autonumbering" accesskey="p"
rel="prev">Autonumbering</a>, Up: <a href="#Koutliner" accesskey="u"
rel="up">Koutliner</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Idstamps-1"></span><h3 class="section">8.4 Idstamps</h3>
+<span id="Idstamps-1"></span><h3 class="section">9.4 Idstamps</h3>
<span id="index-permanent-identifier-1"></span>
<span id="index-idstamp-1"></span>
@@ -5578,7 +5668,7 @@ begin with a 0, as in 012, to distinguish them from
relative ids.
<p>
Next: <a href="#Viewing-Outlines" accesskey="n" rel="next">Viewing
Outlines</a>, Previous: <a href="#Idstamps" accesskey="p"
rel="prev">Idstamps</a>, Up: <a href="#Koutliner" accesskey="u"
rel="up">Koutliner</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Editing-Outlines-1"></span><h3 class="section">8.5 Editing
Outlines</h3>
+<span id="Editing-Outlines-1"></span><h3 class="section">9.5 Editing
Outlines</h3>
<p>Text editing within the Koutliner works just as it does for other
buffers, except when you need to deal with the structural components of
@@ -5616,7 +5706,7 @@ selected region, since that will destroy the outline
structure.
<p>
Next: <a href="#Promoting-and-Demoting" accesskey="n" rel="next">Promoting and
Demoting</a>, Previous: <a href="#Editing-Outlines" accesskey="p"
rel="prev">Editing Outlines</a>, Up: <a href="#Editing-Outlines" accesskey="u"
rel="up">Editing Outlines</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Adding-and-Killing-1"></span><h4 class="subsection">8.5.1 Adding and
Killing</h4>
+<span id="Adding-and-Killing-1"></span><h4 class="subsection">9.5.1 Adding and
Killing</h4>
<span id="index-koutliner_002c-C_002dj"></span>
<span id="index-koutliner_002c-C_002du-c_002dj"></span>
@@ -5653,7 +5743,7 @@ buffer with <kbd>{C-y}</kbd>.
<p>
Next: <a href="#Relocating-and-Copying" accesskey="n" rel="next">Relocating
and Copying</a>, Previous: <a href="#Adding-and-Killing" accesskey="p"
rel="prev">Adding and Killing</a>, Up: <a href="#Editing-Outlines"
accesskey="u" rel="up">Editing Outlines</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Key-Index"
title="Index" rel="index">Index</a>]</p>
</div>
-<span id="Promoting-and-Demoting-1"></span><h4 class="subsection">8.5.2
Promoting and Demoting</h4>
+<span id="Promoting-and-Demoting-1"></span><h4 class="subsection">9.5.2
Promoting and Demoting</h4>
<span id="index-promotion"></span>
<span id="index-demotion"></span>
@@ -5750,7 +5840,7 @@ to demote/promote Koutline trees when in a table since
<tt class="key">TAB</tt>
<p>
Next: <a href="#Moving-Around" accesskey="n" rel="next">Moving Around</a>,
Previous: <a href="#Promoting-and-Demoting" accesskey="p" rel="prev">Promoting
and Demoting</a>, Up: <a href="#Editing-Outlines" accesskey="u"
rel="up">Editing Outlines</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Relocating-and-Copying-1"></span><h4 class="subsection">8.5.3
Relocating and Copying</h4>
+<span id="Relocating-and-Copying-1"></span><h4 class="subsection">9.5.3
Relocating and Copying</h4>
<span id="index-tree_002c-copying"></span>
<span id="index-tree_002c-moving"></span>
@@ -5868,7 +5958,7 @@ See <a href="#Inserting-and-Importing">Inserting and
Importing</a>.
<p>
Next: <a href="#Filling" accesskey="n" rel="next">Filling</a>, Previous: <a
href="#Relocating-and-Copying" accesskey="p" rel="prev">Relocating and
Copying</a>, Up: <a href="#Editing-Outlines" accesskey="u" rel="up">Editing
Outlines</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Moving-Around-1"></span><h4 class="subsection">8.5.4 Moving
Around</h4>
+<span id="Moving-Around-1"></span><h4 class="subsection">9.5.4 Moving
Around</h4>
<span id="index-outline_002c-motion"></span>
<p>In addition to normal emacs movement commands, you can move within a
@@ -5939,7 +6029,7 @@ cell or from one cell or tree to another.
<p>
Next: <a href="#Transposing" accesskey="n" rel="next">Transposing</a>,
Previous: <a href="#Moving-Around" accesskey="p" rel="prev">Moving Around</a>,
Up: <a href="#Editing-Outlines" accesskey="u" rel="up">Editing Outlines</a>
[<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Filling-1"></span><h4 class="subsection">8.5.5 Filling</h4>
+<span id="Filling-1"></span><h4 class="subsection">9.5.5 Filling</h4>
<span id="index-outline_002c-filling"></span>
<span id="index-filling"></span>
@@ -5986,7 +6076,7 @@ a ‘no-fill’ property, then your formatting
will be lost.
<p>
Next: <a href="#Splitting-and-Appending" accesskey="n" rel="next">Splitting
and Appending</a>, Previous: <a href="#Filling" accesskey="p"
rel="prev">Filling</a>, Up: <a href="#Editing-Outlines" accesskey="u"
rel="up">Editing Outlines</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Transposing-1"></span><h4 class="subsection">8.5.6 Transposing</h4>
+<span id="Transposing-1"></span><h4 class="subsection">9.5.6 Transposing</h4>
<p>The Koutliner move and copy commands rearrange entire trees. The
following two commands, in contrast, exchange the locations of two
@@ -6020,7 +6110,7 @@ fewer visible, it makes the current cell the last cell in
the outline.
<p>
Next: <a href="#Inserting-and-Importing" accesskey="n" rel="next">Inserting
and Importing</a>, Previous: <a href="#Transposing" accesskey="p"
rel="prev">Transposing</a>, Up: <a href="#Editing-Outlines" accesskey="u"
rel="up">Editing Outlines</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Splitting-and-Appending-1"></span><h4 class="subsection">8.5.7
Splitting and Appending</h4>
+<span id="Splitting-and-Appending-1"></span><h4 class="subsection">9.5.7
Splitting and Appending</h4>
<span id="index-splitting-a-cell"></span>
<span id="index-cell_002c-splitting"></span>
@@ -6054,7 +6144,7 @@ This helps maintain any special formatting the appended
text may have.
<p>
Next: <a href="#Exporting" accesskey="n" rel="next">Exporting</a>, Previous:
<a href="#Splitting-and-Appending" accesskey="p" rel="prev">Splitting and
Appending</a>, Up: <a href="#Editing-Outlines" accesskey="u" rel="up">Editing
Outlines</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Inserting-and-Importing-1"></span><h4 class="subsection">8.5.8
Inserting and Importing</h4>
+<span id="Inserting-and-Importing-1"></span><h4 class="subsection">9.5.8
Inserting and Importing</h4>
<span id="index-outline_002c-inserting-into"></span>
<span id="index-outline_002c-importing-into"></span>
@@ -6148,7 +6238,7 @@ information.
<p>
Previous: <a href="#Inserting-and-Importing" accesskey="p"
rel="prev">Inserting and Importing</a>, Up: <a href="#Editing-Outlines"
accesskey="u" rel="up">Editing Outlines</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Key-Index"
title="Index" rel="index">Index</a>]</p>
</div>
-<span id="Exporting-1"></span><h4 class="subsection">8.5.9 Exporting</h4>
+<span id="Exporting-1"></span><h4 class="subsection">9.5.9 Exporting</h4>
<span id="index-outline_002c-exporting-1"></span>
<span id="index-outline_002c-HTML-conversion"></span>
@@ -6191,7 +6281,7 @@ not be displayed; you must display it manually, if
desired.
<p>
Next: <a href="#Klinks" accesskey="n" rel="next">Klinks</a>, Previous: <a
href="#Editing-Outlines" accesskey="p" rel="prev">Editing Outlines</a>, Up: <a
href="#Koutliner" accesskey="u" rel="up">Koutliner</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Key-Index" title="Index" rel="index">Index</a>]</p>
</div>
-<span id="Viewing-Outlines-1"></span><h3 class="section">8.6 Viewing
Outlines</h3>
+<span id="Viewing-Outlines-1"></span><h3 class="section">9.6 Viewing
Outlines</h3>
<span id="index-outline_002c-viewing"></span>
<span id="index-view"></span>
@@ -6209,7 +6299,7 @@ effectively browse and study large amounts of material.
<p>
Next: <a href="#View-Specs" accesskey="n" rel="next">View Specs</a>, Previous:
<a href="#Viewing-Outlines" accesskey="p" rel="prev">Viewing Outlines</a>, Up:
<a href="#Viewing-Outlines" accesskey="u" rel="up">Viewing Outlines</a>
[<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Hiding-and-Showing-1"></span><h4 class="subsection">8.6.1 Hiding and
Showing</h4>
+<span id="Hiding-and-Showing-1"></span><h4 class="subsection">9.6.1 Hiding and
Showing</h4>
<span id="index-outline_002c-hiding"></span>
<span id="index-outline_002c-showing"></span>
@@ -6313,7 +6403,7 @@ point. Try it with either your mouse or with
<kbd>{M-<span class="key">RET</spa
<p>
Previous: <a href="#Hiding-and-Showing" accesskey="p" rel="prev">Hiding and
Showing</a>, Up: <a href="#Viewing-Outlines" accesskey="u" rel="up">Viewing
Outlines</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="View-Specs-1"></span><h4 class="subsection">8.6.2 View Specs</h4>
+<span id="View-Specs-1"></span><h4 class="subsection">9.6.2 View Specs</h4>
<span id="index-view-spec"></span>
<span id="index-modeline_002c-view-spec"></span>
@@ -6430,7 +6520,7 @@ cells below level one.
<p>
Next: <a href="#Cell-Attributes" accesskey="n" rel="next">Cell Attributes</a>,
Previous: <a href="#Viewing-Outlines" accesskey="p" rel="prev">Viewing
Outlines</a>, Up: <a href="#Koutliner" accesskey="u" rel="up">Koutliner</a>
[<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Klinks-1"></span><h3 class="section">8.7 Klinks</h3>
+<span id="Klinks-1"></span><h3 class="section">9.7 Klinks</h3>
<span id="index-link"></span>
<span id="index-hyperlink"></span>
@@ -6576,7 +6666,7 @@ mistakenly recognizes a pattern within a comment as a
klink when it isn’t.
<p>
Next: <a href="#Koutliner-History" accesskey="n" rel="next">Koutliner
History</a>, Previous: <a href="#Klinks" accesskey="p" rel="prev">Klinks</a>,
Up: <a href="#Koutliner" accesskey="u" rel="up">Koutliner</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Key-Index" title="Index" rel="index">Index</a>]</p>
</div>
-<span id="Cell-Attributes-1"></span><h3 class="section">8.8 Cell
Attributes</h3>
+<span id="Cell-Attributes-1"></span><h3 class="section">9.8 Cell
Attributes</h3>
<span id="index-cell-attribute"></span>
<span id="index-attribute"></span>
@@ -6665,7 +6755,7 @@ attributes for all visible cells in the outline.
<p>
Previous: <a href="#Cell-Attributes" accesskey="p" rel="prev">Cell
Attributes</a>, Up: <a href="#Koutliner" accesskey="u" rel="up">Koutliner</a>
[<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Koutliner-History-1"></span><h3 class="section">8.9 Koutliner
History</h3>
+<span id="Koutliner-History-1"></span><h3 class="section">9.9 Koutliner
History</h3>
<span id="index-NLS"></span>
<span id="index-Augment"></span>
@@ -6698,14 +6788,15 @@ these capabilities back into the mainstream of modern
computing culture.
<p>
Next: <a href="#Window-Configurations" accesskey="n" rel="next">Window
Configurations</a>, Previous: <a href="#Koutliner" accesskey="p"
rel="prev">Koutliner</a>, Up: <a href="#Top" accesskey="u" rel="up">GNU
Hyperbole</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="HyRolo-1"></span><h2 class="chapter">9 HyRolo</h2>
+<span id="HyRolo-1"></span><h2 class="chapter">10 HyRolo</h2>
-<span id="index-Rolo"></span>
+<span id="index-rolo"></span>
<span id="index-HyRolo"></span>
-<p>Hyperbole includes a complete, advanced rolo system, HyRolo, for
-convenient management of hierarchical, record-oriented information.
-Most often this is used for contact management but it can quickly be
-adapted to most any record-oriented lookup task requiring fast retrieval.
+<p>Hyperbole includes HyRolo, a complete, advanced system for convenient
+management of hierarchical, record-oriented information. Most often
+this is used for contact management but it can quickly be adapted to
+most any record-oriented lookup task requiring fast retrieval. There
+is also a Python-based command-line version, <samp>hyrolo.py</samp>, included.
</p>
<span id="index-rolo_002c-buttons-in"></span>
<p>Hyperbole buttons may be included within rolo records and then
@@ -6728,7 +6819,7 @@ tool.
<p>
Next: <a href="#HyRolo-Menu" accesskey="n" rel="next">Rolo Menu</a>, Previous:
<a href="#HyRolo" accesskey="p" rel="prev">HyRolo</a>, Up: <a href="#HyRolo"
accesskey="u" rel="up">HyRolo</a> [<a href="#SEC_Contents" title="Table
of contents" rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="HyRolo-Concepts-1"></span><h3 class="section">9.1 HyRolo
Concepts</h3>
+<span id="HyRolo-Concepts-1"></span><h3 class="section">10.1 HyRolo
Concepts</h3>
<span id="index-rolo-file"></span>
<span id="index-rolo-entry"></span>
@@ -6818,7 +6909,7 @@ Searching for Manager turns up all Staffer entries.
<p>
Next: <a href="#HyRolo-Searching" accesskey="n" rel="next">HyRolo
Searching</a>, Previous: <a href="#HyRolo-Concepts" accesskey="p"
rel="prev">HyRolo Concepts</a>, Up: <a href="#HyRolo" accesskey="u"
rel="up">HyRolo</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Rolo-Menu"></span><h3 class="section">9.2 Rolo Menu</h3>
+<span id="Rolo-Menu"></span><h3 class="section">10.2 Rolo Menu</h3>
<p>The Rolo submenu of the Hyperbole menu offers a full set of commands
for searching and maintaining a personal address book. It looks like
@@ -6827,7 +6918,7 @@ so.
<div class="float"><span id="image_003aRolo-Menu"></span>
<img src="im/menu-rolo.png" alt="HyRolo Menu">
-<div class="float-caption"><p><strong>Image 9.1: </strong>HyRolo
Menu</p></div></div>
+<div class="float-caption"><p><strong>Image 10.1: </strong>HyRolo
Menu</p></div></div>
<span id="index-Rolo-menu"></span>
<span id="index-HyRolo-menu"></span>
<span id="index-menu_002c-HyRolo"></span>
@@ -6859,8 +6950,9 @@ set of commands as the menubar Rolo menu but with more
concise labels.
<span id="index-hyrolo_002dword"></span>
<span id="index-hyrolo_002dyank"></span>
<p>The minibuffer Rolo/ menu offers the following commands (ConsultFind
-and HelmFind appear only when associated packages are loaded but are
-especially noteworthy as they allow for line-level searching with
+and HelmFind appear only when the Consult and Helm packages are
+installed prior to loading Hyperbole. They are especially noteworthy
+as they allow for fast line-level searching across many files with
interactive search pattern narrowing):
</p>
<div class="example">
@@ -6926,7 +7018,7 @@ containing "Staffer" at any level in a
hierarchy, like so:
<p>
Next: <a href="#HyRolo-Keys" accesskey="n" rel="next">HyRolo Keys</a>,
Previous: <a href="#HyRolo-Menu" accesskey="p" rel="prev">Rolo Menu</a>, Up: <a
href="#HyRolo" accesskey="u" rel="up">HyRolo</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Key-Index" title="Index" rel="index">Index</a>]</p>
</div>
-<span id="HyRolo-Searching-1"></span><h3 class="section">9.3 HyRolo
Searching</h3>
+<span id="HyRolo-Searching-1"></span><h3 class="section">10.3 HyRolo
Searching</h3>
<span id="index-rolo-searching"></span>
<span id="index-searching_002c-rolo"></span>
@@ -7015,7 +7107,7 @@ to match. For example:
<p>
Next: <a href="#HyRolo-Settings" accesskey="n" rel="next">HyRolo Settings</a>,
Previous: <a href="#HyRolo-Searching" accesskey="p" rel="prev">HyRolo
Searching</a>, Up: <a href="#HyRolo" accesskey="u" rel="up">HyRolo</a>
[<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="HyRolo-Keys-1"></span><h3 class="section">9.4 HyRolo Keys</h3>
+<span id="HyRolo-Keys-1"></span><h3 class="section">10.4 HyRolo Keys</h3>
<span id="index-hyrolo-menu"></span>
<span id="index-rolo-keys"></span>
@@ -7210,7 +7302,7 @@ current frame to its state prior to the rolo search.
<p>
Previous: <a href="#HyRolo-Keys" accesskey="p" rel="prev">HyRolo Keys</a>, Up:
<a href="#HyRolo" accesskey="u" rel="up">HyRolo</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Key-Index" title="Index" rel="index">Index</a>]</p>
</div>
-<span id="HyRolo-Settings-1"></span><h3 class="section">9.5 HyRolo
Settings</h3>
+<span id="HyRolo-Settings-1"></span><h3 class="section">10.5 HyRolo
Settings</h3>
<span id="index-hyrolo_002dfile_002dlist-1"></span>
<span id="index-rolo_002c-personal"></span>
@@ -7380,7 +7472,7 @@ There is never a need to learn a complicated query
language.
<p>
Next: <a href="#Developing-with-Hyperbole" accesskey="n" rel="next">Developing
with Hyperbole</a>, Previous: <a href="#HyRolo" accesskey="p"
rel="prev">HyRolo</a>, Up: <a href="#Top" accesskey="u" rel="up">GNU
Hyperbole</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Window-Configurations-1"></span><h2 class="chapter">10 Window
Configurations</h2>
+<span id="Window-Configurations-1"></span><h2 class="chapter">11 Window
Configurations</h2>
<span id="index-window-configurations"></span>
<span id="index-restoring-windows"></span>
@@ -7484,7 +7576,7 @@ is added.
<p>
Next: <a href="#Glossary" accesskey="n" rel="next">Glossary</a>, Previous: <a
href="#Window-Configurations" accesskey="p" rel="prev">Window
Configurations</a>, Up: <a href="#Top" accesskey="u" rel="up">GNU Hyperbole</a>
[<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Developing-with-Hyperbole-1"></span><h2 class="chapter">11
Developing with Hyperbole</h2>
+<span id="Developing-with-Hyperbole-1"></span><h2 class="chapter">12
Developing with Hyperbole</h2>
<p>This chapter is for people who wish to customize Hyperbole, to extend
it, or to develop other systems using Hyperbole as a base. Most of it
@@ -7507,7 +7599,7 @@ regular expressions.
<p>
Next: <a href="#Creating-Types" accesskey="n" rel="next">Creating Types</a>,
Previous: <a href="#Developing-with-Hyperbole" accesskey="p"
rel="prev">Developing with Hyperbole</a>, Up: <a
href="#Developing-with-Hyperbole" accesskey="u" rel="up">Developing with
Hyperbole</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Hook-Variables-1"></span><h3 class="section">11.1 Hook Variables</h3>
+<span id="Hook-Variables-1"></span><h3 class="section">12.1 Hook Variables</h3>
<span id="index-variables"></span>
<span id="index-hook-variables"></span>
@@ -7649,7 +7741,7 @@ specific usage of such hooks.
<p>
Next: <a href="#Explicit-Button-Technicalities" accesskey="n"
rel="next">Explicit Button Technicalities</a>, Previous: <a
href="#Hook-Variables" accesskey="p" rel="prev">Hook Variables</a>, Up: <a
href="#Developing-with-Hyperbole" accesskey="u" rel="up">Developing with
Hyperbole</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Creating-Types-1"></span><h3 class="section">11.2 Creating Types</h3>
+<span id="Creating-Types-1"></span><h3 class="section">12.2 Creating Types</h3>
<span id="index-type-definition"></span>
<span id="index-type-redefinition-1"></span>
@@ -7690,7 +7782,7 @@ and <samp>hibtypes.el</samp> for examples.
<p>
Next: <a href="#Creating-Implicit-Button-Types" accesskey="n"
rel="next">Creating Implicit Button Types</a>, Previous: <a
href="#Creating-Types" accesskey="p" rel="prev">Creating Types</a>, Up: <a
href="#Creating-Types" accesskey="u" rel="up">Creating Types</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Key-Index" title="Index" rel="index">Index</a>]</p>
</div>
-<span id="Creating-Action-Types-1"></span><h4 class="subsection">11.2.1
Creating Action Types</h4>
+<span id="Creating-Action-Types-1"></span><h4 class="subsection">12.2.1
Creating Action Types</h4>
<span id="index-actype_003acreate"></span>
<span id="index-file_002c-hactypes_002eel-1"></span>
@@ -7813,7 +7905,7 @@ returned by the call).
<p>
Previous: <a href="#Creating-Action-Types" accesskey="p" rel="prev">Creating
Action Types</a>, Up: <a href="#Creating-Types" accesskey="u" rel="up">Creating
Types</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Creating-Implicit-Button-Types-1"></span><h4
class="subsection">11.2.2 Creating Implicit Button Types</h4>
+<span id="Creating-Implicit-Button-Types-1"></span><h4
class="subsection">12.2.2 Creating Implicit Button Types</h4>
<p>Implicit buttons leverage the same action types used by explicit and
global buttons but each carries an additional implicit button type
@@ -7862,7 +7954,7 @@ techniques.
<p>
Next: <a href="#Implicit-Button-Link-Types" accesskey="n" rel="next">Implicit
Button Link Types</a>, Previous: <a href="#Creating-Implicit-Button-Types"
accesskey="p" rel="prev">Creating Implicit Button Types</a>, Up: <a
href="#Creating-Implicit-Button-Types" accesskey="u" rel="up">Creating Implicit
Button Types</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Action-Button-Link-Types-1"></span><h4
class="subsubsection">11.2.2.1 Action Button Link Types</h4>
+<span id="Action-Button-Link-Types-1"></span><h4
class="subsubsection">12.2.2.1 Action Button Link Types</h4>
<p>The simplest way to create a new implicit link type (from which any
number of buttons can be recognized within text) is to create an
@@ -7923,7 +8015,7 @@ expression-based link type creation. See <a
href="#Programmatic-Implicit-Button
<p>
Next: <a href="#Programmatic-Implicit-Button-Types" accesskey="n"
rel="next">Programmatic Implicit Button Types</a>, Previous: <a
href="#Action-Button-Link-Types" accesskey="p" rel="prev">Action Button Link
Types</a>, Up: <a href="#Creating-Implicit-Button-Types" accesskey="u"
rel="up">Creating Implicit Button Types</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Key-Index"
title="Index" rel="index">Index</a>]</p>
</div>
-<span id="Implicit-Button-Link-Types-1"></span><h4
class="subsubsection">11.2.2.2 Implicit Button Link Types</h4>
+<span id="Implicit-Button-Link-Types-1"></span><h4
class="subsubsection">12.2.2.2 Implicit Button Link Types</h4>
<p>If you understand Emacs regular expressions (see <a data-manual="emacs"
href="https://www.gnu.org/software/emacs/manual/html_mono/emacs.html#Regexps";>Syntax
of
Regular Expressions</a> in <cite>the GNU Emacs Manual</cite>), you can create
new
@@ -7998,7 +8090,7 @@ same thing without any special definitions.
<p>
Previous: <a href="#Implicit-Button-Link-Types" accesskey="p"
rel="prev">Implicit Button Link Types</a>, Up: <a
href="#Creating-Implicit-Button-Types" accesskey="u" rel="up">Creating Implicit
Button Types</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Programmatic-Implicit-Button-Types-1"></span><h4
class="subsubsection">11.2.2.3 Programmatic Implicit Button Types</h4>
+<span id="Programmatic-Implicit-Button-Types-1"></span><h4
class="subsubsection">12.2.2.3 Programmatic Implicit Button Types</h4>
<span id="index-implicit-button-type-1"></span>
<span id="index-ibtype"></span>
@@ -8123,7 +8215,7 @@ the <samp>hib-kbd.el</samp> file for an example of a
custom help function.
<p>
Next: <a href="#Encapsulating-Systems" accesskey="n" rel="next">Encapsulating
Systems</a>, Previous: <a href="#Creating-Types" accesskey="p"
rel="prev">Creating Types</a>, Up: <a href="#Developing-with-Hyperbole"
accesskey="u" rel="up">Developing with Hyperbole</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Key-Index" title="Index" rel="index">Index</a>]</p>
</div>
-<span id="Explicit-Button-Technicalities-1"></span><h3 class="section">11.3
Explicit Button Technicalities</h3>
+<span id="Explicit-Button-Technicalities-1"></span><h3 class="section">12.3
Explicit Button Technicalities</h3>
<ul class="section-toc">
<li><a href="#Button-Label-Normalization" accesskey="1">Button Label
Normalization</a></li>
@@ -8136,7 +8228,7 @@ Next: <a href="#Encapsulating-Systems" accesskey="n"
rel="next">Encapsulating Sy
<p>
Next: <a href="#Operational-and-Storage-Formats" accesskey="n"
rel="next">Operational and Storage Formats</a>, Previous: <a
href="#Explicit-Button-Technicalities" accesskey="p" rel="prev">Explicit Button
Technicalities</a>, Up: <a href="#Explicit-Button-Technicalities" accesskey="u"
rel="up">Explicit Button Technicalities</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Key-Index"
title="Index" rel="index">Index</a>]</p>
</div>
-<span id="Button-Label-Normalization-1"></span><h4 class="subsection">11.3.1
Button Label Normalization</h4>
+<span id="Button-Label-Normalization-1"></span><h4 class="subsection">12.3.1
Button Label Normalization</h4>
<span id="index-normalized-label"></span>
<span id="index-button-label-2"></span>
<span id="index-button-key"></span>
@@ -8184,7 +8276,7 @@ intervention is required.
<p>
Next: <a href="#Programmatic-Button-Creation" accesskey="n"
rel="next">Programmatic Button Creation</a>, Previous: <a
href="#Button-Label-Normalization" accesskey="p" rel="prev">Button Label
Normalization</a>, Up: <a href="#Explicit-Button-Technicalities" accesskey="u"
rel="up">Explicit Button Technicalities</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Key-Index"
title="Index" rel="index">Index</a>]</p>
</div>
-<span id="Operational-and-Storage-Formats-1"></span><h4
class="subsection">11.3.2 Operational and Storage Formats</h4>
+<span id="Operational-and-Storage-Formats-1"></span><h4
class="subsection">12.3.2 Operational and Storage Formats</h4>
<span id="index-explicit-button-formats"></span>
<span id="index-explicit-button-storage"></span>
@@ -8218,7 +8310,7 @@ any Hyperbole client programming.
<p>
Previous: <a href="#Operational-and-Storage-Formats" accesskey="p"
rel="prev">Operational and Storage Formats</a>, Up: <a
href="#Explicit-Button-Technicalities" accesskey="u" rel="up">Explicit Button
Technicalities</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Programmatic-Button-Creation-1"></span><h4 class="subsection">11.3.3
Programmatic Button Creation</h4>
+<span id="Programmatic-Button-Creation-1"></span><h4 class="subsection">12.3.3
Programmatic Button Creation</h4>
<span id="index-explicit-button_002c-programmatic-creation"></span>
<p>A common need when developing with Hyperbole is to create or to modify
@@ -8265,7 +8357,7 @@ buttons at the end of the personal button file.
<p>
Next: <a href="#Embedding-Hyperbole" accesskey="n" rel="next">Embedding
Hyperbole</a>, Previous: <a href="#Explicit-Button-Technicalities"
accesskey="p" rel="prev">Explicit Button Technicalities</a>, Up: <a
href="#Developing-with-Hyperbole" accesskey="u" rel="up">Developing with
Hyperbole</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Key-Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<span id="Encapsulating-Systems-1"></span><h3 class="section">11.4
Encapsulating Systems</h3>
+<span id="Encapsulating-Systems-1"></span><h3 class="section">12.4
Encapsulating Systems</h3>
<span id="index-file_002c-hsys_002d_002a"></span>
<span id="index-Hyperbole_002c-system-encapsulation"></span>
@@ -8294,7 +8386,7 @@ that a press of the Action Key follows a URL.
<p>
Previous: <a href="#Encapsulating-Systems" accesskey="p"
rel="prev">Encapsulating Systems</a>, Up: <a href="#Developing-with-Hyperbole"
accesskey="u" rel="up">Developing with Hyperbole</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Key-Index" title="Index" rel="index">Index</a>]</p>
</div>
-<span id="Embedding-Hyperbole-1"></span><h3 class="section">11.5 Embedding
Hyperbole</h3>
+<span id="Embedding-Hyperbole-1"></span><h3 class="section">12.5 Embedding
Hyperbole</h3>
<span id="index-Hyperbole-API"></span>
<span id="index-API"></span>
@@ -8656,6 +8748,22 @@ fast, single key manipulation of window and frame
creation, deletion,
sizing, position and face zooming (enlarging/shrinking).
</p>
</dd>
+<dt><span><b>HyNote</b></span></dt>
+<dd><p>HyNote is a start on Hyperbole’s note taking system. It presently
+simply provides an experience similar to HyWiki, but for Org directory
+and Org Roam file and headline links. See the documentation for the
+implicit button type it defines, <code>hynote-file</code>.
+</p>
+<p>HyNote supports Org, Markdown, Koutline and Emacs Outline file
+formats. It uses UUIDs and HyRolo for quick note lookups across
+matching files in <code>hynote-directory-list</code>.
+</p>
+<p>In the future, it will also provide a universal way to easily link to
+information across many file formats.
+</p>
+<p>See also <b>HyWiki</b>.
+</p>
+</dd>
<dt><span><b>Hyperbole</b></span></dt>
<dd><p>The flexible, programmable information management and viewing system
documented by this manual. It utilizes a button-action model and supports
@@ -8688,10 +8796,14 @@ DataBase (BBDB) package.
<dd><p>HyWiki, the Hyperbole personal wiki tool, lets you create a personal
wiki of interlinked Org files in a single directory, where each page
name automatically becomes a live HyWikiWord link back to the
-associated page whenever added in any file in the HyWiki directory.
-HyWikiWords also work outside this directory if you turn on the minor
-<code>hywiki-mode</code> in other buffers. A single command exports an
-entire HyWiki to the web.
+associated page whenever added in any file within the HyWiki
+directory. HyWikiWords also work outside this directory if you turn
+on the minor <code>hywiki-mode</code> in other buffers. A single command,
+<kbd>{C-u C-h h h p}</kbd>, publishes/exports an entire HyWiki to HTML for
+display on the web.
+</p>
+<p>See the documentation for its implicit button types,
<code>hywiki-word</code>
+and <code>hywiki-existing-word</code>.
</p>
</dd>
<dt><span><b>Ilink</b></span></dt>
@@ -14274,6 +14386,7 @@ Next: <a href="#Concept-Index" accesskey="n"
rel="next">Concept Index</a>, Previ
<tr><td></td><td valign="top"><a
href="#index-hycontrol_002dwindows_002dgrid_002dby_002dbuffer_002dlist"><code>hycontrol-windows-grid-by-buffer-list</code></a>:</td><td> </td><td
valign="top"><a href="#HyControl">HyControl</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-hycontrol_002dwindows_002dgrid_002dby_002dfile_002dlist"><code>hycontrol-windows-grid-by-file-list</code></a>:</td><td> </td><td
valign="top"><a href="#HyControl">HyControl</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-hycontrol_002dwindows_002dgrid_002dby_002dfile_002dpattern"><code>hycontrol-windows-grid-by-file-pattern</code></a>:</td><td> </td><td
valign="top"><a href="#HyControl">HyControl</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-hynote_002ddirectory_002dlist">hynote-directory-list</a>:</td><td> </td><td
valign="top"><a href="#HyNote">HyNote</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-hypb_003afgrep_002dgit_002dlog"><code>hypb:fgrep-git-log</code></a>:</td><td> </td><td
valign="top"><a href="#Implicit-Button-Types">Implicit Button
Types</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-hypb_003agrep_002dgit_002dlog"><code>hypb:grep-git-log</code></a>:</td><td> </td><td
valign="top"><a href="#Implicit-Button-Types">Implicit Button
Types</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-hypb_003argrep_002dcommand">hypb:rgrep-command</a>:</td><td> </td><td
valign="top"><a href="#Menus">Menus</a></td></tr>
@@ -14338,12 +14451,14 @@ Next: <a href="#Concept-Index" accesskey="n"
rel="next">Concept Index</a>, Previ
<tr><td></td><td valign="top"><a
href="#index-hywconfig_002dring_002dsave-1"><code>hywconfig-ring-save</code></a>:</td><td> </td><td
valign="top"><a href="#Window-Configurations">Window
Configurations</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-hywconfig_002dyank_002dpop"><code>hywconfig-yank-pop</code></a>:</td><td> </td><td
valign="top"><a href="#Window-Configurations">Window
Configurations</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-hywconfig_002dyank_002dpop-1"><code>hywconfig-yank-pop</code></a>:</td><td> </td><td
valign="top"><a href="#Window-Configurations">Window
Configurations</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-hywiki_002dactive_002din_002dcurrent_002dbuffer_002dp"><code>hywiki-active-in-current-buffer-p</code></a>:</td><td> </td><td
valign="top"><a href="#Implicit-Button-Types">Implicit Button
Types</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-hywiki_002dconsult_002dgrep"><code>hywiki-consult-grep</code></a>:</td><td> </td><td
valign="top"><a href="#HyWiki-Menu">HyWiki Menu</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-hywiki_002ddirectory">hywiki-directory</a>:</td><td> </td><td
valign="top"><a href="#HyWiki">HyWiki</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-hywiki_002dexclude_002dmajor_002dmodes">hywiki-exclude-major-modes</a>:</td><td> </td><td
valign="top"><a href="#HyWikiWords">HyWikiWords</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-hywiki_002dhighlight_002dall_002din_002dprog_002dmodes">hywiki-highlight-all-in-prog-modes</a>:</td><td> </td><td
valign="top"><a href="#HyWikiWords">HyWikiWords</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-hywiki_002dmode-1"><code>hywiki-mode</code></a>:</td><td> </td><td
valign="top"><a href="#HyWikiWords">HyWikiWords</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-hywiki_002dmode-2"><code>hywiki-mode</code></a>:</td><td> </td><td
valign="top"><a href="#HyWiki-Menu">HyWiki Menu</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-hywiki_002dmode-2"><code>hywiki-mode</code></a>:</td><td> </td><td
valign="top"><a href="#Implicit-Button-Types">Implicit Button
Types</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-hywiki_002dmode-3"><code>hywiki-mode</code></a>:</td><td> </td><td
valign="top"><a href="#HyWikiWords">HyWikiWords</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-hywiki_002dmode-4"><code>hywiki-mode</code></a>:</td><td> </td><td
valign="top"><a href="#HyWiki-Menu">HyWiki Menu</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-hywiki_002dorg_002dget_002dpublish_002dproperty"><code>hywiki-org-get-publish-property</code></a>:</td><td> </td><td
valign="top"><a href="#Publish-HyWiki">Publish HyWiki</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-hywiki_002dorg_002dlink_002dtype_002drequired">hywiki-org-link-type-required</a>:</td><td> </td><td
valign="top"><a href="#HyWikiWords">HyWikiWords</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-hywiki_002dorg_002dpublish_002dproject_002dalist">hywiki-org-publish-project-alist</a>:</td><td> </td><td
valign="top"><a href="#Publish-HyWiki">Publish HyWiki</a></td></tr>
@@ -14372,13 +14487,18 @@ Next: <a href="#Concept-Index" accesskey="n"
rel="next">Concept Index</a>, Previ
<tr><td></td><td valign="top"><a href="#index-ibtypes-glink"><code>ibtypes
glink</code></a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-ibtypes-gnus_002dpush_002dbutton"><code>ibtypes
gnus-push-button</code></a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-ibtypes-grep_002dmsg"><code>ibtypes
grep-msg</code></a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-ibtypes-hynote_002dfile"><code>ibtypes
hynote-file</code></a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-ibtypes-hynote_002dfile-1"><code>ibtypes
hynote-file</code></a>:</td><td> </td><td valign="top"><a
href="#HyNote">HyNote</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-ibtypes-hyp_002daddress"><code>ibtypes
hyp-address</code></a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-ibtypes-hyp_002dhtml_002dmanual"><code>ibtypes
hyp-html-manual</code></a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-ibtypes-hyp_002dsource"><code>ibtypes
hyp-source</code></a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-ibtypes-hyperbole_002drun_002dtest"><code>ibtypes
hyperbole-run-test</code></a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-ibtypes-hyperbole_002drun_002dtest_002ddefinition"><code>ibtypes
hyperbole-run-test-definition</code></a>:</td><td> </td><td
valign="top"><a href="#Implicit-Button-Types">Implicit Button
Types</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-ibtypes-hyperbole_002drun_002dtests"><code>ibtypes
hyperbole-run-tests</code></a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-ibtypes-hyrolo_002dstuck_002dmsg"><code>ibtypes
hyrolo-stuck-msg</code></a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-ibtypes-hywiki_002dword"><code>ibtypes
hywiki-word</code></a>:</td><td> </td><td valign="top"><a
href="#HyWikiWords">HyWikiWords</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-ibtypes-hywiki_002dexisting_002dword"><code>ibtypes
hywiki-existing-word</code></a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-ibtypes-hywiki_002dword"><code>ibtypes
hywiki-word</code></a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-ibtypes-hywiki_002dword-1"><code>ibtypes
hywiki-word</code></a>:</td><td> </td><td valign="top"><a
href="#HyWikiWords">HyWikiWords</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-ibtypes-id_002dcflow"><code>ibtypes
id-cflow</code></a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ibtypes-ilink"><code>ibtypes
ilink</code></a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-ibtypes-Info_002dnode"><code>ibtypes
Info-node</code></a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
@@ -15212,6 +15332,8 @@ Previous: <a href="#Function" accesskey="p"
rel="prev">Function, Variable and Fi
<tr><td></td><td valign="top"><a
href="#index-HyControl-switch-modes">HyControl switch
modes</a>:</td><td> </td><td valign="top"><a
href="#HyControl">HyControl</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-HyControl-toggle-modes">HyControl toggle
modes</a>:</td><td> </td><td valign="top"><a
href="#HyControl">HyControl</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-HyControl-windows-grid">HyControl windows
grid</a>:</td><td> </td><td valign="top"><a
href="#HyControl">HyControl</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-HyNote">HyNote</a>:</td><td> </td><td valign="top"><a
href="#HyNote">HyNote</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-hynote-file">hynote
file</a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-Hyperbole">Hyperbole</a>:</td><td> </td><td valign="top"><a
href="#Hyperbole-Overview">Hyperbole Overview</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hyperbole-API">Hyperbole
API</a>:</td><td> </td><td valign="top"><a
href="#Embedding-Hyperbole">Embedding Hyperbole</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-Hyperbole-applications">Hyperbole
applications</a>:</td><td> </td><td valign="top"><a
href="#Hyperbole-Overview">Hyperbole Overview</a></td></tr>
@@ -15224,6 +15346,7 @@ Previous: <a href="#Function" accesskey="p"
rel="prev">Function, Variable and Fi
<tr><td></td><td valign="top"><a href="#index-Hyperbole-mail-list">Hyperbole
mail list</a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hyperbole-main-menu">Hyperbole
main menu</a>:</td><td> </td><td valign="top"><a
href="#Menus">Menus</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hyperbole-manual">Hyperbole
manual</a>:</td><td> </td><td valign="top"><a
href="#Documentation">Documentation</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-hyperbole-manual-ibtype">hyperbole manual
ibtype</a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-Hyperbole-menubar-menu">Hyperbole menubar
menu</a>:</td><td> </td><td valign="top"><a
href="#Menus">Menus</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-Hyperbole-minibuffer-menu">Hyperbole minibuffer
menu</a>:</td><td> </td><td valign="top"><a
href="#Invocation">Invocation</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-Hyperbole-minibuffer-menu-1">Hyperbole minibuffer
menu</a>:</td><td> </td><td valign="top"><a
href="#Default-Hyperbole-Bindings">Default Hyperbole Bindings</a></td></tr>
@@ -15253,6 +15376,7 @@ Previous: <a href="#Function" accesskey="p"
rel="prev">Function, Variable and Fi
<tr><td></td><td valign="top"><a
href="#index-HyWiki">HyWiki</a>:</td><td> </td><td valign="top"><a
href="#HyWiki">HyWiki</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-HyWiki-Action-Key">HyWiki Action
Key</a>:</td><td> </td><td valign="top"><a
href="#HyWikiWords">HyWikiWords</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-HyWiki-exclude-modes">HyWiki
exclude modes</a>:</td><td> </td><td valign="top"><a
href="#HyWikiWords">HyWikiWords</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-hywiki-existing-word">hywiki
existing word</a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-HyWiki-export-to-HTML">HyWiki
export to HTML</a>:</td><td> </td><td valign="top"><a
href="#Publish-HyWiki">Publish HyWiki</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-HyWiki-menu">HyWiki
menu</a>:</td><td> </td><td valign="top"><a href="#HyWiki-Menu">HyWiki
Menu</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-HyWiki-mode">HyWiki
mode</a>:</td><td> </td><td valign="top"><a href="#HyWiki-Menu">HyWiki
Menu</a></td></tr>
@@ -15264,7 +15388,9 @@ Previous: <a href="#Function" accesskey="p"
rel="prev">Function, Variable and Fi
<tr><td></td><td valign="top"><a
href="#index-HyWiki-publishing-function">HyWiki publishing
function</a>:</td><td> </td><td valign="top"><a
href="#Publish-HyWiki">Publish HyWiki</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-HyWiki-section-link">HyWiki
section link</a>:</td><td> </td><td valign="top"><a
href="#HyWikiWords">HyWikiWords</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-HyWiki-tag-search">HyWiki tag
search</a>:</td><td> </td><td valign="top"><a href="#HyWiki-Menu">HyWiki
Menu</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-hywiki_002dmode">hywiki-mode</a>:</td><td> </td><td
valign="top"><a href="#HyWikiWords">HyWikiWords</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-hywiki-word">hywiki
word</a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-hywiki_002dmode">hywiki-mode</a>:</td><td> </td><td
valign="top"><a href="#Implicit-Button-Types">Implicit Button
Types</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-hywiki_002dmode-1">hywiki-mode</a>:</td><td> </td><td
valign="top"><a href="#HyWikiWords">HyWikiWords</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-HyWikiWord">HyWikiWord</a>:</td><td> </td><td valign="top"><a
href="#HyWikiWords">HyWikiWords</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-HyWikiWord-contexts">HyWikiWord
contexts</a>:</td><td> </td><td valign="top"><a
href="#HyWikiWords">HyWikiWords</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-HyWikiWord-create">HyWikiWord
create</a>:</td><td> </td><td valign="top"><a
href="#HyWikiWords">HyWikiWords</a></td></tr>
@@ -15279,6 +15405,7 @@ Previous: <a href="#Function" accesskey="p"
rel="prev">Function, Variable and Fi
<tr><td></td><td valign="top"><a href="#index-ibtype-argument">ibtype
argument</a>:</td><td> </td><td valign="top"><a
href="#Programmatic-Implicit-Button-Types">Programmatic Implicit Button
Types</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ibtype-at_002dp">ibtype
at-p</a>:</td><td> </td><td valign="top"><a
href="#Programmatic-Implicit-Button-Types">Programmatic Implicit Button
Types</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ibtype-hact">ibtype
hact</a>:</td><td> </td><td valign="top"><a
href="#Programmatic-Implicit-Button-Types">Programmatic Implicit Button
Types</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-ibtype-hynote_002dfile">ibtype
hynote-file</a>:</td><td> </td><td valign="top"><a
href="#HyNote">HyNote</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ibtype-hywiki_002dword">ibtype
hywiki-word</a>:</td><td> </td><td valign="top"><a
href="#HyWikiWords">HyWikiWords</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-ibtype-ibut_003alabel_002dset">ibtype
ibut:label-set</a>:</td><td> </td><td valign="top"><a
href="#Programmatic-Implicit-Button-Types">Programmatic Implicit Button
Types</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ibtype-predicate">ibtype
predicate</a>:</td><td> </td><td valign="top"><a
href="#Programmatic-Implicit-Button-Types">Programmatic Implicit Button
Types</a></td></tr>
@@ -15653,6 +15780,7 @@ Previous: <a href="#Function" accesskey="p"
rel="prev">Function, Variable and Fi
<tr><td></td><td valign="top"><a href="#index-no_002dfill-attribute">no-fill
attribute</a>:</td><td> </td><td valign="top"><a
href="#Cell-Attributes">Cell Attributes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-normalized-label">normalized
label</a>:</td><td> </td><td valign="top"><a
href="#Button-Label-Normalization">Button Label Normalization</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-note_002dtaking">note-taking</a>:</td><td> </td><td
valign="top"><a href="#HyWiki">HyWiki</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-notes">notes</a>:</td><td> </td><td valign="top"><a
href="#HyNote">HyNote</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-numeric-argument">numeric
argument</a>:</td><td> </td><td valign="top"><a
href="#HyControl">HyControl</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-numeric-keypad">numeric
keypad</a>:</td><td> </td><td valign="top"><a
href="#HyControl">HyControl</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
@@ -15802,7 +15930,7 @@ Previous: <a href="#Function" accesskey="p"
rel="prev">Function, Variable and Fi
<tr><td></td><td valign="top"><a
href="#index-RFC-1">RFC</a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-ripgrep">ripgrep</a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-Rmail">Rmail</a>:</td><td> </td><td valign="top"><a
href="#Buttons-in-Mail">Buttons in Mail</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-Rolo">Rolo</a>:</td><td> </td><td valign="top"><a
href="#HyRolo">HyRolo</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-rolo">rolo</a>:</td><td> </td><td valign="top"><a
href="#HyRolo">HyRolo</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rolo-address">rolo
address</a>:</td><td> </td><td valign="top"><a
href="#Implicit-Button-Types">Implicit Button Types</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Rolo-commands">Rolo
commands</a>:</td><td> </td><td valign="top"><a href="#HyRolo-Menu">HyRolo
Menu</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rolo-entry">rolo
entry</a>:</td><td> </td><td valign="top"><a
href="#HyRolo-Concepts">HyRolo Concepts</a></td></tr>
diff --git a/man/hyperbole.info b/man/hyperbole.info
index 4e4a5d30b7..b3359b4a5d 100644
Binary files a/man/hyperbole.info and b/man/hyperbole.info differ
diff --git a/man/hyperbole.pdf b/man/hyperbole.pdf
index 01f7c3b487..f6a9a97d5a 100644
Binary files a/man/hyperbole.pdf and b/man/hyperbole.pdf differ
diff --git a/man/hyperbole.texi b/man/hyperbole.texi
index c690ac3ded..2813ce4e22 100644
--- a/man/hyperbole.texi
+++ b/man/hyperbole.texi
@@ -7,7 +7,7 @@
@c Author: Bob Weiner
@c
@c Orig-Date: 6-Nov-91 at 11:18:03
-@c Last-Mod: 30-Aug-24 at 01:45:39 by Bob Weiner
+@c Last-Mod: 1-Sep-24 at 20:28:29 by Bob Weiner
@c %**start of header (This is for running Texinfo on a region.)
@setfilename hyperbole.info
@@ -25,8 +25,8 @@
@set txicodequoteundirected
@set txicodequotebacktick
-@set UPDATED August, 2024
-@set UPDATED-MONTH August 2024
+@set UPDATED September, 2024
+@set UPDATED-MONTH September 2024
@set EDITION 9.0.2pre
@set VERSION 9.0.2pre
@@ -85,7 +85,7 @@ See the GNU General Public License for more details in the
file,
right thing, a powerful contact manager, an advanced, auto-
numbered outliner with hyperlink anchors for each outline
cell, and easily editable and extensible hyperlink buttons,
- even embeddable within mail and news messages.@
+ even embeddable within mail and news messages.
@end direntry
@c
@@ -159,7 +159,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</P>
<PRE>
Edition 9.0.2pre
-Printed August 29, 2024.
+Printed September 1, 2024.
Published by the Free Software Foundation, Inc.
Author: Bob Weiner
@@ -201,7 +201,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
@example
Edition 9.0.2pre
-August 29, 2024
+September 1, 2024
Published by the Free Software Foundation, Inc.
Author: Bob Weiner
@@ -259,6 +259,7 @@ dedicated to my lovely wife, Kathy.
* Buttons::
* Menus::
* HyWiki::
+* HyNote::
* HyControl::
* Koutliner::
* HyRolo::
@@ -3011,7 +3012,7 @@ associated HyWiki page does not exist, create it
automatically.
When on a HyNote file name stem, display the file and its optional
section. This type is active only in buffers where
@code{hywiki-active-in-current-buffer-p} is true. This may require
-that the global minor mode @code(hywiki-mode) has been enabled.
+that the global minor mode @code{hywiki-mode} has been enabled.
@end table
@node Action Buttons, , Implicit Button Types, Implicit Buttons
@@ -4362,7 +4363,7 @@ Return to previous positions in the button traversal
history.
@end table
-@node HyWiki, HyControl, Menus, Top
+@node HyWiki, HyNote, Menus, Top
@chapter HyWiki
@cindex HyWiki
@@ -4373,9 +4374,10 @@ Return to previous positions in the button traversal
history.
HyWiki is Hyperbole's markup-free, personal Wiki system for
note-taking and automatic HyWikiWord highlighting and hyperlinking.
It uses Org mode for note taking and adds automatic hyperlinking and
-highlighting of HyWikiWords within Org files in @code{hywiki-directory}
-(default = @file{~/hywiki}). With @bkbd{C-h h h p} you can publish
-your entire HyWiki to an HTML directory for export to the web.
+highlighting of HyWikiWords in Org files within
+@code{hywiki-directory} (default = @file{~/hywiki}). With @bkbd{C-h h
+h p} you can publish any updated part of your HyWiki to an HTML
+directory for export to the web.
@menu
* HyWikiWords::
@@ -4571,6 +4573,12 @@ It looks like this:
HyWiki> Act Create Edit GrepConsult Help Info Link ModeToggle Org-M-RET/
Publish TagFind WikiWordConsult
@end smallexample
+@noindent
+The GrepConsult and WikiWordConsult items appear only when the Consult
+package is installed prior to loading Hyperbole. These commands are
+especially useful as they allow for fast line-level searching across
+many files with interactive search pattern narrowing.
+
@noindent
Below are descriptions of each menu item.
@@ -4580,24 +4588,32 @@ Below are descriptions of each menu item.
@table @asis
@item Act
Activate HyWikiWord link at point.
+
@item Create
Create and display a new HyWiki page. Shows existing page names to aid in new
naming.
+
@item Edit
Prompt with completion for and display a HyWiki page ready for editing.
+
@item GrepConsult
Grep over HyWiki pages with interactive @code{hywiki-consult-grep}.
+
@item Help
Report on a HyWikiWord's attributes.
+
@item Info
Display Hyperbole manual section on HyWiki.
+
@item Link
Prompt for and add a link at point to a HyWiki page.
+
@findex hywiki-mode
@cindex HyWiki mode
@cindex HyWikiWords outside hywiki-directory
@item ModeToggle
Toggle global minor mode @code{hywiki-mode} that enables HyWikiWord hyperlinks
in buffers outside of @code{hywiki-directory}.
+
@kindex C-h h h o
@kindex HyWiki, C-h h h o
@kindex C-h h h c
@@ -4616,17 +4632,46 @@ make the Action Key create new HyWiki pages when
pressed on as-yet
undefined HyWikiWords; otherwise, you must use @bkbd{C-h h h c} to create a
new HyWiki page instead. Use @samp{None} if you want to
use Org's @bkbd{M-@key{RET}} command in every context within Org mode.
+
@item Publish
Publish modified pages in the HyWiki to HTML; prefix arg to publish all pages.
+
@cindex HyWiki tag search
@cindex search, HyWiki tag
@item TagFind
Find a matching Org tag across all HyWiki pages.
+
@item WikiWordConsult
Use @code{hywiki-consult-grep} to show occurrences of a prompted for
HyWikiWord.
@end table
-@node HyControl, Koutliner, HyWiki, Top
+
+@node HyNote, HyControl, HyWiki, Top
+@chapter HyNote
+@cindex HyNote
+@cindex notes
+HyNote is a start on Hyperbole's note taking system. HyNote supports
+Org, Markdown, Koutline and Emacs Outline file formats.
+
+@vindex hynote-directory-list
+@findex ibtypes hynote-file
+@cindex ibtype hynote-file
+Presently HyNote simply provides an experience similar to the HyWiki
+for Org and Org Roam file name stems and headline links for files
+found in the directories of @code{hynote-directory-list}, which
+defaults to the default Org and Org Roam directories. For example, if
+the file @file{~/Org/hyperbole-cmds.org} has a headline,
+@samp{hyrolo-fgrep Command}, then "hyperbole-cmds#hyrolo-fgrep Command"
+in any file will link to that headline. See the documentation for the
+implicit button type that HyNote defines, @code{hynote-file}.
+
+In the future, HyNote will also provide a universal way to easily link to
+information across many file formats.
+
+See also @ref{HyWiki}.
+
+
+@node HyControl, Koutliner, HyNote, Top
@chapter HyControl
@cindex windows control
@cindex frames control
@@ -6325,12 +6370,13 @@ these capabilities back into the mainstream of modern
computing culture.
@node HyRolo, Window Configurations, Koutliner, Top
@chapter HyRolo
-@cindex Rolo
+@cindex rolo
@cindex HyRolo
-Hyperbole includes a complete, advanced rolo system, HyRolo, for
-convenient management of hierarchical, record-oriented information.
-Most often this is used for contact management but it can quickly be
-adapted to most any record-oriented lookup task requiring fast retrieval.
+Hyperbole includes HyRolo, a complete, advanced system for convenient
+management of hierarchical, record-oriented information. Most often
+this is used for contact management but it can quickly be adapted to
+most any record-oriented lookup task requiring fast retrieval. There
+is also a Python-based command-line version, @file{hyrolo.py}, included.
@cindex rolo, buttons in
Hyperbole buttons may be included within rolo records and then
@@ -6486,8 +6532,9 @@ set of commands as the menubar Rolo menu but with more
concise labels.
@findex hyrolo-word
@findex hyrolo-yank
The minibuffer Rolo/ menu offers the following commands (ConsultFind
-and HelmFind appear only when associated packages are loaded but are
-especially noteworthy as they allow for line-level searching with
+and HelmFind appear only when the Consult and Helm packages are
+installed prior to loading Hyperbole. They are especially noteworthy
+as they allow for fast line-level searching across many files with
interactive search pattern narrowing):
@example
@@ -8105,6 +8152,21 @@ HyControl, the Hyperbole window and frame control
manager, offers
fast, single key manipulation of window and frame creation, deletion,
sizing, position and face zooming (enlarging/shrinking).
+@item HyNote
+HyNote is a start on Hyperbole's note taking system. It presently
+simply provides an experience similar to HyWiki, but for Org directory
+and Org Roam file and headline links. See the documentation for the
+implicit button type it defines, @code{hynote-file}.
+
+HyNote supports Org, Markdown, Koutline and Emacs Outline file
+formats. It uses UUIDs and HyRolo for quick note lookups across
+matching files in @code{hynote-directory-list}.
+
+In the future, it will also provide a universal way to easily link to
+information across many file formats.
+
+See also @b{HyWiki}.
+
@item Hyperbole
The flexible, programmable information management and viewing system
documented by this manual. It utilizes a button-action model and supports
@@ -8133,10 +8195,14 @@ DataBase (BBDB) package.
HyWiki, the Hyperbole personal wiki tool, lets you create a personal
wiki of interlinked Org files in a single directory, where each page
name automatically becomes a live HyWikiWord link back to the
-associated page whenever added in any file in the HyWiki directory.
-HyWikiWords also work outside this directory if you turn on the minor
-@code{hywiki-mode} in other buffers. A single command exports an
-entire HyWiki to the web.
+associated page whenever added in any file within the HyWiki
+directory. HyWikiWords also work outside this directory if you turn
+on the minor @code{hywiki-mode} in other buffers. A single command,
+@bkbd{C-u C-h h h p}, publishes/exports an entire HyWiki to HTML for
+display on the web.
+
+See the documentation for its implicit button types, @code{hywiki-word}
+and @code{hywiki-existing-word}.
@item Ilink
@itemx link-to-ibut