drasil-srs-0.1.26.0: A framework for code and document generation for scientific software - SRS Language SubPackage
Safe HaskellSafe-Inferred
LanguageHaskell2010

Drasil.SRS.ExtractDocDesc

Description

Defines functions to extract certain kinds of information from a document. Mainly used to pull the UIDs of chunks out of Sentences and Exprs.

Synopsis

Documentation

getDocDesc :: DocDesc -> [Sentence] Source #

FIXME: We want all Sentences from a document (not necessarily a document description), so we use this function. But sentencePlate does not include all Sentences! Some only appear when rendering (at least, after mkSections is used on a DocDesc to create `[Section]`).

Extracts Sentences from a document description.

egetDocDesc :: DocDesc -> [ModelExpr] Source #

Extracts expressions from the document description (DocDesc) and default DLPlate.

sentencePlate :: Monoid a => ([Sentence] -> a) -> DLPlate (Constant a) Source #

Creates a Sentence plate.