JabRef / JabRef/jabmap

Add handling of annotations

Open
#43 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
4
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Annotations belong to a PDF. PDFs belong to a BibEntry.

  1. A click on a BibEntry
  2. I click on "add files"
  3. JabMap creates sub nodes with with all PDFs files belonging to this entry
  4. I click on a PDF
  5. I click on "add annotations"
  6. JabMap creates sub notes with all PDF annotations

Variants:

  1. "Refresh annotations" - adds new annotations (and removes non-existing ones). NOTE: JabMap remembers which annotations have been deleted by the user before and does NOT add them again
  2. "Refresh PDFs" - similar to "annotations"
  3. "Inbox", where automatically new annotations, pdf files, and BibEntries flow in

In case a PDF belongs to more than one BibEntry, handling might geht strange, but we focus on this relation kind here. (This somehow refs https://github.com/JabRef/jabref/issues/8128, which describes "proceedings", which is a complete PDF containing multiple papers)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are identified in the issue. Start by tracing the entry points for “add files” and “add annotations” and how BibEntry, PDF, and annotation nodes are represented; done means annotations can be exposed under a PDF, with the described refresh and deletion behavior accounted for.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.