Add a "LaTeX Citations" tab to the entry editor by davidemdot · Pull Request #5155 · JabRef/jabref

davidemdot · 2019-07-30T00:29:03Z

This pull request adds a LaTeX Citations tab to the entry editor, to search for citations to the active entry in the LaTeX file directory (it can be configured in the Library properties dialog).

The new tab can be disabled in the preferences.

Summary of changes

An improved back-end

Optimized parsing performance
Non-existing nested files are skipped
Better exception handling

The new tab

New tab in the entry editor: LaTeX Citations
This tab could be disabled in the entry editor preferences
A progress indicator appears while parsing
Search cancellation if the active entry is changed (background tasks)
Parsed files are stored when the tool is run for the first time (much better performance)
The current search path is shown at the bottom, next to a button to change the LaTeX file directory
Error logging and handling (some of them are shown in the entry editor)

A custom user interface controller for listing citations

Citations list view is the same for dialog tool and tab (CitationsDisplay)
Context of citations, instead of the full line (which is shown as a tooltip)
Changed absolute file path to a relative one, from the search path
New icons and styles for context, file path and position (line and column) of a citation

Miscellaneous

Updated EntryEditor class for injecting dependencies and fixing minor bugs
Renamed tool: LaTeX Citations instead of LaTeX references

That is how it works

Change in CHANGELOG.md described
Manually tested changed features in running JabRef
Screenshots added in PR description (for bigger UI changes)
Ensured that the git commit message is a good one

[WIP] LaTeX Integration project

…a search is cancelled

…tryeditortab

… given entry

Add LaTeX citations tab to the entry editor

LinusDietz · 2019-08-01T09:32:13Z

Hey @davidemdot, didn't check the code yet. Have tested the feature and it seems that the directory JabRef parses is my home directory. As a result I get the following error:

I guess the problem is somewhere here:
https://github.com/JabRef/jabref/pull/5155/files#diff-83e88d28f1ee5c44f11ec9e20bc30891R113

davidemdot · 2019-08-01T09:56:20Z

Hey @LinusDietz!

Firstly, it tries to get the LaTeX file directory. If you did not configure it, it will search in your working directory (preferencesService.getWorkingDir()).

You can set the LaTeX file directory in the 'Library properties' dialog.

LinusDietz · 2019-08-01T11:17:56Z

You can set the LaTeX file directory in the 'Library properties' dialog.

Okay, didn't know that.

My suggestion would be to display the current search path at the bottom of the tab and add a button to directly manipulate the LaTeX file directory.
The exception in the screenshot should be caught anyways and the directory should just be skipped in the parsing.
Another issue is that it seems that the whole LaTeX file directory is parsed each time the Entry Editor is opened or a different entry is selected. This takes about 10 seconds for me, which is too long for the feature to be useful. Can you cache the result of the parsing?
The implementation of the parsing follows the input{} commands of LaTeX. Every time a file is not found (due to whatever reason), an exception is thrown. Can you test for the existence of the file before reading it and issue a log message instead?

13:11:00.851 [pool-3-thread-4] ERROR org.jabref.logic.texparser.DefaultTexParser - Error opening a TEX file
java.nio.file.NoSuchFileException: /Users/dietzl/git/diss/presentations/docsem2018/../../corporate_design/Ressourcen/Praesentation/../../corporate_design/Ressourcen/Praesentation/Praeambel.tex

davidemdot · 2019-08-01T11:39:03Z

Thanks for your feedback! I will work on it and tell you something as soon as possible.

* Update for adding latest changes (no final version) * Fix small issues * Update for improving code * Add localization keys * Update styles * Remove unused code and improve exceptions handling * Add latest improvements

- Change CitationViewModel to CitationsDisplay. - Improve styles and icons. - Remove unused code.

davidemdot · 2019-08-04T20:11:17Z

After latest changes, it looks like...

:"D

LinusDietz

I really like the feature now! I have very few comments. I'd say we should merge this when those are addressed 🎉

…ultTexParser)

davidemdot · 2019-08-05T16:00:13Z

Good points, @LinusDietz. It is done!

Siedlerchr

In general lgtm, just one question about the path in the test. Why did it change?

Siedlerchr · 2019-08-08T14:23:39Z


-        expectedParserResult.addKey(EINSTEIN_C, Paths.get("foo/bar"), 1, 0, 21, citeString);
-        expectedParserResult.addKey(EINSTEIN_A, Paths.get("foo/bar"), 1, 26, 47, citeString);
+        expectedParserResult.addKey(EINSTEIN_C, Paths.get(""), 1, 0, 21, citeString);


I don't understand the change here

I think it does not really matter.

LinusDietz · 2019-08-09T07:06:20Z

To move on with this I have merged the PR. Great work! 🎉

davidemdot and others added 30 commits May 31, 2019 02:05

TEX parser: classes and tests

11d7620

Add support for parsing nested files and cross-references

08d8baa

Fix several TEX parser issues

f75e511

Move database-related methods to the CrossReferences class

