ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

La​Te​XOutline

by odapg ST4

A Sublime Text package that displays sections of a LaTeX file on a side tab and gives easy access to references

Labels latex

Details

Installs

  • Total 78
  • Win 27
  • Mac 33
  • Linux 18
Aug 29 Aug 28 Aug 27 Aug 26 Aug 25 Aug 24 Aug 23 Aug 22 Aug 21 Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7 Aug 6 Aug 5 Aug 4 Aug 3 Aug 2 Aug 1 Jul 31 Jul 30 Jul 29 Jul 28 Jul 27 Jul 26 Jul 25 Jul 24 Jul 23 Jul 22 Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15
Windows 0 0 0 1 0 0 0 0 1 0 0 2 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 1 0 0 0 1 0 0 1 1 0 0 1 1 1 2
Mac 0 0 1 0 1 0 1 0 0 0 2 0 1 0 0 1 0 0 1 0 1 0 0 0 2 0 0 1 1 2 0 0 0 0 0 1 0 1 0 0 1 0 1 1 2 0
Linux 1 1 0 0 0 0 1 0 0 0 0 1 1 0 0 0 1 1 0 1 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0

Readme

Source
raw.​githubusercontent.​com

LaTeXOutline for Sublime Text

Overview

LaTeXOutline is an ST4 package which allows displaying a clickable table of contents for a LaTeX file. This outline is shown on a separate tab.

It is intended to be used with the article, book and beamer LaTeX classes. In particular, the captured sectioning commands are: part, chapter, section, subsection, subsubsection, subsubsubsection, paragraph and frametitle.

LaTeXOutline accepts multiple-files .tex documents.

LaTeXOutline example

The simplest way to install LaTeXOutline is by using PackageControl. You can also install it manually by following these steps.

Manual installation

  1. Clone or download this repository using the green Clone or download button.
  2. If needed, rename the cloned or extracted folder to LaTeXOutline.
  3. Move the LaTeXOutline folder to your Sublime Text's Packages folder.
  4. Restart Sublime Text.
  5. Modify the settings, the keybindings and possibly the LaTeXOutline-custom.hidden-color-scheme to your liking by going to the menu Settings > Packages Settings > LaTeXOutline or by using the corresponding Command Palette entries.

Usage

  1. Open a LaTeX File.

  2. Use the command Palette entries LaTeXOutline: ToC on the Right (or Left), LaTeXOutline: ToC and labels on the Right (or Left) to open the outline pane. Use LaTeX Outline: Close sidebar to close it.
    Alternatively, use the corresponding shortcuts (by default, ctrl j, a, ctrl j, e, ctrl j, z on windows/linux and ⌘ j, a, ⌘ j, e, ⌘ j, z on mac). See the keybindings settings for more details.

  3. Click on the titles in the LaTeXOutline tab to get to the corresponding place in your LaTeX file.
    Click on a ⌖ sign to take a look at a part of the LaTeX file in a panel. Use Esc to close the panel.
    Click on a ❐ sign to copy the corresponding label to the clipboard (alt+click on a ❐ sign copies \ref{label} or \eqref{label}).
    Click on a section's bullet in the LaTeXOutline tab to copy the section's corresponding label in the clipboard. A message is given in the status bar below to indicate if this label has been found.

Remarks

  • Sections and labels numbering in the outline relies on the .aux file and consequently does not work when it is erased.
  • Gathering environment names may take some time and is performed in the background. As a result, they may appear slightly later in the outline (when the corresponding setting is enabled).

Known issues

  • Section numbering does not work with the use of the cleveref package. It is likely that many packages interfering with the .aux file can create issues as well.

License

This plugin is licensed under the MIT license. In particular, it is provided “as is”, without warranty of any kind!

Acknowledgements

LaTeXOutline is originally a specific adaptation of warmdev's original SublimeOutline to LaTeX files, also using modifications due to vlad-wonderkidstudio, see SublimeOutline. It still uses an appreciable part of this code. LaTeXOutline also borrows code from LaTeXTools.