Add ADR for preference for the compatiblity mode#16025
Conversation
PR Summary by QodoAdd ADR: avoid preference for Zotero/JabRef compatibility mode Description
Diagram
High-Level Assessment
Files changed (1)
|
Code Review by Qodo
1.
|
|
Waiting for #15907 to be merged |
| parent: Decision Records | ||
| --- | ||
|
|
||
| # Do we need a preference for the compatibility mode? |
There was a problem hiding this comment.
The title is the solution, not the question.
Same for the filename.
Do we need to refine the template? https://github.com/adr/madr/blob/develop/template/adr-template.md - I was thinking that "found solution" together with "and" was a strong hint.
| ## Considered Options | ||
|
|
||
| * Use a preference for the compatibility mode. | ||
| * Do not use a preference. |
There was a problem hiding this comment.
Maybe
| * Do not use a preference. | |
| * Transparent handling of Zotero reference marks. |
| * Good, because JabRef reads and converts Zotero's reference mark automatically, which does not disturb users. | ||
| * Good, because user does not need to enable anything to use this feature. | ||
| * Good, because it avoids the risk Zotero's reference mark being ignored if user forgets to enable the compatibility mode. | ||
| * Bad, because user may not be aware of the problems it may bring, such as information loss, unless they read the release page or user documentation. |
There was a problem hiding this comment.
I don't get "information loss". A concrete case should be written down here.
There was a problem hiding this comment.
updated. I moved the concrete case to "option description"
|
|
||
| ## Context and Problem Statement | ||
|
|
||
| JabRef is implementing compatibility with Zotero's reference marks. Apart from JabRef's own reference mark, JabRef should also support Zotero's reference mark. |
There was a problem hiding this comment.
There should be more context
Is it about postrgres and JabGui? No, it is about the LibreOffice integration - please state this.
- Will JabRef's reference marks be supported as deprecated or full support?
- What for new docments., will these be Zotero or JabRef style?
|
|
||
| ## Context and Problem Statement | ||
|
|
||
| JabRef is implementing compatibility with Zotero reference marks in the LibreOffice integration. Apart from JabRef's own reference mark, JabRef should also support Zotero's reference mark. Zotero reference marks are supported as an additional input format so that JabRef can read citations created by Zotero. For documents connected to JabRef, JabRef continues to write its own reference mark format. |
There was a problem hiding this comment.
Hyperlink Zotero Reference Marks (zotero) and Libre Office Integration (jabref docu)
|
|
||
| * Users should be disturbed as little as possible. | ||
| * Users should be warned about the possible problems. | ||
| * Users should be able to use this feature with as few steps as possible. |
There was a problem hiding this comment.
Remove "the"- or do have a concrete and complete(!) list of the problems?
|
|
||
| ## Considered Options | ||
|
|
||
| * Use a preference for the compatibility mode. |
There was a problem hiding this comment.
Updated. I modified #Decision Drivers but forgot #Considered Options 😅
|
|
||
| ## Decision Outcome | ||
|
|
||
| Chosen option: "Do not use a preference", because JabRef already uses citation-js's mapping logic as the fallback strategy. Adding a preference is unnecessary. It also brings some additional benefits, such as not disturbing users when connecting to a document. |
There was a problem hiding this comment.
Deep link to the class. Use GitHub permanent link.
|
|
||
| Since JabRef uses citation-js's mapping logic (see ADR-64) as fallback strategy, users do not need to manually enable a preference to recognize Zotero's reference mark. JabRef will convert the citation to BibLaTeX format when it reads Zotero's reference mark. Possible problems will be documented in release page and user documentation. For example, CSL item type `map` is converted to `Misc`, and the CSL field `Scale` is lost during the conversion. JabRef maps CSL item types and fields into BibLaTeX ones, but the field mapping for each CSL type may be incomplete. | ||
|
|
||
| * Good, because JabRef reads and converts Zotero's reference mark automatically, which does not disturb users. |
There was a problem hiding this comment.
Convert???? Does JabRef destroy the marks?? No more opening with Zotero plugin???
There was a problem hiding this comment.
No, should be "map" instead of "convert"
|
|
||
| ## Decision Outcome | ||
|
|
||
| Chosen option: "Do not use a preference", because JabRef already uses [citation-js's mapping logic](https://github.com/JabRef/jabref/blob/07e475dcf8e2f00447667ebd1814a09176293948/jablib/src/main/java/org/jabref/logic/openoffice/CSLItemTypeDefinitions.java#L23-L84) as the fallback strategy. Adding a preference is unnecessary. It also brings some additional benefits, such as not disturbing users when connecting to a document. |
There was a problem hiding this comment.
"Do not use a preference" is not listed as optoin, maybe you meant " Use transparent Handling of Zotero Reference Marks"
(I would not capitalize "Handling")
There was a problem hiding this comment.
"Do not use a preference" is not listed as optoin, maybe you meant " Use transparent Handling of Zotero Reference Marks"
(I would not capitalize "Handling")
Updated
| * Good, because JabRef reads and maps Zotero's reference mark automatically, which does not disturb users. | ||
| * Good, because user does not need to enable anything to use this feature. | ||
| * Good, because it avoids the risk Zotero's reference mark being ignored if user forgets to enable the compatibility mode. | ||
| * Bad, because user may not be aware of the problems it may bring (information loss), unless they read the release page or user documentation. |
There was a problem hiding this comment.
no need to really copy and paste from below, you can just write in plain text or use other words.
Information loss is not clear at this point, but it should, the sections should (more or less) self contained.
There was a problem hiding this comment.
Updated. Thank you for the advice!
|
|
||
| ### Use transparent Handling of Zotero Reference Marks | ||
|
|
||
| Since JabRef uses [citation-js's mapping logic](https://github.com/JabRef/jabref/blob/07e475dcf8e2f00447667ebd1814a09176293948/jablib/src/main/java/org/jabref/logic/openoffice/CSLItemTypeDefinitions.java#L23-L84) (see ADR-64) as fallback strategy, users do not need to manually enable a preference to recognize Zotero's reference mark. JabRef will map the citation to BibLaTeX format when it reads Zotero's reference mark. Possible problems will be documented in release page and user documentation. For example, CSL item type `map` is mapped to `Misc`, and the CSL field `Scale` is lost during the conversion. JabRef maps CSL item types and fields into BibLaTeX ones, but the field mapping for each CSL type may be incomplete. |

Related issues and pull requests
Related to #15869
PR Description
Add ADR for preference for the compatiblity mode. We decide not to use a preference.
AI usage
No
Checklist
CHANGELOG.mdin a way that can be understood by the average user (if change is visible to the user)