A Documentation with the L TEX system

March 5, 2013

1 / 34

AT L EX

Introduction Operation Advantages Document Classes Sections Lists Equations Tables AT L EX Resources to start with AT L EX Online Tutorial BibTeX Documentation

A L TEX

2 / 34

Introduction
AT L EX

Introduction Operation Advantages Document Classes Sections Lists Equations Tables AT L EX Resources to start with AT L EX Online Tutorial BibTeX Documentation

TEX created by Donald Knuth 1977 Powerful typesetting utility for professional printers A L TEX by Leslie Lamport in 1980s Allows authors to focus on content automates indices, bibliographies, cross-references, tables of contents, numbering and placement of equations, gures and tables

3 / 34

Operation
AT L EX

Introduction Operation Advantages Document Classes Sections Lists Equations Tables AT L EX Resources to start with AT L EX Online Tutorial BibTeX Documentation

How it works: text le input converted to device-independent (DVI) le automatically lays out the pages according to rules in a document class le generates working les such as .aux for cross-references and other data .toc, .bbl for table of contents and bibliographies DVI le converted to Postscript or PDF

4 / 34

Advantages
AT L EX

Introduction Operation Advantages Document Classes Sections Lists Equations Tables AT L EX Resources to start with AT L EX Online Tutorial BibTeX Documentation

Separation of style and content Portable - Mac to Unix, small les Superior output Scalable to huge books Cost FREE

5 / 34

Document Classes
AT L EX

Introduction Operation Advantages Document Classes Sections Lists Equations Tables AT L EX Resources to start with AT L EX Online Tutorial BibTeX Documentation

Thousands of document classes available, which dene the layout of the document: article, letter, book, or ieeeTran.

6 / 34

Sections
AT L EX

Introduction Operation Advantages Document Classes Sections Lists Equations Tables AT L EX Resources to start with AT L EX Online Tutorial BibTeX Documentation

1 Section
For the main heading

1.1 Subsection
1.1.1 Subsubsection Numbering is automatic Lowest Level: is the paragraph

7 / 34

Sections
AT L EX

Introduction Operation Advantages Document Classes Sections Lists Equations Tables AT L EX Resources to start with AT L EX Online Tutorial BibTeX Documentation

\section{Section} For the main heading \subsection{Subsection} \subsubsection{Subsubsection} Numbering is automatic \paragraph{Lowest Level:} is the paragraph

8 / 34

Lists
AT L EX

Introduction Operation Advantages Document Classes Sections Lists Equations Tables AT L EX Resources to start with AT L EX Online Tutorial BibTeX Documentation

1. Enumerated, like this one (a) and appropriate numbering, (b) including nesting i. including more nesting A. B. 2. Bulletted with bullets with no numbers

including even more nesting and appropriate numbering,

Refer to Item 1b in the list

9 / 34

Lists
AT L EX

Introduction Operation Advantages Document Classes Sections Lists Equations Tables AT L EX Resources to start with AT L EX Online Tutorial BibTeX Documentation

\begin{enumerate} \item Enumerated, like this one \begin{enumerate} \item and appropriate numbering, \item \label{item1} including nesting \begin{enumerate} \item including more nesting \begin{enumerate} \item including even more nesting \item and appropriate numbering, \end{enumerate} \end{enumerate} \end{enumerate} \item Bulletted \begin{itemize} \item with bullets \item with no numbers \end{itemize} \end{enumerate} Refer to Item \ref{item1} in the list
10 / 34

Equations
AT L EX

Introduction Operation Advantages Document Classes Sections Lists Equations Tables AT L EX Resources to start with AT L EX Online Tutorial BibTeX Documentation

Equations like e = mc2 in line, or displayed v = iR, or they can be with numbers such as p = vi, or in arrays like p = vi = iR i = i2 R. The numbered equations can be references, so we know that the top line is (2).
11 / 34

(1)

(2) (3)

Equations
AT L EX

Introduction Operation Advantages Document Classes Sections Lists Equations Tables AT L EX Resources to start with AT L EX Online Tutorial BibTeX Documentation

Equations like $e=mc2$ in line, or displayed $$v=iR,$$ or they can be with numbers such as \begin{equation} p=vi, \end{equation} or in arrays like \begin{eqnarray} p & = & vi \label{eq:mid}\\ & = & iR\,i \\ & & = i2R. \nonumber \end{eqnarray} The numbered equations can be references, so we know that the top line is (\ref{eq:mid}).
12 / 34

Tables
AT L EX

Introduction Operation Advantages Document Classes Sections Lists Equations Tables AT L EX Resources to start with AT L EX Online Tutorial BibTeX Documentation

1 2 3

1 1 2 3

2 2 4 6

3 3 6 9

13 / 34

Tables
AT L EX

Introduction Operation Advantages Document Classes Sections Lists Equations Tables AT L EX Resources to start with AT L EX Online Tutorial BibTeX Documentation

\begin{center} \begin{tabular}{c|ccc} $\times$ & 1 & 2 & 3 1 & 1 & 2 & 3 2 & 2 & 4 & 6 3 & 3 & 6 & 9 \end{tabular} \end{center}

