[ELPA] Add 'logos' package

[ELPA] Add 'logos' package

[Protesilaos Stavrou]

[-- Attachment #1: Type: text/plain, Size: 887 bytes --]

Good day!

I have a small package which helps set up a simple "focus mode" using
standard Emacs utilities (pages, narrowing, outline-regexp, ...).  Quote
from the manual:

    This package provides a simple "focus mode" which can be applied to
    any buffer for reading, writing, or even doing a presentation.  The
    buffer can be divided in pages using the 'page-delimiter', outline
    structure, or any other pattern.  Commands are provided to move
    between those pages.  These motions work even when narrowing is in
    effect (and they preserve it).  'logos.el' is designed to be simple
    by default and easy to extend.  This manual provides concrete
    examples to that end.

    <https://protesilaos.com/emacs/logos>

Can this be added to GNU ELPA?  Check the attached patch.

All the best,
Protesilaos (or simply "Prot")

-- 
Protesilaos Stavrou
https://protesilaos.com

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-logos-New-package.patch --]
[-- Type: text/x-patch, Size: 946 bytes --]

From b92ee1b081b3d231c35b4a5c5ea61cdc215a602c Mon Sep 17 00:00:00 2001
Message-Id: <b92ee1b081b3d231c35b4a5c5ea61cdc215a602c.1646996187.git.info@protesilaos.com>
From: Protesilaos Stavrou <info@protesilaos.com>
Date: Fri, 11 Mar 2022 12:47:14 +0200
Subject: [PATCH] (logos): New package

---
 elpa-packages | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/elpa-packages b/elpa-packages
index b324807973..9985c168b9 100644
--- a/elpa-packages
+++ b/elpa-packages
@@ -351,6 +351,10 @@
  ("load-relative"	:url "https://github.com/rocky/emacs-load-relative")
  ("loc-changes"		:url "https://github.com/rocky/emacs-loc-changes")
  ("loccur"		:url "https://github.com/fourier/loccur")
+ ("logos"
+  :url "https://gitlab.com/protesilaos/logos"
+  :doc "README.org"
+  :auto-sync t)
  ("map"                 :core "lisp/emacs-lisp/map.el")
  ("marginalia"		:url "https://github.com/minad/marginalia"
   :doc "README.org" :auto-sync t)
-- 
2.35.1

Re: [ELPA] Add 'logos' package

[Philip Kaludercic]

Protesilaos Stavrou <info@protesilaos.com> writes:

> Good day!
>
> I have a small package which helps set up a simple "focus mode" using
> standard Emacs utilities (pages, narrowing, outline-regexp, ...).  Quote
> from the manual:
>
>     This package provides a simple "focus mode" which can be applied to
>     any buffer for reading, writing, or even doing a presentation.  The
>     buffer can be divided in pages using the 'page-delimiter', outline
>     structure, or any other pattern.  Commands are provided to move
>     between those pages.  These motions work even when narrowing is in
>     effect (and they preserve it).  'logos.el' is designed to be simple
>     by default and easy to extend.  This manual provides concrete
>     examples to that end.
>
>     <https://protesilaos.com/emacs/logos>
>
> Can this be added to GNU ELPA?  Check the attached patch.

Looks fine, I would apply it if there are no complaints.

Also, you seem to have a CHANGELOG.org file, should we use that to
generate the "News" section on the ELPA website?

> All the best,
> Protesilaos (or simply "Prot")

-- 
	Philip Kaludercic

Re: [ELPA] Add 'logos' package

[Protesilaos Stavrou]

On 2022-03-11, 13:22 +0000, Philip Kaludercic <philipk@posteo.net> wrote:

> Protesilaos Stavrou <info@protesilaos.com> writes:
>
>> Good day!
>>
>> I have a small package which helps set up a simple "focus mode" using
>> standard Emacs utilities (pages, narrowing, outline-regexp, ...).  Quote
>> from the manual:
>>
>>     This package provides a simple "focus mode" which can be applied to
>>     any buffer for reading, writing, or even doing a presentation.  The
>>     buffer can be divided in pages using the 'page-delimiter', outline
>>     structure, or any other pattern.  Commands are provided to move
>>     between those pages.  These motions work even when narrowing is in
>>     effect (and they preserve it).  'logos.el' is designed to be simple
>>     by default and easy to extend.  This manual provides concrete
>>     examples to that end.
>>
>>     <https://protesilaos.com/emacs/logos>
>>
>> Can this be added to GNU ELPA?  Check the attached patch.
>
> Looks fine, I would apply it if there are no complaints.

