Expand description
The document value adapters.
The canonical document value is sim_codec_doc::MarkupDoc. The helpers in
this module keep the article-shaped constructor names as compatibility
wrappers while the lenses read and write the shared markup frontend.
Constants§
- ARTICLE_
CLASS - The article class symbol carried in the document’s
classfield. - BLOCK_
KEY - The key that tags a block with its kind.
Functions§
- article
- Build an article document from a title and an ordered list of blocks.
- article_
from_ markup - Build a canonical article document from a markup document.
- block_
kind - The kind of a block (the
blocktag), if present. - blocks
- The article’s ordered blocks.
- citation
- A citation block.
- embed_
block - An embedded-runtime block: a runtime
valuerendered bylensinside the article. Cached output (a precomputed Scene) may be attached later. - equation
- An equation block carrying its source (for example TeX).
- field
- Look up an unqualified-keyed field by name.
- figure
- A figure block.
- markup_
from_ article - Convert a canonical or compatibility article expression into markup.
- prose
- A prose paragraph block.
- section
- A section heading block.
- table
- A table block from rows of cell values.
- title
- The article title.