Preparing Basic Manuscripts with L A TEX

Size: px

Start display at page:

Download "Preparing Basic Manuscripts with L A TEX"

Dina Walsh
5 years ago
Views:

1 Preparing Basic Manuscripts with L A TEX Garrett Darl Lewis Department of Politics Princeton University March 24, 2015 Abstract This is an interactive document designed to introduce seminar participants to the features and capabilities of LATEX. By the end of this seminar, users should be able to write a basic text document with equations, graphics, tables, and a professional-looking bibliography. The companion document available on my website provides a somewhat more in-depth analysis of many of the same features, as well as links to other helpful documents and resources. To get the most out of this document, users are encouraged to read raw code alongside the finished document using an appropriate LATEX development environment, such as Overleaf or TEXworks. Department of Politics, Princeton University 130 Corwin Hall, Princeton, NJ glewis@princeton.edu, 1

2 Contents 1 Introduction 3 2 The Main Body 5 3 Text Lists Theorems Counters References Math Complicated Equations and Numbering Tables Regression Output Graphics Importing Graphics Conclusion 19 2

3 1 Introduction L A TEX is a particularly versatile typesetting environment. I am assuming that you are already familiar with the basics of the software and terminology, so we will primarily be focusing on expanding your skill set and introducing more advanced features. Of course, to gain a full appreciation of the capabilities of the software takes practice and effort beyond this seminar, but I hope to provide tools that will be of use throughout the learning process and allow you to proceed independently in your own work. This seminar will proceed in six parts as follows: 1. Text TEXample 1: Theorem Theorem 1. All governments are unjust. Proof. Consider an arbitrary government. Since it is arbitrary, it is obviously unjust. The assertion being correct for an arbitrary government, it is thus true for all governments. 2. Bibliographies TEXample 2: Book Citation Lewis, Darl. 2014a. A L A TEX Book. NJ: My Computer. 3. Math TEXample 3: Multiline Equation a + b = c 2(a + b) (a + b) = 2c c 2a + 2b 2c = a + b c 2(a + b c) = a + b c 2 = 1 (Bad Math) 4. Tables 3

4 TEXample 4: Regression Output Model 1 Model 2 (1) (2) (1) (2) Weight (lbs.) 1.747* *.000 (p-value) (.050) (.567) (.263) (.020) Foreign*Mileage * (.240) (.000) Controls N Y N Y Adj. R No. of cases Source: auto.dta 5. Graphics TEXample 5: Mindmap Computer Science Categorical Methods Networks Probability Optimization Images Compression & Transmission Algorithms Shehtman Logic Rybko Nadirashvili OTARIE (Sobolevski) Kabatyanski, Tsfasman, Rybakov, Zykin Kucherov, Roytberg Raffinot Vereschagin Koshevoy Condensed Matter Partial Eifferential Equations & Numerical Methods Lohéac Combinatorics and Discrete Mathematics Genomics Choice and Decision Theory Astronomy & Cosmology Medicine Economics Physics Biology Quantitative Calculations 4

