Skip to content

GUI_Requirements

felixlut edited this page Feb 26, 2020 · 25 revisions

Table of Contents

GUI Requirements

Settings

The following settings should be available to alter for the user:

  • Credentials:
    • Setting the username to BibSonomy
    • Setting the API key to BibSonomy
  • Tag Cloud:
    • Set the number of Tags shown in the Tag cloud
    • Set ordering inside the Tag Cloud
      • Frequency of use
      • Alphabetical
      • Folkrank
      • Date
  • Fetching posts
    • Number of posts to fetch per request
    • Options to:
      • Show warning if more posts are available
      • Show warning if a post is missing its Tag
      • Update Tags on startup
      • Upload documents on export
      • Download documents on import
  • Default visibility
    • Private - The entries are only available to the user
    • Public - The entries are available to all users
  • Extra fields
    • All the BibTeX fields which should be visible on the Extra tab in the entry editor of JabRef

This is how the old version presented the settings: Settings

Fetching new entries

It should be possible to find new bibliographical entries to the user's collection. These new entries can be found in 2 ways:

  • Direct Search
  • The Tag Cloud

Direct Search

It should be possible to search for new entries via:

  • Full text
  • Tags

This is how this functionality was implemented previously:

Search

Tag cloud

There should be a list of tags which can be used to find new entries, based on the mode used:

  • User mode
    • Tags from the Users private collection
  • World mode
    • Tags from all users
    • Tags from groups the user is a part of

This is how the functionality was implemented before. It was also possible to reload the tag cloud by using the Refresh button:

Tag cloud

Filter found entries

The above mentioned actions(Tag Cloud and Direct Search), fetches a collection of new entries to the user. All of these should be presented to the user in some way.

The following actions should be possible to take:

  • Selecting entries
  • Deselecting entries
  • Deselecting duplicates
  • Delete entry
  • Generate (BibTeX)key
  • Import selected entries
  • Stop querying the BibSonomy API
  • Cancel the search
  • Display extra information about the currently selected page

This is how the old functionality was presented: Found entries

Exporting to BibSonomy

It should be possible to export the entries to BibSonomy.

The previous version implemented the functionality like this: Export

Deleting entries

It should be possible to delete entries from the users own BibSonomy publication collection.

The previous version implemented the functionality like this: Delete

Synchronize

It should be possible to synchronize local and remote BibTeX entries. If there is any differences it should be possible to solve the conflict.

The previous version implemented the synchronization functionality like this: Sync

And the conflict resolution like this: Sync

Private documents

It should be possible for the user to download his/her documents.

The previous version implemented the functionality like this: Export

Proxy settings

It should be possible to access BibSonomy via a proxy.

The previous version implemented this functionality via the same method that JabRef in itself implements it, by using the following command when starting up JabRef: java -Dhttp.proxyHost="hostname" -Dhttp.proxyPort="portnumber"