BibFields Class Reference

Entry Fields. More...

Public Types
enum	ID
	Predefined field IDs.

Static Public Member Functions
static const std::string &	fieldName (BibFields::ID fieldID)
	returns the fieldName corresponding to this ID (or an empty string if this ID is unknown).
static BibFields::ID	addField (const std::string &fieldName)
	returns the ID corresponding to this fieldName (after adding it if neeeded).
static BibFields::ID	fieldID (const std::string &fieldName, bool abridged)
	returns the ID corresponding to this fieldName. More...

Detailed Description

Entry Fields.

Entries can contain any field. Regular BibTex fields, common biblatex fields and special bibtohtml fields are predefined (see macro BIBFIELDS). Other fields found in BibTex files are automatically added.

Specific fields or behaviors:

• abstract, keywords, award : corresponding text. By default the abstract and the keywords are displayed on demand by clicking on a hyperlink.
• image video, link, poster, project, slides, software: corresponding URLs.
• bibcite: BibTex citation (set automatically).
• bibkey: BibTex key (set automatically). Not to be confused with the key field.
• media: unified "media" of the entry (set automatically). Depending on the entry type, this field will contain the value of journal (for @article), booktitle (for @inproceedings or similar) or title.
• rank: entry rank, can serve to sort entries according to their rank. Values can be "0", "1", "2", etc. or "?" (unknown). This field will be set automatically if a set of "knownmedia" (see BibTypes) is provided.

Depending on the printing style (see BibStyle), fields can be displayed as images keywords, or plain text. They can also be displayed on demand (using javascript).

Member Function Documentation

BibFields::ID BibFields::fieldID ( const std::string &  fieldName, bool  abridged  )

static

returns the ID corresponding to this fieldName.

The name can be abridged if abridged is true. Returns BibField::none (i.e. 0) if fieldName is unknown.

---

The documentation for this class was generated from the following files:

• bibdefs.hpp
• bibdefs.cpp