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

Description

Contains functions to create the concept related chunk types found in Language.Drasil.Chunk.Concept.Core.

Synopsis

Concept Chunks

From an idea (IdeaDict)

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.

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

cncpt Source #

Arguments

:: Concept dom 
=> UID

The UID.

-> NP 
-> Sentence

The definition of the term

-> String

The term's abbreviation.

-> [dom]

The domain the term belongs to.

-> ConceptChunk 

Construct a ConceptChunk.

cncpt' Source #

Arguments

:: Concept dom 
=> UID

The UID.

-> NP

The term being defined.

-> Sentence

The definition of the term

-> [dom]

The domain the term belongs to.

-> ConceptChunk 

Construct a ConceptChunk.

cncpt'' Source #

Arguments

:: UID

The UID.

-> NP

The term being defined.

-> Sentence

The definition of the term

-> String

The term's abbreviation.

-> ConceptChunk 

Construct a ConceptChunk.

cncpt''' Source #

Arguments

:: UID

The UID.

-> NP

The term being defined.

-> Sentence

The definition of the term

-> ConceptChunk 

Construct a ConceptChunk.

cw :: Concept c => c -> ConceptChunk Source #

Deprecated: Chunk down-casting is strongly discouraged. If you want to construct a ConceptChunk, use one of its normal constructors.

For projecting out to the ConceptChunk data-type.