5 2 The Main Body The following code is sufficient to produce a basic document. In the preamble, it defines the type of document being created (documentclass), any special packages that might be required to compile the document (usepackage), as well as a statement of the title and author of the work. As I introduce more sophisticated capabilities of the software, I will also discuss more packages and settings that can be called in the preamble when they are needed. At the end of the preamble, the command, \begin{document}, begins the main body. After this command, I tell the software to include a title, table of contents, and an abstract. I then insert the main text, and finally call a bibliography using references written to the file, CiteFile.bib. The command, \end{document} ends the document. After saving, I typically run three commands in my compiler to prepare the document and ensure that all of the auxiliary files have been properly updated. These three commands are pdflatex, MakeIndex, and BibTeX. It is generally not necessary to run all three, but as it is better than spending hours on end trying to figure out why your document is not compiling properly, only to find out that your *.bbl file was out of date. Code Block 1: Basic Structure 1 \documentclass[letter,12pt]{article} 2 %There are several packages which I use throughout the file. Not all will be helpful in every document, but the first several included here are almost always useful. I try to note the relevant heading material in the body below as I use it. 4 % Important packages 5 \usepackage{latexsym, amsmath, amssymb, amsthm, natbib, setspace} 7 % Define the title, \&c 8 \title{my Title} 9 \author{me\thanks{department of Politics\\ Princeton University} 10 \date{\today} 12 \doublespacing % Use double spacing 14 \begin{document} % Begin the body 5

6 15 \maketitle % Generate the title 16 \tableofcontents % Generate a ToC 18 \begin{abstract} 19 Put your abstract here! 20 \end{abstract} 22 \section{the Body} 23 Hello World! 25 %\newpage % Skip to the next page 26 \bibliography{bibliotemp} % Insert a bibliography 27 \end{document} 28 % Everything down here is ignored 3 Text Basic text is pretty easy. Just define your document class, open your document, and start typing, maybe adding a chapter or section along the way. However that s pretty boring, especially if you have to use things like, you know, MATH. Let s look at some of the options... 1 In the previous paragraph, we saw features like italics and bold face type, as well as an ellipsis and a footnote. These are typeset as, Code Block 2: Text 1...have to use things like, \emph{you know}, \textbf{math}. Let s look at some of the options\dots\footnote{i want to quickly point out a few features that can drive someone crazy if they are not paying attention. Many symbols, such as \&, \textasciitilde, and \textbackslash\ require special notation in \LaTeX, since the symbols themselves have certain meaning in the software. Make sure you proofread your finished document--esp. where you are likely to use symbols--to ensure 1 I want to quickly point out a few features that can drive someone crazy if they are not paying attention. Many symbols, such as &,, and \ require special notation in L A TEX since the symbols themselves have certain meaning in the software. Make sure you proofread your finished document esp. where you are likely to use symbols to ensure that there are no odd missing items or strange additions. 6

7 that there are no odd missing items or strange additions.} 3.1 Lists Writing lists in L A TEX is relatively easy using the itemize and enumerate commands. Here I am using the two commands to format my description of their capabilities. 1. Itemize produces a list of bullet points. This is what you do if you do not care about numbering. The bullet shape changes at every level Like this. 2. This is what you do if the order matters. 3. But you can also choose your own shape using the enumitem package. i) Like this. 3.2 Theorems There are a few environments readily available for writing theorems and proofs and the like, but sometimes you have to define your own. Luckily, that s easy to do. In the preamble of my document, I have defined environment, Theorem, using this command: 1 \newtheorem{theorem}{theorem} Code Block 4: Theorem L A TEX counts each environment separately unless specified otherwise using any of the counter tools such as addtocounter and newcounter. Theorem 2. All governments are unjust. 7

8 TEXercise 1: List Problem 1. List your five favorite states in descending order. List two cities in your favorite state. Hint. 1 \begin{enumerate} 2 \item Missouri 3 \begin{itemize} 4 \item Kansas City 5 \item St. Louis 6 \end{itemize} 7 \item Florida 8 \item Texas 9 \item California 10 \item Maryland 11 \end{enumerate} Code Block 3: Nested List TEXercise Solution 1: List Solution. YOUR SOLUTION Proof. Consider an arbitrary government. Since it is arbitrary, it is obviously unjust. The assertion being correct for an arbitrary government, it is thus true for all governments. I did not have to separately define the proof environment used here, as it is included with the amsthm package. However, below I have written an exercise which uses, among others, a solution environment that is slightly different from the proof environment, using a black box instead of an empty one. Creating this environment is somewhat more involved that creating theorem: Code Block 5: Solution 1 \newenvironment{solution}{\begin{trivlist} \item \textbf{solution}. }{ \hspace*{\fill} $\blacksquare$\end{trivlist}} 8

