Safe Haskell	None
Language	GHC2024

Drasil.LessonPlan

Synopsis

Documentation

An abstract "lesson plan."

Please refer to Ting-Yu's thesis for more information.

Instances details

HasSystemMeta LessonPlan Source #
Instance details Defined in Drasil.LessonPlan.Core Methods systemMeta :: Lens' LessonPlan SystemMeta # authors :: Lens' LessonPlan People # background :: Lens' LessonPlan Background # motivation :: Lens' LessonPlan Motivation # projName :: Lens' LessonPlan ProjectName # purpose :: Lens' LessonPlan Purpose # scope :: Lens' LessonPlan Scope # systemdb :: Lens' LessonPlan ChunkDB #
HasProjectName LessonPlan Source #
Instance details Defined in Drasil.LessonPlan.Core Methods projectName :: Lens' LessonPlan ProjectName # projAbrv :: Lens' LessonPlan String # projRepoName :: Lens' LessonPlan String # projTitle :: Lens' LessonPlan NP #
ToFiles LessonPlan JupyterGenOptions Source #
Instance details Defined in Drasil.LessonPlan.JupyterGenerator Methods toFiles :: LessonPlan -> JupyterGenOptions -> [FileLayout] #

Build a LessonPlan.

Constructors

Single-file-generating Jupyter notebook rendering options.

Constructors

JupyterGenOptions
Fields lsnDesc :: LsnDesc Describe the organization of the final lesson plan. titleComb :: Sentence -> Sentence -> Sentence A title combinator that mixes `Notebook` (passed as the first argument) with the title of the `LessonPlan`. To be used as the actual title used in the final generated document. fileName :: String The name of the file to be outputted (no extension, `.ipynb` is added later).

Instances details

ToFiles LessonPlan JupyterGenOptions Source #
Instance details Defined in Drasil.LessonPlan.JupyterGenerator Methods toFiles :: LessonPlan -> JupyterGenOptions -> [FileLayout] #