JabRef / jabref

Graphical Java application for managing BibTeX and biblatex (.bib) databases
https://devdocs.jabref.org
MIT License
3.63k stars 2.59k forks source link

Enhance "Recommended" settings for field formatters (which are e.g. used to cleanup entries) #8790

Open ThiloteE opened 2 years ago

ThiloteE commented 2 years ago

Prerequisites

  1. Be a beginner.
  2. Have a library with bibliographic metadata.
  3. Know nothing about UTF8 and encoding.
  4. Know you want to use this library with LaTeX, Microsoft Word and OpenOffice/LibreOffice or other external programs.

Problems:

  1. Bibliographic data is formatted the "wrong" way (especially after import from external databases).

    • in other words:
      • it can be that this data cannot be read with LaTeX engines
      • or vice versa, it will create wrong output when exporting to OO/LO
      • or MS-Word
      • or using this data for HTML
      • or ...

    Hence the need to (manually or automatically) format the data into the "proper" format depending on which external program is supposed to be used. We have some field formatters for this. They are utilized by cleanup actions (field formatters as can be seen in https://github.com/JabRef/jabref/issues/8790#issuecomment-1125400446) and save actions. Cleanup actions can be found in the UI via Quality > Cleanup entries (ALT + F8). Save actions can be found via right clicking on the library tab and choosing library properties > saving > save actions. Typical examples for field formatters are latex2unicode or unicode2latex, but there are more.

  2. There are (too) many field formatters that all would manually have to be set up.

Draft Solution:

  1. Enhance "recommended" settings for field formatters.

    • Recommended (default) settings were introduced in an earlier version of JabRef via #2051
  2. Go beyond what the older feature could do: Give recommended settings for various "states" the library could be in.

    Example:

    state program user wants to use recommended cleanup actions / save actions
    Data formatted in LaTeX syntax OpenOffice/LibreOffice LaTeX2Unicode, normalize date, ...
    Data formatted in UTF8 syntax LaTeX Unicode2LaTeX, normalize date, ...
    Data formatted in LaTeX syntax UnicodeAwareLaTeX LaTeXtoUnicodAwareLaTeX (does not yet exist. See #8715 though, ...
    Data formatted in UTF8 syntax Microsoft Word no change (i think?)
    Data formatted in UTF8 syntax OpenOffice/LibreOffice no change (i think?)
    ... ... ...

    Maybe it would be good to tie this to library modes, but I am not sure how that could look like exactly...

Additional context

Siedlerchr commented 2 years ago
grafik

Is that what you mean?

ThiloteE commented 2 years ago

Ah sorry, yes. field formatters. My bad. Will edit my post.

ThiloteE commented 2 years ago

Should be better now :-)