mirrors
/
BibTeX.jl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

build based on 3f6dfb2

This commit is contained in:
autodocs 2017-08-05 15:56:40 +00:00
parent b641f2a099
commit b6a8904a67
2 changed files with 27 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
latest/index.html
View File

@ -1,6 +1,6 @@
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · BibTeX.jl</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link href="assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>BibTeX.jl</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" action="search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li class="current"><a class="toctext" href="index.html">Home</a><ul class="internal"></ul></li></ul></nav><article id="docs"><header><nav><ul><li><a href="index.html">Home</a></li></ul><a class="edit-page" href="https://github.com/bramtayl/BibTeX.jl/tree/54ecf83c403d47686d1207c7fcfeb9dba47b76d1/docs/src/index.md"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Home</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="BibTeX.jl-1" href="#BibTeX.jl-1">BibTeX.jl</a></h1><ul><li><a href="index.html#BibTeX.Bibliography-Tuple{String}"><code>BibTeX.Bibliography</code></a></li><li><a href="index.html#BibTeX.Citation"><code>BibTeX.Citation</code></a></li><li><a href="index.html#BibTeX.parse_bibtex-Tuple{Any}"><code>BibTeX.parse_bibtex</code></a></li></ul><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="BibTeX.Citation" href="#BibTeX.Citation"><code>BibTeX.Citation</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Citation{S}(data::Dict{String,String})</code></pre><p>A bibliography item in a bibTeX database, based on a dictionary of strings to values. It is parameterized by a symbol <code>S</code> giving the type of the item (<code>:article</code> etcetera). A <code>b::Citation</code> supports <code>b[key]</code> access to retrieve the data and in general acts like a dictionary from <code>String</code> to <code>String</code>.</p></div><a class="source-link" target="_blank" href="https://github.com/bramtayl/BibTeX.jl/tree/54ecf83c403d47686d1207c7fcfeb9dba47b76d1/src/citation.jl#L1-L9">source</a><br/></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="BibTeX.Bibliography-Tuple{String}" href="#BibTeX.Bibliography-Tuple{String}"><code>BibTeX.Bibliography</code></a> — <span class="docstring-category">Method</span>.</div><div><pre><code class="language-none">Bibliography(bibtex::String) <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · BibTeX.jl</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link href="assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>BibTeX.jl</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" action="search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li class="current"><a class="toctext" href="index.html">Home</a><ul class="internal"></ul></li></ul></nav><article id="docs"><header><nav><ul><li><a href="index.html">Home</a></li></ul><a class="edit-page" href="https://github.com/bramtayl/BibTeX.jl/tree/3f6dfb22d1545a0524240cf5033ab405ce63537a/docs/src/index.md"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Home</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="BibTeX.jl-1" href="#BibTeX.jl-1">BibTeX.jl</a></h1><ul><li><a href="index.html#BibTeX.Bibliography-Tuple{String}"><code>BibTeX.Bibliography</code></a></li><li><a href="index.html#BibTeX.Citation"><code>BibTeX.Citation</code></a></li><li><a href="index.html#BibTeX.parse_bibtex-Tuple{Any}"><code>BibTeX.parse_bibtex</code></a></li><li><a href="index.html#BibTeX.search_latexdirective"><code>BibTeX.search_latexdirective</code></a></li><li><a href="index.html#BibTeX.simplify_latex"><code>BibTeX.simplify_latex</code></a></li><li><a href="index.html#BibTeX.striparg"><code>BibTeX.striparg</code></a></li></ul><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="BibTeX.Citation" href="#BibTeX.Citation"><code>BibTeX.Citation</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Citation{S}(data::Dict{String,String})</code></pre><p>A bibliography item in a bibTeX database, based on a dictionary of strings to values. It is parameterized by a symbol <code>S</code> giving the type of the item (<code>:article</code> etcetera). A <code>b::Citation</code> supports <code>b[key]</code> access to retrieve the data and in general acts like a dictionary from <code>String</code> to <code>String</code>.</p></div><a class="source-link" target="_blank" href="https://github.com/bramtayl/BibTeX.jl/tree/3f6dfb22d1545a0524240cf5033ab405ce63537a/src/citation.jl#L1-L9">source</a><br/></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="BibTeX.Bibliography-Tuple{String}" href="#BibTeX.Bibliography-Tuple{String}"><code>BibTeX.Bibliography</code></a> — <span class="docstring-category">Method</span>.</div><div><pre><code class="language-none">Bibliography(bibtex::String)
Bibliography(io::IO)</code></pre><p>Given a string (or IO stream) of bibtex-format bibliography data, parses the data and returns a <code>Dict</code>-like object <code>b::Bibliography</code> that behaves as a dictionary mapping strings to bibliography items <a href="index.html#BibTeX.Citation"><code>Citation</code></a>.</p></div><a class="source-link" target="_blank" href="https://github.com/bramtayl/BibTeX.jl/tree/54ecf83c403d47686d1207c7fcfeb9dba47b76d1/src/bibliography.jl#L6-L14">source</a><br/></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="BibTeX.parse_bibtex-Tuple{Any}" href="#BibTeX.parse_bibtex-Tuple{Any}"><code>BibTeX.parse_bibtex</code></a> — <span class="docstring-category">Method</span>.</div><div><pre><code class="language-none">parse_bibtex(text)</code></pre><p>This is a simple input parser for BibTex. I had trouble finding a standard specification, but I&#39;ve included several features of real BibTex. Returns a preamble (or an empty string) and a dict of dicts.</p><pre><code class="language-julia-repl">julia&gt; using BibTeX: parse_bibtex Bibliography(io::IO)</code></pre><p>Given a string (or IO stream) of bibtex-format bibliography data, parses the data and returns a <code>Dict</code>-like object <code>b::Bibliography</code> that behaves as a dictionary mapping strings to bibliography items <a href="index.html#BibTeX.Citation"><code>Citation</code></a>.</p></div><a class="source-link" target="_blank" href="https://github.com/bramtayl/BibTeX.jl/tree/3f6dfb22d1545a0524240cf5033ab405ce63537a/src/bibliography.jl#L6-L14">source</a><br/></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="BibTeX.parse_bibtex-Tuple{Any}" href="#BibTeX.parse_bibtex-Tuple{Any}"><code>BibTeX.parse_bibtex</code></a> — <span class="docstring-category">Method</span>.</div><div><pre><code class="language-none">parse_bibtex(text)</code></pre><p>This is a simple input parser for BibTex. I had trouble finding a standard specification, but I&#39;ve included several features of real BibTex. Returns a preamble (or an empty string) and a dict of dicts.</p><pre><code class="language-julia-repl">julia&gt; using BibTeX: parse_bibtex
julia&gt; preamble, result = parse_bibtex(&quot;&quot;&quot; julia&gt; preamble, result = parse_bibtex(&quot;&quot;&quot;
@preamble{some instructions} @preamble{some instructions}
@ -51,4 +51,4 @@ julia&gt; parse_bibtex(&quot;&quot;&quot;
title = B} title = B}
&quot;&quot;&quot;) &quot;&quot;&quot;)
ERROR: Duplicated field title on line 3 ERROR: Duplicated field title on line 3
[...]</code></pre></div><a class="source-link" target="_blank" href="https://github.com/bramtayl/BibTeX.jl/tree/54ecf83c403d47686d1207c7fcfeb9dba47b76d1/src/parser.jl#L117-L184">source</a><br/></section><footer><hr/></footer></article></body></html> [...]</code></pre></div><a class="source-link" target="_blank" href="https://github.com/bramtayl/BibTeX.jl/tree/3f6dfb22d1545a0524240cf5033ab405ce63537a/src/parser.jl#L117-L184">source</a><br/></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="BibTeX.search_latexdirective" href="#BibTeX.search_latexdirective"><code>BibTeX.search_latexdirective</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">search_latexdirective(string, istart=1, inbrace=false)</code></pre><p>Search for a LaTeX directive \directive{arg} or similar in <code>string</code>, returning <code>(ds, de, ae)</code> such that <code>string[ds:de]</code> gives <code>\directive</code> and <code>string[de+1:ae]</code> gives <code>{arg}</code>. Use <a href="index.html#BibTeX.striparg"><code>striparg</code></a> to remove surrounding braces and whitespace from the <code>arg</code>.</p></div><a class="source-link" target="_blank" href="https://github.com/bramtayl/BibTeX.jl/tree/3f6dfb22d1545a0524240cf5033ab405ce63537a/src/latex.jl#L22-L29">source</a><br/></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="BibTeX.simplify_latex" href="#BibTeX.simplify_latex"><code>BibTeX.simplify_latex</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">simplify_latex(s::AbstractString, extra_directives=BibTeX.text_directives)</code></pre><p>Simplify a LaTeX string <code>s</code> into &quot;plain text&quot; if possible, stripping/converting known LaTeX directives in favor of e.g Unicode.</p><p><code>extra_directives</code> is a dictionary (<code>String=&gt;String</code>) that maps LaTeX directives to replacements. It defaults to <code>BibTeX.text_directives</code>, which simply strips out things like bold and italics. Alternatively, you can pass <code>BibTeX.md_directives</code>, which uses Markdown syntax for such directives.</p></div><a class="source-link" target="_blank" href="https://github.com/bramtayl/BibTeX.jl/tree/3f6dfb22d1545a0524240cf5033ab405ce63537a/src/latex.jl#L312-L322">source</a><br/></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="BibTeX.striparg" href="#BibTeX.striparg"><code>BibTeX.striparg</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">striparg(s, argstart=start(s), argend=endof(s))</code></pre><p>Return the substring of <code>s</code> corresponding to the argument from <code>argstart:argend</code>, stripping leading/trailing whitespace and braces.</p></div><a class="source-link" target="_blank" href="https://github.com/bramtayl/BibTeX.jl/tree/3f6dfb22d1545a0524240cf5033ab405ce63537a/src/latex.jl#L123-L128">source</a><br/></section><footer><hr/></footer></article></body></html>