Thank you!

> Also, you seem to have a CHANGELOG.org file, should we use that to
> generate the "News" section on the ELPA website?

Fine by me.  Though the current/first entry basically tells people to
read the manual.  I thought it made no sense to document all the changes
I made since the day this was part of my own init.el.

-- 
Protesilaos Stavrou
https://protesilaos.com

Re: [ELPA] Add 'logos' package

[Philip Kaludercic]

Protesilaos Stavrou <info@protesilaos.com> writes:

>> Also, you seem to have a CHANGELOG.org file, should we use that to
>> generate the "News" section on the ELPA website?
>
> Fine by me.  Though the current/first entry basically tells people to
> read the manual.  I thought it made no sense to document all the changes
> I made since the day this was part of my own init.el.

The point it to have an overview of what changed in the coming versions,
so this shouldn't be an issue.

-- 
	Philip Kaludercic

Re: [ELPA] Add 'logos' package

[Protesilaos Stavrou]

[ Sorry!  Forgot to include emacs-devel. ]

On 2022-03-11, 15:58 +0200, Protesilaos Stavrou <info@protesilaos.com> wrote:

> Hello Stefan!
>
> On 2022-03-11, 08:45 -0500, Stefan Monnier <monnier@iro.umontreal.ca> wrote:
>
>>> Can this be added to GNU ELPA?  Check the attached patch.
>>
>> I'm afraid GNU ELPA is already full.
>>
>>         Stef "not sure why I constantly feel compelled to be silly"
>
> [ Read below ]
>
>> PS: More seriously, I wonder why you named it "logos" which to me
>>     doesn't suggest much more than "language", which would seem to be
>>     only distantly related to focusing on "a page at a time" display.
>
> I thought it relates to "language" since it might help with reading,
> writing, presenting/talking, reasoning (another meaning of "logos").
> Also because I could not think of a better name...
>
> Besides, silliness is my speciality when coming up with backronyms:
>
>     1. ^L Only Generates Ostensible Slides
>     2. Logos Optionally Garners Outline Sections
>
> I understand "logos" does not help with discoverability.  If there is a
> more appropriate and succinct name I am willing to update things
> accordingly.

-- 
Protesilaos Stavrou
https://protesilaos.com

Re: [ELPA] Add 'logos' package

[Philip Kaludercic]

Protesilaos Stavrou <info@protesilaos.com> writes:

> [ Sorry!  Forgot to include emacs-devel. ]

You should be able to edit and resend a message if that happens.

>> [ Read below ]
>>
>>> PS: More seriously, I wonder why you named it "logos" which to me
>>>     doesn't suggest much more than "language", which would seem to be
>>>     only distantly related to focusing on "a page at a time" display.
>>
>> I thought it relates to "language" since it might help with reading,
>> writing, presenting/talking, reasoning (another meaning of "logos").
>> Also because I could not think of a better name...
>>
>> Besides, silliness is my speciality when coming up with backronyms:
>>
>>     1. ^L Only Generates Ostensible Slides
>>     2. Logos Optionally Garners Outline Sections
>>
>> I understand "logos" does not help with discoverability.  If there is a
>> more appropriate and succinct name I am willing to update things
>> accordingly.

I kind of agree with Stefan's point, though in my case the first meaning
that came to mind was "reason"[0].  As the package is useful, it would
be a shame for people not to miss is because of the name.

Intuitively, I would say it should make a reference towards narrowing
and page/section navigation.  Maybe also that it is useful for
presenting?  I can't come up with a good name right now either.

[0] https://en.wiktionary.org/wiki/%CE%BB%CF%8C%CE%B3%CE%BF%CF%82#Ancient_Greek

-- 
	Philip Kaludercic

Re: [ELPA] Add 'logos' package

[Protesilaos Stavrou]

On 2022-03-11, 16:16 +0000, Philip Kaludercic <philipk@posteo.net> wrote:

