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