summaryrefslogtreecommitdiff
path: root/info/beginlatex/html/foreword.html
blob: 728e5650b3810a269c2d5e495d213b1c27482673 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<!DOCTYPE html
  PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "/dtds/html4t.dtd">

<!--Generated from beginlatex.XML.xml with typebook-html.xslt on 2005-04-04T01:01:55--><html>
   <head>
      <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   
      <title>Formatting information: Foreword</title>
      <link rel="stylesheet" href="typebook.css" type="text/css">
      <meta http-equiv="Content-Style-Type" content="text/css">
   </head>
   <body>
      <table width="100%">
         <tr>
            <th class="title" width="66%">
               <h1><a name="doctitle">Formatting information</a></h1>
               <h2>A beginner's introduction to typesetting with
                  <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span></h2>
               <h3>Foreword</h3>
               <h3>Peter Flynn</h3>
               <h4>Silmaril Consultants<br>Textual Therapy Division
               </h4><br>v. 3.6 (March 2005)
            </th>
            <td class="toc" width="33%">
               <h4><a name="doctoc">Contents</a></h4>
               <dl>
                  <dd class=""><a href="intro.html#intro">Introduction</a></dd>
                  <dd class="current"><a href="foreword.html#foreword">Foreword</a></dd>
                  <dd class=""><a href="preface.html#preface">Preface</a></dd>
               </dl>
               <ol>
                  <li class=""><a href="chapter1.html#get">Installing <span class="TEX">T<span class="E">E</span>X</span> and <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span></a></li>
                  <li class=""><a href="chapter2.html#plaintext">Using your editor to create documents</a></li>
                  <li class=""><a href="chapter3.html#basic">Basic document structures</a></li>
                  <li class=""><a href="chapter4.html#process">Typesetting, viewing and printing</a></li>
                  <li class=""><a href="chapter5.html#ctan">CTAN, packages, and online help</a></li>
                  <li class=""><a href="chapter6.html#otherdoc">Other document structures</a></li>
                  <li class=""><a href="chapter7.html#texttools">Textual tools</a></li>
                  <li class=""><a href="chapter8.html#typo">Fonts and layouts</a></li>
                  <li class=""><a href="chapter9.html#macros">Programmability (macros)</a></li>
                  <li class=""><a href="chapter10.html#compat">Compatibility with other systems</a></li>
               </ol>
               <ol type="A">
                  <li class=""><a href="appendixA.html#cnf">Configuring <span class="TEX">T<span class="E">E</span>X</span> search paths</a></li>
                  <li class=""><a href="appendixB.html#tugform"><span class="TEX">T<span class="E">E</span>X</span> Users Group membership</a></li>
                  <li class=""><a href="appendixC.html#asciicharset">The ASCII character set</a></li>
                  <li class=""><a href="appendixD.html#gfdl">GNU Free Documentation License</a></li>
               </ol>
               <dl>
                  <dd class=""><a href="bibliography.html#biblio">References</a></dd>
                  <dd class=""><a href="index.html#index">Index</a></dd>
               </dl>
            </td>
         </tr>
         <tr>
            <td class="credits">
               <p>This edition of <cite>Formatting
                     	  Information</cite> was prompted by the generous help I
                  	have received from <span class="TEX">T<span class="E">E</span>X</span> users too numerous to mention
                  	individually. Shortly after TUGboat published the November
                  	2003 edition, I was reminded by a spate of email of the
                  	fragility of documentation for a system like <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> which is
                  	constantly under development. There have been revisions to
                  	packages; issues of new distributions, new tools, and new
                  	interfaces; new books and other new documents; corrections to
                  	my own errors; suggestions for rewording; and in one or two
                  	cases mild abuse for having omitted package X which the author
                  	felt to be indispensable to users. &para;&nbsp;I am grateful as always to the people who sent me
                  	corrections and suggestions for improvement. Please keep them
                  	coming: only this way can this book reflect what people
                  	want to learn. The same limitation still applies, however: no
                  	mathematics, as there are already a dozen or more excellent
                  	books on the market&nbsp;&#8212; as well as other online
                  	documents&nbsp;&#8212; dealing with mathematical typesetting in
                  <span class="TEX">T<span class="E">E</span>X</span> and <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> in finer and better detail than I am
                  	capable of. &para;&nbsp;The structure remains the same, but I have revised and
                  	rephrased a lot of material, especially in the earlier
                  	chapters where a new user cannot be expected yet to have
                  	acquired any depth of knowledge. Many of the screenshots have
                  	been updated, and most of the examples and code fragments have
                  	been retested. &para;&nbsp;As I was finishing this edition, I was asked to review
                  	an article for <cite><a href="http://www.tug.org/pracjourn/" name="C3">The Prac<span class="TEX">T<span class="E">E</span>X</span> Journal</a></cite>, which
                  	grew out of the Practical <span class="TEX">T<span class="E">E</span>X</span> Conference in 2004. The
                  	author specifically took the writers of documentation to task
                  	for failing to explain things more clearly, and as I read
                  	more, I found myself agreeing, and resolving to clear up some
                  	specific problems areas as far as possible. It is very
                  	difficult for people who write technical documentation to
                  	remember how they struggled to learn what has now become a
                  	familiar system. So much of what we do is second nature, and a
                  	lot of it actually has nothing to do with the software, but
                  	more with the way in which we view and approach information,
                  	and the general level of knowledge of computing. If I have
                  	obscured something by making unreasonable assumptions about
                  	<em>your</em> knowledge, please let me know so
                  	that I can correct&nbsp;it. 
                  <p>Peter Flynn is author of <cite><a href="bibliography.html#htmlbook" name="C4">The HTML Handbook</a></cite> and <cite><a href="bibliography.html#sgmltools" name="C5">Understanding SGML and XML Tools</a></cite>, and editor of <cite><a href="http://www.ucc.ie/xml/" name="C6">The XML FAQ</a></cite>.
                  </p>
               </p>
            </td>
            <td class="legal">
               <p>
                  <p>This document is Copyright &copy; 1999&#8211;2005 by
                     Silmaril Consultants under the terms of what is now the GNU
                     Free Documentation License (copyleft).
                  </p>
                  <p>Permission is granted to copy, distribute and/or modify
                     this document under the terms of the GNU Free Documentation
                     License, Version 1.2 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 <cite><a href="http://www.fsf.org/copyleft/fdl.html" name="C1">The GNU Free Documentation License</a></cite>.
                  </p>
                  <p>You are allowed to distribute, reproduce, and modify it
                     without fee or further requirement for consent subject to the
                     conditions in <a href="appendixD.html#gfdl-4">section D.5</a>. The author has
                     asserted his right to be identified as the author of this
                     document. If you make useful modifications you are asked to
                     inform the author so that the master copy can be updated. See
                     the full text of the License in <a href="appendixD.html#gfdl">Appendix D</a>.
                     
                  </p>
               </p>
            </td>
         </tr>
      </table>
      <div class="prelim">
         <h3><a href="#doctoc"><img src="up.png" title="Table of Contents" width="32" alt="ToC" align="right" border="0"></a><a name="foreword">Foreword</a></h3>
         <p>As noted in <a href="intro.html#intro">this Introduction</a>,
            this document accompanies a two-day introductory training course.
            It became obvious from repeated questions in class and
            afterwards, as well as from general queries on <a href="news:comp.text.tex"><tt>comp.text.tex</tt></a> that many people do
            not read the <small><a href="chapter5.html#FAQ" class="acroref" name="A32" title="Frequently-Asked Questions">FAQ</a></small>s, do not use the
            <small><a href="appendixB.html#TUG" class="acroref" name="A33" title="Users Group">TUG</a></small> web site, do not buy the books and
            manuals, do not use the newsgroups and mailing lists, and do not
            download the free documentation. Instead, they try to get by
            using the training technique known as &#8216;sitting by
            Nelly&#8217;, which involves looking over a
            colleague's shoulder in the office, lab, library, pub, or
            classroom, and absorbing all his or her bad habits.
         </p>
         <p>In the summer of 2001 I presented a short proposal on the
            marketing of <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> to the annual conference of the <span class="TEX">T<span class="E">E</span>X</span> Users
            Group held at the University of Delaware, and showed an example
            of a <a href="http://www.silmaril.ie/documents/latex-brochure/leaflet.pdf">draft 
               brochure</a> designed to persuade newcomers to try <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span>
            for their typesetting requirements. As a result of questions and
            suggestions, it was obvious that it needed to include a pointer
            to some documentation, and I agreed to make available a revised
            form of this document, expanded to be used outside the
            classroom, and to include those topics on which I have had most
            questions from users over the years.
         </p>
         <p>It turned out to mean a significant
            reworking of a lot of the material. Some of it appears in almost
            every other manual and book on <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> but it is essential to
            the beginner and therefore bears repetition. Some of it appears
            other forms elsewhere, and is included here because it needs
            explaining better. And some of it appears nowhere else but this
            document. I took the opportunity to revise the structure of the
            training course in parallel with the book (expanding it from its
            original one day to two days), and to include a more
            comprehensive index. It is by no means perfect (in both senses),
            and I would be grateful for comments and corrections to be sent
            to me at the address given under the credits.
         </p>
         <p>I had originally hoped that the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> version of the
            document would be processable by any freshly-installed default
            <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> system, but the need to include font samples which go
            well beyond the default installation, and to use some packages
            which the new user is unlikely to have installed, means that
            this document itself is not really a simple piece of <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span>,
            however simply it may describe the process itself.
         </p>
         <p>However, as the careful reader will have already noticed,
            the master source of the document is not maintained in <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span>
            but in <small><a href="chapter10.html#XML" class="acroref" name="A34" title="Extensible Markup Language">XML</a></small>. A future task is therefore
            to compare the packages required with those installed by
            default, and flag portions of the document requiring additional
            features so that an abbreviated version can be generated which
            can be guaranteed to process even with a basic <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span>
            installation.
         </p>
         <p><a name="docs"></a>If you are just starting with <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span>, at an early
            opportunity you should buy or borrow a copy of <cite><a href="bibliography.html#latexbook" name="C15"><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span>: A Document Preparation System</a></cite> which is the original
            author's manual. More advanced users should get the
            <cite><a href="bibliography.html#companion" name="C16">The <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> Companion</a></cite> or one of its
            successors. In the same series there are also the <cite><a href="bibliography.html#graphicscomp" name="C17">The <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> Graphics Companion</a></cite> and the <cite><a href="bibliography.html#webcomp" name="C18">The <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> Web Companion</a></cite>. Mathematical users might want to
            read <cite><a href="http://www.ams.org/tex/short-math-guide.html" name="C19">Short Math Guide for <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span></a></cite>.
         </p>
      </div>
      <hr>
      <table width="100%">
         <tr>
            <td align="left"><a href="intro.html"><img src="previous.png" alt="Previous" border="0"></a></td>
            <td align="center"><a href="#doctoc"><img src="top.png" alt="Top" border="0"></a></td>
            <td align="right"><a href="preface.html"><img src="next.png" alt="Next" border="0"></a></td>
         </tr>
      </table>
   </body>
</html>