LaTeX

From miki
Jump to navigation Jump to search

Links

Related pages on this wiki
Personal pages
External references
Tools
  • PDF viewer (for Beamer)
    • pdfpc — On Ubuntu / Debian, the package is called pdf-presenter-console (just make sure that this package installs David Vilar's fork version).

Install

Any Linux

See TeXLive.

Ubuntu

See Ubuntu reference page or TUG Debian/Ubuntu reference page.

Complete install

Use this guide to install the complete and latest TexLive on Ubuntu (~4GB)

DO NOT FORGET to disable any filtering proxies! Because it will reject packages containing ad*. 

git clone https://github.com/scottkosty/install-tl-ubuntu.git
cd install-tl-ubuntu
sudo ./install-tl-ubuntu 
# OR                                            
sudo ./install-tl-ubuntu -q http://www.ctan.org/tex-archive        # to force a repository
Partial install

Choose an official repository

  • Trusty 14.04 — Default version on is TexLive 2013 (2013.20140215-1)
  • Precise 12.04 — Default version on is TexLive 2009.
  • Precise 12.04 — Install this texlive backports ppa provides TexLive 2012 (see [1])
sudo add-apt-repository ppa:texlive-backports/ppa

Install at least the following packages for a minimum install 

sudo apt-get install texlive
sudo apt-get install texlive2html                 # To support TeX to HTML conversion
sudo apt-get install texlive-xetex                # To install XeTeX

Install these extra packages 

sudo apt-get install texlive-plain-extra texlive-science texlive-latex-extra texlive-publishers texlive-fonts-extra cm-super
Configuration / troubleshoot
  • Update pdftex.map in the user profile (see [2]):
updmap                # Update user's pdftex.map

On Windows

  • Install Miktex 2.9 or later.
  • Package minted requires Pygments, see [3].
    • Install Python 2.7.x
    • Install Python pip
    • Add C:\Python27\Scripts to PATH
    • Start 'cmd.exe', and install pygments:
pip install pygments
  • Package IEEEtrantools.sty must be installed manually, see [4]
    • Download IEEEtrantools.sty into C:\Program Files\MiKTeX 2.9\tex\latex\IEEEtran\IEEEtrantools.sty
    • Start "MiKTeX 2.9\Maintenance (Admin)\Settings (Admin)". Inside this program click the button "Refresh FNDB".

Invocation

Basic commands for LaTeX documents (using TeXlive under Linux or MikTeX under Windows): 

pdflatex <file.tex>             # Convert a .tex file directly to pdf format
latex <file.tex> 		# Convert a .tex file to .dvi file
dvips <file.dvi>		# Convert a .dvi file to .ps
dvipdfm -p a4 <filetex>		# Convert a .dvi file to .pdf (using a4 paper)

For TeX documents: 

pdftex <file.tex>               # Convert a .tex directly into .pdf
tex <file.tex>                  # Convert a .tex into .dvi

For XeLaTex documents (with BibTex entries): 

xelatex <file.tex>              # Generate the .aux file needed by BibTex
bibtex <file.aux>               # Process bib entries
xelatex <file.tex>              # 1st pass will generate .pdf w/o references
xelatex <file.tex>              # 2nd pass will generate .pdf w/ references

Alternative to bibtext:

  • biblatex (optionally with the back-end biber)

Packages

Miscellaneous packages

  • eledmac — Typeset scholarly editions (when lots of footnotes, endnotes are used).
  • alltt — define environment alltt, which is like verbatim but where \ { } keep their usual meaning.
  • longtable — Like tabular but produces table that can be broken over several pages.
  • adjustbox — The package provides several macros to adjust boxed content (similar to \includegraphics[width=...,height=...,keepaspectratio]). See also comment in [5]).

algorithmicx, algorithmic2e (algorithms)

(See LaTeX wikibooks for a comparison of algorithm typesetting packages).

algorithmicx (manual algorithmicx.pdf, debian texlive-science) is a package to typeset algorithms either in pseudo-code or in real language (Pascal and C for now).

There are 2 pseudocode layouts. The layout algcompatible is fully compatible with older package algorithmic, except for the following differences:

  • Include package algorithmicx and algcompatible instead of algorithmic:
\usepackage{algorithmicx}
\usepackage{algcompatible}
  • No \RETURN statement. This can be defined as
\algloopdefx{RETURN}[0]{\textbf{return} \ }
% Alternate definition:
% \newcommand{\RETURN}{\State \textbf{return} \ }
  • With algorithmic, empty lines were obtained with \\ ~ \\. There is a dedicated command in algorithmicx:
\Statex                        % Insert empty un-numbered line

Otherwise it is recommended to use layout algpseudocode, which uses the same commands but with a different letter case and allows defining new commands. Below is a summary of available commands. 

\begin{algorithmic}[1]
\State $sum\gets 0$
\Statex
\textbf{return} $sum$\Comment{The sum is $sum$}
\end{algorithmic}

\For{<text>}
    <body>
\EndFor

\ForAll{<text>}
    <body>
\EndFor

\While{<text>}
    <body>
\EndWhile

\Repeat
    <body>
\Until{<text>}

\If{<text>}
    <body>
\ElsIf{<text>}
    <body>
\Else
    <body>
\EndIf

\Procedure{<name>}{<params>}
<body>
\EndProcedure

\Function{<name>}{<params>}
<body>
\EndFunction

\Loop
<body>
\EndLoop

\Require something
\Ensure something
\Statex
\State \Call{Create}{10}

Save, restore algorithms: 

\algstore{<savename>}
\algstore*{<savename>}
\algrestore{<savename>}
\algrestore*{<savename>}

algorithmic2e (manual algorithm2e.pdf) is yet another package, which as of 2013, seems to be the most frequently used package bundle [6]. It has a nice option to draw vertical lines for delimiting blocks, but looks more complicated and harder to read.

authblk

Use the authblk package to display the author affiliation using a footnote system in class article.

For instance: 

\documentclass[11pt]{article}
\usepackage{authblk}

\author{Firstname Name}
\author{Firstname Name}
\affil{Company A}
\author{Firstname Name}
\affil{Company B}

\title{...}
\date{...}

\begin{document}
\maketitle
\end{document}

