diff options
| author | lukeflo | 2025-10-14 10:21:39 +0200 |
|---|---|---|
| committer | lukeflo | 2025-10-14 10:36:23 +0200 |
| commit | 549f89c554ae70af28a9c7276673f0f77b488165 (patch) | |
| tree | fc7172fcad863d71fa98105599d13b6d76335436 | |
| parent | 18fa9b8bcb02aa5653b976cad7ec9c3123d4f372 (diff) | |
| download | bibiman-549f89c554ae70af28a9c7276673f0f77b488165.tar.gz bibiman-549f89c554ae70af28a9c7276673f0f77b488165.zip | |
add personal experience to citekey docs
| -rw-r--r-- | CITEKEYS.md | 29 |
1 files changed, 26 insertions, 3 deletions
diff --git a/CITEKEYS.md b/CITEKEYS.md index 165f58c..19bd497 100644 --- a/CITEKEYS.md +++ b/CITEKEYS.md @@ -148,6 +148,7 @@ should be built. 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: + [](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. @@ -157,9 +158,9 @@ 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 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 + 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. ## Examples<a name="examples"></a> @@ -215,3 +216,25 @@ The combination of those setting will produce the following citekeys: - **`article:bos-mccurley_lat=met=pub=wor_2023`** - **`book:bhambra-holmwood_col=mod=soc=the_camb:medf_2021`** + +**Personal Note** + +I use the following pattern to format the citekeys of my bibfiles: + +```toml +[citekey_formatter] +fields = [ + "author;1;;;_", + "title;3;7;-;_", + "year;;;;_", + "entrytype;;;;_", + "shorthand", +] +case = "lowercase" +ascii_only = true +``` + +It produces citekeys with enough information to quickly identify the underlying +work while not being too long; at least in my opinion. The shorthand at the end +is only printed in a few cases, but shows me that the specific work might differ +from standard articles/books etc. |