Tidy up char 127
[latex2e.git] / trunk / doc / ltx3info.tex
blobe0aabafba498360d2af53e12c86b827c5b63035c
1 % \iffalse meta-comment
3 % Copyright 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009
4 % The LaTeX3 Project and any individual authors listed elsewhere
5 % in this file.
6 %
7 % This file is part of the LaTeX base system.
8 % -------------------------------------------
9 %
10 % It may be distributed and/or modified under the
11 % conditions of the LaTeX Project Public License, either version 1.3c
12 % of this license or (at your option) any later version.
13 % The latest version of this license is in
14 % http://www.latex-project.org/lppl.txt
15 % and version 1.3c or later is part of all distributions of LaTeX
16 % version 2005/12/01 or later.
18 % This file has the LPPL maintenance status "maintained".
20 % The list of all files belonging to the LaTeX base distribution is
21 % given in the file `manifest.txt'. See also `legal.txt' for additional
22 % information.
24 % The list of derived (unpacked) files belonging to the distribution
25 % and covered by LPPL is defined by the unpacking scripts (with
26 % extension .ins) which are part of the distribution.
28 % \fi
29 \documentclass[a4paper]{article}
31 % Commands and environments:
33 \newcommand{\eg}{e.g.~}
34 \newcommand{\ie}{i.e.~}
37 \newenvironment{citations}{%
38 \list{}{%
39 \renewcommand{\makelabel}[1]{\normalfont\itshape ##1}%
41 }{%
42 \endlist
45 % Some logos:
47 \newcommand{\NFSS}{NFSS}
49 \newcommand{\LaTeXNews}{\LaTeX~News}
51 \newcommand{\AW}{Addison Wesley}
53 \newcommand{\SGML}{{\sc SGML}}
54 \newcommand{\DSSSL}{{\sc DSSSL}}
55 \newcommand{\HTML}{{\sc HTML}}
56 \newcommand{\XML}{{\sc XML}}
57 \newcommand{\PDF}{{\sc PDF}}
59 \newcommand{\PS}{{\sc Post\-Script}}
61 \newcommand{\AmSTeX}{$\mathcal A$\lower.4ex\hbox{$\!\mathcal
62 M\!$}$\mathcal S$-\TeX}
63 \newcommand{\AmSLaTeX}{$\mathcal A$\lower.4ex\hbox{$\!\mathcal
64 M\!$}$\mathcal S$-\LaTeX}
65 \newcommand{\MF}{{\sc Meta\-font}}
67 % sections
69 \setcounter{secnumdepth}{-2}
71 % Front matter:
73 \title{\Large The \LaTeX3 Project}
75 \author{\copyright 1995--1999 \
76 Frank Mittelbach and
77 Chris Rowley}
79 \date{12 January 1999}
81 \begin{document}
83 \thispagestyle{empty}
85 \maketitle
87 \begin{abstract}
88 This article describes the motivation, achievements and future of
89 the \LaTeX3 Project, which was established to produce a new version
90 of \LaTeX{}, the widely-used and highly-acclaimed document
91 preparation system. It also describes how you can help us to
92 achieve our aims.\\[2pt]
93 \textbf{For Archive maintainers, Authors, Publishers and
94 Distributors:}\\
95 The project team request that, whenever possible, you include this
96 article in any of the following:
97 \begin{itemize}
98 \item Books about \TeX{} and \LaTeX{}.
99 \item Instructions for authors on using \LaTeX{}.
100 \item The printed documentation of CD-ROM collections that contain
101 \LaTeX.
102 \item On-line collections that include a significant proportion of
103 documents encoded in \LaTeX.
104 \end{itemize}
105 \end{abstract}
107 \section{Outline}
109 The purposes of the \LaTeX3 system can be summarized thus: it will
110 greatly increase the range of documents which can be processed; and it
111 will provide a flexible interface for typographic designers to easily
112 specify the formatting of a class of documents.
114 The \LaTeX3 Project Team is a small group of volunteers whose aim is
115 to produce this major new document processing system based on the
116 principles pioneered by Leslie Lamport in the current \LaTeX.
118 The major visible work of the team before 1997 was the development of
119 the current \emph{standard} version of \LaTeX{}. This was first
120 released in 1994 and has since then been actively maintained and
121 enhanced by extensions to that core system. They will continue to
122 develop and maintain this system, releasing updated versions every six
123 months and recording these activities in the \LaTeX{} bugs database
124 (see below).
126 Although \LaTeX{} may be distributed freely, the production and
127 maintenance of the system does require expenditure of reasonably large
128 sums of money. The \LaTeX3 Project Fund has therefore been set up to
129 channel money into this work. We know that some users are
130 aware of this fund as they have already contributed to it---many
131 thanks to all of them! If you want to know more about how you can
132 help the project, see Page \pageref{fund}---and thanks in advance for
133 your generosity in the future.
136 \section{Background}
138 With \TeX{}, Knuth designed a formatting system that is able to
139 produce a large range of documents typeset to extremely high quality
140 standards. For various reasons (\eg quality, portability, stability
141 and availability) \TeX{} spread very rapidly and can nowadays be best
142 described as a world-wide de facto standard for high quality
143 typesetting. Its use is particularly common in specialized areas, such
144 as technical documents of various kinds, and for multi-lingual
145 requirements.
147 The \TeX{} system is fully programmable. This allows the development
148 of high-level user interfaces whose input is processed by \TeX{}'s
149 interpreter to produce low-level typesetting instructions; these are
150 input to \TeX{}'s typesetting engine which outputs the format of each
151 page in a device-independent page-description language. The \LaTeX{}
152 system is such an interface; it was designed to support the needs of
153 long documents such as textbooks and manuals. It separates content and
154 form as much as possible by providing the user with a generic (\ie
155 logical rather than visual) mark-up interface; this is combined with
156 style sheets which specify the formatting.
158 Recent years have shown that the concepts and approach of \LaTeX{} are
159 now widely accepted. Indeed, \LaTeX{} has become the standard method
160 of communicating and publishing documents in many academic
161 disciplines. This has led to many publishers accepting \LaTeX{}
162 source for articles and books; and the American Mathematical Society
163 now provides a \LaTeX{} package making the features of \AmSTeX{}
164 available to all users of \LaTeX{}. Its use has also spread into many
165 other commercial and industrial environments, where the technical
166 qualities of \TeX{} together with the concepts of \LaTeX{} are
167 considered a powerful combination of great importance to such areas as
168 corporate documentation and publishing. This has also extended to
169 on-line publishing using, for example, \PDF{} output incorporating
170 hypertext and other active areas.
172 With the spreading use of \SGML{}-compliant systems (\eg Web-based
173 publishing using \HTML{} or \XML{}) \TeX{} again is a common choice as
174 the formatting engine for high quality typeset output: a widely used
175 such system is {\em The Publisher\/} from ArborText, whilst a more
176 recent development is the object-oriented document editor Grif. The
177 latter is used for document processing in a wide range of industrial
178 applications; it has also been adopted by the Euromath consortium as
179 the basis of their mathematician's workbench, one of the most advanced
180 of the emerging project-oriented user environments. Typeset output
181 from \SGML{}-coded documents in these systems is obtained by
182 translation into \LaTeX{}, which will therefore soon also be a natural
183 choice for the output of \DSSSL-compliant systems.
185 Because a typical \SGML{} Document Type Definition (DTD) uses concepts
186 similar to those of \LaTeX{}, the formatting is often implemented by
187 simply mapping document elements to \LaTeX{} constructs rather than
188 directly to `raw \TeX'.
189 This enables the
190 sophisticated analytical techniques built into the \LaTeX{}
191 software to be exploited; and it avoids the need to program in \TeX{}.
193 \section{Motivation}
195 This increase in the range of applications of \LaTeX{} has highlighted
196 certain limitations of the current system, both for authors of
197 documents and for designers of formatting styles.
199 In addition to the need to extend the variety of classes of document
200 which can be processed by \LaTeX{}, substantial enhancements are
201 necessary in, at least, the following areas:
202 \begin{itemize}
203 \item
204 the command syntax (attributes, short references, etc);
205 \item
206 the layout specification interface (style design);
207 \item
208 the level of robustness (error recovery, omitted tags);
209 \item
210 the extendibility (package interface);
211 \item
212 the layout specification of tabular material;
213 \item
214 the specification and inclusion of graphical material;
215 \item
216 the positioning of floating material, and other aspects of page
217 layout;
218 \item
219 the requirements of hypertext systems.
220 \end{itemize}
222 Further analysis of these deficiencies has shown that some of the
223 problems are to be found in \LaTeX{}'s internal concepts and design.
224 This project to produce a new version therefore involves thorough
225 research into the challenges posed by new applications and by the use
226 of \LaTeX{} as a formatter for a wide range of documents, \eg \SGML{}
227 documents; on-line \PDF{} documents with hypertext links.
229 This will result in a major re-implementation of large parts of the
230 system. Some of the results of such rethinking of the fundamentals
231 are already available in Standard \LaTeX{}, notably in the following
232 areas:
234 \begin{itemize}
235 \item Font declaration and selection;
236 \item Font and glyph handling within mathematical formulas;
237 \item Handling multiple font glyph encodings within a document;
238 \item Allowing multiple input character encodings within a document;
239 \item A uniform interface for graphics inclusion;
240 \item Support for coloured text;
241 \item Building and interfacing new classes and extension packages.
242 \end{itemize}
245 \section{Description}
247 The strengths of the present version of \LaTeX{} are
248 as follows:
249 \begin{itemize}
250 \item excellent standard of typesetting for text, technical
251 formulas\\
252 and tabular material;
253 \item separation of generic mark-up from visual formatting;
254 \item ease of use for authors;
255 \item portability of documents over a wide range of platforms;
256 \item adaptability to many languages;
257 \item widespread and free availability;
258 \item reliable support and maintenance by the \LaTeX3 project team.
259 \end{itemize}
260 These will be preserved and in many cases greatly enhanced by the new
261 version which is being developed to fulfill the following requirements.
262 \begin{itemize}
263 \item
264 It will provide a syntax that allows highly automated translation
265 from popular \SGML{} DTDs into \LaTeX{} document classes (these
266 will be provided as standard with the new version).
268 The syntax of the new \LaTeX{} user-interface will, for example,
269 support the \SGML{} concepts of `entity', `attribute' and `short
270 reference' in such a way that these can be directly linked to the
271 corresponding \SGML{} features.
273 \item
274 It will support hypertext links and other features required for
275 on-line structured documents using, for example, \HTML{} and \XML{}.
277 \item
278 It will provide a straightforward style-designer interface to support
279 both the specification of a wide variety of typographic requirements
280 and the linking of entities in the generic mark-up of a document to
281 the desired formatting. These two parts of the design process will
282 be clearly separated so that it is possible to specify different
283 layouts for the same DTD.
285 The language and syntax of this interface will be as natural as
286 possible for a typographic designer. As a result, this language
287 could easily be interfaced to a visually-oriented, menu-driven
288 specification system.
290 This interface will also support \DSSSL{} specifications and
291 style-sheet concepts such as those used with \HTML{} and \XML{}.
293 \item
294 It will provide an enhanced user-interface that allows expression of
295 the typesetting requirements from a large range of subject areas. Some
296 examples are listed here.
298 \begin{itemize}
299 \item The requirements of technical documentation (\eg offset layout,\\
300 change bars, etc).
301 \item The requirements of academic publishing in the humanities\\
302 (critical text editions, etc).
303 \item The requirements of structural formulas in chemistry.
304 \item Advanced use of the mathematical-typesetting features of \TeX{}.
305 \item The integration of graphical features, such as shading,
306 within text.
307 \item the integration of hypertext and other links in on-line
308 documents using systems such as \HTML{}, \XML{} and \PDF{}.
310 \end{itemize}
312 Special care will be taken to ensure that this interface is
313 extensible: this will be achieved by use of modular designs.
316 \item
317 It will provide a more robust author-interface. For example,
318 artificial restrictions on the nesting of commands will be removed.
319 Error handling will be improved by adding
320 a more effective, interactive help system.
322 \item
323 It will provide access to arbitrary fonts from any family (such as
324 the \PS{} and TrueType fonts) including a wide range of fonts for
325 multi-lingual documents and the specialist glyphs required by
326 documents in various technical and academic areas.
328 \item
329 The new interfaces will be documented in detail and the
330 system will provide extensive catalogues of examples, carefully
331 designed to make the learning time for new users (both designers and
332 authors) as short as possible.
334 \item
335 The code itself will be thoroughly documented and it will be
336 designed on modular principles. Thus the system will be easy to
337 maintain and to enhance.
338 \end{itemize}
340 The resulting new \LaTeX{} will, like the present version, be usable
341 with any standard \TeX{} system (or whatever replaces it) and so will
342 be freely available on a wide range of platforms.
345 \section{\LaTeX{} documentation}
347 \begingroup
348 \setlength{\parindent}{0pt}
350 A complete description of Standard \LaTeX{} can be found in:
351 \begin{citations}
352 \item[\LaTeX: A Document Preparation System]
353 Leslie Lamport,\\ \AW, 2nd ed, 1994.
354 \item[The \LaTeX{} Companion]
355 Mittelbach, Goossens with Braams, Carlisle and Rowley,\\ \AW, 2nd ed, 2004.
356 \end{citations}
358 A recent addition to the publications closely associated with the
359 project is:
360 \begin{citations}
361 \item[The \LaTeX{} Graphics Companion]
362 Goossens, Mittelbach and Rahtz,\\ \AW, 1997.
363 \end{citations}
365 This \LaTeX{} distribution comes with documentation on several aspects
366 of of the system. The newer features of the system are described in
367 the following documents:
368 \begin{citations}
369 \item[\LaTeXe{} for authors]
370 describes the new features of \LaTeX{} documents,
371 in the file \texttt{usrguide.tex};
372 \item[\LaTeXe{} for class and package writers]
373 describes how to produce \LaTeX{} classes and packages,
374 in the file \texttt{clsguide.tex};
375 \item[\LaTeXe{} font selection]
376 describes the new features of \LaTeX{} fonts for
377 class and package writers,
378 in the file \texttt{fntguide.tex}.
379 \end{citations}
381 For further contacts and sources of information on \TeX{} and
382 \LaTeX{}, see the addresses on Page~\pageref{contacts}.
384 \endgroup
385 \pagebreak
388 \section{The \LaTeX3 Project Fund}
389 \label{fund}
391 Although \LaTeX{} may be distributed freely, the production and
392 maintenance of the system does require expenditure of reasonably large
393 sums of money. There are many necessities that need substantial
394 financing: examples are new or enhanced computing equipment and travel
395 to team meetings (the volunteers come from many different countries,
396 so getting together occasionally is a non-trivial exercise).
398 This is why we are appealing to you for contributions to the fund.
399 Any sum will be much appreciated; the amount need not be large as
400 small contributions add up to very useful amounts. Contributions of
401 suitable equipment and software will also be of great value. This
402 appeal is both to you as an individual author and to you as a member
403 of a group or as an employee: please encourage your department or your
404 employer to contribute towards sustaining our work.
406 We should like to see funded projects that make considerable use of
407 \LaTeX{} (\eg conferences and research teams who use it to publish
408 their work, and electronic research archives using it) include
409 contributions to this fund in their budgets. %% e-print systems
411 We are also asking commercial organisations to assess the benefits
412 they gain from using, or distributing, a well-supported \LaTeX{} and
413 to make appropriate contributions to the fund in order that we can
414 continue to maintain and improve the product. If you work for, or do
415 business with, such an organisation, please bring to the attention of
416 the relevant people the existence and needs of the project.
418 In particular, we ask that all the large number of organisations and
419 businesses that distribute \LaTeX{}, within other software or as part
420 of a CD-ROM collection, should consider pricing all products containing
421 \LaTeX{} at a level that enables them to make regular donations to the
422 fund from the profit on these items. We also ask all authors and
423 publishers of books about \LaTeX{} to consider donating part of the
424 royalties to the fund.
426 Contributions should be sent to one of the following addresses:
427 \begin{quote}\small\label{addrs}
428 \TeX{} Users Group, P.O. Box 2311, Portland, OR~97208-2311 USA\\
429 Fax:~+1~503~223~3960 \ Email: \texttt{tug@tug.org}
431 \noindent
432 UK TUG, 1 Eymore Close, Selly Oak, Birmingham B29~4LB UK\\
433 Fax: +44 121 476 2159 \ Email: \texttt{uktug-enquiries@tex.ac.uk}
434 \end{quote}
436 Cheques should be payable to the user group (TUG or UKTUG) and be
437 clearly marked as contributions to the \LaTeX3 fund.
438 Many thanks to all of you who have contributed in the past and thanks
439 in advance for your generosity in the future.
441 \section{Contacts and information}
442 \label{contacts}
444 In addition to the sources mentioned above, \LaTeX{} has its home page
445 on the World Wide Web at:
446 \begin{verbatim}
447 http://www.latex-project.org/
448 \end{verbatim}
449 This page describes \LaTeX{} and the \LaTeX3 project, and contains
450 pointers to other \LaTeX{} resources, such as the user guides, the
451 \TeX{} Frequently Asked Questions, and the \LaTeX{} bugs database.
453 More general information, including contacts for local User Groups,
454 can be accessed via:
455 \begin{verbatim}
456 http://www.tug.org/
457 \end{verbatim}
459 The electronic home of anything \TeX-related is the Comprehensive
460 \TeX{} Archive Network (CTAN). This is a network of cooperating ftp
461 sites, with over a gigabyte of \TeX{} material:
462 \begin{verbatim}
463 ftp://cam.ctan.org/tex-archive/
464 ftp://dante.ctan.org/tex-archive/
465 ftp://tug.ctan.org/tex-archive/
466 \end{verbatim}
468 For more information, see the \LaTeX{} home page.
471 \end{document}