Obsidian Attachment Management

This plugin supports more flexibly to setting your attachment location with variable like ${notepath}, ${notename} and ${date}.

Features

This plugin currently supports:

• Setting the attachment location with ${notepath}, ${notename}, ${date} and ${parent}
• Auto-rename the attachment when paste file to markdown or canvas
• Auto-rename the attachment file or folder while your rename the article (markdown or canvas) file
• Auto-rename the attachment when drop file to markdown or canvas
• Re-Arrange the attachment file that linked by markdown or canvas to corresponding path as you configured (experimental)
• Processing duplicate attachment
  • Processing duplicate attachment on craete (the first time, you paste or drop a attach in notes)
  • Processing duplicate attachment on rename
• Override attachment configuration for specified notes or folder

How to install

• Install from Obsidian community plugins.
• Clone this repo
  • npm i to install dependencies
  • npm run build to start compilation in watch mode.
  • Copy the main.js and manifest.json files to your vault VaultFolder.obsidian/plugins/obsidian-attachment-management

Settings

The path of attachment is composed of three parts :

{root path}/{attachment path}/{attachment name}.extension

And you can use the variables below to config:

• ${notepath}: The directory of the markdown or canvas file under the vault root.
• ${notename}: The filename of the markdown or canvas file (without file extension).
• ${parent}: The parent folder name of the markdown or canvas file.
• ${originalname}: The filename of the attachment file when first time it created in obsidian.
• ${date}: Date time format by Moment format options

Root Path to Save New Attachments

You must select a root folder to save the associated attachment of a markdown or canvas file.

It can be set use the config of obsidian in Files & Links, or reset in this option.

• Copy Obsidian settings: use the config of obsidian in Files & Links.
• In the folder specified below: set a fixed folder.
• Next to note in folder specified below: in the subfolder of current markdown or canvas file.

Attachment Path

A sub-folder to place attachment under the {root path}, available variables:

• ${notepath}: The directory of the markdown or canvas file under the vault root.
• ${notename}: The filename of the markdown or canvas file (without file extension).
• ${parent} : The parent folder name of the markdown or canvas file.

Default value ${notepath}/${notename}.

Attachment Format

Set how to rename the attachment, available variables:

• ${notename}: The filename of the markdown or canvas file (without file extension).
• ${originalname}: The filename of the attachment file when first time it created.
• ${date}: Date time format by Moment format options

default value IMG-{date}.

Date Format

Use Moment format options to set the ${date}, default value YYYYMMDDHHmmssSSS. You should always use the ${date} variable to prevent the same file name.

Handle All Attachments

By default, only auto-rename the image file (see Accepted file formats), if enable this option, all created file (except md or canvas) will be renamed automatically

Exclude Extension Pattern

This option is only useful when "Handle all attachments" is enabled. Write a Regex pattern to exclude certain extensions from being handled.

Automatically Rename Attachment

Automatically rename the attachment folder/filename when you rename the folder/filename where the corresponding md/canvas file be placed.

Usage

Install and enable the plugin, after configure you can paste or drop attachment file as usually and it will be auto rename.

This plugin supports a command Rearrange Linked Attachments. If you run this command, it will rename all attachment that has been linked in markdown or canvas file as you configured.

Notice The Rearrange Linked Attachments was currently a experimental feature, if you want to try out, it's better to back up your files at first.

Overriding Setting

You can set the attachment path setting for file or folder. The priority of these setting are:

file setting > most close parent folder setting > global setting

If you want to reset the setting of files or folder to the global setting, use the command Reset Override Setting or the Reset button of override setting panel. By the way, the reset will only working on each file or folder that you have set on. The more appropriate method to handle the reset will be add in future.

Known Issues

• No support for processing duplicated file name right now (in develop). In backup, you could use the data variable x to use Unix timestamp with millisecond as filename (it will prevent duplicated filename).
• When drop a file in canvas, it's will delay to show the updated link/filename.