| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Language.Drasil.ShortName
Description
Short names are used for displaying references.
Synopsis
- data ShortName
- shortname' :: Sentence -> ShortName
- getSentSN :: ShortName -> Sentence
- class HasShortName s where
Documentation
Used for holding the short form of a name (as a Sentence with a wrapper).
shortname' :: Sentence -> ShortName Source #
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).
Instances
| HasShortName Citation Source # | |
| HasShortName ConceptInstance Source # | Finds the |
Defined in Language.Drasil.Chunk.Concept.Core Methods shortname :: ConceptInstance -> ShortName Source # | |
| HasShortName LabelledContent Source # | Find the shortname of the reference address used for the |
Defined in Language.Drasil.Document.Core Methods shortname :: LabelledContent -> ShortName Source # | |
| HasShortName DecRef Source # | Finds the shortname of the reference address used for the |
| HasShortName Reference Source # | Finds the shortname of the reference address used for the |
| HasShortName Section Source # | Finds the short name of a |