Skip to content

Latest commit

 

History

History
273 lines (214 loc) · 11.9 KB

Variables Reference Guide.md

File metadata and controls

273 lines (214 loc) · 11.9 KB

Variables Reference Guide

This document provides a detailed explanation of all available variables for the file naming system. Each variable can be used in your templates to create dynamic and organized file names.

Table of Contents

Basic File Information

File and Note Variables

  • {imagename} - Original image filename without extension e.g.: For "vacation-photo.jpg" → "vacation-photo"
  • {notename} - Current note name e.g.: If editing "Travel Log.md" → "Travel Log"
  • {notename_nospaces} - Current note name with underscores replacing spaces e.g.: "Travel Log" → "Travel_Log"
  • {filetype} - File extension e.g.: "jpg", "png", "pdf"
  • {parentfolder} - Parent folder name e.g.: In "Documents/Photos/Vacation" → "Photos"
  • {grandparentfolder} - Grandparent folder name e.g.: "Documents/Photos/Vacation" → "Documents"
  • {notepath} - Full path of the current note e.g.: "Documents/Photos/Vacation/MyNote"
  • {notefolder} - Current note's folder name e.g.: In "Documents/Photos/Vacation" → "Vacation"
  • {vaultname} - Obsidian vault name e.g.: "My Knowledge Base"
  • {vaultpath} - Full vault filesystem path (desktop) when available; otherwise falls back to the vault root path. e.g.: "C:/Users/username/Documents/Obsidian/My Knowledge Base"

Date and Time Variables

Basic Date Formats

  • {date:YYYY-MM-DD} - Custom date format using moment.js patterns e.g.: "2024-10-31"
    • Supports all moment.js formats like:
      • {date:YYYY} → "2024"
      • {date:MMMM Do YYYY} → "October 31st 2024"
      • {date:dddd} → "Thursday"
      • {date:HH:mm:ss} → "14:30:45"

Quick Date Variables

  • {today} - Current date in YYYY-MM-DD format
  • {tomorrow} - Tomorrow's date
  • {yesterday} - Yesterday's date
  • {YYYY-MM-DD} - Alternative current date format
  • {YYYY} - Current year (4 digits)
  • {yyyy} - Current year (4 digits, alias)
  • {MM} - Current month (01-12)
  • {mm} - Current minute (00-59)
  • {DD} - Current day (01-31)
  • {HH} - Current hour (00-23)
  • {ss} - Current second (00-59)
  • {time} - Current time in HH-mm-ss
  • {timestamp} - Unix timestamp

Natural Language Dates

  • {monthname} or {MMMM} - Full month name e.g.: "October"
  • {month} - Full month name (alias)
  • {dayname} or {dddd} - Full day name e.g.: "Thursday"
  • {weekday} - Full day name (alias)
  • {dateordinal} or {Do} - Day with ordinal e.g.: "31st"
  • {relativetime} - Human-readable relative time. Examples:
  • "2 hours ago"
  • "in 3 days"
  • "a few seconds ago"
  • {calendar} - moment.js calendar e.g.: "Today at 2:30 PM"
  • {currentdate} - Current date (YYYY-MM-DD)

Time Periods and Units

  • {startofweek} - First day of current week
  • {endofweek} - Last day of current week
  • {startofmonth} - First day of current month
  • {endofmonth} - Last day of current month
  • {nextweek} - Date next week
  • {lastweek} - Date last week
  • {nextmonth} - Date next month
  • {lastmonth} - Date last month
  • {daysinmonth} - Number of days in current month
  • {weekofyear} or {week} or {w} - Week number (1-52)
  • {quarterofyear} or {quarter} or {Q} - Quarter (1-4)
  • {dayofyear} or {DDD} - Day of year (1-365)

Image Properties

Basic Dimensions

  • {width} - Image width in pixels
  • {height} - Image height in pixels
  • {aspectratio} - Width/height ratio (2 decimals) e.g.: "1.78" for 16:9 ratio
  • {ratio} - Width/height ratio (alias for aspectratio)
  • {resolution} - Full resolution string e.g.: "1920x1080"

Size and Quality Indicators

  • {megapixels} - Image megapixels e.g.: "2.07" for 1920x1080
  • {quality} - Current conversion quality setting
  • {bytesperpixel} - Average bytes per pixel
  • {compressionratio} - Image compression ratio