0e47a8b

Refactor code

deb44d6

Update tests for an easier understand and fix general issues

2dfbfdb

Add test for two citations in the same line

b46aeb4

Rename CrossingKeys to TexBibEntriesResolver and fix minor issues

2037295

Merge pull request #5011 from davidemdot/latex-integration-project

de20a67

[WIP] LaTeX Integration project

Add user interface for the TEX parser tool (#5103)

eda24df

Update EntryEditor for using PreferencesService

a13e3b2

Add LaTeX references tab option to entry editor preferences

fedda55

Add getCitationsByKey(BibEntry) method in TexParserResult

4214103

Add LaTeX references tab to the entry editor

4ba7f0d

Add missing localization keys

d1fc7b3

Fix bug related to the display of results

145b631

Replace Boolean with boolean type in preferences

cba1949

Rename feature-related stuff (references -> citations)

47deee4

Update CHANGELOG.md

4d7256d

Improve exception handling and add search cancellation

04d1a5f

Update DefaultTexParser for avoiding ClosedByInterruptException when …

0d41f30

…a search is cancelled

Update EntryEditor for adding @Inject uses

0095bed

Fix bug in EntryEditor (setOnDragDropped event)

de0db44

Merge remote-tracking branch 'origin/master' into latexintegration-en…

e6722ee

…tryeditortab

Update logger messages in cancelSearch()

b1c7cb6

Update LaTeX citations tab for using a enum status property

824ba0d

Merge branch 'master' into latexintegration-entryeditortab

1fd6d4e

Improve performance in the entry editor tab by searching for only the…

ce4f925

… given entry

Add default case to bindToEntry() in LatexCitationsTab

00287d8

Update for adding small improvements

b2c75cb

davidemdot added 5 commits July 28, 2019 14:18

Change toString() methods

3d019db

Add a new JabRefIcons.LATEX_CITATIONS

7adf03a

Fix all issues from reviews of #5137

34713f5

Merge pull request #5137 from davidemdot/latexintegration-entryeditortab

7a49dd2

Add LaTeX citations tab to the entry editor

Revert temporal change

06d266f

davidemdot requested review from LinusDietz and Siedlerchr July 30, 2019 00:42

davidemdot added component: entry-editor project: gsoc component: ui labels Jul 30, 2019

davidemdot mentioned this pull request Aug 2, 2019

LaTeX integration latest changes #5167

Merged

4 tasks

davidemdot added 3 commits August 2, 2019 15:30

LaTeX integration latest changes (#5167)

b0fbb14

* Update for adding latest changes (no final version) * Fix small issues * Update for improving code * Add localization keys * Update styles * Remove unused code and improve exceptions handling * Add latest improvements

Merge branch 'master' into latexintegration

28d06b9

Add latest changes to latexintegration (#5170)

556b8b7

- Change CitationViewModel to CitationsDisplay. - Improve styles and icons. - Remove unused code.

LinusDietz approved these changes Aug 5, 2019

View reviewed changes

Comment thread src/main/java/org/jabref/logic/texparser/DefaultTexParser.java Outdated

Comment thread src/main/java/org/jabref/logic/texparser/DefaultTexParser.java Outdated

Add a check for nested files and improve the code to skip lines (Defa…

034227b

…ultTexParser)

LinusDietz reviewed Aug 5, 2019

View reviewed changes

Comment thread src/main/java/org/jabref/logic/texparser/DefaultTexParser.java Outdated

davidemdot added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Aug 6, 2019

davidemdot changed the title ~~Add 'LaTeX Citations' tab to the entry editor~~ Add a "LaTeX Citations" tab to the entry editor Aug 6, 2019

Remove logging message for non-existing nested files

83b94e5

Siedlerchr approved these changes Aug 8, 2019

View reviewed changes

LinusDietz merged commit be8663a into master Aug 9, 2019

tkubt mentioned this pull request Oct 5, 2021

Make the LaTeX citations tab a entry table column #8123

Open

Uh oh!

Conversation

davidemdot commented Jul 30, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of changes

An improved back-end

The new tab

A custom user interface controller for listing citations

Miscellaneous

That is how it works

Uh oh!

LinusDietz commented Aug 1, 2019

Uh oh!

davidemdot commented Aug 1, 2019

Uh oh!

LinusDietz commented Aug 1, 2019 • edited by davidemdot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

davidemdot commented Aug 1, 2019

Uh oh!

davidemdot commented Aug 4, 2019

Uh oh!

LinusDietz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

davidemdot commented Aug 5, 2019

Uh oh!

Uh oh!

Siedlerchr left a comment

Choose a reason for hiding this comment

Uh oh!

Siedlerchr Aug 8, 2019

Choose a reason for hiding this comment

Uh oh!

LinusDietz Aug 9, 2019

Choose a reason for hiding this comment

Uh oh!

LinusDietz commented Aug 9, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

davidemdot commented Jul 30, 2019 •

edited

Loading

LinusDietz commented Aug 1, 2019 •

edited by davidemdot

Loading