Codemeta Terms

Terms from Schema.org

Recognized properties for CodeMeta Code includes the following terms from https://schema.org. These terms are part of the CodeMeta specification and can be used without any prefix.

Property Type Description
codeRepository URL Link to the repository where the un-compiled, human readable code and related code is located (SVN, github, CodePlex).
programmingLanguage ComputerLanguage or Text The computer programming language.
runtimePlatform Text Runtime platform or script interpreter dependencies (Example - Java v1, Python2.3, .Net Framework 3.0). Supersedes runtime.
targetProduct SoftwareApplication Target Operating System / Product to which the code applies. If applies to several versions, just the product name can be used.
applicationCategory Text or URL Type of software application, e.g. ‘Game, Multimedia’.
applicationSubCategory Text or URL Subcategory of the application, e.g. ‘Arcade Game’.
downloadUrl URL If the file can be downloaded, URL to download the binary.
fileSize Text Size of the application / package (e.g. 18MB). In the absence of a unit (MB, KB etc.), KB will be assumed.
installUrl URL URL at which the app may be installed, if different from the URL of the item.
memoryRequirements Text or URL Minimum memory requirements.
operatingSystem Text Operating systems supported (Windows 7, OSX 10.6, Android 1.6).
permissions Text Permission(s) required to run the app (for example, a mobile app may require full internet access or may run only on wifi).
processorRequirements Text Processor architecture required to run the application (e.g. IA64).
releaseNotes Text or URL Description of what changed in this version.
softwareHelp CreativeWork Software application help.
softwareRequirements SoftwareSourceCode Required software dependencies
softwareVersion Text Version of the software instance.
storageRequirements Text or URL Storage requirements (free space required).
supportingData DataFeed Supporting data for a SoftwareApplication.
author Organization or Person 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.
citation CreativeWork or URL A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
contributor Organization or Person A secondary contributor to the CreativeWork or Event.
copyrightHolder Organization or Person The party holding the legal copyright to the CreativeWork.
copyrightYear Number The year during which the claimed copyright for the CreativeWork was first asserted.
creator Organization or Person The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
dateCreated Date or DateTime The date on which the CreativeWork was created or the item was added to a DataFeed.
dateModified Date or DateTime The date on which the CreativeWork was most recently modified or when the item’s entry was modified within a DataFeed.
datePublished Date Date of first broadcast/publication.
editor Person Specifies the Person who edited the CreativeWork.
encoding MediaObject A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. Supersedes encodings.
fileFormat Text or URL Media type, typically MIME format (see IANA site) of the content e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, ‘encoding’ can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
funder Organization or Person A person or organization that supports (sponsors) something through some kind of financial contribution.
keywords Text Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.
license CreativeWork or URL A license document that applies to this content, typically indicated by URL.
producer Organization or Person The person or organization who produced the work (e.g. music album, movie, tv/radio series etc.).
provider Organization or Person The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. Supersedes carrier.
publisher Organization or Person The publisher of the creative work.
sponsor Organization or Person A person or organization that supports a thing through a pledge, promise, or financial contribution. e.g. a sponsor of a Medical Study or a corporate sponsor of an event.
version Number or Text The version of the CreativeWork embodied by a specified resource.
isAccessibleForFree Boolean A flag to signal that the publication is accessible for free.
isPartOf CreativeWork Indicates a CreativeWork that this CreativeWork is (in some sense) part of. Reverse property hasPart
hasPart CreativeWork Indicates a CreativeWork that is (in some sense) a part of this CreativeWork. Reverse property isPartOf
position Integer or Text The position of an item in a series or sequence of items. (While schema.org considers this a property of CreativeWork, it is also the way to indicate ordering in any list (e.g. the Authors list). By default arrays are unordered in JSON-LD
description Text A description of the item.
identifier PropertyValue or URL 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.
name Text The name of the item (software, Organization)
sameAs URL 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.
url URL URL of the item.
relatedLink URL A link related to this object, e.g. related web pages
givenName Text Given name. In the U.S., the first name of a Person. This can be used along with familyName instead of the name property
familyName Text Family name. In the U.S., the last name of an Person. This can be used along with givenName instead of the name property.
email Text Email address
affiliation Text An organization that this person is affiliated with. For example, a school/university
identifier URL URL identifer, ideally an ORCID ID for individuals, a FundRef ID for funders
name Text The name of an Organization, or if separate given and family names cannot be resolved for a Person
address PostalAddress or Text Physical address of the item.

These terms are all recognized properties of https://schema.org/SoftwareSourceCode or https://schema.org/SoftwareApplication Types. Note that while most properties take basic data types as values (Text, URL), several take other node types, such as Person or Organization. Recommended fields for these node types in CodeMeta documents are given below.

Codemeta terms

The CodeMeta project also introduces the following additional properties, which lack clear equivalents in https://schema.org but can play an important role in software metadata records covered by the CodeMeta crosswalk.

Property Type Description
softwareSuggestions SoftwareSourceCode Optional dependencies , e.g. for optional features, code development, etc
maintainer Person Individual responsible for maintaining the software (usually includes an email contact address)
contIntegration URL link to continuous integration service
buildInstructions URL link to installation instructions/documentation
developmentStatus Text Description of development status, e.g. Active, inactive, supsended. See repostatus.org
embargoDate Date Software may be embargoed from public access until a specified date (e.g. pending publication, 1 year from publication)
funding Text Funding source (e.g. specific grant)
issueTracker URL link to software bug reporting or issue tracking system
referencePublication ScholarlyArticle An academic publication related to the software.
readme URL link to software Readme file

Please suggest additional terms or adjustments to this representation in the codmeta issues