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

Language.Drasil.Chunk.Concept.Core

Description

Define concept-related chunks. A concept is usually something that has a term, definition, and comes from some domain of knowledge.

Synopsis

Concept-related Datatypes

data ConceptChunk Source #

The ConceptChunk datatype records a concept that contains a unique id (UID), a term (NP), a definition (Sentence), an optional abbreviation ('Maybe String'), and an associated domain of knowledge ([UID]).

Ex. The concept of Accuracy may be defined as the quality or state of being correct or precise.

Constructors

ConDict UID NP (Maybe String) Sentence [UID] 

Instances

Instances details
HasChunkRefs ConceptChunk Source # 
Instance details

Defined in Language.Drasil.Chunk.Concept.Core

HasUID ConceptChunk Source #

Finds UID of the ConceptChunk.

Instance details

Defined in Language.Drasil.Chunk.Concept.Core

Methods

uid :: Getter ConceptChunk UID #

Idea ConceptChunk Source #

Finds the abbreviation of the ConceptChunk.

Instance details

Defined in Language.Drasil.Chunk.Concept.Core

NamedIdea ConceptChunk Source #

Finds term (NP) of the ConceptChunk.

Instance details

Defined in Language.Drasil.Chunk.Concept.Core

Methods

term :: Lens' ConceptChunk NP Source #

ConceptDomain ConceptChunk Source #

Finds the domain of UIDs of a ConceptChunk.

Instance details

Defined in Language.Drasil.Chunk.Concept.Core

Methods

cdom :: ConceptChunk -> [UID] Source #

Definition ConceptChunk Source #

Finds definition of a ConceptChunk.

Instance details

Defined in Language.Drasil.Chunk.Concept.Core

Generic ConceptChunk Source # 
Instance details

Defined in Language.Drasil.Chunk.Concept.Core

Associated Types

type Rep ConceptChunk 
Instance details

Defined in Language.Drasil.Chunk.Concept.Core

Eq ConceptChunk Source #

Equal if UIDs are equal.

Instance details

Defined in Language.Drasil.Chunk.Concept.Core

type Rep ConceptChunk Source # 
Instance details

Defined in Language.Drasil.Chunk.Concept.Core

sDom :: [UID] -> UID Source #

Check if something has one domain. Throws an error if there is more than one.