Skip to content

Commit

Permalink
Update Views>Panels>Built-In Panels to give more details on keyboard …
Browse files Browse the repository at this point in the history
…navigation for Document List (which got big enough to warrant a subsection, instead of a single gigantic paragraph)

Closes#666
  • Loading branch information
pryrt committed May 1, 2024
1 parent 396d74f commit 42572b6
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion content/docs/views.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,10 +200,20 @@ The **Folder as Workspace**[↗](#remembered-settings "Remembered Setting") entr

The **Document Map**[](#remembered-settings "Remembered Setting") item will toggle the display of the Document Map panel, which shows a copy of the file in a tiny font, with a highlighted range to indicate which section of the current file is visible in the editor.

The **Document List**[↗](#remembered-settings "Remembered Setting") toggle will display the Document List panel, which lists all the open documents and allows easily switching between them. (Prior to v8.1.3, the panel was known as the **Doc Switcher** panel and controlled through the [General preferences](../preferences/#general), but that name was confused with the Document Switcher <kbd>Ctrl+TAB</kbd> settings in [MISC preferences](../preferences/#misc).) The Document List can be sorted by Name (or Extension or Path, if those columns are shown) by left-clicking on the header. To view the extension separately from the filename, right click on the header and choose the **Ext.** entry in the dropdown menu (as of v8.1.5; prior to that, it was in the [General settings](../preferences/#general)). To view the path in Document List panel, right click on the header and choose the **Path** entry in the dropdown menu (new to v8.1.5). As of v8.5, when you add [color to a tab](../other-resources/#tab-bar-right-click-menu), the color will also be applied to the entry in the Document List; and conversely, the right-click menu in the Document List is the same menu as the normal [tab bar right-click menu](../other-resources/#tab-bar-right-click-menu), so it will allow you to add color to the tab from that panel as well. The Document List has collapsible separators for each of the views (new to v8.5): if there is just one visible View, then there will be a single horizontal bar with a `︿` arrow, and clicking that `︿` arrow or double-clicking the horizontal line will collapse (hide) the list of files, and subsequently clicking the `﹀` arrow or double-clicking the horizontal line will uncollapse (show) the list again; if there are two visible views, then the Panel will have two collapsible separator bars, one for each View, which work in the same manner to show or hide the list of files for each view separately. If you right-click on the Document List panel's header row, you can toggle the ✔ checkmark on **Group by View** to disable and enable this option (which is on by default); if it's disabled, the files for both visible Views will be shown in a single list with no separator bar. Finally, aside from the right-click menu's options for closing files using the Document List panel, if you middle-click on a file's entry in the Document List, it will also close that file's tab and remove it from the Document List panel (new to v8.5).
The **Document List**[](#remembered-settings "Remembered Setting") toggle will display the Document List panel, which lists all the open documents and allows easily switching between them. (Prior to v8.1.3, the panel was known as the **Doc Switcher** panel and controlled through the [General preferences](../preferences/#general), but that name was confused with the Document Switcher <kbd>Ctrl+TAB</kbd> settings in [MISC preferences](../preferences/#misc).) More details on this Panel can be found in the [Document List Panel Details](#document-list-panel-details) section, below.

The **Function List**[](#remembered-settings "Remembered Setting") toggle will display the [Function List](../function-list/) panel, which lists the functions, methods, and classes in the current file, and allows easy navigation to those sections of the file by double-clicking in the Function List panel. (The "functions, methods, and classes" are programming terms, but the feature can also be used for listing headings or sections of other structured files, or through [config files](config-files/#function-list), can be made to match anything else that you choose to match for indicating "sections" of your text, whatever that happens to mean to you.)

#### Document List Panel Details

If you click on the file name in the Document List Panel, that file's tab will be made active. If you right-click on the filename, that tab will become active, and a right-click-context-menu will appear near your cursor -- the same context menu as you see if you right-click on the title of the tab in the [Tab Bar](../user-interface/#tab-bar-right-click-menu). And (starting in v8.5), if you middle-click on the filename, it will close that file's tab and remove it from the Document List Panel.

The Document List can be sorted by Name (or Extension or Path, if those columns are shown) by left-clicking on the header. To view the extension separately from the filename, right click on the header and choose the **Ext.** entry in the dropdown menu (as of v8.1.5; prior to that, it was in the [General settings](../preferences/#general)). To view the path in Document List panel, right click on the header and choose the **Path** entry in the dropdown menu (new to v8.1.5). As of v8.5, when you add [color to a tab](../other-resources/#tab-bar-right-click-menu), the color will also be applied to the entry in the Document List; and conversely, the right-click menu in the Document List is the same menu as the normal [tab bar right-click menu](../other-resources/#tab-bar-right-click-menu), so it will allow you to add color to the tab from that panel as well.

The Document List has collapsible separators for each of the Views (new to v8.5): if there is just one visible View, then there will be a single horizontal bar with a `︿` arrow, and clicking that `︿` arrow or double-clicking the horizontal line will collapse (hide) the list of files, and subsequently clicking the `` arrow or double-clicking the horizontal line will uncollapse (show) the list again; if there are two visible Views, then the Panel will have two collapsible separator bars, one for each View, which work in the same manner to show or hide the list of files for each view separately. If you right-click on the Document List panel's header row, you can toggle the ✔ checkmark on **Group by View** to disable and enable this option (which is on by default); if it's disabled, the files for both visible Views will be shown in a single list with no separator bar.

The Document List Panel also allows keyboard navigation when the Panel is active (the Panel will have a highlighted title bar when active): You can use the <kbd>Arrow Up</kbd> and <kbd>Arrow Down</kbd> to navigate to select a different file, then use <kbd>Enter</kbd> to "pick" or "activate" that file (that tab will come to the front of its View, and your typing and cursor movement will happen in that tab). Alternately, when the Document List Panel is active, if you type a letter, it will then select the next file in the Panel that starts with that letter; hitting that same letter repeatedly will cycle through the files with the same first letter. If you change your mind and want a file that starts with a different letter, it is not sufficient to just type that letter; instead, you need to "reset" the type-to-find -- either by clicking the Document List Panel titlebar, or by using one of the <kbd>Arrow</kbd> keys (even <kbd>Arror Right</kbd> or <kbd>Arror Left</kbd> will work, even though they don't _appear_ to do anything) -- and once it's reset, then typing a new letter will go to the next file that starts with that new letter.

### Panel Mechanics

Docked Panels can be moved easily to another edge, or to be floating instead of docked, by clicking on the Panel's title and dragging it to the new location. Another way to make a docked Panel float is to double-click its title bar. When a Panel is already floating, it may be returned to its previously-docked location by double-clicking its title bar.
Expand Down

0 comments on commit 42572b6

Please sign in to comment.