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

Language.Drasil.Document.Labels

Description

Even though we do not have Labels per se, here we define the different ways of construction ways to mark labels.

Synopsis

Types

data LblType Source #

Applying different pieces of information for a reference. An RP is a decorated internal reference. Citation is a citation. URI is for URLs and other external links.

Constructors

RP IRefProg String 
Citation String 
URI String 

Instances

Instances details
HasChunkRefs LblType Source # 
Instance details

Defined in Language.Drasil.Document.Labels

Methods

chunkRefs :: LblType -> Set UID #

Generic LblType Source # 
Instance details

Defined in Language.Drasil.Document.Labels

Associated Types

type Rep LblType 
Instance details

Defined in Language.Drasil.Document.Labels

type Rep LblType = D1 ('MetaData "LblType" "Language.Drasil.Document.Labels" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'False) (C1 ('MetaCons "RP" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IRefProg) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)) :+: (C1 ('MetaCons "Citation" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)) :+: C1 ('MetaCons "URI" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String))))

Methods

from :: LblType -> Rep LblType x #

to :: Rep LblType x -> LblType #

type Rep LblType Source # 
Instance details

Defined in Language.Drasil.Document.Labels

type Rep LblType = D1 ('MetaData "LblType" "Language.Drasil.Document.Labels" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'False) (C1 ('MetaCons "RP" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IRefProg) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)) :+: (C1 ('MetaCons "Citation" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)) :+: C1 ('MetaCons "URI" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String))))

data IRefProg Source #

Created for different forms of references. Used in LblType.

Constructors

Deferred UID

Deferred lookup; done later. Used for domains in a ConceptInstance.

RS String

Lifts a String into a RefProg.

RConcat IRefProg IRefProg

Concatenates with two subprograms.

Name

The Symbol to insert the ShortName directly.

Instances

Instances details
HasChunkRefs IRefProg Source # 
Instance details

Defined in Language.Drasil.Document.Labels

Methods

chunkRefs :: IRefProg -> Set UID #

Generic IRefProg Source # 
Instance details

Defined in Language.Drasil.Document.Labels

Associated Types

type Rep IRefProg 
Instance details

Defined in Language.Drasil.Document.Labels

type Rep IRefProg = D1 ('MetaData "IRefProg" "Language.Drasil.Document.Labels" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'False) ((C1 ('MetaCons "Deferred" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UID)) :+: C1 ('MetaCons "RS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String))) :+: (C1 ('MetaCons "RConcat" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IRefProg) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IRefProg)) :+: C1 ('MetaCons "Name" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: IRefProg -> Rep IRefProg x #

to :: Rep IRefProg x -> IRefProg #

type Rep IRefProg Source # 
Instance details

Defined in Language.Drasil.Document.Labels

type Rep IRefProg = D1 ('MetaData "IRefProg" "Language.Drasil.Document.Labels" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'False) ((C1 ('MetaCons "Deferred" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UID)) :+: C1 ('MetaCons "RS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String))) :+: (C1 ('MetaCons "RConcat" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IRefProg) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IRefProg)) :+: C1 ('MetaCons "Name" 'PrefixI 'False) (U1 :: Type -> Type)))

Classes

class HasRefAddress b where Source #

Members must have a reference address.

Methods

getRefAdd :: b -> LblType Source #

Provides the ability to hold a reference address.

Instances

Instances details
HasRefAddress Citation Source #

Gets the reference address of a Citation.

Instance details

Defined in Language.Drasil.Document.Citation.Core

Methods

getRefAdd :: Citation -> LblType Source #

HasRefAddress ConceptInstance Source #

Finds the reference address contained in a ConceptInstance.

Instance details

Defined in Language.Drasil.Document.ConceptInstance

Methods

getRefAdd :: ConceptInstance -> LblType Source #

HasRefAddress LabelledContent Source #

Finds the reference address contained in the Reference of LabelledContent.

Instance details

Defined in Language.Drasil.Document.Core

Methods

getRefAdd :: LabelledContent -> LblType Source #

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 #

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 #

HasRefAddress Section Source #

Finds the reference address of a Section.

Instance details

Defined in Language.Drasil.Document.Sections

Methods

getRefAdd :: Section -> LblType Source #

class (IsChunk s, HasRefAddress s) => Referable s where Source #

Members of this class have the ability to be referenced.

Methods

refAdd :: s -> String Source #

The referencing address (what we're linking to). Only visible in the source (tex/html).

renderRef :: s -> LblType Source #

Alternate form of reference.

Instances

Instances details
Referable Citation Source #

Gets the reference information of a Citation.

Instance details

Defined in Language.Drasil.Document.Citation.Core

Methods

refAdd :: Citation -> String Source #

renderRef :: Citation -> LblType Source #

Referable ConceptInstance Source #

Finds the reference information contained in a ConceptInstance.

Instance details

Defined in Language.Drasil.Document.ConceptInstance

Methods

refAdd :: ConceptInstance -> String Source #

renderRef :: ConceptInstance -> LblType Source #

Referable LabelledContent Source #

Finds the reference information of LabelledContent.

Instance details

Defined in Language.Drasil.Document.Core

Methods

refAdd :: LabelledContent -> String Source #

renderRef :: LabelledContent -> LblType Source #

Referable Section Source #

Finds the reference information of a Section.

Instance details

Defined in Language.Drasil.Document.Sections

Methods

refAdd :: Section -> String Source #

renderRef :: Section -> LblType Source #

LblType accessor

getAdd :: LblType -> String Source #

Retrieves the String contained in a LblType.

IRefProg constructors

name :: IRefProg Source #

Constructor that gets the Name of an IRefProg.

(+::+) :: IRefProg -> IRefProg -> IRefProg Source #

Constructor that concatenates two subprograms.

raw :: String -> IRefProg Source #

Constructor for a String into an IRefProg.

defer :: UID -> IRefProg Source #

Constructor to defer a UID lookup; done later.

prepend :: String -> IRefProg Source #

Prepends a String to an IRefProg.