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

Safe Haskell	Safe-Inferred
Language	Haskell2010

Drasil.DocumentLanguage.Notebook

Description

Document language for lesson plan notebooks.

Synopsis

mkNb :: LsnDesc -> (IdeaDict -> CI -> Sentence) -> System -> Document
type LsnDesc = [LsnChapter]
data LsnChapter
- = Intro Intro
- | LearnObj LearnObj
- | Review Review
- | CaseProb CaseProb
- | Example Example
- | Smmry Smmry
- | BibSec
- | Apndx Apndx
newtype LearnObj = LrnObjProg [Contents]
newtype Review = ReviewProg [Contents]
newtype CaseProb = CaseProbProg [Contents]
newtype Example = ExampleProg [Contents]

Documentation

mkNb :: LsnDesc -> (IdeaDict -> CI -> Sentence) -> System -> Document Source #

Creates a notebook from a lesson description and system information.

type LsnDesc = [LsnChapter] Source #

data LsnChapter Source #

Constructors

Intro Intro
LearnObj LearnObj
Review Review
CaseProb CaseProb
Example Example
Smmry Smmry
BibSec
Apndx Apndx

newtype LearnObj Source #

Constructors

LrnObjProg [Contents]

newtype Review Source #

Constructors

ReviewProg [Contents]

newtype CaseProb Source #

Constructors

CaseProbProg [Contents]

newtype Example Source #

Constructors

ExampleProg [Contents]