drasil-docLang-0.1.26.0: A framework for code and document generation for scientific software - Document Language SubPackage

Safe Haskell	None
Language	Haskell2010

Drasil.DocumentLanguage.Notebook.Core

Contents

Section Types
Multiplate Definition and Type

Description

Lesson plan notebook section types.

Synopsis

type NBDesc = [DocSection]
data DocSection
- = IntrodSec IntrodSec
- | BodySec BodySec
- | SmmrySec SmmrySec
- | BibSec
- | ApndxSec ApndxSec
data IntrodSec = IntrodProg [Contents] [IntrodSub]
data IntrodSub where
- InPurpose :: [Sentence] -> IntrodSub
newtype BodySec = BodyProg [BodySub]
data BodySub where
- Review :: [Contents] -> BodySub
- MainIdea :: [Contents] -> [Section] -> BodySub
- MethsAndAnls :: [Contents] -> [Section] -> BodySub
- Example :: [Contents] -> [Section] -> BodySub
newtype SmmrySec = SmmryProg [Contents]
newtype ApndxSec = ApndxProg [Contents]
data DLPlate f = DLPlate {
- docSec :: DocSection -> f DocSection
- introdSec :: IntrodSec -> f IntrodSec
- introdSub :: IntrodSub -> f IntrodSub
- bodySec :: BodySec -> f BodySec
- bodySub :: BodySub -> f BodySub
- smmrySec :: SmmrySec -> f SmmrySec
- apendSec :: ApndxSec -> f ApndxSec
}

Section Types

type NBDesc = [DocSection] Source #

data DocSection Source #

Constructors

IntrodSec IntrodSec
BodySec BodySec
SmmrySec SmmrySec
BibSec
ApndxSec ApndxSec

Introduction Section

data IntrodSec Source #

Introduction section. Contents are top level followed by a list of subsections.

Constructors

IntrodProg [Contents] [IntrodSub]

data IntrodSub where Source #

Introduction subsections

Constructors

InPurpose :: [Sentence] -> IntrodSub

Body Section

newtype BodySec Source #

Constructors

BodyProg [BodySub]

data BodySub where Source #

Constructors

Review :: [Contents] -> BodySub
MainIdea :: [Contents] -> [Section] -> BodySub
MethsAndAnls :: [Contents] -> [Section] -> BodySub
Example :: [Contents] -> [Section] -> BodySub

Summary Section

newtype SmmrySec Source #

Constructors

SmmryProg [Contents]

Appendix Section

newtype ApndxSec Source #

Constructors

ApndxProg [Contents]

Multiplate Definition and Type

data DLPlate f Source #

Constructors

DLPlate
Fields docSec :: DocSection -> f DocSection introdSec :: IntrodSec -> f IntrodSec introdSub :: IntrodSub -> f IntrodSub bodySec :: BodySec -> f BodySec bodySub :: BodySub -> f BodySub smmrySec :: SmmrySec -> f SmmrySec apendSec :: ApndxSec -> f ApndxSec

Instances

Instances details

Multiplate DLPlate Source #
Instance details Defined in Drasil.DocumentLanguage.Notebook.Core Methods multiplate :: forall (f :: Type -> Type). Applicative f => DLPlate f -> DLPlate f mkPlate :: (forall a. Projector DLPlate a -> a -> f a) -> DLPlate f