file metadata

file metadata

[Christopher Howard]

Hi, I have a bunch of files in various project that have non-descriptive names, but I don't want to change the file names, nor the file contents. It would be nice if there was some way I could display my own description of the file next to the the file listing, say in dired. Do we have any kind of extension, ideally with dired integration, that provides some of kind of file metadata system, or interacts with a third party metadata system?

-- 
📛 Christopher Howard
🚀 gemini://gem.librehacker.com
🌐 http://gem.librehacker.com

בראשית ברא אלהים את השמים ואת הארץ

RE: [External] : file metadata

[Drew Adams]

> Hi, I have a bunch of files in various project that have non-descriptive
> names, but I don't want to change the file names, nor the file contents.
> It would be nice if there was some way I could display my own
> description of the file next to the the file listing, say in dired. Do
> we have any kind of extension, ideally with dired integration, that
> provides some of kind of file metadata system, or interacts with a third
> party metadata system?

One approach is to bookmark a file and use a bookmark's annotation to record the metadata.

If you use Bookmark+ then:

You can also use tags, instead of or in addition to an annotation.

You can also use an autofile bookmark, which has the same name as the file.  This is just a wrapper around a file or directory: a way to attach meta information (such as tags or an annotation) to it.  But you can use an autofile bookmark much as you would use a file or directory.

See:

* Annotations: https://www.emacswiki.org/emacs/BookmarkPlus#BookmarkAnnotations

* Tags:
https://www.emacswiki.org/emacs/BookmarkPlus#BookmarkTags

* Autofiles:
https://www.emacswiki.org/emacs/BookmarkPlus#AutofileBookmarks

Re: file metadata

[Dan Hitt]

That's a really good question.

You didn't mention your underlying OS or filesystem, although i guess we'd
want emacs to work with whatever metadata system is present.

Do you already have some extra metadata assigned (say with an attribute
called 'description') through (e.g.) ext4?

dan

On Fri, Oct 11, 2024 at 3:23 PM Christopher Howard <
christopher@librehacker.com> wrote:

> Hi, I have a bunch of files in various project that have non-descriptive
> names, but I don't want to change the file names, nor the file contents. It
> would be nice if there was some way I could display my own description of
> the file next to the the file listing, say in dired. Do we have any kind of
> extension, ideally with dired integration, that provides some of kind of
> file metadata system, or interacts with a third party metadata system?
>
> --
> 📛 Christopher Howard
> 🚀 gemini://gem.librehacker.com
> 🌐 http://gem.librehacker.com
>
> בראשית ברא אלהים את השמים ואת הארץ
>
>

Re: file metadata

[Christopher Howard]

Dan Hitt <dan.hitt@gmail.com> writes:

> You didn't mention your underlying OS or filesystem, although i guess we'd
> want emacs to work with whatever metadata system is present.
>

I am using ext4, and Emacs 30.0.91 (build 12, x86_64-pc-linux-gnu, GTK+ Version 3.24.41, cairo version 1.18.0) of 2024-10-09. I am running Guix System x86_64.

> Do you already have some extra metadata assigned (say with an attribute
> called 'description') through (e.g.) ext4?
>

I do not, but I am opened minded regarding this.

-- 
Christopher Howard

Re: file metadata

[Jean Louis]

* Christopher Howard <christopher@librehacker.com> [2024-10-12 01:24]:
> Hi, I have a bunch of files in various project that have non-descriptive names, but I don't want to change the file names, nor the file contents. It would be nice if there was some way I could display my own description of the file next to the the file listing, say in dired. Do we have any kind of extension, ideally with dired integration, that provides some of kind of file metadata system, or interacts with a third party metadata system?

Oh yes, I do that all the time, that is my main thing. I have too many documents, too many legal entities, employees, reports, and it is not possible to work with the file system only.

System is fully functional, though it requires personal guidance and patience to be installed. Once installed, it works fine, it would fully satisfy your needs.


RCD Notes & Hyperscope for GNU Emacs, The Dynamic Knowledge Repository:
https://gnu.support/gnu-emacs/rcd-notes-for-gnu-emacs/index.html

RCD Notes for GNU Emacs is Dynamic Knowledge Repository designed as envisioned by Doug Engelbart. Backed up by PostgreSQL relational database, RCD Notes provides features such as people management also known as CRM or Customer Relationship Management, ERP or Enterprise Resource Planning, WRS or Website Revision System and Hyperscope Dynamic Knowledge Repository. It uses any kind of Emacs major modes and any kind of lightweight markup languages for editing and writing of any of elementary objects.

