Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.Data.Citation

Contents

Types
Class
CiteField Constructors
Comparators

Description

Contains all necessary types and constructors for citing sources in Drasil.

Synopsis

data CiteField
- = Address String
- | Author People
- | BookTitle String
- | Chapter Int
- | Edition Int
- | Editor People
- | HowPublished HP
- | Institution String
- | Journal String
- | Month Month
- | Note String
- | Number Int
- | Organization String
- | Pages [Int]
- | Publisher String
- | School String
- | Series String
- | Title String
- | Type String
- | Volume Int
- | Year Int
data HP
- = URL String
- | Verb String
data CitationKind
- = Article
- | Book
- | Booklet
- | InBook
- | InCollection
- | InProceedings
- | Manual
- | MThesis
- | Misc
- | PhDThesis
- | Proceedings
- | TechReport
- | Unpublished
class HasFields c where
- getFields :: Lens' c [CiteField]
author :: People -> CiteField
editor :: People -> CiteField
address :: String -> CiteField
bookTitle :: String -> CiteField
howPublished :: String -> CiteField
howPublishedU :: String -> CiteField
institution :: String -> CiteField
journal :: String -> CiteField
note :: String -> CiteField
organization :: String -> CiteField
publisher :: String -> CiteField
school :: String -> CiteField
series :: String -> CiteField
title :: String -> CiteField
typeField :: String -> CiteField
chapter :: Int -> CiteField
edition :: Int -> CiteField
number :: Int -> CiteField
volume :: Int -> CiteField
year :: Int -> CiteField
pages :: [Int] -> CiteField
month :: Month -> CiteField
compareAuthYearTitle :: HasFields c => c -> c -> Ordering

Types

data CiteField Source #

Fields used in citations.

Constructors

Address String
Author People
BookTitle String	Used for `InCollection` references only.
Chapter Int
Edition Int
Editor People
HowPublished HP	Can be published via URL or something else.
Institution String
Journal String
Month Month
Note String
Number Int
Organization String
Pages [Int]	Range of pages (ex1. 1-32; ex2. 7,31,52-55).
Publisher String
School String
Series String
Title String
Type String	BibTeX "type" field.
Volume Int
Year Int

Instances

Instances details

Generic CiteField Source #
Instance details Defined in Language.Drasil.Data.Citation Associated Types type Rep CiteField :: Type -> Type # Methods from :: CiteField -> Rep CiteField x # to :: Rep CiteField x -> CiteField #
HasChunkRefs CiteField Source #
Instance details Defined in Language.Drasil.Data.Citation Methods chunkRefs :: CiteField -> Set UID #
type Rep CiteField Source #
Instance details Defined in Language.Drasil.Data.Citation type Rep CiteField = D1 ('MetaData "CiteField" "Language.Drasil.Data.Citation" "drasil-lang-0.1.60.0-GSVjWL6zqIJGx21JJ17VJN" 'False) ((((C1 ('MetaCons "Address" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)) :+: C1 ('MetaCons "Author" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 People))) :+: (C1 ('MetaCons "BookTitle" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)) :+: (C1 ('MetaCons "Chapter" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :+: C1 ('MetaCons "Edition" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))) :+: ((C1 ('MetaCons "Editor" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 People)) :+: C1 ('MetaCons "HowPublished" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HP))) :+: (C1 ('MetaCons "Institution" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)) :+: (C1 ('MetaCons "Journal" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)) :+: C1 ('MetaCons "Month" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Month)))))) :+: (((C1 ('MetaCons "Note" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)) :+: C1 ('MetaCons "Number" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :+: (C1 ('MetaCons "Organization" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)) :+: (C1 ('MetaCons "Pages" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Int])) :+: C1 ('MetaCons "Publisher" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String))))) :+: ((C1 ('MetaCons "School" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)) :+: (C1 ('MetaCons "Series" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)) :+: C1 ('MetaCons "Title" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)))) :+: (C1 ('MetaCons "Type" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)) :+: (C1 ('MetaCons "Volume" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :+: C1 ('MetaCons "Year" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

data HP Source #

How something is published. Necessary for URLs to work properly.

Constructors

URL String
Verb String

Instances

Instances details

Generic HP Source #
Instance details Defined in Language.Drasil.Data.Citation Associated Types type Rep HP :: Type -> Type # Methods from :: HP -> Rep HP x # to :: Rep HP x -> HP #
HasChunkRefs HP Source #
Instance details Defined in Language.Drasil.Data.Citation Methods chunkRefs :: HP -> Set UID #
type Rep HP Source #
Instance details Defined in Language.Drasil.Data.Citation type Rep HP = D1 ('MetaData "HP" "Language.Drasil.Data.Citation" "drasil-lang-0.1.60.0-GSVjWL6zqIJGx21JJ17VJN" 'False) (C1 ('MetaCons "URL" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)) :+: C1 ('MetaCons "Verb" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)))

data CitationKind Source #

External references come in many flavours. Articles, Books, etc. (we are using the types available in Bibtex).

Constructors

Article
Book
Booklet
InBook
InCollection
InProceedings
Manual
MThesis
Misc
PhDThesis
Proceedings
TechReport
Unpublished

Instances

Instances details

Generic CitationKind Source #
Instance details Defined in Language.Drasil.Data.Citation Associated Types type Rep CitationKind :: Type -> Type # Methods from :: CitationKind -> Rep CitationKind x # to :: Rep CitationKind x -> CitationKind #
HasChunkRefs CitationKind Source #
Instance details Defined in Language.Drasil.Data.Citation Methods chunkRefs :: CitationKind -> Set UID #
type Rep CitationKind Source #
Instance details Defined in Language.Drasil.Data.Citation type Rep CitationKind = D1 ('MetaData "CitationKind" "Language.Drasil.Data.Citation" "drasil-lang-0.1.60.0-GSVjWL6zqIJGx21JJ17VJN" 'False) (((C1 ('MetaCons "Article" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Book" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Booklet" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "InBook" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "InCollection" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InProceedings" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "Manual" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "MThesis" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Misc" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "PhDThesis" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Proceedings" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "TechReport" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Unpublished" 'PrefixI 'False) (U1 :: Type -> Type)))))

Class

class HasFields c where Source #

Citations should have a fields (CiteField).

Methods

getFields :: Lens' c [CiteField] Source #

Provides a Lens to CiteFields.

Instances

Instances details

HasFields Citation Source #	Finds `Fields` of the `Citation`.
Instance details Defined in Language.Drasil.Chunk.Citation Methods getFields :: Lens' Citation [CiteField] Source #