drasil-lang-0.1.60.0: A framework for code and document generation for scientific software - Language SubPackage
Safe HaskellSafe-Inferred
LanguageHaskell2010

Language.Drasil.Data.Citation

Description

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

Synopsis

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 

data HP Source #

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

Constructors

URL String 
Verb String 

data CitationKind Source #

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

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 #

CiteField Constructors

People -> CiteField

author :: People -> CiteField Source #

Smart field constructor for a CiteField.

editor :: People -> CiteField Source #

Smart field constructor for a CiteField.

String -> CiteField

address :: String -> CiteField Source #

Smart field constructor for a CiteField.

bookTitle :: String -> CiteField Source #

Smart field constructor for a CiteField.

howPublished :: String -> CiteField Source #

Smart field constructor for a CiteField.

howPublishedU :: String -> CiteField Source #

URL version of howPublished.

Smart field constructor for a CiteField.

institution :: String -> CiteField Source #

Smart field constructor for a CiteField.

journal :: String -> CiteField Source #

Smart field constructor for a CiteField.

note :: String -> CiteField Source #

Smart field constructor for a CiteField.

organization :: String -> CiteField Source #

Smart field constructor for a CiteField.

publisher :: String -> CiteField Source #

Smart field constructor for a CiteField.

school :: String -> CiteField Source #

Smart field constructor for a CiteField.

series :: String -> CiteField Source #

Smart field constructor for a CiteField.

title :: String -> CiteField Source #

Smart field constructor for a CiteField.

typeField :: String -> CiteField Source #

Smart field constructor for a CiteField.

Int -> CiteField

chapter :: Int -> CiteField Source #

Smart field constructor for a CiteField.

edition :: Int -> CiteField Source #

Smart field constructor for a CiteField.

number :: Int -> CiteField Source #

Smart field constructor for a CiteField.

volume :: Int -> CiteField Source #

Smart field constructor for a CiteField.

year :: Int -> CiteField Source #

Smart field constructor for a CiteField.

[Int] -> CiteField

pages :: [Int] -> CiteField Source #

Smart field constructor for a CiteField.

CiteField -> CiteField

month :: Month -> CiteField Source #

Smart field constructor for a CiteField.