Features

Note	This is a work in progress. More features should be added, and each should link to its own page with documentation. Link to IJ docs where possible and useful

Table of Contents

• Searching through this wiki
• Installation
• Writing LaTeX
• Reading
• Preview
• Navigation
• Running
  • PDF viewers
• External tools
  • BibTeX
• Managing LaTeX
• Tools
• UI
• Utilities
• Settings and preferences
  • Global settings
    • Conventions
  • LaTeX SDK
  • Run configuration settings
  • Code style settings
    • Common code style settings for LaTeX and BibTex
    • LaTeX specific code style settings
• Menu entries
  • Context menu entries
• Inspections
  • BibTeX
  • LaTeX
    • Typesetting issues
      • Spacing
    • Code style issues
    • Probable bugs
      • Packages
    • Redundant LaTeX
    • Discouraged use of TeX or obsolete LaTeX
• Intentions
  • LaTeX

Searching through this wiki

You can search through this wiki by using the GitHub global search bar at the top of the page, and then selecting Wiki results.

Installation

Also see the installation guide.

• Support for Windows, Mac and Unix (via for example MiKTeX or TeX Live)

• MIT license

• Built on the IntelliJ IDE which has many features built in (documentation)

• Works with all Jetbrains IDEs, including IntelliJ, PyCharm, PhpStorm, DataGrip, Rider, GoLand, RubyMine, Android Studio, WebStorm and CLion.

• Suggested updates of TeXiFy and one click to update

• Prerelease alpha builds available

Writing LaTeX

• Unicode support

• Autocomplete of labels, all commands from installed packages, custom defined commands and (custom) environments

• Smart quote substitution

• Automagically import packages of common commands

• Shortcuts for styling text

• Line commenting shortcut

• Renaming of labels and environments

• Support for user-created document classes and packages

• Toggle star action

• Custom shortcuts for menu items

• Brace matching

• Live templates

• Custom live templates

• Postfix templates

• Custom macros with shortcuts

• Spellchecking with custom dictionaries

• Support for the Grazie grammar and spellchecking plugin

• Soft wraps and wrap on typing

• Many useful shortcuts

• Automatic insertion of \item in list environments like itemize and enumerate

• Automatic insertion of \end when typing \begin for environments

• On typing \[ automatic insertion of \], after Enter also with correct indentation

• Surround with dollars, quotes, or braces

• Automatic insertion of braces of first required parameter

• Typing } at closing brace skips over it, same for $..$

• Multi-cursors

• Easy switching to other math environments

• Support for \graphicspath from the graphicx package.

• Magic comments

• Support for \newcommand-like custom definitions of cite and label commands

• Action for swapping arguments of LaTeX commands

• Drag and drop graphics inside your document

• Paste HTML tables and turn them into LaTeX

• Paste images directly from your clipboard

• Known issues with parsing LaTeX

Reading

• Customizable syntax highlighting

• Code folding for imports, (sub(sub))sections, environments, some math symbols and some escaped symbols like \%

• Code formatting

• Line markers for sections

• Color preview for the xcolor package

• Language injection

• Special highlighting and marker for todo comments, customizable

• Links in comments and in commands which provide links (e.g. \url and \href) are clickable

• Easy links to LaTeX package documentation, and documentation for many commands and environments

Preview

• Unicode math preview

• Equation preview

• TikZ preview

Navigation

• Structure view with filters

• Go to declaration of labels, citations and custom commands

• Label reference resolving when using the xr package

• Find usages for commands defined in a \newcommand-like way

• "Goto Symbol" support for section names, labels, bibitems, new environments and new commands

• Gutter icons and navigation shortcuts for file inclusions

• Support for the import package

• Breadcrumbs for environments and commands

Running

• Gutter icons for quick compilation

• Customizable run configurations to compile LaTeX files

• Compiler support for pdfLaTeX, LuaTeX, Latexmk, texliveonfly, XeLaTeX, Tectonic, bibtex, and biber

• A clean overview of LaTeX, BibTeX and Biber warnings and errors

• Support for automatic compilation

• The pdf will appear in a separate out/ directory to avoid cluttering the source directory

• Auxiliary files will be put in a separate auxil/ directory on Windows

• Custom compiler path

• Option to choose different output formats like PDF and DVI

• Support for TEXINPUTS and environment variables in general

