Reference manual#

For users#

For developers#

The rsm package contains core modules, implementing each of the steps in the file processing pipeline:

nodes

Nodes that make up the manuscript tree.

reader

Input: Path to .rsm file -- Output: file contents.

tsparser

Input: RSM source string -- Output: abstract syntax tree.

transformer

Input: abstract syntax tree -- Output: (transformed) abstract syntax tree.

translator

Input: abstract syntax tree -- Output: HTML body.

builder

Input: HTML body -- Output: WebManuscript.

writer

Input: WebManuscript -- Output: None (writes to disk).

And user-facing modules, which use the modules above to actually process a file:

app

Applications that execute the steps of the RSM file processing pipeline.

cli

RSM command line utilities.

rsmlogger

Configure the logging module for RSM apps.