Skip to content

Commit

Permalink
5.0.0 (#21)
Browse files Browse the repository at this point in the history
- Renamed plugin from "Paste to Current Indentation" to "Paste Mode," reflecting that the scope of the plugin has increased over the past several releases.
- Added the ability for remote images referenced in pasted HTML to be locally downloaded when pasting.
  • Loading branch information
jglev authored Dec 17, 2022
1 parent 5e65ab1 commit 4bc286d
Show file tree
Hide file tree
Showing 10 changed files with 260 additions and 64 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,6 @@ main.js

# obsidian
data.json

# For the Obsidian hotreload plugin:
.hotreload
48 changes: 33 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
## Obsidian Paste to Current Indentation Plugin
## Obsidian Paste Mode

An [Obsidian](https://obsidian.md/) plugin to paste and manage text, including block quotes, that are indented. This plugin helps especially with embedding code, quotes, and other content within lists.

_(This plugin was formerly titled "Paste to Current Indentation".)

### "Paste modes"

Paste to Current Indentation takes over the paste functionality within Obsidian. It has eight "paste modes," which determine what happens when one pastes text within a file in Obsidian. **All of the below will honor the cursor's current indentation when pasting, except for "Passthrough" mode, which uses Obsidian's default paste functionality.**
Paste Mode takes over the paste functionality within Obsidian. It has eight "paste modes," which determine what happens when one pastes text within a file in Obsidian. **All of the below will honor the cursor's current indentation when pasting, except for "Passthrough" mode, which uses Obsidian's default paste functionality.**

![Demonstration of paste modes](img/all-paste-modes.gif)

Expand All @@ -20,44 +22,60 @@ The current paste mode is displayed in Obsidian's Status Bar:

![Status bar showing current paste mode](img/status-bar.png)

### Switching paste mode
#### Switching paste mode

There are multiple ways to switch paste modes:

1. Clicking the status bar paste mode display will bring up a searchable menu with which you can select a new mode.
1. Open the Command Palette and search for `Paste to Current Indentation: Cycle Paste Mode`. This command is equivalent to clicking the satus bar.
1. Open the Command Palette and search for `Paste to Current Indentation: Set Paste Mode`. One command per paste mode is provided.
1. Open the Command Palette and search for `Paste Mode: Cycle Paste Mode`. This command is equivalent to clicking the satus bar.
1. Open the Command Palette and search for `Paste Mode: Set Paste Mode`. One command per paste mode is provided.
- These commands could be used, e.g., with the Obsidian [Quick Add plugin](https://github.com/chhoumann/quickadd/blob/master/docs/Choices/MacroChoice.md) to assign a keyboard command for switching to a given mode and then pasting.
1. Open the Command Palette and search for `Paste to Current Indentation: Cycle Paste Mode`. This command will cycle through the different paste modes (i.e., from Text mode to Text Blockquote mode, to Markdown mode, to Markdown Blockquote mode, to Passthrough mode, back to Text mode, etc.)
1. Open the Command Palette and search for `Paste Mode: Cycle Paste Mode`. This command will cycle through the different paste modes (i.e., from Text mode to Text Blockquote mode, to Markdown mode, to Markdown Blockquote mode, to Passthrough mode, back to Text mode, etc.)
1. Within the plugin's Settings page.

### Limitations of Paste Modes
#### Limitations of Paste Modes

- The "Markdown" and "Markdown (Blockquote)" modes are automatically disabled **for one-time commands** (i.e., for the "Paste in Markdown Mode," "Paste in Markdown (Blockquote) Mode", and "Paste in Mode (Interactive)" commands) in Obsidian Mobile. This is due to how Obsidian Mobile is allowed to interact with the clipboard.
If these commands are disabled, a note stating such will appear in the Settings tab for the plugin.
- Similarly, in Obsidian Mobile, images such as screenshots, and similar files, cannot be pasted from the clipboard, due to how Obsidian Mobile is allowed to interact with the clipboard.

### Additional commands

- Within the Command Palette, the `Paste to Current Indentation: Toggle blockquote at current indentation` command will toggle blockquote markers at the highlighted text's current level of indentation.
- Within the Command Palette, the `Paste Mode: Toggle blockquote at current indentation` command will toggle blockquote markers at the highlighted text's current level of indentation.

![Toggle blockquote command](img/toggle-blockquote.gif)

Block quote markers are customizable via the plugin's Settings page (e.g., if you prefer to use spaces instead of `> `).

# Roadmap
### Additional features

#### Dynamic attachment saving

- Attachments can be automatically saved to different locations based on the directory of the file being pasted into.

![](img/attachment_location_overrides.png)

#### Downloading local copies of linked attachments

- When pasting in "Markdown" or "Markdown (Blockquote)" modes, files that are linked in the text (`http://example.com/path/to/file.png`, `file://path/to/file.png`, etc.) can be automatically downloaded locally, based on their source location.

#### Automatic character escaping in Markdown

Characters that might cause display issues in Markdown (such as `==`, `<`, etc.) can be automatically [escaped](https://www.markdownguide.org/basic-syntax/#characters-you-can-escape) when pasting.

### Roadmap

I consider this plugin feature-complete for now.

Todo:

- Add tests

# Developing for this plugin
### Developing for this plugin

The documentation below is retained from the [Obsidian Sample Plugin](https://github.com/obsidianmd/obsidian-sample-plugin).

## Quickstart guide for development
#### Quickstart guide for development

- Clone this repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
- Install NodeJS, then run `yarn` in the command line under your repo folder.
Expand All @@ -67,7 +85,7 @@ The documentation below is retained from the [Obsidian Sample Plugin](https://gi
- Reload Obsidian to load the new version of the plugin.
- For updates to the Obsidian API run `yarn` in the command line under this repo's folder.

## Developing for mobile
#### Developing for mobile

Mobile development can be facilitated using the following workflow:

Expand All @@ -76,18 +94,18 @@ Mobile development can be facilitated using the following workflow:
1. Follow [the advice in this post](https://forum.obsidian.md/t/debugging-obsidian-mobile-plugins/20913):
> How to test plugins on Android I think you need to have ADB on your computer installed (I always had that installed; if the following directions don’t work without it, install it); on your android phone you have to enable ADB (it’s under developer settings [tap the build number three times to get these settings]); then connect the phone to your computer over USB; open chrome (or chromium based browser should also work) and type chrome://inspect in the browser. Open obsidian on your phone, then it should appear in the browser. You will have the console and the inspector like you have for desktop Obsidian
## Releasing new releases
#### Releasing new releases

- Update `manifest.json` with the new version number, such as `1.0.1`, and the minimum Obsidian version required for the latest release.
- Update the `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of the plugin that's compatible.
- Create new GitHub release using the new version number as the "Tag version". Use the exact version number (i.e., do not include a prefix `v`). See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
- Upload the files `manifest.json`, `main.js`, and `styles.css` as binary attachments.
- Publish the release.

## Manually installing the plugin
### Manually installing the plugin

- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/obsidian-paste-to-current-indentation/`.

## Obsidian API documentation
### Obsidian API documentation

See https://github.com/obsidianmd/obsidian-api
4 changes: 1 addition & 3 deletions createIconsDict.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ for (const f of iconFiles) {
}

fs.writeFile('icons.json', JSON.stringify(iconsDict), (err) => {
// throws an error, you could also catch it here
if (err) throw err;

// success case, the file was saved
console.log('Icons file updated.');
// console.log('Icons file updated.');
});
Binary file added img/attachment_location_overrides.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 4bc286d

Please sign in to comment.