Previously this type extended Collection (which in turn extends CreativeWork). However, to avoid consuming more memory that necessary when creating directory listings with many directories, it now extends Entity.

Properties

The Directory type has these properties:

Name	Description	Type	Inherited from	JSON-LD @id	Aliases
id	The identifier for this item.	String	Entity	schema:id	-
name	The name of the directory.	String	-	schema:name	-
path	The path (absolute or relative) of the file on the file system.	String	-	stencila:path	-
parts	The files and other directories within this directory.	(File | Directory)*	-	schema:hasParts	hasParts, part

Related

The Directory type is related to these types:

• Parents: Entity
• Children: none

Formats

The Directory type can be encoded (serialized) to, and/or decoded (deserialized) from, these formats:

Format	Encoding	Decoding	Support	Notes
DOM HTML	🟢 No loss
HTML	🔷 Low loss
JATS
Markdown	⚠️ High loss
Stencila Markdown	⚠️ High loss
Quarto Markdown	⚠️ High loss
MyST Markdown	⚠️ High loss
LLM Markdown	⚠️ High loss
LaTeX	🔷 Low loss	🔷 Low loss
PDF	🔷 Low loss
Plain text	⚠️ High loss
IPYNB	🔷 Low loss	🔷 Low loss
Microsoft Word DOCX	🔷 Low loss	🔷 Low loss
OpenDocument ODT	🔷 Low loss	🔷 Low loss
TeX	🔷 Low loss	🔷 Low loss
JSON	🟢 No loss	🟢 No loss
JSON+Zip	🟢 No loss	🟢 No loss
JSON5	🟢 No loss	🟢 No loss
JSON-LD	🟢 No loss	🟢 No loss
CBOR	🟢 No loss	🟢 No loss
CBOR+Zstandard	🟢 No loss	🟢 No loss
YAML	🟢 No loss	🟢 No loss
Lexical JSON	🔷 Low loss	🔷 Low loss
Koenig JSON	🔷 Low loss	🔷 Low loss
Pandoc AST	🔷 Low loss	🔷 Low loss
Directory		🟢 No loss
Stencila Web Bundle
Debug	🔷 Low loss

Bindings

The Directory type is represented in:

• JSON-LD
• JSON Schema
• Python class Directory
• Rust struct Directory
• TypeScript class Directory

Source

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