Difference between revisions of "CommunityData:TeX"

From CommunityData
Jump to navigation Jump to search
(Created page with "== Getting Setup for Paper Template == === Linux Instructions === Install the following packages: * rubber * latexmk * texlive-latex-recommended * texlive-latex-extra * tex...")
 
(updated)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Getting Setup for Paper Template ==
+
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.
  
=== Linux Instructions ===
+
== Installing Dependencies ==
 +
=== Debian/Ubuntu Installation Instructions ===
  
Install the following packages:
+
First, you'll want to install the following packages:
  
 
* rubber
 
* rubber
Line 13: Line 14:
 
* texlive-bibtex-extra
 
* texlive-bibtex-extra
 
* moreutils
 
* moreutils
 +
* gawk
  
 
Also, to install Garamond grab and install the font from [http://www.ctan.org/tex-archive/fonts/urw/garamond/ here] through the following complicated process:
 
Also, to install Garamond grab and install the font from [http://www.ctan.org/tex-archive/fonts/urw/garamond/ here] through the following complicated process:
Line 24: Line 26:
 
Alternatively, if you want to install them system wide and have root credentials, you can also place them in ''/usr/local/share/texmf'' instead.
 
Alternatively, if you want to install them system wide and have root credentials, you can also place them in ''/usr/local/share/texmf'' instead.
  
=== MacTeX ===
+
=== Using MacTeX on OSX ===
  
 
To install with MacTeX, you need to install the font:
 
To install with MacTeX, you need to install the font:
Line 32: Line 34:
 
  sudo getnonfreefonts-sys garamond
 
  sudo getnonfreefonts-sys garamond
  
== Beamer Templates ==
+
== Getting/Installing Templates ==
  
To get setup for the <code>beamer-mako</code> templates, install the following packages:
+
You can find the latest version of the templates [https://code.communitydata.science/cdsc_tex.git here].
  
* texlive-latex-base
+
To clone the public repository, you can do:
* latex-beamer
+
 
* rubber
+
git clone git://code.communitydata.science/cdsc_tex
* latexmk
+
 
* texlive-fonts-extra
+
If you can clone them into the directory <code>~/tex/</code> (e.g., by doing <code>mkdir ~/tex; cd ~/tex</code> 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., <code>ln -s ~/tex/cdsc_tex/new* ~/bin/</code>); this will allow you to run, for example, <code>new_knitr_document documentname</code> to create a new knitr document from the template.
 +
 
 +
== Using the Templates ==
 +
 
 +
There are quite a number of useful instructions sprinkled throughout the TeX source file in comments. You should pay particular attention to the comments that begin with:
 +
 
 +
% LATEX NOTE:
 +
 
 +
There are two styles that come with the package with two basic layouts that are defined. To switch between them, you just edit the following line:
 +
 
 +
\chapterstyle{cdsc-article}
 +
 
 +
The first style <code>cdsc-article</code> is great for papers ([https://mako.cc/academic/shaw_hill-laboratories_of_oligarchy-DRAFT.pdf a perhaps dated example]).
 +
 
 +
The second style <code>cdsc-memo</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 <code>\chapterstyle</code> line mentioned above <code>cdsc-article</code> to <code>cdsc-memo</code> by editing the following line.
 +
 
 +
If you want to include git commit IDs and datestamp on each page of the paper, you can uncomment the following lines which will import version control information after running <copde>make vc</code>
 +
 
 +
\input{vc}
 +
\pagestyle{cdsc-page-git}
 +
 
 +
One problem is that that this can be tricky to get to work on Overleaf. This alternative line will just input a timestamp at the build process:
 +
 
 +
\pagestyle{cdsc-page-overleaf}
 +
 
 +
 
 +
Either approach can be useful for keeping track of which version of a document somebody has.
 +
 
 +
The templates themselves use the [http://texdoc.net/texmf-dist/doc/latex/memoir/memman.pdf LaTeX Memoir Class] (warning that link is a ~1000 page PDF and the documentation).
 +
 
 +
== 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/

Latest revision as of 12:53, 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[edit]

Debian/Ubuntu Installation Instructions[edit]

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[edit]

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[edit]

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[edit]

There are quite a number of useful instructions sprinkled throughout the TeX source file in comments. You should pay particular attention to the comments that begin with:

% LATEX NOTE:

There are two styles that come with the package with two basic layouts that are defined. To switch between them, you just edit the following line:

\chapterstyle{cdsc-article}

The first style cdsc-article is great for papers (a perhaps dated example).

The second style cdsc-memo 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 \chapterstyle line mentioned above cdsc-article to cdsc-memo by editing the following line.

If you want to include git commit IDs and datestamp on each page of the paper, you can uncomment the following lines which will import version control information after running <copde>make vc

\input{vc}
\pagestyle{cdsc-page-git}

One problem is that that this can be tricky to get to work on Overleaf. This alternative line will just input a timestamp at the build process:

\pagestyle{cdsc-page-overleaf}


Either approach can be useful for keeping track of which version of a document somebody has.

The templates themselves use the LaTeX Memoir Class (warning that link is a ~1000 page PDF and the documentation).

Sending Patches[edit]

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/