Skip to content

GUI for bibliography consistency check #11950

@koppor

Description

@koppor

Note This is a bit more effort. Suited for more than one developer

JabRef has a functionality to check a set of BibTeX entries for consistency. (Introcued at #10778 and #10847)

The class for that is org.jabref.logic.quality.consistency.BibliographyConsistencyCheck.

There is currently no UI.

Goals:

  1. Add a new menu entry at Quality: "Check consistency" (below "Check integrity")
  2. This executes BibliographyConsistencyCheck on the whole library
  3. It presents a result window

Result window:

Displays org.jabref.logic.quality.consistency.BibliographyConsistencyCheck.Result.

Use each EntryType as heading (or do accordeons as in the FindUnlinkedFiles functionality)

For each EntryType in Result:

Display org.jabref.logic.quality.consistency.BibliographyConsistencyCheck.EntryTypeResult

  • Render as table
  • First column: Citation key
  • On click of a line : jump to entry (similar to behavior of org.jabref.gui.search.GlobalSearchBar)
  • other columns: Field names
  • content:
    x | required field is present
    o | optional field is present
    ? | unknown field is present
    - | field is absent

See org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultTxtWriterTest#checkDifferentOutputSymbols for a "guide" how to get the symbols. Just step through the code.

If no new tables are used, but a single table, this table would look as follows:

image

(Taken from #10778)

Metadata

Metadata

Labels

good first issueAn issue intended for project-newcomers. Varies in difficulty.

Type

No type
No fields configured for issues without a type.

Projects

Status
Done
Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions