Jabref: File annotations: remove line breaks, increase width, and reduce font size

[anassal]

JabRef 4.2-dev--snapshot--2018-03-09--master--988fb54a9
Windows 8.1 6.3 x86
Java 1.8.0_161

1. Multi-line PDF annotations like these:

are shown with "line breaks" like this.

1. There is currently a wide white space between the annotation text and the date/page number. Text should be warped with the maximum available/appropriate width.

2. Then, the height of each annotation item should be "auto".

3. I suggest the font size of the extracted annotations in the left-hand panel be reduced (e.g., x0.6). The right hand panel font size looks OK.

[miderleta]

Hi. I am looking for my first contribution. Do you mind if I would give this issue a go please?

[Siedlerchr]

@miderleta You are welcome! Please take a look at our Contribution guideline for getting started and setting up a workspace etc and you can start.

For this specific issue it's probably sufficient to play around with the css properties and the fxml.
If you have any questions please ask here or in our gitter chat

[miderleta]

It seems like I cannot generate Javadoc for the project. Is that an issue or am I doing something wrong?

[Siedlerchr]

@miderleta Where do you need it for? Any modern IDE will show you the javadoc automatically for each method - if it's annotated.

Edit// For understanding of the high level architecture, you might take a look at our wiki https://github.com/JabRef/jabref/wiki/High-Level-Documentation

[upupming]

@anassal

Line breaks

If we always delete the line breaks in annotation, it will look better. But what if the line breaks are for another paragraph? You can see this example:

Line break at Location 1 should be deleted, but that at location 2 should be reserved!

I will try to find a solution to judge if the line break should be removed. If you have any idea, please leave a comment.

Date/Page margin

Actually, this margin will be changed automatically when you adjust your window size. See the following gif:

The summary in the left-hand panel is so long that there is no extra space for the "Marking" and "Content" panel. I will try to wrap the summary and reduce the minimized margin between summary and date/page footer in the left-hand panel. I will also reduce the font size of summary.

By the way,

1. Then, the height of each annotation item should be "auto".

Do not understand your meaning clearly, could you please explain it in more detail?

[Siedlerchr]

Maybe you can differentiate between a new paragraph starting vs a normal line break code wise.

[anassal]

@upupming This is a valid point. But can't we reasonably assume that most annotations are in single paragraphs, since paragraphs usually contain different ideas?

For annotations that actually span over multiple paragraphs, we can see if there are statistical differences between "end-of-line" and "end-of-paragraph" linebreak characters, as @Siedlerchr suggested, in PDFs annotated in multiple readers (e.g., Adobe, Foxit, Okular). It is also worth checking if this has been solved in other libraries/tools that extract text from PDF.

Regarding the "auto" height of an annotation item (left-hand panel), I just meant auto height that would result from text wrapping and fixed/limited width. Along with text wrapping and other improvements, the summary could be limited to, say, 10-15 words.

[upupming]

@anassal Done~

Now you can check the build from http://builds.jabref.org/master/. Please remember to make a backup of your library before trying out this version.