drasil-lang-0.1.60.0: A framework for code and document generation for scientific software - Language SubPackage
Safe HaskellSafe-Inferred
LanguageHaskell2010

Language.Drasil.Derivation

Description

For deriving equations in examples.

Synopsis

Type

data Derivation Source #

Derivations are an ordered list of sentences and expressions. They are rendered in order as paragraphs and equation blocks to display the derivation.

Constructors

Derivation Sentence [Sentence] 

Class

class MayHaveDerivation c where Source #

A class that might have a Derivation.

Methods

derivations :: Lens' c (Maybe Derivation) Source #

Provides a Lens to a possible derivation.

Functions

mkDeriv :: Sentence -> [Sentence] -> Derivation Source #

Smart constructor for creating a Derivation.

mkDerivName :: Sentence -> [Sentence] -> Derivation Source #

Similar to mkDeriv, but prepends "Detailed derivation of" to the header.

mkDerivNoHeader :: [Sentence] -> Derivation Source #

Similar to mkDeriv, but without a header Sentence.