Walkthrough Step
A step in a walkthrough.
This type is marked as unstable and is subject to change.
Properties
The WalkthroughStep type has these properties:
| Name | Description | Type | Inherited from | JSON-LD @id |
Aliases |
|---|---|---|---|---|---|
id |
The identifier for this item. | String |
Entity |
schema:id |
- |
isCollapsed |
Whether this step is active (i.e. is encoded in source format and can be edited) | Boolean |
- | stencila:isCollapsed |
is-collapsed, is_collapsed |
content |
The content of the step. | Block* |
- | stencila:content |
- |
Related
The WalkthroughStep type is related to these types:
- Parents:
Entity - Children: none
Formats
The WalkthroughStep 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 | Encoded using implemented function | ||
| Stencila Markdown | ⚠️ High loss | |||
| Quarto Markdown | ⚠️ High loss | |||
| MyST Markdown | ⚠️ High loss | |||
| LLM Markdown | ⚠️ High 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 WalkthroughStep type is represented in:
- JSON-LD
- JSON Schema
- Python class
WalkthroughStep - Rust struct
WalkthroughStep - TypeScript class
WalkthroughStep
Source
This documentation was generated from WalkthroughStep.yaml by docs_types.rs.