openlibhums / openlibhums/janeway
Detect metadata discrepancies when a JATS XML galley is uploaded
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 238
- Forks
- 97
- Avg merge
- 9d 1h
- Merged PRs (30d)
- 8
Description
Is your feature request related to a problem? Please describe.
As explained in the project this issue is part of (https://github.com/orgs/BirkbeckCTP/projects/3, when a JATS XML galley is uploaded, the encoded metadata may differ from that in the Janeway database.
Describe the solution you'd like
- A mechanism for detecting discrepancies between a JATS XML file and the metadata stored in Janeway
- A mechanism for synchronizing changes from the encoded JATS into the database and viceversa
Describe alternatives you've considered
An alternative would be to completely ignore the metadata encoded in the JATS file and always use Janeway generation logic instead as per #2125
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing where JATS XML galleys are uploaded and where Janeway stores the corresponding metadata. Define the discrepancy cases and synchronization direction before identifying how completion will be verified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, xml
- Domain
- backend, content
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100