aboutsummaryrefslogtreecommitdiff
path: root/CITEKEYS.md
diff options
context:
space:
mode:
Diffstat (limited to 'CITEKEYS.md')
-rw-r--r--CITEKEYS.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/CITEKEYS.md b/CITEKEYS.md
index 19bd497..828e557 100644
--- a/CITEKEYS.md
+++ b/CITEKEYS.md
@@ -147,11 +147,17 @@ should be built.
- Most importantly: *always use the **`--dry-run`** option first*! This will
print a list of old and new values for all citekeys in the file without
changing anything. For the test file of this repo and using the pattern from
- the [section below](#examples) `----dry-run` produces the following output:
+ the [section below](#examples) `--dry-run` produces the following output:
[![niri-screenshot-2025-10-14-10-11-06.png](https://i.postimg.cc/SxxRkY8K/niri-screenshot-2025-10-14-10-11-06.png)](https://postimg.cc/bs4pRJmX)
- After finding a good overall pattern, *use the `--output=` option* to create a
new file and don't overwrite your existing file. Thus, your original file
isn't broken if the key formatter produces some unwanted output.
+- Its possible to update citekey based PDF and note files directly when
+ formatting the citekeys using the `-u`/`--update-attachments` option. Thus,
+ all PDFs and notes are already linked to the correct entries after updating
+ the citekeys. Since this operation can break things, use it with `--dry-run`
+ first. As with regular citekeys this will print all changes without processing
+ anything.
- Even very long patterns are possible, they are not encouraged, since it bloats
the bibfiles.
- The same accounts for *too short* patterns; if the pattern is to unspecific,