diff --git a/doc/symbols-outline.txt b/doc/symbols-outline.txt index f363366..faf2779 100644 --- a/doc/symbols-outline.txt +++ b/doc/symbols-outline.txt @@ -1,4 +1,4 @@ -*symbols-outline.txt* For NVIM v0.7.0 Last change: 2023 November 08 +*symbols-outline.txt* For NVIM v0.7.0 Last change: 2023 November 11 ============================================================================== Table of Contents *symbols-outline-table-of-contents* @@ -132,7 +132,18 @@ Default values are shown: -- Vim options for the outline window show_numbers = false, show_relative_numbers = false, - show_cursorline = true, -- Only in this fork + + -- Only in this fork (this and the one below) + show_cursorline = true, + -- Enable this when you enabled cursorline so your cursor color can + -- blend with the cursorline, in effect, as if your cursor is hidden + -- in the outline window. + -- This is useful because with cursorline, there isn't really a need + -- to know the vertical column position of the cursor and it may even + -- be distracting, rendering lineno/guides/icons unreadable. + -- This makes your line of cursor look the same as if the cursor wasn't + -- focused on the outline window. + hide_cursor = false, -- Whether to wrap long lines, or let them flow off the window wrap = false, @@ -144,7 +155,9 @@ Default values are shown: -- Only in this fork: -- Winhighlight option for outline window. -- See :help 'winhl' - -- To change background color to "CustomHl" for example, set to "Normal:CustomHl". + -- To change background color to "CustomHl" for example, append "Normal:CustomHl". + -- Note that if you're adding highlight changes, you should append to this + -- default value, otherwise details/lineno will not have highlights. winhl = "SymbolsOutlineDetails:Comment,SymbolsOutlineLineno:LineNr", }, @@ -219,7 +232,9 @@ Default values are shown: -- Jump to symbol under cursor but keep focus on outline window. -- Renamed in this fork! peek_location = "o", - -- Only in this fork: + -- Only in this fork (next 2): + -- Visit location in code and close outline immediately + goto_and_close = "" -- Change cursor position of outline window to the current location in code. -- "Opposite" of goto/peek_location. restore_location = "", @@ -338,26 +353,27 @@ DEFAULT KEYMAPS *symbols-outline-default-keymaps* These mappings are active for the outline window. - Key Action - ------------ ---------------------------------------------------- - Escape Close outline - ? Show help message - Enter Go to symbol location in code - o Go to symbol location in code without losing focus - Ctrl+k Go up and goto location - Ctrl+j Go down and goto location - Ctrl+g Go to code location in outline window - Ctrl+Space Hover current symbol - K Toggles the current symbol preview - r Rename symbol - a Code actions - h Fold symbol or parent symbol - Tab Toggle fold under cursor - Shift+Tab Toggle all folds - l Unfold symbol - W Fold all symbols - E Unfold all symbols - R Reset all folding + Key Action + ------------- ---------------------------------------------------- + Esc / q Close outline + ? Show help + Enter Go to symbol location in code + o Go to symbol location in code without losing focus + Shift+Enter Go to symbol location in code and close outline + Ctrl+k Go up and goto location + Ctrl+j Go down and goto location + Ctrl+g Update outline window to focus on code location + Ctrl+Space Hover current symbol (provider action) + K Toggles the current symbol preview + r Rename symbol + a Code actions + h Fold symbol or parent symbol + Tab Toggle fold under cursor + Shift+Tab Toggle all folds + l Unfold symbol + W Fold all symbols + E Unfold all symbols + R Reset all folding HIGHLIGHTS *symbols-outline-highlights* @@ -372,7 +388,7 @@ Default: }, < -Possible highlight groups to customize: +Possible highlight groups provided by symbols-outline to customize: ------------------------------------------------------------------------- Highlight Purpose @@ -385,6 +401,9 @@ Possible highlight groups to customize: SymbolsOutlineLineno Highlight of the lineno column ------------------------------------------------------------------------- +You can customize any other highlight groups using `winhl` too, this option is +passed directly to the `winhl` vim option unprocessed. + PREVIEW WINDOW ~ @@ -519,6 +538,28 @@ it using `outline_window.winhl`: please see |symbols-outline-highlights|. +- **Single cursorline** + +>lua + outline_window = { + show_cursorline = true, + hide_cursor = true, + } +< + +This will be how the outline window looks like when focused: + + + +Note that in the screenshot, `outline_items.show_symbol_lineno` is also +enabled. + +Some may find this unhelpful, but one may argue that elements in each row of +the outline becomes more readable this way, hence this is an option. + +This feature is newly added in this fork, and is currently experimental (may be +unstable). + ============================================================================== 1. Links *symbols-outline-links*