drasil-lang-0.1.60.0: A framework for code and document generation for scientific software - Language SubPackage

Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.Development.Sentence

Contents

All Lowercase
Capitalize First Word
Capitalize All Words
Short Form (lowercase)

Description

Various helpers for building Sentences from other bits. Really ought to be moved out to (likely) docLang, but is here for now.

Synopsis

phrase :: NamedIdea n => n -> Sentence
plural :: NamedIdea n => n -> Sentence
phrasePoss :: NamedIdea n => n -> Sentence
pluralPoss :: NamedIdea n => n -> Sentence
atStart :: NamedIdea n => n -> Sentence
atStart' :: NamedIdea n => n -> Sentence
titleize :: NamedIdea n => n -> Sentence
titleize' :: NamedIdea n => n -> Sentence
short :: Idea c => c -> Sentence
introduceAbb :: Idea n => n -> Sentence

All Lowercase

phrase :: NamedIdea n => n -> Sentence Source #

Helper for getting the phrase from a NamedIdea using it's UID.

plural :: NamedIdea n => n -> Sentence Source #

Helper for getting the plural of a phrase from a NamedIdea.

phrasePoss :: NamedIdea n => n -> Sentence Source #

Singular possesive function

Helper for getting the possesive cases from the term of a NamedIdea.

pluralPoss :: NamedIdea n => n -> Sentence Source #

Plural possesive function

Helper for getting the possesive cases from the term of a NamedIdea.

Capitalize First Word

atStart :: NamedIdea n => n -> Sentence Source #

Singular sentence case.

Helper function for getting the sentence case of a noun phrase from a NamedIdea.

atStart' :: NamedIdea n => n -> Sentence Source #

Plural sentence case.

Helper function for getting the sentence case of a noun phrase from a NamedIdea.

Capitalize All Words

titleize :: NamedIdea n => n -> Sentence Source #

Singular title case.

Helper function for getting the title case of a noun phrase from a NamedIdea.

titleize' :: NamedIdea n => n -> Sentence Source #

Plural title case.

Helper function for getting the title case of a noun phrase from a NamedIdea.

Short Form (lowercase)

short :: Idea c => c -> Sentence Source #

Get short form (if it exists), else get term of an Idea. Uses the UID of the Idea in a Ch Sentence constructor to get the short form using getA. getA may return Nothing, in which case lookupS uses the term, where lookupS is the main helper for looking up the short form of a Ch Sentence.

introduceAbb :: Idea n => n -> Sentence Source #

Helper for common pattern of introducing the title-case version of a noun phrase (from an Idea) followed by its abbreviation in parentheses.