emacs/protesilaos.denote
1
0
Fork 0
mirror of https://github.com/protesilaos/denote.git synced 2026-09-10 07:16:20 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Mention the SIGNATURE in the docstring of all front matter variables

Browse source 
Thanks to Alan Schmitt for telling me this was missing. It was done in
issue 714: <https://github.com/protesilaos/denote/issues/714>.
This commit is contained in:
Protesilaos 2026-07-07 22:56:49 +03:00
parent 65f1bbf1de
commit 1004f735b7
No known key found for this signature in database
GPG key ID: 99BD6459CD5CA3EA
2 changed files with 19 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.org
View file

@ -3027,8 +3027,9 @@ The variables which hold the front matter format are:
- ~denote-yaml-front-matter~ - ~denote-yaml-front-matter~
These variables have a string value with specifiers that are used by the These variables have a string value with specifiers that are used by the
~format~ function. The formatting operation passes four arguments which ~format~ function. The formatting operation passes five arguments which
include the values of the given entries. If you are an advanced user include the values of the given entries: =TITLE=, =DATE=, =KEYWORDS=,
=IDENTIFIER=, and =SIGNATURE=. If you are an advanced user
who wants to edit this variable to affect how front matter is produced, who wants to edit this variable to affect how front matter is produced,
consider using something like =%2$s= to control where the Nth argument consider using something like =%2$s= to control where the Nth argument
is placed. is placed.
@ -3053,6 +3054,7 @@ for all variables.
#+DATE: %s #+DATE: %s
#+FILETAGS: %s #+FILETAGS: %s
#+IDENTIFIER: %s #+IDENTIFIER: %s
#+SIGNATURE: %s
\n") \n")
;; Change the order (notice the %N$s notation) ;; Change the order (notice the %N$s notation)
@ -3061,6 +3063,7 @@ for all variables.
#+filetags: %3$s #+filetags: %3$s
#+date: %2$s #+date: %2$s
#+identifier: %4$s #+identifier: %4$s
#+signature: %5$s
\n") \n")
;; Remove the date ;; Remove the date
@ -3068,12 +3071,14 @@ for all variables.
"#+title: %1$s "#+title: %1$s
#+filetags: %3$s #+filetags: %3$s
#+identifier: %4$s #+identifier: %4$s
#+signature: %5$s
\n") \n")
;; Remove the date and the identifier ;; Remove the date and the identifier
(setq denote-org-front-matter (setq denote-org-front-matter
"#+title: %1$s "#+title: %1$s
#+filetags: %3$s #+filetags: %3$s
#+signature: %5$s
\n") \n")
#+end_src #+end_src
@ -6171,22 +6176,22 @@ there will be no corresponding prompt.
#+vindex: denote-org-front-matter #+vindex: denote-org-front-matter
+ Variable ~denote-org-front-matter~ :: Specifies the Org front + Variable ~denote-org-front-matter~ :: Specifies the Org front
matter. It is passed to ~format~ with arguments =TITLE=, =DATE=, matter. It is passed to ~format~ with arguments =TITLE=, =DATE=,
=KEYWORDS=, =ID= ([[#h:7f918854-5ed4-4139-821f-8ee9ba06ad15][Change the front matter format]]) =KEYWORDS=, =IDENTIFIER=, =SIGNATURE= ([[#h:7f918854-5ed4-4139-821f-8ee9ba06ad15][Change the front matter format]])
#+vindex: denote-yaml-front-matter #+vindex: denote-yaml-front-matter
+ Variable ~denote-yaml-front-matter~ :: Specifies the YAML (Markdown) + Variable ~denote-yaml-front-matter~ :: Specifies the YAML (Markdown)
front matter. It is passed to ~format~ with arguments =TITLE=, front matter. It is passed to ~format~ with arguments =TITLE=,
=DATE=, =KEYWORDS=, =ID= ([[#h:7f918854-5ed4-4139-821f-8ee9ba06ad15][Change the front matter format]]) =DATE=, =KEYWORDS=, =IDENTIFIER=, =SIGNATURE= ([[#h:7f918854-5ed4-4139-821f-8ee9ba06ad15][Change the front matter format]])
#+vindex: denote-toml-front-matter #+vindex: denote-toml-front-matter
+ Variable ~denote-toml-front-matter~ :: Specifies the TOML (Markdown) + Variable ~denote-toml-front-matter~ :: Specifies the TOML (Markdown)
front matter. It is passed to ~format~ with arguments =TITLE=, front matter. It is passed to ~format~ with arguments =TITLE=,
=DATE=, =KEYWORDS=, =ID= ([[#h:7f918854-5ed4-4139-821f-8ee9ba06ad15][Change the front matter format]]) =DATE=, =KEYWORDS=, =IDENTIFIER=, =SIGNATURE= ([[#h:7f918854-5ed4-4139-821f-8ee9ba06ad15][Change the front matter format]])
#+vindex: denote-text-front-matter #+vindex: denote-text-front-matter
+ Variable ~denote-text-front-matter~ :: Specifies the plain text + Variable ~denote-text-front-matter~ :: Specifies the plain text
front matter. It is passed to ~format~ with arguments =TITLE=, front matter. It is passed to ~format~ with arguments =TITLE=,
=DATE=, =KEYWORDS=, =ID= ([[#h:7f918854-5ed4-4139-821f-8ee9ba06ad15][Change the front matter format]]) =DATE=, =KEYWORDS=, =IDENTIFIER=, =SIGNATURE= ([[#h:7f918854-5ed4-4139-821f-8ee9ba06ad15][Change the front matter format]])
#+findex: denote-date-org-timestamp #+findex: denote-date-org-timestamp
+ Function ~denote-date-org-timestamp~ :: Format =DATE= using the Org + Function ~denote-date-org-timestamp~ :: Format =DATE= using the Org

16
denote.el
View file

@ -2195,8 +2195,8 @@ Denote file-naming scheme."
#+signature: %s #+signature: %s
\n" \n"
"Org front matter. "Org front matter.
It is passed to `format' with arguments TITLE, DATE, KEYWORDS, It is passed to `format' with arguments TITLE, DATE, KEYWORDS, ID,
ID. Advanced users are advised to consult Info node `(denote) SIGNATURE. Advanced users are advised to consult Info node `(denote)
Change the front matter format'.") Change the front matter format'.")
(defvar denote-yaml-front-matter (defvar denote-yaml-front-matter
@ -2208,8 +2208,8 @@ identifier: %s
signature: %s signature: %s
---\n\n" ---\n\n"
"YAML (Markdown) front matter. "YAML (Markdown) front matter.
It is passed to `format' with arguments TITLE, DATE, KEYWORDS, It is passed to `format' with arguments TITLE, DATE, KEYWORDS, ID,
ID. Advanced users are advised to consult Info node `(denote) SIGNATURE. Advanced users are advised to consult Info node `(denote)
Change the front matter format'.") Change the front matter format'.")
(defvar denote-toml-front-matter (defvar denote-toml-front-matter
@ -2221,8 +2221,8 @@ identifier = %s
signature = %s signature = %s
+++\n\n" +++\n\n"
"TOML (Markdown) front matter. "TOML (Markdown) front matter.
It is passed to `format' with arguments TITLE, DATE, KEYWORDS, It is passed to `format' with arguments TITLE, DATE, KEYWORDS, ID,
ID. Advanced users are advised to consult Info node `(denote) SIGNATURE. Advanced users are advised to consult Info node `(denote)
Change the front matter format'.") Change the front matter format'.")
(defvar denote-text-front-matter (defvar denote-text-front-matter
@ -2233,8 +2233,8 @@ identifier: %s
signature: %s signature: %s
---------------------------\n\n" ---------------------------\n\n"
"Plain text front matter. "Plain text front matter.
It is passed to `format' with arguments TITLE, DATE, KEYWORDS, It is passed to `format' with arguments TITLE, DATE, KEYWORDS, ID,
ID. Advanced users are advised to consult Info node `(denote) SIGNATURE. Advanced users are advised to consult Info node `(denote)
Change the front matter format'.") Change the front matter format'.")
(defun denote-format-string-for-md-front-matter (s) (defun denote-format-string-for-md-front-matter (s)