Difference between revisions of "CommunityData:TeX"

From CommunityData
Jump to navigation Jump to search
(Updating to new templates)
Line 1: Line 1:
 +
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 ==
 
== Installing Dependencies ==
 
=== Debian/Ubuntu Installation Instructions ===
 
=== Debian/Ubuntu Installation Instructions ===
Line 34: Line 36:
 
== Getting/Installing Templates ==
 
== Getting/Installing Templates ==
  
You can find the latest version of Mako's templates here: http://projects.mako.cc/source/?p=latex_mako
+
You can find the latest version of the templates [https://code.communitydata.science/cdsc_tex.git here].
  
 
To clone the public repository, you can do:
 
To clone the public repository, you can do:
  
  git clone git://projects.mako.cc/latex_mako
+
  git clone git://code.communitydata.science/cdsc_tex
  
 
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.
 
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.
  
If you want, you can copy the files new_tex_document  new_tex_letter into your path (e.g., <code>~/bin</code>) this will allow you to run <code>new_tex_document documentname</code> to create new documents from the template more easily. It's totally optional.
+
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 ==
 
== Using the Templates ==
Line 56: Line 58:
 
== Sending Patches ==
 
== 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: http://projects.mako.cc/source/
+
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/

Revision as of 17:06, 10 June 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 mako-mem to memo by editing the following line:

\pagestyle{mako-mem}

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/