- /// Empty if no info exists.
- /// Note that this will retrieve data from the crossref as needed.
- docstring const getInfo(docstring const & key) const;
- /**
- * "Translates" the available Citation Styles into strings for a given key,
- * either numerical or author-year depending upon the active engine. (See
- * below for those methods.)
- */
- std::vector<docstring> const
- getCiteStrings(docstring const & key, Buffer const & buf) const;
- /**
- * "Translates" the available Citation Styles into strings for a given key.
- * The returned string is displayed by the GUI.
- * [XX] is used in place of the actual reference
- * Eg, the vector will contain: [XX], Jones et al. [XX], ...
- * User supplies :
- * the key,
- * the buffer
- */
- std::vector<docstring> const
- getNumericalStrings(docstring const & key, Buffer const & buf) const;
- /**
- * "Translates" the available Citation Styles into strings for a given key.
- * The returned string is displayed by the GUI.
- * Eg, the vector will contain:
- * Jones et al. (1990), (Jones et al. 1990), Jones et al. 1990, ...
- * User supplies :
- * the key,
- * the buffer
- */
- std::vector<docstring> const
- getAuthorYearStrings(docstring const & key, Buffer const & buf) const;
+ /// Empty if no info exists.
+ /// Note that this will retrieve data from the crossref or xdata as needed.
+ /// \param ci contains further context information, such as if it should
+ /// output any richtext tags marked in the citation format and escape < and >
+ /// elsewhere, and the general output context.
+ docstring const getInfo(docstring const & key, Buffer const & buf,
+ CiteItem const & ci, docstring const & format = docstring()) const;
+ /// \return formatted BibTeX data for citation labels.
+ /// Citation labels can have more than one key.
+ docstring const getLabel(std::vector<docstring> keys, Buffer const & buf,
+ std::string const & style, CiteItem const & ci) const;
+ /// Is this a reference from a bibtex database
+ /// or from a bibliography environment?
+ bool isBibtex(docstring const & key) const;
+ /// A vector holding a pair of lyx cite command and the respective
+ /// output for a given (list of) key(s).
+ typedef std::vector<std::pair<docstring,docstring>> CiteStringMap;
+ /// Translates the available citation styles into strings for a given
+ /// list of keys, using either numerical or author-year style depending
+ /// upon the active engine. The function returns a CiteStringMap with the first
+ /// element being the lyx cite command, the second being the formatted
+ /// citation reference.
+ CiteStringMap const getCiteStrings(
+ std::vector<docstring> const & keys,
+ std::vector<CitationStyle> const & styles, Buffer const & buf,
+ CiteItem const & ci) const;
+ /// A list of BibTeX keys cited in the current document, sorted by
+ /// the last name of the author.
+ /// Make sure you have called collectCitedEntries() before you try to
+ /// use this. You should probably call it just before you use this.
+ std::vector<docstring> const & citedEntries() const
+ { return cited_entries_; }
+ ///
+ void makeCitationLabels(Buffer const & buf);