| 1 |
Hi, |
| 2 |
|
| 3 |
Welcome to the beginnings of Tufte LaTeX package to help you |
| 4 |
produce Tufte-style handouts, reports, and notes. |
| 5 |
|
| 6 |
== Quick Start |
| 7 |
|
| 8 |
Try typesetting sample-handout.tex with the following sequence |
| 9 |
of commands, |
| 10 |
|
| 11 |
pdflatex sample-handout |
| 12 |
bibtex sample-handout |
| 13 |
pdflatex sample-handout |
| 14 |
pdflatex sample-handout |
| 15 |
|
| 16 |
The result should look like sample-handout.pdf. |
| 17 |
|
| 18 |
The sample book can be compiled with the following: |
| 19 |
|
| 20 |
pdflatex sample-book |
| 21 |
bibtex sample-book |
| 22 |
texindy --language english sample-book.idx |
| 23 |
# or makeindex sample-book.idx |
| 24 |
pdflatex sample-book |
| 25 |
pdflatex sample-book |
| 26 |
pdflatex sample-book |
| 27 |
|
| 28 |
== Troubleshooting |
| 29 |
|
| 30 |
If you encounter errors of the form, |
| 31 |
|
| 32 |
! LaTeX Error: File `paralist.sty' not found. |
| 33 |
|
| 34 |
you will need to obtain missing packages from CTAN <http://ctan.org>. |
| 35 |
For package installation instructions and answers to many other |
| 36 |
questions, see the UK TeX FAQ, |
| 37 |
|
| 38 |
http://www.tex.ac.uk/cgi-bin/texfaq2html?introduction=yes |
| 39 |
|
| 40 |
or search the news:comp.text.tex group via, |
| 41 |
|
| 42 |
http://groups.google.com/group/comp.text.tex |
| 43 |
|
| 44 |
The following packages are required: |
| 45 |
|
| 46 |
* chngpage or changepage |
| 47 |
* fancyhdr |
| 48 |
* fontenc |
| 49 |
* geometry |
| 50 |
* hyperref |
| 51 |
* natbib and bibentry |
| 52 |
* optparams |
| 53 |
* paralist |
| 54 |
* placeins |
| 55 |
* ragged2e |
| 56 |
* setspace |
| 57 |
* textcase |
| 58 |
* textcomp |
| 59 |
* titlesec |
| 60 |
* titletoc |
| 61 |
* xcolor |
| 62 |
* xifthen |
| 63 |
|
| 64 |
The following packages are optional and will be automatically used if installed: |
| 65 |
|
| 66 |
* beramono |
| 67 |
* helvet |
| 68 |
* ifpdf |
| 69 |
* ifxetex |
| 70 |
* letterspace (in the microtype package) |
| 71 |
* mathpazo |
| 72 |
* soul |
| 73 |
|
| 74 |
== Bugs/Features/Support |
| 75 |
|
| 76 |
For kudos, feature requests, patches, or support requests that you |
| 77 |
feel are /particular/ to this Tufte-LaTeX package, i.e., not a general |
| 78 |
LaTeX issue, please use this project's issue tracker available at |
| 79 |
|
| 80 |
http://tufte-latex.googlecode.com |
| 81 |
|
| 82 |
== Contributing |
| 83 |
|
| 84 |
Patches are most welcome via the issue tracker! Submit a series of |
| 85 |
high quality patches, and you'll find yourself a developer on this project. |
| 86 |
|
| 87 |
== License |
| 88 |
|
| 89 |
Copyright 2007-2010 by Kevin Godby, Bil Kleb, and Bill Wood. |
| 90 |
|
| 91 |
Licensed under the Apache License, Version 2.0 (the "License"); |
| 92 |
you may not use this file except in compliance with the License. |
| 93 |
You may obtain a copy of the License at |
| 94 |
|
| 95 |
http://www.apache.org/licenses/LICENSE-2.0 |
| 96 |
|
| 97 |
Unless required by applicable law or agreed to in writing, software |
| 98 |
distributed under the License is distributed on an "AS IS" BASIS, |
| 99 |
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 100 |
See the License for the specific language governing permissions and |
| 101 |
limitations under the License. |