Safe Haskell	Safe-Inferred
Language	Haskell2010

Drasil.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

getDocDesc :: DocDesc -> [Sentence]
egetDocDesc :: DocDesc -> [ModelExpr]
sentencePlate :: Monoid a => ([Sentence] -> a) -> DLPlate (Constant a)
getSec :: Section -> [Sentence]
extractDocBib :: SmithEtAlSRS -> [Section] -> BibRef

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.

getSec :: Section -> [Sentence] Source #

Extracts Sentences from a Section.

extractDocBib :: SmithEtAlSRS -> [Section] -> BibRef Source #

Extract bibliography entries from generated sections. This version extracts from fully expanded Sections, capturing citations that are only created during document generation (like those in orgOfDocIntro).