9 3.3 Counters When you define a new basic environment L A TEX automatically produces a counter with the same name and increments that counter every time you use the environment. Sometimes, though, you may want to use a different numbering system. The code below defines two new environments, one of which uses the same counter as the theorem environment, and one of which is numbered by section: Code Block 6: Theorem 1 \newtheorem{corollary}[theorem]{corollary} 2 \newtheorem{definition}{definition}[section] Note, in some more advanced contexts, you may need to define a new counter yourself using the newcounter command. 3.4 References Often times while writing, you will want to refer to various pieces of your document. There are several ways to do this, depending on exactly what you are trying to reference, but they all follow one general format, with the exception of references to works cited. Cross References As you are writing, anything you wish to label, such as Section 3.4 here, should be tagged using the label command. Then when you want to refer back to that item, you need only call the appropriate label using the ref command. This works for the majority of items you might reference, as I demonstrate here in my references to Table 1 and Figure 2 (In general, it is best to label the captions on figures, rather than the figure itself). Equations are a slightly special case and should be referenced with the eqref command, and with Equation (2), although it is not generally necessary. 9

10 TEXercise 2: Question Problem 2. Generate a Question environment identical to the Theorem environment. Then create an Answer environment that looks like the Proof environment, but uses a star instead of an open box. Set the counter on question to be the same as that on problem. Finally, ask yourself a question and then answer it. Hint. Code Block 7: Question 1 \newtheorem{question}[problem]{question} 2 \newenvironment{answer}{\begin{trivlist} \item \textit{answer}. }{ \hspace*{\fill} $\star$\end{trivlist}} 4 \begin{question} 5 Is this correct? 6 \end{question} 8 \begin{answer} 9 Yes, it is. 10 \end{answer} TEXercise Solution 2: Question Solution. YOUR SOLUTION Footnotes Footnotes may be generated in L A TEX using the footnote command. 2 Bibliography To generate a bibliography of works cited, requires you to use a separate *.bib file and the software, BIBTEX, which is included with most L A TEX distributions. It also requires the natbib package. When referencing you bibliography, the program will skip over citations if it they cannot be found 2 Text placed within the braces will go into a footnote. Once in the environment, you can reference of items, display math, and generally use L A TEX as you would in any other environment. 10

11 in your *.bib file (that has also been appropriately compiled using BIBTEX). If this happens, you will receive a question mark in lieu of the citation. Luckily, the *.bib file is easy to assemble, since it is little more than a list of all your sources. The block of code below gives examples of how to record several types of sources material: Code Block 8: *.bib File 2 AUTHOR = {Lewis, Darl}, 3 TITLE = {A \LaTeX Template}, 4 YEAR = {2014}, 5 JOURNAL = {A Journal}, 6 VOLUME = {1}, 7 NUMBER = {1}, 8 PAGES = {1-12} 9 } 10 % 12 AUTHOR = {Lewis, Darl}, 13 TITLE = {A \LaTeX Book}, 14 YEAR = {2014}, 15 PUBLISHER = {My Computer}, 16 ADDRESS = {NJ}, 17 } 18 % 20 AUTHOR = {Lewis, Darl}, 21 TITLE = {Another \LaTeX Template}, 22 YEAR = {2014}, 23 EDITOR = {Lewis, Darl}, 24 BOOKTITLE = {Another \LaTeX Book}, 25 PUBLISHER = {My Computer}, 26 ADDRESS = {NJ}, 27 } To insert the list of references at the end of your document, simply define the bibliography style and call the bibliography before you end the document. Of course, if you want to insert the references elsewhere, you may do that as well. As a default, I use the bibliography style associated 11

12 with the Journal of Political Economy, but this option is quite flexible. The nocite option allow the software to include references in the works cited section whether or not they have been cited within the document. 1 \bibliographystyle{jpe} 2 \nocite{*} 3 \bibliography{citefile} Code Block 9: Bibliography When you want to refer back to the works you have cited, you may use one of several cite commands, the most useful of which are cite (which produces this:lewis (2014c)) and citep (which produces (Lewis, 2014c)). TEXercise 3: Refer Problem 3. I have labelled the following equation, TestEq. Write a comment which refers to this equation, and insert a footnote citing Lewis (2014c) at the end of that comment. Hint. E = mc 2 (1) Code Block 10: References 1 This comment refers to Section \eqref{testeq}.\footnote{\cite{lewis14}} TEXercise Solution 3: Refer Solution. YOUR SOLUTION 4 Math The value of L A TEX becomes most apparent when writing equations. After a while, it becomes very easy to simply type equations as you go in a way that does not accrue with many other software 12

