Safe Haskell	None
Language	GHC2024

Language.Drasil.Document.Reference

Contents

Type
Class
Constructors

Description

Defines a type used to hold referencing information.

Synopsis

data Reference = Reference UID LblType ShortName
class HasReference c where
- getReferences :: Lens' c [Reference]
ref :: (IsChunk r, HasRefAddress r, HasShortName r) => r -> Reference
refS :: (IsChunk r, HasRefAddress r, HasShortName r) => r -> Sentence
namedRef :: (IsChunk r, HasRefAddress r, HasShortName r) => r -> Sentence -> Sentence
complexRef :: (IsChunk r, HasRefAddress r, HasShortName r) => r -> RefInfo -> Sentence
namedComplexRef :: (IsChunk r, HasRefAddress r, HasShortName r) => r -> Sentence -> RefInfo -> Sentence

Type

data Reference Source #

A Reference contains the identifier (UID), a reference address (LblType), a human-readable shortname (ShortName), and any extra information about the reference (RefInfo).

Constructors

Reference UID LblType ShortName

Instances

Instances details

HasChunkRefs Reference Source #

Instance details

Defined in Language.Drasil.Document.Reference

Methods

chunkRefs :: Reference -> Set UID #

HasUID Reference Source #

Finds the UID of a Reference.

Instance details

Defined in Language.Drasil.Document.Reference

Methods

uid :: Getter Reference UID #

HasRefAddress Reference Source #

Finds the reference address contained in a Reference (through a LblType).

Instance details

Defined in Language.Drasil.Document.Reference

Methods

getRefAdd :: Reference -> LblType Source #

HasShortName Reference Source #

Finds the shortname of the reference address used for the Reference.

Instance details

Defined in Language.Drasil.Document.Reference

Methods

shortname :: Reference -> ShortName Source #

Generic Reference Source #

Instance details

Defined in Language.Drasil.Document.Reference

Associated Types

type Rep Reference

Instance details

Defined in Language.Drasil.Document.Reference

type Rep Reference = D1 ('MetaData "Reference" "Language.Drasil.Document.Reference" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'False) (C1 ('MetaCons "Reference" 'PrefixI 'True) (S1 ('MetaSel ('Just "_ui") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UID) :*: (S1 ('MetaSel ('Just "ra") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LblType) :*: S1 ('MetaSel ('Just "sn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShortName))))

Methods

from :: Reference -> Rep Reference x #

to :: Rep Reference x -> Reference #

Eq Reference Source #

Equal if UIDs are equal.

Instance details

Defined in Language.Drasil.Document.Reference

Methods

(==) :: Reference -> Reference -> Bool #

(/=) :: Reference -> Reference -> Bool #

type Rep Reference Source #

Instance details

Defined in Language.Drasil.Document.Reference

type Rep Reference = D1 ('MetaData "Reference" "Language.Drasil.Document.Reference" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'False) (C1 ('MetaCons "Reference" 'PrefixI 'True) (S1 ('MetaSel ('Just "_ui") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UID) :*: (S1 ('MetaSel ('Just "ra") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LblType) :*: S1 ('MetaSel ('Just "sn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShortName))))

Class

class HasReference c where Source #

A class that contains a list of References.

Methods

getReferences :: Lens' c [Reference] Source #

Provides a Lens to the References.

Constructors

ref :: (IsChunk r, HasRefAddress r, HasShortName r) => r -> Reference Source #

Projector function that creates a Reference from something Referable.

refS :: (IsChunk r, HasRefAddress r, HasShortName r) => r -> Sentence Source #

Takes the reference UID and wraps it into a Sentence.

namedRef :: (IsChunk r, HasRefAddress r, HasShortName r) => r -> Sentence -> Sentence Source #

Takes a Reference with a name to be displayed and wraps it into a Sentence. Does not overwrite the shortname contained in the reference, but will only display as the given Sentence.

complexRef :: (IsChunk r, HasRefAddress r, HasShortName r) => r -> RefInfo -> Sentence Source #

Takes a Reference with additional display info. Uses the internal shortname for its display name.

namedComplexRef :: (IsChunk r, HasRefAddress r, HasShortName r) => r -> Sentence -> RefInfo -> Sentence Source #

Takes a Reference with a name to be displayed and any additional information and wraps it into a Sentence. Does not overwrite the shortname contained in the reference, but will only display as the given Sentence along with the given RefInfo.