bibtex

README

bibtex

A quick and dirty BibTeX package. Includes a simple plain text to BibTeX parser.

Prior art

• makebib.perl - Converts plain text through a series regexp rules into BibTeX
  • Perl script includes self test that maybe helpful
• pybtex - Python BibTeX processor
• peer2 - Golang port of a Python tool called peer, it can do basic BibTeX format parsing
• r59-lex.go - Golang, simple lexer example using goroutines
  • meling/biblexer - a Golang BibTeX lexer based on Rob Pike's r59-lex.go
• nickng/bibtex - Golang, BibTeX parser package
• tmc/bibtex - Golang, BibTeX parser package
• sotetsuk/gobibtext - Golang, a BibTeX parser implementing the Decode, Encode function approach

Use case input examples

• Example web pages with publication list
  • Publications dealing with optical spectroscopy of minerals

About BibTeX

• Wikipedia page on BibTeX
  • includes good description of currently used fields
• Bibliographies with BibTeX
  • article explaining practical usage
• bibtex.org
  • format
  • usage

Open Source Citation Tools

• JabRef - an open source bibliography reference manager.
  • The native file format used by JabRef is BibTeX, the standard LaTeX bibliography format.
• Zotero
  • Provides a hosted solution
  • License
  • Source Code
    • Developer docs

Documentation

Overview

Package bibtex is a quick and dirty plain text parser for generating a Bibtex citation

@author R. S. Doiel, <rsdoiel@gmail.com>

Copyright (c) 2016, R. S. Doiel All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of mkbib nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Index

• Constants
• func Bib(token *tok.Token, buf []byte) (*tok.Token, []byte)
• type Element
  • func Parse(buf []byte) ([]*Element, error)
  • func (element *Element) String() string
• type Elements
• type TagTypes

Constants

const (
	// Version of BibTeX package
	Version = "v0.0.2"

	// A template for printing an element
	ElementTmplSrc = `` /* 132-byte string literal not displayed */

)

Functions

func Bib

func Bib(token *tok.Token, buf []byte) (*tok.Token, []byte)

Bib is a niave BibTeX Tokenizer function Note: there is an English bias in the AlphaNumeric check

Types

type Element

type Element struct {
	XMLName xml.Name          `json:"-"`
	Type    string            `xml:"type" json:"type"`
	Keys    []string          `xml:"keys" json:"keys"`
	Tags    map[string]string `xml:"tags" json:"tags"`
}

Generic Element

func Parse

func Parse(buf []byte) ([]*Element, error)

Parse a BibTeX file into appropriate structures

func (*Element) String

func (element *Element) String() string

Render a single BibTeX element

type Elements

type Elements []*Element

type TagTypes

type TagTypes struct {
	Required []string
	Optional []string
}