aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorlukeflo2025-10-14 10:11:52 +0200
committerlukeflo2025-10-14 10:14:34 +0200
commit18fa9b8bcb02aa5653b976cad7ec9c3123d4f372 (patch)
tree3ab6d26ddf966317407d597b07a0957885694351
parentc62b83e02359c24973344699116acc12b4a04108 (diff)
downloadbibiman-18fa9b8bcb02aa5653b976cad7ec9c3123d4f372.tar.gz
bibiman-18fa9b8bcb02aa5653b976cad7ec9c3123d4f372.zip
add dry-run example to citekeys doc
-rw-r--r--CITEKEYS.md10
-rw-r--r--tests/test-config.toml9
2 files changed, 14 insertions, 5 deletions
diff --git a/CITEKEYS.md b/CITEKEYS.md
index 912326a..165f58c 100644
--- a/CITEKEYS.md
+++ b/CITEKEYS.md
@@ -66,7 +66,8 @@ Every field pattern consists of the following five parts separated by
semicolons. The general pattern looks like this (every subfield is explained
below):
-*biblatex field name* **;** *max word count* **;** *max char count* **;** *inner delimiter* **;** *trailing delimiter*
+*biblatex field name* **;** *max word count* **;** *max char count* **;** *inner
+delimiter* **;** *trailing delimiter*
- **BibLaTeX field**: the first part represents the field name which value
should be used to generate the content part of the citekey. Theoretically, any
@@ -145,9 +146,10 @@ 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.
+ changing anything. For the test file of this repo and using the pattern from
+ the [section below](#examples) `----dry-run` produces the following output:
- After finding a good overall pattern, *use the `--output=` option* to create a
- new file and don't overwrite your existent file. Thus, your original file
+ new file and don't overwrite your existing file. Thus, your original file
isn't broken if the key formatter produces some unwanted output.
- Even very long patterns are possible, they are not encouraged, since it bloats
the bibfiles.
@@ -155,7 +157,7 @@ should be built.
it bares the risk of producing doublettes (e.g. single author and year only).
But the citekey generator will not check for doublettes!
- It is possible to keep special chars and use them as delimiters. But this
- might cause problems other programs and CLI tools in particular, since many
+ might cause problems for other programs and CLI tools in particular, since many
special chars are reserved for shell operations. For instance, it will very
likely break the note file feature of `bibiman` which doesn't accept many
special chars.
diff --git a/tests/test-config.toml b/tests/test-config.toml
index 8dd8014..704d8d8 100644
--- a/tests/test-config.toml
+++ b/tests/test-config.toml
@@ -61,7 +61,14 @@ custom_column = "series"
# year_color = "135"
[citekey_formatter]
-fields = ["shorthand;;;;+","entrytype;;;;:", "author;2;;-;_", "title;3;6;=;_", "year", "publisher;;5;#;" ]
+fields = [
+ "shorthand;;;;+",
+ "entrytype;;;;:",
+ "author;2;;-;_",
+ "title;3;6;=;_",
+ "year",
+ "publisher;;5;#;"
+]
# fields = [ # CamelCase test
# "author;2;;;",
# "title;5;5;;",