Skip to content

Commit

Permalink
2.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
gasparschott committed Aug 27, 2024
1 parent c48238b commit d04e954
Show file tree
Hide file tree
Showing 4 changed files with 399 additions and 227 deletions.
89 changes: 46 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,90 +6,93 @@
- [Introduction](#introduction)
- [Usage](#usage)
1. [Basic Example](#basic-example)
2. [Commands](#commands)
3. [Contextual Menus](#contextual-menus)
4. [Opening Multiple Items](#opening-multiple-items)
- [Commands](#commands)
- [Other Functions](#other-functions)
- [The Settings Window](#the-settings-window)
5. [Maximum number of items to open at one time](#maximum-number-of-items-to-open-at-one-time)
6. [Allow single click to open File Explorer folders in Continuous Mode](#allow-single-click-to-open-file-explorer-folders-in-continuous-mode)
- [Other Functions](#other-functions)
- [Continuous Mode and other Plugins](#continuous-mode-and-other-plugins)
- [The Settings Window](#the-settings-window)
- [Troubleshooting](#troubleshooting)

## Introduction
A plugin for Obsidian that displays all open notes in a tab group as if they were a continuous scrollable document (sometimes called “Scrivenings mode”). Also provides methods to open multiple notes from the File Explorer, search results, document links, or dataview/query blocks.
A plugin for Obsidian that displays all open notes in a tab group as if they were a continuous scrollable document (sometimes called “Scrivenings mode”). Continuous Mode is available for notes in the Main Split and panes in the Sidebars. The plugin also allows keyboard navigation between notes, and provides several ways to open multiple notes at one time—from the File Explorer, search results, document links, or dataview/query blocks.

### <a href="https://www.buymeacoffee.com/fiLtliTFxQ" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 40px !important;" ></a>

## Usage:

### Basic Example
With multiple notes already open, toggle Continuous Mode and note headers, scroll notes into view by clicking tab or making it active:
<img src="assets/01-basic.gif" style="width:672px;" alt="Tab Group Menu" />
With multiple notes already open, you can use the contextual menu to toggle Continuous Mode in the active tab group and to toggle visibility of note headers; you can scroll notes into view by clicking the tab or making the note active:

### Commands
Two commands are currently available:
- Toggle continuous mode in active tab group
- Toggle visibility of note titles in active tab group
<img src="assets/01-basic.gif" style="width:672px;" alt="Basic usage example" />

### Contextual Menus

This plugin adds a “Continuous Mode” menu item to the contextual menus in various parts of the Obsidian UI. The position of the menu item and the available options differ according to the...er...context.
This plugin adds a “Continuous Mode” menu item to the contextual menus available in various parts of the Obsidian UI. The position of the menu item and the available options differ according to the...er...context.

#### Basic Functions
<img src="assets/menu-basic-1.png" style="width:229px;" alt="Tab Group Menu" />

These are available in the Tab Group Menu, File Menu, Selected Tab Menu, and Editor Menus.
These menu items are available in the Tab Group Menu, File Menu, Selected Tab Menu, and Editor Menus.

#### Opening Multiple Items
The contextual menus allow you to open multiple notes from the File Explorer, search results, file, or dataview/query block contextual menus. You can:
- open items in a new split (left, right, up, down).
- open or append items in the active tab group; files will not be duplicated if they are already open.
- replace files in the active tab group with files from the selected folder (i.e., close all open notes in active tab group and replace with folder items).
<img src="assets/menu-basic-1.png" style="width:229px;" alt="Tab Group Menu" />

##### Change sort order submenu

<img src="assets/menu-sort.png" style="width:197px;" alt="Change sort order" />

<img src="assets/menu-open-folder.png" style="width:307px;" alt="Folder Menu" /> <img src="assets/menu-open-file.png" style="width:290px;" alt="File Menu" />

<img src="assets/menu-open-search-results.png" style="width:357px;" alt="Search Results Menu" /> <img src="assets/menu-open-query-block-links.png" style="width:339px;" alt="Query Block Menu" />
#### Opening Multiple Items

<img src="assets/menu-open-document-links.png" style="width:362px;" alt="Document Links Menu" />
In other contexts, the menu will include options to allow you to open multiple items in Continuous Mode.

- You can filter the files that are opened by type (e.g., markdown, images, canvas, etc.), extension, or file name in the Settings.
- Opening folders is not recursive—only the top level notes will be opened.
- Sort order is respected when opening folders. Once opened, sort order does not dynamically update when it is changed in the file explorer; reopen the folder in Continuous Mode to accomplish this.
- Similarly, after opening multiple files, the tab group will not dynamically reflect any changes you make to the folder structure in the file explorer. If you do make any changes (e.g., move, create, or delete a note), you'll have to reopen the folder to see the updated structure.
<img src="assets/menu-open-folder.png" style="width:307px;" alt="Folder Menu" />

#### Change sort order submenu
Change the order of the open notes in the active tab group.
This menu will show “file,” “document links,” “query block links,” “search results” instead of “folder” depending on the context. You can:
- Open items in a new split (left, right, up, down).
- Open or append items in the active tab group; files will not be duplicated if they are already open.
- Replace files in the active tab group with files from the selected folder (i.e., close all open notes in active tab group and replace with folder items).

<img src="assets/menu-sort.png" style="width:197px;" alt="Change sort order" />
See the Settings for options to:
- filter (include or exclude) the files that are opened: by type (e.g., markdown, images, canvas, etc.), extension, or file name.
- set the number of items to open at one time.
- open File Explorer folder items with one click.

**Notes:**
Opening folders is not recursive—only the top level notes in the folder will be opened.
Sort order of the source (e.g., File Explorer, Search Results) is respected when opening multiple items. Once opened, sort order does not dynamically update when it is changed in the file explorer; reopen the folder in Continuous Mode to accomplish this.
Similarly, after opening multiple files, the tab group will not dynamically reflect any changes you make to the folder structure in the file explorer. If you do make any changes (e.g., move, create, or delete a note), you'll have to reopen the folder to see the updated structure.

### Maximum number of items to open at one time
You can set the maximum number of file to be opened at one time in the Settings. This allows you to open the items in a folder incrementally by repeatedly selecting “Open or append items in Continuous Mode”. This is useful for dealing with folders containing a large number of items.
## Commands
Many of the above functions can be invoked via the Command Palette.

### Allow single click to open File Explorer folders in Continuous Mode
Enable this in the Settings, with a default action to perform (e.g., “Open folder in new split left”).
## Keyboard navigation in and between notes
You can navigate between notes with the up and down arrow keys, and with the left and right arrow keys if the cursor is at the beginning or end of the note.
- In pdfs, the left and right arrow keys will jump from page to page.
- In HTML files, the left and right arrow keys will scroll the page.
- In an active canvas leaf, click the background to deselect any active node and use the up and down arrow keys to navigate to the adjacent note.
- In an active graph view, similarly use the arrow keys to navigate to the adjacent note. Use ```shift + arrow``` keys to move the graph around.
- While editing notes, the insertion point will scroll so as to remain more or less in the center of the screen, similar to “typewriter mode”; this behavior can be disabled in the settings.

## Other functions
- Notes will scroll into view when you click the tab header. Note: this may fail when clicking tab headers for the first time after start-up, and before the note has been scrolled into view at least once. This appears to be an issue with Obsidian.
- You can reorder notes in a tab group by dragging and dropping the tab headers.
- Automatically save and restore continuous mode tab group settings when shutting down/starting up Obsidian.
- Navigate between notes with up and down arrow keys (and left and right arrow keys if at the beginning or end of the note).
- Also use left and right arrow keys to scroll html notes or jump from page to page in pdfs.
- If editing a canvas file (i.e., canvas leaf is active), click the background to deselect any active node and use the up and down arrow keys to navigate to the adjacent note.
- Similarly use the arrow keys to navigate out of an active graph view. Use shift+arrow keys to move the graph around.
- While editing notes, the insertion point will scroll so as to remain more or less in the center of the screen, similar to “typewriter mode”; this behavior can be disabled in the settings.
- Scroll notes into view by clicking the tab header. Note: scroll into view fails when clicking the tab headers the first time, and before the note has been scrolled into view at least once. This appears to be an issue with Obsidian.
- Reorder notes in tab group via tab header drag-and-drop.

## The Settings Window

<img src="assets/settings.png" style="width:621px;" alt="Settings window" />

## Continuous Mode and other Plugins
The Continuous Mode menus are available or compatible with the following third-party plugins which add to or modify the File Explorer or provide new file views:
The Continuous Mode menus are available or compatible with the following third-party plugins, which add to or modify the File Explorer or provide new file views:

- “<a href="https://obsidian.md/plugins?id=file-tree-alternative" target="_blank">File Tree Alternative</a>” plugin.
- “<a href="https://github.com/Quorafind/Outliner.MD" target="_blank">Outliner.MD</a>” plugin.
- “<a href="https://github.com/Quorafind/Outliner.MD" target="_blank">Outliner.MD</a>” plugin.
- “<a href="https://obsidian.md/plugins?id=longform" target="_blank">Longform</a>” plugin. Basic support: Files are opened in their project or scene order (i.e. not alphabetically); however, tab order is not automatically refreshed when the project order is changed, nor are new files automatically opened when new scenes are created. While technically feasible, there are too many variables to make this work predictably. Instead, open the project again in Continuous Mode using the "replace" option.

## The Settings Window
If you find that Continuous Mode interferes with or doesn’t work properly with a particular plugin, please let me know.

<img src="assets/settings.png" style="width:621px;" alt="Settings window" />

## Troubleshooting
- “No readable files found”: If you know that there are readable files in the source you are trying to open, check the plugin settings to make sure that the “Filter file types” are set to include the file types .
Expand Down
Loading

0 comments on commit d04e954

Please sign in to comment.