In XeLaTeX, we need to patch authblk when using the xltxtra package with fonts that have superior glyphs (for instance Palatino Linotype or Minion Pro): 

\usepackage{xltxtra}
\usepackage[noblocks]{authblk}
\setmainfont{Minion Pro}

% We patch authblk to keep superscript from xltxtra package
% See http://tex.stackexchange.com/questions/168095
\makeatletter
\renewcommand\AB@authnote[1]{\textsuperscript{#1}}
\renewcommand\AB@affilnote[1]{\textsuperscript{#1}}
\makeatother

caption

Use the caption package (manual caption-eng.pdf}}) to format captions: 

\usepackage[margin=10pt,textfont=it,labelfont=bf,labelsep=endash]{caption}

There are also other caption packages:

  • ccaption (continued captions)
  • mcaption (margin captions)

cleveref, varioref (smart references)

The cleveref (manual cleveref.pdf, debian texlive-latex-extra) package enhances LaTeX cross-referencing features, allowing the format of references to be determined automatically according to the type of reference.

From the manual:

  • The cleveref package must be loaded after all other packages that don't specifically support it (see manual, §13). Also note that all \newtheorem definitions must be placed after the cleveref package is loaded.
% Load cleveref as last package!
\usepackage{cleveref}
\usepackage[capitalise]{cleveref}        % Always capitalize labels
\usepackage[noabbrev]{cleveref}          % Never use abbreviations in labels

\newtheorem{theorem}{Theorem}            % These must come AFTER loading cleveref
\newtheorem{myclaim}{Claim}
  • Most frequently used commands:
\cref{label}                      % Insert a reference, including label
\Cref{label}                      % ... idem, but at the beginning of a sentence
\crefrange{label1}{label2}        % Insert a range of references
\Crefrange{label1}{label2}        % ... idem, but at the beginning of a sentence
  • Don't use cleveref with eqnarray. Use amsmath better alternatives.
  • cleveref conflicts with algorithmic package, so use algorithmicx package instead. Unfortunately this is not possible with IEEE publication since algorithmic is included by default.

float

Better controls on float + custom style. See [7].

listings, minted (source listings)

listings is the old-fashioned way to insert code listings in LaTeX.

minted (manual minted.pdf, debian texlive-latex-extra) is a package that facilitates expressive syntax highlighting using the powerful Pygments library. It requires : 

sudo apt-get install python-setuptools
sudo easy_install Pygments

All .tex files using minted must be compiled with option -shell-escape: 

xelatex -shell-escape myfile.tex

Some minimal examples (see manual for more): 

\begin{minted}{python}
def boring(args = None):
pass
\end{minted}

\mint{python}|import this|

% Use ''listing'' environment when adding a caption / label
\begin{listing}[htb]              % Use [H] to force listing HERE
\mint{cl}/(car (cons 1 ’(2)))/
\caption{Example of a listing.}
\label{lst:example}
\end{listing}
Listing \ref{lst:example} contains an example of a listing.

MnSymbol

Use package MnSymbol (manual MnSymbol.pdf) to get access to many more symbols (from [9]).

The package is incompatible with packages amssymb and amsfonts. A solution is to load MnSymbol after these package (see manual; see also [10] for another solution): 

\documentclass[a4paper,twoside,11pt]{report}
\usepackage{amssymb}
\usepackage{amsfonts, amsmath, amsthm}
\usepackage{MnSymbol}
%...

soul

Use package soul (manual soul.pdf, debian texlive-plain-extra) to highlight, underline, hyphenate texts, or use small caps and change kerning, letter spacing. See manual for details.

LaTeX example: 

\documentclass[a4paper]{article}
\usepackage{color,soul}

\begin{document}
Some normal text.\par
\hl{Some highlighted text.}\par
Some more normal text.
\end{document}

TeX example (requires color package from CTAN, see manual): 

\input color
\input soul.sty

\pdfoutput=1
\pdfpagewidth=21cm
\pdfpageheight=29.7cm

Some text here\par
\hl{Some highlighted text now}\par
Some more text\par

\bye

Troubleshooting Reconstruction error: 

\hl{match of next brace, bracket, comment, \tt\#define}             % WRONG
\hl{match of next brace, bracket, comment, \tt \#define}            % CORRECT
\hl{/$s$\enter\ ?$s$\enter}                                         % WRONG
\hl{{/$s$\enter} {?$s$\enter}}                                      % CORRECT
\hl{These are {\it italic words} and these not}                     % WRONG
\hl{These are \it italic words \rm and these not}                   % CORRECT

subcaption

Use package subcaption (debian texlive-latex-recommended) to easily place figures side-by-side [11],[12]. Each sub-caption can have their own caption that are typeset with a specific sub-caption style. Alternatively, one can use minipage environment as well, but it does not align figures and captions appear like ordinary captions.

Note that packages subfig and subfigures are deprecated. 

\usepackage{subcaption} 
... 
\begin{figure}
  \centering
  \begin{subfigure}[b]{0.4textwidth}
    \centering
    \includegraphics[width=textwidth]{1.png}
    \caption{Picture 1}
    \label{fig:1}
  \end{subfigure}

  \begin{subfigure}[b]{0.4textwidth}
    \centering
    \includegraphics[width=textwidth]{2.png}
    \caption{Picture 2}
    \label{fig:2}
  \end{subfigure}
\end{figure}

\begin{figure}
  \centering
  \begin{minipage}[b]{0.4textwidth}
    \centering
    \includegraphics[width=textwidth]{1.png}
    \caption{Picture 1}
    \label{fig:1}
  \end{subfigure}

  \begin{minipage}[b]{0.4textwidth}
    \centering
    \includegraphics[width=textwidth]{2.png}
    \caption{Picture 2}
    \label{fig:2}
  \end{subfigure}
\end{figure}

Font, Font Packages, and Managing Fonts

My font selection - beamer
\defaultfontfeatures{Mapping=tex-text}
\setprimaryfont{Calibri}
\setallmonofonts[Scale=0.90]{Museo Slab}%{Calibri} %[Scale=0.8]                 % Also call \setmonofont
\setallsansfonts{Calibri}                                                       % Also call \setsansfont
Some fonts
The original TeX font designed in MetaFont. Now exists in scalable version in Type 1, TrueType and OpenType (see also debian package cm-super).
The Latin Modern fonts are enhanced versions of the Computer Modern fonts. They have enhanced metrics and glyph coverage.
 %\usepackage[T1]{fontenc}
 %\usepackage[adobe-utopia]{mathdesign}
 \usepackage{fourier}
  • Palatino Linotype
  • Minion Pro (available via Adobe Reader)
  • Blackboard sans-serif fonts: Use package dsfont [13]
\usepackage[sans]{dsfont}
\mathds{A}
  • Calibri and Andale Mono
\setmainfont{Calibri}
\setmonofont[Scale=0.86]{Andale Mono}
Fonts on LaTeX
  • If LaTeX complains about fonts, maybe you need to update the pdftex.map:
updmap
  • In document, it seems good to select Type 1 encoding, whatever it means. However this seems automatic in recent TexLive version:
 \usepackage[T1]{fontenc}
Fonts on XeLaTeX
  • Change fonts with package fontspec and commands like \setmainfont and \setmonofont.
  • The xunicode package provides additional mapping between LaTeX accents and the selected font.
  • The xltxtra package provides some fixes relating to fonts.
  • Also nice, use the microtype package:
\usepackage[final,expansion=true,protrusion=true,spacing=true,kerning=true]{microtype}
Some references and font troubleshooting links
  • See fntguide.pdf.
  • Which LaTeX font packages contain real small caps and work with the “microtype” package? [14],
  • Why do I suddenly get an auto expansion error? [15]
  • pdfTeX error (font expansion): auto expansion is only possible with scalable [16]
Deprecated

\sf, \bf, \it are deprecated. Prefer text alternatives like \textbf (see [17])

Reference

Syntax - Basic

Links
\dots
Special characters 
\# \$ \% \^{} \& \_ \{ \} \~{} \textbackslash
LaTeX Commands 
\TeX{} and         % space (tx to {})
\TeX{}nicians and  % NO space
\TeX perts.        % NO space
Document class 
\documentclass[options]{class}  % See manual for reference
Packages 
\usepackage[options]{package}   % See manual for list of packages
Page style 
\pagestyle{style}       % plain, headings, empty
\thispagestyle{style}   % for current page only
Colors 
\usepackage[usenames,dvipsnames,svgnames]{xcolor}% before tikz or tkz
\definecolor{Maroon}{rgb}{0.5,0.0,0.0}%{.80,.80,.95}
\definecolor{fondpaille}{cmyk}{0,0,0.1,0}
\pagecolor{fondpaille}                              % Setup default background color
\color{Maroon}                                      % Setup default foreground color
Big project 
\include{filename}           % Insert content of file - LaTeX starts a new page
\includeonly{filename,...}   % (in preamble) restrict list of included files
\input{filename}             % Simply includes the file
Breaks 
Supercalifragilist%
     icexpialidocious        % Use % to break lines without inserting space in output (here single word)
\\                           % Start a new line without starting a new paragraph
\newline                     % idem
\\*                          % idem, but prohibits page break after forced line break
\newpage                     %
\linebreak[n]                % Suggest LaTeX where to break (or not) page (n=0..4)
\nolinebreak[n]              %
\pagebreak[n]                %
\nopagebreak[n]              %
\sloppy                      % Tell LaTeX to relax its layout standards
\fussy                       % Reset to default layout behaviour

\sloppy might be used to fix "overfull hbox" message and line sticking out on the right of paragraphs (although usually result is not really good). Use option draft in document class to identify these issues more easily

Hyphenation 
\hyphenation{FORTRAN Hy-phen-a-tion} % Instruct LaTex where (and not) insert hyphens
su\-per\-cal\-i\-frag        % Instruct hyphen locally (handy for accented words)
\mbox{0116 291 2319}         % Content of \mbox is kept togetter
\fbox{0116 291 2319}         % Idem, with surrounding box
input/output                 % Slash / prevents hyphenation
input\slash output           % ... so use \slash instead
Special characters and symbols 
`x'                               % single quotation marks
``quote''                         % double quotation marks
daughter-in-law                   % 'hyphen' dash
pages 13--67                      % 'en-dash'
yes---or no?                      % 'em-dash'
$0$, $1$ and $-1$                 % 'minus' sign
http://www.clever.edu/$\sim$demo  % tilde for url (better than \~{})
5MB/s                             % slash, but hyphenation disabled
read\slash write                  % slash, with hyphenation allowed
$-30\,^{\circ}\mathrm{C}$         % degree symbol
30 \textcelsius{}                 % idem, easier (with package 'textcomp')
\texteuro, \euro, €               % various ways to get euro sign (see manual for variants)
\ldots \cdots                     % ellipsis (low dots), centered dots
\dotsc \dotsb \dotsm \dotsi \dotso% semantics dots, for: commas, binary ops, multiply, integrals, other
\dots                             % SMART dots, from amsmath (same as above, but auto-guess)
not shelfful, but shelf\mbox{}ful % use \mbox{} to prevent ligatures
H\^otel na\"\ive \'el\`eve        % some example of accents (see manual for more)
International support 
\usepackage[utf8]{inputenc}       % Enable utf-8 (see also XeLaTeX)

% French support
M\up{me}, D\up{r}, 1\ier{}...     % See manual for more
Spacing 
Not\ expandable space             % non-expandable space
Mr.~Smith                         % Idem + non-breakable
I like BASIC\@. What about you?   % Indicate . is end of sentence
Titles, Chapters, Sections 
\chapter[Shorter title]{...}      % For 'report' or 'book' class
\part{...}                        % Does not influence section / chapter numbering
\appendix{...}                    % Like chapters, using letters for numbering
\section{...}
\section*{...}                    % unnumbered section, not in TOC
\subsection{...}
\subsubsection{...}
\paragraph{...}
\subparagraph{...}
\tableofcontents
\title{...} \author{...} \date{...}
\maketitle
Cross References 
\label{sec:this}
See section~\ref{sec:this}
See page~\pageref{sec:this}
As in equation~\eqref{eq:this}
Footnotes 
\footnote{text}                   % after word or sentence (i.e. after comma or dot)
Emphasized Words 
\underline{text}
\emph{text}
Subscript and superscript 
\usepackage{xltxtra}
CO\textsubscript{2}
4\textsuperscript{th}
Environments 
\begin{itemize}
\item one
\item[-] two with a dash
\end{itemize}

\begin{enumerate}
\item first
\item second
\end{itemize}

\begin{description}
\item[One] one
\item[Second] second
\end{description}

\begin{flushleft} \end{flushleft}    % Can also be used as \flushleft, \flushright...
\begin{flushright} \end{flushright}
\begin{center} \end{center}
Miscellaneous 
/verb|\verb+...+| allows verbatim text              % but does NOT work in macro arguments  
...
\begin{frame}[fragile]
In beamer, frame must be /verb|[fragile]|
\end{frame}

\usepackage{graphicx}                               % Rotation
My rotated \rotatebox{90}{text}
Beamer 
/alert{Some text.}

% Change the font size for one frame
\begin{frame}{}
\fontsize{10pt}{12.0}\selectfont   % \fontsize{<font size>}{<value for \baselineskip>}\selectfont
\end{frame}
Colors 
\usepackage{xcolor}
\definecolor{bashstring}{RGB}{186,33,33}
\textcolor{bashstring}{my string}
{\color{bashstring}mystring}                        % declaration, within a TeX group
{\color{bashstring}\verb+also work with verbatim+}  % declaration mandatory with \verb

Syntax - Mathematics

Fractions
\frac{1}{\sqrt{2}+\frac{1}{\sqrt{2}+\frac{1}{\sqrt{2}+\dotsb}}} % Standard fraction

$$\frac{1}{\sqrt{2}+\frac{1}{\sqrt{2}+\frac{1}{\sqrt{2}+\dotsb}}}$$ 

\cfrac{1}{\sqrt{2}+
 \cfrac{1}{\sqrt{2}+
   \cfrac{1}{\sqrt{2}+\dotsb
}}}                                                             % Continued fraction

$$\cfrac{1}{\sqrt{2}+ 

\cfrac{1}{\sqrt{2}+
  \cfrac{1}{\sqrt{2}+\dotsb

}}}  % Continued fraction$$ 

\tfrac{1}{2}                                                    % Tiny fraction, like in textstyle

$$\tfrac{1}{2}  % Tiny fraction, like in textstyle$$

Multiline and multiple equations
% Multiline -- Easiest is to use multiline, best is to use IEEEeqnarray
\begin{multline}
a + b + c + d + e + f + g + h + i
\\
= j + k + l + m + n
\end{multline}

$$\begin{multline} a + b + c + d + e + f + g + h + i \\ = j + k + l + m + n \end{multline}$$ 

% Multiple equations - Easiest is to use \begin{align} if NO line too long
\begin{align}
a & = b + c \\
& = d + e
\end{align}

$$\begin{align} a & = b + c \\ & = d + e \end{align}$$ 

% Multiple equations - ... but best is to use IEEEeqnarray (AVOID \begin{eqnarray} !!!)
% See also commands (\begin{IEEEeqnarray*}, \IEEEyesnumber, \IEEEyessubnumber)
% ... also to group several blocks of equations beside each other
% (source: The not so short introduction to LaTeX)
\usepackage[retainorgcmds]{IEEEtrantools}
\begin{IEEEeqnarray}{rCl}
a & = & b + c
\\
& = & d + e + f + g + h + i + j + k \nonumber\\
&& +\: l + m + n + o
\\
& = & p + q + r + s
\end{IEEEeqnarray}

\begin{IEEEeqnarray}{rCl}
\IEEEeqnarraymulticol{3}{l}{
a + b + c + d + e + f + g + h
}\nonumber\\ \quad
& = & i + j
\\
& = & k + l + m
\end{IEEEeqnarray}
Operators

References: Big-O [18], negative-space fix [19], operator [20] 

\usepackage{amsmath}
\operatorname{sgn} x
\DeclareMathOperator{\sgn}{sgn}            % DO NOT define new op with \newcommand, but this
\DeclareMathOperator*{\esssup}{ess\,sup}   % Starred, with subscript like \sum

$$\operatorname{sgn} x \quad \DeclareMathOperator{\sgn}{sgn} \sgn x \quad \DeclareMathOperator*{\esssup}{ess\,sup} \esssup_{x\in [0,1]}f(x)$$ 

\newcommand{\BigO}[1]{\ensuremath{\operatorname{O}\bigl(#1\bigr)}}        % Simple big-O
\newcommand{\BigO}[1]{\ensuremath{\operatorname{O}\!\left(#1\right)}}     % scaling ()
\newcommand{\BigO}[1]{\ensuremath{\operatorname{\mathcal{O}}\!\left(#1\right)}} % alternate

$$\operatorname{O}\bigl(n^2\bigr) \quad \operatorname{O}\!\left(n^2\right) \quad \operatorname{\mathcal{O}}\!\left(n^2\right) $$

Cases
|x| =
\begin{cases}
0 & \text{if $x \lt 0$,} \\                      % Note the use of \text and $...$
x & \text{if $x > 0$.}
\end{cases}

$$|x| = \begin{cases} 0 & \text{if $x \lt 0$,} \\  % Note the use of \text and $...$ x & \text{if $x > 0$.} \end{cases}$$

Matrices
\begin{pmatrix} 0 & -i \\ i & 0 \end{pmatrix}     % instead of using array

$$\begin{pmatrix} 0 & -i \\ i & 0 \end{pmatrix}  % instead of using array$$ 

$\left( \begin{smallmatrix}1 & 0 \\ 0 & -1\end{smallmatrix} \right)$    % small matrix for inline

$$ \left( \begin{smallmatrix}1 & 0 \\ 0 & -1\end{smallmatrix} \right) $$

Advanced Scripting

These are features typically only used in package.


Enable @ as a standard letter (see [21]) 
\makeatletter
% ...
\makeatother
Test if a given class is loaded

Requires @ as a standard letter 

\@ifclassloaded{<someclass>}
  {<true code>}
  {<false coode>}%

Dimensions & Page Layout

References

Frequently-used dimensions:

\textheight||Height of the page body \textwidth||Width of the page body \linewidth||width in current environment
Useful packages
  • geometry — lets you customize the page size even with classes that do not support the options.
  • layout — To print from a LaTeX document itself the current page layout and dimensions.
  • showframe — To render a frame marking the margins of a document you are currently working on.

Symbols

Some frequently used symbols

$$\bot$$ \bot perpendicular (orthogonal) sign
$$\parallel$$ \parallel parallel sign

XeLaTeX

LaTeX XeLaTeX 
\usepackage{inputenc}
\usepackage{fontenc}
\usepackage{textcomp}

\usepackage[languageA]{babel}

Save file as utf-8 

\usepackage{polyglossia}
\setdefaultlanguage[babelshorthands]{languageA}

\usepackage[Ligatures=TeX]{fontspec}            % To enable --, ---, '', ``, !`, ?`, ,,, <<, >>

Templates

Smallest

%UTF-8 encoding “Нelłó worlð!”

\documentclass{article}
\begin{document}
Small is beautiful.
\end{document}
  • \documentclass[options]{class} takes optional paramters options, and a mandatory document class. See manual for reference.

3-columns

Example of 3-column document, minimum margin, no page numbering (see [22]) 

%UTF-8 encoding “Нelłó worlð!”

\documentclass[a4paper]{article}
% Specify paper size univocally (for pdf output)
\special{papersize=210mm,297mm}
% Set minimum margin using package geometry
\usepackage[a4paper,landscape,top=1cm, bottom=1cm, left=0.5cm, right=1cm]{geometry}
% To support 3-column document, color and highlighting 
\usepackage{multicol,color,soul}
% Remove any footer / header (page numbers...)
\pagestyle{empty}

\begin{document}
\begin{multicols}{3}
Some text here\par
Some more text there\par
And not anymore\par
\end{multicols}
\end{document}

Realistic Journal Article

%UTF-8 encoding “Нelłó worlð!”

\documentclass[a4paper,11pt]{article}
% define the title
\author{H.~Partl}
\title{Minimalism}
\begin{document}
% generates the title
\maketitle
% insert the table of contents
\tableofcontents
\section{Some Interesting Words}
Well, and here begins my lovely article.
\section{Good Bye World}
\ldots{} and here it ends.
\end{document}

Beamer and XeTeX

To change the default font in the document with XeTeX, use the fontspec package. The xunicode package provides additional mapping between LaTeX accents and the selected font. A third package, xltxtra provides some fixes relating to fonts. [23] 

\documentclass[xetex,mathserif,serif]{beamer}
 
\usepackage{fontspec}
\usepackage{xunicode} %Unicode extras!
\usepackage{xltxtra}  %Fixes
\setmainfont{Calibri}
\setmonofont[Scale=0.86]{Andale Mono}

Also nice, use the microtype package: 

\usepackage[final,expansion=true,protrusion=true,spacing=true,kerning=true]{microtype}

Layout and Typesetting

Moved to LaTeX writing tips

Conventions and Examples

Moved to LaTeX writing tips

Tips / How-to

Quick debug

  • Check syntax rapidly by using package syntonly:
\usepackage{syntonly}
\syntaxonly                  % Comment out this line to produce pages
  • Add draft to document class to identify layout issues easily:
\documentclass[draft]{article}

Remove sub-sections from header in beamer presentation

Simplest is to use another outer theme (here infolines): 

\documentclass{beamer}

\mode<presentation>
{
  \usetheme{Antibes}
% \usetheme{Hannover}
  \setbeamercovered{transparent}
% \usefonttheme{structuresmallcapsserif}
% \usefonttheme{structurebold}
 \usecolortheme{beaver}
% tree is default outertheme - but infolines is more compact
% \useoutertheme{tree}
 \useoutertheme{infolines}
}

% slidenumbering
\setbeamertemplate{footline}[frame number]
\setbeamertemplate{sidebar right}{}

Change vertical alignment

Simply use the [t] or [c] modifier (top / center). For frames: 

\begin{frame}[t]{The seven permutation army}

% Top-aligned frame
\end{frame}

For columns: 

\begin{columns}[t]

\begin{column}{0.35\linewidth}
% 1st top-aligned column
\end{column}

\begin{column}{0.65\linewidth}
% 2nd top-aligned column
\end{column}

\end{columns}

How to format BibTex entries and cite sources

References
  • Bibtex package, see example file xampl.bib (entries @INBOOK, @BOOK...).
  • Available entry types, and mandatory fields (see WP:BibTeX)
Examples

Example of bibtex file (extension .bib). 

%UTF-8 (ûτf—8)

@PREAMBLE{ "\newcommand{\noopsort}[1]{} "
        # "\newcommand{\printfirst}[2]{#1} "
        # "\newcommand{\singleletter}[1]{#1} "
        # "\newcommand{\switchargs}[2]{#2#1} " }

@STRING{EUROCRYPT = "Advances in Cryptology --- EUROCRYPT"}

@INPROCEEDINGS{BeRo96pss,
    author    = {Mihir Bellare and Phillip Rogaway},
    title     = {The Exact Security of Digital Signatures --- How to Sign with {RSA} and {R}abin},
    editor    = {U. Maurer},
    booktitle = EUROCRYPT # {'96},
    volume    = 1070,
    series    = LNCS,
    pages     = {399--416},
    year      = 1996,
    publisher = SPRINGER,
}

% Edited year to make sure this entry comes after pkcs1
@MISC{RSA93pkcs3,
    author = {{RSA Laboratories}},
    title  = {Public-Key Cryptography Standards ({PKCS}) \#3: {D}iffie-{H}ellman Key-Agreement Standard Version 1.4},
    month  = nov,
    year   = "{\noopsort{9999}}1993",
}

@MISC{wikipedia:combinadic,
    author       = {Wikipedia},
    title        = {Combinatorial number system --- Wikipedia{,} The Free Encyclopedia},
    year         = {2013},
    howpublished = {\url{https://en.wikipedia.org/wiki/Combinadic}},
    note         = {[Online; accessed 18-June-2014]}
}

Example of citation: 

\bibliographystyle{amsplain}
\providecommand{\shortcite}[1]{\cite{#1}}   % For compatibility with other packages

This as been shown by Bellare and Rogaway~cite{BeRo96pss}.
This results is a well-known fact~cite{wikipedia:combinadic}.

\hbadness 10000   % To avoid warning in bibtex entries with urls
\bibliography{ext,ours}
Recommendations
  • Common Errors in Bibliographies — John Owens
    Authors
    Make the names in the bibliography match what is printed on the paper. For hyphenated names with the second half uncapitalized (Wu-chun Feng, Wen-mei Hwu), put the hyphen and second half in brackets: Wu-{chun} Feng, Wen{-mei} Hwu.
    Capitalization in titles
    Follow capitalization as printed on the paper. The bib style should enforce capitalization, not your bibliography. Properly bracket {} words in titles that must be capitalized.
    Months
    Include the month of publication in your bibliographies.
    Pages
    Always include pages if pages are available.
  • Search article in CiteSeerX, and if found, copy bibtex entry.
  • For wikipedia article xxx, use the special wikipedia pageSpecial:Cite/xxx that generates automatically a bibtex entry(eg. Special:Cite/Continued_fraction)
  • The simplest solution for URLs is to use the howpublished field [24] [25].
    howpublished   = {\url{http://en.wikipedia.org/wiki/RSA\_(cryptosystem)}},
Other alternative are to use more modern styles with support of url and url field, or use biblatex.
  • Use curly brackets {} when necessary: keep word together in author field author = Template:RSA Laboratories ,protect uppercase words {UPPERCASE}, capitalise all significant words, to allow for bibliography styles that want this [26]
  author = {{RSA Laboratories}}
  title = {Pascal, {C}, {Java}: {Were} they all Conceived in {ETH}?}

When citing sources:

  • Don't use bracketed numbers as word:
Foo showed that bar~\cite{Foo:2000:BAR}
Foo showed that bar~\shortcite{Foo:2000:BAR}             % +++ BETTER - Avoid name repeat
In \cite{Foo:2000:BAR}, Foo shows that bar.              % !!! BAD
This requires to add in your document, in case the bibtex style does not support it
\providecommand{\shortcite}[1]{\cite{#1}}
  • Use ~ to prevent break before citation and group several citations together using a comma:
text text text~\cite{Foo:2000:BAR}
\cite{AuthorOne:2000:ABC,AuthorTwo:2002:DEF}
\cite{AuthorOne:2000:ABC}\cite{AuthorTwo:2002:DEF}       % !!! BAD !!!
  • Convert .ris to .bib — Install package cb2bib and bibutils, then
/usr/share/cb2bib/c2btools/ris2bib 1996-EUROCRYPT-016.ris output.bib
  • Use {\noopsort{XXX}} to override default sort odering, e.g. in author or year field (see xampl.bib). For instance, here we don't change author name but use the fact that year is used as 2nd sort key to make sure second entry comes after the first entry:
@preamble{ "\newcommand{\noopsort}[1]{} " }

@MISC{RSA12pkcs1,
    author = {{RSA Laboratories}},
    title  = {Public-Key Cryptography Standards ({PKCS}) \#1: {RSA} Cryptography Specifications Version 2.2},
    year   = {2012},
}

@MISC{RSA93pkcs3,
    author = {{RSA Laboratories}},
    title  = {Public-Key Cryptography Standards ({PKCS}) \#3: {D}iffie-{H}ellman Key-Agreement Standard Version 1.4},
    year   = "{\noopsort{9999}}1993",
}

An alternative solution is to use \setbox0=\hbox{XXX}: 

@MISC{RSA93pkcs3,
    author = {{RSA Laboratories}},
    title  = {Public-Key Cryptography Standards ({PKCS}) \#3: {D}iffie-{H}ellman Key-Agreement Standard Version 1.4},
    year   = {\setbox0=\hbox{9999}1993},
}
Software
Referencer — a GNOME application to organise documents or references, and ultimately generate a BibTeX bibliography file.

Source code listing

See package minted or listings above.

Fix horizontal alignment

  • Use \rlap and \phantom. Note that \rlap does not work in math mode, so we apply a workaround (better solution here)
$\crtCp \gets \rsacipher \bmod \rsap$
{\rlap{$\crtCq$}}$\phantom{\crtCp} \gets \rsacipher \bmod \rsaq$
  • Use \array, and play with [pos] option for vertical alignment in the paragraph, and @{} to suppress inter-column space:
$\begin{array}[t]{@{}r@{}l}
  \crtCp &\ \gets \rsacipher \bmod \rsap \\
  \crtCq &\ \gets \rsacipher \bmod \rsaq
\end{array}$
  • Fix unwanted space when using \left ... \right. Insert negative space \! (see [27] for better solution)
\newcommand{\BigO}[1]{\ensuremath{\operatorname{O}\!\left(#1\right)}}

Find LaTeX symbols

See the Links section.

For instance, Detexify2 or shapecatcher.com recognize symbols drawn with the mouse. There are also extensive symbol lists.

Force big floats after current page

Say you have a document with lots of big figures or listings that you put in floats. LaTeX usual behavior with such big floats appears quite frustrating, and usually pushes these floats up to the end of current chapter / section.

The solution apparently is to always give all placement specifier [htbp], which let LaTeX chooses the best option. If this does not work, one can force LaTeX with [p!]: 

\begin{listing}[htbp]
%\begin{listing}[p!]       % To force float to next page
\begin{minted}{python}
...
\end{minted}
\end{listing}

Another solution would be to use package afterpage [28], but I sometimes get error about lost floats (see this question): 

... Float(s) lost
... This may be a LaTeX bug.

% In preamble:
\usepackage{afterpage}

% Before the float, ask to call \clearpage after current page:
\afterpage{\clearpage}
\begin{listing}[htbp]       % We let LaTeX choose best placement (not necessarily next page)
\begin{minted}{python}
...
\end{minted}
\end{listing}

Add vertical space between tables

Use \par\vspace{2em} (see also [29], but /newline does not work). This combination is the most stable and doesn't require empty lines: 

\begin{tabular}{c|l}
%...
\end{tabular}
\par\vspace{2em}
\begin{tabular}{c|l}
%...
\end{tabular}

Syntax / style checker for LaTeX

Use package chktex or lacheck.

Define minipage width

\begin{minipage}{\linewidth}    % Use current line width as minipage width
  % ...
  \captionof{table}[short]{Long}
\end{minipage}

Several options [30]:

  • Use \textwidth, which stays constant.
  • Use \linewidth, which adapts to surrounding environment (like enumerate or itemize

Fix Overfull \hbox

  • Use sloppy or better, \begin{sloppypar}...\end{sloppypar} to tell LaTeX to temporarily relax metrics regarding maximum interword / intercharacter spacing...
  • Use \noindent and comments % to prevent LaTex from inserting space that would create overflow. For insance:
This overflows. 
\begin{minipage}{.40\linewidth}
Hello,
\end{minipage}
\hfill
\begin{minipage}{.60\linewidth}
World!
\end{minipage}

This doesn't. 

\noindent\begin{minipage}{.40\linewidth}
Hello,
\end{minipage}% don't let LaTeX insert space here
\hfill
\begin{minipage}{.60\linewidth}
World!
\end{minipage}

Place figure side-by-side

See package subcaption.

Drawing on top of an image

Using tikz (see [31]). Use a scope such that (0,0) is bottom left of the picture, and (1,1) is top right. 

\begin{tikzpicture}
    \node[anchor=south west,inner sep=0] (image) at (0,0)
      {\includegraphics[width=0.9\textwidth]{matrix-ranking.png}};
    \begin{scope}[x={(image.south east)},y={(image.north west)}]
        % This draw a grid with label
        \draw[help lines,densely dotted,xstep=.02,ystep=.02] (0,0) grid (1,1);
        \draw[help lines,xstep=.1,ystep=.1] (0,0) grid (1,1);
        \foreach \x in {0,1,...,9} { \node [anchor=north] at (\x/10,0) {0.\x}; }
        \foreach \y in {0,1,...,9} { \node [anchor=east] at (0,\y/10) {0.\y}; }
        % Use the grid above to draw at desired place
        \draw[green,line width=3pt] (0.4,0.5) rectangle ++(0.2,0.1);
    \end{scope}
\end{tikzpicture}

Another option is to use package overpic. 

\usepackage[percent]{overpic}

\begin{overpic}[scale=.25]{golfer.ps}
    \put(5,45){\huge \LaTeX}
    \put(55,10){\includegraphics[scale=.07] {golfer.ps}}
\end{overpic}

Preventing page breaks between lines / Handling widows and orphans

See http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nopagebrk.

  • Use environment samepage
  • Enclose all relevant stuff in a \parbox or minipage.
  • ... (use \raggedbottom...)

To handle orphans (single line at bottom of the page) / widows (top of the page) [32]: 

\widowpenalty10000
\clubpenalty10000

Other tricks:

  • Use sloppypar (see [33]).

Find files in texlive distribution

kpsewhich latex.ltx

Get documentation on package

texdoc source2e

Add line breaks in table cell

  • Define the command [34]
\newcommand{\specialcell}[2][c]{%
  \begin{tabular}[#1]{@{}c@{}}#2\end{tabular}}

Use it as follows: 

Foo bar & \specialcell{Foo\\bar} & Foo bar \\    % vertically centered
Foo bar & \specialcell[t]{Foo\\bar} & Foo bar \\ % aligned with top rule
Foo bar & \specialcell[b]{Foo\\bar} & Foo bar \\ % aligned with bottom rule
  • Alternatively, use \shortstack [35]
\documentclass{article}

\begin{document} 
\begin{tabular}{ccc}
    one & two & three \\
    one & two & \shortstack{a \\ bb \\ c}\\
\end{tabular}
\end{document}

\begin{tabular}{|p{3cm}|p{3cm}|}
first line
\newline second line & still on first line \\
\end{tabular}
  • Use \parbox, but this does not look convenient
\begin{tabular}{ll}
one line& \parbox[t]{5cm}{another\\column}\\
second line here& and here
\end{tabular}
  • Other solutions: use \makecell [37]

Avoid TeX commands

  • Don't use $$ in LaTeX, it is a plain TeX command.

Troubleshoot

LaTeX Error
Cannot determine size of graphic (no BoundingBox)
LaTeX does not find the BoundingBox information which is necessary to produce the .dvi file. A way to fix this is either to edit the graphic to add the bounding box information, or to use pdflatex to produce directly a .pdf file.
Missing table of content (file *.toc not found)
This happens when the command \tableofcontents is used in the document, but LaTeX did not produce yet a table of content file. The .toc file is produced at the first invocation. To solve this, just run LaTex a second time:
pdflatex mypresentation.tex                   # produce a pdf without toc, and a toc file
pdflatex mypresentation.tex                   # produce a pdf with toc generated in the previous pass
"seac" character deprecated in Type 2 charstring
We get the following error from XeTeX.
** WARNING ** "seac" character deprecated in Type 2 charstring.
** ERROR ** Type2 Charstring Parser: Parsing charstring failed: (status=-1, stack=5)

Output file removed.
This happens when using OpenType fonts (OTF) with accented characters (even i counts as accented!).
The possible fixes are either to use another font, convert the font to TTF, or fix the buggy OTF.
Command \sups already defined.
Occurs when compiling with xelatex. See file /usr/share/texmf/tex/latex/tipa/tipa.sty, line 478.
This is apparently a conflict between tipa and fontspec in TeXLive2012 (TeXLive2009 seems ok, see [38])
"Underfull \hbox (badness 10000) in paragraph at lines X--Y" in bibliography with url
  • Add code below to preamble. This LaTeX to allow huge badness when using sloppy command (from [39])
\usepackage{etoolbox}
\apptocmd{\sloppy}{\hbadness 10000\relax}{}{}    % To avoid warning in bibtex entries with urls
  • Alternatively, simply increase hbadness before bibliography section:
\hbadness 10000   % To avoid warning in bibtex entries with urls
\bibliography{ext}
"Missing elsarticle.cls"
  • Install package texlive-publishers to get elsarticle.cls (since TeXLive 2012 — was part of texlive-latex-extra in TeXLive 2009).
"auto expansion is only possible with scalable fonts" (when using microtype and fourier (aka utopia) package)
  • We get the following message when compiling with pdflatex:
[1{/home/beq06659/.texmf-var/fonts/map/pdftex/updmap/pdftex.map}
! pdfTeX error (font expansion): auto expansion is only possible with scalable 
fonts.
\AtBegShi@Output ...ipout \box \AtBeginShipoutBox 
                                                  \fi \fi 
l.105
  • The error is because pdftex.map is located in user's profile and is not up-to-date [40]. Update pdftex.map with:
updmap                   # Update pdftex.map
hyperref — Failed to convert input string to UTF16

We get this warning when using package hyperref, with option unicode: 

** WARNING ** Failed to convert input string to UTF16...

The solution is to add option pdfencoding=auto [41]: 

 \usepackage[unicode=true,pdfencoding=auto]{hyperref}
Float(s) lost... This may be a LaTeX bug.

We can get this message when using package minted and afterpage. It seems to happen when we insert a float right after the first paragraph on a page. The bug seems related to both minted and afterpage because removing any of these package fixes the bug (note that the bug occurs even if the float does not use minted). 

\afterpage{\clearpage}
\begin{figure}[htpb]
abracadabra
\end{figure}

There is no fix I know of. The only workaround is to move the figure up or down in the text so that it is no longer inserted after the first paragraph on a page.

Note that a better option seems to remove afterpage, and set the placement specifier correctly instead.

Extra '\fi' with IEEEeqnarray - with package cleveref / IEEEtrantools
  • Bug is due to cleveref still using deprecated function of IEEEtrantools (\if@IEEEissubequation and \if@IEEElastlinewassubequation)
  • A temp fix
\makeatletter
\newif\if@IEEEissubequation
\@IEEEissubequationfalse
\makeatother
\usepackage[capitalize,noabbrev]{cleveref}
Never use _ in a filename (e.g. \includegraphics)
  • LaTeX will take _ as subscript character, and will produce strange errors.

Graphics in LaTeX

Insert graphics in LaTeX

Use the command includegraphics: from package graphicx. Ideally, graphics dimensions are given relative to current \linewidth and \textheight. Usually graphics are inserted in a figure environment. 

\begin{figure}[htpb]
% Insert a graphics with given max width and height, but keeping aspect ratio
\includegraphics[width=\linewidth,height=\textheight,keepaspectratio]{picture}
\end{figure}

Using package PGF/TikZ

PGF/TikZ is a graphical interpreter that produces high-quality graphics. See page PGF/TikZ.

Using Asymptote

Asymptote is a powerful descriptive vector graphics language that provides a natural coordinate-based framework for technical drawing.

Importing MS Visio Graphics

Method 1: Using OpenOffice Draw

This procedure creates from a Visio drawing, a PDF file that has the correct page dimension in order to be directly imported in a LaTeX document. This procedure requires to have OpenOffice Draw installed.

  • In Visio, File → Save As, select type Enhanced Metafile (.emf), enter a file name, click Save.
(Using intermediate .emf is less convenient but gives better results than Paste Special as GDI object, which sometimes modify the pasted object)
  • In OpenOffice Draw, Open the newly saved file, Select the drawing with the mouse, and then go to menu File → Export.
  • Check the box Selection, select format EPS - Encapsulated PostScript (.eps), save the file.
  • Press OK, to accept all default options (no preview, Level 2, Grayscale, no compression)
  • In a shell, type the LaTeX command
epstopdf <filename.eps>

which will create a file <filename.pdf> with the correct page size.

Limitations
Some line formats are not correctly rendered by OpenOffice Draw when exporting to EPS format.

Method 2: Using Custom PostScript Page Size

This procedure can be used to solve problem in the 1st method where some line formats are not correctly rendered in the EPS. This procedure requires to have a PDF printer installed, such as PrimoPDF.

  • In Visio, select the drawing to print, and copy-paste it into a new document.
  • Go to menu File → Page Setup
    • Go to Page Size panel
    • Select Size to fit drawing contents, and note the page size as computed by Visio
  • Go to Print Setup panel
    • Click on Printer Paper Setup
    • Click on Printer...
    • Select the PDF printer, and click on Properties...
    • Click on Advanced...
    • For Paper size, select PostScript Custom Page Size, then click on Edit Custom Page Size
    • Select unit Millimeter, and then in Width and Height, enter the same size as computed by Visio, plus 1 or 2mm.
  • Click Ok buttons until back in the Print Setup dialog. Set Left, Right, Top and Bottom margin to be 0mm, and select Center horizontally and Center vertically.
  • If necessary, move the drawing so that it fits perfectly in the middle of the page.
  • Print the document.

The result is a PDF document with the best output quality and the correct dimension.

Limitations
Sometimes text police are rasterized.

Other methods using Visio 2007

  • Go to menu File → Page Setup
    • Go to Page Size panel
    • Select Size to fit drawing contents
  • Go to menu File → Publish as PDF or XPS

Other methods using Visio 2010

  • Force page margin to 0 in, as explained in [42]. Assuming you already have the developer tab in the Ribbon:
    • On the Developer tab, click Show ShapeSheet, and then click Page.
    • In the Print Properties section of the ShapeSheet, set the following values to 0:
      • PageLeftMargin
      • PageRightMargin
      • PageTopMargin
      • PageBottomMargin
  • On the Design tab, click Size and then Fit to drawing.
  • On the File tab, select Save As, and select .pdf as file type.

Method 3: Using Postscript printer and Perl script

This method is explained here.

  • Install the Adobe Generic Postscript Driver.
  • Configure the printer to use EPS, i.e. right click on the printer → Printer Preferences... → click Advanced button → open Document Options → PostScript Options → Under PostScript Output Option, select "Encapsulated PostScript (EPS)".
  • In Visio, print your drawing to the postscript printer.
  • The bounding box is incorrectly set to the page size. To fix it, use the perl script TightBoundingBox.pl, also copied below (requires gs command from cygwin).

Other methods

  • Give a try to metafile2eps, a tool from LyX to convert EMF to EPS [43]

Import Inkscape graphics

Importing Inkscape + LaTeX

See SVG-Inkscape, in particular the guide to include Inkscape graphics with LaTeX.

Exporting / editng LaTeX equations

There are many editors out there. The best one however seems to be KLatexFormula.

  • Windows / Linux support
  • Instant rendering
  • Drag & drop support
  • Can reopen equations saved in PNG format

Alternatives:

  • Latexeqedit — limited to 300dpi, slow rendering, only PNG, cannot re-open
  • Latexee — very slow
  • EqualX &mdahs; no export, only for building the formula

References

Retrieved from "https://miki.immie.org/mediawiki/index.php?title=LaTeX&oldid=7100"