Image Analysis

  • {orientation} - Image orientation: "landscape", "portrait", "square"
  • {issquare} - Square image indicator: "true", "false"
  • {aspectratiotype} - Common aspect ratio name: "16:9", "4:3", "1:1", "16:10", "custom"
  • {resolutioncategory} - Image size category:
  • "tiny" (< 100K pixels)
  • "small" (< 500K pixels)
  • "medium" (< 2M pixels)
  • "large" (< 8M pixels)
  • "very-large" (≥ 8M pixels)
  • {filesizecategory} - returns 1 of the 6 file size categories:
  • 0-50KB
  • 51-200KB
  • 201-1024KB
  • 1025KB-5MB
  • 5MB-10MB
  • 10MB+
  • {dominantdimension} - Larger dimension: "width", "height", "equal"
  • {dimensiondifference} - Pixel difference
  • {maxdimension} - Larger dimension value
  • {mindimension} - Smaller dimension value
  • {diagonalpixels} - Diagonal resolution
  • {aspectratiosimplified} - Simplified ratio: "16:9" from 1920x1080
  • {screenfitcategory} - Screen resolution category:
  • "fits-1080p" (≤ 1920x1080)
  • "fits-1440p" (≤ 2560x1440)
  • "fits-4k" (≤ 3840x2160)
  • "above-4k"
  • {pixelcount} - Total number of pixels in the image

Size Variables

Flexible Size Formatting

  • {size:MB:2} - Size in MB with custom decimals e.g.: "1.25 MB"
  • {size:KB:1} - Size in KB with custom decimals e.g.: "1280.5 KB"
  • {size:B:0} - Size in bytes with custom decimals e.g.: "1310720"

Quick Size Variables

  • {sizemb} - Size in MB
  • {sizekb} - Size in KB
  • {sizeb} - Size in bytes

Hashing and Unique Identifiers

MD5 Hashing Options

All MD5 hashes can be truncated using :length suffix. The type argument is case-insensitive (e.g. {MD5:FileName} works the same as {MD5:filename}).

  • {MD5:filename} - Hash of filename
  • {MD5:filename:8} - First 8 characters of filename hash
  • {MD5:fullpath} - Hash of the image path. For images already in the vault (TFile), this hashes the full vault path (e.g. Images/Sub/pic.png). For drag/paste images (File), it falls back to hashing the filename because no vault path exists.
  • {MD5:parentfolder} - Hash of parent folder
  • {MD5:rootfolder} - Hash of root folder
  • {MD5:extension} - Hash of file extension
  • {MD5:notename} - Hash of current note
  • {MD5:notefolder} - Hash of note's folder
  • {MD5:notepath} - Hash of note's path
  • {MD5:custom text} - Hash of custom text

SHA-256 Hashing Options

SHA-256 supports the special image type (hashes the image file content). The type argument is case-insensitive (e.g. {sha256:FileName} works the same as {sha256:filename}). Hashes can be truncated using a :length suffix.

  • {sha256:image} - Hash of the image content
  • {sha256:image:8} - First 8 characters of image content hash
  • {sha256:filename} - Hash of filename
  • {sha256:filename:10} - First 10 characters of filename hash
  • {sha256:fullpath} - Hash of the image path. For images already in the vault (TFile), this hashes the full vault path (e.g. Images/Sub/pic.png). For drag/paste images (File), it falls back to hashing the filename because no vault path exists.
  • {sha256:parentfolder} - Hash of parent folder
  • {sha256:rootfolder} - Hash of root folder
  • {sha256:extension} - Hash of file extension
  • {sha256:notename} - Hash of current note
  • {sha256:notefolder} - Hash of note's folder
  • {sha256:notepath} - Hash of note's path
  • {sha256:custom-text} - Hash of custom text

Random Identifiers

  • {randomHex:6} - Random hex string e.g.: "A1B2C3"
  • {counter:000} - Incremental counter e.g.: "001", "002", "003"
  • {random} - Random alphanumeric e.g.: "x7k9m2"
  • {uuid} - Random UUID e.g.: "550e8400-e29b-41d4-a716-446655440000"

