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

Language.Drasil.Document.ShortName

Description

Short names are used for displaying references.

Synopsis

Documentation

data ShortName Source #

Used for holding the short form of a name (as a Sentence with a wrapper).

Instances

Instances details
HasChunkRefs ShortName Source # 
Instance details

Defined in Language.Drasil.Document.ShortName

Methods

chunkRefs :: ShortName -> Set UID #

Generic ShortName Source # 
Instance details

Defined in Language.Drasil.Document.ShortName

Associated Types

type Rep ShortName 
Instance details

Defined in Language.Drasil.Document.ShortName

type Rep ShortName = D1 ('MetaData "ShortName" "Language.Drasil.Document.ShortName" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'True) (C1 ('MetaCons "ShortNm" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Sentence)))

Methods

from :: ShortName -> Rep ShortName x #

to :: Rep ShortName x -> ShortName #

type Rep ShortName Source # 
Instance details

Defined in Language.Drasil.Document.ShortName

type Rep ShortName = D1 ('MetaData "ShortName" "Language.Drasil.Document.ShortName" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'True) (C1 ('MetaCons "ShortNm" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Sentence)))

shortname' :: Sentence -> ShortName Source #

Smart constructor for making a Sentence into a ShortName.

getSentSN :: ShortName -> Sentence Source #

Pulls the short form (as a Sentence) out of a ShortName.

class HasShortName s where Source #

A ShortName is the text to be displayed for a link.

Used for referencing within a document that can include symbols and whatnot if required. Visible in the typeset documents (pdf).

Methods

shortname :: s -> ShortName Source #

Instances

Instances details
HasShortName Citation Source #

Finds ShortName of the Citation.

Instance details

Defined in Language.Drasil.Document.Citation.Core

Methods

shortname :: Citation -> ShortName Source #

HasShortName ConceptInstance Source #

Finds the ShortName contained in a ConceptInstance.

Instance details

Defined in Language.Drasil.Document.ConceptInstance

Methods

shortname :: ConceptInstance -> ShortName Source #

HasShortName LabelledContent Source #

Find the shortname of the reference address used for the LabelledContent.

Instance details

Defined in Language.Drasil.Document.Core

Methods

shortname :: LabelledContent -> ShortName 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 #

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 #

HasShortName Section Source #

Finds the short name of a Section.

Instance details

Defined in Language.Drasil.Document.Sections

Methods

shortname :: Section -> ShortName Source #