M CHANGELOG.org => CHANGELOG.org +52 -0
@@ 6,6 6,58 @@
The newest release is at the top. For further details, please consult
the manual: <https://protesilaos.com/emacs/logos>.
+* Version 0.6.0 on 2022-10-19
+:PROPERTIES:
+:CUSTOM_ID: h:b71866b6-393a-4bff-bb89-e52f5e2fca9d
+:END:
+
++ Revised the fallback condition of the user option
+ ~logos-outline-regexp-alist~ (it comes into effect when the
+ ~logos-outlines-are-pages~ is non-nil).
+
+ The previous value did not account for the buffer-local values of
+ ~outline-regexp~ or ~page-delimiter~, nor did it adapt to any
+ changes in their respective values. Instead, it would capture
+ whatever the value was at the time of the symbol's declaration.
+
+ We remove the =t= condition altogether and instead handle the
+ fallback value internally. Logos will return the current
+ buffer-local value of ~outline-regexp~ or ~page-delimiter~, in this
+ order of priority.
+
+ Put simply, this has the same intent as before, but works properly.
+
++ Introduced a check to guard against a void ~outline-regexp~. The
+ previous value would cause a problem if the ~outline-regexp~ had not
+ been set yet. In a typical Emacs session, even on 'emacs -Q', the
+ ~outline-regexp~ is set in the scratch buffer, so we have a valid
+ value at the outset. However, when the user changes the
+ ~initial-buffer-choice~ or opens Emacs directly for a given file,
+ the ~outline-regexp~ can be void.
+
+ Thanks to Xiaoduan for informing me about this error and for testing
+ my code on how to fix it. This was done via a private channel and
+ is shared with permission.
+
++ Implemented the user option ~logos-hide-cursor~. It hides the
+ cursor when ~logos-focus-mode~ is enabled. Note that this user
+ option is always buffer-local. Use ~setq-default~ to set its
+ default global value (same as with other user options that apply to
+ ~logos-focus-mode~ (read the manual)).
+
+ Thanks to Marcel Ventosa for suggesting the idea of hiding the
+ cursor. This was done via a private channel and is shared with
+ permission.
+
++ Clarified the documentation of ~logos-focus-mode-extra-functions~.
+ It is intended for use by those who are prepared to write custom
+ functions in the spirit of those already used in =logos.el= to
+ affect the buffer when ~logos-focus-mode~ is enabled.
+
++ Added the missing autoload cookie to ~logos-focus-mode~. This means
+ that it shows up in the completion candidates of =M-x= even if the
+ =logos= library has not been called via =require=.
+
* Version 0.5.0 on 2022-09-01
:PROPERTIES:
:CUSTOM_ID: h:189634ab-187a-4e44-9006-1361459150b8
M README.org => README.org +3 -7
@@ 5,9 5,9 @@
#+options: ':t toc:nil author:t email:t num:t
#+startup: content
-#+macro: stable-version 0.5.0
-#+macro: release-date 2022-09-01
-#+macro: development-version 1.0.0-dev
+#+macro: stable-version 1.0.0
+#+macro: release-date 2022-10-19
+#+macro: development-version 1.1.0-dev
#+macro: file @@texinfo:@file{@@$1@@texinfo:}@@
#+macro: space @@texinfo:@: @@
#+macro: kbd @@texinfo:@kbd{@@$1@@texinfo:}@@
@@ 134,8 134,6 @@ buffers (~logos-variable-pitch~), make the buffer read-only
~fringe~ face (~logos-hide-fringe~). All these variables are
buffer-local.
-[ Note that ~logos-hide-cursor~ is part of {{{development-version}}}. ]
-
#+vindex: logos-focus-mode-map
Furthermore, the ~logos-focus-mode~ establishes a bespoke keymap, which
can be used to, for example, bind the arrow keys to page motions. The
@@ 228,8 226,6 @@ changes out-of-the-box ([[#h:2bb57369-352a-43bf-afe3-0bed2fcc7359][Extra tweaks]
effects if they are non-nil. Note that everything is buffer-local, so
it is possible to use file variables as described in the Emacs manual.
-[ Note that ~logos-hide-cursor~ is part of {{{development-version}}}. ]
-
#+begin_src emacs-lisp
(require 'logos)
M logos.el => logos.el +2 -2
@@ 6,7 6,7 @@
;; Maintainer: Logos Development <~protesilaos/logos@lists.sr.ht>
;; URL: https://git.sr.ht/~protesilaos/logos
;; Mailing-List: https://lists.sr.ht/~protesilaos/logos
-;; Version: 0.5.1
+;; Version: 1.0.0
;; Package-Requires: ((emacs "27.1"))
;; Keywords: convenience, focus, writing, presentation, narrowing
@@ 123,7 123,7 @@ If the current buffer's major mode is not specified herein, Logos
will try to use the `outline-regexp', else fall back to the
generic `page-delimiter'."
:type `(alist :key-type symbol :value-type string) ; TODO 2022-03-02: ensure symbol is mode?
- :package-version '(logos . "0.6.0")
+ :package-version '(logos . "1.0.0")
:group 'logos)
(defcustom logos-hide-cursor nil