[ Show as SlideShow ]

Basic LaTeX Editing

Contact: Todd Satogata (Jefferson Lab)

This presentation collects some guidance on LaTeX-specific paper processing for JACoW conferences. It is meant more to be a starting point for guidance, reference, and refresher rather than a tutorial.

Setting Up

LaTeX papers are processed to pdf by command-line programs. JACoW and our associated recommended software configurations mostly use pdflatex for this purpose.

  • pdflatex understands many different graphics file types for figures.
  • pdflatex also (usually) produces compliant pdf with properly embedded fonts when using the JACoW template.

JACoW LaTeX power users may process papers different ways.

  • e.g. Todd lives in the command-line and has a unix Makefile for building and checking LaTeX papers.
  • Other JACoW editors may use Overleaf or a TeX IDE
  • Learn from various experienced editors, find one that matches your "style"

Software: IDEs

The Recommended Software JACoW wiki page suggests TeX IDEs for use

  • New LaTeX editors should install these and get used to compiling LaTeX papers with them
  • The JACoW template class file can easily be installed for use in the package
  • Volker recommends MikTeX/TeXStudio since MikTeX automatically loads packages when needed
  • Jan recommends WinEdt for a front-end IDE

The IDEs provide an integrated environment to edit LaTeX and process to see output PDF

  • TeXShop on Macs uses TeX Live (also auto-updates)

Other users who are used to the command-line may just install TeX packages or TeX live themselves

Software: Overleaf

New users should also explore Overleaf, a web-based LaTeX IDE

  • Overleaf is used in Jan and Todd's training tutorials linked in the References section of this page

Overleaf is a good learning and writing tool, not a production paper processing tool

  • It is very network-dependent, as any web-based application (e.g. Google docs) is

Nonetheless, it is an excellent tool and many JACoW authors collaborate on papers using Overleaf.

The JACoW Template is located in the Overleaf gallery for general use:

LaTeX Paper Processing Remarks

LaTeX papers from JACoW authors are binary in my experience

  • They are usually either nearly perfect or total disasters
  • Depends greatly on how much the author contravenes the LaTeX template with their own "programming" style
  • Also depends greatly on how much author fights against LaTeX vertical space control

Examples from a friend at IPAC'15:

LaTeX Source Code Challenges

From TUPWI052 at IPAC'15 on previous slide:

 
begin{figure}[h]
 \begin{minipage}{1.\linewidth}
 \centering
  \begin{minipage}{.99\linewidth}
   \centering
   \includegraphics[width=.59\linewidth]{TUPWI052f16.eps}
   \includegraphics[width=.59\linewidth]{TUPWI052f17.eps}
   \caption{\label{FigDARing} ... }
  \end{minipage} 
 \end{minipage}
\end{figure} 

Common (LaTeX) Paper Errors: Top 9

  • Subsection/Table Caption Title Case
  • Negative vertical space creates bottom margin overrun
  • Equations/tables/author list extend beyond margin
  • Author added hyperref package, external links
  • Used wrong (old) template
  • Units written incorrectly (in math mode, math italic mu in um)
  • Not allowing floats to float
  • \\ used for "new paragraph" instead of blank line
  • Using cut-and-paste Word quotes or " instead of LaTeX quotes ``''

Common (LaTeX) Paper Errors: Top 9 10

  • Subsection/Table Caption Title Case
  • Negative vertical space creates bottom margin overrun
  • Equations/tables/author list extend beyond margin
  • Author added hyperref package, external links
  • Used wrong (old) template
  • Units written incorrectly (in math mode, math italic mu in um)
  • Not allowing floats to float
  • \\ used for "new paragraph" instead of blank line
  • Using cut-and-paste Word quotes or " instead of LaTeX quotes ``''
  • Doing violence to the carefully designed JACoW template

References