[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/hyperbole 616ee63b21 5/8: hsys-youtube.el - Doc and pro
From: |
ELPA Syncer |
Subject: |
[elpa] externals/hyperbole 616ee63b21 5/8: hsys-youtube.el - Doc and properly define yt- actypes |
Date: |
Sun, 14 May 2023 03:58:32 -0400 (EDT) |
branch: externals/hyperbole
commit 616ee63b217c2e7a6fc5ebb561475c9b085e2dac
Author: Bob Weiner <rsw@gnu.org>
Commit: Bob Weiner <rsw@gnu.org>
hsys-youtube.el - Doc and properly define yt- actypes
---
ChangeLog | 5 +++
hsys-youtube.el | 66 ++++++++++++++++++------------------
man/hyperbole.html | 97 ++++++++++++++++++++++++++++++++++++++++-------------
man/hyperbole.info | Bin 602191 -> 604184 bytes
man/hyperbole.pdf | Bin 1353957 -> 1356010 bytes
man/hyperbole.texi | 87 +++++++++++++++++++++++++++++++++--------------
6 files changed, 173 insertions(+), 82 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index fc0fd1b717..41ecbbd42d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
2023-05-13 Bob Weiner <rsw@gnu.org>
+* hsys-youtube.el (require 'hact): Autoload for defact macro.
+ (yt-info, yt-play, yt-search, yt-url): Change from aliases to
+ defact, so are properly registered as actypes.
+ man/hyperbole.texi (Action Types): Add yt-* actypes.
+
* hpath.el (hpath:cache-mswindows-mount-points): Catch and ignore any shell
command
error. Can be triggered when default-directory is set to a URL, as in RFC
display buffers. This in turn would lead hyperbole-mode activation to
fail.
diff --git a/hsys-youtube.el b/hsys-youtube.el
index d0a5222ac5..36180a2c19 100644
--- a/hsys-youtube.el
+++ b/hsys-youtube.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 10-Jul-22 at 18:10:56
-;; Last-Mod: 22-Nov-22 at 18:11:43 by Bob Weiner
+;; Last-Mod: 14-May-23 at 02:09:33 by Bob Weiner
;;
;; SPDX-License-Identifier: GPL-3.0-or-later
;;
@@ -43,6 +43,7 @@
;;; Requirements
;;; ************************************************************************
+;;;###autoload
(require 'hact) ;; For htype:symbol
(require 'hsys-www)
@@ -74,7 +75,27 @@ optional.")
;;; ************************************************************************
;;;###autoload
-(defun hsys-youtube-get-url (video-id &optional start-time-string
end-time-string)
+(defact yt-info (video-id)
+ "Display a web page with the metadata information about VIDEO-ID."
+ (hact #'actypes::www-url (format
"https://mattw.io/youtube-metadata/?url=https://youtu.be/%s&submit=true"
+ video-id)))
+;;;###autoload
+(defact yt-play (video-id &optional start-time-string end-time-string)
+ "Play a VIDEO-ID from the point specified by optional START-TIME-STRING.
+If not given, START-TIME-STRING is set to \"0s\" representing the beginning
+of the video. START-TIME-STRING is a colon-separated hours:minutes:seconds
+string, e.g. 1:2:44 (1 hour, two minutes, 45 seconds), where the hours
+and minutes are optional."
+ (hact #'actypes::www-url (hsys-youtube-get-url video-id start-time-string
end-time-string)))
+
+;;;###autoload
+(defact yt-search (search-term)
+ "Search Youtube for SEARCH-TERM."
+ (interactive "sSearch Youtube for: ")
+ (hyperbole-web-search "Youtube" search-term))
+
+;;;###autoload
+(defact yt-url (video-id &optional start-time-string end-time-string)
"Return url to play VIDEO-ID from point specified by optional
START-TIME-STRING.
Return nil if START-TIME-STRING is given but is invalid. If not given,
START-TIME-STRING is set to \"0s\" representing the beginning of the video.
@@ -91,23 +112,18 @@ minutes are optional."
(hsys-youtube-start-url video-id start-time-string)))
;;;###autoload
-(defun hsys-youtube-get-url:help (hbut)
- "Show in minibuffer the url from an `hsys-youtube-get-url' action button,
HBUT.
+(defun hsys-youtube-play:help (hbut)
+ "Show in the minibuffer the url for an `hsys-youtube-play' action button,
HBUT.
Called when the Assist Key is pressed on such a button."
(message (apply #'hsys-youtube-get-url (hattr:get hbut 'args))))
+;; Create easy to type Action Button aliases.
;;;###autoload
-(defun hsys-youtube-info (video-id)
- "Display a web page with the metadata information about VIDEO-ID."
- (hact #'actypes::www-url (format
"https://mattw.io/youtube-metadata/?url=https://youtu.be/%s&submit=true"
- video-id)))
-
+(defalias 'hsys-youtube-info (htype:symbol 'yt-info 'actypes))
;;;###autoload
-(defun hsys-youtube-search (search-term)
- "Search Youtube for SEARCH-TERM."
- (interactive "sSearch Youtube for: ")
- (hyperbole-web-search "Youtube" search-term))
-
+(defalias 'hsys-youtube-play (htype:symbol 'yt-play 'actypes))
+;;;###autoload
+(defalias 'hsys-youtube-search (htype:symbol 'yt-search 'actypes))
;;;###autoload
(defun hsys-youtube-search:help (search-term)
"Display in the minibuffer the Youtube url to search for SEARCH-TERM."
@@ -115,30 +131,14 @@ Called when the Assist Key is pressed on such a button."
(hyperbole-web-search "Youtube" search-term t))
;;;###autoload
-(defun hsys-youtube-play (video-id &optional start-time-string end-time-string)
- "Play a VIDEO-ID from the point specified by optional START-TIME-STRING.
-If not given, START-TIME-STRING is set to \"0s\" representing the beginning
-of the video. START-TIME-STRING is a colon-separated hours:minutes:seconds
-string, e.g. 1:2:44 (1 hour, two minutes, 45 seconds), where the hours
-and minutes are optional."
- (hact #'actypes::www-url (hsys-youtube-get-url video-id start-time-string
end-time-string)))
+(defalias 'hsys-youtube-get-url (htype:symbol 'yt-url 'actypes))
;;;###autoload
-(defun hsys-youtube-play:help (hbut)
- "Show in the minibuffer the url for an `hsys-youtube-play' action button,
HBUT.
+(defun hsys-youtube-get-url:help (hbut)
+ "Show in minibuffer the url from an `hsys-youtube-get-url' action button,
HBUT.
Called when the Assist Key is pressed on such a button."
(message (apply #'hsys-youtube-get-url (hattr:get hbut 'args))))
-;; Create easy to type Action Button aliases.
-;;;###autoload
-(defalias (htype:symbol 'yt-info 'actypes) #'hsys-youtube-info)
-;;;###autoload
-(defalias (htype:symbol 'yt-play 'actypes) #'hsys-youtube-play)
-;;;###autoload
-(defalias (htype:symbol 'yt-search 'actypes) #'hsys-youtube-search)
-;;;###autoload
-(defalias (htype:symbol 'yt-url 'actypes) #'hsys-youtube-get-url)
-
;;; ************************************************************************
;;; Private variables
;;; ************************************************************************
diff --git a/man/hyperbole.html b/man/hyperbole.html
index 12f3f42111..eebce96674 100644
--- a/man/hyperbole.html
+++ b/man/hyperbole.html
@@ -2011,14 +2011,15 @@ point-and-click type behavior beyond implicit button
types. See <a class="xref"
<a class="index-entry-id" id="index-labeling-implicit-buttons"></a>
<a class="index-entry-id" id="index-naming-implicit-buttons"></a>
<p>Individual implicit buttons may be labeled/named, allowing activation
-by name or use as a link target by other buttons. Here is a pathname
+by name or use as a link target by other buttons. Such names are
+highlighted similarly to explicit button names. Here is a pathname
button with a label of ’My Emacs Files’:
</p>
<div class="example">
<pre class="example-preformatted"><[My Emacs Files]>:
"~/.emacs.d"
</pre></div>
-<p>The label is delimited by ‘<samp class="samp"><[</samp>’ and
‘<samp class="samp">]></samp>’ and can be followed
+<p>The name is delimited by ‘<samp class="samp"><[</samp>’ and
‘<samp class="samp">]></samp>’ and can be followed
by any number of :, - or = separator characters, including none.
</p>
@@ -2450,13 +2451,15 @@ non-brace character.
</dd>
<dt><code class="code">text-toc</code></dt>
<dd><p>Jump to the text file section referenced by a table of contents (toc)
-entry at point. The filename of the current buffer must contain
-<samp class="file">README</samp> and there must be a ‘Table of
Contents’ or ‘Contents’
-label on a line by itself (it may begin with an asterisk), preceding
-the table of contents. Each toc entry must begin with some whitespace
-followed by one or more asterisk characters. Each section header
-linked to by the toc must start with one or more asterisk characters
-at the very beginning of the line.
+entry at point. This works in any text derived major mode buffer with
+a ‘Table of Contents’ or ‘Contents’ label on a line by
itself (it may
+begin with an asterisk), preceding the table of contents. Each TOC
+entry must begin with some whitespace followed by one or more asterisk
+characters. Each section header linked to by the toc must start with
+one or more asterisk characters at the very beginning of the line.
+TOCs in Internet RFCs work as well. For example, display this RFC,
+<link-to-rfc 822>, and Action Key press on any TOC line to jump to the
+associated section. Or try it in the Hyperbole <samp class="file">DEMO</samp>
file.
</p>
<a class="index-entry-id" id="index-ibtypes-cscope"></a>
<a class="index-entry-id" id="index-C_002fC_002b_002b-call-trees"></a>
@@ -3264,6 +3267,38 @@ the point to return to in BUF-NAME after displaying the
summary.
that is used. Valid values of this variable include
<code class="code">browse-url-default-browser</code> and <code
class="code">browse-url-generic</code>.
See its documentation string for details.
+</p>
+<a class="index-entry-id" id="index-actypes-yt_002dinfo"></a>
+<a class="index-entry-id" id="index-youtube"></a>
+<a class="index-entry-id" id="index-video"></a>
+</dd>
+<dt><code class="code">yt-info</code></dt>
+<dd><p>Display a web page with the metadata information about VIDEO-ID.
+</p>
+<a class="index-entry-id" id="index-actypes-yt_002dplay"></a>
+</dd>
+<dt><code class="code">yt-play</code></dt>
+<dd><p>Play a VIDEO-ID from the point specified by optional START-TIME-STRING.
+If not given, START-TIME-STRING is set to "0s" representing the
beginning
+of the video. START-TIME-STRING is a colon-separated hours:minutes:seconds
+string, e.g. 1:2:44 (1 hour, two minutes, 45 seconds), where the hours
+and minutes are optional.
+</p>
+<a class="index-entry-id" id="index-actypes-yt_002dsearch"></a>
+</dd>
+<dt><code class="code">yt-search</code></dt>
+<dd><p>Search Youtube for SEARCH-TERM.
+</p>
+<a class="index-entry-id" id="index-actypes-yt_002durl"></a>
+</dd>
+<dt><code class="code">yt-url</code></dt>
+<dd><p>Return url to play VIDEO-ID from point specified by optional
START-TIME-STRING.
+Return nil if START-TIME-STRING is given but is invalid. If not given,
+START-TIME-STRING is set to "0s" representing the beginning of the
video.
+</p>
+<p>START-TIME-STRING is a colon-separated hours:minutes:seconds string,
+e.g. 1:2:44 (1 hour, two minutes, 45 seconds), where the hours and
+minutes are optional.
</p></dd>
</dl>
@@ -3939,12 +3974,17 @@ in the current buffer.
<a class="index-entry-id" id="index-menu_002c-Documentation"></a>
<a class="index-entry-id" id="index-menu_002c-Doc"></a>
<a class="index-entry-id" id="index-menu_002c-Types"></a>
+<a class="index-entry-id" id="index-concepts"></a>
+<a class="index-entry-id" id="index-use-cases"></a>
</dd>
<dt><strong class="strong">Doc/</strong></dt>
-<dd><p>Hyperbole documentation quick access. This menu contains an About item
-which describes Hyperbole and a Demo item which demonstrates a number of
-interactive Hyperbole features. It also contains the Types/ submenu for
-documentation on Hyperbole implicit button and action types.
+<dd><p>Hyperbole documentation quick access. This menu contains an About
+item which describes Hyperbole; a Concepts item that discusses how
+Hyperbole features all interrelate; a Demo item which demonstrates a
+number of interactive Hyperbole features; a New item that details new
+Hyperbole features, as well as a WhyUse item with use cases. It also
+contains the Types/ submenu for documentation on Hyperbole implicit
+button and action types.
</p>
<a class="index-entry-id" id="index-Find"></a>
<a class="index-entry-id" id="index-Grep"></a>
@@ -6112,8 +6152,7 @@ an optional header that starts and ends with a line of
equal signs (at
least three equal signs starting at the beginning of a line), followed
by zero or more rolo records which we call entries. You must manually
add a header to any rolo file if you want it to have one. Rolo files
-may be regular text files, Emacs outline files, Org files, Markdown
-files or Koutline files.
+may be Emacs outline files, Org files, Markdown files or Koutline files.
</p>
<p>Rolo <em class="dfn">entries</em> begin with optional space, followed by a
delimiter of
one or more special characters followed by another space. Delimiters
@@ -6125,7 +6164,6 @@ look like this:
Koutline Mode: 1b3 or 1.2.3
Markdown Mode: ###
Org Mode: ***
-Text Mode: ***
</pre></div></div>
<p>Entries may be arranged in a hierarchy, where child entries start with
@@ -6362,7 +6400,7 @@ Next: <a href="#HyRolo-Settings" accesskey="n"
rel="next">HyRolo Settings</a>, P
<a class="index-entry-id" id="index-hyrolo-menu"></a>
<a class="index-entry-id" id="index-rolo-keys"></a>
<p>After a rolo search is performed, point is left in the <em class="dfn">rolo
-match buffer</em>, <samp class="file">*Hyperbole Rolo*</samp>, which uses
<code class="code">hyrolo-mode</code> to
+match buffer</em>, <samp class="file">*HyRolo*</samp>, which uses <code
class="code">hyrolo-mode</code> to
simplify browsing many HyRolo matches. Press <kbd class="kbd">{?}</kbd> when
in the
match buffer for a summary of available keys, all of which are
documented in this section.
@@ -6538,13 +6576,16 @@ Previous: <a href="#HyRolo-Keys" accesskey="p"
rel="prev">HyRolo Keys</a>, Up: <
<a class="index-entry-id" id="index-rolo_002c-personal"></a>
<p>The files used in any rolo search are given by the
<code class="code">hyrolo-file-list</code> variable, whose default value is
typically
-<code class="code">"~/.rolo.otl"</code>. Searches scan only your
personal rolo file.
-Any entries added to this list should be absolute filenames. If a
-file in the list does not exist or is not readable, it is skipped.
-Files are searched in the order in which they appear in the list. In
-general, you should leave your personal rolo file as the first entry
-in the list, since this is the only file to which the Add command on
-the rolo menu adds entries.
+<code class="code">"~/.rolo.otl"</code>, in which case, searches
scan only your personal
+rolo file. Any entries added to this list should be absolute
+filenames and can be any of the following formats: Emacs outlines
+(.otl), Koutlines (.kotl), Markdown files (.md), or Org files (.org).
+</p>
+<p>If a file in the list does not exist or is not readable, it is
+skipped. Files are searched in the order in which they appear in the
+list. You should leave your personal rolo file as the first entry in
+the list, since this is the only file to which the Add command on the
+rolo menu adds entries.
</p>
<p>Hyperbole releases earlier than 4.17 used a different filename for the
personal rolo. If such a file exists, you will be prompted to rename
@@ -13062,6 +13103,10 @@ Next: <a href="#Concept-Index" accesskey="n"
rel="next">Concept Index</a>, Previ
<tr><td></td><td class="printindex-index-entry"><a
href="#index-actypes-rfc_002dtoc"><code>actypes
rfc-toc</code></a>:</td><td> </td><td class="printindex-index-section"><a
href="#Action-Types">Action Types</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-actypes-text_002dtoc"><code>actypes
text-toc</code></a>:</td><td> </td><td class="printindex-index-section"><a
href="#Action-Types">Action Types</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-actypes-www_002durl"><code>actypes
www-url</code></a>:</td><td> </td><td class="printindex-index-section"><a
href="#Action-Types">Action Types</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-actypes-yt_002dinfo"><code>actypes
yt-info</code></a>:</td><td> </td><td class="printindex-index-section"><a
href="#Action-Types">Action Types</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-actypes-yt_002dplay"><code>actypes
yt-play</code></a>:</td><td> </td><td class="printindex-index-section"><a
href="#Action-Types">Action Types</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-actypes-yt_002dsearch"><code>actypes
yt-search</code></a>:</td><td> </td><td
class="printindex-index-section"><a href="#Action-Types">Action
Types</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-actypes-yt_002durl"><code>actypes
yt-url</code></a>:</td><td> </td><td class="printindex-index-section"><a
href="#Action-Types">Action Types</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-add_002dhook"><code>add-hook</code></a>:</td><td> </td><td
class="printindex-index-section"><a href="#Hook-Variables">Hook
Variables</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-assist_002dkey"><code>assist-key</code></a>:</td><td> </td><td
class="printindex-index-section"><a href="#Smart-Key-Bindings">Smart Key
Bindings</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-assist_002dkey_002ddefault_002dfunction">assist-key-default-function</a>:</td><td> </td><td
class="printindex-index-section"><a href="#Smart-Key-Operations">Smart Key
Operations</a></td></tr>
@@ -13877,6 +13922,7 @@ Previous: <a href="#Function" accesskey="p"
rel="prev">Function, Variable and Fi
<tr><td></td><td class="printindex-index-entry"><a
href="#index-completion-3">completion</a>:</td><td> </td><td
class="printindex-index-section"><a
href="#Smart-Key-_002d-Argument-Completion">Smart Key - Argument
Completion</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-completion-4">completion</a>:</td><td> </td><td
class="printindex-index-section"><a href="#Smart-Key-_002d-Helm-Mode">Smart Key
- Helm Mode</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-completion_002c-Ivy">completion, Ivy</a>:</td><td> </td><td
class="printindex-index-section"><a href="#Smart-Key-_002d-Ivy">Smart Key -
Ivy</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-concepts">concepts</a>:</td><td> </td><td
class="printindex-index-section"><a href="#Menus">Menus</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-configuration">configuration</a>:</td><td> </td><td
class="printindex-index-section"><a
href="#Customization">Customization</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-consult-package">consult package</a>:</td><td> </td><td
class="printindex-index-section"><a href="#Glossary">Glossary</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-consult_002dorg_002droam-package">consult-org-roam
package</a>:</td><td> </td><td class="printindex-index-section"><a
href="#Glossary">Glossary</a></td></tr>
@@ -14818,6 +14864,7 @@ Previous: <a href="#Function" accesskey="p"
rel="prev">Function, Variable and Fi
<tr><td></td><td class="printindex-index-entry"><a
href="#index-URL-2">URL</a>:</td><td> </td><td
class="printindex-index-section"><a href="#Smart-Key-_002d-WWW-URLs">Smart Key
- WWW URLs</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-URLs_002c-abbreviated">URLs,
abbreviated</a>:</td><td> </td><td class="printindex-index-section"><a
href="#Using-URLs-with-Find_002dFile">Using URLs with Find-File</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-URLs_002c-using-with-find_002dfile">URLs, using with
find-file</a>:</td><td> </td><td class="printindex-index-section"><a
href="#Using-URLs-with-Find_002dFile">Using URLs with Find-File</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a href="#index-use-cases">use
cases</a>:</td><td> </td><td class="printindex-index-section"><a
href="#Menus">Menus</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-USENET">USENET</a>:</td><td> </td><td
class="printindex-index-section"><a href="#Buttons-in-Mail">Buttons in
Mail</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-USENET-1">USENET</a>:</td><td> </td><td
class="printindex-index-section"><a href="#Buttons-in-News">Buttons in
News</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-username">username</a>:</td><td> </td><td
class="printindex-index-section"><a href="#Implicit-Button-Types">Implicit
Button Types</a></td></tr>
@@ -14836,6 +14883,7 @@ Previous: <a href="#Function" accesskey="p"
rel="prev">Function, Variable and Fi
<tr><td></td><td class="printindex-index-entry"><a
href="#index-version-description">version
description</a>:</td><td> </td><td class="printindex-index-section"><a
href="#Suggestion-or-Bug-Reporting">Suggestion or Bug Reporting</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-vertical-drag">vertical drag</a>:</td><td> </td><td
class="printindex-index-section"><a
href="#Creating-and-Deleting-Windows">Creating and Deleting
Windows</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-vertical-drag-1">vertical drag</a>:</td><td> </td><td
class="printindex-index-section"><a
href="#Smart-Mouse-Drags-within-a-Window">Smart Mouse Drags within a
Window</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-video">video</a>:</td><td> </td><td
class="printindex-index-section"><a href="#Action-Types">Action
Types</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-view">view</a>:</td><td> </td><td
class="printindex-index-section"><a href="#Viewing-Outlines">Viewing
Outlines</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-view-mode">view mode</a>:</td><td> </td><td
class="printindex-index-section"><a href="#Smart-Key-_002d-View-Mode">Smart Key
- View Mode</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-view-spec">view spec</a>:</td><td> </td><td
class="printindex-index-section"><a href="#View-Specs">View Specs</a></td></tr>
@@ -14906,6 +14954,7 @@ Previous: <a href="#Function" accesskey="p"
rel="prev">Function, Variable and Fi
<tr><td></td><td class="printindex-index-entry"><a
href="#index-yanking">yanking</a>:</td><td> </td><td
class="printindex-index-section"><a href="#Thing-Selection">Thing
Selection</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-yanking-1">yanking</a>:</td><td> </td><td
class="printindex-index-section"><a
href="#Smart-Mouse-Drags-between-Windows">Smart Mouse Drags between
Windows</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-yanking-2">yanking</a>:</td><td> </td><td
class="printindex-index-section"><a
href="#Smart-Key-_002d-Delimited-Things">Smart Key - Delimited
Things</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-youtube">youtube</a>:</td><td> </td><td
class="printindex-index-section"><a href="#Action-Types">Action
Types</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th id="Concept-Index_cp_letter-Z">Z</th><td></td><td></td></tr>
<tr><td></td><td class="printindex-index-entry"><a
href="#index-zooming">zooming</a>:</td><td> </td><td
class="printindex-index-section"><a href="#HyControl">HyControl</a></td></tr>
diff --git a/man/hyperbole.info b/man/hyperbole.info
index 35de7575b5..f6c647cadc 100644
Binary files a/man/hyperbole.info and b/man/hyperbole.info differ
diff --git a/man/hyperbole.pdf b/man/hyperbole.pdf
index 588f4b09c5..0dcaaf9649 100644
Binary files a/man/hyperbole.pdf and b/man/hyperbole.pdf differ
diff --git a/man/hyperbole.texi b/man/hyperbole.texi
index 468d5b58a2..2b1fee7f0a 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: 13-May-23 at 10:01:36 by Bob Weiner
+@c Last-Mod: 13-May-23 at 22:34:55 by Bob Weiner
@c %**start of header (This is for running Texinfo on a region.)
@setfilename hyperbole.info
@@ -2104,14 +2104,15 @@ Key Operations}.
@cindex labeling implicit buttons
@cindex naming implicit buttons
Individual implicit buttons may be labeled/named, allowing activation
-by name or use as a link target by other buttons. Here is a pathname
+by name or use as a link target by other buttons. Such names are
+highlighted similarly to explicit button names. Here is a pathname
button with a label of 'My Emacs Files':
@example
<[My Emacs Files]>: "~/.emacs.d"
@end example
-The label is delimited by @samp{<[} and @samp{]>} and can be followed
+The name is delimited by @samp{<[} and @samp{]>} and can be followed
by any number of :, - or = separator characters, including none.
@@ -2529,13 +2530,15 @@ non-brace character.
@cindex toc implicit button type
@item text-toc
Jump to the text file section referenced by a table of contents (toc)
-entry at point. The filename of the current buffer must contain
-@file{README} and there must be a `Table of Contents' or `Contents'
-label on a line by itself (it may begin with an asterisk), preceding
-the table of contents. Each toc entry must begin with some whitespace
-followed by one or more asterisk characters. Each section header
-linked to by the toc must start with one or more asterisk characters
-at the very beginning of the line.
+entry at point. This works in any text derived major mode buffer with
+a `Table of Contents' or `Contents' label on a line by itself (it may
+begin with an asterisk), preceding the table of contents. Each TOC
+entry must begin with some whitespace followed by one or more asterisk
+characters. Each section header linked to by the toc must start with
+one or more asterisk characters at the very beginning of the line.
+TOCs in Internet RFCs work as well. For example, display this RFC,
+<link-to-rfc 822>, and Action Key press on any TOC line to jump to the
+associated section. Or try it in the Hyperbole @file{DEMO} file.
@findex ibtypes cscope
@cindex C/C++ call trees
@@ -3262,6 +3265,34 @@ Follow a link given by a URL. The variable,
that is used. Valid values of this variable include
@code{browse-url-default-browser} and @code{browse-url-generic}.
See its documentation string for details.
+
+@findex actypes yt-info
+@cindex youtube
+@cindex video
+@item yt-info
+Display a web page with the metadata information about VIDEO-ID.
+
+@findex actypes yt-play
+@item yt-play
+Play a VIDEO-ID from the point specified by optional START-TIME-STRING.
+If not given, START-TIME-STRING is set to "0s" representing the beginning
+of the video. START-TIME-STRING is a colon-separated hours:minutes:seconds
+string, e.g. 1:2:44 (1 hour, two minutes, 45 seconds), where the hours
+and minutes are optional.
+
+@findex actypes yt-search
+@item yt-search
+Search Youtube for SEARCH-TERM.
+
+@findex actypes yt-url
+@item yt-url
+Return url to play VIDEO-ID from point specified by optional START-TIME-STRING.
+Return nil if START-TIME-STRING is given but is invalid. If not given,
+START-TIME-STRING is set to "0s" representing the beginning of the video.
+
+START-TIME-STRING is a colon-separated hours:minutes:seconds string,
+e.g. 1:2:44 (1 hour, two minutes, 45 seconds), where the hours and
+minutes are optional.
@end table
@@ -3869,11 +3900,16 @@ in the current buffer.
@cindex menu, Documentation
@cindex menu, Doc
@cindex menu, Types
+@cindex concepts
+@cindex use cases
@item Doc/
-Hyperbole documentation quick access. This menu contains an About item
-which describes Hyperbole and a Demo item which demonstrates a number of
-interactive Hyperbole features. It also contains the Types/ submenu for
-documentation on Hyperbole implicit button and action types.
+Hyperbole documentation quick access. This menu contains an About
+item which describes Hyperbole; a Concepts item that discusses how
+Hyperbole features all interrelate; a Demo item which demonstrates a
+number of interactive Hyperbole features; a New item that details new
+Hyperbole features, as well as a WhyUse item with use cases. It also
+contains the Types/ submenu for documentation on Hyperbole implicit
+button and action types.
@cindex Find
@cindex Grep
@@ -5741,8 +5777,7 @@ an optional header that starts and ends with a line of
equal signs (at
least three equal signs starting at the beginning of a line), followed
by zero or more rolo records which we call entries. You must manually
add a header to any rolo file if you want it to have one. Rolo files
-may be regular text files, Emacs outline files, Org files, Markdown
-files or Koutline files.
+may be Emacs outline files, Org files, Markdown files or Koutline files.
Rolo @dfn{entries} begin with optional space, followed by a delimiter of
one or more special characters followed by another space. Delimiters
@@ -5755,7 +5790,6 @@ Emacs Outline Mode: ***
Koutline Mode: 1b3 or 1.2.3
Markdown Mode: ###
Org Mode: ***
-Text Mode: ***
@end group
@end example
@@ -5994,7 +6028,7 @@ you should contact.
@cindex hyrolo menu
@cindex rolo keys
After a rolo search is performed, point is left in the @dfn{rolo
-match buffer}, @file{*Hyperbole Rolo*}, which uses @code{hyrolo-mode} to
+match buffer}, @file{*HyRolo*}, which uses @code{hyrolo-mode} to
simplify browsing many HyRolo matches. Press @bkbd{?} when in the
match buffer for a summary of available keys, all of which are
documented in this section.
@@ -6142,13 +6176,16 @@ current frame to its state prior to the rolo search.
@cindex rolo, personal
The files used in any rolo search are given by the
@code{hyrolo-file-list} variable, whose default value is typically
-@code{"~/.rolo.otl"}. Searches scan only your personal rolo file.
-Any entries added to this list should be absolute filenames. If a
-file in the list does not exist or is not readable, it is skipped.
-Files are searched in the order in which they appear in the list. In
-general, you should leave your personal rolo file as the first entry
-in the list, since this is the only file to which the Add command on
-the rolo menu adds entries.
+@code{"~/.rolo.otl"}, in which case, searches scan only your personal
+rolo file. Any entries added to this list should be absolute
+filenames and can be any of the following formats: Emacs outlines
+(.otl), Koutlines (.kotl), Markdown files (.md), or Org files (.org).
+
+If a file in the list does not exist or is not readable, it is
+skipped. Files are searched in the order in which they appear in the
+list. You should leave your personal rolo file as the first entry in
+the list, since this is the only file to which the Add command on the
+rolo menu adds entries.
Hyperbole releases earlier than 4.17 used a different filename for the
personal rolo. If such a file exists, you will be prompted to rename
- [elpa] externals/hyperbole updated (2cd6cbe153 -> 9096ea849e), ELPA Syncer, 2023/05/14
- [elpa] externals/hyperbole 616ee63b21 5/8: hsys-youtube.el - Doc and properly define yt- actypes,
ELPA Syncer <=
- [elpa] externals/hyperbole 968c09d8a7 6/8: Restore Smart Key depress window buffer if switched before release, ELPA Syncer, 2023/05/14
- [elpa] externals/hyperbole 085cf5ae92 7/8: Merge branch 'master' into rsw, ELPA Syncer, 2023/05/14
- [elpa] externals/hyperbole 4d96e83e61 1/8: Add HY-CONCEPTS.kotl on {C-h h d c}, ELPA Syncer, 2023/05/14
- [elpa] externals/hyperbole 0c1f6b07a7 2/8: Action Key on top-level mini menu name reloads Smart Keys and menus, ELPA Syncer, 2023/05/14
- [elpa] externals/hyperbole 9096ea849e 8/8: Merge pull request #325 from rswgnu/rsw, ELPA Syncer, 2023/05/14
- [elpa] externals/hyperbole 4194f18537 4/8: Catch potential error in mount point shell cmd call from hypb mode, ELPA Syncer, 2023/05/14
- [elpa] externals/hyperbole 3177f4b845 3/8: Update test/MANIFEST so is current, ELPA Syncer, 2023/05/14