• Support for Dockerized MiKTeX

• Support for TeX Live from WSL

PDF viewers

• Built-in PDF viewer

• SumatraPDF (Windows) support with forward and backward search

• Evince (Linux) support with forward and backward search

• Okular (Linux) support with forward and backward search

• Zathura (Linux) support with forward and backward search

• Skim (MacOS) support with forward and backward search

• Custom pdf viewer

• Opens system default pdf viewer when no custom or supported pdf viewer is known

External tools

• Support for run configurations to create an index/glossary, also when auxil/ or out/ is used

• Jinja2 support

• Run any external tool before compiling

BibTeX

If you are new to BibTeX, see the BibTeX introduction.

• Syntax highlighting

• Formatter

• Autocomplete

• Structure view with filters

• Ctrl+Q on a bibtex reference will show a popup with title and authors from the bibtex entry

• Support for @string variables

• Folding

• Chapterbib support

Managing LaTeX

• Never press Ctrl+S again: saves while you type

• Project management

• Support for multiple content roots

Tools

• VCS integration including Git

• Terminal window

• Detexify

• Extend TeXiFy functionality with custom scripts

UI

• Symbol tool window

• Editor tabs

• Split screen editing

• Change display font

• Custom color scheme

• RTL/bidirectional support

• Fancy icons that fit in with the IntelliJ style

Utilities

• Word counting tool

• Customizable file templates for .tex, .sty, .cls and .bib files

• Table Creation Wizard

• Graphic Insertion Wizard

• Dummy Text (Lorem Ipsum) Wizard

• Menu button to delete generated auxiliary files

• Crash reporting dialog

• File creation dialog

Settings and preferences

Global settings

These settings can be found in File › Settings › Languages & Frameworks › TeXiFy and are global to your IntelliJ: they will be same for all projects.

• Option to disable automatic insertion of second $

• Option to disable automatic brace insertion around text in subscript and superscript

• Option to disable auto-insertion of \item

• Option to disable automatic package dependency checks

• Option to enable automatic compilation

• Option to enable continuous preview of math and TikZ environments

• Option to include the backslash when selecting a LaTeX command

• Option to show LaTeX package files in the structure view

• Option to enable smart quote substitution

Conventions

These settings can be found in File › Settings › Languages & Frameworks › TeXiFy › Conventions and allow you to configure Latex code conventions that apply either globally or for the current project.

• The maximum number of characters in a section before TeXiFy will suggest to move the section to another file

• Which commands and environments should have a label and which prefix the label should have

LaTeX SDK

• Custom location of LaTeX installation

Run configuration settings

See Run configurations settings for more info.

• Choose compiler

• Custom compiler path

• Custom compiler arguments

• Custom environment variables

• (Windows) Choose a custom path to SumatraPDF

• Choose pdf viewer

• Custom pdf viewer

• Choose LaTeX source file to compile

• (MiKTeX only) Set a custom path for auxiliary files

• Set a custom path for output files

• Option to always compile documents twice

• Choose output format

• Choose LaTeX distribution

• Choose BibTeX run configuration

• Choose Makeindex run configuration

• Other tasks to run before the run configuration, including other run configurations or external tools

Code style settings

These settings can be found in File › Settings › Editor › Code Style › LaTeX (or BibTeX).

Common code style settings for LaTeX and BibTex

• Specify the number of spaces to use for indentation

• Option to hard wrap LaTeX and BibTeX files

LaTeX specific code style settings

• Option to start a comment at the same indentation as normal text

• Specify the number of blank lines before a sectioning command

• Indent text in sections

• Option to disable indentation of the document environment

Menu entries

If any shortcut is assigned to a menu entry, it will be shown next to it.

File › New › LaTeX File

Create a new LaTeX file of type Source (.tex), Bibliography(.bib), Package (.sty), Document class (.cls) or TikZ (.tikz)

File › Other Settings › Run configuration Templates for New Projects

Change the run configuration template

Edit › LaTeX › Sectioning

Insert sectioning commands like \part or \subsection. If any text is selected, it will be used as argument to the command.

Edit › LaTeX › Font Style

Insert font style commands like \textbf for bold face. If any text is selected, it will be used as argument to the command.

Edit › LaTeX › Insert Table…​

Displays a table creation wizard that generates a LaTeX table.

