Update README.md

This commit is contained in:
Sangye Ince-Johannsen 2024-10-27 01:03:25 +02:00
parent b3d7fe7689
commit d6e7347927

View file

@ -17,7 +17,7 @@ Creates formatted citations from DEVONthink documents, with smart Bates number s
Bates-numbered documents: Bates-numbered documents:
```markdown ```markdown
"The environmental impact study shows..." [FWS 123456](x-devonthink-item://...) "The environmental impact study shows..." [FWS 4326](x-devonthink-item://...)
``` ```
Regular documents: Regular documents:
@ -27,11 +27,10 @@ Regular documents:
## Features ## Features
- Smart Bates number detection and formatting - Copies selected text to clipboard
- Page number tracking - Calculates Bates number using if filename has Bates start or range in it
- URL-encoded quotes - Appends deeplink to selected text in document to clipboard
- Markdown-compatible output - Formats clipboard in Markdown
- Error handling
- Works with both Bates and regular documents - Works with both Bates and regular documents
## Installation ## Installation
@ -54,6 +53,17 @@ Regular documents:
- DEVONthink Pro - DEVONthink Pro
- macOS - macOS
- Perl (for URL encoding) - Perl (for URL encoding)
- For Bates numbering, documents should be titled in one of these formats:
- `FWS 000533`
- `FWS 000533-000564`
- `FWS-000533`
- `FWS_000533`
- `NMFS 002561-002985`
- `BLM 45`
- `BLM_45-62`
- etc.
I wrote a separate Python script, `bates`, to quickly rename a folder of PDFs to be compatible with this script. [Find it here →](https://sij.ai/sij/pathScripts)
## Notes ## Notes