Suggestion Inline
Abstract base type for nodes that indicate a suggested change to inline content.
Properties
The SuggestionInline type has these properties:
| Name | Description | Type | Inherited from | JSON-LD @id |
Aliases |
|---|---|---|---|---|---|
id |
The identifier for this item. | String |
Entity |
schema:id |
- |
suggestionStatus |
The status of the suggestion including whether it is the original, or is accepted, or rejected. | SuggestionStatus |
Suggestion |
stencila:suggestionStatus |
suggestion-status, suggestion_status |
authors |
The authors of the suggestion | Author* |
Suggestion |
schema:author |
author |
provenance |
A summary of the provenance of the content within the suggestion. | ProvenanceCount* |
Suggestion |
stencila:provenance |
- |
executionDuration |
Time taken to generate the suggestion. | Duration |
Suggestion |
stencila:executionDuration |
execution-duration, execution_duration |
executionEnded |
The timestamp when the generation ended. | Timestamp |
Suggestion |
stencila:executionEnded |
execution-ended, execution_ended |
feedback |
Feedback on the suggestion | String |
Suggestion |
stencila:feedback |
- |
content |
The content that is suggested to be inserted, modified, replaced, or deleted. | Inline* |
- | stencila:content |
- |
Related
The SuggestionInline type is related to these types:
- Parents:
Suggestion - Children: none
Formats
The SuggestionInline 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 SuggestionInline type is represented in:
- JSON-LD
- JSON Schema
- Python class
SuggestionInline - Rust struct
SuggestionInline - TypeScript class
SuggestionInline
Source
This documentation was generated from SuggestionInline.yaml by docs_types.rs.