| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Drasil.Generator
Synopsis
- dumpEverything :: SmithEtAlSRS -> Path -> IO ()
- exportCode :: SmithEtAlSRS -> Choices -> IO ()
- exportCodeZoo :: SmithEtAlSRS -> [Choices] -> IO ()
- codedDirName :: String -> Choices -> String
- withCommonKnowledge :: [Reference] -> [DefinedQuantityDict] -> [IdeaDict] -> [ConceptChunk] -> [UnitDefn] -> [DataDefinition] -> [InstanceModel] -> [GenDefn] -> [TheoryModel] -> [ConceptInstance] -> [Citation] -> [LabelledContent] -> ChunkDB
- exportSmithEtAlSrsWCode :: SmithEtAlSRS -> SRSDecl -> String -> Choices -> IO ()
- exportSmithEtAlSrsWCodeZoo :: SmithEtAlSRS -> SRSDecl -> String -> [Choices] -> IO ()
- data DocSpec = DocSpec Format Filename
- type Filename = String
- data Format
- buildMakefile :: DocSpec -> Maybe Makefile
- exportLessonPlan :: LessonPlan -> LsnDesc -> String -> IO ()
- exportSmithEtAlSrs :: SmithEtAlSRS -> SRSDecl -> String -> IO ()
- typeCheckSI :: SmithEtAlSRS -> IO ()
- exportWebsite :: DrasilWebsite -> Document -> Filename -> IO ()
Tools for dumping a chunk database to disk for debugging
dumpEverything :: SmithEtAlSRS -> Path -> IO () Source #
For debugging purposes, if the system has a DEBUG_ENV environment
variable set to anything, we can dump the chunk maps in a system to the host
system.
Generators
exportCode :: SmithEtAlSRS -> Choices -> IO () Source #
Generate an ICO-style executable software artifact.
exportCodeZoo :: SmithEtAlSRS -> [Choices] -> IO () Source #
Internal: Generate a zoo of ICO-style executable softifact.
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.
Generators
exportSmithEtAlSrsWCode :: SmithEtAlSRS -> SRSDecl -> String -> Choices -> IO () Source #
Generate an SRS softifact with a specific solution softifact.
exportSmithEtAlSrsWCodeZoo :: SmithEtAlSRS -> SRSDecl -> String -> [Choices] -> IO () Source #
Generate an SRS softifact with a zoo of solution softifacts.
Types (Printing Options)
Document specifications. Holds the type of document (DocType) and its name (Filename).
type Filename = String Source #
When choosing your document, you must specify the filename for the generated output (specified without a file extension).
Possible formats for printer output.
Rules
exportLessonPlan :: LessonPlan -> LsnDesc -> String -> IO () Source #
Generate an interactive JupyterNotebook-based lesson plan.
Generators
exportSmithEtAlSrs :: SmithEtAlSRS -> SRSDecl -> String -> IO () Source #
Generate an SRS softifact.
Type check a Drasil System
typeCheckSI :: SmithEtAlSRS -> IO () Source #
exportWebsite :: DrasilWebsite -> Document -> Filename -> IO () Source #
Generate a "website" (an HTML file with a CSS stylesheet) softifact.