LaTeX package

Compile LaTeX, knitr, literate Agda, literate Haskell, or Pweavedocuments from within Atom.

Installing

Use the Atom package manager and search for "latex", or run apm install latexfrom the command line.

Prerequisites

TeX distribution

A reasonably up-to-date and working TeX distribution is required. The onlyofficially supported distributions are TeX Live, and MiKTeX. Although,the latter is not as well tested and supported as TeX Live, hence using TeX Liveis highly recommended.

You need to ensure that the package can find your TeX distribution's binaries;by default the package uses your PATH environment variable, as well as thefollowing search paths on Linux and macOS

1. /usr/texbin
2. /Library/TeX/texbin

and on Windows it uses

1. %SystemDrive%\texlive\2017\bin\win32
2. %SystemDrive%\texlive\2016\bin\win32
3. %SystemDrive%\texlive\2015\bin\win32
4. %ProgramFiles%\MiKTeX 2.9\miktex\bin\x64
5. %ProgramFiles(x86)%\MiKTeX 2.9\miktex\bin

If your TeX distribution's binaries are not installed in one of those locationsor discoverable via the PATH environment variable, you will need to help thepackage find the binaries. This can be done by setting the TeX Pathconfiguration option to point to the folder containing the binaries, either inthe settings view, or directly in your config.cson file. See Configurationfor further details regarding the settings of this package.

Syntax Highlighting

In order for this package to behave as expected, your Atom environment mustcontain a package that provides a LaTeX grammar. We suggest language-latex,but other valid options might exist. Additional syntax packages may be requiredto build document types other than LaTeX. For more details seeBuilder Capabilities below.

Builder Selection

The latex package provides access to two automatic builders for LaTeX andknitr documents. By default the package will use latexmk for LaTeX documentsand an included builder to prepare knitr documents for latexmk. In this casean up to date installation of latexmk is required. If you're using TeX Livethen you need only insure that latexmk is installed and up to date using theappropriate package manager. If you're using MikTeX then see how to uselatexmk with MiKTeX.

The JavaScript based DiCy builder may also be used for all documents byselecting the Use DiCy option in the settings page. DiCy will be installedautomatically and so no further action is required for either TeX Live orMiKTeX.

Builder Capabilities

Document types other than LaTeX documents may be processed by this package. Theavailability and behavior of this feature depends upon the specific builderselected. The following table details the different types of documents that maybe processed by each builder and any additional syntax package requirements.

Usage

The latex:build command can be invoked from the LaTex menu or by pressing thedefault keybind ctrl-alt-b while in a LaTex orknitr file. Log messages and any other messages from the build may be seen inthe LaTeX log panel accessible from the status bar.

The latex package supports other commands as detailed in the table below.

Overriding Build Settings

Many of the build settings in the settings page of the latex package can beoverridden on a per file basis. One way to override specific build settings isto use "magic" TeX comments in the form of % !TEX <name> = <value>. Anotherway is to use a YAML formatted file with the same name as your root LaTeXfile, but with an extension of .yaml. The settings and values that canoverridden via either method are listed in the table below. If multiple settingnames are listed then the first is preferred and following names are availablefor compatibility. More details can found at Overridding Build Settings.

There are additional settings that may be configured for the DiCy builder thatmay not be accessible from this package's setting page, but can be set via aYAML options file or TeX magic comments. For more details please seeOptions and Configuration in the DiCydocumentation.

PDF/DVI/PS Viewers

The latex package currently supports Atril, Evince, Okular,pdf-view, Preview, Skim, Sumatra PDF, Windows shell open,xdg-open, Xreader and Zathura as PDF/DVI/PS viewers. This includessupport for cursor synchronization via SyncTeX if possible. Specific features ofeach of the viewers is detailed at Supported Viewers.

Development status

Please note that this package is in a beta state. It is stable, but lackssome important features.

Any and all help is greatly appreciated!

NOTE: latexmk does not support file paths containing special characters such as ~. To partially circumvent this, add useRelativePaths: true to your config file like so

# config.cson
"*":
  latex:
    useRelativePaths: true

When set, this package will use a relative path in place of an absolute one. This will allow latexmk to compile projects stored in directories that contain special characters. Note that the project itself must not contain special characters in its directory or file names.

This feature has not been fully tested yet, and there are no guarantees it will work in all cases. Please raise an issue if you find a case where it fails.