Edit › LaTeX › Insert Graphic…​

Displays a wizard that generates graphic inclusion LaTeX.

Edit › LaTeX › Toggle Star

Toggle the star of a command.

Edit › Fill Paragraph

Fill the paragraph that is currently under the cursor such that each line is filled until the right margin, but does not exceed it.

Code › Reformat File with Latexindent

Run Latexindent.pl on the LaTeX file the caret is in.

Code › Reformat File with bibtex-tidy

Run bibtex-tidy on the file the caret is in.

Analyze › LaTeX › Word Count

Word counting tool.

Tools › LaTeX › Equation Preview

Preview equations.

Tools › LaTeX › TikZ Preview

Preview TikZ pictures.

Tools › LaTeX › Clear Auxiliary Files

Clear the generated auxiliary files.

Tools › LaTeX › Clear Generated Files

Clear all generated files.

Tools › LaTeX › SumatraPDF

(Windows only) Forward search and configuration of inverse search

Context menu entries

Right-click on any file › New › LaTeX File

Create a new LaTeX file.

Right-click on LaTeX source file › Run 'filename'

Compiles the file.

Inspections

• Inspection suppression

• Creating Custom Inspections

BibTeX

• Duplicate ID

• Missing bibliography style

• Duplicate bibliography style commands

• Same bibliography is included multiple times

• Bib entry is not used

LaTeX

If you see a minor issue, like some missing metadata about commands or environments, you are encouraged to check if you can fix it yourself.

Typesetting issues

Issues which have influence on the typeset result.

• Nesting of sectioning commands

• Collapse cite commands

• En dash in number ranges

• Use of . instead of \cdot

• Use of x instead of \times

• Vertically uncentered colon: use of raw := instead of \coloneqq by mathtools (and variants)

• Insert \qedhere in trailing displaymath environment

• Dotless versions of i and j must be used with diacritics

• Enclose high commands with \leftX..\rightX

• Citations must be placed before interpunction

Spacing

Typesetting issues related to incorrect spacing.

• Non-escaped common math operators

• Non-breaking spaces before references

• Ellipsis with …​ instead of \ldots or \dots

• Normal space after abbreviation

• End-of-sentence space after sentences ending with capitals

• Use the matching amssymb symbol for extreme inequalities

Code style issues

Issues which do not have influence on the typeset result but improve maintainability.

• Math functions in \text

• Grouped superscript and subscript

• Gather equations

• Figure not referenced

• Missing labels

• Label conventions

• Start sentences on a new line

• Use \eqref{…​} instead of (\ref{…​})

• Use \RequirePackage{…​} instead of \usepackage{…​}

• File that contains a document environment should contain a \documentclass command

• Might break TeXiFy functionality

• Too large section

Probable bugs

Issues which indicate probable unintended behaviour and often highlight possible compilation errors.

• Unsupported Unicode character

• File argument should not include the extension

• File argument should include the extension

• Missing documentclass

• Missing document environment

• Unresolved references

• Non matching environment commands

• Open if-then-else control sequence

• File not found

• Absolute path not allowed

• Inclusion loops

• Nested includes

• Label is before caption

• Unescaped # symbol

• Multiple \graphicspath definitions

• Relative path to parent is not allowed when using BIBINPUTS

• Command is not defined anywhere

Packages

Probable bugs related to packages.

• Package could not be found

• Package is not installed

• Package name does not match file name

• Package name does not contain the correct path

• Missing imports

Redundant LaTeX

Warns for redundant code.

• Redundant escape when Unicode is enabled

• Redundant use of \par

• Unnecessary whitespace in section commands

• Command is already defined

• Duplicate labels

• Package has been imported multiple times

• Duplicate command definitions

Discouraged use of TeX or obsolete LaTeX

Issues related to code maturity and use of deprecated constructs.

• Use of \over discouraged

• TeX styling primitives usage is discouraged

• Discouraged use of \def and \let

• Avoid eqnarray

• Discouraged use of primitive TeX display math

• Discouraged use of \makeatletter in tex sources

Intentions

LaTeX

See Intentions.

• Add label

• Toggle inline/display math mode

• Insert comments to disable the formatter

• Change to \left..\right

• Convert to other math environment

• Move section contents to separate file

• Move selection contents to separate file

• Split into multiple \usepackage commands