Add documentation for the GUI for consistency check #551
Conversation
|
We first need to get JabRef/blog.jabref.org#109 done. Then we can port text from the blog post here. |
|
I have updated the documentation, took the content from the blog post. Also, added a screenshot of two sample entries. |
There was a problem hiding this comment.
Please also add https://blog.jabref.org/2025/03/08/Consistency-Check/#why-it-matters as section "Motivation" or "Background"
| - **EntryType Headings**: The first column lists the name of the selected entry type. | ||
| - **Choose Entry type**: Entry types (such as article, book, in-proceedings, etc.) will be listed in a dropdown menu. | ||
| - **Column 2**: Citation key of the entry. | ||
| - **Other columns**: Represent the fields and their status (`x`, `o`, `?`, or `-`). | ||
| - **Navigation**: Clicking on a line in the table will take you directly to the corresponding entry in the editor, making it easy to address inconsistencies. |
There was a problem hiding this comment.
Indent does not match content.
Maybe, you can describe the columns as bullet list - and the other points as another list?
Currently, first bullet point: heading. second bullet point: something else; sub bullets of second bullet point: headings.
There was a problem hiding this comment.
Done, but should this also be done for the blog post?
There was a problem hiding this comment.
Would be nice for the blog post, too.
Co-authored-by: Oliver Kopp <[email protected]>
This PR adds documentation for GUI for consistency check.