citation

Documentation

Index

• func ExportBibtex(citations []Citation)
• func ExportJson(citations []Citation)
• type Citation
  • func ParseFromBibtex(bibtex string) []Citation
  • func (self *Citation) CopyFile(file string) string
  • func (self *Citation) GetAuthorCitekey() string
  • func (self *Citation) GetAuthorTui() string
  • func (self *Citation) GetAuthorsSql(citAuthors []CitationAuthor) string
  • func (self *Citation) GetCiteKey() string
  • func (self *Citation) GetTitle() string
  • func (self *Citation) GetYear() string
  • func (self Citation) Print()
• type CitationAuthor
  • func ParseAuthorsSql(authors string) []CitationAuthor
• type CitationShort
• type Client
  • func NewClient(source ClientType) Client
  • func (self *Client) GetCitation(doi, file string) (Citation, error)
• type ClientType
• type Crossref
• type CrossrefFields
• type Datacite
• type DataciteFields
• type DatePart
• type ResourceLink

Functions

func ExportBibtex

func ExportBibtex(citations []Citation)

exports all citations to bibtex

func ExportJson

func ExportJson(citations []Citation)

exports citations to short json

Types

type Citation

type Citation struct {
	Address      string // address
	Author       []CitationAuthor
	Booktitle    string // booktitle
	Chapter      string // chapter
	Citekey      string // citekey (generated)
	Doi          string // doi
	Editor       []CitationAuthor
	File         string // appended file
	Howpublished string // how published
	Institution  string // institution
	Id           int    // database id (generated)
	Isbn         string // isbn
	Issn         string // issn
	Journal      string // journal name
	Number       string // issue number
	Organization string // organization
	Pages        string // pages
	Publisher    string // publisher
	ResourceType string // needs to be converted to bibtex entry type
	Series       string // series
	School       string // school
	Title        string // title
	Url          string // doi url
	UrlDate      string // access date (generated)
	Volume       string // volume
	Year         string // year
}

the organized form of a citation

func ParseFromBibtex

func ParseFromBibtex(bibtex string) []Citation

tries to parse a bibtex string to []Citation assumes a reasonably well formatted bibtex file https://www.bibtex.com/g/bibtex-format/

func (*Citation) CopyFile

func (self *Citation) CopyFile(file string) string

copies source file to the bibliography folder and returns new name

func (*Citation) GetAuthorCitekey

func (self *Citation) GetAuthorCitekey() string

returns author abbreviation for citekey

func (*Citation) GetAuthorTui

func (self *Citation) GetAuthorTui() string

returns short author string for TUI either:

family name (if one author),
family and family (2 authors),
family et al. (more authors)

func (*Citation) GetAuthorsSql

func (self *Citation) GetAuthorsSql(citAuthors []CitationAuthor) string

returns authors as delimited string for the sql database

func (*Citation) GetCiteKey

func (self *Citation) GetCiteKey() string

returns citekey

func (*Citation) GetTitle

func (self *Citation) GetTitle() string

returns abbreviated title

func (*Citation) GetYear

func (self *Citation) GetYear() string

returns publication year

func (Citation) Print

func (self Citation) Print()

prints citation summary

type CitationAuthor

type CitationAuthor struct {
	Family string `json:"family"`
	Given  string `json:"given"`
}

an author's family and given name

func ParseAuthorsSql

func ParseAuthorsSql(authors string) []CitationAuthor

parses authors delimited string to []CitationAuthor

type CitationShort

type CitationShort struct {
	Authors string
	Title   string
	Year    string
	Citekey string
}

'short' citations for json export

type Client

type Client struct {
	// contains filtered or unexported fields
}

crossref / datacite api

func NewClient

func NewClient(source ClientType) Client

returns new client

func (*Client) GetCitation

func (self *Client) GetCitation(doi, file string) (Citation, error)

returns api call result

type ClientType

type ClientType int

which api to choose

const (
	CrossRefClient ClientType = 0
	DataCiteClient ClientType = 1
)

type Crossref

type Crossref struct {
	Status         string         `json:"status"`
	MessageType    string         `json:"message-type"`
	MessageVersion string         `json:"message-version"`
	Message        CrossrefFields `json:"message"`
}

type CrossrefFields

type CrossrefFields struct {
	Author         []CitationAuthor `json:"author"`
	ContainerTitle []string         `json:"container-title"`
	DOI            string           `json:"DOI"`
	Editor         []CitationAuthor `json:"editor"`
	ISBN           []string         `json:"ISBN"`
	ISSN           []string         `json:"ISSN"`
	Issue          string           `json:"issue"`
	Link           []ResourceLink   `json:"link"`
	Page           string           `json:"page"`
	Publisher      string           `json:"publisher"`
	Title          []string         `json:"title"`
	Type           string           `json:"type"`
	URL            string           `json:"URL"`
	Volume         string           `json:"volume"`
	Published      DatePart         `json:"published"`
}

type Datacite

type Datacite struct {
	Data struct {
		Attributes DataciteFields `json:"attributes"`
	} `json:"data"`
}

type DataciteFields

type DataciteFields struct {
	Author     []CitationAuthor `json:"author"`
	Container  string           `json:"container-title"`
	Doi        string           `json:"doi"`
	Identifier string           `json:"identifier"`
	Publisher  string           `json:"publisher"`
	Title      string           `json:"title"`
	Type       string           `json:"resource-type-id"`
	Url        string           `json:"url"`
	Year       string           `json:"published"`
}

type DatePart

type DatePart struct {
	Parts [][]int `json:"date-parts"`
}

type ResourceLink

type ResourceLink struct {
	URL string `json:"URL"`
}