24
latest/search_index.js
View File

@ -32,6 +32,30 @@ var documenterSearchIndex = {"docs": [
"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" "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_latexdirective",
"page": "Home",
"title": "BibTeX.search_latexdirective",
"category": "Function",
"text": "search_latexdirective(string, istart=1, inbrace=false)\n\nSearch for a LaTeX directive \\directive{arg} or similar in string, returning (ds, de, ae) such that string[ds:de] gives \\directive and string[de+1:ae] gives {arg}. Use striparg to remove surrounding braces and whitespace from the arg.\n\n\n\n"
},
{
"location": "index.html#BibTeX.simplify_latex",
"page": "Home",
"title": "BibTeX.simplify_latex",
"category": "Function",
"text": "simplify_latex(s::AbstractString, extra_directives=BibTeX.text_directives)\n\nSimplify a LaTeX string s 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.md_directives, which uses Markdown syntax for such directives.\n\n\n\n"
},
{
"location": "index.html#BibTeX.striparg",
"page": "Home",
"title": "BibTeX.striparg",
"category": "Function",
"text": "striparg(s, argstart=start(s), argend=endof(s))\n\nReturn the substring of s corresponding to the argument from argstart:argend, stripping leading/trailing whitespace and braces.\n\n\n\n"
},
{ {
"location": "index.html#BibTeX.jl-1", "location": "index.html#BibTeX.jl-1",
"page": "Home", "page": "Home",