13 platforms. Most mathematical symbols are simply a \ followed by the name of the symbol, and most of the common structures you are likely to encounter are designed to be implemented with relative ease and flexibility. If you want to write an inline equation, just use write the appropriate commands between two dollar signs, $, to produce something like this a + b = c. If you want to to write something longer or make it more visible by pulling it out of the text, though, use the equation environment: e iπ + 1 = 0 (2) If you don t want to attach a number, there are several options. I usually just go with this one... ( ) v ρ t + v v = p + T + f 4.1 Complicated Equations and Numbering Suppose you are trying to write a longer equation of a system of related equations. In such a scenario, you may prefer to use more than the basic features provided by the equation environment. First, I present a series of related equations, which I have given a special non-numeric label: a + b = c 2(a + b) (a + b) = 2c c 2a + 2b 2c = a + b c (Bad Math) 2(a + b c) = a + b c 2 = 1 Note the use of the split environment and the use of the symbol, &, to align equations in this series of equations. Suppose I want each to have a unique number though. In that case, I can use the align command in lieu of equation and split: 13

14 a + b = c (3) 2(a + b) (a + b) = 2c c (4) 2a + 2b 2c = a + b c (5) 2(a + b c) = a + b c (6) 2 = 1 (7) Alternatively, you can nest a few related equations under one principal number. To do so, use subequations: a + b = c (8a) 2(a + b) (a + b) = 2c c (8b) 2a + 2b 2c = a + b c (8c) 2(a + b c) = a + b c (8d) 2 = 1 (8e) If you label them properly, you can easily refer back to previous equations like (8). That makes it easy to talk about how similar (8a) is to the first equation I presented here in Section 4. As one last example, consider a long equation that does not fit on a single line. Here we use multline, as well as introduce the use of array for the vectors and cases for the piecewise component. 14

15 TEXercise 4: Solve Problem 4. Solve the equation, 4x + 5y = 7x + 3y for y. Show your work. Hint. 1 \begin{subequations} 2 \begin{align} 3 4x+5y &=7x+3y \\ 4 5y-3y &=7x-4x \\ 5 2y &=3x \\ 6 y &=\frac{3}{2}x 7 \end{align} 8 \end{subequations} Code Block 11: Solve TEXercise Solution 4: Solve Solution. YOUR SOLUTION a c e [ d e f ] + δ(x) N y i + H(x) z j + j Ω i=0 1 π(1 + x 2 ) dx ad + be + cf + 1 if x < 0 = ad + be + cf + N i=0 y i j Ω z j + 1 if x = 0 (9) ad + be + cf + j Ω z j + 1 if x > 0 There are still more ways of separating an equation into multiple lines with slightly varying effects. For more on mathematical features and symbols, I will refer you to a well-written document in Downes (2002), which offers a quick run-down of the capabilities of the software. For a comprehensive list of symbols available, both in the equation environment and the text environment, 15

16 see Pakin (2009). TEXercise 5: Multi Problem 5. Reconfigure this equation into three lines using multline: a + b + c + d + e + f + g + h + i + j = α + β + γ + δ + ɛ + ζ + η + θ + ι + κ = (10) For convenience, here is the code I used to produce this format: 1 \begin{equation} 2 \begin{split} Code Block 12: Split 3 a+b+c+d+e+f+g+h+i+j &=\alpha +\beta +\gamma +\delta +\epsilon +\zeta +\eta +\theta +\iota+ \kappa \\ 4 &= \end{split} 6 \end{equation} Hint. 1 \begin{multline} 2 a+b+c+d+e+f+g+h+i+j \\ Code Block 13: Multiline 3 =\alpha +\beta +\gamma +\delta +\epsilon +\zeta +\eta +\theta +\iota +\kappa \\ 4 = \end{multline} TEXercise Solution 5: Multi Solution. YOUR SOLUTION 16

17 Table 1: The auto data Model 1 Model 2 (1) (2) (1) (2) Weight (lbs.) 1.747* *.000 (p-value) (.050) (.567) (.263) (.020) Foreign*Mileage * (.240) (.000) Controls N Y N Y Adj. R No. of cases Source: auto.dta 5 Tables 5.1 Regression Output We often want to display data or reults in table form. Often times, the software you are using will provide resources to export data formatted for a table in a L A TEX document. Matlab, Stata, and R all have such packages. Sometimes you may need to prepare a table yourself: 6 Graphics 6.1 Importing Graphics Here is an image with a caption included using the graphicx package. I have placed to copies of it inside a figure to make manipulation easier (i.e. placement within the paper, centering, &c), with the first image being imported as a raster image (*.png or *.jpg) and the second being an identical image in vector format (*.eps or *.pdf ). Note that the latter file type produces a much smoother image, although this problem can be ameliorated using high-definition raster images. 17

18 TEXercise 6: Table Problem 6. Recreae the Table (1), but include a third model. You may ignore the table environment (not the tabular environment!) and the caption. Choose whatever numbers you wish for the results. Hint. 1 \begin{center} 2 \begin{tabular}{l*{3}{rr}} 3 \hline Code Block 14: Table 4 &\multicolumn{2}{c}{model 1} &\multicolumn{2}{c}{model 2} &\multicolumn{2}{c}{model 3}\\ 5 & (1) & (2) & (1) & (2) & (1) & (2)\\ 6 \hline\\[-1ex] 7 Weight (lbs.) & 1.747* &.008 & 4.614* &.000 & 4.614* &.000\\ 8 ($p$-value) & (--.050) & (.567) & (.263) & (.020) & (.263) & (.020)\\ 9 Foreign*Mileage & & & &.006* & &.006*\\ 10 & & & (.240) & (.000) & (.240) & (.000)\\ 11 Controls & N & Y & N & Y & N & Y\\ 12 \hline 13 Adj. $Rˆ2$ &.273 &.435 &.526 &.773 &.526 &.773\\ 14 No. of cases & 74 & 74 & 74 & 74 & 74 & 74\\ 15 \hline 16 \small\textit{source:} auto.dta 17 \end{tabular} 18 \end{center} TEXercise Solution 6: Table Solution. YOUR SOLUTION 18

Figure 1: If you like nerdy comics, try xkcd. Also, go Caltech! Figure 2: If you like nerdy comics, try xkcd. Also, go Caltech! 7 Conclusion Now that you have made it this far, it is time to just jump in and start playing around with the software.

19 Figure 1: If you like nerdy comics, try xkcd. Also, go Caltech! Figure 2: If you like nerdy comics, try xkcd. Also, go Caltech! 7 Conclusion Now that you have made it this far, it is time to just jump in and start playing around with the software. Practice makes perfect, right? If you have more requests for information to include, let me know. I will try to update this document over time to add functionality as well as make the learning experience easier. Hopefully there is enough here to at least give you an idea of what to look for as you attempt to write documents in L A TEX. March 24,

20 TEXercise 7: Image Problem 7. Import the image of your choice. I have provided medusoid.pdf if you are not inclined to find one of your own. Include a caption with your graphic. Hint. 1 \begin{center} Code Block 15: Image 2 \includegraphics[width=.8\textwidth]{medusoid.pdf} 3 \captionof{figure}{artificial Jellyfish} 4 \end{center} **Note, typically the following code will work, but only when it is possible to place the image in a figure. 1 \begin{figure}[h!] Code Block 16: Image II 2 \caption{figure}{artificial Jellyfish} 3 \centering 4 \includegraphics[width=.8\textwidth]{medusoid.pdf} 5 \end{figure} TEXercise Solution 7: Image Solution. YOUR SOLUTION References Crémer, Jacques A Very Minimal Introduction to TikZ. Manuscript 0 (0):1 24. Downes, Michael A Short Math Guide for L A TEX. AMS Manuscript :1 17. Lewis, Darl. 2014a. Another L A TEX Template. In Another L A TEX Book, edited by Darl Lewis. NJ: My Computer b. A L A TEX Book. NJ: My Computer c. A L A TEX Template. A Journal 1 (1):

21 Pakin, Scott The Comprehensive L A TEX Symbol List. Manuscript :

Preparing Advanced Manuscripts with L A TEX

Preparing Advanced Manuscripts with L A TEX Garrett Darl Lewis Department of Politics Princeton University March 25, 2015 Abstract This is an interactive document designed to introduce seminar participants