Small improvement for bug #7509 as suggested by JMarc

[lyx.git] / src / BiblioInfo.h

diff --git a/src/BiblioInfo.h b/src/BiblioInfo.h
index fffb81c639404ef779864659b803aeaf5b8e1636..efe4bff233948d61e5785959e87a0f2815bd320f 100644 (file)
--- a/src/BiblioInfo.h
+++ b/src/BiblioInfo.h
@@ -117,8 +117,13 @@ private:
        /// material intended only for rich text (HTML) output should be 
        /// wrapped in "{!" and "!}". it will be removed if richtext is
        /// false.
-       docstring expandFormat(std::string const & fmt, 
-                       BibTeXInfo const * const xref, bool richtext) const;
+       /// a simple macro facility is also available. keys that look like
+       /// "%!key%" are substituted with their definition.
+       /// moreover, keys that look like "%_key%" are treated as translatable
+       /// so that things like "pp." and "vol." can be translated.
+       docstring expandFormat(std::string const & fmt,
+                       BibTeXInfo const * const xref, int & counter, 
+                       Buffer const & buf, bool richtext) const;
        /// true if from BibTeX; false if from bibliography environment
        bool is_bibtex_;
        /// the BibTeX key for this entry
@@ -168,6 +173,8 @@ public:
        /// \return formatted BibTeX data associated with a given key.
        /// Empty if no info exists. 
        /// Note that this will retrieve data from the crossref as needed.
+       /// If \param richtext is true, then it will output any richtext tags
+       /// marked in the citation format and escape < and > elsewhere.
        docstring const getInfo(docstring const & key, Buffer const & buf,
                        bool richtext = false) const;
        /// Is this a reference from a bibtex database