Here is small video demonstration:

https://gnu.support/images/2024/10/2024-10-14/2024-10-14-01:48:10.ogv

It has tags, tag types, each tag can have tags, different language,
related person, rank, system is actually extensible on the go, it has
85 different rather fixed properties for each elementary object, plus
unlimited properties, with unlimited property types, types, subtypes,
all extensible and customizable by user. It's fantastic, it is also
good money maker system for me.

-- 
Jean

Take action in Free Software Foundation campaigns:
https://www.fsf.org/campaigns

✡️🛡️ Proudly standing with Israel, a nation rooted in history and culture. Let's condemn hatred and promote understanding.

In support of Richard M. Stallman
https://stallmansupport.org/

Re: file metadata

[James Thomas]

Christopher Howard wrote:

> Hi, I have a bunch of files in various project that have
> non-descriptive names, but I don't want to change the file names, nor
> the file contents. It would be nice if there was some way I could
> display my own description of the file next to the the file listing,
> say in dired. Do we have any kind of extension, ideally with dired
> integration, that provides some of kind of file metadata system, or
> interacts with a third party metadata system?

I had a system where I used:

(let ((backup-directory-alist '(("." . "~/denote"))))
  (make-backup-file-name-1 (expand-file-name
  (file-name-with-extension filename "org"))))

...to automatically check for a corresponding denote file with metadata.

Regards,
James

Re: file metadata

[James Thomas]

James Thomas wrote:

> Christopher Howard wrote:
>
>> Hi, I have a bunch of files in various project that have
>> non-descriptive names, but I don't want to change the file names, nor
>> the file contents. It would be nice if there was some way I could
>> display my own description of the file next to the the file listing,
>> say in dired. Do we have any kind of extension, ideally with dired
>> integration, that provides some of kind of file metadata system, or
>> interacts with a third party metadata system?
>
> I had a system where I used:
>
> (let ((backup-directory-alist '(("." . "~/denote"))))
>   (make-backup-file-name-1 (expand-file-name
>   (file-name-with-extension filename "org"))))
>
> ...to automatically check for a corresponding denote file with metadata.

Wth, I decided to write it again. Sharing if useful for Denote users:

--8<---------------cut here---------------start------------->8---
;; Metadata for files

(defun denote-metadata (file)
  (interactive
   (list (read-file-name "Metadata for file: ")))
  (find-file
   (let* ((backup-directory-alist `(("." . ,(denote-directory))))
	  (name (make-backup-file-name-1
		 (expand-file-name file))))
     (expand-file-name
      (concat
       (denote-get-identifier) "--"
       (file-name-nondirectory name) ".org")
      (file-name-directory name))))))

(defun my/dired-mark-files-with-metadata nil
  (interactive)
  (save-excursion
    (let* ((backup-directory-alist '(("." . "/")))
	   (d (file-relative-name
	       (make-backup-file-name-1
		(expand-file-name default-directory))
	       "/"))
	   temp
	   (hits 0))
      (mapcar
       (lambda (f)
	 (goto-char (point-min))
	 (when
	     (search-forward-regexp
	      (format
	       "\\s %s[*@]?$"
	       (file-name-sans-extension
		(string-remove-prefix
		 d
		 (string-trim-left
		  f (concat denote-id-regexp "--")))))
	      nil t)
	   (setq hits (1+ hits))
	   (dired-mark 1)))
       (directory-files
	(denote-directory) nil
	(concat "\\`" denote-id-regexp "--" d)))
      (message "%d files with metadata marked" hits))))
--8<---------------cut here---------------end--------------->8---

--

Re: file metadata

[James Thomas]

James Thomas wrote:

> James Thomas wrote:
>
>> Christopher Howard wrote:
>>
>>> Hi, I have a bunch of files in various project that have
>>> non-descriptive names, but I don't want to change the file names, nor
>>> the file contents. It would be nice if there was some way I could
>>> display my own description of the file next to the the file listing,
>>> say in dired. Do we have any kind of extension, ideally with dired
>>> integration, that provides some of kind of file metadata system, or
>>> interacts with a third party metadata system?
>>
>> I had a system where I used:
>>
>> (let ((backup-directory-alist '(("." . "~/denote"))))
>>   (make-backup-file-name-1 (expand-file-name
>>   (file-name-with-extension filename "org"))))
>>
>> ...to automatically check for a corresponding denote file with metadata.
>
> Wth, I decided to write it again. Sharing if useful for Denote users:

Updated version that accounts for 'keywords' (_after_ the original file
extension):

--8<---------------cut here---------------start------------->8---
;; Metadata for files

(defun denote-metadata (file)
  (interactive
   (list (read-file-name "Metadata for file: ")))
  (find-file
   (let* ((backup-directory-alist `(("." . ,(denote-directory))))
	  (name (make-backup-file-name-1
		 (expand-file-name file))))
     (expand-file-name
      (concat
       (denote-get-identifier) "--"
       (file-name-nondirectory name) ".org")
      (file-name-directory name))))))

(defun my/dired-mark-files-with-metadata nil
  (interactive)
  (save-excursion
    (let* ((backup-directory-alist '(("." . "/")))
	   (d (file-relative-name
	       (make-backup-file-name-1
		(expand-file-name default-directory))
	       "/"))
	   temp
	   (hits 0))
      (mapcar
       (lambda (f)
	 (goto-char (point-min))
	 (when
	     (search-forward-regexp
	      (format
	       "\\s %s[*@]?$"
	       (string-remove-suffix
		(if (setq temp (denote-retrieve-filename-keywords f))
		  (concat "__" temp) "")
		(file-name-sans-extension
		 (string-remove-prefix
		  d
		  (string-trim-left
		   f (concat denote-id-regexp "--"))))))
	      nil t)
	   (setq hits (1+ hits))
	   (dired-mark 1)))
       (directory-files
	(denote-directory) nil
	(concat "\\`" denote-id-regexp "--" d)))
      (message "%d files with metadata marked" hits))))
--8<---------------cut here---------------end--------------->8---

--

Re: file metadata

[James Thomas]

James Thomas wrote:

> James Thomas wrote:
>
>> James Thomas wrote:
>>
>>> Christopher Howard wrote:
>>>
>>>> Hi, I have a bunch of files in various project that have
>>>> non-descriptive names, but I don't want to change the file names, nor
>>>> the file contents. It would be nice if there was some way I could
>>>> display my own description of the file next to the the file listing,
>>>> say in dired. Do we have any kind of extension, ideally with dired
>>>> integration, that provides some of kind of file metadata system, or
>>>> interacts with a third party metadata system?
>>>
>>> I had a system where I used:
>>>
>>> (let ((backup-directory-alist '(("." . "~/denote"))))
>>>   (make-backup-file-name-1 (expand-file-name
>>>   (file-name-with-extension filename "org"))))
>>>
>>> ...to automatically check for a corresponding denote file with metadata.
>>
>> Wth, I decided to write it again. Sharing if useful for Denote users:
>
> Updated version that accounts for 'keywords' (_after_ the original file
> extension):

Never mind that: breaks the first function.

(I'll see myself out now)

--

Re: [External] : file metadata

[Christopher Howard]

Bookmark+ seems like just what I need. However, it appears to be broken in Emacs 30, and I switched to 30 pre-test a month or so ago. The same errors do not appear when I run it in Emacs 29. This is using the latest commit from https://github.com/emacsmirror/bookmark-plus.

When I first try to load it (through a require) a get this error:

``` bt
Debugger entered--Lisp error: (error "Key sequence r K starts with non-prefix key r")
  define-key((keymap #^[nil nil keymap #^^[3 0 pop-global-mark nil list-buffers t list-directory eval-last-sexp helm-find-files nil nil indent-rigidly dired-jump kmacro-keymap downcase-region (keymap (108 . set-language-environment) (99 . universal-coding-system-argument) (28 . set-input-method) (88 . set-next-selection-coding-system) (120 . set-selection-coding-system) (112 . set-buffer-process-coding-system) (107 . set-keyboard-coding-system) (116 . set-terminal-coding-system) (70 . set-file-name-coding-system) (114 . revert-buffer-with-coding-system) (102 . set-buffer-file-coding-system)) set-goal-column delete-blank-lines mark-page read-only-mode find-file-read-only save-buffer transpose-lines upcase-region find-alternate-file write-file exchange-point-and-mark nil suspend-frame (keymap (67108912 . global-text-scale-adjust) (67108909 . global-text-scale-adjust) (67108925 . global-text-scale-adjust) (67108907 . global-text-scale-adjust) (58 . repeat-complex-command) (27 . repeat-complex-command)) nil nil nil nil rectangle-mark-mode nil nil server-edit set-selective-display nil nil expand-abbrev kmacro-start-macro kmacro-end-macro calc-dispatch balance-windows nil shrink-window-if-larger-than-buffer set-fill-prefix nil delete-window ...] #^^[1 0 #^^[2 0 #^^[3 0 pop-global-mark nil list-buffers t list-directory eval-last-sexp helm-find-files nil nil indent-rigidly dired-jump kmacro-keymap downcase-region (keymap (108 . set-language-environment) (99 . universal-coding-system-argument) (28 . set-input-method) (88 . set-next-selection-coding-system) (120 . set-selection-coding-system) (112 . set-buffer-process-coding-system) (107 . set-keyboard-coding-system) (116 . set-terminal-coding-system) (70 . set-file-name-coding-system) (114 . revert-buffer-with-coding-system) (102 . set-buffer-file-coding-system)) set-goal-column delete-blank-lines mark-page read-only-mode find-file-read-only save-buffer transpose-lines upcase-region find-alternate-file write-file exchange-point-and-mark nil suspend-frame (keymap (67108912 . global-text-scale-adjust) (67108909 . global-text-scale-adjust) (67108925 . global-text-scale-adjust) (67108907 . global-text-scale-adjust) (58 . repeat-complex-command) (27 . repeat-complex-command)) nil nil nil nil rectangle-mark-mode nil nil server-edit set-selective-display nil nil expand-abbrev kmacro-start-macro kmacro-end-macro calc-dispatch balance-windows nil shrink-window-if-larger-than-buffer set-fill-prefix nil delete-window ...] nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil] nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil] nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil nil ...] (67108912 . text-scale-adjust) (67108925 . text-scale-adjust) (67108909 . text-scale-adjust) (67108907 . text-scale-adjust) (67108923 . comment-line) (67108896 . pop-global-mark) (C-left . previous-buffer) (left . previous-buffer) (C-right . next-buffer) (right . next-buffer)) "rK" bmkp-set-desktop-bookmark)
  eval-buffer(#<buffer  *load*-696379> nil "/home/christopher/Repos/emacsmirror/bookmark-plus/bookmark+-key.el" nil t)  ; Reading at buffer position 9485
  load-with-code-conversion("/home/christopher/Repos/emacsmirror/bookmark-plus/bookmark+-key.el" "/home/christopher/Repos/emacsmirror/bookmark-plus/bookmark+-key.el" nil t)
  require(bookmark+-key)
  eval-buffer(#<buffer  *load*-617642> nil "/home/christopher/Repos/emacsmirror/bookmark-plus/bookmark+.el" nil t)  ; Reading at buffer position 10133
  load-with-code-conversion("/home/christopher/Repos/emacsmirror/bookmark-plus/bookmark+.el" "/home/christopher/Repos/emacsmirror/bookmark-plus/bookmark+.el" nil t)
  require(bookmark+)
  eval-buffer(#<buffer  *load*> nil "/home/christopher/.emacs.d/init.el" nil t)  ; Reading at buffer position 50593
  load-with-code-conversion("/home/christopher/.emacs.d/init.el" "/home/christopher/.emacs.d/init.el" t t)
  load("/home/christopher/.emacs.d/init" noerror nomessage)
  #f(compiled-function () #<bytecode 0x86b8921748fbf10>)()
  startup--load-user-init-file(#f(compiled-function () #<bytecode -0x1a06b9bc692f9c80>) #f(compiled-function () #<bytecode 0x731968ef8c7b19b>) t)
  command-line()
  normal-top-level()
```

If I (c)ontinue, and then try C-x j, I get this error:

``` bt
Debugger entered--Lisp error: (wrong-type-argument commandp bmkp-jump-map)
  call-interactively(bmkp-jump-map nil nil)
  command-execute(bmkp-jump-map)
```

-- 
Christopher Howard

RE: [External] : file metadata

[Drew Adams]

> Bookmark+ seems like just what I need. However, it appears to be broken
> in Emacs 30, and I switched to 30 pre-test a month or so ago. The same
> errors do not appear when I run it in Emacs 29. This is using the latest
> commit from
> https://urldefense.com/v3/__https://github.com/emacsmirror/bookmark-
> plus__;!!ACWV5N9M2RV99hQ!M-
> 3CrV160p4kWvbEN27pGBLIT8ojzosDsDStwA5U6qiaqym41IEHS7Z06Uo8fLX_XVIkKBU9Ex
> eu8TW_-ix8bSez8w$ 

That mirror says the Bookmark+ code there is at least
8 months old.  (Dunno who mirrors the code there.)

The latest updates to Bookmark+ are from 2024-09-16 -
a month ago.  Download the files from Emacs Wiki, to
be sure to get the latest versions.

See this note in bookmark+-mac.el, which is a file of
Lisp macros:

;;    ****** NOTE ******
;;
;;      WHENEVER you update Bookmark+ (i.e., download new versions of
;;      Bookmark+ source files), I recommend that you do the
;;      following:
;;
;;      1. Delete ALL existing BYTE-COMPILED Bookmark+ files
;;         (bookmark+*.elc).
;;      2. Load Bookmark+ (`load-library' or `require').
;;      3. Byte-compile the source files.
;;
;;      In particular, ALWAYS LOAD `bookmark+-mac.el' (not
;;      `bookmark+-mac.elc') BEFORE YOU BYTE-COMPILE new versions of
;;      the files, in case there have been any changes to Lisp macros
;;      (in `bookmark+-mac.el').
;;
;;      (This is standard procedure for Lisp: code that depends on
;;      macros needs to be byte-compiled anew after loading the
;;      updated macros.)
;;
;;    ******************

However, I can't speak to compatibility with Emacs 30
dev versions - I don't have an Emacs 30 version, and I
have no idea what they might have changed that causes
backward incompatibility.  (Keep in mind that 30 isn't
released yet - you're living on the bleeding edge.)

Maybe someone here who's familiar with Emacs 30 can
advise us about the errors you see.

But first try with the latest Bookmark+ files (from
Emacs Wiki), paying attention to the above Note, and
starting with `emacs -Q' (no init file), to avoid
interactions with other things you might have in your
init file.  It's best to try with only the source
files (*.el) first - no byte-compiled files (*.elc),
for debugging purposes.

The error occurs when loading file bookmark+-key.el.
Presumably, one of the `define-key's in that file is
what Emacs 30 chokes on.

You might try manually loading the files in turn, in
the order you see in bookmark+.el.  But load a _copy_
of bookmark+-key.el, which you can bisect, to narrow
the debugging search.  You can add the sexp `(debug)',
moving it to, in effect bisect and enter the debugger
wherever you like.  In the debugger, use `d' to step
or `c' to take big steps.

Sorry for the trouble.  Let me know, if you learn
something I should know about, to prepare for Emacs
30 compatibility.

Getting the files from Emacs Wiki, etc.:

https://www.emacswiki.org/emacs/BookmarkPlus#Libraries

Thx - Drew

> When I first try to load it (through a require) a get this error:
> 
> ``` bt
> Debugger entered--Lisp error: (error "Key sequence r K starts with non-
> prefix key r")
...
>   require(bookmark+-key)
...
>   require(bookmark+)
...
>   load("/home/christopher/.emacs.d/init" noerror nomessage)
...
>   command-line()
>   normal-top-level()
>
> If I (c)ontinue, and then try C-x j, I get this error:
> 
> bt
> Debugger entered--Lisp error: (wrong-type-argument commandp bmkp-jump-
> map)
>   call-interactively(bmkp-jump-map nil nil)
>   command-execute(bmkp-jump-map)
> 
> Christopher Howard

Re: [External] : file metadata

[Christopher Howard]

May I ask, hopefully with sounding antagonistic, why you prefer to maintain your library on EmacsWiki rather than a git repository some where?

In the Guix distribution packaging is it is very easy to pull a library from a git repository, as well as automatically check for updates, whereas there is not tooling to scan a wiki page and try to figure what are the correct files and whether the library has changed recently. I'm sure this is why the Guix emacs-bookmark-plus package depends on the out-of-date GitHub mirror. I think the wiki itself is a git repository, but even if one wanted to download the whole wiki, the library files are not sequestered into some distinct directory where they are easy for the tooling to deal with.

You could of course say that people are free to mirror the files themselves if they want to, but that brings us back to where we are now — a mirror that has not been kept up-to-date.

-- 
Christopher Howard

RE: [External] : file metadata

[Drew Adams]

> why you prefer to maintain your library on EmacsWiki
> rather than a git repository some where?

Old-school, lazy; easier for me.  (But I don't maintain
it there; I publish it there.)

> people are free to mirror the files themselves if they
> want to, but that brings us back to where we are now
> — a mirror that has not been kept up-to-date.

"Up-to-date" has different meanings.  The Emacs-Wiki
mirror is updated periodically (not by me).  It has no
need to check what might have changed in any given file.
"Periodically", regardless of the chosen period, is
different from whenever this or that file might get
updated on the wiki.

If you want the latest of my files, download them
from the wiki.  No one _needs_ to get the latest
versions.  But if someone wants help debugging
something I suggest to start with the latest.

HTH.