Overleaf guide - ganong-noel/lab_manual GitHub Wiki
Overleaf memos
1. Set-up
Each project will have an overleaf project with a main.tex file including \usepackage[subpreambles=true]{standalone}
and an input folder for inputs that need to be sent to Chase for disclosure. Create a folder within the project named issue_XXX_short_name (same name as issue branch). Within your issue folder, create an input folder and .tex file for your memo. Include \documentclass[class=article, crop=false]{standalone}
at the top of the memo. You can input your figures and tables from the input folder using the input{}
function in LaTeX.
2. Tracking Changes
Although you can look through version history in Overleaf, it isn't explicitly linked to version control, like posting a comment in Git. Thus, it is important to track and push the coding changes you're making to your memo to the associated branch and make a brief comment at least once a week in the Git ticket posting any figures/tables and linking to the commits with changes.
3. Getting Feedback
It is important to clarify where in the memo the PI needs to provide feedback. In your EOD message, make sure to include a longer description clarifying what is ready for review within the memo. You can also use %__ to NNN or GGG within the memo and note in your message that sections needing feedback are tagged in this way.
4. Tips
- To make comments that you can fold (using % does not enable this functionality), include
\usepackage{comment}
in the preamble and wrap your comment you want to fold inbegin{comment}
andend{comment}
. This is a good way to save old comments and conversations without having them take up too much space in your memo. - To create a to-do list that you can track progress on, include
\newcommand{\checkboxUnchecked}{\(\square\)} \newcommand{\checkboxChecked}{\(\boxtimes\)}
in your preamble and use\item[\checkboxUnchecked]
to create an unchecked box and\item[\checkboxChecked]
. - Use `` and " or '' for quotations marks.
- To get rid of indents for the whole document instead of using
\noindent
, use\setlength\parindent{0pt}
in your preamble.
Overleaf redlines
1. Goal
The purpose of this wiki page is to explain how to make a redlines version of a paper if the paper is written in Overleaf (so tex) rather than in Lyx (where we can do a compare-merge within Lyx itself). This involves making a version of the paper that cumulates the differences between the current version and a previous version (usually one submitted to Chase or a journal) and explicitly shows the changes made in the current from the previous versions. If there is a line that gets deleted, it is struck through, and if one gets added, it is highlighted in someway. For example:
"
This is a line from the previous version.But this is its replacement in the new version."
While there are multiple ways to do this, this guide will capture the one of the easier methods we have found to work.
2. Set up
We will be using a Perl script called latexdiff
, which will run on your respective local. Since it is a Perl script, you would need Perl to be installed in your local computer. For MacOS, Perl will come with your computer and no further step is required. For windows, you might need to install Perl here.
latexdiff
Downloading This downloading guide is adapted from here.
For Windows:
- Download
latexdiff
from here - Unzip the
latexdiff
files and copy them to thePerl > bin
folder (default installation in C: drive) You should be good to go!
For MacOS:
Downloading Tex Live Utility should suffice to run latexdiff
. For more information about Tex Live Utility, see here.
latexdiff
3. Using Once you have set up latexdiff
, the process is straightforward. To do the diff, you need to have a .tex
file of the older version of the paper and a .tex
file of the new version of the paper. Once you have these, go to your command line/terminal and perform this line of code:
latexdiff old_paper.tex new_paper.tex > diff_paper.tex
And this should give a very nice .tex
file with all the differences highlighted. The default is the deleted text is in red and struck-through, while the added text is in blue. You can change up these defaults in the command line and the different options can be seen either by writing latexdiff -h
in the command line, or in the documentation provided by the author here.