|
24
|
1 @chapter Introduction to AUC TeX
|
|
|
2
|
|
|
3 This section of the AUC @TeX{} manual gives a brief overview of what AUC
|
|
|
4 @TeX{} is, and the section is also available as a @file{README} file.
|
|
|
5 It is @strong{not} an attempt to document AUC @TeX{}. Real
|
|
|
6 documentation for AUC @TeX{} is available in the rest of the manual,
|
|
|
7 which you can find in the @file{doc} directory.
|
|
|
8
|
|
|
9 Read the @file{INSTALLATION} file for information about how to install
|
|
|
10 AUC @TeX{}. It is identical to the Installation chapter in the AUC
|
|
|
11 @TeX{} manual.
|
|
|
12
|
|
|
13 If you are upgrading from the previous version of AUC @TeX{}, the
|
|
|
14 latest changes can be found in the @file{CHANGES} file. If you are
|
|
|
15 upgrading from an older version, read the History chapter in the AUC
|
|
|
16 @TeX{} manual.
|
|
|
17
|
|
|
18 AUC @TeX{} is a comprehensive customizable integrated environment for
|
|
|
19 writing input files for La@TeX{} using GNU Emacs.
|
|
|
20
|
|
|
21 AUC @TeX{} lets you run @TeX{}/La@TeX{} and other La@TeX{}-related
|
|
|
22 tools, such as a output filters or post processor from inside Emacs.
|
|
|
23 Especially `running La@TeX{}' is interesting, as AUC @TeX{} lets you
|
|
|
24 browse through the errors @TeX{} reported, while it moves the cursor
|
|
|
25 directly to the reported error, and displays some documentation for that
|
|
|
26 particular error. This will even work when the document is spread over
|
|
|
27 several files.
|
|
|
28
|
|
|
29 AUC @TeX{} automatically indents your `La@TeX{}-source', not only as you
|
|
|
30 write it --- you can also let it indent and format an entire document.
|
|
|
31 It has a special outline feature, which can greatly help you `getting an
|
|
|
32 overview' of a document.
|
|
|
33
|
|
|
34 Apart from these special features, AUC @TeX{} provides an large range of
|
|
|
35 handy Emacs macros, which in several different ways can help you write
|
|
|
36 your La@TeX{} documents fast and painless.
|
|
|
37
|
|
|
38 All features of AUC @TeX{} are documented using the GNU Emacs online
|
|
|
39 documentation system. That is, documentation for any command is just
|
|
|
40 a key click away!
|
|
|
41
|
|
|
42 AUC @TeX{} is written entirely in Emacs-Lisp, and hence you can easily
|
|
|
43 add new features for your own needs. It was not made as part of any
|
|
|
44 particular employment or project (apart from the AUC @TeX{} project
|
|
|
45 itself). AUC @TeX{} is distributed under the `GNU Emacs General Public
|
|
|
46 License' and may therefore almost freely be copied and redistributed.
|
|
|
47
|
|
|
48 The next sections are a short introduction to some `actual' features.
|
|
|
49 For further information, refer to the build-in online documentation of
|
|
|
50 AUC @TeX{}.
|
|
|
51
|
|
|
52 @section Indentation and formatting
|
|
|
53
|
|
|
54 AUC @TeX{} may automatically indent your document as you write it. By
|
|
|
55 pressing @key{lfd} instead of @key{ret} at the end of a line, the
|
|
|
56 current line is indented by two spaces according to the current
|
|
|
57 environment level, and the cursor is moved down one line. By pressing
|
|
|
58 @key{tab}, the current line is indented, and the cursor stays where it
|
|
|
59 is. The well-known Emacs feature @code{format-paragraph} (@kbd{M-q}) is
|
|
|
60 reimplemented especially for AUC @TeX{} to follow the indentation. A
|
|
|
61 special command @code{LaTeX-fill-buffer} lets you indent an entire
|
|
|
62 document like the well-known C utility indent (this time, only according
|
|
|
63 to the La@TeX{} structure @t{:-)}.
|
|
|
64
|
|
|
65 @section Completion
|
|
|
66
|
|
|
67 By studying your @samp{\documentstyle} command (in the top of your
|
|
|
68 document), and consulting a precompiled list of (La)@TeX{} symbols from
|
|
|
69 a large number of @TeX{} and La@TeX{} files, AUC @TeX{} is aware of the
|
|
|
70 La@TeX{} commands you should able to use in this particular document.
|
|
|
71 This `knowledge' of AUC @TeX{} is used for two purposes.
|
|
|
72
|
|
|
73 @enumerate
|
|
|
74 @item
|
|
|
75 To make you able to `complete' partly written La@TeX{} commands. You may
|
|
|
76 e.g. write @kbd{\renew} and press @kbd{M-@key{tab}}
|
|
|
77 (@code{TeX-complete-symbol}), and then AUC @TeX{} will complete the word
|
|
|
78 @samp{\renewcommand} for you. In case of ambiguity it will display a
|
|
|
79 list of possible completions.
|
|
|
80 @item
|
|
|
81 To aid you inserting environments, that is \begin - \end pairs. This is
|
|
|
82 done by pressing C-c C-e (La@TeX{}-environment), and you will be
|
|
|
83 prompted for which `environment' to insert.
|
|
|
84 @end enumerate
|
|
|
85
|
|
|
86 @section Editing your document
|
|
|
87
|
|
|
88 A number of more or less intelligent keyboard macros have been defined
|
|
|
89 to aid you editing your document. The most important are listed here
|
|
|
90 below.
|
|
|
91
|
|
|
92 @table @code
|
|
|
93 @item LaTeX-environment
|
|
|
94 (@kbd{C-c C-e}) Insert a @samp{\begin@{@}} --- @samp{\end@{@}} pair as
|
|
|
95 described above.
|
|
|
96 @item LaTeX-section
|
|
|
97 (@kbd{C-c C-s}) Insert one of @samp{\chapter}, @samp{\section}, etc.
|
|
|
98 @item TeX-font
|
|
|
99 (@kbd{C-c C-f C-r}, @kbd{C-c C-f C-i}, @kbd{C-c C-f C-b}) Insert one of
|
|
|
100 @samp{@{\textrm @}}), @samp{@{\textit \/@}} @samp{@{\textbf @}} etc.
|
|
|
101 @end table
|
|
|
102
|
|
|
103 A number of additional functions are available. But it would be far too
|
|
|
104 much to write about here. Refer to the rest of the AUC @TeX{}
|
|
|
105 documentation for further information.
|
|
|
106
|
|
|
107 @section Running La@TeX{}
|
|
|
108
|
|
|
109 When invoking on of the commands @code{TeX-command-master} (@kbd{C-c
|
|
|
110 C-c}) or @code{TeX-command-region} (@kbd{C-c C-r}) La@TeX{} is run on
|
|
|
111 either the entire current document or a given region of it. The Emacs
|
|
|
112 view is split in two, and the output of @TeX{} is printed in the second
|
|
|
113 half of the screen, as you may simultaneously continue editing your
|
|
|
114 document. In case @TeX{} found any errors when processing your input
|
|
|
115 you can call the function @code{TeX-next-error} (@kbd{C-c `}) which will
|
|
|
116 move the cursor to the first given error, and display a short
|
|
|
117 explanatory text along with the message @TeX{} gave. This procedure may
|
|
|
118 be repeated until all errors have been displayed. By pressing @kbd{C-c
|
|
|
119 C-w} (@code{TeX-toggle-debug-boxes}) you can toggle whether the browser
|
|
|
120 also should notify over-full/under-full boxes or not.
|
|
|
121
|
|
|
122 Once you've successfully formatted your document, you may preview or
|
|
|
123 print it by invoking @code{TeX-command-master} again.
|
|
|
124
|
|
|
125 @section Outlines
|
|
|
126
|
|
|
127 Along with AUC @TeX{} comes support for outline mode for Emacs, which
|
|
|
128 lets you browse the sectioning structure of your document, while you
|
|
|
129 will still be able to use the full power of the rest of the AUC @TeX{}
|
|
|
130 functionality.
|
|
|
131
|
|
|
132 @section Availability
|
|
|
133
|
|
|
134 The most recent version is always available by ftp at
|
|
|
135
|
|
|
136 @flushright
|
|
|
137 @samp{ftp://ftp.iesd.auc.dk/pub/emacs-lisp/auctex.tar.gz}
|
|
|
138 @end flushright
|
|
|
139
|
|
|
140 In case you don't have access anonymous ftp, you can get it by email
|
|
|
141 requests to @samp{<ftpmail@@decwrl.dec.com>}.
|
|
|
142
|
|
|
143 WWW users may want to check out the AUC @TeX{} page at
|
|
|
144
|
|
|
145 @flushright
|
|
|
146 @samp{http://www.iesd.auc.dk/~amanda/auctex/}
|
|
|
147 @end flushright
|
|
|
148
|
|
|
149 @section Contacts
|
|
|
150
|
|
|
151 There has been established a mailing list for help, bug reports, feature
|
|
|
152 requests and general discussion about AUC @TeX{}. You're very welcome
|
|
|
153 to join. Traffic average at an article by day, but they come in bursts.
|
|
|
154 If you are only interested in information on updates, you could refer to
|
|
|
155 the newsgroups @samp{comp.text.tex} and @samp{gnu.emacs.sources}.
|
|
|
156
|
|
|
157 If you want to contact the AUC @TeX{} mailing list, send mail to
|
|
|
158 @samp{<auc-tex-request@@iesd.auc.dk>} in order to join. Articles should
|
|
|
159 be send to @samp{<auc-tex@@iesd.auc.dk>}.
|
|
|
160
|
|
|
161 To contact the current maintainers of auc-@TeX{} directly, email
|
|
|
162 @samp{<auc-tex_mgr@@iesd.auc.dk>}.
|
|
|
163
|
|
|
164 @example
|
|
|
165 AUC @TeX{} development
|
|
|
166 c/o Kresten Krab Thorup
|
|
|
167
|
|
|
168 Mathematics and Computer Science
|
|
|
169 University of Aalborg
|
|
|
170 DK 9000 Aalborg
|
|
|
171 Denmark
|
|
|
172 @end example
|
|
|
173
|
|
|
174
|
