Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.Chunk.CommonIdea

Contents

Common Idea datatype
Constructors
Functions

Description

Contains the common idea type and respective constructors. SHOULD BE DEPRECATED. Some of the uses (for program name) should have its own chunk type. Others need examined.

Synopsis

data CI
commonIdea :: UID -> NP -> String -> [IdeaDict] -> CI
prependAbrv :: CommonIdea c => c -> String -> String

Common Idea datatype

data CI Source #

The common idea (with NounPhrase) data type. It must have a UID, NounPhrase for its term, an abbreviation (String), and a domain ([UID]). It is similar to IdeaDict and IdeaDict in the sense that these are for things worth naming, but this type also carries an abbreviation and related domains of knowledge.

Ex. The term "Operating System" has the abbreviation OS and comes from the domain of computer science.

Instances

Instances details

Generic CI Source #
Instance details Defined in Language.Drasil.Chunk.CommonIdea Associated Types type Rep CI :: Type -> Type # Methods from :: CI -> Rep CI x # to :: Rep CI x -> CI #
HasChunkRefs CI Source #
Instance details Defined in Language.Drasil.Chunk.CommonIdea Methods chunkRefs :: CI -> Set UID #
HasUID CI Source #	Finds `UID` of the `IdeaDict` used to make the `CI`.
Instance details Defined in Language.Drasil.Chunk.CommonIdea Methods uid :: Getter CI UID #
Idea CI Source #	Finds the idea of a `CI` (abbreviation).
Instance details Defined in Language.Drasil.Chunk.CommonIdea Methods getA :: CI -> Maybe String Source #
NamedIdea CI Source #	Finds term (`NP`) of the `IdeaDict` used to make the `CI`.
Instance details Defined in Language.Drasil.Chunk.CommonIdea Methods term :: Lens' CI NP Source #
CommonIdea CI Source #	Finds the idea of a `CI` (abbreviation).
Instance details Defined in Language.Drasil.Chunk.CommonIdea Methods abrv :: CI -> String Source #
ConceptDomain CI Source #	Finds the domain of a `CI`.
Instance details Defined in Language.Drasil.Chunk.CommonIdea Methods cdom :: CI -> [UID] Source #
type Rep CI Source #
Instance details Defined in Language.Drasil.Chunk.CommonIdea type Rep CI = D1 ('MetaData "CI" "Language.Drasil.Chunk.CommonIdea" "drasil-lang-0.1.60.0-GSVjWL6zqIJGx21JJ17VJN" 'False) (C1 ('MetaCons "CI" 'PrefixI 'True) (S1 ('MetaSel ('Just "_nc'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IdeaDict) :: (S1 ('MetaSel ('Just "_ab") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String) :: S1 ('MetaSel ('Just "cdom'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [UID]))))

Constructors

commonIdea :: UID -> NP -> String -> [IdeaDict] -> CI Source #

The commonIdea smart constructor requires a chunk id (String), a term (NP), an abbreviation (String), and a list of IdeaDict (should be domains). Note: should be polymorphic in IdeaDict, but currently causes issues with ambiguous type variables, punting for now.

Functions

prependAbrv :: CommonIdea c => c -> String -> String Source #

Prepends the abbreviation from a CommonIdea to a String.