ADR for entry type and item type mapping selection#15907
Conversation
Review Summary by QodoAdd ADR 0061 for entry type and item type mapping selection
WalkthroughsDescription• Adds ADR 0061 documenting entry type and item type mapping selection • Evaluates four mapping strategies for Zotero compatibility • Selects Better BibTeX mapping as primary solution • Documents decision drivers, consequences, and trade-offs Diagramflowchart LR
A["Zotero Compatibility Need"] --> B["Evaluate Mapping Strategies"]
B --> C["citeproc-java"]
B --> D["JabRef Natural Mapping"]
B --> E["Zotero Natural Mapping"]
B --> F["Better BibTeX Mapping"]
F --> G["Selected Solution"]
G --> H["Bidirectional Conversion Support"]
File Changes1. docs/decisions/0061-EntryType-ItemType-mapping-selection.md
|
Code Review by Qodo
1.
|
| * Good, because Better BibTeX provides mapping for both entry type to item type and item type to entry type. | ||
| * Good, because Better BibTeX is designed specifically for Zotero and BibTeX and BibLaTeX interoperability. | ||
| * Good, because the repository is actively maintained. | ||
| * Bad, because Better BibTeX does not support all entry types. |
There was a problem hiding this comment.
all entry types of? Jabref?
Yes. Updated.
koppor
left a comment
There was a problem hiding this comment.
Good start.
I miss examples and where JabRef's current mapping is used.
|
Reply to #15907 (comment) and #15907 (comment): The original After the discussion with @subhramit, I modified the options. Please correct me if I misunderstand or miss something @subhramit @koppor . |
|
Add |
| @@ -2,7 +2,7 @@ | |||
| nav_order: 64 | |||
| parent: Decision Records | |||
| --- | |||
| # Entry type and item type mapping selection | |||
| # Use citation-js's mapping for CSL item type/field <-> BibLaTeX type/field conversion | |||
| * Bad, because Better BibTeX contains many-to-one mappings when converting BibTeX/BibLaTeX entry type to Zotero item type, which may lose information. | ||
| * Bad, because JabRef needs to track Better BibTeX's updates, or import it as a submodule. | ||
|
|
||
| ## Pros and Cons of the Options |
There was a problem hiding this comment.
I would have expected this ADR even more self-contained.
One example where mappings are different. In the DevCall you named an examle. Why not repeating it here?
|
|
||
| ## Context and Problem Statement | ||
|
|
||
| We are implementing compatibility with Zotero. Zotero uses its item types, while JabRef uses BibTeX/BibLaTeX entry types. We need a suitable mapping strategy that preserves as much information as possible in both directions, from JabRef to Zotero and from Zotero to JabRef. |
There was a problem hiding this comment.
Please add this in a follow up:
| We are implementing compatibility with Zotero. Zotero uses its item types, while JabRef uses BibTeX/BibLaTeX entry types. We need a suitable mapping strategy that preserves as much information as possible in both directions, from JabRef to Zotero and from Zotero to JabRef. | |
| We are implementing compatibility with Zotero. Zotero uses its [item types](https://www.zotero.org/support/kb/item_types_and_fields), while JabRef uses BibTeX/BibLaTeX entry types. We need a suitable mapping strategy that preserves as much information as possible in both directions, from JabRef to Zotero and from Zotero to JabRef. |
Related issues and pull requests
Related to #15875
PR Description
Add ADR for entry type and item type mapping selection
AI usage
Codex-5.4
Checklist
CHANGELOG.mdin a way that can be understood by the average user (if change is visible to the user)