bibtex

package module
v0.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 7, 2016 License: BSD-3-Clause Imports: 5 Imported by: 7

README

bibtex

A Golang BibTeX package and bibfilter tool. bibfilter can parse and filter BibTeX entries.

bibfilter

Output my.bib file without comment entries

  bibfilter -exclude=comment my.bib

Output only articles from my.bib

    bibfilter -include=article my.bib

Output only articles and conference proceedings from my.bib

    bibfilter -include=article,inproceedings my.bib

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
  • 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

About BibTeX

Open Source Citation Tools

Documentation

Overview

Package bibtex is a quick and dirty BibTeX parser for working with a Bibtex citation

@author R. S. Doiel, <rsdoiel@caltech.edu>

Copyright (c) 2016, Caltech All rights not granted herein are expressly reserved by Caltech.

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

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

2. 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.

3. Neither the name of the copyright holder 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

View Source 
const (
	// Version of BibTeX package
	Version = "v0.0.4"

	// DefaultInclude list
	DefaultInclude = "" /* 150-byte string literal not displayed */

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

)

Variables

This section is empty.

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
}

Source Files

View all Source files

Directories

Path Synopsis
cmds
bibfilter command
bibfilter reads a bibfile and writes it out.
 bibfilter reads a bibfile and writes it out.
webapp.go a Web Application of bibfilter @author R. S. Doiel, <rsdoiel@caltech.edu> Copyright (c) 2016, Caltech All rights not granted herein are expressly reserved by Caltech.
 webapp.go a Web Application of bibfilter @author R. S. Doiel, <rsdoiel@caltech.edu> Copyright (c) 2016, Caltech All rights not granted herein are expressly reserved by Caltech.
bibfilter
webfilter is a GopherJS wrapper around bibtex.
 webfilter is a GopherJS wrapper around bibtex.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.