From d00e22668e6df25c3d4fae24f05270711be7bdfa Mon Sep 17 00:00:00 2001 From: Marty Oehme Date: Wed, 11 Jun 2025 16:58:20 +0200 Subject: [PATCH 1/2] docs: Add developer info --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 22f1702..b2f4b21 100644 --- a/README.md +++ b/README.md @@ -164,6 +164,23 @@ default-formatter = jinja2 Can be any of the installed papis formatters, including custom ones (though usually it will be `python`, which is also the default setting). +## For developers + +To get started hacking on this little plugin it is easiest to either inject papis into the development environment: + +```sh +uv add --dev papis +``` + +Or, what I do, in turn inject it into your normal papis environment as editable: (`uv tool install --with-editable path/to/this/repo papis`). + +Currently I can see two big things to do that would help this project out: + +- A way to encode the options directly in the `ref-format` string, such as `ref-format = bbt:Author[1]year[2]TITLE[2, 20]` or something. +- Tests for all the little regex-y things we do. Tests for extracting the author, formatting the title, taking apart dates, and so on. + +If you have the motivation to work on one of these let me know! + --- This plugin is a fairly simple adaption from [this](https://github.com/hrdl-github/papis/commit/b9b9c6eaa3de159e1b210174ef49e90a89271eb8) commit, From 03261a4f9e407b66b09a1af62a2776e06e5c5fbc Mon Sep 17 00:00:00 2001 From: Marty Oehme Date: Thu, 4 Dec 2025 10:39:40 +0100 Subject: [PATCH 2/2] docs: Warn of papis 0.14.1 incompatibility --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index b2f4b21..0af95be 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ Formats reference keys in papis similarly to the (zotero plugin) `better-bibtex` keys, in formats such as `Name2008TitleShort`, `Name2008titleshort`, or `Name2008`. +> [!IMPORTANT] +> In the current state this plugin is _not_ supported by papis v0.14.1 as that version refactors the formatting module. To my knowledge papis v0.14.0 should still be supported. + ## Installation