Skip to content

Latest commit

 

History

History
81 lines (60 loc) · 4.57 KB

README.md

File metadata and controls

81 lines (60 loc) · 4.57 KB

Outline for Sublime Text 3

Makes an outline of the code for quick navigation and orientation within a file.

  1. Forked and updated by Adam Tableman for UCLA/IST use. See original repository for the base code on which this code is based/forked.
  2. For Fortran, install the Fortran+ Sublime Text Plugin at https://github.com/UCLA-Plasma-Simulation-Group/tools_sublimetext_fortran . Fortran+ fixes a few issues in the Sublime's Fortran support and also makes changes so that the Outline+ plugin works better. If Fortan+ is installed, the outline will be as shown in the above screenshot with indentation and '----contains----' entries that show where Fortran contains statements occur in the code.

Installation

Just 4 easy steps!

  1. If you previously installed the Outline package, you must uninstall it.
  2. Add the Outline+ repository to Sublime Text's package manager:
  3. Install Outline+
  4. Turn on the outline

If you are new to Sublime Text, see the Installation Walkthrough section below for detailed instructions.

Installation Walkthrough

  1. If you previously installed the Outline package, you must uninstall it.
    • Open Command Palate (Mac: ⌘-Shift-P or Windows: Ctrl-Shift-P)
    • Type 'remove package' then select the 'Package Control: Remove Package' item.
    • Scroll though the list and select the Outline item to uninstall it. (If you don't see an Outline entry it's no big deal... it just means Outline isn't installed which is what we were after anyway!)
  2. Add the Outline+ repository to Sublime Text's package manager:
    • Open Command Palate (Mac: ⌘-Shift-P or Windows: Ctrl-Shift-P)
    • Type 'add repository' then select the 'Package Control: Add Repository' item.
    • Then paste in the value: https://raw.githubusercontent.com/UCLA-Plasma-Simulation-Group/tools_sublimetext_outliner/master/info.json
  3. Install Outline+
    • Open Command Palate (Mac: ⌘-Shift-P or Windows: Ctrl-Shift-P)
    • Type 'install package' then select the 'Package Control: Install Package' item
    • Type 'Outline+' then select the 'Outline+' item
  4. Turn on the outline
    • Open Command Palate (Mac: ⌘-Shift-P or Windows: Ctrl-Shift-P)
    • Type 'outline'
    • Select one of the 5 layout options that come up:
      • 'Browse Mode: Outline (Left)'
      • 'Browse Mode: Outline (Right)'
        • This is one shown in the screenshot above.
      • 'Browse Mode: Filebrowser Left, Outline Right'
      • 'Browse Mode: Filebrowser Top Left, Outline Bottom Left'
      • 'Browse Mode: Filebrowser Top Right, Outline Bottom Right'
    • See the Default layout section below for more info.

Default layout

The outline tab can be set as a sidebar on the left or right. Press Ctrl + Shift + P and select either Browse Mode: Outline (Left) or Browse Mode: Outline (Right) to set your preferred layout.

If you also use FileBrowser, you can use both in three different layouts:

  • FileBrowser left, Outline right
  • FileBrowser top left, Outline bottom left
  • FileBrowser top right, Outline bottom right

To use FileBrowser and Outline together, please close the FileBrowser sidebar first and then use the correponding Browse Mode command to set the layout, otherwise the Outline view may not work as intended.

Color theme

Outline has two built-in color themes: Bright (default theme) and Dark. To switch to the Dark theme, add the following to your user settings file. Open the user settings file by "Preferences > Package Settings > Outline > Settings" (Sublime Text version 3124 or later), or "Settings - User":

"color_scheme": "Packages/Outline+/outline-Dark.hidden-tmTheme"

Remove -Dark or remove the entire line to return to the bright theme. To customize your own color theme, see this issue.

Outline content and indentation

Outline is updated when you save a file or switch between files.

Content and indentation in the Outline tab is controlled by the Symbol List.tmPreferences file (file name may differ) corresponding to the syntax of your file.

Known issue

  • This package may not work if you use a multi-column/row layout.

License

This plugin is licensed under the MIT license.