Safe Haskell	None
Language	Haskell2010

Language.Drasil.Output.Formats

Description

Defines output formats for the different documents we can generate.

Synopsis

type Filename = String
data DocType
- = SRS
- | Website
- | Jupyter
data DocChoices = DC {
- doctype :: DocType
- format :: [Format]
}
data DocSpec = DocSpec DocChoices Filename
data DocClass = DocClass (Maybe String) String
newtype UsePackages = UsePackages [String]
data ExDoc = ExDoc (Maybe String) String

Documentation

type Filename = String Source #

When choosing your document, you must specify the filename for the generated output (specified without a file extension).

data DocType Source #

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

SRS
Website
Jupyter

Instances

Instances details

Show DocType Source #	Shows the different types of documents.
Instance details Defined in Language.Drasil.Output.Formats Methods showsPrec :: Int -> DocType -> ShowS # show :: DocType -> String # showList :: [DocType] -> ShowS #

data DocChoices Source #

Document choices include the type of document as well as the file formats we want to generate as.

Constructors

DC
Fields doctype :: DocType format :: [Format]

data DocSpec Source #

Document specifications. Holds the type of document (DocType) and its name (Filename).

Constructors

DocSpec DocChoices Filename

Instances

Instances details

RuleTransformer DocSpec Source #	Allows the creation of Makefiles for documents that use LaTeX.
Instance details Defined in Language.Drasil.Output.Formats Methods makeRule :: DocSpec -> [Rule] #

data DocClass Source #

LaTeX helper.

Constructors

DocClass (Maybe String) String

newtype UsePackages Source #

LaTeX helper for adding packages. Wraps a list of package names.

Constructors

UsePackages [String]

data ExDoc Source #

LaTeX helper.

Constructors

ExDoc (Maybe String) String