| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Drasil.Generator
Synopsis
- caseStudyMainSRS :: SmithEtAlSRS -> SRSDecl -> String -> IO ()
- caseStudyMainSRSWCode :: SmithEtAlSRS -> SRSDecl -> String -> Choices -> IO ()
- caseStudyMainSRSWCodeZooWLsnPlan :: SmithEtAlSRS -> SRSDecl -> String -> [Choices] -> LessonPlan -> LsnDesc -> String -> IO ()
- caseStudyMainDrasilWebsite :: DrasilWebsite -> IO ()
- genCode :: SmithEtAlSRS -> Choices -> IO FileLayout
- genCodeZoo :: SmithEtAlSRS -> [Choices] -> IO [FileLayout]
- codedDirName :: String -> Choices -> String
- withCommonKnowledge :: [Reference] -> [DefinedQuantityDict] -> [IdeaDict] -> [ConceptChunk] -> [UnitDefn] -> [DataDefinition] -> [InstanceModel] -> [GenDefn] -> [TheoryModel] -> [ConceptInstance] -> [Citation] -> [LabelledContent] -> ChunkDB
- type Filename = String
- data Format
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`).
Generators
genCode :: SmithEtAlSRS -> Choices -> IO FileLayout Source #
Generate an ICO-style executable software artifact.
genCodeZoo :: SmithEtAlSRS -> [Choices] -> IO [FileLayout] Source #
Internal Functions
codedDirName :: String -> Choices -> String Source #
Find name of folders created for a "zoo" of executable softifacts.
FIXME: This is a hack. The generation phase should emit what artifacts it created.
Common Background Knowledge for Drasil's Science-focused Case Studies
withCommonKnowledge :: [Reference] -> [DefinedQuantityDict] -> [IdeaDict] -> [ConceptChunk] -> [UnitDefn] -> [DataDefinition] -> [InstanceModel] -> [GenDefn] -> [TheoryModel] -> [ConceptInstance] -> [Citation] -> [LabelledContent] -> ChunkDB Source #
Create a ChunkDB containing background knowledge common to all of
Drasil's existing case studies. This means knowledge related to the
SmithEtAl-esque SRS, mathematics, physics, general science, basic software,
and general documentation.