From 61d565ce18392a8a92347cb3376f7cd8d1092fe5 Mon Sep 17 00:00:00 2001 From: plugd Date: Sun, 1 May 2022 22:21:02 +0200 Subject: [PATCH] Documentation update for 3.4.0. --- config.mk | 2 +- elpher-pkg.el | 2 +- elpher.el | 4 ++-- elpher.texi | 34 +++++++++++++++++++++++++++++++++- 4 files changed, 37 insertions(+), 5 deletions(-) diff --git a/config.mk b/config.mk index b3cc115..6647c4c 100644 --- a/config.mk +++ b/config.mk @@ -1,5 +1,5 @@ PKG = elpher -VERSION = 3.3.3 +VERSION = 3.4.0 INSTALLINFO = install-info MAKEINFO = makeinfo diff --git a/elpher-pkg.el b/elpher-pkg.el index 2ff63df..9130582 100644 --- a/elpher-pkg.el +++ b/elpher-pkg.el @@ -1,4 +1,4 @@ -(define-package "elpher" "3.3.3" "A friendly gopher and gemini client" +(define-package "elpher" "3.4.0" "A friendly gopher and gemini client" '((emacs "27.1")) :keywords ("convenience") :authors (("Tim Vaughan" . "plugd@thelambdalab.xyz")) diff --git a/elpher.el b/elpher.el index 879e68a..b264dcc 100644 --- a/elpher.el +++ b/elpher.el @@ -5,7 +5,7 @@ ;; Author: Tim Vaughan ;; Created: 11 April 2019 -;; Version: 3.3.3 +;; Version: 3.4.0 ;; Keywords: comm gopher ;; Homepage: https://thelambdalab.xyz/elpher ;; Package-Requires: ((emacs "27.1")) @@ -70,7 +70,7 @@ ;;; Global constants ;; -(defconst elpher-version "3.3.3" +(defconst elpher-version "3.4.0" "Current version of elpher.") (defconst elpher-margin-width 6 diff --git a/elpher.texi b/elpher.texi index a97a4e4..ff2979a 100644 --- a/elpher.texi +++ b/elpher.texi @@ -1,7 +1,7 @@ \input texinfo @c -*-texinfo-*- @setfilename elpher.info -@settitle Elpher Manual v3.3.0 +@settitle Elpher Manual v3.4.0 @dircategory Emacs @direntry @@ -641,6 +641,24 @@ In either case, ``forgetting'' means that the details of the key and certificate file pair are erased from memory. Furthermore, in the case of throw-away certificates, the corresponding files are deleted. +@section Hiding preformatted text in text/gemini documents + +Preformatted text is often used to display ``ASCII art'' or other +similar text-based artwork. While for many this is a fun way to +introduce personality into their gemini documents, such text can +pose difficulties for screen readers. + +Setting the @code{elpher-gemini-hide-preformatted} customization option +to non-nil causes Elpher to hide all preformatted text blocks by +default. In place of the preformatted text, Elpher instead displays the +``alt text'' (if any is available), along with a button which can be +used to make specific blocks visible as required. + +Other related customization options are +@code{elpher-gemini-preformatted-toggle-label}, which is the label used +for the toggle button, and +@code{elpher-gemini-preformatted-toggle-bullet}, which is the margin +string used to distinguish the line replacing the preformatted text. @node Finger support, Local files, Gemini support, Top @chapter Finger support @@ -800,6 +818,20 @@ See the customization group itself for details. This chapter documents the major changes introduced by Elpher releases. +@section v3.4.0 + +@subsection Toggling preformatted text visibility + +This version introduces the ability to hide preformatted text in +text/gemini documents by default. To enable this, set the customization +variable @code{elpher-gemini-hide-preformatted} to non-nil. This causes +all preformated text blocks to be replaced with their ``alt-text'' (if +any is available) and a button for toggling the visibility of the text +block. + +This feature is intended to make it easier for people using screen +readers to read text/gemini documents. + @section v3.3.0 This version includes lots of bug fixes, as well as a couple of new -- 2.20.1