Next: Indices, Previous: Customization, Up: top [Contents][Index]
• Copying this Manual | ||
• Changes | ||
• Development | ||
• FAQ | ||
• Texinfo mode |
Next: Changes, Up: Appendices [Contents][Index]
The full license text can be read here:
• GNU Free Documentation License | License for copying this manual. |
Up: Copying this Manual [Contents][Index]
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.
The “publisher” means any person or entity that distributes copies of the Document to the public.
A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.
You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See https://www.gnu.org/licenses/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.
“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.
“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.
“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.
An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.
The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
Copyright (C) year your name. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''.
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:
with the Invariant Sections being list their titles, with the Front-Cover Texts being list, and with the Back-Cover Texts being list.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
Next: Development, Previous: Copying this Manual, Up: Appendices [Contents][Index]
preview-pdf-color-adjust-method
to choose appropriate
option among the three: new, traditional and fallback method.
(add-hook 'LaTeX-mode-hook #'flymake-mode)
TeX-record-buffer
is used was corrected. It
was used in just the opposite way as the document says. Erase the
customization if you have customized this option since it now acts in
reverse to your expectation.
japanese-TeX-command-list
is removed.
Use japanese-TeX-engine-default
, or if it’s really necessary,
customize TeX-command-list
directly if the task which the option
used to carry is required.
In addition, the option TeX-electric-escape
is now effective in
Texinfo mode. When it is enabled, typing @ will invoke
TeX-electric-macro
offering completion in similar style with
other TeX modes of AUCTeX.
TeX-view-program-list-builtin
for Windows and macOS. This viewer
can be configured under these operating systems with an entry like this
in an init file:
(setq TeX-view-program-selection '((output-pdf "PDF Tools")))
TeX-math-input-method-off-regexp
. When you begin to input a math
formula, the current input method is turned off if its name matches this
regular expression.
In fact this variable was introduced long before, but has not been
documented in info files nor turned into a customize option with
defcustom
until this release.
TeX-view-evince-keep-focus
is non-nil.
upmendex
, an extension of makeindex
capable of sorting indexes by unicode based ICU.
TeX-command-list
runs the command
makeglossaries
.
font-latex-match-simple-exclude-list
do not receive any
fontification. In DocTeX mode, the character ‘_’ is removed
from font-latex-match-simple-exclude-list
in order to fontify
macros like ‘\__module_foo:nnn’ correctly.
TeX-ispell-verb-delimiters
.
This string contains usual characters used as delimiters for in-line
verbatim macros like ‘\verb’. Text between delimiters after an
in-line verbatim macro will be skipped during spell checking.
LaTeX-env-label-as-keyval
. A new customize option
LaTeX-listing-label
is available as prefix to labels in code
typesetting environments, e.g. ‘lstlisting’ environment provided by
‘listings’ package. LaTeX-listing-label
defaults to
lst:
. Parsing of labels for later referencing relies on two
requirements:
\begin{lstlisting}[caption=Some Caption,label={lst:foo}] ... \end{lstlisting}
LaTeX-label
now takes a second optional argument
NO-INSERT
. When non-nil
, LaTeX-label
reads a label
and returns it as a string. This argument is also passed to any
function bound to LaTeX-label-function
(see next item).
LaTeX-label-function
has changed. The
function bound to this variable is now expected to take an optional
second argument NO-INSERT
. When this argument is non-nil
,
the function should read and only return a label as a string; insertion
is done by another function.
japanese-latex-mode
and japanese-plain-tex-mode
. This bug
was fixed. (This was actually done in AUCTeX 11.90, but not
advertised)
TeX-complete-symbol
,
AUCTeX now also supports the new Emacs standard completion-at-point
facility (see the Emacs command completion-at-point
). This also
means that modern completion UIs like company-mode work out of the
box in TeX and LaTeX buffers.
See Completion, for details.
font-latex-fontify-script
(especially the new values
multi-level
and invisible
) and
font-latex-fontify-script-max-level
. Also, the script characters
‘^’ and ‘_’ are also fontified with a special face named
font-latex-script-char-face
.
See Fontification of math, for details.
LaTeX-insert-item
(C-c LFD)
inserts suitable number of ampersands for ‘*{num}{cols}’
constructs. Style files for LaTeX packages ‘tabularx’,
‘tabulary’, ‘longtable’, ‘dcolumn’ and ‘siunitx’ are
adapted to take advantage of this improvement.
TeX-ispell-extend-skip-list
, which is set to t
and
activated by default.
TeX-raise-frame-function
that is currently only used by Evince and Atril inverse search to raise
the Emacs frame.
LaTeX-short-caption-prompt-length
.
TeX-ignore-warnings
and
TeX-suppress-ignored-warnings
, allow ignoring certain warnings
after compilation of the document.
See Ignoring warnings, for details.
TeX-PDF-from-DVI
, controls if and how to produce a
PDF file by converting a DVI file. This supersedes
TeX-PDF-via-dvips-ps2pdf
which is still recognized but marked as
obsolete and may be removed in future releases.
TeX-source-correlate-method
is set to use ‘source-specials’
for DVI, e.g.:
(setq TeX-source-correlate-method '((dvi . source-specials) (pdf . synctex)))
which is the default.
TeX-documentation-texdoc
, for reading
documentation with ‘texdoc’ has been added. TeX-doc
is
still available but now C-c ? runs
TeX-documentation-texdoc
.
LaTeX-reftex-cite-format-auto-activate
which controls the
automatic activation of citation formats provided by RefTeX when a style
file is loaded and RefTeX is enabled. Currently, biblatex.el,
harvard.el, jurabib.el and natbib.el use this
feature. If you have customized reftex-cite-format
and want to
use your settings, you should set this variable to nil
.
LaTeX-includegraphics-options-alist
is now no-op and is removed
from tex-style.el. You can safely remove any customization of it
from your init file. The mandatory argument of ‘\includegraphics’
knows about image file extensions supported by the used engine and
offers them for inclusion.
TeX-command-run-all
, bound to
C-c C-a.
LaTeX-command-section
and
LaTeX-command-section-change-level
.
See Starting a Command, for details.
TeX-PDF-via-dvips-ps2pdf
it is possible to
compile a document to DVI and then convert it to PDF
using dvips
–ps2pdf
before viewing it.
TeX-file-line-error
allows to select file:line:error
style for error messages.
makeindex
when appropriate.
TeX-view-program-list
can contain, as third optional element of
each item, the name of the executable(s) needed to open the viewer.
TeX-expand-list
variable has been split into
TeX-expand-list
and TeX-expand-list-builtin
. Only the
former is intended to be customized by the user, the latter contains
built-in expanders. You might want to keep in TeX-expand-list
only new expansion strings.
TeX-check-TeX
is non-nil, it will test whether a
working TeX distribution is actually present in the system and
available to Emacs. Instead, when TeX-check-engine
is non-nil,
before running LaTeX commands AUCTeX will check whether the
correct engine has been set, based upon known restrictions posed by
LaTeX packages.
ConTeXt-Mark-version
, and AUCTeX is able to catch error
messages in the output log of a Mark IV document.
TeX-PDF-mode
is now enabled by default.
TeX-previous-error
works with TeX commands if the new
option TeX-parse-all-errors
is non-nil, which is the default.
When this option is non-nil, an overview of errors and warnings reported
by the TeX compiler can be opened with M-x TeX-error-overview
RET.
See Debugging, for details.
TeX-declare-expert-macros
and
LaTeX-declare-expert-environments
.
Users can then restrict completion using
TeX-complete-expert-commands
.
TeX-math-close-double-dollar
was removed.
See Quotes, for details.
TeX-arg-input-file-search
variable is
non-nil. Completion for class options of the standard LaTeX classes
is provided as well.
LaTeX-default-author
,
LaTeX-fontspec-arg-font-search
,
LaTeX-fontspec-font-list-default
, TeX-date-format
, and
TeX-insert-braces-alist
. A new possible value
(show-all-optional-args
) for
TeX-insert-macro-default-style
was added. The default value of
TeX-source-correlate-method
has been changed.
LaTeX-biblatex-use-Biber
variable was changed to
be file local only and is no more customizable.
LaTeX-environment
(C-c C-e) when the current environment is
‘document’ was changed. With ‘beamer’ class the default
environment is ‘frame’, with ‘letter’ it is ‘letter’,
with ‘slides’ it is ‘slide’.
TeX-insert-macro
.
For example, C-c RET bigl RET ( RET inserts
‘\bigl(\bigr)’.
You can insert brace pair ‘()’, ‘{}’ and ‘[]’ by typing
a single left brace if the new user option
LaTeX-electric-left-right-brace
is enabled.
Macros ‘\langle’, ‘\lfloor’ and ‘\lceil’, which produce
the left part of the paired braces, are treated similarly as ‘(’,
‘{’ and ‘[’ during the course of TeX-insert-macro
.
See Quotes, for details.
Similar supports are provided for various amsmath environments.
See Tabular-like, for details.
TeX-narrow-to-group
) and to
LaTeX environments (LaTeX-narrow-to-environment
) were added.
TeX-command-extra-options
option.
See Processor Options, for details.
TeX-add-style-hook
has now a third argument to tell AUCTeX for
which dialect (LaTeX, Texinfo or BibTeX) the style hook is
registers. Labelling style hook by dialect will avoid applying them not
in the right context.
TeX-next-error
;
a problem for example encountered when using MiKTeX 2.8. In addition
quoted file names as emitted by MiKTeX are now supported.
with-kpathsea-sep
has been removed; the
setting is now usually determined at runtime.
Due to this and other problems, preview-latex in the released XEmacs package failed under Windows or with anything except recent 21.5 XEmacsen.
polish
language option of the babel LaTeX package as well as
the polski LaTeX package are now supported. Most notably this means
that AUCTeX will help to insert quotation marks as defined by polish.sty
("`..."'
) and polski.sty (,,...''
).
TeX-doc
for Emacs 21.
TeX-doc
provides easy access to documentation
about commands and packages or information related to TeX and friends
in general.
See Documentation.
TeX-command-list
accessible with C-c C-c or the Command
menu.
See Cleaning.
Adding support for this feature required the default value of the
variable TeX-output-view-style
to be changed. Please make sure
you either remove any customizations overriding the new default or
incorporate the changes into your customizations if you want to use this
feature.
-file-line-error
kind are now
understood in AUCTeX and preview-latex (parsers are still
separate).
TeX-toggle-debug-warnings
(C-c C-t C-w) or
TeX-toggle-debug-bad-boxes
(C-c C-t C-b). In this case
TeX-next-error
will find these warnings in addition to normal
errors.
The key binding C-c C-w for TeX-toggle-debug-bad-boxes
(which was renamed from TeX-toggle-debug-boxes
) now is
deprecated.
TeX-electric-sub-and-superscript
is set to a non-nil value.
\\og ...\\fg
) which can now be
inserted by typing ".
(load "auctex.el" nil
t t)
instead of the former (require 'tex-site)
. Related to this
change tex-mik.el does not load tex-site.el anymore. That
means if you used only (require 'tex-mik)
in order to activate
AUCTeX, you have to add (load "auctex.el" nil t t)
before the
latter statement.
See Loading the package.
font-latex-verb-like-commands
, font-latex-verbatim-macros
,
and font-latex-verbatim-environments
being removed and the more
general variables LaTeX-verbatim-macros-with-delims
,
LaTeX-verbatim-macros-with-braces
, and
LaTeX-verbatim-environments
being added.
font-latex-title-fontify
were removed. Use
font-latex-fontify-sectioning
instead.
LaTeX-mark-section
now marks subsections of a given section as
well. The former behavior is available via the prefix argument.
Also note that the way AUCTeX is supposed to be activated changed.
Instead of (require 'tex-site)
you should now use (load
"auctex.el" nil t t)
. While the former method may still work, the new
method has the advantage that you can deactivate a preactivated
AUCTeX with the statement (unload-feature 'tex-site)
before
any of its modes have been used. This may be important especially for
site-wide installations.
TeX-fold-force-fontify
.
LaTeX-german-open-quote
,
LaTeX-german-close-quote
, LaTeX-german-quote-after-quote
,
LaTeX-italian-open-quote
, LaTeX-italian-close-quote
, and
LaTeX-italian-quote-after-quote
are now obsolete. If you are not
satisfied with the default settings, you should customize
TeX-quote-language-alist
instead.
font-latex-fontify-sectioning
.
This variable was previously called font-latex-title-fontify
; In
this release we provide an alias but this will disappear in one of the
the next releases. The faces for the sectioning commands are now called
font-latex-sectioning-N-face
(N=0…5) instead of
font-latex-title-N-face
(N=1…4). Analogously
the names of the variables holding the related keyword lists were
changed from font-latex-title-N-keywords
to
font-latex-sectioning-N-keywords
.
See Font Locking, for details.
Make sure to adjust your customizations.
font-latex-slide-title-face
. You can
add macros to be highlighted with this face to
font-latex-match-slide-title-keywords
.
show-trailing-whitespace
to t
. If
you want to delete all trailing whitespace in a buffer, type M-x
delete-trailing-whitespace RET.
TeX-macro-global
is not determined during
configuration anymore but at load time of AUCTeX. Consequently the
associated configuration option ‘--with-tex-input-dirs’ was
removed.
TeX-auto-generate-global
) was extended
to recognize keywords common in LaTeX packages and classes, like
“\DeclareRobustCommand” or “\RequirePackage”. Additionally a bug
was fixed which led to duplicate entries in AUCTeX style files.
TeX-fold-dwim
command content can both be hidden and shown with a single key binding.
In course of these changes new key bindings for unfolding commands where
introduced. The old bindings are still present but will be phased out
in future releases.
(add-hook 'LaTeX-mode-hook 'LaTeX-install-toolbar)
to your init file.
LaTeX-includegraphics-read-file
.
LaTeX-float
to nil
now means that you
will not be prompted for the float position of figures and tables. You
can get the old behaviour of nil
by setting the variable to
""
, i.e. an empty string.
See also Floats.
overlays-at
was fixed.
LaTeX-math-menu-unicode
, Mathematics.
start
is used for the viewer for MiKTeX and fpTeX.
TeX-fold-preserve-comments
can now be customized to
deactivate folding in comments.
TeX-fold
now supports folding of environments in Texinfo mode.
TeX-source-specials
minor mode
which can be toggled via an entry in the Command menu or the key binding
C-c C-t C-s. If you have customized the variable
TeX-command-list
, you have to re-initialize it for this to work.
This means to open a customization buffer for the variable by typing
M-x customize-variable RET TeX-command-list RET
, selecting
“Erase Customization” and do your customization again with the new
default.
TeX-command-list
has to be erased. Otherwise the command menu
and the customization will not work correctly.
TeX-newline-function
, Indenting.
doc.sty
and ltxdoc.cls
(‘dtx’
files) was added. The new docTeX mode provides functionality for
editing documentation parts. This includes formatting (indenting and
filling), adding and completion of macros and environments while staying
in comments as well as syntax highlighting. (Please note that the mode
is not finished yet. For example syntax highlighting does not work yet
in XEmacs.)
TeX-master
is set to t
, AUCTeX will now query for a
master file only when a new file is opened. Existing files will be left
alone. The new function TeX-master-file-ask
(bound to C-c
_ is provided for adding the variable manually.
font-latex-title-fontify
can be customized to restore the old
appearance, i.e. the usage of a different color instead of a change in
size.
alphanum.sty
, beamer.cls
, booktabs.sty
,
captcont.sty
, emp.sty
, paralist.sty
,
subfigure.sty
and units.sty
/nicefrac.sty
was added.
Credits go to the authors mentioned in the respective AUCTeX style
files.
LaTeX-includegraphics-options-alist
.
LaTeX-default-position
is nil
, don’t prompt for
position arguments in Tabular-like
environments, see Tabular-like.
font-latex-quotes
.
font-latex-match-function-keywords
,
font-latex-match-reference-keywords
,
font-latex-match-variable-keywords
and
font-latex-match-warning-keywords
.
LaTeX-german-open-quote
,
LaTeX-german-close-quote
and
LaTeX-german-quote-after-quote
instead of TeX-open-quote
,
TeX-close-quote
and TeX-quote-after-quote
if you want to
influence the type of quote insertion.
TeX-output-view-style
.
TeX-insert-macro
(C-c RET) ask for
all optional arguments by customizing the variable
TeX-insert-macro-default-style
, Completion.
TeX-run-discard
is now able to completely detach a process that
it started.
autoconf
making installing AUCTeX a mostly automatic process. See
Installation and Installation under MS Windows
for details.
comment-region
now inserts %% by default.
Suggested by "Davide G. M. Salvetti" <salve@debian.org>.
TeX-install-font-lock
for this.
LaTeX-top-caption-list
specifies environments
where the caption should go at top.
Contributed by ataka@milk.freemail.ne.jp (Masayuki Ataka).
See the file history.texi for older changes.
Next: FAQ, Previous: Changes, Up: Appendices [Contents][Index]
The following sections describe future development of AUCTeX. Besides mid-term goals, bug reports and requests we cannot fix or honor right away are being gathered here. If you have some time for Emacs Lisp hacking, you are encouraged to try to provide a solution to one of the following problems. If you don’t know Lisp, you may help us to improve the documentation. It might be a good idea to discuss proposed changes on the mailing list of AUCTeX first.
• Mid-term Goals | ||
• Wishlist | ||
• Bugs |
Next: Wishlist, Up: Development [Contents][Index]
As of AUCTeX 11.81 preview-latex is a part of AUCTeX in the sense that the installation routines were merged and preview-latex is being packaged with AUCTeX.
Further integration will happen at the backend. This involves folding of error parsing and task management of both packages which will ease development efforts and avoid redundant work.
Currently, the help for errors is more or less hardwired into tex.el. For supporting error help in other languages, it would be sensible to instead arrange error messages in language-specific files, make a common info file from all such catalogs in a given language and look the error texts up in an appropriate index. The user would then specify a preference list of languages, and the errors would be looked up in the catalogs in sequence until they were identified.
Macro cross references should also be usable for document navigation using RefTeX.
Next: Bugs, Previous: Mid-term Goals, Up: Development [Contents][Index]
A parser could gather information about which macros are defined in
which LaTeX packages and store the information in a hashtable which
can be used in a backend for TeX-doc
in order to open the
matching documentation for a given macro. The information could also be
used to insert an appropriate ‘\usepackage’ statement if the user
tries to insert a macro for which the respective package has not been
requested yet.
Fringe indicators for errors in the main text would be nice.
A separate frame with a table of math character graphics to click on in order to insert the respective sequence into the buffer (cf. the “grid” of x-symbol).
It would be nice if you could index process your favorite collection of .dtx files (such as the LaTeX source), just call a command on arbitrary control sequence, and get either the DVI viewer opened right at the definition of that macro (using Source Specials), or the source code of the .dtx file.
For starters, LaTeX-math-mode
is not very LaTeX-specific in
the first place, and similar holds for indentation and formatting.
\usepackage
in the preamble.
There should probably be a ‘none’ value which wouldn’t query for the master, but instead disable all features that relies on TeX-master.
This default value for TeX-master could then be controled with mapping based on the extension.
TeX-font-list
.
TeX-command-default
should be set from the master file, if not
set locally. Suggested by Peter Whaite ‘<peta@cim.mcgill.ca>’.
We need a list of what can safely be done in an ordinary style hook. You can not set a variable that AUCTeX depends on, unless AUCTeX knows that it has to run the style hooks first.
Here is the start of such a list.
LaTeX-add-environments
TeX-add-symbols
LaTeX-add-labels
LaTeX-add-bibliographies
LaTeX-largest-level
At least, support headers, trailers, as well as TeX-outline-extra.
TeX-header-start
and TeX-trailer-end
.
We might want these, just for fun (and outlines)
We should have a way to globally specify the default value of the header and trailer regexps.
TeX-mode
keybindings.
A third initialization file (tex-mode.el) containing an emulator
of the standard TeX-mode
would help convince some people to
change to AUCTeX.
TeX-error-list
to remember buffer positions in
order to be more robust with regard to line numbers and changed files.
Previous: Wishlist, Up: Development [Contents][Index]
LaTeX-math-mode
. and
simply self insert if not in a math context.
TeX-insert-dollar
more robust. Currently it can be fooled
by ‘\mbox’’es and escaped double dollar for example.
Next: Texinfo mode, Previous: Development, Up: Appendices [Contents][Index]
Well, you might have guessed it, the first place to look is in the available documentation packaged with AUCTeX. This could be the release notes (in the RELEASE file) or the news section of the manual in case you are experiencing problems after an upgrade, the INSTALL file in case you are having problems with the installation, the section about bugs in the manual in case you encountered a bug or the relevant sections in the manual for other related problems.
If this did not help, you can send a bug report to the AUCTeX bug reporting list by using the command M-x TeX-submit-bug-report RET. But before you do this, you can try to get more information about the problem at hand which might also help you locate the cause of the error yourself.
First, you can try to generate a so-called backtrace which shows the functions involved in a program error. In order to do this, start Emacs with the command line ‘emacs --debug-init’ and/or put the line
(setq debug-on-error t)
as the first line into your init file. After Emacs has started, you can load a file which triggers the error and a new window should pop up showing the backtrace. If you get such a backtrace, please include it in the bug report.
Second, you can try to figure out if something in your personal or site configuration triggers the error by starting Emacs without such customizations. You can do this by invoking Emacs with the command line ‘emacs -q -no-site-file -l auctex’. The ‘-l’ option ‘auctex.el’ which you normally do in your init file. After you have started Emacs like this, you can load the file triggering the error. If everything is working now, you know that you have to search either in the site configuration file or your personal init file for statements related to the problem.
AUCTeX was tested with GNU Emacs 24. Older versions may work but are unsupported.
./configure
does not find programs like latex?
This is problem often encountered on Windows. Make sure that the
PATH
environment variable includes the directories containing the
relevant programs, as described in
Installation under MS Windows in the AUCTeX manual.
It must be enabled first, insert this in your init file:
(setq-default TeX-master nil) (setq TeX-parse-self t) (setq TeX-auto-save t)
Read also the chapters about parsing and multifile documents in the manual.
TeX-save-document
work?
TeX-check-path
has to contain "./" somewhere.
For various reasons, AUCTeX ignores the extension when it stores information about a file, so you should use unique base names for your files. E.g. rename foo.bib to foob.bib.
If the message in the minibuffer stays "Type ‘C-c C-l’ to display
results of compilation.", you probably have a misconfiguration in your
init file (.emacs, init.el or similar). To track this
down either search in the ‘*Messages*’ buffer for an error message
or put (setq debug-on-error t)
as the first line into your init
file, restart Emacs and open a LaTeX file. Emacs will complain
loudly by opening a debugging buffer as soon as an error occurs. The
information in the debugging buffer can help you find the cause of the
error in your init file.
TeX-next-error
(C-c `) fail?
If TeX-file-line-error
is set to nil (not the default), these
sort of failures might be related to the the fact that when writing the
log file, TeX puts information related to a file, including error
messages, between a pair of parentheses. In this scenario AUCTeX
determines the file where the error happened by parsing the log file and
counting the parentheses. This can fail when there are other,
unbalanced parentheses present.
Activating so-called file:line:error messages for the log file usually
solves this issue, as these kind of messages are are easier to parse;
however, they may lack some details. Activation can be done either in
the configuration of your TeX system (consult its manual to see where
this is) or by simply keeping the variable TeX-file-line-error
to
the default value of non-nil.
AUCTeX came into being at Aalborg University in Denmark. Back then the Danish name of the university was Aalborg Universitetscenter; AUC for short.
Previous: FAQ, Up: Appendices [Contents][Index]
AUCTeX includes a major mode for editting Texinfo files. This major mode is not the same mode as the native Texinfo mode (see (texinfo)Texinfo Mode) of Emacs, although they have the same name. However, AUCTeX still relies on a number of functions from the native Texinfo mode.
The following text describes which functionality is offered by AUCTeX and which by the native Texinfo mode. This should enable you to decide when to consult the AUCTeX manual and when the manual of the native mode. And in case you are a seasoned user of the native mode, the information should help you to swiftly get to know the AUCTeX-specific commands.
• Exploiting | How AUCTeX and the native mode work together | |
• Superseding | Where the native mode is superseded | |
• Mapping | Where key bindings are mapped to the native mode | |
• Unbinding | Which native mode key bindings are missing |
Next: Superseding, Up: Texinfo mode [Contents][Index]
In a nutshell the split between AUCTeX Texinfo mode, and native Texinfo mode is as follows:
Next: Mapping, Previous: Exploiting, Up: Texinfo mode [Contents][Index]
This section is directed to users of the native Texinfo mode switching to AUCTeX. It follows the summary of the native mode (see (texinfo)Texinfo Mode Summary) and lists which of its commands are no longer of use.
In the native Texinfo mode, frequently used Texinfo commands can be inserted with key bindings of the form C-c C-c k where k differs for each Texinfo command; c inserts @code, d inserts @dfn, k @kbd, etc.
In AUCTeX commands are inserted with the key binding C-c C-m
instead which prompts for the macro to be inserted. For font selection
commands (like @b, @i, or @emph) and a few related ones (like @var,
@key or @code) there are bindings which insert the respective macros
directly. They have the form C-c C-f k
or C-c C-f
C-k
and call the function TeX-font
. Type C-c C-f
RET to get a list of supported commands.
Note that the prefix argument is not handled the same way by AUCTeX.
Note also that the node insertion command from the native mode
(texinfo-insert-@node
) can still accessed from the Texinfo menu
in AUCTeX.
In AUCTeX braces can be inserted with the same key binding as in the
native Texinfo mode: C-c {. But AUCTeX uses its own function
for the feature: TeX-insert-braces
.
The native Texinfo mode does not insert full environments. Instead, it
provides the function texinfo-insert-@end
(mapped to C-c
C-c e) for closing an open environment with a matching @end statement.
In AUCTeX you can insert full environments, i.e. both the opening and
closing statements, with the function Texinfo-environment
(mapped
to C-c C-e).
In the native Texinfo mode there are various functions and bindings to
format a region or the whole buffer for info or to typeset the
respective text. For example, there is makeinfo-buffer
(mapped
to C-c C-m C-b) which runs ‘makeinfo’ on the buffer or there
is texinfo-tex-buffer
(mapped to C-c C-t C-b) which runs
TeX on the buffer in order to produce a DVI file.
In AUCTeX different commands for formatting or typesetting can be
invoked through the function TeX-command-master
(mapped to
C-c C-c). After typing C-c C-c, you can select the desired
command, e.g ‘Makeinfo’ or ‘TeX’, through a prompt in the mini
buffer. Note that you can make, say ‘Makeinfo’, the default by
adding this statement in your init file:
(add-hook 'Texinfo-mode-hook (lambda () (setq TeX-command-default "Makeinfo")))
Note also that C-c C-c Makeinfo RET is not completely
functionally equivalent to makeinfo-buffer
as the latter will
display the resulting info file in Emacs, showing the node corresponding
to the position in the source file, just after a successful compilation.
This is why, while using AUCTeX, invoking makeinfo-buffer
might still be more convenient.
Note also that in the case of a multifile document, C-c C-c in
AUCTeX will work on the whole document (provided that the file
variable TeX-master
is set correctly), while
makeinfo-buffer
in the native mode will process only the current
buffer, provided at the @setfilename
statement is provided.
The native Texinfo mode provides the binding C-c C-t C-i
(texinfo-texindex
) for producing an index and the bindings
C-c C-t C-p (texinfo-tex-print
) and C-c C-t C-q
(tex-show-print-queue
) for printing and showing the printer
queue. These are superseded by the respective commands available
through C-c C-c (TeX-command-master
) in AUCTeX: Index,
Print, and Queue.
The command C-c C-t C-k (tex-kill-job
) in the native mode
is superseded by C-c C-k (TeX-kill-job
) in AUCTeX.
Next: Unbinding, Previous: Superseding, Up: Texinfo mode [Contents][Index]
This node follows the native Texinfo mode summary (see (texinfo)Texinfo Mode Summary) and lists only those commands to which AUCTeX provides a keybinding.
Basically all commands of the native mode related to producing menus and interlinking nodes are mapped to same or similar keys in AUCTeX, while a few insertion commands are mapped to AUCTeX-like keys.
@item
insertionThe binding C-c C-c i for the insertion of @item
in the
native mode is mapped to M-RET or C-c C-j in
AUCTeX, similar to other AUCTeX modes.
@end
insertionThe binding C-c C-c e for closing a @foo
command by
a corresponding @end foo
statement in the native mode is
mapped to C-c C-] in AUCTeX, similar to other AUCTeX modes.
The binding C-} (up-list
) is available both in the native
mode and in AUCTeX. (This is because the command is not implemented
in either mode but a native Emacs command.) However, in AUCTeX, you
cannot use C-] for this, as it is used for @end
insertion.
The bindings C-c C-u C-n (texinfo-update-node
) and C-c
C-u C-e (texinfo-every-node-update
) from the native mode are
available in AUCTeX as well.
The bindings C-c C-u m (texinfo-master-menu
), C-c C-u
C-m (texinfo-make-menu
), and C-c C-u C-a
(texinfo-all-menus-update
) from the native mode are available in
AUCTeX as well. The command texinfo-start-menu-description
,
bound to C-c C-c C-d in the native mode, is bound to C-c C-u
C-d in AUCTeX instead.
Previous: Mapping, Up: Texinfo mode [Contents][Index]
The following commands from the native commands might still be useful when working with AUCTeX, however, they are not accessible with a key binding any longer.
@node
insertionThe node insertion command, mapped to C-c C-c n in the native mode, is not mapped to any key in AUCTeX. You can still access it through the Texinfo menu, though. Another alternative is to use the C-c C-m binding for macro insertion in AUCTeX.
The command texinfo-show-structure
(C-c C-s) from the
native mode does not have a key binding in AUCTeX. The binding is
used by AUCTeX for sectioning.
Previous: Mapping, Up: Texinfo mode [Contents][Index]