GitHub Twitter

ScholarlyArticle DRAFT Profile

Version: 0.2-DRAFT-2020_12_03 (07 December 2020)

Bioschemas profile, based on Biotea model, describing a ScholarlyArticle in Life Sciences.


If you spot any errors or omissions with this type, please file an issue in our GitHub.


Contributors

The following people have been involved in the creation of this specification document. They are all members of the Scholarly Publications group.

Group Leader(s)
Other team members

Schema.org hierarchy

This Profile fits into the schema.org hierarchy as follows:

Thing > CreativeWork > Article > ScholarlyArticle

Description

A ScholarlyArticle is an article commonly reporting a scientific research, for instance a journal article or thesis. DOI is recommended as official idnetifier (e.g., "@id" in JSON-LD)

Summary of Changes

Changes since previous draft 0.1 of the ScholarlyArticle profile:
  • Add examples
  • Updates identifier property to MANY so multiple identifiers can be included
  • Uses name for the title (as per schema.org examples) and keeps headline (optional) for compatibility purposes
  • Simplifies the profile by removing alternateName and alternativeHeadline as they are not commonly used
  • Changes sameAs so it is used only for machine-readable representations
  • Changes url so it is used for any (MANY) web page displaying this article
  • Changes about to link to SemanticTextAnnotation (rather than SemanticAnnotation as only those based on text are currently supported)
  • Uses abstract rather than backstory to store the article abstract
  • Simplifies the profile by removing copyrightHolder and copyrightYear are they are not commonly used
  • Adds correction so it is possible to link to corrections of this article
  • Adds editor and funder
  • Changes isAccessibleForFree to optional as license is more common and has more information
  • Changes isBasedOn to optional as it is not that common
  • Changes keywords to MANY as DefinedTerm and URL would require them to be separated in a list rather by only commas
  • Adds publisher as recommended (mandatory for Google Structured Data)
  • Removes version
  • Removes article section as it referes to sports, culture and so in a magazine
  • Makes pageStart and pageEnd optional
  • Removes wordCount as not that common
  • Double checks the property range as some has been updated in schema.org
  • Changes prepared by L. Garcia

Latest profiles

Latest release: none

Latest draft: 0.2-DRAFT-2020_12_03

Previous profiles

Previous version: 0.1-DRAFT-2019_03_15


Group Use Cases Cross Walk Task & Issues Examples Live Deploys
Scholarly Publications

You can read the release version of this specification here.


Key to specification table
  • Green properties/types are proposed by Bioschemas, or indicate proposed changes by Bioschemas to Schema.org
  • Red properties/types exist in the core of Schema.org
  • Blue properties/types exist in the pending area of Schema.org
  • Black properties/types are reused from external vocabularies/ontologies

CD = Cardinality

View all examples
Property Expected Type Description CD Controlled Vocabulary Example
Marginality: Minimum.
identifier PropertyValue
Text
URL
Schema:

The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.


Bioschemas:

A global a unique identifier for scholarly articles such as DOI. Others such as PMID and PMC are also possible. Use the namespace:id format e.g. doi, pmid and pmc . Follow community recommendations for the namespace

MANY
View ≪identifier≫ example
name Text
Schema:

The name of the item.


Bioschemas:

Title of the article as per schema.org examples (headline is also offered as optional for compatibility purposes)

ONE
View ≪name≫ example
Marginality: Recommended.
abstract Text
Schema:

An abstract is a short description that summarizes a CreativeWork.


ONE
View ≪abstract≫ example
author Organization
Person
Schema:

The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.


MANY
View ≪author≫ example
citation CreativeWork
Text
Schema:

A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.


MANY
View ≪citation≫ example
dateCreated Date
DateTime
Schema:

The date on which the CreativeWork was created or the item was added to a DataFeed.


ONE
dateModified Date
DateTime
Schema:

The date on which the CreativeWork was most recently modified or when the item’s entry was modified within a DataFeed.


MANY
datePublished Date
Schema:

Date of first broadcast/publication.


ONE
View ≪datePublished≫ example
isPartOf CreativeWork
URL
Periodical
PublicationVolume
PublicationIssue
Schema:

Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. Inverse property: hasPart.


Bioschemas:

We recommend at least to inlcude a link to the most granular possible level, e.g., PublicationIssue if available. It is also possible to use ‘isPartOf’ to directly link to the PublicationVolume or the Journal (i.e. Periodical), making it easier to find links to each other. It can also be part of another type, e.g., Dataset, if needed.

MANY
View ≪isPartOf≫ example
keywords DefinedTerm
Text
URL
Schema:

Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.


MANY
View ≪keywords≫ example
license CreativeWork
URL
Schema:

A license document that applies to this content, typically indicated by URL.


ONE
View ≪license≫ example
publisher Organization
Person
Schema:

The publisher of the creative work.


MANY
url URL
Schema:

URL of the item.


Bioschemas:

DOI if possible and any other available page displaying this article

MANY
View ≪url≫ example
Marginality: Optional.
about Thing
Schema:

The subject matter of the content. Inverse property: subjectOf.


Bioschemas:

SemanticTextAnnotations derived (manually or automatically) from the text of this article

MANY
View ≪about≫ example
articleBody Text
Schema:

The actual body of the article.


Bioschemas:

If included, could be separated in paragraphs or so.

MANY
correction CorrectionComment
Text
URL
Schema:

Indicates a correction to a CreativeWork, either via a CorrectionComment, textually or in another document.


MANY
editor Person
Schema:

Specifies the Person who edited the CreativeWork.


MANY
funder Organization
Person
Schema:

A person or organization that supports (sponsors) something through some kind of financial contribution.


headline Text
Schema:

Headline of the article.


Bioschemas:

Title of the article (offer for compatibility, while schema.org uses name for this purpose, some scholarly material repostitories/archives use headline)

ONE
View ≪headline≫ example
inLanguage Language
Text
Schema:

The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also availableLanguage. Supersedes language.


MANY
View ≪inLanguage≫ example
isAccessibleForFree Boolean
Schema:

A flag to signal that the item, event, or place is accessible for free. Supersedes free.


ONE
View ≪isAccessibleForFree≫ example
isBasedOn CreativeWork
Product
URL
Schema:

A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html. Supersedes isBasedOnUrl.


Bioschemas:

Link to any HTML other than the DOI one as well as to possible web services, such as PMC OAI service, providing machine-readable versions used to create this metadata.

MANY
pageEnd Integer
Text
Schema:

The page on which the work ends; for example “138” or “xvi”.


ONE
pageStart Integer
Text
Schema:

The page on which the work starts; for example “135” or “xiii”.


ONE
pagination Text
Schema:

Any description of pages that is not separated into pageStart and pageEnd; for example, “1-6, 9, 55” or “10-12, 46-49”.


MANY
sameAs URL
Schema:

URL of a reference Web page that unambiguously indicates the item’s identity. E.g. the URL of the item’s Wikipedia page, Wikidata entry, or official website.


Bioschemas:

Any other machine readable description of this article.

MANY

Top ▲