| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Drasil.Generator.Formats
Description
Defines output formats for the different documents we can generate.
Synopsis
- data DocType
- data DocSpec = DocSpec DocChoices Filename
- data DocChoices = DC {}
- data DocClass = DocClass (Maybe String) String
- newtype UsePackages = UsePackages [String]
- data ExDoc = ExDoc (Maybe String) String
- type Filename = String
- docChoices :: DocType -> [Format] -> DocChoices
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.
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.
newtype UsePackages Source #
LaTeX helper for adding packages. Wraps a list of package names.
Constructors
| UsePackages [String] |
type Filename = String Source #
When choosing your document, you must specify the filename for the generated output (specified without a file extension).
Constructors
docChoices :: DocType -> [Format] -> DocChoices Source #
Constructor for users to choose their document options