[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/hyperbole 7837f83da3 1/4: Doc updates in preparation fo
|
From: |
ELPA Syncer |
|
Subject: |
[elpa] externals/hyperbole 7837f83da3 1/4: Doc updates in preparation for release |
|
Date: |
Sun, 16 Jan 2022 15:57:30 -0500 (EST) |
branch: externals/hyperbole
commit 7837f83da38bd063095536823036ad90091d1010
Author: Robert Weiner <rsw@gnu.org>
Commit: Robert Weiner <rsw@gnu.org>
Doc updates in preparation for release
---
ChangeLog | 9 ++-
DEMO | 15 +++--
HY-NEWS | 28 ++++++++-
MANIFEST | 1 +
hbut.el | 9 +--
hibtypes.el | 5 +-
hui.el | 3 +-
hypb-ert.el | 2 +-
man/hyperbole.texi | 163 +++++++++++++++++++++++++++++++++++++++++++++++++----
man/version.texi | 4 +-
10 files changed, 205 insertions(+), 34 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 5d80f235e0..3b833ddc8f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,7 @@
2022-01-15 Bob Weiner <rsw@gnu.org>
+* man/hyperbole.texi (Testing): Add to describe test usage.
+
* hpath.el (hpath:absolute-arguments): Check that each arg is non-nil
before calling hpath:absolute-to.
@@ -2162,9 +2164,6 @@ Delete knode.el and integrate functionality into kcell.el.
intuitive logical expression matching. Made rolo-logical searches in DEMO
work.
-2020-12-03 Bob Weiner <rsw@gnu.org>
-
-* hibtypes.el (Info-node): Allowed for backslash double-quotes around node
name, e.g. when in a doc string.
2021-01-30 Mats Lidell <matsl@gnu.org>
* Makefile (test-ert, test-all): Add ert test targets
@@ -2195,6 +2194,10 @@ Delete knode.el and integrate functionality into
kcell.el.
(demo-factorial-ebutton-test): Test cases
(demo-should-browse-url): Test helper
+2020-12-03 Bob Weiner <rsw@gnu.org>
+
+* hibtypes.el (Info-node): Allowed for backslash double-quotes around node
name, e.g. when in a doc string.
+
2020-11-22 Bob Weiner <rsw@gnu.org>
* hpath.el (hpath:trim): Fixed to not trim trailing quoted double quote,
diff --git a/DEMO b/DEMO
index 7cc94c4e6b..a387d9edaa 100644
--- a/DEMO
+++ b/DEMO
@@ -763,12 +763,15 @@ or without quotes.
** Email Addresses
-An Action Key press on an email address of any common domain name will start
-composing an email message to that name within Emacs. This is limited to
-major modes listed in the variable, mail-address-mode-list. Try composing a
-message to <hyperbole-users@gnu.org> and tell us what you think of Hyperbole.
-Even better, a press of or on {C-h h m c} composes mail to the list that
-includes your system information.
+An Action Key press on an email address of any common domain name will
+start composing an email message to that name within Emacs. This is
+limited to major modes listed in the variable, mail-address-mode-list.
+If that variable is nil, then email addresses are active in every
+buffer.
+
+Try composing a message to <hyperbole-users@gnu.org> and tell us what
+you think of Hyperbole. Even better, a press of or on {C-h h m c}
+composes mail to the list that includes your system information.
** Action Buttons
diff --git a/HY-NEWS b/HY-NEWS
index 42a2c144f9..d87e1fa595 100644
--- a/HY-NEWS
+++ b/HY-NEWS
@@ -164,6 +164,10 @@
evaluate: (symset:clear 'ibtypes) and then reload hibtypes.{el,elc},
the priority order of all implicit button types is reset.
+ - Mail Address Activation Everywhere: Email addresses are recognized as
+ implicit buttons in major modes given by `mail-address-mode-list'. If
+ you set that to nil, however, they will be recognized in all major modes.
+
- Magit Mode Support: Just click or press the Action Key somewhere and it
will typically display what you want. Extensive Action Key support in
Magit modes for cycling through display views and displaying items.
@@ -181,16 +185,33 @@
- Pathname Implicit Buttons: Recursive 'ls' listings are now recognized
properly, prepending the preceding directory to each entry for viewing.
+ An Action Key press on a defined PATH-style variable name, e.g. MANPATH,
+ will prompt with completion for one of the paths and will then display
+ that. If it is the colon or semicolon-separated string of paths value
+ from a PATH-style variable, the path at point is displayed; empty paths,
+ e.g. :: represent the current directory, ’.’. Must have at least four
+ paths within the variable value for this to work.
+
+ Much improved pathname handling including multiple variables per
+ path, embedded . or .. within paths, better recognition of semicolon
+ separated pathnames in Windows PATH variable.
+
Variable substitutions are now made with fixed case, so that the
case of a value with both upper and lower case characters is
never changed, for example a value of ${HOME}.
+ file:// URLs are now resolved properly.
+
- Todotxt Mode Support: Smart key support for the todotxt mode
https://github.com/rpdillon/todotxt.el.
- UNIX Shell Errors: Jump to associated source line from a shell error of
the
form: "<pathname>: line <num>: ".
+ - Internet RFC Links (e.g. RFC-822): Change to using http to retrieve RFCs
+ instead of ftp since this is disabled in many environments. Always
display
+ with Emacs' web browser rather than externally.
+
CUSTOMIZATON
- Customizable Display Program File Mappings:
@@ -201,7 +222,6 @@
hpath:external-display-alist-x)
are all customizable.
-
PROGRAMMING
- Edebuggable Hyperbole Types: `defib' and `defact' type definitions
@@ -213,6 +233,9 @@
- kbd-key:is-p: Added this new predicate to test whether point is within
a brace-delimited key series.
+ - hypb:def-to-buffer: Quick copying of program definitions and insertion
+ at the start of another buffer. Can be bound and used in key series.
+
ACE WINDOW PACKAGE INTEGRATION - fast window and buffer switching
- After installing the ace-window package and loading Hyperbole, execute
@@ -223,6 +246,9 @@
linking to point in the window chosen when prompted.
See "DEMO#Displaying File and Buffer Items and Moving Buffers".
+ - Throw A Region Elsewhere Within the Same Buffer: {M-o t <window-id>}
+ when used with a selected region can now throw to the source buffer
+ as long as point is outside the selected region in the target window.
===========================================================================
* V7.1.3
diff --git a/MANIFEST b/MANIFEST
index 72757e99fb..14ab84ea72 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -57,6 +57,7 @@ hmoccur.el - Multi-buffer or multi-file regexp
occurrence location
hpath.el - GNU Hyperbole support routines for handling UNIX paths
htz.el - Timezone-based time and date support for GNU Hyperbole
hypb.el - Miscellaneous GNU Hyperbole support features
+hypb-ert.el - Hyperbole test runner action button types
hyrolo.el - Hierarchical, multi-file, easy-to-use contact
management system
hyrolo-logic.el - Logic functions for GNU Hyperbole Rolo files
hywconfig.el - Save ring of window configurations
diff --git a/hbut.el b/hbut.el
index eaf1b63324..ac2692f5f4 100644
--- a/hbut.el
+++ b/hbut.el
@@ -1998,13 +1998,8 @@ Here is a sample use case. Let's create a button type
whose
buttons perform a grep-like function over a current repo's git
log entries. The buttons use this format: [<text to match>].
-The following defines the button type called search-git-log with a
-a key series action surrounded by braces:
-
- (defil search-git-log \"[<\" \">]\" \".*\" \"{M-: (hypb:fgrep-git-log
\\\"\\\\&\\\") RET}\")
-
-or this simpler version skips the explicit text substitution (\\\\&)
-and instead uses the function that takes the button text as an argument:
+The following defines the button type called search-git-log which
+calls hypb:fgrep-git-log with the text of the button as an argument:
(defil search-git-log \"[<\" \">]\" \".*\" #'hypb:fgrep-git-log)
diff --git a/hibtypes.el b/hibtypes.el
index 0140e3ac86..831e684b66 100644
--- a/hibtypes.el
+++ b/hibtypes.el
@@ -254,7 +254,10 @@ display options."
"If on an e-mail address in a specific buffer type, compose mail to that
address in another window.
Applies to any major mode in `mail-address-mode-list', the HyRolo match buffer,
any buffer attached to a file in `hyrolo-file-list', or any buffer with
-\"mail\" or \"rolo\" (case-insensitive) within its name."
+\"mail\" or \"rolo\" (case-insensitive) within its name.
+
+If `mail-address-mode-list' is set to nil, this button type is active
+in all buffers."
(when (let ((case-fold-search t))
(or
(and (or (null mail-address-mode-list)
diff --git a/hui.el b/hui.el
index 837d39f863..a62b8ab1e2 100644
--- a/hui.el
+++ b/hui.el
@@ -1126,7 +1126,8 @@ Optional NO-SORT means display in decreasing priority
order (natural order)."
(with-output-to-temp-buffer buf-name
(mapcar (lambda (nm-doc-cons)
(princ (car nm-doc-cons)) (terpri)
- (princ (cdr nm-doc-cons)) (terpri))
+ (princ (cdr nm-doc-cons)) (terpri)
+ (terpri))
doc-list)))))
(defun hui:htype-help-current-window (htype-sym &optional no-sort)
diff --git a/hypb-ert.el b/hypb-ert.el
index 50ec716dba..f67b537bc3 100644
--- a/hypb-ert.el
+++ b/hypb-ert.el
@@ -1,4 +1,4 @@
-;;; hypb-ert.el --- ert button support -*- lexical-binding:
t; -*-
+;;; hypb-ert.el --- Hyperbole test runner action button types -*-
lexical-binding: t; -*-
;; Author: Mats Lidell <matsl@gnu.org> and Bob Weiner <rsw@gnu.org>
;;
diff --git a/man/hyperbole.texi b/man/hyperbole.texi
index 72fd575444..edc02bb4cd 100644
--- a/man/hyperbole.texi
+++ b/man/hyperbole.texi
@@ -52,7 +52,7 @@
This manual is for GNU Hyperbole
(Edition @value{EDITION}, Published @value{UPDATED}).
-Copyright @copyright{} 1989-2021 Free Software Foundation, Inc.
+Copyright @copyright{} 1989-2022 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
@@ -142,7 +142,7 @@ Texinfo markup language.
<CENTER><H3><A HREF="mailto:rsw@@gnu.org";>Say thanks or send a testimonial if
you like Hyperbole.</A></H3></CENTER>
-<P>Copyright © 1989-2021 Free Software Foundation, Inc.</P>
+<P>Copyright © 1989-2022 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,
@@ -155,7 +155,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</P>
<PRE>
Edition 8.0.0pre
-Printed December 26, 2021.
+Printed January 16, 2022.
Published by the Free Software Foundation, Inc.
Author: Bob Weiner
@@ -183,7 +183,7 @@ Printed December 26, 2021.
@sp 2
@noindent
-Copyright @copyright{} 1989-2021 Free Software Foundation, Inc.
+Copyright @copyright{} 1989-2022 Free Software Foundation, Inc.
GNU Hyperbole is available for use, modification, and distribution
under the terms of the GNU General Public License (GPL) Version 3 or
@@ -197,7 +197,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
@example
Edition 8.0.0pre
-December 26, 2021
+January 16, 2022
Published by the Free Software Foundation, Inc.
Author: Bob Weiner
@@ -424,6 +424,7 @@ Hyperbole Key Bindings
* Binding Minibuffer Menu Items::
* Default Hyperbole Bindings::
+* Testing::
Smart Key Reference
@@ -443,6 +444,8 @@ Smart Mouse Keys
Smart Keyboard Keys
* Smart Key - Company Mode::
+* Smart Key - Org Mode::
+* Smart Key - Ivy::
* Smart Key - Treemacs::
* Smart Key - Dired Sidebar Mode::
* Smart Key - Emacs Pushbuttons::
@@ -459,6 +462,7 @@ Smart Keyboard Keys
* Smart Key - The Koutliner::
* Smart Key - RDB Mode::
* Smart Key - Help Buffers::
+* Smart Key - Custom Mode::
* Smart Key - Bookmark Mode::
* Smart Key - Pages Directory Mode::
* Smart Key - Python Source Code::
@@ -2548,9 +2552,12 @@ with the following format:
@file{<path>[#<link-anchor>]:<line-num>[:<column-num>
@cindex address
@item mail-address
If on an e-mail address in a specific buffer type, compose mail to that
-address in another window. Applies to the rolo match buffer, any buffer
+address in another window. Applies to any major mode
+in @code{mail-address-mode-list}, the rolo match buffer, any buffer
attached to a file in @code{hyrolo-file-list}, or any buffer
-with @file{mail} or @file{rolo} (case-insensitive) within its name.
+with @file{mail} or @file{rolo} (case-insensitive) within its name. If
+@code{mail-address-mode-list} is set to nil, this button type is active
+in all buffers.
@findex ibtypes www-url
@cindex URL
@@ -2599,6 +2606,35 @@ delimiters. See the variable documentation for
@code{hpath:suffixes} for
suffixes that are added to or removed from the pathname when searching
for a valid match. See the function documentation for @code{hpath:find}
for special file display options.
+
+@cindex PATH-type variable
+@cindex colon-separated paths
+@cindex semicolon-separated paths
+@noindent
+If instead is a PATH-style variable name, .e.g. @code{MANPATH}, will
+prompt with completion for one of the paths and will then display that.
+If it is the colon or semicolon-separated string of paths value from a
+PATH-style variable, the path at point is displayed; empty paths,
+e.g. @file{::} represent the current directory, @file{.}. Must have at
+least four paths within the variable value for this to work.
+
+
+@findex ibtypes hyperbole-run-tests
+@cindex running tests
+@cindex testing
+@cindex ert
+@cindex Emacs Regression Test framework
+@item hyperbole-run-tests
+Recognize buttons of the form @code{<hyperbole-run-tests test-selector>}
+which when activated run Hyperbole tests using the ERT framework. The
+@code{test-selector} argument is as described in @code{ert-select-tests}.
+
+
+@findex ibtypes hyperbole-run-test
+@item hyperbole-run-test
+Recognize buttons of the form @code{<hyperbole-run-test test-name>}
+which when activated run individual Hyperbole tests, each given
+by the @code<test-name> argument, an unquoted name.
@end table
@@ -7631,6 +7667,7 @@ bindings that hide global Hyperbole keys.
@menu
* Binding Minibuffer Menu Items::
* Default Hyperbole Bindings::
+* Testing::
@end menu
@node Binding Minibuffer Menu Items, Default Hyperbole Bindings, Hyperbole Key
Bindings, Hyperbole Key Bindings
@@ -7645,7 +7682,7 @@ key sequence you want to use to activate the menu item.
Immediately
after, it will display the Hyperbole top-level minibuffer menu. Simply
select the item you want to bind to your key.
-@node Default Hyperbole Bindings, , Binding Minibuffer Menu Items, Hyperbole
Key Bindings
+@node Default Hyperbole Bindings, Testing, Binding Minibuffer Menu Items,
Hyperbole Key Bindings
@section Default Hyperbole Bindings
Hyperbole's default key bindings can be viewed and edited from
@@ -7770,6 +7807,37 @@ as part of any setting of @code{hyperbole-init-hook}
within your
personal @file{~/.emacs} file. For example, @code{(add-hook
'hyperbole-init-hook (lambda () (global-set-key "\C-ct" 'hyperbole-mode)))}.
+@node Testing, , Default Hyperbole Bindings, Hyperbole Key Bindings
+@section Testing
+
+Hyperbole includes over 200 automated test cases in the @file{test/}
+subdirectory. You can run all of them by moving to the Hyperbole home
+directory in a Posix shell and run @code{make test-all} or @code{make
+test} to run just non-interactive tests. If any tests fail, you can
+press the Action Key to see the source of the failure. Full testing is
+suppored under POSIX systems only.
+
+With Hyperbole active, you can also define implicit buttons that run
+individual or sets of Hyperbole tests. The file @file{hypb-ert.el} contains
+two action link types:
+
+@example
+@code{hyperbole-run-test} - run a single Hyperbole test by name
+@code{hyperbole-run-tests} - run one more tests matching a pattern
+
+@noindent
+Example uses with a press of the Action Key:
+
+ Run the test hbut-defal-url:
+ <hyperbole-run-test hbut-defal-url>
+
+ Run the tests specified by the test selector hbut-defal:
+ <hyperbole-run-tests hbut-defal>
+
+ Run all tests:
+ <hyperbole-run-tests t>
+@end example
+
@node Koutliner Keys, Smart Key Reference, Hyperbole Key Bindings, Top
@appendix Koutliner Keys
@@ -8717,6 +8785,8 @@ If dragged from an Emacs window to outside of Emacs:
@menu
* Smart Key - Company Mode::
+* Smart Key - Org Mode::
+* Smart Key - Ivy::
* Smart Key - Treemacs::
* Smart Key - Dired Sidebar Mode::
* Smart Key - Emacs Pushbuttons::
@@ -8733,6 +8803,7 @@ If dragged from an Emacs window to outside of Emacs:
* Smart Key - The Koutliner::
* Smart Key - RDB Mode::
* Smart Key - Help Buffers::
+* Smart Key - Custom Mode::
* Smart Key - Bookmark Mode::
* Smart Key - Pages Directory Mode::
* Smart Key - Python Source Code::
@@ -8765,7 +8836,7 @@ If dragged from an Emacs window to outside of Emacs:
* Smart Key - Default Context::
@end menu
-@node Smart Key - Company Mode, Smart Key - Treemacs, Smart Keyboard Keys,
Smart Keyboard Keys
+@node Smart Key - Company Mode, Smart Key - Org Mode, Smart Keyboard Keys,
Smart Keyboard Keys
@subsection Smart Key - Company Mode
@cindex company-mode
@@ -8782,8 +8853,56 @@ When company-mode is active:
@end group
@end format
+@node Smart Key - Org Mode, Smart Key - Ivy, Smart Key - Company Mode, Smart
Keyboard Keys
+@subsection Smart Key - Org Mode
+
+@vindex hsys-org-enable-smart-keys
+@cindex Org mode
+@format
+@group
+When in an Org mode context and @code{hsys-org-enable-smart-keys} is non-nil:
+ ACTION KEY
+ (1) follows internal links in Org mode files. When pressed on a
+ link referent/target, the link definition is displayed, allowing
two-way
+ navigation between definitions and targets.
+
+ (2) follows Org mode external links.
+
+ (3) within a radio target definition, this jumps to the first
+ occurrence of an associated radio target.
-@node Smart Key - Treemacs, Smart Key - Dired Sidebar Mode, Smart Key -
Company Mode, Smart Keyboard Keys
+ (4) when point is on an outline heading in Org mode, this
+ cycles the view of the subtree at point.
+
+ (5) with point on the first line of a code block definition, this
+ executes the code block via the Org mode standard binding of {C-c C-c},
+ (org-ctrl-c-ctrl-c).
+
+ (6) In any other context besides the end of a line, the Action Key
invokes the
+ Org mode standard binding of {M-RET}, (org-meta-return).
+
+ ASSIST KEY
+ (1) on an Org mode heading, this cycles through views of the whole buffer
outline.
+
+ (2) on an Org mode link or agenda item, this displays standard Hyperbole
help.
+@end group
+@end format
+
+@vindex org-link-outside-org-mode
+@noindent
+Org links may be used outside of Org mode buffers. Such links are
+handled by the separate implicit button type, @code{org-link-outside-org-mode}.
+
+
+@node Smart Key - Ivy, Smart Key - Treemacs, Smart Key - Org Mode, Smart
Keyboard Keys
+@subsection Smart Key - Ivy
+
+@cindex Ivy completion
+@cindex completion, Ivy
+When an Ivy completion list is active, a press of either Smart Key on a
+completion candidate selects that one and exits the minibuffer.
+
+@node Smart Key - Treemacs, Smart Key - Dired Sidebar Mode, Smart Key - Ivy,
Smart Keyboard Keys
@subsection Smart Key - Treemacs
@cindex Treemacs
@@ -9205,7 +9324,7 @@ relational databases (part of InfoDock):
@end group
@end format
-@node Smart Key - Help Buffers, Smart Key - Bookmark Mode, Smart Key - RDB
Mode, Smart Keyboard Keys
+@node Smart Key - Help Buffers, Smart Key - Custom Mode, Smart Key - RDB Mode,
Smart Keyboard Keys
@subsection Smart Key - Help Buffers
@cindex help buffer
@format
@@ -9217,7 +9336,27 @@ When pressed at the end of a Help buffer:
@end group
@end format
-@node Smart Key - Bookmark Mode, Smart Key - Pages Directory Mode, Smart Key -
Help Buffers, Smart Keyboard Keys
+@node Smart Key - Custom Mode, Smart Key - Bookmark Mode, Smart Key - Help
Buffers, Smart Keyboard Keys
+@subsection Smart Key - Custom Mode
+
+@cindex Custom mode
+@noindent
+When pressed within Custom-mode for editing customizations:
+ ACTION KEY
+ (1) on the last line of the buffer, exit Custom mode, potentially
+ prompting to save any changes;
+ (2) at the end of any other line, scroll the window down down a windowful;
+ (3) if a mouse event on a widget, activate the widget or display a menu;
+ (4) anywhere else, execute the command bound to {RETURN}.
+ ASSIST KEY
+ (1) on the last line of the buffer, exit Custom mode, potentially
+ prompting to save any changes;
+ (2) at the end of any other line, scroll the window down down a windowful;
+ (3) if a mouse event on a widget, activate the widget or display a menu;
+ (4) anywhere else, execute the command bound to {RETURN}.
+
+
+@node Smart Key - Bookmark Mode, Smart Key - Pages Directory Mode, Smart Key -
Custom Mode, Smart Keyboard Keys
@subsection Smart Key - Bookmark Mode
@format
diff --git a/man/version.texi b/man/version.texi
index 4d773102a7..198403cbce 100644
--- a/man/version.texi
+++ b/man/version.texi
@@ -1,4 +1,4 @@
-@set UPDATED December, 2021
-@set UPDATED-MONTH December 2021
+@set UPDATED January, 2022
+@set UPDATED-MONTH January 2022
@set EDITION 8.0.0pre
@set VERSION 8.0.0pre