> Protesilaos Stavrou <info@protesilaos.com> writes:
>
>> [ Sorry!  Forgot to include emacs-devel. ]
>
> You should be able to edit and resend a message if that happens.
>
>>> [ Read below ]
>>>
>>>> PS: More seriously, I wonder why you named it "logos" which to me
>>>>     doesn't suggest much more than "language", which would seem to be
>>>>     only distantly related to focusing on "a page at a time" display.
>>>
>>> I thought it relates to "language" since it might help with reading,
>>> writing, presenting/talking, reasoning (another meaning of "logos").
>>> Also because I could not think of a better name...
>>>
>>> Besides, silliness is my speciality when coming up with backronyms:
>>>
>>>     1. ^L Only Generates Ostensible Slides
>>>     2. Logos Optionally Garners Outline Sections
>>>
>>> I understand "logos" does not help with discoverability.  If there is a
>>> more appropriate and succinct name I am willing to update things
>>> accordingly.
>
> I kind of agree with Stefan's point, though in my case the first meaning
> that came to mind was "reason"[0].  As the package is useful, it would
> be a shame for people not to miss is because of the name.
>
> Intuitively, I would say it should make a reference towards narrowing
> and page/section navigation.  Maybe also that it is useful for
> presenting?  I can't come up with a good name right now either.

I think others will have the same opinion.  Though as you note, it is
difficult to find a term that captures concepts such as "pages",
"outlines", "narrowing"...

I had thought about something pertaining to presentations but discarded
it.  It felt like it was emphasising one use-case, whereas the package
can be used simply to read or write or just as a convenience for moving
around the buffer.  Same principle for anything that hinted at "focus".

Again, I am open to suggestions.  Though I have ran out of ideas.  Hence
the generic name I chose.

-- 
Protesilaos Stavrou
https://protesilaos.com

Re: [ELPA] Add 'logos' package

[Jose A. Ortega Ruiz]

On Fri, Mar 11 2022, Protesilaos Stavrou wrote:

[...]

> I had thought about something pertaining to presentations but discarded
> it.  It felt like it was emphasising one use-case, whereas the package
> can be used simply to read or write or just as a convenience for moving
> around the buffer.  Same principle for anything that hinted at "focus".
>
> Again, I am open to suggestions.  Though I have ran out of ideas.  Hence
> the generic name I chose.

I haven't fully followed this thread, so apologies if these have already
been mentioned: "locus" sounds pretty suggestive to me, and i also quite
like the more daring "limelight".

Cheers,
jao
-- 
One reason that life is complex is that it has a real part and an
imaginary part.
 -Andrew Koenig

Re: [ELPA] Add 'logos' package

[Protesilaos Stavrou]

On 2022-03-11, 17:15 +0000, "Jose A. Ortega Ruiz" <mail@jao.io> wrote:

> On Fri, Mar 11 2022, Protesilaos Stavrou wrote:
>
> [...]
>
>> I had thought about something pertaining to presentations but discarded
>> it.  It felt like it was emphasising one use-case, whereas the package
>> can be used simply to read or write or just as a convenience for moving
>> around the buffer.  Same principle for anything that hinted at "focus".
>>
>> Again, I am open to suggestions.  Though I have ran out of ideas.  Hence
>> the generic name I chose.
>
> I haven't fully followed this thread, so apologies if these have already
> been mentioned: "locus" sounds pretty suggestive to me, and i also quite
> like the more daring "limelight".

Thank you!  These are different though they constitute a lateral step:
It is not obvious how those terms describe what the package does.

If we will still have to explain what the name means, I think it is
easier to just stick with "logos".  That way I will not have to make any
changes to the package and my website.

[ To be clear: the manual already explains everything in detail. ]

-- 
Protesilaos Stavrou
https://protesilaos.com

Re: [ELPA] Add 'logos' package

[Kévin Le Gouguec]

Protesilaos Stavrou <info@protesilaos.com> writes:

> If we will still have to explain what the name means, I think it is
> easier to just stick with "logos".  That way I will not have to make any
> changes to the package and my website.

FWIW, I find "logos" to be a fine name for this package.  Might be just
me, but it conveys notions of "speech", "reason", "structured thought",
which IIUC this mode aims at supporting.

The Emacs package ecosystem is no stranger to obscure names that
nonetheless seem to enjoy wide popularity; I'm thinking e.g. of Daniel
Mendler's corfu and vertico.

