Elisp: How to Write Commands
Here's the basics of how to write a emacs command that user can call.
This is the typical template for user-defined emacs commands.
(defun my-command () "One sentence summary of what this command do. More details here. Be sure to mention the return value if relevant. Lines here should not be longer than 70 chars, and don't indent them." (interactive) (let (var1 var2 …) (setq var1 …) (setq var2 …) ;; do something … ))
In your doc string, if you want clickable URL, or clickable reference to other commands, etc., See: Elisp: Doc String Markup.
Be sure you've already read the following:
Elisp Basic Functions
Apply to dired's Marked Files
To apply a function to marked files in dired, use
dired-get-marked-files, like this:
;; idiom for processing a list of files in dired's marked files ;; suppose myProcessFile is your function that takes a file path ;; and do some processing on the file (defun dired-myProcessFile () "apply myProcessFile function to marked files in dired." (interactive) (require 'dired) (mapc 'myProcessFile (dired-get-marked-files)) )
Elisp: Writing Command
If you have a question, put $5 at patreon and message me.