\\\hline \\ \\ \\

14 / 34

A L TEX Resources to start with

AT L EX

Introduction Operation Advantages Document Classes Sections Lists Equations Tables AT L EX Resources to start with AT L EX Online Tutorial BibTeX Documentation

LaTeX a document preparation system. http://www.latex-project.org/ The comprehensive TEX archive network. http://www.ctan.org/ http://www.miktex.org/ http://www.texniccenter.org/ Ghostscript, ghostview and gsview. http://pages.cs.wisc.edu/ghost/ Tpx: Tex drawing tool. http://tpx.sourceforge.net/ gnuplot homepage. http://www.gnuplot.info/

15 / 34

A L TEX Online Tutorial

AT L EX

Introduction Operation Advantages Document Classes Sections Lists Equations Tables AT L EX Resources to start with AT L EX Online Tutorial BibTeX Documentation

google LaTeX Krummel http://mrskrummel.com/tutorials.html google 12 LaTeX Videos http://castingoutnines.wordpress.com/2010/02/04/12-videos-forgetting-latex-into-the-hands-of-students/ http://chronicle.com/blognetwork/castingoutnines/2010/02/04/12videos-for-getting-latex-into-the-hands-of-students/

16 / 34

AT L EX

BibTeX BibTeX Document BibTeX Commands Sample Database Entry Citations Putting it together Documentation

BibTeX

17 / 34

BibTeX
AT L EX

BibTeX BibTeX Document BibTeX Commands Sample Database Entry Citations Putting it together Documentation

Bibliographic database (.bib le) Run BibTeX with .bib le and the document .aux le to produce a .bbl le BibTeX needs to know the

rules for compiling the .bbl le names of the .bib les

18 / 34

Document BibTeX Commands

AT L EX

Include in the source (.tex le)

BibTeX BibTeX Document BibTeX Commands Sample Database Entry Citations Putting it together Documentation

\bibliographystyle{IEEEtran} where the argument is the name of the style le for formatting references (in this case IEEEtran.bst)

\bibliography{references} where the argument is a comma separated list of the database les (in this case references.bib)

19 / 34

Sample Database Entry

AT L EX

BibTeX BibTeX Document BibTeX Commands Sample Database Entry Citations Putting it together Documentation

@INPROCEEDINGS{white96, AUTHOR = {Joseph F.\ White}, TITLE = {Your Paper Has Been Accepted!}, BOOKTITLE = {Applied Microwave \& Wireless}, YEAR = {1996}, pages = {17--23}, month = {Winter}, }

The entry white96 is any unique key used to reference this publication

20 / 34

Citations
AT L EX

BibTeX BibTeX Document BibTeX Commands Sample Database Entry Citations Putting it together Documentation

Include in the source a \cite{white96} command to cite the reference. This compiles as a citation number in a format dened in the document style. Elsewhere in the document source include the bibliography commands \bibliographystyle{IEEEtran} \bibliography{references}

21 / 34

Putting it together
AT L EX

BibTeX BibTeX Document BibTeX Commands Sample Database Entry Citations Putting it together Documentation

A 1. compile the L TEX source, which will include the citation key in the .aux le 2. run BibTeX to build the .bbl le. This will include the references in the format and order dened by the bibliography style le A 3. compile the L TEX source again, which will include the .bbl le at the position of the \bibliography{} command The citations may be incorrect at this stage: ....in the source a [?] command to cite.... A 4. compile the L TEX source once more to include the correct citation entries: ....in the source a [1] command to cite....

[1]

J. F. White, Your paper has been accepted! in Applied Microwave & Wireless, Winter 1996, pp. 1723.

22 / 34

AT L EX

BibTeX Documentation Sections of a Document Sections of a Document Documentation Formal Technical Writing Clarity in Technical Writing Formalities in Technical Writing Subtleties One, two and many Partitioning Acronyms Other

Documentation

23 / 34

Sections of a Document
AT L EX

BibTeX Documentation Sections of a Document Sections of a Document Documentation Formal Technical Writing Clarity in Technical Writing Formalities in Technical Writing Subtleties One, two and many Partitioning Acronyms Other

Abstract or Executive Summary Write this last A short summary of everything in the report, what is delivered, the scope or the work, the challenge addressed The reader decides to read or not to read on the basis of this summary Document Control authors, revisions, dates, copyright Introduction provide background to the report state the challenge addressed and the aims of the report tell the reader what the report is GOING TO SAY

24 / 34

Sections of a Document
AT L EX

BibTeX Documentation Sections of a Document Sections of a Document Documentation Formal Technical Writing Clarity in Technical Writing Formalities in Technical Writing Subtleties One, two and many Partitioning Acronyms Other

Body and Discussion the main part of the report tell the reader what the report IS SAYING include deciencies or scope for further work Conclusions tell the reader what the report HAS SAID References reference everything it is NOT PLAGIARISM if it IS REFERENCED use primary resources where possible wikipedia is a tertiary resource, so backtrack to secondary or primary resource. http://ieeexplore.ieee.org/ is free through the university library