I think keywords and titles are more suited to solving the problem of
package discovery and visibility.  Trying to stuff as much "relevant"
semantics as possible in the name alone feels counter-productive to me:
finding one or two words that will successfully map to a meaningful
subset of a package's feature, in every user's brain, sounds like a very
hard problem.

IMO this "one-or-two words" budget is better spent on some other purpose
(brevity, catchiness, punniness, theming…).  Again, to me "logos" is
thematically very appropriate.

Re: [ELPA] Add 'logos' package

[Protesilaos Stavrou]

On 2022-03-12, 09:59 +0100, Kévin Le Gouguec <kevin.legouguec@gmail.com> wrote:

> Protesilaos Stavrou <info@protesilaos.com> writes:
>
>> If we will still have to explain what the name means, I think it is
>> easier to just stick with "logos".  That way I will not have to make any
>> changes to the package and my website.
>
> FWIW, I find "logos" to be a fine name for this package.  Might be just
> me, but it conveys notions of "speech", "reason", "structured thought",
> which IIUC this mode aims at supporting.
>
> The Emacs package ecosystem is no stranger to obscure names that
> nonetheless seem to enjoy wide popularity; I'm thinking e.g. of Daniel
> Mendler's corfu and vertico.
>
> I think keywords and titles are more suited to solving the problem of
> package discovery and visibility.  Trying to stuff as much "relevant"
> semantics as possible in the name alone feels counter-productive to me:
> finding one or two words that will successfully map to a meaningful
> subset of a package's feature, in every user's brain, sounds like a very
> hard problem.
>
> IMO this "one-or-two words" budget is better spent on some other purpose
> (brevity, catchiness, punniness, theming…).  Again, to me "logos" is
> thematically very appropriate.

Thanks for the feedback!  Forgot about the keywords...  Will add them
now.

* * *

Note that the package was filed as "logos".  It is on the archive
following this commit to elpa.git:

    commit be7c3e14d0fc77ecee0aff02e2bc0a9f26a1796a
    Author: Stefan Monnier <monnier@iro.umontreal.ca>
    Date:   Fri Mar 11 08:42:20 2022 -0500

        * elpa-packages (logos): New package

     elpa-packages | 4 ++++
     1 file changed, 4 insertions(+)

-- 
Protesilaos Stavrou
https://protesilaos.com

Re: [ELPA] Add 'logos' package

[Christopher Dimech]

On Gnu Website there exists a categorisation section that helps
users to identify packages provided.  Having something similar
would help many identify package names they might be unfamiliar
with.

https://www.gnu.org/manual/manual.html#categories

----- Christopher Dimech
Administrator General - Naiad Informatics - Gnu Project

Society has become too quick to pass judgement and declare someone
Persona Non-Grata, the most extreme form of censure a country can
bestow.

In a new era of destructive authoritarianism, I support Richard
Stallman.  Times of great crisis are also times of great
opportunity.  I call upon you to make this struggle yours as well !

https://stallmansupport.org/
https://www.fsf.org/     https://www.gnu.org/


> Sent: Friday, March 11, 2022 at 10:57 PM
> From: "Protesilaos Stavrou" <info@protesilaos.com>
> To: "emacs-devel" <emacs-devel@gnu.org>
> Subject: [ELPA] Add 'logos' package
>
> Good day!
>
> I have a small package which helps set up a simple "focus mode" using
> standard Emacs utilities (pages, narrowing, outline-regexp, ...).  Quote
> from the manual:
>
>     This package provides a simple "focus mode" which can be applied to
>     any buffer for reading, writing, or even doing a presentation.  The
>     buffer can be divided in pages using the 'page-delimiter', outline
>     structure, or any other pattern.  Commands are provided to move
>     between those pages.  These motions work even when narrowing is in
>     effect (and they preserve it).  'logos.el' is designed to be simple
>     by default and easy to extend.  This manual provides concrete
>     examples to that end.
>
>     <https://protesilaos.com/emacs/logos>
>
> Can this be added to GNU ELPA?  Check the attached patch.
>
> All the best,
> Protesilaos (or simply "Prot")
>
> --
> Protesilaos Stavrou
> https://protesilaos.com
>