Skip to content

Instantly share code, notes, and snippets.

@hugoledoux
Last active December 30, 2015 18:39
Show Gist options
  • Save hugoledoux/7869177 to your computer and use it in GitHub Desktop.
Save hugoledoux/7869177 to your computer and use it in GitHub Desktop.
The Rules for happily collaborating on a LaTeX document

The Rules for happily collaborating on a LaTeX document

1. You shall use only one sentence per line.

Use one empty line to start a new paragraph

2. You shall use natbib for citations

\usepackage[round]{natbib}
...
\citet{Smith2000} does this and that~\citep{Brown1990}.

3. You shall prevent breaking lines with "~" when referencing

in Section~\ref{sec:intro} the triangles are great~\citep{Smith99}.

Use these 2 commands:

\newcommand{\Reffig}[1]{Fig.~\ref{#1}}
\newcommand{\Refsec}[1]{Sec.~\ref{#1}}
...
As we can see in \Refsec{sec:intro}, the

4. You shall use one "-" for an hyphen, two "--" for a range between numbers, and three "---" for a punctuation in a sentence.

I like---unlike my father---to build multi-dimensional models, 
especially those made in 1990--1995.

5. You shall give meaningful labels.

A figure's label should start with "fig:" and a section's label with "sec:"

\section{Introduction}  
\label{sec:intro}

6. You shall put a short space after e.g. and i.e. with the use of a \

The following two commands shall thus be used:

  \newcommand{\ie }{i.e.}
  \newcommand{\eg }{e.g.}
  ...
  I like vegetables, \eg\ potatoes, carrots, and pumpkins. 

7. You shall put all figures/graphs in a single folder ("figs/").

And you shall put the source file (eg OmniGraffle, Illustrator, etc.) there as well for future use.

8. In your BibTeX file, you shall use curly brackets for words/letters you want to have capitalised in the title.

Title = {The {3D} {CityGML} building was constructed with the {Delaunay} triangulation},

9. You shall not use italics or bold commands directly.

Use \emph{} instead

This is \emph{great} work.

10. You shall not add any commands to change the format (eg vspace, newpage) until the the paper is done.

11. You shall declare all sizes relative to \linewidth.

So that the paper can be switched to a 2-column one without (too much) pain.

\includegraphics[width=0.95\linewidth]{figs/potato.pdf}
@johnzjq
Copy link

johnzjq commented Dec 9, 2013

Nice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment