Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.Sentence

Contents

Types
- Sentence
- Context Types
Functions

Description

Contains Sentences and helpers functions.

Synopsis

data Sentence where
- Ch :: SentenceStyle -> TermCapitalization -> UID -> Sentence
- SyCh :: UID -> Sentence
- Sy :: USymb -> Sentence
- S :: String -> Sentence
- P :: Symbol -> Sentence
- E :: ModelExpr -> Sentence
- Ref :: UID -> Sentence -> RefInfo -> Sentence
- Quote :: Sentence -> Sentence
- Percent :: Sentence
- (:+:) :: Sentence -> Sentence -> Sentence
- EmptyS :: Sentence
data SentenceStyle
- = PluralTerm
- | TermStyle
- | ShortStyle
data RefInfo
- = None
- | Equation [Int]
- | Page [Int]
- | RefNote String
data TermCapitalization
- = CapF
- | CapW
- | NoCap
(+:+) :: Sentence -> Sentence -> Sentence
(+:+.) :: Sentence -> Sentence -> Sentence
(+:) :: Sentence -> Sentence -> Sentence
(!.) :: Sentence -> Sentence
capSent :: Sentence -> Sentence
headSent :: Int -> Sentence -> Sentence
ch :: (HasUID c, HasSymbol c) => c -> Sentence
eS :: ModelExpr -> Sentence
eS' :: Express t => t -> Sentence
sC :: Sentence -> Sentence -> Sentence
sDash :: Sentence -> Sentence -> Sentence
sParen :: Sentence -> Sentence
sentencePlural :: UID -> Sentence
sentenceShort :: UID -> Sentence
sentenceSymb :: UID -> Sentence
sentenceTerm :: UID -> Sentence

Types

Sentence

data Sentence where Source #

For writing Sentences via combining smaller elements. Sentences are made up of some known vocabulary of things:

units (their visual representation)
words (via Strings)
special characters
accented letters
references to specific layout objects

Constructors

Ch :: SentenceStyle -> TermCapitalization -> UID -> Sentence	Ch looks up the term for a given `UID` and displays the term with a given `SentenceStyle` and `CapitalizationRule`. This allows Sentences to hold plural forms of `NounPhrase`s and `NamedIdea`s.
SyCh :: UID -> Sentence	A branch of Ch dedicated to SymbolStyle only.
Sy :: USymb -> Sentence	Converts a unit symbol into a usable Sentence form.
S :: String -> Sentence	Constructor for `String`s, used often for descriptions in Chunks.
P :: Symbol -> Sentence	Converts the graphical representation of a symbol into a usable Sentence form.
E :: ModelExpr -> Sentence	Lifts an expression into a Sentence.
Ref :: UID -> Sentence -> RefInfo -> Sentence	Takes a `UID` to a reference, a display name (`Sentence`), and any additional reference display information (`RefInfo`). Resolves the reference later (similar to Ch).
Quote :: Sentence -> Sentence	Adds quotation marks around a Sentence.
Percent :: Sentence	Used for a % symbol.
(:+:) :: Sentence -> Sentence -> Sentence infixr 5	Direct concatenation of two Sentences (no implicit spaces!).
EmptyS :: Sentence	Empty Sentence.

Instances

Instances details

Monoid Sentence Source #	Sentences can be empty or directly concatenated.
Instance details Defined in Language.Drasil.Sentence Methods mempty :: Sentence # mappend :: Sentence -> Sentence -> Sentence # mconcat :: [Sentence] -> Sentence #
Semigroup Sentence Source #	Sentences can be concatenated.
Instance details Defined in Language.Drasil.Sentence Methods (<>) :: Sentence -> Sentence -> Sentence # sconcat :: NonEmpty Sentence -> Sentence # stimes :: Integral b => b -> Sentence -> Sentence #

Used in Ch constructor to determine the capitalization of a term. CapF is for capitalizing the first word from the UID of the given term. CapW is for capitalizing all words from the UID of the given term. Mirrors CapFirst and CapWords from CapitalizationRule.

Constructors