From c8abbf58d72df1426495e7bb1bcb94777618b7db Mon Sep 17 00:00:00 2001 From: Marty Oehme Date: Wed, 11 Jun 2025 16:42:37 +0200 Subject: [PATCH] doc: Add example formatting variations --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3575865..22f1702 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # papis-bbt-formatter -Formats reference keys in papis similarly to the (zotero plugin) `better-bibtex` keys, in the format `Name2008TitleShort`. +Formats reference keys in papis similarly to the (zotero plugin) `better-bibtex` keys, in formats such as `Name2008TitleShort`, `Name2008titleshort`, or `Name2008`. ## Installation @@ -43,7 +43,10 @@ formatter = bbt ref-format = bbt: ``` -For now, the ref-format also _has_ to start with `bbt:`. +The formatter is set to `bbt` which will invoke it for every formatting operation +(see the `default-formatter` setting for formatting things other than the ref-key). + +For now, the ref-format also _has_ to start with `bbt:` so that the formatter picks it up. Formatted reference keys by default will look like: