Jabref: Cleanup "Error console"

Created on 28 Feb 2016  路  16Comments  路  Source: JabRef/jabref

JabRef as built on 2016-02-28.

Consistent naming of "Error console"

Help / "Show error console" brings up a window called "Program output". This is inconsistent. To clean the thing up, I propose to

  • rename "Show error console" to "Show developer information"
  • rename "Program output" to "Developer information"

Reason: I neither find "Error console" nor "Program output" fitting. "Program output" fits better, but it is not the UI, it is the console output somehow. The log, however, is not shown on the console.

Remove tab "Exceptions"

I think with the current exception handling, we can remove the tab "Exceptions". In case the "Log" shows an exception (such as java.lang.NullPointerException), the tab "Exceptions" does shows "No exceptions have occurred." This feels inconsistent. Therefore, I propose to remove the tab "Exceptions".

Update: I had an exception today (#890). Maybe we can try to log all exceptions somehow and then remove that tab.

Change the big red x into something nice.

The window of the error console shows a big X on inside a red circle. That indicates errors, but we also show useful logs without errors. Other dialogs of JabRef also don't have an icon. Therefore, I propose to remove the X completely. If we want to go with icons because they support usability, we should use an "i" somehow.

grabbed_20160228-141703

enhancement ui

Most helpful comment

Maybe a functionality to create an issue in github with the details about the version, log and the .bib file (opt-in of course) plus a text. The github API seems easy to use, when looking at the code which checks for the update notification.

All 16 comments

The X is because it is a JOptionPane(?) and will be automatically not there when a better solution (resizable (#872) and non-modal (#819)) is in place (unless someone adds it back explicitly).

Why not call the tabs "Logs", "System.err" and "System.out"? And the action "Show logs"?

I will try to rewrite this in JavaFX and address the other things mentioned

Good idea. Please base on the javafx branch. There is also a label javafx
and a first pull request for the about dialog rewritten in JavaFX.

I would remove all the tabs and just have one list for all messages. The different kinds of messages can then be differentiated via color or icons. This would also make debugging easier since debug messages are logged before and after the corresponding exception.

Two further remarks:

  • add button to toggle debug mode on/off
  • add button to copy log messages (necessary?)

Hiho,
I will ask something:
@koppor Should i remove "Exception" Tab?
@tobiasdiez Should i add this buttons?

thx for tip and help ;-)

The debug toggle is probably not that important but a nice extra. Copying the messages should be very very easy since we want users to include the output in their bug reports. So except if you come up with a more innovative solution, a simple button will do.

What about renaming it to "Error diagnostics" or "Troubleshouting". The user doesn't have to care that we developer treat it as console output, but should click on it in case he has some problems. The dialog should also contain a short text directing the user to https://github.com/JabRef/jabref/issues

Maybe a functionality to create an issue in github with the details about the version, log and the .bib file (opt-in of course) plus a text. The github API seems easy to use, when looking at the code which checks for the update notification.

@simonharrer

  • Github api doesn't support attach file. (have a look at this link: https://developer.github.com/v3/issues/#create-an-issue)
  • So i will implement a function to create a issue with the details about the version and log, if it is okay.

Is it possible to post a new issue in the name of the (logged in) GitHub user? I suppose it is not.... and using a "generic bug reporting user" is also not sensible for me as there is no way to contact the actual user to ask questions...

Another option would be to fill in the issue form using some GET parameters: https://github.com/JabRef/jabref/issues/new?title=bla&body=blubb

@matthiasgeiger
I have tried to handler the create of new issue with automatics Binding of List - Entries about URL:
But there are some problems:

  • First one: the URL Length is limit by ca. 2000 char (take a look at screenshot)
    01
  • Second one: the methode openBrowser() of JabrefDesktop.class has a limit of 200 char (take a look at screenshot)
    02

Need some helps and tipps. Thx you :-)

@motokito Maybe a POST request works (instead of GET with parameters)

@tobiasdiez
Can you explain and give ne some Tipps. How should I implemented this solution ?
I am very thx you about it 馃槉

@oscargus Thx you about the links.
But i have some problem, that:
if one is not logged in to github, it will redirect one to login page. Once logged in, it will redirect one to the create new issue page. Now if we using GET method, it will fill in the parameter from the URL. But when using the POST method and we are not logged in. We will also get redirected to the login page and can not send our POST parameters for create new issue. This means we need to be log in befor sending the POST request for the new issue page.
Should i implement this github login functionality from jabref ? How can i open it in browser after i send GET / POST Request ?

Thx you about your help :-)

I did not read through the whole of it but oAuth sounds like something worth having a look on https://developer.github.com/v3/oauth/

Was this page helpful?
0 / 5 - 0 ratings

Related issues

jonasstein picture jonasstein  路  3Comments

a-torgovitsky picture a-torgovitsky  路  3Comments

Siedlerchr picture Siedlerchr  路  4Comments

humbleambition picture humbleambition  路  3Comments

LinusDietz picture LinusDietz  路  3Comments