Skip to content

Commit

Permalink
README: Mention user-emacs-directory (Fix #155)
Browse files Browse the repository at this point in the history
  • Loading branch information
minad committed Nov 1, 2024
1 parent 34191e9 commit 1ab4233
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -109,13 +109,14 @@ contributions.

The templates are defined in a Lisp data file configured by ~tempel-path~. Lisp
data files are files containing Lisp s-expressions (see ~lisp-data-mode~). By
default the file =~/.config/emacs/templates= is used. The templates are grouped by
major mode with an optional ~:when~ condition. Each template is a list in the
concise form of the Emacs Tempo syntax. The first element of each list is the
name of the template. I recommend to use avoid special letters for the template
names, since special letters may carry meaning during completion filtering and
as such make it harder to select the desired template. Thus the name =lett= is
better than =let*=. Behind the name, the Tempo syntax elements follow.
default the file =templates= in the ~user-emacs-directory~ is used, e.g.,
=~/.config/emacs/templates=. The templates are grouped by major mode with
an optional ~:when~ condition. Each template is a list in the concise form of the
Emacs Tempo syntax. The first element of each list is the name of the template.
I recommend to use avoid special letters for the template names, since special
letters may carry meaning during completion filtering and as such make it harder
to select the desired template. Thus the name =lett= is better than =let*=. Behind
the name, the Tempo syntax elements follow.

In addition, each template may specify a =:pre= and/or =:post= key with a FORM that
is evaluated before the template is expanded or after it is finalized,
Expand Down

1 comment on commit 1ab4233

@whargrove
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Please sign in to comment.