Safe Haskell	Safe-Inferred
Language	Haskell2010

Drasil.DocumentLanguage.Definitions

Contents

Types
Constructors
Helpers

Description

Defines helper functions for creating subsections within the Solution Characteristics Specification. Namely, for theory models, general definitions, data definitions, and instance models.

Synopsis

data Field
- = Label
- | Symbol
- | Units
- | DefiningEquation
- | Description Verbosity InclUnits
- | Input
- | Output
- | InConstraints
- | OutConstraints
- | Notes
- | Source
- | RefBy
type Fields = [Field]
data InclUnits
- = IncludeUnits
- | IgnoreUnits
data Verbosity
- = Verbose
- | Succinct
ddefn :: Fields -> SystemInformation -> DataDefinition -> LabelledContent
derivation :: (MayHaveDerivation c, HasShortName c, Referable c) => c -> Maybe Contents
gdefn :: Fields -> SystemInformation -> GenDefn -> LabelledContent
instanceModel :: Fields -> SystemInformation -> InstanceModel -> LabelledContent
tmodel :: Fields -> SystemInformation -> TheoryModel -> LabelledContent
helperRefs :: HasUID t => t -> SystemInformation -> Sentence
helpToRefField :: UID -> SystemInformation -> Sentence

Types

data Field Source #

Fields that should be displayed in definitions.

Constructors

Label
Symbol
Units
DefiningEquation
Description Verbosity InclUnits
Input
Output
InConstraints
OutConstraints
Notes
Source
RefBy

Instances

Instances details

Show Field Source #	Defines `Field`s as `Space`s.
Instance details Defined in Drasil.DocumentLanguage.Definitions Methods showsPrec :: Int -> Field -> ShowS # show :: Field -> String # showList :: [Field] -> ShowS #

type Fields = [Field] Source #

Synonym for a list of Fields.

data InclUnits Source #

Determines whether to include or ignore units.

Constructors

IncludeUnits	In description field (for other symbols).
IgnoreUnits

data Verbosity Source #

Refers to the verbosity of statements.

Constructors

Verbose	Full Descriptions.
Succinct	Simple Description (do not redefine other symbols).

Constructors

ddefn :: Fields -> SystemInformation -> DataDefinition -> LabelledContent Source #

Create a data definition using a list of fields, a database of symbols, and a QDefinition (called automatically by SCSSub program).

derivation :: (MayHaveDerivation c, HasShortName c, Referable c) => c -> Maybe Contents Source #

Create a derivation from a chunk's attributes. This follows the TM, DD, GD, or IM definition automatically (called automatically by SCSSub program).

gdefn :: Fields -> SystemInformation -> GenDefn -> LabelledContent Source #

Create a general definition using a list of fields, database of symbols, and a GenDefn (general definition) chunk (called automatically by SCSSub program).

instanceModel :: Fields -> SystemInformation -> InstanceModel -> LabelledContent Source #

Create an instance model using a list of fields, database of symbols, and an InstanceModel chunk (called automatically by SCSSub program).

tmodel :: Fields -> SystemInformation -> TheoryModel -> LabelledContent Source #

Create a theoretical model using a list of fields to be displayed, a database of symbols, and a RelationConcept (called automatically by SCSSub program).

Helpers

helperRefs :: HasUID t => t -> SystemInformation -> Sentence Source #

Helper function to make a list of Sentences from the current system information and something that has a UID.

helpToRefField :: UID -> SystemInformation -> Sentence Source #

Creates a reference as a Sentence by finding if the UID is in one of the possible data sets contained in the SystemInformation database.