annotate man/autotype.texi @ 40819:668787248f9b

* dired.el (dired-move-to-filename-regexp): Do not distinguish between ASCII letters and non-ASCII characters. Don't allow comma except in the form "month day, year". Don't allow space between month name and comma. Clean up the code that checks for trailing period, comma, and space. Remove now-obsolete comments, and add more commentary about Japanese dates. Always gobble up trailing spaces, instead of doing it only sometimes.
author Paul Eggert <eggert@twinsun.com>
date Wed, 07 Nov 2001 21:59:39 +0000
parents 5a3dae2132b4
children 87962bf716e3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
1 \input texinfo
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
2 @c This is an annex of the Emacs manual.
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
3 @c Copyright (C) 1994, 1995 Free Software Foundation, Inc.
Dave Love <fx@gnu.org>
parents:
diff changeset
4 @c Author: Daniel.Pfeiffer@Informatik.START.dbp.de, fax (+49 69) 7588-2389
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
5 @setfilename ../info/autotype
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
6 @c @node Autotypist, Picture, Abbrevs, Top
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
7 @c @chapter Features for Automatic Typing
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
8 @settitle Features for Automatic Typing
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
9 @c @cindex text
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
10 @c @cindex selfinserting text
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
11 @c @cindex autotypist
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
12
30009
95bdbefcdac6 Use dircategory `Emacs'.
Gerd Moellmann <gerd@gnu.org>
parents: 29713
diff changeset
13 @dircategory Emacs
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
14 @direntry
Dave Love <fx@gnu.org>
parents:
diff changeset
15 * Autotype: (autotype). Convenient features for text that you enter frequently
Dave Love <fx@gnu.org>
parents:
diff changeset
16 in Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
17 @end direntry
Dave Love <fx@gnu.org>
parents:
diff changeset
18
32315
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
19 @ifnottex
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
20 Copyright @copyright{} 1994, 1995, 1999 Free Software Foundation, Inc.
32315
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
21
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
22 Permission is granted to copy, distribute and/or modify this document
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
23 under the terms of the GNU Free Documentation License, Version 1.1 or
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
24 any later version published by the Free Software Foundation; with the
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
25 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
26 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
27 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
28 license is included in the section entitled ``GNU Free Documentation
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
29 License'' in the Emacs manual.
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
30
32315
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
31 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
32 this GNU Manual, like GNU software. Copies published by the Free
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
33 Software Foundation raise funds for GNU development.''
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
34
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
35 This document is part of a collection distributed under the GNU Free
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
36 Documentation License. If you want to distribute this document
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
37 separately from the collection, you can do so by adding a copy of the
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
38 license to the document, as described in section 6 of the license.
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
39 @end ifnottex
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
40
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
41 @titlepage
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
42 @sp 10
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
43
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
44 @center @titlefont{Autotyping}
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
45 @sp 2
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
46 @center @subtitlefont{Convenient features for text that you enter
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
47 frequently in Emacs}
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
48 @sp 2
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
49 @center Daniel Pfeiffer
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
50 @center additions by Dave Love
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
51
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
52 @page
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
53 @vskip 0pt plus 1filll
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
54 Copyright @copyright{} 1994, 1995, 1999 Free Software Foundation, Inc.
32315
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
55 @sp 1
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
56 Permission is granted to copy, distribute and/or modify this document
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
57 under the terms of the GNU Free Documentation License, Version 1.1 or
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
58 any later version published by the Free Software Foundation; with the
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
59 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
60 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
61 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
62 license is included in the section entitled ``GNU Free Documentation
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
63 License'' in the Emacs manual.
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
64
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
65 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
66 this GNU Manual, like GNU software. Copies published by the Free
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
67 Software Foundation raise funds for GNU development.''
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
68
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
69 This document is part of a collection distributed under the GNU Free
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
70 Documentation License. If you want to distribute this document
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
71 separately from the collection, you can do so by adding a copy of the
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 30870
diff changeset
72 license to the document, as described in section 6 of the license.
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
73 @end titlepage
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
74
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
75 @node Top
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
76 @top Autotyping
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
77
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
78 Under certain circumstances you will find yourself typing similar things
Dave Love <fx@gnu.org>
parents:
diff changeset
79 over and over again. This is especially true of form letters and programming
Dave Love <fx@gnu.org>
parents:
diff changeset
80 language constructs. Project-specific header comments, flow-control
Dave Love <fx@gnu.org>
parents:
diff changeset
81 constructs or magic numbers are essentially the same every time. Emacs has
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
82 various features for doing tedious and repetitive typing chores for you
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
83 in addition to the Abbrev features (@pxref{(emacs)Abbrevs}).
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
84
Dave Love <fx@gnu.org>
parents:
diff changeset
85 One solution is using skeletons, flexible rules that say what to
Dave Love <fx@gnu.org>
parents:
diff changeset
86 insert, and how to do it. Various programming language modes offer some
Dave Love <fx@gnu.org>
parents:
diff changeset
87 ready-to-use skeletons, and you can adapt them to suit your needs or
Dave Love <fx@gnu.org>
parents:
diff changeset
88 taste, or define new ones.
Dave Love <fx@gnu.org>
parents:
diff changeset
89
Dave Love <fx@gnu.org>
parents:
diff changeset
90 Another feature is automatic insertion of what you want into empty files,
Dave Love <fx@gnu.org>
parents:
diff changeset
91 depending on the file-name or the mode as appropriate. You can have a file or
Dave Love <fx@gnu.org>
parents:
diff changeset
92 a skeleton inserted, or you can call a function. Then there is the
Dave Love <fx@gnu.org>
parents:
diff changeset
93 possibility to have Un*x interpreter scripts automatically take on a magic
Dave Love <fx@gnu.org>
parents:
diff changeset
94 number and be executable as soon as they are saved. Or you can have a
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
95 copyright notice's year updated, if necessary, every time you save a
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
96 file. Similarly for time stamps in the file.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
97
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
98 URLs can be inserted based on a word at point. Flexible templates can
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
99 be defined for inserting and navigating between text more generally. A
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
100 sort of meta-expansion facility can be used to try a set of alternative
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
101 completions and expansions of text at point.
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
102
Dave Love <fx@gnu.org>
parents:
diff changeset
103 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
104 * Using Skeletons:: How to insert a skeleton into your text.
Dave Love <fx@gnu.org>
parents:
diff changeset
105 * Wrapping Skeletons:: Putting existing text within a skeleton.
Dave Love <fx@gnu.org>
parents:
diff changeset
106 * Skeletons as Abbrevs:: An alternative for issuing skeleton commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
107 * Skeleton Language:: Making skeleton commands insert what you want.
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
108 * Inserting Pairs:: Typing one character and getting another
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
109 after point.
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
110 * Autoinserting:: Filling up empty files as soon as you visit them.
Dave Love <fx@gnu.org>
parents:
diff changeset
111 * Copyrights:: Inserting and updating copyrights.
Dave Love <fx@gnu.org>
parents:
diff changeset
112 * Executables:: Turning interpreter scripts into executables.
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
113 * Timestamps:: Updating dates and times in modified files.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
114 * QuickURL:: Inserting URLs based on text at point.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
115 * Tempo:: Flexible template insertion.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
116 * Hippie Expand:: Expansion of text trying various methods.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
117
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
118 * Concept Index::
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
119 * Command Index::
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
120 * Variable Index::
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
121 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
122
Dave Love <fx@gnu.org>
parents:
diff changeset
123
Dave Love <fx@gnu.org>
parents:
diff changeset
124
Dave Love <fx@gnu.org>
parents:
diff changeset
125 @node Using Skeletons
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
126 @chapter Using Skeletons
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
127 @cindex skeletons
Dave Love <fx@gnu.org>
parents:
diff changeset
128 @cindex using skeletons
Dave Love <fx@gnu.org>
parents:
diff changeset
129
Dave Love <fx@gnu.org>
parents:
diff changeset
130 When you want Emacs to insert a form letter or a typical construct of the
Dave Love <fx@gnu.org>
parents:
diff changeset
131 programming language you are using, skeletons are a means of accomplishing
Dave Love <fx@gnu.org>
parents:
diff changeset
132 this. Normally skeletons each have a command of their own, that, when called,
Dave Love <fx@gnu.org>
parents:
diff changeset
133 will insert the skeleton. These commands can be issued in the usual ways
26463
2bf82b32f9f8 Fix makeinfo errors.
Dave Love <fx@gnu.org>
parents: 26151
diff changeset
134 (@pxref{(emacs)Commands}). Modes that offer various skeletons will often
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
135 bind these to key-sequences on the @kbd{C-c} prefix, as well as having
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
136 an @cite{Insert} menu and maybe even predefined abbrevs for them
26463
2bf82b32f9f8 Fix makeinfo errors.
Dave Love <fx@gnu.org>
parents: 26151
diff changeset
137 (@pxref{Skeletons as Abbrevs}).
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
138
Dave Love <fx@gnu.org>
parents:
diff changeset
139 The simplest kind of skeleton will simply insert some text indented
Dave Love <fx@gnu.org>
parents:
diff changeset
140 according to the major mode and leave the cursor at a likely place in the
Dave Love <fx@gnu.org>
parents:
diff changeset
141 middle. Interactive skeletons may prompt you for a string that will be part
Dave Love <fx@gnu.org>
parents:
diff changeset
142 of the inserted text.
Dave Love <fx@gnu.org>
parents:
diff changeset
143
Dave Love <fx@gnu.org>
parents:
diff changeset
144 Skeletons may ask for input several times. They even have a looping
Dave Love <fx@gnu.org>
parents:
diff changeset
145 mechanism in which you will be asked for input as long as you are willing to
Dave Love <fx@gnu.org>
parents:
diff changeset
146 furnish it. An example would be multiple ``else if'' conditions. You can
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
147 recognize this situation by a prompt ending in @key{RET}, @kbd{C-g}
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
148 or @kbd{C-h}. This
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
149 means that entering an empty string will simply assume that you are finished.
Dave Love <fx@gnu.org>
parents:
diff changeset
150 Typing quit on the other hand terminates the loop but also the rest of the
Dave Love <fx@gnu.org>
parents:
diff changeset
151 skeleton, e.g. an ``else'' clause is skipped. Only a syntactically necessary
Dave Love <fx@gnu.org>
parents:
diff changeset
152 termination still gets inserted.
Dave Love <fx@gnu.org>
parents:
diff changeset
153
Dave Love <fx@gnu.org>
parents:
diff changeset
154
Dave Love <fx@gnu.org>
parents:
diff changeset
155
Dave Love <fx@gnu.org>
parents:
diff changeset
156 @node Wrapping Skeletons
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
157 @chapter Wrapping Skeletons Around Existing Text
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
158 @cindex wrapping skeletons
Dave Love <fx@gnu.org>
parents:
diff changeset
159
Dave Love <fx@gnu.org>
parents:
diff changeset
160 Often you will find yourself with some code that for whatever reason
Dave Love <fx@gnu.org>
parents:
diff changeset
161 suddenly becomes conditional. Or you have written a bit of text and want to
Dave Love <fx@gnu.org>
parents:
diff changeset
162 put it in the middle of a form letter. Skeletons provide a means for
Dave Love <fx@gnu.org>
parents:
diff changeset
163 accomplishing this, and can even, in the case of programming languages,
Dave Love <fx@gnu.org>
parents:
diff changeset
164 reindent the wrapped code for you.
Dave Love <fx@gnu.org>
parents:
diff changeset
165
Dave Love <fx@gnu.org>
parents:
diff changeset
166 Skeleton commands take an optional numeric prefix argument
26463
2bf82b32f9f8 Fix makeinfo errors.
Dave Love <fx@gnu.org>
parents: 26151
diff changeset
167 (@pxref{(emacs)Arguments}). This is interpreted in two different ways depending
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
168 on whether the prefix is positive, i.e. forwards oriented or negative,
Dave Love <fx@gnu.org>
parents:
diff changeset
169 i.e. backwards oriented.
Dave Love <fx@gnu.org>
parents:
diff changeset
170
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
171 A positive prefix means to wrap the skeleton around that many
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
172 following words. This is accomplished by putting the words there where
26463
2bf82b32f9f8 Fix makeinfo errors.
Dave Love <fx@gnu.org>
parents: 26151
diff changeset
173 the point is normally left after that skeleton is inserted (@pxref{Using
2bf82b32f9f8 Fix makeinfo errors.
Dave Love <fx@gnu.org>
parents: 26151
diff changeset
174 Skeletons}). The point (@pxref{(emacs)Point}) is left at the next
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
175 interesting spot in the skeleton instead.
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
176
Dave Love <fx@gnu.org>
parents:
diff changeset
177 A negative prefix means to do something similar with that many precedingly
26463
2bf82b32f9f8 Fix makeinfo errors.
Dave Love <fx@gnu.org>
parents: 26151
diff changeset
178 marked interregions (@pxref{(emacs)Mark}). In the simplest case, if you type
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
179 @kbd{M--} just before issuing the skeleton command, that will wrap the
Dave Love <fx@gnu.org>
parents:
diff changeset
180 skeleton around the current region, just like a positive argument would have
Dave Love <fx@gnu.org>
parents:
diff changeset
181 wrapped it around a number of words.
Dave Love <fx@gnu.org>
parents:
diff changeset
182
Dave Love <fx@gnu.org>
parents:
diff changeset
183 Smaller negative arguments will wrap that many interregions into successive
Dave Love <fx@gnu.org>
parents:
diff changeset
184 interesting spots within the skeleton, again leaving the point at the next one.
Dave Love <fx@gnu.org>
parents:
diff changeset
185 We speak about interregions rather than regions here, because we treat them in
Dave Love <fx@gnu.org>
parents:
diff changeset
186 the order they appear in the buffer, which coincides with successive regions
Dave Love <fx@gnu.org>
parents:
diff changeset
187 only if they were marked in order.
Dave Love <fx@gnu.org>
parents:
diff changeset
188
Dave Love <fx@gnu.org>
parents:
diff changeset
189 That is, if you marked in alphabetical order the points A B C [] (where []
Dave Love <fx@gnu.org>
parents:
diff changeset
190 represents the point) and call a skeleton command with @kbd{M-- 3}, you will
Dave Love <fx@gnu.org>
parents:
diff changeset
191 wrap the text from A to B into the first interesting spot of the skeleton, the
Dave Love <fx@gnu.org>
parents:
diff changeset
192 text from B to C into the next one, the text from C to the point into the
Dave Love <fx@gnu.org>
parents:
diff changeset
193 third one, and leave the point in the fourth one. If there are less marks in
Dave Love <fx@gnu.org>
parents:
diff changeset
194 the buffer, or if the skeleton defines less interesting points, the surplus is
Dave Love <fx@gnu.org>
parents:
diff changeset
195 ignored.
Dave Love <fx@gnu.org>
parents:
diff changeset
196
Dave Love <fx@gnu.org>
parents:
diff changeset
197 If, on the other hand, you marked in alphabetical order the points [] A C B,
Dave Love <fx@gnu.org>
parents:
diff changeset
198 and call a skeleton command with @kbd{M-- 3}, you will wrap the text from
Dave Love <fx@gnu.org>
parents:
diff changeset
199 point to A, then the text from A to C and finally the text from C to B. This
Dave Love <fx@gnu.org>
parents:
diff changeset
200 is done because the regions overlap and Emacs would be helplessly lost if it
Dave Love <fx@gnu.org>
parents:
diff changeset
201 tried to follow the order in which you marked these points.
Dave Love <fx@gnu.org>
parents:
diff changeset
202
Dave Love <fx@gnu.org>
parents:
diff changeset
203
Dave Love <fx@gnu.org>
parents:
diff changeset
204
Dave Love <fx@gnu.org>
parents:
diff changeset
205 @node Skeletons as Abbrevs
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
206 @chapter Skeletons as Abbrev Expansions
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
207 @cindex skeletons as abbrevs
Dave Love <fx@gnu.org>
parents:
diff changeset
208
39268
5a3dae2132b4 Spelling correction.
Richard M. Stallman <rms@gnu.org>
parents: 38017
diff changeset
209 Rather than use a key binding for every skeleton command, you can also
26463
2bf82b32f9f8 Fix makeinfo errors.
Dave Love <fx@gnu.org>
parents: 26151
diff changeset
210 define an abbreviation (@pxref{(emacs)Defining Abbrevs}) that will expand
2bf82b32f9f8 Fix makeinfo errors.
Dave Love <fx@gnu.org>
parents: 26151
diff changeset
211 (@pxref{(emacs)Expanding Abbrevs}) into the skeleton.
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
212
Dave Love <fx@gnu.org>
parents:
diff changeset
213 Say you want @samp{ifst} to be an abbreviation for the C language if
Dave Love <fx@gnu.org>
parents:
diff changeset
214 statement. You will tell Emacs that @samp{ifst} expands to the empty string
Dave Love <fx@gnu.org>
parents:
diff changeset
215 and then calls the skeleton command. In Emacs-lisp you can say something like
Dave Love <fx@gnu.org>
parents:
diff changeset
216 @code{(define-abbrev c-mode-abbrev-table "ifst" "" 'c-if)}. Or you can edit
Dave Love <fx@gnu.org>
parents:
diff changeset
217 the output from @kbd{M-x list-abbrevs} to make it look like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
218
Dave Love <fx@gnu.org>
parents:
diff changeset
219 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
220 (c-mode-abbrev-table)
Dave Love <fx@gnu.org>
parents:
diff changeset
221 "if" 0 "" c-if
Dave Love <fx@gnu.org>
parents:
diff changeset
222 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
223
Dave Love <fx@gnu.org>
parents:
diff changeset
224 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
225 (Some blank lines of no semantic significance, and other abbrev tables,
Dave Love <fx@gnu.org>
parents:
diff changeset
226 have been omitted.)
Dave Love <fx@gnu.org>
parents:
diff changeset
227
Dave Love <fx@gnu.org>
parents:
diff changeset
228
Dave Love <fx@gnu.org>
parents:
diff changeset
229
Dave Love <fx@gnu.org>
parents:
diff changeset
230 @node Skeleton Language
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
231 @chapter Skeleton Language
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
232 @cindex skeleton language
Dave Love <fx@gnu.org>
parents:
diff changeset
233
Dave Love <fx@gnu.org>
parents:
diff changeset
234 @findex skeleton-insert
Dave Love <fx@gnu.org>
parents:
diff changeset
235 Skeletons are an shorthand extension to the Lisp language, where various
Dave Love <fx@gnu.org>
parents:
diff changeset
236 atoms directly perform either actions on the current buffer or rudimentary
Dave Love <fx@gnu.org>
parents:
diff changeset
237 flow control mechanisms. Skeletons are interpreted by the function
Dave Love <fx@gnu.org>
parents:
diff changeset
238 @code{skeleton-insert}.
Dave Love <fx@gnu.org>
parents:
diff changeset
239
Dave Love <fx@gnu.org>
parents:
diff changeset
240 A skeleton is a list starting with an interactor, which is usually a
Dave Love <fx@gnu.org>
parents:
diff changeset
241 prompt-string, or @code{nil} when not needed, but can also be a Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
242 expression for complex read functions or for returning some calculated value.
Dave Love <fx@gnu.org>
parents:
diff changeset
243 The rest of the list are any number of elements as described in the following
Dave Love <fx@gnu.org>
parents:
diff changeset
244 table:
Dave Love <fx@gnu.org>
parents:
diff changeset
245
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
246 @table @asis
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
247 @item @code{"@var{string}"}, @code{?@var{c}}, @code{?\@var{c}}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
248 @vindex skeleton-transformation
Dave Love <fx@gnu.org>
parents:
diff changeset
249 Insert string or character. Literal strings and characters are passed through
Dave Love <fx@gnu.org>
parents:
diff changeset
250 @code{skeleton-transformation} when that is non-@code{nil}.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
251 @item @code{?\n}
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
252 @c ??? something seems very wrong here.
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
253 Insert a newline and align under current line. Use newline character
Dave Love <fx@gnu.org>
parents:
diff changeset
254 @code{?\n} to prevent alignment.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
255 @item @code{_}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
256 Interesting point. When wrapping skeletons around successive regions, they are
Dave Love <fx@gnu.org>
parents:
diff changeset
257 put at these places. Point is left at first @code{_} where nothing is wrapped.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
258 @item @code{>}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
259 Indent line according to major mode. When following element is @code{_}, and
Dave Love <fx@gnu.org>
parents:
diff changeset
260 there is a interregion that will be wrapped here, indent that interregion.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
261 @item @code{&}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
262 Logical and. Iff preceding element moved point, i.e. usually inserted
Dave Love <fx@gnu.org>
parents:
diff changeset
263 something, do following element.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
264 @item @code{|}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
265 Logical xor. Iff preceding element didn't move point, i.e. usually inserted
Dave Love <fx@gnu.org>
parents:
diff changeset
266 nothing, do following element.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
267 @item @code{-@var{number}}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
268 Delete preceding number characters. Depends on value of
Dave Love <fx@gnu.org>
parents:
diff changeset
269 @code{skeleton-untabify}.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
270 @item @code{()} or @code{nil}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
271 Ignored.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
272 @item @var{lisp-expression}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
273 Evaluated, and the return value is again interpreted as a skeleton element.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
274 @item @code{str}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
275 A special variable that, when evaluated the first time, usually prompts
Dave Love <fx@gnu.org>
parents:
diff changeset
276 for input according to the skeleton's interactor. It is then set to the
Dave Love <fx@gnu.org>
parents:
diff changeset
277 return value resulting from the interactor. Each subskeleton has its local
Dave Love <fx@gnu.org>
parents:
diff changeset
278 copy of this variable.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
279 @item @code{v1}, @code{v2}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
280 Skeleton-local user variables.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
281 @item @code{'@var{expression}}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
282 Evaluate following lisp expression for its side-effect, but prevent it from
Dave Love <fx@gnu.org>
parents:
diff changeset
283 being interpreted as a skeleton element.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
284 @item @var{skeleton}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
285 Subskeletons are inserted recursively, not once, but as often as the user
Dave Love <fx@gnu.org>
parents:
diff changeset
286 enters something at the subskeletons interactor. Thus there must be a
Dave Love <fx@gnu.org>
parents:
diff changeset
287 @code{str} in the subskeleton. They can also be used non-interactively, when
Dave Love <fx@gnu.org>
parents:
diff changeset
288 prompt is a lisp-expression that returns successive list-elements.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
289 @item @code{resume:}
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
290 Ignored. Execution resumes here if the user quits during skeleton
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
291 interpretation.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
292 @item @code{quit}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
293 A constant which is non-@code{nil} when the @code{resume:} section was entered
Dave Love <fx@gnu.org>
parents:
diff changeset
294 because the user quit.
Dave Love <fx@gnu.org>
parents:
diff changeset
295 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
296
Dave Love <fx@gnu.org>
parents:
diff changeset
297 @findex skeleton-further-elements
Dave Love <fx@gnu.org>
parents:
diff changeset
298 Some modes also use other skeleton elements they themselves defined. For
Dave Love <fx@gnu.org>
parents:
diff changeset
299 example in shell script mode's skeletons you will find @code{<} which does a
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
300 rigid indentation backwards, or in CC mode's skeletons you find the
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
301 self-inserting elements @code{@{} and @code{@}}. These are defined by the
Dave Love <fx@gnu.org>
parents:
diff changeset
302 buffer-local variable @code{skeleton-further-elements} which is a list of
Dave Love <fx@gnu.org>
parents:
diff changeset
303 variables bound while interpreting a skeleton.
Dave Love <fx@gnu.org>
parents:
diff changeset
304
Dave Love <fx@gnu.org>
parents:
diff changeset
305 @findex define-skeleton
Dave Love <fx@gnu.org>
parents:
diff changeset
306 The macro @code{define-skeleton} defines a command for interpreting a
Dave Love <fx@gnu.org>
parents:
diff changeset
307 skeleton. The first argument is the command name, the second is a
Dave Love <fx@gnu.org>
parents:
diff changeset
308 documentation string, and the rest is an interactor and any number of skeleton
Dave Love <fx@gnu.org>
parents:
diff changeset
309 elements together forming a skeleton. This skeleton is assigned to a variable
Dave Love <fx@gnu.org>
parents:
diff changeset
310 of the same name as the command and can thus be overridden from your
26463
2bf82b32f9f8 Fix makeinfo errors.
Dave Love <fx@gnu.org>
parents: 26151
diff changeset
311 @file{~/.emacs} file (@pxref{(emacs)Init File}).
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
312
Dave Love <fx@gnu.org>
parents:
diff changeset
313
Dave Love <fx@gnu.org>
parents:
diff changeset
314
Dave Love <fx@gnu.org>
parents:
diff changeset
315 @node Inserting Pairs
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
316 @chapter Inserting Matching Pairs of Characters
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
317 @cindex inserting pairs
Dave Love <fx@gnu.org>
parents:
diff changeset
318 @cindex pairs
Dave Love <fx@gnu.org>
parents:
diff changeset
319
Dave Love <fx@gnu.org>
parents:
diff changeset
320 Various characters usually appear in pairs. When, for example, you insert
Dave Love <fx@gnu.org>
parents:
diff changeset
321 an open parenthesis, no matter whether you are programming or writing prose,
Dave Love <fx@gnu.org>
parents:
diff changeset
322 you will surely enter a closing one later. By entering both at the same time
Dave Love <fx@gnu.org>
parents:
diff changeset
323 and leaving the cursor inbetween, Emacs can guarantee you that such
Dave Love <fx@gnu.org>
parents:
diff changeset
324 parentheses are always balanced. And if you have a non-qwerty keyboard, where
Dave Love <fx@gnu.org>
parents:
diff changeset
325 typing some of the stranger programming language symbols makes you bend your
Dave Love <fx@gnu.org>
parents:
diff changeset
326 fingers backwards, this can be quite relieving too.
Dave Love <fx@gnu.org>
parents:
diff changeset
327
29480
3f09d2029838 (Inserting Pairs): Add the missing `skeleton-' prefix to vars and funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 26463
diff changeset
328 @findex skeleton-pair-insert-maybe
3f09d2029838 (Inserting Pairs): Add the missing `skeleton-' prefix to vars and funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 26463
diff changeset
329 @vindex skeleton-pair
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
330 This is done by binding the first key (@pxref{(emacs)Rebinding}) of
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
331 the pair to @code{skeleton-pair-insert-maybe} instead of
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
332 @code{self-insert-command}. The ``maybe'' comes from the fact that
38017
32f10000ac35 Don't use the British spelling of "behaviour".
Eli Zaretskii <eliz@gnu.org>
parents: 36506
diff changeset
333 this at-first surprising behavior is initially turned off. To enable
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
334 it, you must set @code{skeleton-pair} to some non-@code{nil} value.
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
335 And even then, a positive argument (@pxref{(emacs)Arguments}) will
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
336 make this key behave like a self-inserting key
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
337 (@pxref{(emacs)Inserting Text}).
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
338
29480
3f09d2029838 (Inserting Pairs): Add the missing `skeleton-' prefix to vars and funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 26463
diff changeset
339 @vindex skeleton-pair-on-word
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
340 While this breaks with the stated intention of always balancing pairs, it
Dave Love <fx@gnu.org>
parents:
diff changeset
341 turns out that one often doesn't want pairing to occur, when the following
Dave Love <fx@gnu.org>
parents:
diff changeset
342 character is part of a word. If you want pairing to occur even then, set
29480
3f09d2029838 (Inserting Pairs): Add the missing `skeleton-' prefix to vars and funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 26463
diff changeset
343 @code{skeleton-pair-on-word} to some non-@code{nil} value.
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
344
29480
3f09d2029838 (Inserting Pairs): Add the missing `skeleton-' prefix to vars and funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 26463
diff changeset
345 @vindex skeleton-pair-alist
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
346 Pairing is possible for all visible characters. By default the
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
347 parenthesis @samp{(}, the square bracket @samp{[}, the brace
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
348 @samp{@{}, the pointed bracket @samp{<} and the backquote @samp{`} all
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
349 pair with the symmetrical character. All other characters pair
38017
32f10000ac35 Don't use the British spelling of "behaviour".
Eli Zaretskii <eliz@gnu.org>
parents: 36506
diff changeset
350 themselves. This behavior can be modified by the variable
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
351 @code{skeleton-pair-alist}. This is in fact an alist of skeletons
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
352 (@pxref{Skeleton Language}), with the first part of each sublist
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
353 matching the typed character. This is the position of the interactor,
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
354 but since pairs don't need the @code{str} element, this is ignored.
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
355
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
356 Some modes have bound the command @code{skeleton-pair-insert-maybe}
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
357 to relevant keys. These modes also configure the pairs as
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
358 appropriate. For example, when typing english prose, you'd expect the
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
359 backquote (@samp{`}) to pair with the quote (@samp{'}), while in Shell
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
360 script mode it must pair to itself. They can also inhibit pairing in
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
361 certain contexts. For example an escaped character stands for itself.
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
362
Dave Love <fx@gnu.org>
parents:
diff changeset
363
Dave Love <fx@gnu.org>
parents:
diff changeset
364
Dave Love <fx@gnu.org>
parents:
diff changeset
365 @node Autoinserting
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
366 @chapter Autoinserting Text in Empty Files
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
367 @cindex autoinserting
Dave Love <fx@gnu.org>
parents:
diff changeset
368
Dave Love <fx@gnu.org>
parents:
diff changeset
369 @findex auto-insert
Dave Love <fx@gnu.org>
parents:
diff changeset
370 @kbd{M-x auto-insert} will put some predefined text at the beginning of
Dave Love <fx@gnu.org>
parents:
diff changeset
371 the buffer. The main application for this function, as its name suggests,
Dave Love <fx@gnu.org>
parents:
diff changeset
372 is to have it be called automatically every time an empty, and only an
Dave Love <fx@gnu.org>
parents:
diff changeset
373 empty file is visited. This is accomplished by putting @code{(add-hook
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
374 'find-file-hooks 'auto-insert)} into your @file{~/.emacs} file
26463
2bf82b32f9f8 Fix makeinfo errors.
Dave Love <fx@gnu.org>
parents: 26151
diff changeset
375 (@pxref{(emacs)Init File}).
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
376
Dave Love <fx@gnu.org>
parents:
diff changeset
377 @vindex auto-insert-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
378 What gets inserted, if anything, is determined by the variable
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
379 @code{auto-insert-alist}. The @sc{car}s of this list are each either
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
380 a mode name, making an element applicable when a buffer is in that
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
381 mode. Or they can be a string, which is a regexp matched against the
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
382 buffer's file name. In that way different kinds of files that have
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
383 the same mode in Emacs can be distinguished. The @sc{car}s may also
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
384 be cons cells consisting of mode name or regexp as above and an
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
385 additional descriptive string.
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
386
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
387 When a matching element is found, the @sc{cdr} says what to do. It may
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
388 be a string, which is a file name, whose contents are to be inserted, if
Dave Love <fx@gnu.org>
parents:
diff changeset
389 that file is found in the directory @code{auto-insert-directory} or under a
26463
2bf82b32f9f8 Fix makeinfo errors.
Dave Love <fx@gnu.org>
parents: 26151
diff changeset
390 absolute file name. Or it can be a skeleton (@pxref{Skeleton Language}) to
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
391 be inserted.
Dave Love <fx@gnu.org>
parents:
diff changeset
392
Dave Love <fx@gnu.org>
parents:
diff changeset
393 It can also be a function, which allows doing various things. The function
26463
2bf82b32f9f8 Fix makeinfo errors.
Dave Love <fx@gnu.org>
parents: 26151
diff changeset
394 can simply insert some text, indeed, it can be skeleton command (@pxref{Using
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
395 Skeletons}). It can be a lambda function which will for example conditionally
Dave Love <fx@gnu.org>
parents:
diff changeset
396 call another function. Or it can even reset the mode for the buffer. If you
Dave Love <fx@gnu.org>
parents:
diff changeset
397 want to perform several such actions in order, you use a vector, i.e. several
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
398 of the above elements between square brackets (@samp{[@r{@dots{}}]}).
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
399
Dave Love <fx@gnu.org>
parents:
diff changeset
400 By default C and C++ headers insert a definition of a symbol derived from
Dave Love <fx@gnu.org>
parents:
diff changeset
401 the filename to prevent multiple inclusions. C and C++ sources insert an
Dave Love <fx@gnu.org>
parents:
diff changeset
402 include of the header. Makefiles insert the file makefile.inc if it exists.
Dave Love <fx@gnu.org>
parents:
diff changeset
403
Dave Love <fx@gnu.org>
parents:
diff changeset
404 TeX and bibTeX mode files insert the file tex-insert.tex if it exists, while
36330
a16d8ed56e9c (Autoinserting): Remove doubled `insert'.
Gerd Moellmann <gerd@gnu.org>
parents: 32315
diff changeset
405 LaTeX mode files insert a typical @code{\documentclass} frame. Html
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
406 files insert a skeleton with the usual frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
407
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
408 Ada mode files call the Ada header skeleton command. Emacs lisp
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
409 source files insert the usual header, with a copyright of your
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
410 environment variable @env{$ORGANIZATION} or else the FSF, and prompt
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
411 for valid keywords describing the contents. Files in a @file{bin}
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
412 directory for which Emacs could determine no specialised mode
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
413 (@pxref{(emacs)Choosing Modes}) are set to Shell script mode.
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
414
Dave Love <fx@gnu.org>
parents:
diff changeset
415 @findex define-auto-insert
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
416 In Lisp (@pxref{(emacs)Init File}) you can use the function
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
417 @code{define-auto-insert} to add to or modify
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
418 @code{auto-insert-alist}. See its documentation with @kbd{C-h f
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
419 auto-insert-alist}.
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
420
Dave Love <fx@gnu.org>
parents:
diff changeset
421 @vindex auto-insert
Dave Love <fx@gnu.org>
parents:
diff changeset
422 The variable @code{auto-insert} says what to do when @code{auto-insert} is
Dave Love <fx@gnu.org>
parents:
diff changeset
423 called non-interactively, e.g. when a newly found file is empty (see above):
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
424 @table @asis
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
425 @item @code{nil}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
426 Do nothing.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
427 @item @code{t}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
428 Insert something if possible, i.e. there is a matching entry in
Dave Love <fx@gnu.org>
parents:
diff changeset
429 @code{auto-insert-alist}.
Dave Love <fx@gnu.org>
parents:
diff changeset
430 @item other
Dave Love <fx@gnu.org>
parents:
diff changeset
431 Insert something if possible, but mark as unmodified.
Dave Love <fx@gnu.org>
parents:
diff changeset
432 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
433
Dave Love <fx@gnu.org>
parents:
diff changeset
434 @vindex auto-insert-query
Dave Love <fx@gnu.org>
parents:
diff changeset
435 The variable @code{auto-insert-query} controls whether to ask about
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
436 inserting something. When this is @code{nil}, inserting is only done with
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
437 @kbd{M-x auto-insert}. When this is @code{function}, you are queried
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
438 whenever @code{auto-insert} is called as a function, such as when Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
439 visits an empty file and you have set the above-mentioned hook. Otherwise
Dave Love <fx@gnu.org>
parents:
diff changeset
440 you are alway queried.
Dave Love <fx@gnu.org>
parents:
diff changeset
441
Dave Love <fx@gnu.org>
parents:
diff changeset
442 @vindex auto-insert-prompt
Dave Love <fx@gnu.org>
parents:
diff changeset
443 When querying, the variable @code{auto-insert-prompt}'s value is used as a
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
444 prompt for a y-or-n-type question. If this includes a @samp{%s} construct,
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
445 that is replaced by what caused the insertion rule to be chosen. This is
Dave Love <fx@gnu.org>
parents:
diff changeset
446 either a descriptive text, the mode-name of the buffer or the regular
Dave Love <fx@gnu.org>
parents:
diff changeset
447 expression that matched the filename.
Dave Love <fx@gnu.org>
parents:
diff changeset
448
Dave Love <fx@gnu.org>
parents:
diff changeset
449
Dave Love <fx@gnu.org>
parents:
diff changeset
450
Dave Love <fx@gnu.org>
parents:
diff changeset
451 @node Copyrights
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
452 @chapter Inserting and Updating Copyrights
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
453 @cindex copyrights
Dave Love <fx@gnu.org>
parents:
diff changeset
454
Dave Love <fx@gnu.org>
parents:
diff changeset
455 @findex copyright
Dave Love <fx@gnu.org>
parents:
diff changeset
456 @kbd{M-x copyright} is a skeleton inserting command, that adds a copyright
Dave Love <fx@gnu.org>
parents:
diff changeset
457 notice at the point. The ``by'' part is taken from your environment variable
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
458 @env{$ORGANIZATION} or if that isn't set you are prompted for it. If the
26463
2bf82b32f9f8 Fix makeinfo errors.
Dave Love <fx@gnu.org>
parents: 26151
diff changeset
459 buffer has a comment syntax (@pxref{(emacs)Comments}), this is inserted as a comment.
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
460
Dave Love <fx@gnu.org>
parents:
diff changeset
461 @findex copyright-update
Dave Love <fx@gnu.org>
parents:
diff changeset
462 @vindex copyright-limit
Dave Love <fx@gnu.org>
parents:
diff changeset
463 @vindex copyright-current-year
Dave Love <fx@gnu.org>
parents:
diff changeset
464 @kbd{M-x copyright-update} looks for a copyright notice in the first
Dave Love <fx@gnu.org>
parents:
diff changeset
465 @code{copyright-limit} characters of the buffer and updates it when necessary.
Dave Love <fx@gnu.org>
parents:
diff changeset
466 The current year (variable @code{copyright-current-year}) is added to the
Dave Love <fx@gnu.org>
parents:
diff changeset
467 existing ones, in the same format as the preceding year, i.e. 1994, '94 or 94.
Dave Love <fx@gnu.org>
parents:
diff changeset
468 If a dash-separated year list up to last year is found, that is extended to
Dave Love <fx@gnu.org>
parents:
diff changeset
469 current year, else the year is added separated by a comma. Or it replaces
Dave Love <fx@gnu.org>
parents:
diff changeset
470 them when this is called with a prefix argument. If a header referring to a
26463
2bf82b32f9f8 Fix makeinfo errors.
Dave Love <fx@gnu.org>
parents: 26151
diff changeset
471 wrong version of the GNU General Public License (@pxref{(emacs)Copying}) is found,
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
472 that is updated too.
Dave Love <fx@gnu.org>
parents:
diff changeset
473
Dave Love <fx@gnu.org>
parents:
diff changeset
474 An interesting application for this function is to have it be called
Dave Love <fx@gnu.org>
parents:
diff changeset
475 automatically every time a file is saved. This is accomplished by putting
Dave Love <fx@gnu.org>
parents:
diff changeset
476 @code{(add-hook 'write-file-hooks 'copyright-update)} into your @file{~/.emacs}
26463
2bf82b32f9f8 Fix makeinfo errors.
Dave Love <fx@gnu.org>
parents: 26151
diff changeset
477 file (@pxref{(emacs)Init File}).
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
478
Dave Love <fx@gnu.org>
parents:
diff changeset
479 @vindex copyright-query
Dave Love <fx@gnu.org>
parents:
diff changeset
480 The variable @code{copyright-query} controls whether to update the
Dave Love <fx@gnu.org>
parents:
diff changeset
481 copyright or whether to ask about it. When this is @code{nil} updating is
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
482 only done with @kbd{M-x copyright-update}. When this is @code{function}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
483 you are queried whenever @code{copyright-update} is called as a function,
Dave Love <fx@gnu.org>
parents:
diff changeset
484 such as in the @code{write-file-hooks} feature mentioned above. Otherwise
Dave Love <fx@gnu.org>
parents:
diff changeset
485 you are always queried.
Dave Love <fx@gnu.org>
parents:
diff changeset
486
Dave Love <fx@gnu.org>
parents:
diff changeset
487
Dave Love <fx@gnu.org>
parents:
diff changeset
488
Dave Love <fx@gnu.org>
parents:
diff changeset
489 @node Executables
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
490 @chapter Making Interpreter Scripts Executable
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
491 @cindex executables
Dave Love <fx@gnu.org>
parents:
diff changeset
492
Dave Love <fx@gnu.org>
parents:
diff changeset
493 @vindex executable-prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
494 @vindex executable-chmod
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
495 Various interpreter modes such as Shell script mode or AWK mode will
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
496 automatically insert or update the buffer's magic number, a special
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
497 comment on the first line that makes the @code{exec} systemcall know
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
498 how to execute the script. To this end the script is automatically
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
499 made executable upon saving, with @code{executable-chmod} as argument
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
500 to the system @code{chmod} command. The magic number is prefixed by
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
501 the value of @code{executable-prefix}.
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
502
Dave Love <fx@gnu.org>
parents:
diff changeset
503 @vindex executable-magicless-file-regexp
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
504 Any file whose name matches @code{executable-magicless-file-regexp} is not
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
505 furnished with a magic number, nor is it made executable. This is mainly
Dave Love <fx@gnu.org>
parents:
diff changeset
506 intended for resource files, which are only meant to be read in.
Dave Love <fx@gnu.org>
parents:
diff changeset
507
Dave Love <fx@gnu.org>
parents:
diff changeset
508 @vindex executable-insert
Dave Love <fx@gnu.org>
parents:
diff changeset
509 The variable @code{executable-insert} says what to do when
Dave Love <fx@gnu.org>
parents:
diff changeset
510 @code{executable-set-magic} is called non-interactively, e.g. when file has no
Dave Love <fx@gnu.org>
parents:
diff changeset
511 or the wrong magic number:
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
512 @table @asis
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
513 @item @code{nil}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
514 Do nothing.
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
515 @item @code{t}
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
516 Insert or update magic number.
Dave Love <fx@gnu.org>
parents:
diff changeset
517 @item other
Dave Love <fx@gnu.org>
parents:
diff changeset
518 Insert or update magic number, but mark as unmodified.
Dave Love <fx@gnu.org>
parents:
diff changeset
519 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
520
Dave Love <fx@gnu.org>
parents:
diff changeset
521 @findex executable-set-magic
Dave Love <fx@gnu.org>
parents:
diff changeset
522 @vindex executable-query
Dave Love <fx@gnu.org>
parents:
diff changeset
523 The variable @code{executable-query} controls whether to ask about
Dave Love <fx@gnu.org>
parents:
diff changeset
524 inserting or updating the magic number. When this is @code{nil} updating
Dave Love <fx@gnu.org>
parents:
diff changeset
525 is only done with @kbd{M-x executable-set-magic}. When this is
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
526 @code{function} you are queried whenever @code{executable-set-magic} is
25848
Dave Love <fx@gnu.org>
parents:
diff changeset
527 called as a function, such as when Emacs puts a buffer in Shell script
Dave Love <fx@gnu.org>
parents:
diff changeset
528 mode. Otherwise you are alway queried.
Dave Love <fx@gnu.org>
parents:
diff changeset
529
Dave Love <fx@gnu.org>
parents:
diff changeset
530 @findex executable-self-display
Dave Love <fx@gnu.org>
parents:
diff changeset
531 @kbd{M-x executable-self-display} adds a magic number to the buffer, which
Dave Love <fx@gnu.org>
parents:
diff changeset
532 will turn it into a self displaying text file, when called as a Un*x command.
Dave Love <fx@gnu.org>
parents:
diff changeset
533 The ``interpreter'' used is @code{executable-self-display} with argument
36506
a75c13e39706 Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36330
diff changeset
534 @samp{+2}.
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
535
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
536 @node Timestamps
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
537 @chapter Maintaining Timestamps in Modified Files
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
538 @cindex timestamps
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
539
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
540 @findex time-stamp
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
541 @vindex write-file-hooks
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
542 The @code{time-stamp} command can be used to update automatically a
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
543 template in a file with a new time stamp every time you save the file.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
544 Customize the hook @code{write-file-hooks} to add the function
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
545 @code{time-stamp} to arrange this.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
546
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
547 @vindex time-stamp-active
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
548 @vindex time-stamp-format
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
549 @vindex time-stamp-start
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
550 The time stamp is updated only if the customizable variable
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
551 @code{time-stamp-active} is on, which it is by default; the command
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
552 @code{time-stamp-toggle-active} can be used to toggle it. The format of
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
553 the time stamp is set by the customizable variable
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
554 @code{time-stamp-format}.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
555
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
556 @vindex time-stamp-line-limit
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
557 @vindex time-stamp-end
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
558 @vindex time-stamp-count
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
559 @vindex time-stamp-inserts-lines
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
560 The variables @code{time-stamp-line-limit}, @code{time-stamp-start},
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
561 @code{time-stamp-end}, @code{time-stamp-count}, and
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
562 @code{time-stamp-inserts-lines} control finding the template. Do not
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
563 change these in your init file or you will be incompatible with other
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
564 people's files. If you must change them, do so only in the local
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
565 variables section of the file itself.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
566
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
567 Normally the template must appear in the first 8 lines of a file and
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
568 look like one of the following:
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
569
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
570 @example
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
571 Time-stamp: <>
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
572 Time-stamp: " "
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
573 @end example
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
574
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
575 The time stamp is written between the brackets or quotes:
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
576
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
577 @example
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
578 Time-stamp: <1998-02-18 10:20:51 gildea>
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
579 @end example
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
580
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
581 @node QuickURL
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
582 @chapter QuickURL: Inserting URLs Based on Text at Point
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
583
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
584 @vindex quickurl-url-file
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
585 @findex quickurl
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
586 @cindex URLs
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
587 @kbd{M-x quickurl} can be used to insert a URL into a buffer based on
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
588 the text at point. The URLs are stored in an external file defined by
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
589 the variable @code{quickurl-url-file} as a list of either cons cells of
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
590 the form @code{(@var{key} . @var{URL})} or
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
591 lists of the form @code{(@var{key} @var{URL} @var{comment})}. These
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
592 specify that @kbd{M-x quickurl} should insert @var{URL} if the word
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
593 @var{key} is at point, for example:
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
594
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
595 @example
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
596 (("FSF" "http://www.fsf.org/" "The Free Software Foundation")
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
597 ("emacs" . "http://www.emacs.org/")
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
598 ("hagbard" "http://www.hagbard.demon.co.uk" "Hagbard's World"))
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
599 @end example
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
600
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
601 @findex quickurl-add-url
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
602 @findex quickurl-list
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
603 @kbd{M-x quickurl-add-url} can be used to add a new @var{key}/@var{URL}
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
604 pair. @kbd{M-x quickurl-list} provides interactive editing of the URL
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
605 list.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
606
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
607 @node Tempo
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
608 @chapter Tempo: Flexible Template Insertion
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
609
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
610 @cindex templates
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
611 The Tempo package provides a simple way to define powerful templates, or
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
612 macros, if you wish. It is mainly intended for, but not limited to,
30870
4f58e2bbcb08 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
613 programmers to be used for creating shortcuts for editing
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
614 certain kinds of documents.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
615
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
616 @findex tempo-backward-mark
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
617 @findex tempo-forward-mark
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
618 A template is defined as a list of items to be inserted in the current
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
619 buffer at point. Some can be simple strings, while others can control
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
620 formatting or define special points of interest in the inserted text.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
621 @kbd{M-x tempo-backward-mark} and @kbd{M-x tempo-forward-mark} can be
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
622 used to jump between such points.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
623
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
624 More flexible templates can be created by including lisp symbols, which
36330
a16d8ed56e9c (Autoinserting): Remove doubled `insert'.
Gerd Moellmann <gerd@gnu.org>
parents: 32315
diff changeset
625 will be evaluated as variables, or lists, which will be evaluated
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
626 as lisp expressions. Automatic completion of specified tags to expanded
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
627 templates can be provided.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
628
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
629 @findex tempo-define-template
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
630 See the documentation for @code{tempo-define-template} for the different
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
631 items that can be used to define a tempo template with a command for
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
632 inserting it.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
633
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
634 See the commentary in @file{tempo.el} for more information on using the
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
635 Tempo package.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
636
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
637 @node Hippie Expand
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
638 @chapter `Hippie' Expansion
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
639
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
640 @findex hippie-expand
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
641 @kindex M-/
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
642 @vindex hippie-expand-try-functions-list
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
643 @kbd{M-x hippie-expand} is a single command providing a variety of
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
644 completions and expansions. Called repeatedly, it tries all possible
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
645 completions in succession.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
646
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
647 Which ones to try, and in which order, is determined by the contents of
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
648 the customizable option @code{hippie-expand-try-functions-list}. Much
38017
32f10000ac35 Don't use the British spelling of "behaviour".
Eli Zaretskii <eliz@gnu.org>
parents: 36506
diff changeset
649 customization of the expansion behavior can be made by changing the
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
650 order of, removing, or inserting new functions in this list. Given a
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
651 positive numeric argument, @kbd{M-x hippie-expand} jumps directly that
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
652 number of functions forward in this list. Given some other argument (a
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
653 negative argument or just @kbd{C-u}) it undoes the tried completion.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
654
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
655 See the commentary in @file{hippie-exp.el} for more information on the
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
656 possibilities.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
657
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
658 Typically you would bind @code{hippie-expand} to @kbd{M-/} with
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
659 @code{dabbrev-expand}, the standard binding of @kbd{M-/}, providing one
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
660 of the expansion possibilities.
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
661
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
662
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
663 @node Concept Index
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
664 @unnumbered Concept Index
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
665 @printindex cp
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
666
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
667 @node Command Index
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
668 @unnumbered Command Index
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
669 @printindex fn
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
670
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
671 @node Variable Index
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
672 @unnumbered Variable Index
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
673 @printindex vr
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
674
29713
983e65f12610 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29480
diff changeset
675 @setchapternewpage odd
26151
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
676 @contents
983ad33e1d97 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25848
diff changeset
677 @bye