diff options
| author | lukeflo | 2025-10-15 08:50:54 +0200 |
|---|---|---|
| committer | lukeflo | 2025-10-15 08:50:54 +0200 |
| commit | 7d59b6c816fa81c13cdf8348a2e7db0076015cd1 (patch) | |
| tree | 06e863cc52411cf041ca0d118c1334c7d3e3bac2 /README.md | |
| parent | 34170cfa62df5443a0d8675106c553efec035687 (diff) | |
| parent | db882623358d9141927bd31f6825472f2cdca4b6 (diff) | |
| download | bibiman-7d59b6c816fa81c13cdf8348a2e7db0076015cd1.tar.gz bibiman-7d59b6c816fa81c13cdf8348a2e7db0076015cd1.zip | |
Merge pull request 'implement basic citekey formatting' (#58) from format-citekeys-#55 into main
Reviewed-on: https://codeberg.org/lukeflo/bibiman/pulls/58
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
@@ -24,9 +24,11 @@ - [Ubuntu/Debian](#ubuntudebian) - [Void Linux](#void-linux) - [Usage](#usage) + - [CLI for citekey formatting](#cli-for-citekey-formatting) - [Configuration](#configuration) - [Location of Config File](#location-of-config-file) - [General Configuration](#general-configuration) + - [Citekey formatting](#citekey-formatting) - [Color Configuration](#color-configuration) - [Features](#features) - [Keybindings](#keybindings) @@ -196,6 +198,13 @@ bibman tests/multi-files/ bibiman tests/biblatex-test.bib tests/multi-files/ ``` +### CLI for citekey formatting<a name="cli-for-citekey-formatting"></a> + +Beside the TUI `bibiman` can format and replace citekeys. To make use of this +feature run the program with the `format-citekeys` subcommand. For more +information use `bibiman format-citekeys --help` and the see +[docs](./CITEKEYS.md). + ## Configuration<a name="configuration"></a> ### Location of Config File<a name="location-of-config-file"></a> @@ -268,6 +277,11 @@ note_symbol = "" ## Possible values are "journaltitle", "organization", "instituion", "publisher" ## and "pubtype" (which is the default) custom_column = "pubtype" + +[citekey_formatter] +fields = [] +ascii_only = true +case = "lowercase" ``` `bibfiles` @@ -326,6 +340,12 @@ custom_column = "pubtype" good advice to use a rather wide terminal window when using a value like `journaltitle`. +### Citekey formatting<a name="citekey-formatting"></a> + +`bibiman` now also offers a citekey generating feature. This enables to reformat +all citekeys based on an elaborated pattern matching syntax. For furthter +information and examples see the [docs](CITEKEYS.md). + ### Color Configuration<a name="color-configuration"></a> Furthermore, it is now possible to customize the colors. The following values |