System Information

  • {timezone} - System timezone e.g.: "America/New_York" or "Europe/London"
  • {locale} - System locale e.g.: "en-US"
  • {platform} - Operating system e.g.:: "Win32", "MacIntel"
  • {useragent} - Browser user agent string

Examples and Use Cases

  1. Use forward slashes (/) to create subfolders
  2. Combine different variable types for unique filenames
  3. Include dates/minutes/seconds or any hashing algorithms to prevent duplication or replacement of files.

This allows us to create various organizational structures, and categorise various types of images based on folders, subfolders or pure file-naming. E.g.: Keep all images processed this week/month/quarter/year in 1 folder, or maybe even collect all images processed each day in their own respective folder. Not enough? We could further categorise them by project. Some of the possible use-cases:

Example 1 - Let Obsidian handle the folder creation

Folder: Default File naming: {notename}-{date:YYYYMMDDHHmmSSsss}

Example 2 - 50/50 - Let Image Converter handle the images, and Obsidian all other attachments

In Image Converter:

  • Folder: /attachments/all-vault-images/{YYYY-MM-DD}/{notename}/
  • File naming: Inserted {imagename} at {YYYY-MM-DD} {time}

In Obsidian: Settings -> Files and links -> Default location for new attachments -> In the folder specified below:

  • Attachment folder path: : /attachments

This setup allows you to organize all images added to Obsidian in one main folder: /all-vault-images while keeping all other attachments (PDF, docx, zip etc.) in /attachments folder.

/attachments
├── all-vault-images
│   ├── 2024-10-31
│   │   ├── MyNoteName
│   │   │   ├── Inserted image1.jpg at 2024-10-31 12-34-56
│   │   │   └── Inserted image2.png at 2024-10-31 13-00-00
│   └── ... (other daily folders)
└── ... (other attachments, like PDFs, docs, etc.)

Inside /all-vault-images, a new subfolder is automatically created for each day you add or process images, such as /2024-10-31. Each daily subfolder then contains subfolders for each note where images were inserted (e.g., MyNoteName). This is folder heavy approach, but the one which allows to easily create a chronological view of when which image was added into which note (because now all images from one specific note will be located under 1 same folder)

Example 3 - Natural Language Date Organization - Journaling, Daily Logs etc.

  • Folder: /{yyyy}/{monthname}/Week {weekofyear} ({startofweek} to {endofweek})/{dayname} {dateordinal}/
  • File naming: {time}-{imagename}

Example output is a path reads like natural language:

/2024/November/Week 45 (Oct 28 to Nov 3)/Thursday 31st/14-30-meeting-notes.jpg
/2024/November/Week 45 (Oct 28 to Nov 3)/Friday 1st/09-15-project-update.png

Example 4 - keeping vault size small

  • Folder: `/attachments/all-vault-images/{filesizecategory}/
  • File naming: {notename}-{imagename}-{size:MB:2}MB_{date:YYYYMMDD}

This would allow you to keep all images in 1 place categorised into subfolders based on converted image file size:

/attachments
├── all-vault-images
│   ├── 0-50KB
│   ├── 51-200KB
│   ├── 201-1024KB
│   ├── 1025KB-5MB
│   ├── 5MB-10MB
│   └── 10MB+
└── ... (other attachments, like PDFs, docs, etc.)
  • 0-50KB - Files smaller than 50 kilobytes
  • 51-200KB - Files between 51 and 200 kilobytes
  • 201-1024KB - Files between 201 and 1024 kilobytes (1 megabyte)
  • 1025KB-5MB - Files between 1025 kilobytes and 5 megabytes
  • 5MB-10MB - Files between 5 and 10 megabytes
  • 10MB+ - Files larger than 10 megabytes

For example, if I would see any images inside 1025KB-5MB, 5MB-10MB, 10MB+ folders, it would signify to me that those images require further optimization (or if I would like to keep my vault size small - I would even consider deleting them).

  • {notename} - if link is ever broken, embedding note name into actual image gives me enough context to track it down later, similarly with {imagename} and the {date:YYYYMMDD}
  • {size:MB:2}MB - by adding size to the note, I can be proactive a see the size of the converted file, if it is too big I would re-process further with maybe higher compression level or maybe even a small resize