Skip to main content

Module doc

Module doc 

Source
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 class field.
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 block tag), if present.
blocks
The article’s ordered blocks.
citation
A citation block.
embed_block
An embedded-runtime block: a runtime value rendered by lens inside 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.