BibTeX.jl/latest/search_index.js

var documenterSearchIndex = {"docs": [

{
    "location": "index.html#",
    "page": "Home",
    "title": "Home",
    "category": "page",
    "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: 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\nRepeated fields and keys are not allowed:\n\njulia> using BibTeX: parse_bibtex\n\njulia> parse_bibtex(\"\"\"\n            @book{abook,\n                title = A}\n            @book{abook,\n                title = B}\n        \"\"\")\nERROR: Duplicated id abook on line 3\n[...]\n\njulia> parse_bibtex(\"\"\"\n            @book{abook,\n                title = A,\n                title = B}\n        \"\"\")\nERROR: Duplicated field title on line 3\n[...]\n\n\n\n"
},

{
    "location": "index.html#BibTeX.search_latex_directive",
    "page": "Home",
    "title": "BibTeX.search_latex_directive",
    "category": "Function",
    "text": "search_latex_directive(astring, start_position = 1, inbrace=false)\n\nSearch for a LaTeX directive \\directive{argument} or similar in string, returning (start_position, directive_end, argument_end) such that string[start_position:directive_end] gives \\directive and string[directive_end+1:argument_end] gives {argument}.   Use strip_argument to remove surrounding braces and whitespace from the argument.\n\n\n\n"
},

{
    "location": "index.html#BibTeX.simplify_latex",
    "page": "Home",
    "title": "BibTeX.simplify_latex",
    "category": "Function",
    "text": "simplify_latex(astring, extra_directives)\n\nSimplify a LaTeX string astring into \"plain text\" if possible, stripping/converting known LaTeX directives in favor of e.g Unicode.\n\nextra_directives is a dictionary (String=>String) that maps LaTeX directives to replacements.  It defaults to BibTeX.text_directives, which simply strips out things like bold and italics.  Alternatively, you can pass BibTeX.markdown_directives, which uses Markdown syntax for such directives.\n\n\n\n"
},

{
    "location": "index.html#BibTeX.strip_argument",
    "page": "Home",
    "title": "BibTeX.strip_argument",
    "category": "Function",
    "text": "strip_argument(astring, start_position = start(astring), end_position = endof(astring))\n\nReturn the substring of astring corresponding to the argument from start_position:end_position, stripping leading/trailing whitespace and braces.\n\n\n\n"
},

{
    "location": "index.html#BibTeX.jl-1",
    "page": "Home",
    "title": "BibTeX.jl",
    "category": "section",
    "text": "Modules = [BibTeX]"
},

]}