branch: externals/hyperbole
commit f3214b521017413fd17769a071284d2a86864f91
Author: Mats Lidell <[email protected]>
Commit: GitHub <[email protected]>
Preparation for reorganization of public documentation (#820)
---
ChangeLog | 9 +++++++++
Makefile | 20 ++++++++++----------
README.md | 5 ++++-
README.md.html | 26 ++++++++++++++++++++------
README.toc.md | 26 ++++++++++++++++++++++++--
5 files changed, 67 insertions(+), 19 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index b0441626ce..c6ab80f473 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2025-11-29 Mats Lidell <[email protected]>
+
+* README.md: Add link to stable documentation. Use html version of HY-NEWS.
+
+* Makefile: Support pushing the development version to www.gnu.org in
+ preparation for reorganization of the documentation.
+ (website): Prompt for confirmation on dangerous operations.
+ (website-devel): Remove not needed target.
+
2025-11-29 Bob Weiner <[email protected]>
* man/im/hywiki-page.png: Add.
diff --git a/Makefile b/Makefile
index 9f004e920e..9bb2d51e44 100644
--- a/Makefile
+++ b/Makefile
@@ -3,7 +3,7 @@
# Author: Bob Weiner
#
# Orig-Date: 15-Jun-94 at 03:42:38
-# Last-Mod: 13-Oct-25 at 22:23:24 by Mats Lidell
+# Last-Mod: 29-Nov-25 at 19:19:51 by Mats Lidell
#
# Copyright (C) 1994-2025 Free Software Foundation, Inc.
# See the file HY-COPY for license information.
@@ -178,7 +178,6 @@ ELISP_TO_COMPILE = $(pkg_parent)/elc-${USER}
# Path to dir where the web repository is located i.e. hypb:web-repo-location
HYPB_WEB_REPO_LOCATION = ../hyweb/hyperbole/
-HYPB_WEB_REPO_LOCATION_DEVEL = $(HYPB_WEB_REPO_LOCATION)devel/
# CI/CD Emacs versions for local docker based tests
DOCKER_VERSIONS=28.2 29.4 30.2 master
@@ -428,23 +427,24 @@ README.md.html: README.md README.toc.md
&& pandoc --from=gfm-tex_math_dollars --to=html+gfm_auto_identifiers
-o README.md.html README.toc.md
# website maintenance: "https://www.gnu.org/software/hyperbole/";
+define confirm
+ @echo "═══════════════════════════════════════"
+ @echo " WARNING: $(1)"
+ @echo "═══════════════════════════════════════"
+ @read -r -p "Are you sure? Write '$(2)' to continue: " answer; \
+ [[ "$$answer" == "$(2)" ]] || { echo "Aborted."; exit 1; }
+endef
+
# Locally update Hyperbole website
website-local: README.md.html
$(EMACS_BATCH) --debug -l hypb-maintenance --eval '(let
((hypb:web-repo-location "$(HYPB_WEB_REPO_LOCATION)")) (hypb:web-repo-update))'
# Push to public Hyperbole website
website: website-local
+ $(call confirm,Deploys to website!,DEPLOY)
cd $(HYPB_WEB_REPO_LOCATION) && $(CVS) commit -m "Hyperbole release
$(HYPB_VERSION)"
@echo "Website for Hyperbole $(HYPB_VERSION) is updated."
-# Locally update development website
-website-local-devel: README.md.html
- $(EMACS_BATCH) --debug -l hypb-maintenance --eval '(let
((hypb:web-repo-location "$(HYPB_WEB_REPO_LOCATION_DEVEL)"))
(hypb:web-repo-update))'
-
-website-devel: website-local-devel
- cd $(HYPB_WEB_REPO_LOCATION_DEVEL) && $(CVS) commit -m "Hyperbole
development update $(HYPB_VERSION)"
- @echo "Website for Hyperbole $(HYPB_VERSION) is updated."
-
# Generate a Hyperbole package suitable for distribution via the Emacs package
manager.
pkg: package
package: tags doc $(pkg_parent)/hyperbole-$(HYPB_VERSION).tar.sig
diff --git a/README.md b/README.md
index c91f9c8fe3..e946091ae8 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,8 @@
# GNU Hyperbole 9.0.2pre - The Everyday Hypertextual Information Manager
+[ If you are looking for the documentation for the stable release look
+[here](stable/hyperbole.html).]
+
[We work on Hyperbole as a gift to the Emacs community and request you
send us a thank you or a testimonial describing your usage if you like
Hyperbole to [[email protected]](mailto:[email protected])].
@@ -466,7 +469,7 @@ Typical Hyperbole applications include:
See the [HY-ABOUT](HY-ABOUT) file for a description and overview of Hyperbole.
-See the [HY-NEWS](HY-NEWS) file for a summary of new features in this release.
+See the [HY-NEWS](HY-NEWS.html) file for a summary of new features in this
release.
See the [INSTALL](INSTALL) file for installation and invocation instructions.
diff --git a/README.md.html b/README.md.html
index 09c86cc806..dbd04d7a78 100644
--- a/README.md.html
+++ b/README.md.html
@@ -1,15 +1,18 @@
<h1
id="gnu-hyperbole-902pre---the-everyday-hypertextual-information-manager">GNU
Hyperbole 9.0.2pre - The Everyday Hypertextual Information Manager</h1>
+<p>[ If you are looking for the documentation for the stable release
+look <a href="stable/hyperbole.html">here</a>.]</p>
<p>[We work on Hyperbole as a gift to the Emacs community and request
you send us a thank you or a testimonial describing your usage if you
-like Hyperbole (mailto:<a
-href="mailto:[email protected]";>[email protected]</a>)].</p>
+like Hyperbole to <a
+href="mailto:[email protected]";><span>[email protected]</span></a>].</p>
<ul>
<li><a
href="#gnu-hyperbole-902pre---the-everyday-hypertextual-information-manager">GNU
Hyperbole 9.0.2pre - The Everyday Hypertextual Information Manager</a>
<ul>
+<li><a href="#reference-manual">Reference Manual</a></li>
<li><a href="#videos">Videos</a></li>
<li><a href="#summary">Summary</a></li>
<li><a href="#installation">Installation</a></li>
@@ -31,6 +34,17 @@ developed?</a></li>
</ul>
<p><img src="man/im/hyperbole-cv.png"
alt="Hyperbole screenshot of the Koutliner, DEMO file and HyRolo" /></p>
+<h2 id="reference-manual">Reference Manual</h2>
+<p>Hyperbole has many features you can explore interactively or by
+reading sections of the reference manual:</p>
+<ul>
+<li><p><a href="man/hyperbole.html">Browse Hyperbole Web
+Manual</a></p></li>
+<li><p><a href="man/hyperbole.info">In Emacs, Browse Hyperbole Info
+Manual</a></p></li>
+<li><p><a href="man/hyperbole.pdf">Display or Print PDF
+Manual</a></p></li>
+</ul>
<h2 id="videos">Videos</h2>
<p>If you prefer video introductions, visit the videos linked to below;
otherwise, skip to the next section.</p>
@@ -147,7 +161,7 @@ and structured files, mail messages and news articles. It
offers
intuitive keyboard and mouse-based control of information display within
multiple windows. It also provides point-and-click access to World-Wide
Web URLs, Info manuals, ftp archives, etc.</p>
-<p>Hyperbole works well on GNU Emacs 27.1 or above. It is designed and
+<p>Hyperbole works well on GNU Emacs 28 or above. It is designed and
written by Bob Weiner. It is maintained by him and Mats Lidell. Its main
distribution site is: <a
href="https://www.gnu.org/software/hyperbole/";>https://www.gnu.org/software/hyperbole/</a>.
@@ -226,9 +240,9 @@ not a simple introduction. It is included in the "man/"
subdirectory of
the Hyperbole package directory in four forms:</p>
<p><a href="man/hyperbole.info">hyperbole.info</a> - online Info browser
version<br />
-<a href="man/hyperbole.html">hyperbole.html</a> - web HTML version<br />
+<a href="man/hyperbole.html">hyperbole.html</a> - web version<br />
<a href="man/hyperbole.pdf">hyperbole.pdf</a> - printable version<br />
-<a href="man/hyperbole.texi">hyperbole.texi</a> - source form</p>
+<a href="man/hyperbole.texi">hyperbole.texi</a> - source version</p>
<p>The Hyperbole package installation places the Info version of this
manual where needed and adds an entry for Hyperbole into the Info
directory under the Emacs category. {C-h h d i} will let you browse the
@@ -422,7 +436,7 @@ archive entries.</p></li>
<h2 id="files">Files</h2>
<p>See the <a href="HY-ABOUT">HY-ABOUT</a> file for a description and
overview of Hyperbole.</p>
-<p>See the <a href="HY-NEWS">HY-NEWS</a> file for a summary of new
+<p>See the <a href="HY-NEWS.html">HY-NEWS</a> file for a summary of new
features in this release.</p>
<p>See the <a href="INSTALL">INSTALL</a> file for installation and
invocation instructions.</p>
diff --git a/README.toc.md b/README.toc.md
index c91f9c8fe3..18cb88f5d8 100644
--- a/README.toc.md
+++ b/README.toc.md
@@ -1,10 +1,32 @@
# GNU Hyperbole 9.0.2pre - The Everyday Hypertextual Information Manager
+[ If you are looking for the documentation for the stable release look
+[here](stable/hyperbole.html).]
+
[We work on Hyperbole as a gift to the Emacs community and request you
send us a thank you or a testimonial describing your usage if you like
Hyperbole to [[email protected]](mailto:[email protected])].
-[TOC]
+
+
+- [GNU Hyperbole 9.0.2pre - The Everyday Hypertextual Information
Manager](#gnu-hyperbole-902pre---the-everyday-hypertextual-information-manager)
+ - [Reference Manual](#reference-manual)
+ - [Videos](#videos)
+ - [Summary](#summary)
+ - [Installation](#installation)
+ - [Invocation](#invocation)
+ - [Mailing Lists](#mailing-lists)
+ - [Ftp and Git Repository Downloads](#ftp-and-git-repository-downloads)
+ - [Hyperbole Components](#hyperbole-components)
+ - [Hyperbole Buttons](#hyperbole-buttons)
+ - [Important Features](#important-features)
+ - [Hyperbole Uses](#hyperbole-uses)
+ - [Files](#files)
+ - [Programmer Quick Reference](#programmer-quick-reference)
+ - [User Quotes](#user-quotes)
+ - [Why was Hyperbole developed?](#why-was-hyperbole-developed)
+
+
@@ -466,7 +488,7 @@ Typical Hyperbole applications include:
See the [HY-ABOUT](HY-ABOUT) file for a description and overview of Hyperbole.
-See the [HY-NEWS](HY-NEWS) file for a summary of new features in this release.
+See the [HY-NEWS](HY-NEWS.html) file for a summary of new features in this
release.
See the [INSTALL](INSTALL) file for installation and invocation instructions.
