Emacs's Builtin Elisp Cheat Sheet - Mastering Emacs
source link: https://www.masteringemacs.org/article/emacs-builtin-elisp-cheat-sheet
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
Emacs’s Builtin Elisp Cheat Sheet
Learning Emacs lisp is as much about taming the language as it is the ecosystem of functions and variables that you need to get the job done. The lack of namespaces (notwithstanding shorthands in Emacs 28) and inconsistent naming due to 40+ years of organic growth doesn’t help.
But good news. Emacs 28 adds a cheat sheet / reference card feature called shortdoc. Invoke M-x shortdoc-display-group and pick a category of elisp functions you want a cheat sheet for, and Emacs abides.
What I especially like about it is that it leverages all the things that I love about lisp and Emacs. Although Emacs is eminently self-documenting, it has sorely needed a feature like this.
When you open a shortdoc group you’ll see example code for each listed function, along with the output of said function, and hyperlinks to the Info manual entry (if there is such an entry.) If there’s no manual entry, Emacs will instead describe the function.
To top it off, it’s really easy to extend:
(require 'shortdoc)
(define-short-documentation-group list
"Making Lists"
(make-list
:eval (make-list 5 'a))
(cons
:eval (cons 1 '(2 3 4))))You can add your own collection of reference entries: the existing cheat sheet definitions in M-x find-library shortdoc and C-h f define-short-documentation-group is enough to get you started. It’s straightforward and a perfect way to familiarize yourself with elisp if you’re new to it.
There’s also a couple of key bindings: n and p to move up or down, and C-c C-p and C-c C-n to move between sections. That’s in addition to the RET or left mouse click for the hyperlinked function names.
Recommend
-
146
Table Component for elisp ctable.el is a table component for emacs lisp. Emacs lisp programs can display a nice table view from an abstract data model. The many emacs programs have the code for displaying table views, such as...
-
130
Java 9 Modules Cheat SheetJava Application DevelopmentJava UpdatesIn our Java 9 Modules Cheat Sheet, we go over the most useful declarations, mechanisms, attributes, and flags for the Java Platform Module...
-
98
Java 8 has already been with us for quite some time. Let’s reflect on it and talk about the best practices that have naturally grown in its typical usage. In this post we’ll look at the hot topics of the Java 8 language: default methods, lambdas...
-
40
Readme.org Göktuğ’s Emacs Lisp Bits Introduction This repository is a swarm for all the Elisp stuff I published. Most files will have licen...
-
30
ElispCheatSheet Quick reference to the core language of Emacs —Editor MACroS. ( Much Emacs Lisp was utilised in making my blog https://alhassy.github.io )
-
11
Elisp API Demos Showing an Elisp demo of mapcar in C-h f mapcar: Usage To inject elisp demos into *Help*, such as C-h f (M-x describe-function), use...
-
15
emacs-tree-sitter This is an Emacs Lisp binding for tree-sitter, an incremental parsing library. It requires Emacs 25.1 or above, built with dynamic module support. It...
-
11
Posts About The posts about “emacs/elisp” that I publish on the subreddit r/emacs in an org document. Install The posts are in the file
-
8
The Compat Elisp Library: A Package Maintainer's Best Friend Mar 16, 2023 |
-
6
OpenAI.el Elisp library for the OpenAI API The OpenAI Elisp library provides convenient access to the OpenAI API from applications written in the Elips language. P.S. This package is expected t...
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK