CommunityData:TeX: Difference between revisions

Revision as of 19:44, 8 August 2019

In order to write LaTeX documents, there are two main options. The first is to do everything in Overleaf. The second option, which is explained in this document, is to install software on your local machine which will compile LaTeX documents. This document explains how to use our lab-created templates. Using other templates may require other steps.

Installing Dependencies

Debian/Ubuntu Installation Instructions

First, you'll want to install the following packages:

rubber
latexmk
texlive-latex-recommended
texlive-latex-extra
texlive-fonts-extra
texlive-fonts-recommended
texlive-bibtex-extra
moreutils
gawk

Also, to install Garamond grab and install the font from here through the following complicated process:

Download the file
Create ~/texmf if it does not exist yet
Unzip the file ugm.zip from the garamond.zip file into that ~/texmf/
Copy the other font files in the root directory of garamond.zip into ~/texmf/fonts/type1/
Run "texhash ~/texmf

Alternatively, if you want to install them system wide and have root credentials, you can also place them in /usr/local/share/texmf instead.

Using MacTeX on OSX

To install with MacTeX, you need to install the font:

wget http://tug.org/fonts/getnonfreefonts/install-getnonfreefonts
texlua install-getnonfreefonts
sudo getnonfreefonts-sys garamond

Getting/Installing Templates

You can find the latest version of the templates here.

To clone the public repository, you can do:

git clone git://code.communitydata.science/cdsc_tex

If you can clone them into the directory ~/tex/ (e.g., by doing mkdir ~/tex; cd ~/tex before running the clone command above) it will make things a bit easier.

This code includes a bunch of bash scripts which are used to quickly create a new project. If you want, you can copy the files into your path (e.g., ln -s ~/tex/cdsc_tex/new* ~/bin/); this will allow you to run, for example, new_knitr_document documentname to create a new knitr document from the template.

Using the Templates

The templates themselves use the LaTeX Memoir Class (warning that link is a ~1000 page PDF and the documentation). There are three styles that come with it and two basic layouts that are defined. To switch between them, you just edit the following line:

\chapterstyle{article-2}

The first style article-1 is the most conservative. article-2 is great for papers (a perhaps dated example). The third style article-3 is more for shorter pieces and memos (a perhaps dated example). If you want to use the style, you might want to consider switching the pagestyle from cdsc-article to cdsc-memo by editing the following line:

\pagestyle{cdsc-article}

Sending Patches

If you want to send patches, these currently should be sent over email to mako. Details on how to do this with the git format-patch command are online here: https://code.communitydata.science/

@@ Line 52: / Line 52: @@
   \chapterstyle{article-2}
-The first style <code>article-1</code> is the most conservative. <code>article-2</code> is great for papers ([https://mako.cc/academic/shaw_hill-laboratories_of_oligarchy-DRAFT.pdf a perhaps dated example]). The third style <code>article-3</code> is more for shorter pieces and memos ([https://mako.cc/academic/bmh-research_statement.pdf a perhaps dated example]). If you want to use the style, you might want to consider switching the pagestyle from <code>mako-mem</code> to <code>memo</code> by editing the following line:
+The first style <code>article-1</code> is the most conservative. <code>article-2</code> is great for papers ([https://mako.cc/academic/shaw_hill-laboratories_of_oligarchy-DRAFT.pdf a perhaps dated example]). The third style <code>article-3</code> is more for shorter pieces and memos ([https://mako.cc/academic/bmh-research_statement.pdf a perhaps dated example]). If you want to use the style, you might want to consider switching the pagestyle from <code>cdsc-article</code> to <code>cdsc-memo</code> by editing the following line:
-  \pagestyle{mako-mem}
+  \pagestyle{cdsc-article}
 == Sending Patches ==
 If you want to send patches, these currently should be sent over email to mako. Details on how to do this with the <code>git format-patch</code> command are online here: https://code.communitydata.science/