-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Change default behavior of resolve bibtex strings (#8382)
* Change default behavior of resolve bibtex strings Fixes #7010 Fixes #7012 Fixes #8303 * Renaming of fields * fix prefs, remove migration * Fix gui properties and l10n * adjust defaults, fix bst tests * remove obsolete test Fix changelog * fix checkstyle * fix another test * fix comment * Fix typos * add institution * Sort fields alphabetically * Group prefernces at "File": BibTeX strings, Loading, Saving * Remove unused imports * Add ADR-0024 * Add test for comment field * fix tests * Fix markdown in ADR-0024 * ADR-0024: Fix filename and addr to adr.md * ADR-0019: Fix typo * Remove obsolete empty line * Introduce BIBTEX_STRING_START_END_SYMBOL and remove negation - Add org.jabref.logic.bibtex.FieldWriter#BIBTEX_STRING_START_END_SYMBOL - !doNotResolveStrings -> resolveStrings * Remove deprecated constructor FieldWriterPreferences() * Fix test on Windows (CRLF issue) * Add missing context information * Add more tests * Fix negation Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>
- Loading branch information
1 parent
9b8f17b
commit ccf20b4
Showing
23 changed files
with
335 additions
and
145 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ment-special-fields-as-seperate-fields.md → ...ment-special-fields-as-separate-fields.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
133 changes: 133 additions & 0 deletions
133
docs/adr/0024-use-#-as-indicator-for-BibTeX-string-constants.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| # Use `#` as indicator for BibTeX string constants | ||
|
|
||
| Bibtex supports string constants. The entry editor should support that, too. | ||
| Affected code is (at least) `org.jabref.logic.importer.fileformat.BibtexParser#parseFieldContent` and `org.jabref.logic.bibtex.FieldWriter#formatAndResolveStrings` | ||
|
|
||
| ## Decision Drivers | ||
|
|
||
| * Full BibTeX compatibility | ||
| * Intuitive for the user | ||
| * UI backwards compatible | ||
|
|
||
| ## Considered Options | ||
|
|
||
| * Wrap string constants in `#` | ||
| * Replace the internal `#` in JabRef by the non-used character `§` | ||
| * Replace the internal `#` in JabRef by the non-used character `%` | ||
| * Replace the internal `#` in JabRef by the non-used character `&` | ||
| * Replace the internal `#` in JabRef by a single `&` | ||
| * Change the data type of a field value | ||
| * Wrap plan # in curly braces: `{#}` | ||
|
|
||
| ## Decision Outcome | ||
|
|
||
| Chosen option: "Wrap string constants in #", because already existing behavior | ||
|
|
||
| ## Pros and Cons of the Options | ||
|
|
||
| ### Wrap string constants in `#` | ||
|
|
||
| When BibTeX on the disk contains `field = value`, it is rendered as `field = #value#` in the entry editor. The user then knows that `value` is a BibTeX string. | ||
|
|
||
| Example: | ||
|
|
||
| left: BibTeX; right: Entry Editor | ||
|
|
||
| ```text | ||
| @String{ value = "example" } | ||
| field1 = value -> #value# | ||
| field2 = {value} -> value | ||
| field1 = value # value --> #value# # #value# | ||
| ``` | ||
|
|
||
| * Good, because In place in JabRef since more than 10 years | ||
| * Bad, because `#` is used in BibTeX for string concatenation | ||
| * Bad, because `#` is used in Markdown to indicate headings. When using Markdown in fields such as comments, this causes writing errors | ||
| * Bad, because `#` could appear in URLs | ||
|
|
||
| ### Replace the internal `#` in JabRef by the non-used character `§` | ||
|
|
||
| When BibTeX on the disk contains `field = value`, it is rendered as `field = §value§` in the entry editor. The user then knows that `value` is a BibTeX string. | ||
|
|
||
| Example: | ||
|
|
||
| left: BibTeX; right: Entry Editor | ||
|
|
||
| ```text | ||
| field1 = value -> §value§ | ||
| field2 = {value} -> value | ||
| field1 = value # value --> §value§ # §value§ | ||
| ``` | ||
|
|
||
| * Good, because Easy to implement | ||
| * Good, because No conflict with BibTeX's `#` sign | ||
| * Bad, because Documentation needs to be updated | ||
| * Bad, because `§` is not available on an US keyboard | ||
|
|
||
| ### Replace the internal `#` in JabRef by the non-used character `%` | ||
|
|
||
| Similar to "Replace the internal # in JabRef by the non-used character §" | ||
|
|
||
| Example: | ||
|
|
||
| left: BibTeX; right: Entry Editor | ||
|
|
||
| ```text | ||
| field1 = value -> %value% | ||
| field2 = {value} -> value | ||
| field1 = value # value --> %value% # %value% | ||
| ``` | ||
|
|
||
| * Good, because A user does not write LaTeX comments inside a string | ||
| * Bad, because `%` could be used in Markdown, too | ||
| * Bad, because `%` is used for comments in LaTeX and thus migtht cause confusion | ||
| * Bad, because `%` could appear in URLs: There is [url percent encoding](https://www.w3schools.com/tags/ref_urlencode.asp) | ||
|
|
||
| ### Replace the internal `#` in JabRef by the non-used character `&` | ||
|
|
||
| Similar to "Replace the internal `#` in JabRef by the non-used character `§`" | ||
|
|
||
| Example: | ||
|
|
||
| left: BibTeX; right: Entry Editor | ||
|
|
||
| ```text | ||
| field1 = value -> &value& | ||
| field2 = {value} -> value | ||
| field1 = value # value --> &value& # &value& | ||
| ``` | ||
|
|
||
| * Good, because Users do not write LaTeX tables | ||
| * Bad, because `&` is a LaTeX command for tables | ||
|
|
||
| ### Replace the internal `#` in JabRef by a single `&` | ||
|
|
||
| Prefix strings with `&` | ||
|
|
||
| Example: | ||
|
|
||
| left: BibTeX; right: Entry Editor | ||
|
|
||
| ```text | ||
| field1 = value -> &value | ||
| field2 = {value} -> value | ||
| field1 = value # value --> &value # &value | ||
| ``` | ||
|
|
||
| * Good, because Near to C syntax | ||
| * Bad, because `&` is a LaTeX command for tables | ||
| * Bad, because `&` could appear in URLs | ||
|
|
||
| ### Change the data type of a field value | ||
|
|
||
| `org.jabref.model.entry.BibEntry#setField(org.jabref.model.entry.field.Field, java.lang.String)` changes to `org.jabref.model.entry.BibEntry#setField(org.jabref.model.entry.field.Field, org.jabref.model.entry.field.Value)` (org.jabref.model.entry.BibEntry#setField(org.jabref.model.entry.field.Field, java.lang.String)). This would bring JabRef's internal data model even more close to BibTeX | ||
|
|
||
| * Good, because More object-orientated design of BibTeX field storage | ||
| * Good, because Easies implementation of an advanced field editor | ||
| * Bad, because High effort to implement |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.