Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.Document.DecoratedReference

Contents

Type
Class
Constructors

Description

References that have extra information.

Synopsis

data DecRef = DR {
- _rf :: Reference
- refInfo :: RefInfo
}
class HasDecRef c where
- getDecRefs :: Lens' c [DecRef]
dRef :: (IsChunk r, HasRefAddress r, HasShortName r) => r -> DecRef
dRefInfo :: (IsChunk r, HasRefAddress r, HasShortName r) => r -> RefInfo -> DecRef

Type

data DecRef Source #

For holding a Reference that is decorated with extra information (ex. page numbers, equation sources, etc.).

Constructors

DR
Fields _rf :: Reference refInfo :: RefInfo

Instances

Instances details

Generic DecRef Source #
Instance details Defined in Language.Drasil.Document.DecoratedReference Associated Types type Rep DecRef :: Type -> Type # Methods from :: DecRef -> Rep DecRef x # to :: Rep DecRef x -> DecRef #
HasChunkRefs DecRef Source #
Instance details Defined in Language.Drasil.Document.DecoratedReference Methods chunkRefs :: DecRef -> Set UID #
HasUID DecRef Source #	Finds the `UID` of a `Reference`.
Instance details Defined in Language.Drasil.Document.DecoratedReference Methods uid :: Getter DecRef UID #
HasRefAddress DecRef Source #	Finds the reference address contained in a `Reference` (through a `LblType`).
Instance details Defined in Language.Drasil.Document.DecoratedReference Methods getRefAdd :: DecRef -> LblType Source #
HasShortName DecRef Source #	Finds the shortname of the reference address used for the `Reference`.
Instance details Defined in Language.Drasil.Document.DecoratedReference Methods shortname :: DecRef -> ShortName Source #
Eq DecRef Source #	Equal if `UID`s are equal.
Instance details Defined in Language.Drasil.Document.DecoratedReference Methods (==) :: DecRef -> DecRef -> Bool # (/=) :: DecRef -> DecRef -> Bool #
type Rep DecRef Source #
Instance details Defined in Language.Drasil.Document.DecoratedReference type Rep DecRef = D1 ('MetaData "DecRef" "Language.Drasil.Document.DecoratedReference" "drasil-lang-0.1.60.0-GSVjWL6zqIJGx21JJ17VJN" 'False) (C1 ('MetaCons "DR" 'PrefixI 'True) (S1 ('MetaSel ('Just "_rf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Reference) :*: S1 ('MetaSel ('Just "refInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RefInfo)))

Class

class HasDecRef c where Source #

A class that contains a list of decorated references (DecRefs).

Methods

getDecRefs :: Lens' c [DecRef] Source #

Provides a Lens to the DecRefs.

Constructors

dRef :: (IsChunk r, HasRefAddress r, HasShortName r) => r -> DecRef Source #

Same as ref, but for DecRef instead of Reference.

dRefInfo :: (IsChunk r, HasRefAddress r, HasShortName r) => r -> RefInfo -> DecRef Source #

For creating a decorated reference (DecRef) with extra reference information (RefInfo).