25 / 34

Documentation
AT L EX

BibTeX Documentation Sections of a Document Sections of a Document Documentation Formal Technical Writing Clarity in Technical Writing Formalities in Technical Writing Subtleties One, two and many Partitioning Acronyms Other

Read Tips for authors [1] included in the ENGG200 web site Read the Document Style Guide (Style.pdf) included in the Lecture resources Complete source for the style guide is in rst laboratory resources

26 / 34

Formal Technical Writing

AT L EX

BibTeX Documentation Sections of a Document Sections of a Document Documentation Formal Technical Writing Clarity in Technical Writing Formalities in Technical Writing Subtleties One, two and many Partitioning Acronyms Other

Do not use colloquialism it can be a source of ambiguity Write in the third-person Avoid pronouns (I, we, they, he, she, you, ...) Rather than We measured the voltage write Voltage measurements were made Write in the past tense

The measured voltage WAS ... the report is written after the event exception for planned of future work discussed in the report

27 / 34

Clarity in Technical Writing

AT L EX

Sectioning and lists to provide clarity c.f. last two slides: Do not use colloquialism it can be a source of ambiguity. Write in the third-person. Avoid pronouns (I, we, they, he, she, you, ...): Rather than We measured the voltage write Voltage measurements were carried out. Write in the past tense The measured voltage WAS ... the report is written after the event exception for planned of future work discussed in the report

BibTeX Documentation Sections of a Document Sections of a Document Documentation Formal Technical Writing Clarity in Technical Writing Formalities in Technical Writing Subtleties One, two and many Partitioning Acronyms Other

28 / 34

Formalities in Technical Writing

AT L EX

BibTeX Documentation Sections of a Document Sections of a Document Documentation Formal Technical Writing Clarity in Technical Writing Formalities in Technical Writing Subtleties One, two and many Partitioning Acronyms Other

quotes and quotes quotes and quotes punctation NOT outside, but inside, like this quote. ac and dc are lower case No . after abbreviations ending with the last letter of the full word Dr rather than Dr. for DoctoR Prof. rather than Prof for PROFessor units like 25 V are upright and NOT italic V

include a non-breaking space (25V) between values and units when a noun no space or hyphen (25V or 25-V) between values and units for adjectives the 5V source was measured and found to deliver 4.9 V
29 / 34

other tips in the style guide...

Subtleties
AT L EX

case and character style can have specic technical meaning

BibTeX Documentation Sections of a Document Sections of a Document Documentation Formal Technical Writing Clarity in Technical Writing Formalities in Technical Writing Subtleties One, two and many Partitioning Acronyms Other

total signal versus dc and signal components versus amplitude: vI = VI + vi = VI + Vi cos t

cos x and log(x) and not cosx or log (x) = l o g (x) $\cos x$ and $\log(x)$ and not $cos x$ or $log(x)$

30 / 34

One, two and many

AT L EX

BibTeX Documentation Sections of a Document Sections of a Document Documentation Formal Technical Writing Clarity in Technical Writing Formalities in Technical Writing Subtleties One, two and many Partitioning Acronyms Other

Cadence of the English language is three: There are cars and trucks seems like not many types of vehicles There are cars, trucks and automobiles seems like many types (but there is still only two.) Avoid use of etc, such as, or including, just because a list seems incomplete. Poor use is There are many examples, such as cars etc. Here the etc implies there are others I cant think of Acceptable is There are many examples, such as cars, trucks with eight wheels, ten wheels, sixteen wheels, etc, and motor bikes. Here the etc refers to the continuation of information known to the reader.

31 / 34

Partitioning
AT L EX

BibTeX Documentation Sections of a Document Sections of a Document Documentation Formal Technical Writing Clarity in Technical Writing Formalities in Technical Writing Subtleties One, two and many Partitioning Acronyms Other

Humans cant assimilate more that seven concepts at once Five at once is more comfortable If there are more that seven Sections (including Introduction and Conclusion) then nest some into subsections or divide into Chapters.

32 / 34

Acronyms
AT L EX

BibTeX Documentation Sections of a Document Sections of a Document Documentation Formal Technical Writing Clarity in Technical Writing Formalities in Technical Writing Subtleties One, two and many Partitioning Acronyms Other

Dene acronyms on rst use. e.g. the operating system (OS) is important. The OS does ... Another OS may... If dened in an abstract, redene it on rst use in the body. Avoid using an acronym if it is not required more than two or three times in the document Exceptions are well and generally understood acronyms. The dc voltage... QANTAS... Beware of tautologies. A PIN number expands to Personal Identity Number number or dc current expands to direct current current.

33 / 34

Other
AT L EX

Spell out numbers less than twenty

BibTeX Documentation Sections of a Document Sections of a Document Documentation Formal Technical Writing Clarity in Technical Writing Formalities in Technical Writing Subtleties One, two and many Partitioning Acronyms Other

34 / 34