| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Drasil.Generator.CaseStudyVariants
Description
Case study variants.
Each case study is expected to generate files in a specific pattern that the main `code/Makefile` expects for (a) testing and (b) website deployment.
Synopsis
- caseStudyMainSRS :: SmithEtAlSRS -> SRSDecl -> String -> IO ()
- caseStudyMainSRSWCode :: SmithEtAlSRS -> SRSDecl -> String -> Choices -> IO ()
- caseStudyMainSRSWCodeZooWLsnPlan :: SmithEtAlSRS -> SRSDecl -> String -> [Choices] -> LessonPlan -> LsnDesc -> String -> IO ()
- caseStudyMainDrasilWebsite :: DrasilWebsite -> IO ()
Documentation
caseStudyMainSRS :: SmithEtAlSRS -> SRSDecl -> String -> IO () Source #
A case study that only outputs an SRS in each of our supported variants.
caseStudyMainSRSWCode :: SmithEtAlSRS -> SRSDecl -> String -> Choices -> IO () Source #
A case study that outputs both an SRS in each of our supported variants as well as a single chosen software artifact in optionally many programming languages.
caseStudyMainSRSWCodeZooWLsnPlan :: SmithEtAlSRS -> SRSDecl -> String -> [Choices] -> LessonPlan -> LsnDesc -> String -> IO () Source #
The same as caseStudyMainSRSWCode, except it also produces a
JupyterNotebook-based lesson plan.
caseStudyMainDrasilWebsite :: DrasilWebsite -> IO () Source #
The Drasil website binary is expected to build a `WebsiteHTML` folder containing the actual website artifacts (`index.html` and `index.css`).