protesilaos / denote

Simple notes for Emacs with an efficient file-naming scheme
https://protesilaos.com/emacs/denote
GNU General Public License v3.0
453 stars 49 forks source link

Suggestion where to place `SIGNATURE` in the front matter #366

Open maikol-solis opened 1 month ago

maikol-solis commented 1 month ago

Hi Prot!

I'm an org-roam user which is trying denote, and so far, I like a lot.

My suggestion is to put the SIGNATURE in the subtitle of the front matter. I use it this way in org-roam and worked for me perfectly.

For example.

Markdown

---
title:      "My title"
subtitle:   "7a1"
date:       2024-05-14
tags:       []
identifier: "20240514T135224"
---

org-mode

#+title:      My title
#+subtitle:   7a1
#+date:       [2024-05-14 Tue 13:52]
#+filetags:   
#+identifier: 20240514T135224

WDYT?

Best.

protesilaos commented 1 month ago

From: Maikol Solís @.***> Date: Mon, 20 May 2024 04:44:23 -0700

Hi Prot!

Hello Maikol!

I'm an org-roam user which is trying denote, and so far, I like a lot.

Good to know!

My suggestion is to put the SIGNATURE in the subtitle of the front matter. I use it this way in org-mode and worked for me perfectly.

For example.

Markdown

---
title:      "My title"
subtitle:   "7a1"
date:       2024-05-14
tags:       []
identifier: "20240514T135224"
---

org-mode

#+title:      My title
#+subtitle:   7a1
#+date:       [2024-05-14 Tue 13:52]
#+filetags:   
#+identifier: 20240514T135224

WDYT?

For the time being, we do not add the signature to the front matter. The reason is technical. We do not yet have the infrastructure to format front matter conditionally. So we would be inserting a signature with an empty value with the out-of-the-box 'M-x denote', which does not look right.

I think we need to refactor how the front matter is done, though I would leave that for a version after '3.0.0', as we have a lot of new features already that we still need to iron out.

About your example, I think the "subtitle" does not sound right for the kind of value you are showing there. If this were a publication, you would want something more descriptive for the reader. The sequence you have there is your own implementation/methodological detail.

We could call our entry "#+signature:", though other words like "qualifier" may be helpful. Basically, we want a word that will most likely not interfere with something the user may need for other types of data.

-- Protesilaos Stavrou https://protesilaos.com

maikol-solis commented 1 month ago

Thanks Prot. Fair enough. Yes, I agree that version 3.0 has a lot of exciting features to add a new one.

With respect to the subtitle, I normally use my notes as intermediate products before start drafting a real work. But I could understand that other could have other workflows.

Maybe I could tweak the capture functions to add the subtitles in my case.

Thanks.

Best.

MirkoHernandez commented 3 weeks ago

@maikol-solis Could you elaborate why there is a need to have the signature in the front-matter? I'm currently using denote-renamer-buffer-mode to display the signature along the title (If you just need a visual cue, this might be the solution).

Also, I've been using the package citar-denote which seamlessly is to be able to add entries to the front-matter. Maybe you could check that package's source.

maikol-solis commented 3 days ago

My main goal is to put the fogelzettel in the front matter. This helps me to identify where I am in my own zettelkasten. The citar-denote it's a good resource. I'll check it out.

MirkoHernandez commented 3 days ago

@maikol-solis denote-rename-buffer-mode can be used for that particular use case, it can display the signature in the modeline. Unless your are using unusually long signatures I think that it should work. Here is how to change the format to display the signature.

`(setq denote-rename-buffer-format  "%s %t")`

Edit: I forgot to mention that I created a minor mode for this particular use case denote-folgezettel.

protesilaos commented 3 days ago

From: Maikol Solís @.***> Date: Tue, 25 Jun 2024 12:52:45 -0700

My main goal is to put the fogelzettel in the front matter.

I think it will be a nice addition to have the SIGNATURE in the front matter. The tricky part is to make this backward compatible with the existing front matter. We also want to insert a signature only if there is one, rather than have the field there unconditionally and leave it without a value.

-- Protesilaos Stavrou https://protesilaos.com