const sorting_rules = Dict{Symbol, Vector{Symbol}}(
    :nty  => [:authors;:editors;:title;:date],
    :nyt  => [:authors;:editors;:date;:title],
    :y    => [:date]
);

Implemented sorting rules for bibliography entry sorting.

See also sort_bibliography!.

Publication

A structure to store all the information necessary to web export.

Publication(entry)

Construct a Publication (compatible with web export) from an Entry.

access_to_bibtex!(fields, a)

Transform the how-to-access field to a BibTeX string.

bibtex_to_web(source::String)

Convert a BibTeX file to a web compatible format, specifically for the StaticWebPages.jl package.

date_to_bibtex!(fields, date)

Convert a date to a BibTeX string.

eprint_to_bibtex!(fields, eprint)

Convert eprint information to a BibTeX string.

export_bibtex(target, bibliography)

Export a bibliography to BibTeX format.

export_bibtex(bibliography)

Export a bibliography to a BibTeX string.

export_bibtex(e::Entry)

Export an Entry to a BibTeX string.

export_cff(e::Entry, destination::String="CITATION.cff", version::String="1.2.0", add_preferred::Bool=true) -> Dict{String, Any}

Export an Entry to a CFF file (default is CITATION.cff).

export_web(bibliography::DataStructures.OrderedDict{String,BibInternal.Entry})

Export a bibliography in internal format to the web format of the StaticWebPages.jl package. Also used by DocumenterCitations.jl.

field_to_bibtex(key, value)

Convert an entry field to BibTeX format.

fileio_load(file; check)
fileio_load(stream; check)

The FileIO interface to import a BibTeX file or parse a BibTeX string and convert it to the internal bibliography format. The check keyword argument can be set to :none (or nothing), :warn, or :error to raise appropriate logs.

fileio_save(file, data)
fileio_save(stream, data)

Export a bibliography as a BibTeX string to a file or stream.

import_bibtex(input)

Import a BibTeX file or parse a BibTeX string and convert it to the internal bibliography format. The check keyword argument can be set to :none (or nothing), :warn, or :error to raise appropriate logs.

import_cff(input) -> Entry

Import a CFF file and convert it to the internal bibliography format.

in_to_bibtex!(fields::BibInternal.Fields, i::BibInternal.In)

Convert the "published in" information to a BibTeX string.

int_to_spaces(n)

Make a string of n spaces.

na_if_empty(str::AbstractString) -> AbstractString

Use placeholder value if string param is empty.

name_to_string(name::BibInternal.Name)

Convert a name in an Entry to a string.

names_to_strings(names)

Convert a collection of names to a BibTeX string.

recursive_isless(a::Entry, b::Entry, fields::Tuple{Symbol},
                 depth::Int = 0)

Helper function for sort_bibliography!.

This function allows recursive checking if a < b with descending importance. The importance set for the comparison is defined by the argument fields. This argument is a tuple consisting of symbols denoting the fields of the data type BibInternal.Entry. The ordering implies the importance.

The depth argument is purely for iterating/recursive purposes.

select(
    bibliography::DataStructures.OrderedDict{String,Entry},
    selection::Vector{String};
    complementary::Bool = false
    )

Select a part of a bibliography based on a given selection set of keys. If complementary is true, selection designates which entries will not be kept. By default, complementary is set to false.

sort_bibliography!(
    bibliography::DataStructures.OrderedDict{String,Entry},
    sorting_rule::Symbol = :key
    )

Sorts the bibliography in place.

The sorting order can be set by specifying the sorting_rule. The sorting is implemented via isless() functions. For detailed insight have a look at the isless() implementation of Julia and BibInternal.jl.

Supported symbols for sorting_rule are:

• :key (default): sort by bibliography keys e.g. BibTeX keys or :id
• the sorting rules defined in sorting_rules

xcite(entry)

Format the BibTeX cite output of an Entry for web export.

xfile(entry)

Format the downloadable path of an Entry file for web export.

xin(entry)

Format the appears-in field of an Entry for web export.

xlabels(entry)

Format the labels of an Entry for web export.

xlink(entry)

Format the download link of an Entry for web export.

xnames(entry, editors = false; names = :full)

Format the name of an Entry for web export.

Arguments:

• entry: an entry
• editors: true if the name describes editors
• names: :full (full names) or :last (last names + first name abbreviation)

xtitle(entry

Format the title of an Entry for web export.

xyear(entry)

Format the year of an Entry for web export.