Obsidian paste image rename
This plugin is inspired by Zettlr, Zettlr shows a prompt that allows the user to rename the image, this is a great help if you want your images to be named and organized clearly.
Zettlr's prompt after pasting an image
Paste image rename plugin not only implements Zettlr's feature, but also allows you to customize how the image name would be generated, and eventually free you from the hassle by automatically renaming the image according to the rules.
How to use
Basic usage
After installing the plugin, you can just paste an image to any document and the rename prompt will display: 
By typing the new name and clicking "Rename" (or just press enter), the image will be renamed and the internal link will be replaced with the new name.
If you set "Image name pattern" to {{fileName}} (it's the default behavior after 1.2.0), "New name" will be generated as the name of the active file. 
Set imageNameKey frontmatter
While adding a lot of images to one document, people possibly want the images to be named in the same format, that's where imageNameKey is useful.
First set a value for imageNameKey in frontmatter:
---
imageNameKey: my-blog
---
Then paste an image, you will notice that the "New name" has already been generated as "my-blog", which is exactly the value of imageNameKey: 
You can change the pattern for new name generating by updating the "Image name pattern" value in settings.
For a detailed explanation and other features such as auto renaming, please refer to Settings.
Add prefix/suffix to duplicated names
The plugin will always try to add a prefix/suffix if there's a file of the same name.
Let's continue from the last section and paste the second image, the prompt will still show the new name as "my-blog", now if we just click "Rename", the file will be renamed as "my-blog-1.png", not "my-blog.png":
The -1 suffix is generated according to the default settings:
- Because "Duplicate number at start" is false, suffix is used rather than prefix
- "Duplicate number delimiter"
-is put before the number1
If we paste the third image without editing the "New name" input, its name will be "my-blog-2.png", the number is increased according to the largest number of "my-blog-?.png" in the attachment directory.
This feature is especially powerful if you enable "Auto rename" in settings, you can just add new images without thinking, and they will be renamed sequentially by the pattern and imageNameKey set.
FAQ
-
Q: I pasted an image but the rename prompt did not show up.
A: This is probabily because you are using Windows system and pasting from a file (i.e. the image is copied from File Explorer not from a browser or image viewer). In Windows, pasting from a file is like a regular file tranfer, the original file name is kept rather than being created and named "Pasted image ..." by Obsidian. You need to turn on "Handle all image" in settings to make it work in this situation.
Settings
-
Image name pattern
The pattern indicates how the new name should be generated.
-
Available variables:
{{imageNameKey}}: this variable is read from the markdown file's frontmatter, from the same keyimageNameKey.{{DATE:$FORMAT}}: use$FORMATto format the current date,$FORMATmust be a Moment.js format string, e.g.{{DATE:YYYY-MM-DD}}
-
Examples of pattern to results :
(imageNameKey = "foo")
{{imageNameKey}}-: foo-{{imageNameKey}}-{{DATE:YYYYMMDDHHmm}}: foo-202204081652Pasted Image {{DATE:YYYYMMDDHHmm}}: Pasted Image 202204081652
-
-
Duplicate number at start (or end)
If enabled, the duplicate number will be added at the start as prefix for the image name, otherwise, it will be added at the end as suffix for the image name.
-
Duplicate number delimiter
The delimiter to generate the number prefix/suffix for duplicated names. For example, if the value is
-, the suffix will be like "-1", "-2", "-3", and the prefix will be like "1-", "2-", "3-". -
Auto rename
By default, the rename modal will always be shown to confirm before renaming, if this option is set, the image will be auto renamed after pasting.
-
Handle all images
By default, the plugin only handles images that starts with "Pasted image " in name, which is the prefix Obsidian uses to create images from pasted content. If this option is set, the plugin will handle all images. This includes drag'n drop image, or any other image that is created in the valut.
3 Jul 31, 2022
0 Nov 9, 2020
3 Jul 19, 2022
19 Nov 15, 2022
19 May 1, 2022
8 Sep 5, 2022
5 Nov 1, 2022
1 Aug 22, 2022
16 Dec 6, 2022
3 Nov 12, 2022
65 Nov 2, 2022
4 Mar 23, 2022
5 Dec 20, 2022
4 Nov 29, 2022
15 Oct 2, 2022
11 Nov 30, 2022
9 Aug 25, 2022
16 Nov 5, 2022