Customization for character replacement generated slug

[aruscher]

This change allows to modify the replacement rules for the slug names.

Addresses feature request #1543

[rudolf-adamkovic]

This is great. So much passive voice, though: are applied, are replaced (2×), are removed (2×). Why not go with apply, replace, and remove?

[aruscher]

I used passive voice because something is done with something. I will check the other docs and revise this text if necessary.

[rudolf-adamkovic]

Addresses feature request #1543

This resolves the problem, so we can go with "Close #1543".

[jethrokuan]

In v2, these won't be customizable options. The way to change how the slug is computed is to override the function entirely:

(cl-defmethod org-roam-node-slug ((node org-roam-node))
  "Return the slug of NODE."
  ;; My logic goes here
)

I'm trying to prevent the proliferation of customize options, slug computation can be as complex or as simple as you want it to be.

[aruscher]

@jethrokuan Where do you draw the line between customize options and method overriding? Is it intended that the user should by default override methods to implement the desired behavior and, thus, that every method should work without customize options?

[jethrokuan]

The default is customize options, if the options can be easily enumerated.

Slug computation is an open-ended configuration option: e.g. one may choose to include the file creation time, or tags in the slug in which case providing customize options would be far too messy.

In this case overriding the method goes in line with adding properties to nodes: you can define arbitrary properties on a node and use them in org-roam templates e.g.:

(cl-defmethod org-roam-namespace ((node org-roam-node))
  "Return the namespace of NODE."
  ;; Do something with folder structure maybe
)

and then in your templates use ${namespace}

[rudolf-adamkovic]

The user here. :) So, what shall I do?

[aruscher]

The user here. :) So, what shall I do?

In a nutshell: You are supposed to redefine the original function as part of your configuration instead of relying on a customization option. So you more or less should copy this code to your init.el to get your desired - instead of _. Please make sure that this code is evaluated after org-roam was loaded :

(cl-defmethod org-roam-node-slug ((node org-roam-node))
  (let ((title (org-roam-node-title node)))
    (cl-flet* ((nonspacing-mark-p (char)
				  (memq char org-roam-slug-trim-chars))
	       (strip-nonspacing-marks (s)
				       (ucs-normalize-NFC-string
					(apply #'string (seq-remove #'nonspacing-mark-p
								    (ucs-normalize-NFD-string s)))))
	       (cl-replace (title pair)
			   (replace-regexp-in-string (car pair) (cdr pair) title)))
      (let* ((pairs `(("[^[:alnum:][:digit:]]" . "-")  
		      ("--*" . "-")  
		      ("^-" . "")  
		      ("-$" . "")))
	     (slug (-reduce-from #'cl-replace (strip-nonspacing-marks title) pairs)))
	(downcase slug)))))

[rudolf-adamkovic]

@aruscher Thank you! I customize a large number of functions and variables in my Emacs initialization file, but I have yet to use (or see) cl-defmethod, cl-flet*, and the like. Hence, I got confused.

[jimmerricks]

A small change needs to be made to the code snippet for it to work with Emacs 29. See here: d184001.