Profile of schema:SoftwareSourceCode using properties corresponding to the Software Management Plan use case
Property | Expected Type | Description | Cardinality |
codeRepository | See range for codeRepository in schema.org | Link to the repository where the un-compiled, human readable code and related code is located (SVN, github, CodePlex). | one |
programmingLanguage | See range for programmingLanguage in schema.org | The computer programming language. | many |
version | See range for version in schema.org | The version of the CreativeWork embodied by a specified resource. | one |
description | See range for description in schema.org | A description of the item. | one |
name | See range for name in schema.org | The name of the item. | one |
url | See range for url in schema.org | URL of the item. | one |
Property | Expected Type | Description | Cardinality |
maSMP:versionControlSystem | SoftwareApplication | Version control system used for this source code, to keep track of all commits, branches and so. | one |
targetProduct | See range for targetProduct in schema.org | Target Operating System / Product to which the code applies. If applies to several versions, just the product name can be used. | many |
archivedAt | See range for archivedAt in schema.org | Indicates a page or other link involved in archival of a CreativeWork. In the case of MediaReview, the items in a MediaReviewItem may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content. | many |
author | See range for author in schema.org | 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 |
citation | See range for citation in schema.org | A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. | many |
identifier | See range for identifier in schema.org | 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](/docs/datamodel.html#identifierBg) for more details.\n | many |
keywords | See range for keywords in schema.org | Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. | many |
license | See range for license in schema.org | A license document that applies to this content, typically indicated by URL. | one |
sameAs | See range for sameAs in schema.org | 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. | many |
bioschemas:input | bioschemas:FormalParameter | An input required to use the computational workflow (eg. Excel spreadsheet, BAM file). | many |
bioschemas:output | bioschemas:FormalParameter | An output produced by the computational workflow (or software). | many |
codemeta:readme | URL | Link to this software Readme file. Property defined in the Codemeta terms. | one |
maSMP:intendedUse | DefinedTerm or Text or URL | Purpose and intended use of this software. | one |
Property | Expected Type | Description | Cardinality |
codeSampleType | See range for codeSampleType in schema.org | What type of code sample: full (compile ready) solution, code snippet, inline code, scripts, template. | many |
runtimePlatform | Text | Runtime platform or script interpreter dependencies (Example - Java v1, Python2.3, .Net Framework 3.0). | many |
conditionsOfAccess | See range for conditionsOfAccess in schema.org | Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an ArchiveComponent held by an ArchiveOrganization. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". | many |
contributor | See range for contributor in schema.org | A secondary contributor to the CreativeWork or Event. | many |
copyrightHolder | See range for copyrightHolder in schema.org | The party holding the legal copyright to the CreativeWork. | many |
dateModified | See range for dateModified in schema.org | The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed. | one |
datePublished | See range for datePublished in schema.org | Date of first broadcast/publication. | one |
discussionUrl | See range for discussionUrl in schema.org | A link to the page containing the comments of the CreativeWork. | many |
isAccessibleForFree | See range for isAccessibleForFree in schema.org | A flag to signal that the item, event, or place is accessible for free. | one |
maintainer | See range for maintainer in schema.org | A maintainer of a Dataset, software package (SoftwareApplication), or other Project. A maintainer is a Person or Organization that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When maintainer is applied to a specific version of something e.g. a particular version or packaging of a Dataset, it is always possible that the upstream source has a different maintainer. The isBasedOn property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.\n | many |
codemeta:buildInstructions | URL | Link to installation instructions/documentation. | one |
codemeta:issueTracker | URL | Link to software bug reporting or issue tracking system. | one |
codemeta:referencePublication | ScholarlyArticle | An academic publication related to the software. Property defined in the Codemeta terms. | one |
maSMP:developerDocumentation | CreativeWork | Documentation about this software directed to developers who will use or reuse (e.g., extend) this software | many |
maSMP:learningResource | LearningResource | Any LearningResource that can provide orientation towards learning, education, skill acquisition, and other educational purposes about this research software. | many |
maSMP:changelog | URL | Link to CHANGELOG file. | one |
maSMP:testedWith | maSMP:SoftwareTestAction | Testing actions (e.g., continuous integration, end-to-end, etc.) performed on this software. | many |
maSMP:userDocumentation | CreativeWork | Documentation about this software directed to users who will use this software as it is. | many |
maSMP:deployInstructions | Text or URL | Text or link to deployment instructions/documentation. | many |
maSMP:installInstructions | Text or URL | Text or link to installation instructions/documentation. It should not be confused with the installUrl which points to a place where the installation package (e.g., .exe) can be found. | many |
maSMP:testInstructions | Text or URL | Text or link to testing instructions/documentation. | many |