Section
A section of a document.
Properties
The Section
type has these properties:
Name | Description | Type | Inherited from | JSON-LD @id |
Aliases |
---|---|---|---|---|---|
id |
The identifier for this item. | String |
Entity |
schema:id |
- |
content |
The content within the section. | Block * |
- | stencila:content |
- |
sectionType |
The type of section. | SectionType |
- | stencila:sectionType |
section-type , section_type |
authors |
The authors of the section. | Author * |
- | schema:author |
author |
provenance |
A summary of the provenance of the content within the section. | ProvenanceCount * |
- | stencila:provenance |
- |
Related
The Section
type is related to these types:
- Parents:
Entity
- Children: none
Formats
The Section
type can be encoded (serialized) to, and/or decoded (deserialized) from, these formats:
Format | Encoding | Decoding | Support | Notes |
---|---|---|---|---|
DOM HTML | 🟢 No loss | |||
HTML | 🟢 No loss | Encoded as <section> using special function |
||
JATS | 🟢 No loss | 🟢 No loss | Encoded as <sec> |
|
Markdown | 🟢 No loss | 🟢 No loss | Encoded using implemented function | |
Stencila Markdown | 🟢 No loss | 🟢 No loss | ||
Quarto Markdown | 🟢 No loss | 🟢 No loss | ||
MyST Markdown | 🟢 No loss | 🟢 No loss | ||
LLM Markdown | 🟢 No loss | 🟢 No loss | ||
LaTeX | 🔷 Low loss | 🔷 Low loss | ||
🔷 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 | ||||
Stencila Web Bundle | ||||
Debug | 🔷 Low loss |
Bindings
The Section
type is represented in:
- JSON-LD
- JSON Schema
- Python class
Section
- Rust struct
Section
- TypeScript class
Section
Testing
During property-based (a.k.a generative) testing, the properties of the Section
type are generated using the following strategies for each complexity level. Any optional properties that are not in this table are set to None
.
Property | Complexity | Description | Strategy |
---|---|---|---|
content |
Min+ | An empty vector | Vec::new() |
Low+ | Generate an arbitrary heading and an arbitrary paragraph. | vec_heading_paragraph() |
|
High+ | Generate up to four arbitrary, non-recursive, block nodes. | vec_blocks_non_recursive(4) |
|
Max | Generate up to eight arbitrary, non-recursive, block nodes. | vec_blocks_non_recursive(8) |
|
sectionType |
Min+ | No type. | None |
Low+ | Generate an arbitrary section type. | option::of(SectionType::arbitrary()) |
Source
This documentation was generated from Section.yaml
by docs_types.rs
.