From 662dcb26d71146214acb2f4b7f85db919d4c26ac Mon Sep 17 00:00:00 2001 From: autodocs Date: Sun, 6 Aug 2017 18:40:43 +0000 Subject: [PATCH] build based on 673e30c --- latest/index.html | 6 +++--- latest/search_index.js | 14 +++++++------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/latest/index.html b/latest/index.html index 3604f3e..6839859 100644 --- a/latest/index.html +++ b/latest/index.html @@ -1,6 +1,6 @@ -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
+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}
@@ -51,4 +51,4 @@ julia> parse_bibtex("""
                 title = B}
         """)
 ERROR: Duplicated field title on line 3
-[...]
source
BibTeX.search_latexdirective — Function.
search_latexdirective(string, istart=1, inbrace=false)
Search 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.
source
BibTeX.simplify_latex — Function.
simplify_latex(s::AbstractString, extra_directives=BibTeX.text_directives)
Simplify a LaTeX string s into "plain text" if possible, stripping/converting known LaTeX directives in favor of e.g Unicode.
extra_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.
source
BibTeX.striparg — Function.
striparg(s, argstart=start(s), argend=endof(s))
Return the substring of s corresponding to the argument from argstart:argend, stripping leading/trailing whitespace and braces.
source

+[...]
source
BibTeX.search_latex_directive — Function.
search_latex_directive(astring, start_position = 1, inbrace=false)

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

source
BibTeX.simplify_latex — Function.
simplify_latex(astring, extra_directives)

Simplify a LaTeX string astring into "plain text" if possible, stripping/converting known LaTeX directives in favor of e.g Unicode.

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

source
BibTeX.strip_argument — Function.
strip_argument(astring, start_position = start(astring), end_position = endof(astring))

Return the substring of astring corresponding to the argument from start_position:end_position, stripping leading/trailing whitespace and braces.

source
diff --git a/latest/search_index.js b/latest/search_index.js index 3a8db91..4463af1 100644 --- a/latest/search_index.js +++ b/latest/search_index.js @@ -33,11 +33,11 @@ var documenterSearchIndex = {"docs": [ }, { - "location": "index.html#BibTeX.search_latexdirective", + "location": "index.html#BibTeX.search_latex_directive", "page": "Home", - "title": "BibTeX.search_latexdirective", + "title": "BibTeX.search_latex_directive", "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" + "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" }, { @@ -45,15 +45,15 @@ var documenterSearchIndex = {"docs": [ "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" + "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.striparg", + "location": "index.html#BibTeX.strip_argument", "page": "Home", - "title": "BibTeX.striparg", + "title": "BibTeX.strip_argument", "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" + "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" }, {