| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Language.Drasil.Label.Type
Description
Even though we do not have Labels per se, here we define the
different ways of construction ways to mark labels.
Types
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.
Instances
| Generic LblType Source # | |
| HasChunkRefs LblType Source # | |
| type Rep LblType Source # | |
Defined in Language.Drasil.Label.Type type Rep LblType = D1 ('MetaData "LblType" "Language.Drasil.Label.Type" "drasil-lang-0.1.60.0-GSVjWL6zqIJGx21JJ17VJN" '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)))) | |
Created for different forms of references. Used in LblType.
Constructors
| Deferred UID | Deferred lookup; done later. Used for domains in a |
| RS String | Lifts a |
| RConcat IRefProg IRefProg | Concatenates with two subprograms. |
| Name | The |
Instances
| Generic IRefProg Source # | |
| HasChunkRefs IRefProg Source # | |
| type Rep IRefProg Source # | |
Defined in Language.Drasil.Label.Type type Rep IRefProg = D1 ('MetaData "IRefProg" "Language.Drasil.Label.Type" "drasil-lang-0.1.60.0-GSVjWL6zqIJGx21JJ17VJN" '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.
Instances
| HasRefAddress Citation Source # | Gets the reference address of a |
| HasRefAddress ConceptInstance Source # | Finds the reference address contained in a |
Defined in Language.Drasil.Chunk.Concept.Core Methods getRefAdd :: ConceptInstance -> LblType Source # | |
| HasRefAddress LabelledContent Source # | Finds the reference address contained in the |
Defined in Language.Drasil.Document.Core Methods getRefAdd :: LabelledContent -> LblType Source # | |
| HasRefAddress DecRef Source # | Finds the reference address contained in a |
| HasRefAddress Reference Source # | Finds the reference address contained in a |
| HasRefAddress Section Source # | Finds the reference address of a |
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
| Referable Citation Source # | Gets the reference information of a |
| Referable ConceptInstance Source # | Finds the reference information contained in a |
Defined in Language.Drasil.Chunk.Concept.Core | |
| Referable LabelledContent Source # | Finds the reference information of |
Defined in Language.Drasil.Document.Core | |
| Referable Section Source # | Finds the reference information of a |