Safe Haskell	None
Language	Haskell2010

Language.Drasil.Label.Type

Contents

Types
Classes
LblType accessor
IRefProg constructors

Description

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

Synopsis

data LblType
- = RP IRefProg String
- | Citation String
- | URI String
data IRefProg
- = Deferred UID
- | RS String
- | RConcat IRefProg IRefProg
- | Name
class HasRefAddress b where
- getRefAdd :: b -> LblType
class (HasUID s, HasRefAddress s) => Referable s where
- refAdd :: s -> String
- renderRef :: s -> LblType
getAdd :: LblType -> String
name :: IRefProg
(+::+) :: IRefProg -> IRefProg -> IRefProg
raw :: String -> IRefProg
defer :: UID -> IRefProg
prepend :: String -> IRefProg

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

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.

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 Reference Source #	Finds the reference address contained in a `Reference` (through a `LblType`).
Instance details Defined in Language.Drasil.Reference Methods getRefAdd :: Reference -> LblType Source #
HasRefAddress DecRef Source #	Finds the reference address contained in a `Reference` (through a `LblType`).
Instance details Defined in Language.Drasil.DecoratedReference Methods getRefAdd :: DecRef -> LblType Source #
HasRefAddress Citation Source #	Gets the reference address of a `Citation`.
Instance details Defined in Language.Drasil.Chunk.Citation Methods getRefAdd :: Citation -> 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 Section Source #	Finds the reference address of a `Section`.
Instance details Defined in Language.Drasil.Document Methods getRefAdd :: Section -> LblType Source #
HasRefAddress ConceptInstance Source #	Finds the reference address contained in a `ConceptInstance`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods getRefAdd :: ConceptInstance -> LblType Source #

class (HasUID 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.Chunk.Citation Methods refAdd :: Citation -> String Source # renderRef :: Citation -> 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 Methods refAdd :: Section -> String Source # renderRef :: Section -> LblType Source #
Referable ConceptInstance Source #	Finds the reference information contained in a `ConceptInstance`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods refAdd :: ConceptInstance -> String Source # renderRef :: ConceptInstance -> LblType Source #