LaTeX plugin for Sublime Text 2 and 3
Python Shell
Latest commit e78cd9f Oct 4, 2017 @r-stein r-stein Merge pull request #1239 from AllanLRH/patch-1
Added github-links to the .sublime-completions files (documentation files)
Permalink
Failed to load latest commit information.
bibliography_plugins Fix caching of new_bibliography on ST3 Mar 25, 2017
builders Basic builder: accept both ` and ' as quotes on missing citations Jan 14, 2017
docs Added github-links to the .sublime-completions files Oct 3, 2017
evince Evince: escape most ASCII characters in URLs Sep 19, 2016
external Extend parser to more citekey names May 16, 2017
latextools_plugin_internal Ensure registered plugins are always added to the to load queue Aug 10, 2016
latextools_utils Remove non-hidden local cache May 22, 2017
messages Fixed wrong README.markdown and install.txt Jun 1, 2017
skim Toggle sync PDF support for Mac Oct 7, 2012
snippets Add some features to support editing bib files May 10, 2016
st_preview Fixed a bug, which disabled the deletion of preview temp files Jul 26, 2017
viewers Merge pull request #988 from ig0774/fix_command_viewer_windows Jan 6, 2017
.gitignore Ignore irrelevant files Jun 21, 2013
.no-sublime-package Readd .no-sublime-package file for Package Control 2 Sep 10, 2013
01_reload_submodules.py Overhaul the cache to use a in-memory layer Dec 6, 2016
02_temp_file_cleanup.py Better means of loading external libs Jun 17, 2016
03_reset_phantoms.py Changes to allow phantoms to be cleanly reloaded Nov 1, 2016
Beamer boxes.sublime-snippet Add back snippets for beamer boxes and frames Apr 4, 2011
Beamer frame.sublime-snippet Add back snippets for beamer boxes and frames Apr 4, 2011
Beamer.sublime-completions Added snippets for creating a figure and for a table, as well as comp… Apr 23, 2012
BibLaTeX.tmLanguage Add some features to support editing bib files May 10, 2016
Default (Linux).sublime-keymap Added command for toggling starred version of surrounding environment Aug 25, 2017
Default (Linux).sublime-keymap.OLD NEW-STYLE KEYBINDINGS. Sep 17, 2012
Default (Linux).sublime-mousemap ST2 compatibility Jul 24, 2016
Default (OSX).sublime-keymap Added command for toggling starred version of surrounding environment Aug 25, 2017
Default (OSX).sublime-keymap.OLD NEW-STYLE KEYBINDINGS. Sep 17, 2012
Default (OSX).sublime-mousemap ST2 compatibility Jul 24, 2016
Default (Windows).sublime-keymap Added command for toggling starred version of surrounding environment Aug 25, 2017
Default (Windows).sublime-keymap.OLD NEW-STYLE KEYBINDINGS. Sep 17, 2012
Default (Windows).sublime-mousemap ST2 compatibility Jul 24, 2016
Insert environment.sublime-snippet Snippet to insert an environment as an alternative to surround the se… May 18, 2016
LaTeX math.sublime-completions Changed LaTeX-completions scope such that it is disabled inside math … Aug 13, 2016
LaTeX.sublime-build Add variants for different build configurations Sep 20, 2016
LaTeX.sublime-build.OLD Initial transition to invoking make_pdf via build system, with config May 25, 2011
LaTeX.sublime-commands Add a command to remove all cache files May 22, 2017
LaTeX.sublime-completions Fix #822, rename multiline -> multline in completions file Aug 25, 2016
LaTeXTools (Advanced).sublime-settings Change the bracket completing algorithm to be less agressive Feb 23, 2017
LaTeXTools Console.hidden-tmLanguage Highlight errors and warnings in the console May 15, 2016
LaTeXTools Preferences.sublime-settings.OLD Switched to new pref file everywhere Mar 9, 2014
LaTeXTools.sublime-settings Remove non-hidden local cache May 22, 2017
Main.sublime-menu Merge branch 'master' into read_the_docs Nov 2, 2016
README.markdown Fixed wrong README.markdown and install.txt Jun 1, 2017
Remark.sublime-snippet Really added Remark Snippet; fixed up messages Mar 13, 2014
Symbol List - Labels.tmPreferences Initial support for 'Goto Anything' Mar 28, 2011
Symbol List - Sections.tmPreferences fixing the regexp that captures \sections Feb 18, 2013
Text boldface.sublime-snippet Improve bf/emph/ul snippets if ivoked with key combo and no selection Oct 22, 2012
Text emphasize.sublime-snippet Improve bf/emph/ul snippets if ivoked with key combo and no selection Oct 22, 2012
Text monospace.sublime-snippet add support for \texttt{} snippet May 21, 2013
Text underline.sublime-snippet Improve bf/emph/ul snippets if ivoked with key combo and no selection Oct 22, 2012
Wrap in command.sublime-snippet Improve bf/emph/ul snippets if ivoked with key combo and no selection Oct 22, 2012
Wrap in environment.sublime-snippet Implement change from #395 Jul 15, 2016
biblatex_crossref_completions.py Add some features to support editing bib files May 10, 2016
biblatex_field_name_completions.py Update biblatex_field_name_completions.py Apr 25, 2017
biblatex_name_completions.py Migrate external to its own package to (hopefully) stop stepping on o… Aug 23, 2016
biblatex_snippet_completions.py Migrate external to its own package to (hopefully) stop stepping on o… Aug 23, 2016
biblatex_syntax_listener.py Add some features to support editing bib files May 10, 2016
change_environment.py Added check for empty new_regions and safe detection of star. Aug 25, 2017
create_mousemap.py Make jump-to-anywhere mousebindings unique Jul 24, 2016
delete_temp_files.py Add a command to remove all cache files May 22, 2017
dependencies.json Changed minimal version for mdpopups to 3118 Oct 30, 2016
detect_spellcheck.py Detect spellcheck also from root is now a function argument Feb 5, 2016
figure.sublime-snippet Replaced \begin{center}[...] with \centering Mar 5, 2015
getRegion.py Unify command completions with better support for braces Jul 25, 2016
getTeXRoot.py Add support for --output-directory, --aux-directory, and --jobname May 18, 2016
jumpToPDF.py Allow current view to override output_directory, aux_directory and jo… Apr 13, 2017
jumpto_anywhere.py Fixes an issue, which disable jump-to-anywhere in some cases Sep 18, 2017
jumpto_tex_file.py Added (sub)(include/input)from support (import package) Dec 28, 2016
kpsewhich.py Disable kpsewhich error message Mar 23, 2017
latexCommand.py Changes latexcmd `C-l, c` to let the user input the command May 18, 2016
latexDocumentationViewer.py Fixed a Bug, which disabled the latex_pkg_doc command on windows Nov 7, 2016
latexEnvCloser.py Better detection of ST2 and ST3 Jul 3, 2013
latexEnvironment.py Slightly adapted a snippet to be compatible with given envs May 18, 2016
latex_cite_completions.py This temporary fixes an error with \cite{ May 23, 2017
latex_cwl_completions.py Fix some minor errors Mar 21, 2017
latex_directive_completions.py ST2 compatibility Sep 18, 2016
latex_env_completions.py Fix typo self.view -> view Aug 4, 2016
latex_fill_all.py Fix an off-by-one error in look around Mar 31, 2017
latex_glossary_completions.py Added "newacronym" in glo_filter_commands Nov 18, 2016
latex_input_completions.py Allow current view to override output_directory, aux_directory and jo… Apr 13, 2017
latex_installed_packages.py Adds a standard way to run external commands. Oct 30, 2016
latex_own_command_completions.py Fix some minor errors Mar 21, 2017
latex_ref_completions.py Use the analysis for ref and cite completions Dec 6, 2016
latextools_cache_listener.py Disable `cache_on_save` and `cache_on_load` by default Mar 23, 2017
latextools_default_settings.py Extend LaTeXTools settings to include an advanced settings file Apr 26, 2016
latextools_plugin.py Several improvements to loading plugins Dec 3, 2016
latextools_sublime_version_listener.py Rename the context to detect the ST version Oct 9, 2016
makePDF.py Fixed a bug, which disabled the build panel in ST3 < 3080 May 18, 2017
messages.json Prepare v3.14.2 Sep 7, 2017
migrate.py Rename migration command Jan 1, 2016
mkdocs.yml Fix documentation search (hopefully) May 16, 2017
open_detexify.py Open Detexify command May 9, 2017
parseTeXlog.py parseTeXlog: added comments May 3, 2017
search_commands.py Add a `only_current_file` flag to the command search Jan 21, 2017
system_check.hidden-tmLanguage Add some checks for packages required by preview Nov 5, 2016
system_check.py Fix for #1209 Sep 16, 2017
system_check.sublime-syntax Add some checks for packages required by preview Nov 5, 2016
table.sublime-snippet Replaced \begin{center}[...] with \centering Mar 5, 2015
texMacro.py Initial commit Mar 22, 2011
texSections.py Better detection of ST2 and ST3 Jul 3, 2013
texSyntaxListener.py Improved TeXSyntaxListener for ST3 and user defined syntax Apr 28, 2016
texcount.py Modify texcount to use check_output Oct 30, 2016
toc_quickpanel.py Add a `only_current_file` flag to the toc quickpanel Jan 21, 2017
toggle_auto.py Migrate from latextools_settings -> latextools_utils because this wil… Dec 8, 2015
toggle_focus.py Migrate from latextools_settings -> latextools_utils because this wil… Dec 8, 2015
toggle_fwdsync.py Migrate from latextools_settings -> latextools_utils because this wil… Dec 8, 2015
toggle_show.py Updated README and settings Sep 26, 2016
toggle_view_on_build.py Add a toggle for open_pdf_on_build Jul 15, 2016

README.markdown

LateXTools: A LaTeX Plugin for Sublime Text 2 and 3

by Ian Bacher, Marciano Siniscalchi, and Richard Stein

Marciano's blog: http://tekonomist.wordpress.com

Documentation: https://latextools.readthedocs.io

Latest revision: v3.14.1 (2017-06-01).

Package Control

Headline features:

  • Documentation migrated to ReadTheDocs (https://latextools.readthedocs.io)
  • Support for the import package
  • TOC quickpanel now shows just the current document when using (C-r)
  • Uses analysis for ref / cite commands and better caching
  • Improved fill all completions for large files
  • %!TEX directives now override settings in all circumstances

Prereleases

LaTeXTools uses pre-releases to beta test new features and improve the stability of releases. If you also want to get the newest features and help us testing them. Just open Preferences > Package Settings > Package Control > Settings - User and insert at a reasonable (correct JSON syntax) position:

    "install_prereleases": ["LaTeXTools"],

If you also use prereleases of other packages just add them comma separated into the list.

Overview

This plugin provides several features that simplify working with LaTeX files:

  • The ST build command takes care of compiling your LaTeX source to PDF using texify (Windows/MikTeX) or latexmk (OSX/MacTeX, Windows/TeXlive, Linux/TeXlive). Then, it parses the log file and lists errors and warning. Finally, it launches the PDF viewer and, on supported viewers (Sumatra PDF on Windows, Skim on OSX, and Evince on Linux by default) jumps to the current cursor position.
  • Forward and inverse search with the named PDF previewers is fully supported
  • Fill everything including references, citations, packages, graphics, figures, etc.
  • Plugs into the "Goto anything" facility to make jumping to any section or label in your LaTeX file(s)
  • Smart command completion for a variety of text and math commands
  • Additional snippets and commands are also provided
  • Fully customizable build command
  • Fully customizable PDF viewers
  • Full support for project files and multi-file documents
  • Easily view package documentation
  • Word counts

Requirements and Setup

The easiest way to install LaTeXTools is via Package Control. See the Package Control installation instructions for details on how to set it up (it's very easy.) Once you have Package Control up and running, invoke it (via the Command Palette from the Tools menu, or from Preferences), select the Install Package command, and find LaTeXTools.

If you prefer a more hands-on approach, you can always clone the git repository, or else just grab this plugin's .zip file from GitHub and extract it to your Packages directory (you can open it easily from ST, by clicking on Preferences > Browse Packages). Then, (re)launch ST. Please note that if you do a manual installation, the Package must be named LaTeXTools.

Finally, you'll need to have a working TeX installation and a PDF viewer. LaTeXTools supports MacTeX, MiKTeX and TeXLive as TeX systems and Skim, Sumatra PDF, Evince, Okular, and Zathura as PDF viewers. For detailed instructions on how to set these up, please see our online documentation!

Bugs, issues & feature requests

Please read the installation instructions carefully to ensure you get up and running as quickly as possible. Help for troubleshooting common issues can be found in the Troubleshooting section at the end of this README. For other bugs, issues or to request new features, please get in touch with us via Github.

Please search for existing issues and pull requests before opening a new issue.

Acknowldegements

Additional contributors (thank you thank you thank you): first of all, Wallace Wu and Juerg Rast, who contributed code for multifile support in ref and cite completions, "new-style" ref/cite completion, and project file support. Also, skuroda (Preferences menu), Sam Finn (initial multifile support for the build command); Daniel Fleischhacker (Linux build fixes), Mads Mobaek (universal newline support), Stefan Ollinger (initial Linux support), RoyalTS (aka Tobias Schidt?) (help with bibtex regexes and citation code, various fixes), Juan Falgueras (latexmk option to handle non-ASCII paths), Jeremy Jay (basic biblatex support), Ray Fang (texttt snippet), Ulrich Gabor (tex engine selection and cleaning aux files), Wes Campaigne and 'jlegewie' (ref/cite completion 2.0!). Huge thanks to Daniel Shannon (aka phyllisstein) who first ported LaTeXTools to ST3. Also thanks for Charley Peng, who has been assisting users and generating great pull requests; I'll merge them as soon as possible. Also William Ledoux (various Windows fixes, env support), Sean Zhu (find Skim.app in non-standard locations), Maximilian Berger (new center/table snippet), Lucas Nanni (recursively delete temp files), Sergey Slipchenko ($ auto-pairing with Vintage), btstream (original fill-all command; LaTeX-cwl support), Richard Stein (auto-hide build panel, jump to included tex files, LaTeX-cwl support config, TEX spellcheck support, functions to analyze LaTeX documents, cache functionality, multiple cursor editing), Dan Schrage (nobibliography command), PoByBolek (more biblatex command), Rafael Lerm (support for multiple lines in \bibliography commands), Jeff Spencer (override keep_focus and forward_sync via key-binding), Jonas Malaco Filho (improvements to the Evince scripts), Michael Bar-Sinai (bibtex snippets).

If you have contributed and I haven't acknowledged you, email me!