Skip to content

Add user interface for the TEX parser tool#5103

Merged
LinusDietz merged 32 commits into
JabRef:latexintegrationfrom
davidemdot:latexintegration-ui
Jul 12, 2019
Merged

Add user interface for the TEX parser tool#5103
LinusDietz merged 32 commits into
JabRef:latexintegrationfrom
davidemdot:latexintegration-ui

Conversation

@davidemdot

@davidemdot davidemdot commented Jul 4, 2019

Copy link
Copy Markdown
Member

The goal has been to connect the back-end of the parser with the user interface:

A first dialog box will ask for a directory for scanning TEX files. For displaying these entries, a new dialog box will be opened.

User Interface

Any feedback is more than welcome!

@tobiasdiez tobiasdiez left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update. The code looks already quite good. I've a bunch of small comments and remarks.
(I'm currently travelling and thus have only bad internet - because of this, I was not always able to provide proper references. Sorry for that. Please let me know if some of my pointers were to vague.)

Comment thread src/main/java/org/jabref/gui/actions/StandardActions.java Outdated
Comment thread src/main/java/org/jabref/gui/texparser/FileNodeViewModel.java Outdated
Comment thread src/main/java/org/jabref/gui/texparser/ParseTexDialog.fxml Outdated
Comment thread src/main/java/org/jabref/gui/texparser/ParseTexDialogView.java Outdated
Comment thread src/main/java/org/jabref/gui/texparser/ParseTexDialogView.java Outdated
Comment thread src/main/java/org/jabref/gui/texparser/ParseTexResultViewModel.java Outdated
Comment thread src/main/java/org/jabref/gui/texparser/WalkFileTreeTask.java Outdated
Comment thread src/main/java/org/jabref/gui/texparser/WalkFileTreeTask.java Outdated
Comment thread src/main/java/org/jabref/gui/texparser/WalkFileTreeTask.java Outdated
Comment thread src/main/java/org/jabref/gui/util/RecursiveTreeItem.java Outdated
@davidemdot

Copy link
Copy Markdown
Member Author

Thanks for your feedback, @tobiasdiez.

I have been fixing some points, and will comment others in detail today along the day.

@tobiasdiez tobiasdiez added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Jul 5, 2019

@Siedlerchr Siedlerchr left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apart from @tobiasdiez requested changes it looks already good.
Pleas resolve them so we can start trying out

@davidemdot

davidemdot commented Jul 7, 2019

Copy link
Copy Markdown
Member Author

Working on:

  • Disable parse button while there are no items selected
  • Small progress indication for searching and parsing

Not sure about (see comments above):

  • Search for a global constant for LaTeX
  • Is it really necessary to have the listBind statement in the root change listener (instead of a one-time binding)? (ParseTexDialogView.java)

@LinusDietz

LinusDietz commented Jul 8, 2019

Copy link
Copy Markdown
Member

Hey @davidemdot,
I had a look at the feature and it looks quite good already. The parsing seems to work very well, and the preview of the text around the citation is also nice.

  • some fonts of formatted italic/ \texttt{} seems not to work.

Screen Shot 2019-07-08 at 13 23 06

Generally, there are some more important things to consider. I think one of the rather important use cases would be something like 'As a researcher, I want to keep track in which papers I have cited a certain paper.' This is not really easy in the current UI. Therefore, I would need to be able to add several independent locations to the LaTeX references search window and some option to manage these.

Furthermore, I would find it interesting to have an option to display a list of entries that I have never cited in any of my papers.

I guess we all should discuss whether we can support these use cases and how a UI for this could look like @JabRef/developers

Also, there is one larger problem with the parsing:

  • When I parse a directory with many papers, I get the following error:

Screen Shot 2019-07-08 at 13 36 48

After that the whole feature becomes unusable and you cannot select any other path. I realize that adding such a big directory is probably not a good idea, but JabRef should detect that and not open too many files at once.

@davidemdot

Copy link
Copy Markdown
Member Author

Thanks, @LinusDietz!

I am trying to replicate the error, but I cannot do it. How many files does that folder contain?

Searching many files

Parsing many files

@davidemdot

Copy link
Copy Markdown
Member Author

And that's how I see the formatted text...

Styles

... which means that it will be more complicated to solve it.

😅

@Siedlerchr

Copy link
Copy Markdown
Member

Could be one of those weird mac osx issues. The too many open files seems to a unix size things. Can be configured as far as I see https://superuser.com/questions/433746/is-there-a-fix-for-the-too-many-open-files-in-system-error-on-os-x-10-7-1

@davidemdot

Copy link
Copy Markdown
Member Author

I have been testing these issues in Windows 10 and it seems to work.

@Siedlerchr Siedlerchr left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codewise lgtm. As this is a new feature, you should probably add a changelog entry.

import org.jabref.logic.l10n.Localization;

public class FileNodeViewModel {
class FileNodeViewModel {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would actually still leave this all public, there might be some cases where it could be still needed

@LinusDietz LinusDietz merged commit eda24df into JabRef:latexintegration Jul 12, 2019
@davidemdot davidemdot deleted the latexintegration-ui branch July 27, 2019 15:19
github-actions Bot pushed a commit that referenced this pull request Dec 1, 2020
a20406d Added name of the editors of a given edition (#5140)
9881fc5 Ping on push, not PR, document role of dist-updater (#5137)
04668cc Create nouvelles-perspectives-en-sciences-sociales.csl (#5063)
1d94e21 Update bursa-uludag-universitesi-saglik-bilimleri-enstitusu.csl (#5047)
84f3893 Add Harvard style for Metropolia University of Applied Sciences (#5086)
8e43e79 Create opto-electronic-advances.csl (#5135)
36e4fba Update society-for-american-archaeology.csl (#5124)
69ca360 St. Paul Canon Law new style (#5138)
b490ab0 Update and rename st-paul-university-faculty-of-canon-law.csl to saint-paul-university-faculty-of-canon-law.csl
b498116 There is no en-CA locale
3c35f28 Metadata
7059cca Create tu-dortmund-agvm.csl (#5088)
c321c98 Create new Citation type (#5093)
a7edc8d Update international-organization.csl (#5103)
3d1a052 The AWS load balancer is messing things up (#5133)
ca3839b Fix sort by a single macro (#5136)
5d1a7e8 Update chungara-revista-de-antropologia-chilena.csl (#5123)
cd75d5d ping distribution-updater (#5132)
dcf473a Update wirtschaftsuniversitat-wien-health-care-management.csl (#5125)
a87085e Fix Harvard Praxisforschung Editors (#5130)
d4176ca Switch automated tests to Github Actions (#5111)
726d0d8 Radiology, MPP, CORR -- small fixes: https://forums.zotero.org/discussion/85883/doi-radiology#latest https://forums.zotero.org/discussion/51058/style-request-molecular-plant-pathology#latest https://forums.zotero.org/discussion/85678/citing-style-clinical-orthopaedics-and-related-research#latest
e23db68 Update to la-trobe-university-harvard style (#5119)
c54b278 Create wirtschaftsuniversitat-wien-health-care-management.csl (#5110)
62fb019 Create austral-entomology.csl (#5118)
afa328c Update iso690-author-date-en.csl (#5113)
5468dce Update iso690-author-date-fr-no-abstract.csl (#5112)
98af86c Update iso690-numeric-fr.csl (#5115)
09f84c4 Update iso690-author-date-fr.csl (#5114)
178a9e4 Fix current biology to superscript
1fa5ce7 Create droit-belge-centre-de-droit-prive-ulb.csl (#5107)
3a6a4bc Fix file modes (#5106)
48f50e5 Create chungara-revista-de-antropologia-chilena.csl (#5096)
1e848f8 Create the-journal-of-the-indian-law-institute.csl (#5100)
856524c Create molecular-biology.csl (#5101)
eeebbf4 Create harvard-harper-adams-university.csl (#5104)
d90993d Fix tests
d4037bf WIP: St Paul Canon Law style

git-subtree-dir: src/main/resources/csl-styles
git-subtree-split: a20406d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

project: gsoc status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants