Home

File

This is a representation used in Stencila Schema for a file in the local or accessible file system.

It extends CreativeWork so files can participate in the same metadata-rich document model as other works, while also carrying file-oriented information needed for includes, references, and workflow operations. It is used where the file itself is part of the document graph, not just a string path.

Key properties include file path and media metadata, together with inherited identifiers and descriptive fields from CreativeWork.

Analogues

The following external types, elements, or nodes are similar to a File:

  • POSIX file: Close filesystem analogue for a file as a concrete resource addressed by path.

  • schema.org MediaObject: Approximate web-metadata analogue when the file is also a media resource, though Stencila File is filesystem-oriented rather than URL-oriented.

Properties

The File type has these properties:

NameDescriptionTypeInherited from
nameThe name of the file.String-
pathThe path (absolute or relative) of the file on the file systemString-
mediaTypeIANA media type (MIME type).String-
transferEncodingThe encoding used for the context (e.g. base64, gz)String-
sizeThe size of the content in bytesUnsignedInteger-
contentThe content of the file.String-
workTypeThe type of CreativeWork (e.g. article, book, software application).CreativeWorkTypeCreativeWork
doiThe work's Digital Object Identifier (https://doi.org/).StringCreativeWork
aboutThe subject matter of the content.ThingVariant*CreativeWork
abstractA short description that summarizes a CreativeWork.Block*CreativeWork
authorsThe authors of the CreativeWork.Author*CreativeWork
provenanceA summary of the provenance of the content within the work.ProvenanceCount*CreativeWork
contributorsA secondary contributor to the CreativeWork.Author*CreativeWork
editorsPeople who edited the CreativeWork.Person*CreativeWork
maintainersThe maintainers of the CreativeWork.(Person | Organization)*CreativeWork
commentsComments about this creative work.Comment*CreativeWork
dateCreatedDate/time of creation.DateTimeCreativeWork
dateReceivedDate/time that work was received.DateTimeCreativeWork
dateAcceptedDate/time of acceptance.DateTimeCreativeWork
dateModifiedDate/time of most recent modification.DateTimeCreativeWork
datePublishedDate of first publication.DateTimeCreativeWork
fundersPeople or organizations that funded the CreativeWork.(Person | Organization)*CreativeWork
fundedByGrants that funded the CreativeWork; reverse of fundedItems.(Grant | MonetaryGrant)*CreativeWork
genreGenre of the creative work, broadcast channel or group.String*CreativeWork
keywordsKeywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.String*CreativeWork
isPartOfAn item or other CreativeWork that this CreativeWork is a part of.CreativeWorkVariantCreativeWork
licensesLicense documents that applies to this content, typically indicated by URL, but may be a CreativeWork itself.(CreativeWorkVariant | String)*CreativeWork
partsElements of the collection which can be a variety of different elements, such as Articles, Datatables, Tables and more.CreativeWorkVariant*CreativeWork
publisherA publisher of the CreativeWork.Person | OrganizationCreativeWork
bibliographyA bibliography of references which may be cited in the work.BibliographyCreativeWork
referencesReferences to other creative works, such as another publication, web page, scholarly article, etc.Reference*CreativeWork
textThe textual content of this creative work.TextCreativeWork
titleThe title of the creative work.Inline*CreativeWork
repositoryURL of the repository where the un-compiled, human readable source of the work is located.StringCreativeWork
commitThe commit hash (or similar) of the source of the work.StringCreativeWork
worktreeStatusThe status of the source worktree relative to the commit.WorktreeStatusCreativeWork
versionThe version of the creative work.String | NumberCreativeWork
alternateNamesAlternate names (aliases) for the item.String*Thing
descriptionA description of the item.StringThing
identifiersAny kind of identifier for any kind of Thing.(PropertyValue | String)*Thing
imagesImages of the item.ImageObject*Thing
urlThe URL of the item.StringThing
idThe identifier for this item.StringEntity

Related

The File type is related to these types:

Bindings

The File type is represented in:


This documentation was generated from File.yaml by docs_types.rs.

© 2026 Stencila