Structured Citations

[GaziYucel]

Add structured citations feature to OJS 3.5 and above.

Focus will be structuring references which are input in the free input field on the References section in the backend UI. The location of the structured citations will be under the current References text area field.

I have the following in mind

• database
  • citations: citation_id, publication_id, raw_citation, seq
  • citation_settings: citation_settin_id, citation_id, locale, settin_name, setting_value, setting_type
  • authors and other fields in the schema are an array of objects, these will be saved as a json blob in citation_settings table
• UI Library components will be used
• the location in the UI will be under the References text area.
• adding references will still be done by adding in the References textarea as done now
• saving references will add a job to process the citations
• all citations with an doi will be processed automatically:
  • extract doi
  • if doi found: structured citations will be retrieved from openalex
  • if doi not found, retrieve from crossref api:
    • only process the high scores
    • ignore low scores
• the citations will be multi-lingual (only string fields such as title, abstract, etc.)
• include citations in exports:
  • ...

Related pull requests

• ojs: Structured Citations ojs#4529
• pkp-lib: Structured Citations #10462
• ui-library: Structured Citations ui-library#464
• googleScholar: Structured Citations googleScholar#24

Backend UI

https://www.youtube.com/watch?v=yWpQ1GNexow

Original data model for as used in the former Citation Manager Plugin:

• doi: The DOI itself, such as 10.1234/5a6b-7c8d.
• title: The title of the work.
• publicationYear: The copyright year for this publication.
• publicationDate: The publication date, formatted as an ISO 8601 date e.g. 2018-02-13.
• type: The type or genre of the work, e.g. journal-article.
• volume: The volume of the issue of the journal, e.g. 495.
• issue: The issue of the journal, e.g. 7442.
• pages: The number of pages of the work/article, e.g. 4.
• firstPage: The first page of the work/article, e.g. 49.
• lastPage: The last page of the work/article, e.g. 59.
• abstract: The abstract of this work.
• journalName: Name of the journal
• journalIssnL: Issn_l of the journal
• journalPublisher: Publisher name of the journal
• url: URL for the work.
• urn: URN for the work.
• arxivId: Arxiv id.
• handleId: Handle id.
• openAlexId: OpenAlex ID.
• wikidataId: Wikidata QID.
• openCitationsId: Open Citations ID.
• githubIssueId: GitHub Issue ID for Open Citations.
• authors: array of objects { orcid, display_name, given_name, family_name, wikidata_id, openalex_id }

Schema of FidusWriter

id: citation id
publicationId: publication id
raw_citation: Raw citation.
seq: The order in which this citation should appear in a list of citations.
abstract: Abstract of this work
addendum: Addendum to this work
afterword: Author(s) of afterword.
annotation: The annotations of this work.
annotator: Author(s) of annotations.
author: List of authors.
bookauthor: List of authors.
bookpagination: The pagination of this work.
booksubtitle: Subtitle of book.
booktitle: Title of book.
booktitleaddon: Addon title of book.
chapter: Chapter number.
commentator: Author(s) of commentary.
date: The publication date
doi: The DOI itself, such as 10.1234/5a6b-7c8d.
edition: Edition or issue
editor: List of editors.
editora: List of editors.
editorb: List of editors.
editorc: List of editors.
eid: Electronic identifier of an article
eprint: Electronic identifier of an online publication
eprintclass: Additional information to an online publication.
eprinttype: Eprint identifier type.
eventdate: Event date of reference.
eventtitle: Event title of reference.
foreword: Author(s) of foreword.
holder: Holder of patent.
howpublished: Non-standard publication details.
institution: University or similar.
introduction: Author(s) of introduction.
isbn: International Standard Book Number.
isrn: International Standard Technical Report Number.
issn: International Standard Serial Number.
issue: Non-number issue of journal.
issuesubtitle: The subtitle of the issue.
issuetitle: The title of the issue.
journalsubtitle: The subtitle of the journal.
journaltitle: The title of the journal.
keywords: Keywords
language: The language of this work.
langid: The language of bibliography / citation.
location: Location or address, where published.
mainsubtitle: Subtitle of multi-volume book.
maintitle: Title of multi-volume book.
maintitleaddon: Addon to title of multi-volume book.
note: Notes
number: Numbered issue of journal or book in series.
organization: Manual/website publisher or event sponsor
origdate: Publication date of the original work.
origlanguage: The language of the original work.
origlocation: Location or address, where originally published.
origpublisher: Original publisher(s).
origtitle: The title of the original work.
pages: The number of pages of the work/article, e.g. 4, 46-53
pagetotal: Total number of pages.
pagination: The pagination of this work.
part: Number of physical part of logical volume
publisher: Publisher(s).
pubstate: The state of this work, e.g. submitted.
series: Name of series
shorttitle: The abridged or short title of this work.
subtitle: Subtitle of work.
title: Title of work.
titleaddon: Addon title of work.
translator: Translator(s) of (work)title.
type: Addon title of work.
url: The public URL for this publication or where it will be available if it has not yet been published.
urldate: Access date to the url.
venue: Venue of event.
version: Version of this work
volume: Volume of journal or multi-volume book.
volumes: Number of volumes for multi-volume work.
externalIds: External ids, e.g. open alex, open citations, wikidata.