Introduction

This package displays all the symbols (including classes, functions, variables, etc., depending on what the backend outputs), in an outline view.

Features

1. List the symbols in a well-organized window.
2. The outline window position follows your cursor in the original buffer.
3. It's easy to navigate between symbols via moving in the outline window.
4. Allows various and custom backends. Currently ctags and lsp-mode backends are provided.

Requirements

Symbols-outline.el relies on a backend to get the symbols. By default the ctags backend is used. Or if lsp-mode is active, you can use the lsp backend. See symbols-outline-fetch-fn.

If using ctags backend, ctags must be installed on your machine.

Installation

This package is in Melpa so you can install it with your favorite package manager.

Example configuration

(global-set-key (kbd "C-c i") 'symbols-outline-show)
(with-eval-after-load 'symbols-outline
  ;; By default the ctags backend is selected
  (unless (executable-find "ctags")
    (setq symbols-outline-fetch-fn #'symbols-outline-lsp-fetch))
  (setq symbols-outline-window-position 'left)
  (symbols-outline-follow-mode))

Keybindings in the outline window

Customizations

• symbols-outline-window-position: the outline window position. Default right.
• symbols-outline-window-width: the outline side window width. Default 30.
• symbols-outline-no-other-window: if t, the outline side window will not be selected with the other-window command. Instead, you can switch to the outline window with symbols-outline-show. Default t.
• symbols-outline-no-delete-other-window: if t, the outline side window will not be deleted by the delete-other-windows command. Default t.
• symbols-outline-collapse-functions-on-startup: whether to collapse function nodes on startup to hide the parameter nodes.