diff --git a/latest/index.html b/latest/index.html index a289ce4..a728810 100644 --- a/latest/index.html +++ b/latest/index.html @@ -1,5 +1,6 @@ -Home · BibTeX.jl
Home

BibTeX.jl

BibTeX.parse_bibtex — Method.
parse_bibtex(text)

This is a simple input parser for BibTex. I had trouble finding a standard specification, but I've included several features of real BibTex. Returns a preamble (or an empty string) and a dict of dicts.

julia> using BibTeX
+Home · BibTeX.jl
Home
BibTeX.jl
BibTeX.Citation — Type.
Citation{S}(data::Dict{String,String})
A bibliography item in a bibTeX database, based on a dictionary of strings to values.  It is parameterized by a symbol S giving the type of the item (:article etcetera).  A b::Citation supports b[key] access to retrieve the data and in general acts like a dictionary from String to String.
source
BibTeX.Bibliography — Method.
Bibliography(bibtex::String)
+Bibliography(io::IO)
Given a string (or IO stream) of bibtex-format bibliography data, parses the data and returns a Dict-like object b::Bibliography that behaves as a dictionary mapping strings to bibliography items Citation.
source
BibTeX.parse_bibtex — Method.
parse_bibtex(text)
This is a simple input parser for BibTex. I had trouble finding a standard specification, but I've included several features of real BibTex. Returns a preamble (or an empty string) and a dict of dicts.
julia> using BibTeX: parse_bibtex
 
 julia> preamble, result = parse_bibtex("""
             @preamble{some instructions}
@@ -15,7 +16,7 @@ julia> preamble, result = parse_bibtex("""
 julia> preamble
 "some instructions"
 
-julia> result["b"]["type"]
+julia> result["b"]["__type__"]
 "a"
 
 julia> result["b"]["c"]
@@ -33,4 +34,4 @@ ERROR: Expected { on line 1
 
 julia> parse_bibtex("@book@")
 ERROR: Expected { on line 1
-[...]
source

+[...]
source
diff --git a/latest/search_index.js b/latest/search_index.js index 109bdac..91b32d0 100644 --- a/latest/search_index.js +++ b/latest/search_index.js @@ -8,12 +8,28 @@ var documenterSearchIndex = {"docs": [ "text": "" }, +{ + "location": "index.html#BibTeX.Citation", + "page": "Home", + "title": "BibTeX.Citation", + "category": "Type", + "text": "Citation{S}(data::Dict{String,String})\n\nA bibliography item in a bibTeX database, based on a dictionary of strings to values. It is parameterized by a symbol S giving the type of the item (:article etcetera). A b::Citation supports b[key] access to retrieve the data and in general acts like a dictionary from String to String.\n\n\n\n" +}, + +{ + "location": "index.html#BibTeX.Bibliography-Tuple{String}", + "page": "Home", + "title": "BibTeX.Bibliography", + "category": "Method", + "text": "Bibliography(bibtex::String)\nBibliography(io::IO)\n\nGiven a string (or IO stream) of bibtex-format bibliography data, parses the data and returns a Dict-like object b::Bibliography that behaves as a dictionary mapping strings to bibliography items Citation.\n\n\n\n" +}, + { "location": "index.html#BibTeX.parse_bibtex-Tuple{Any}", "page": "Home", "title": "BibTeX.parse_bibtex", "category": "Method", - "text": "parse_bibtex(text)\n\nThis is a simple input parser for BibTex. I had trouble finding a standard specification, but I've included several features of real BibTex. Returns a preamble (or an empty string) and a dict of dicts.\n\njulia> using BibTeX\n\njulia> preamble, result = parse_bibtex(\"\"\"\n @preamble{some instructions}\n @comment blah blah\n @string{short = long}\n @a{b,\n c = { {c} c},\n d = \"d d\",\n e = f # short\n }\n \"\"\");\n\njulia> preamble\n\"some instructions\"\n\njulia> result[\"b\"][\"type\"]\n\"a\"\n\njulia> result[\"b\"][\"c\"]\n\"{ c } c\"\n\njulia> result[\"b\"][\"d\"]\n\"d d\"\n\njulia> result[\"b\"][\"e\"]\n\"f short\"\n\njulia> parse_bibtex(\"@book\")\nERROR: Expected { on line 1\n[...]\n\njulia> parse_bibtex(\"@book@\")\nERROR: Expected { on line 1\n[...]\n\n\n\n" + "text": "parse_bibtex(text)\n\nThis is a simple input parser for BibTex. I had trouble finding a standard specification, but I've included several features of real BibTex. Returns a preamble (or an empty string) and a dict of dicts.\n\njulia> using BibTeX: parse_bibtex\n\njulia> preamble, result = parse_bibtex(\"\"\"\n @preamble{some instructions}\n @comment blah blah\n @string{short = long}\n @a{b,\n c = { {c} c},\n d = \"d d\",\n e = f # short\n }\n \"\"\");\n\njulia> preamble\n\"some instructions\"\n\njulia> result[\"b\"][\"__type__\"]\n\"a\"\n\njulia> result[\"b\"][\"c\"]\n\"{ c } c\"\n\njulia> result[\"b\"][\"d\"]\n\"d d\"\n\njulia> result[\"b\"][\"e\"]\n\"f short\"\n\njulia> parse_bibtex(\"@book\")\nERROR: Expected { on line 1\n[...]\n\njulia> parse_bibtex(\"@book@\")\nERROR: Expected { on line 1\n[...]\n\n\n\n" }, {