| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Drasil.Generator
Synopsis
- cdb :: [DefinedQuantityDict] -> [IdeaDict] -> [ConceptChunk] -> [UnitDefn] -> [DataDefinition] -> [InstanceModel] -> [GenDefn] -> [TheoryModel] -> [ConceptInstance] -> [LabelledContent] -> [Reference] -> [Citation] -> ChunkDB
- dumpEverything :: System -> PrintingInformation -> Path -> IO ()
- gen :: DocSpec -> Document -> PrintingInformation -> IO ()
- genDot :: System -> IO ()
- genCode :: Choices -> CodeSpec -> IO ()
- data DocType
- data DocSpec = DocSpec DocChoices Filename
- data DocChoices = DC DocType [Format]
- data Format
- docChoices :: DocType -> [Format] -> DocChoices
- typeCheckSI :: System -> IO ()
Base ChunkDB for all case studies
cdb :: [DefinedQuantityDict] -> [IdeaDict] -> [ConceptChunk] -> [UnitDefn] -> [DataDefinition] -> [InstanceModel] -> [GenDefn] -> [TheoryModel] -> [ConceptInstance] -> [LabelledContent] -> [Reference] -> [Citation] -> ChunkDB Source #
Tools for dumping a chunk database to disk for debugging
dumpEverything :: System -> PrintingInformation -> 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.
Generator Functions
gen :: DocSpec -> Document -> PrintingInformation -> IO () Source #
Generate a number of artifacts based on a list of recipes.
Types (Printing Options)
Document types include Software Requirements Specification and Website. Choosing SRS will generate both TeX and HTML files, while Website generates only as HTML. This also determines what folders the generated files will be placed into.
Document specifications. Holds the type of document (DocType) and its name (Filename).
Constructors
| DocSpec DocChoices Filename |
Instances
| RuleTransformer DocSpec Source # | Allows the creation of Makefiles for documents that use LaTeX. |
Defined in Drasil.Generator.Formats | |
data DocChoices Source #
Document choices include the type of document as well as the file formats we want to generate as.
Possible formats for printer output.
Constructor
docChoices :: DocType -> [Format] -> DocChoices Source #
Constructor for users to choose their document options
Type check a Drasil System
typeCheckSI :: System -> IO () Source #