[ELPA] Add Denote package

[ELPA] Add Denote package

[Protesilaos Stavrou]

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

Hello everyone,

I have a new package that I would like to contribute to the FSF via GNU
ELPA.  It is called "denote" and aims to be a simple tool for taking
notes in a flat directory using a strict and efficient file-naming
scheme.  Denote provides the means to create links between notes and can
produce a buffer with backlinks to the current one ("backlinks" are the
links in other notes pointing to the present entry).

Denote creates Org files by default, but there is an option to use plain
text (.txt) or Markdown with either YAML or TOML notation for the file's
front matter (the area at the top with the tile, date, tags).

The webpage of the manual: <https://protesilaos.com/emacs/denote>.  It
is comprehensive and covers everything one needs.

I have received patches from Damien Cassou (FSF-covered), Kaushal Modi
(FSF-covered), and Jack Baty (small; below the threshold).

What do you think?  Can I install the attached patch in elpa.git?  Do
you want me to explain more about this package?  Something else to
consider?

[ I will tag a release once the patch is installed. ]

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-elpa-packages-denote-New-package.patch --]
[-- Type: text/x-patch, Size: 925 bytes --]

From 3e4dfef1afcd84eb440cfcd4ac568e59702ec6b8 Mon Sep 17 00:00:00 2001
Message-Id: <3e4dfef1afcd84eb440cfcd4ac568e59702ec6b8.1655954849.git.info@protesilaos.com>
From: Protesilaos Stavrou <info@protesilaos.com>
Date: Thu, 23 Jun 2022 06:27:04 +0300
Subject: [PATCH] * elpa-packages (denote): New package

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

diff --git a/elpa-packages b/elpa-packages
index 2bfb8f3cae..e072b035c5 100644
--- a/elpa-packages
+++ b/elpa-packages
@@ -183,6 +183,11 @@
  ("debbugs"		:url nil :doc ("debbugs.texi" "debbugs-ug.texi"))
  ("delight"		:url "https://git.savannah.gnu.org/r/delight.git"
   :auto-sync t)
+ ("denote"
+  :url "https://git.sr.ht/~protesilaos/denote"
+  :auto-sync t
+  :doc "README.org"
+  :ignored-files ("COPYING" "doclicense.texi"))
  ("detached"		:url "https://git.sr.ht/~niklaseklund/detached.el"
   :news "CHANGELOG.org"
   :readme "README.md"
-- 
2.36.1

Re: [ELPA] Add Denote package

[Stefan Kangas]

Protesilaos Stavrou <info@protesilaos.com> writes:

> I have a new package that I would like to contribute to the FSF via GNU
> ELPA.

Thanks, I tried it a couple of days ago and find it useful.  (I'm
still considering whether or not to integrate it into my own
workflow.)

> What do you think?  Can I install the attached patch in elpa.git?

LGTM, but put :url on the same line as the package name to follow the
same format as other packages.

> Do you want me to explain more about this package?

Out of curiosity, and if you find it useful, could you perhaps explain
your motivation for writing this?  In particular, what are, in your
view, the key differences to existing packages like org-roam?  Which
types of users are likely to use this rather than e.g. org-roam?  [To
be clear, none of these questions would affect its addition to GNU
ELPA.]

Re: [ELPA] Add Denote package

[Protesilaos Stavrou]

> From: Stefan Kangas <stefan@marxist.se>
> Date: Thu, 23 Jun 2022 11:25:35 +0200
>
>> What do you think?  Can I install the attached patch in elpa.git?
>
> LGTM, but put :url on the same line as the package name to follow the
> same format as other packages.

Thanks!  I have no problem with that.  Though note that my cursory,
fontaine, and tmr packages all have the :url on the subsequent line
(while my others have it on the same line).

>> Do you want me to explain more about this package?
>
> Out of curiosity, and if you find it useful, could you perhaps explain
> your motivation for writing this?  In particular, what are, in your
> view, the key differences to existing packages like org-roam?  Which
> types of users are likely to use this rather than e.g. org-roam?  [To
> be clear, none of these questions would affect its addition to GNU
> ELPA.]

There is a section in the manual which addresses Frequently Asked
Questions while others elaborate on the core principles and related
themes.  But since we are here this is an overview:

* My motivation for every package I write is to (i) solve a problem I
  have and/or implement a workflow I want, (ii) learn Emacs Lisp
  (programming in general) in a fun way through trial and error.

* The existence of PACKAGE is never a good reason for me not to try my
  own.  When the question arises of "why not contribute to PACKAGE
  instead?" the answer is that without me experimenting in the first
  place, I would lack the skills for such a task.  Furthermore,
  contributing to another package does not guarantee I get what I want
  in terms of workflow.

* To me, Denote streamlines tasks I was performing from my pre-Emacs
  days (before the summer of 2019) and later through an Elisp toy
  package I wrote (I can share the link, if you are curious).
  Specifically how files in my long-term storage are named and how notes
  are written as small files in a flat directory.

* I never used org-roam and am thus not fit to answer your question.
  What follows is purely subjective and constitutes no comparison
  between the two packages.  Its requirement for Org was reason enough
  for me not to try it.  I personally do not want to use Org for my
  notes (not unless necessary) on the premise that fewer features help
  me focus on the only task that matters: writing---and I write a lot.
  Added markup, to-do tracking, clocking time, org-babel, tables with
  formulas, multiple headings with property drawers, section
  folding... These are all wonderful features for the right task, such
  as the README.org of Denote, but not when all I want is pure text.
  For me, a restricted environment removes the temptation to add such
  constructs and thus boosts my productivity.  These extras also lock me
  into Emacs, whereas I want my notes to be accessible at all times.

* About which types of users may want to try Denote, it must be those
  who (i) see a value in the file-naming scheme that Denote implements
  as explained at length in the manual, (ii) want the flexibility to
  write notes in other file types beside Org and/or enjoy the
  flexibility the 'denote-type' command offers of picking the file type
  on demand.

-- 
Protesilaos Stavrou
https://protesilaos.com

Re: [ELPA] Add Denote package

[Protesilaos Stavrou]

> From: Protesilaos Stavrou <info@protesilaos.com>
> Date: Thu, 23 Jun 2022 06:52:26 +0300
>
> What do you think?  Can I install the attached patch in elpa.git?  Do
> you want me to explain more about this package?  Something else to
> consider?

There haven't been any objections.  I am thus applying the patch.  Thank
you!

-- 
Protesilaos Stavrou
https://protesilaos.com

Re: [ELPA] Add Denote package

[Stefan Monnier]

> There haven't been any objections.  I am thus applying the patch.  Thank
> you!

Thanks,


        Stefan

Re: [ELPA] Add Denote package

[Stefan Kangas]

Protesilaos Stavrou <info@protesilaos.com> writes:

> There is a section in the manual which addresses Frequently Asked
> Questions while others elaborate on the core principles and related
> themes.  But since we are here this is an overview:

I had already read the manual, kudos for providing one.  This overview
provided some additional insight, which was also helpful.  Thanks.