]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCitation.cpp
Update sk.po
[lyx.git] / src / insets / InsetCitation.cpp
index 1ef7e0fb000ff455dae48cc1748ab380d2d2aa6b..1d079c26cd1487bddcadeefa718e46584776fbae 100644 (file)
 #include "BufferParams.h"
 #include "BufferView.h"
 #include "DispatchResult.h"
+#include "FuncCode.h"
+#include "FuncRequest.h"
+#include "FuncStatus.h"
 #include "LaTeXFeatures.h"
 #include "output_xhtml.h"
 #include "ParIterator.h"
+#include "texstream.h"
 #include "TocBackend.h"
 
 #include "support/debug.h"
 #include "support/lstrings.h"
 
 #include <algorithm>
+#include <climits>
 
 using namespace std;
 using namespace lyx::support;
 
 namespace lyx {
 
-ParamInfo InsetCitation::param_info_;
-
-
 InsetCitation::InsetCitation(Buffer * buf, InsetCommandParams const & p)
        : InsetCommand(buf, p)
-{}
+{
+       buffer().removeBiblioTempFiles();
+}
+
+
+InsetCitation::~InsetCitation()
+{
+       if (isBufferLoaded())
+               /* We do not use buffer() because Coverity believes that this
+                * may throw an exception. Actually this code path is not
+                * taken when buffer_ == 0 */
+               buffer_->removeBiblioTempFiles();
+}
+
+
+// May well be over-ridden when session settings are loaded
+// in GuiCitation. Unfortunately, that will not happen until
+// such a dialog is created.
+bool InsetCitation::last_literal = true;
 
 
 ParamInfo const & InsetCitation::findInfo(string const & /* cmdName */)
 {
-       // standard cite does only take one argument if jurabib is
-       // not used, but jurabib extends this to two arguments, so
+       static ParamInfo param_info_;
+
+       // standard cite does only take one argument, but biblatex, jurabib
+       // and natbib extend this to two arguments, so
        // we have to allow both here. InsetCitation takes care that
        // LaTeX output is nevertheless correct.
        if (param_info_.empty()) {
-               param_info_.add("after", ParamInfo::LATEX_OPTIONAL);
-               param_info_.add("before", ParamInfo::LATEX_OPTIONAL);
+               param_info_.add("after", ParamInfo::LATEX_OPTIONAL,
+                               ParamInfo::HANDLING_LATEXIFY);
+               param_info_.add("before", ParamInfo::LATEX_OPTIONAL,
+                               ParamInfo::HANDLING_LATEXIFY);
                param_info_.add("key", ParamInfo::LATEX_REQUIRED);
+               param_info_.add("pretextlist", ParamInfo::LATEX_OPTIONAL,
+                               ParamInfo::HANDLING_LATEXIFY);
+               param_info_.add("posttextlist", ParamInfo::LATEX_OPTIONAL,
+                               ParamInfo::HANDLING_LATEXIFY);
+               param_info_.add("literal", ParamInfo::LYX_INTERNAL);
        }
        return param_info_;
 }
 
 
-namespace {
+// We allow any command here, since we fall back to cite
+// anyway if a command is not allowed by a style
+bool InsetCitation::isCompatibleCommand(string const &)
+{
+       return true;
+}
 
-vector<string> const init_possible_cite_commands()
+
+CitationStyle InsetCitation::getCitationStyle(BufferParams const & bp, string const & input,
+                                 vector<CitationStyle> const & valid_styles) const
 {
-       char const * const possible[] = {
-               "cite", "nocite", "citet", "citep", "citealt", "citealp",
-               "citeauthor", "citeyear", "citeyearpar",
-               "citet*", "citep*", "citealt*", "citealp*", "citeauthor*",
-               "Citet",  "Citep",  "Citealt",  "Citealp",  "Citeauthor",
-               "Citet*", "Citep*", "Citealt*", "Citealp*", "Citeauthor*",
-               "fullcite",
-               "footcite", "footcitet", "footcitep", "footcitealt",
-               "footcitealp", "footciteauthor", "footciteyear", "footciteyearpar",
-               "citefield", "citetitle", "cite*"
-       };
-       size_t const size_possible = sizeof(possible) / sizeof(possible[0]);
-
-       return vector<string>(possible, possible + size_possible);
+       CitationStyle cs = valid_styles[0];
+       cs.forceUpperCase = false;
+       cs.hasStarredVersion = false;
+
+       string normalized_input = input;
+       string::size_type const n = input.size() - 1;
+       if (isUpperCase(input[0]))
+               normalized_input[0] = lowercase(input[0]);
+       if (input[n] == '*')
+               normalized_input = normalized_input.substr(0, n);
+
+       string const alias = bp.getCiteAlias(normalized_input);
+       if (!alias.empty())
+               normalized_input = alias;
+
+       vector<CitationStyle>::const_iterator it  = valid_styles.begin();
+       vector<CitationStyle>::const_iterator end = valid_styles.end();
+       for (; it != end; ++it) {
+               CitationStyle this_cs = *it;
+               if (this_cs.name == normalized_input) {
+                       cs = *it;
+                       break;
+               }
+       }
+
+       return cs;
 }
 
 
-vector<string> const & possibleCiteCommands()
+void InsetCitation::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-       static vector<string> const possible = init_possible_cite_commands();
-       return possible;
+       switch (cmd.action()) {
+       case LFUN_INSET_MODIFY: {
+               buffer().removeBiblioTempFiles();
+               cache.recalculate = true;
+               if (cmd.getArg(0) == "toggleparam") {
+                       string cmdname = getCmdName();
+                       string const alias =
+                               buffer().masterParams().getCiteAlias(cmdname);
+                       if (!alias.empty())
+                               cmdname = alias;
+                       string const par = cmd.getArg(1);
+                       string newcmdname = cmdname;
+                       if (par == "star") {
+                               if (suffixIs(cmdname, "*"))
+                                       newcmdname = rtrim(cmdname, "*");
+                               else
+                                       newcmdname = cmdname + "*";
+                       } else if (par == "casing") {
+                               if (isUpperCase(cmdname[0]))
+                                       newcmdname[0] = lowercase(cmdname[0]);
+                               else
+                                       newcmdname[0] = uppercase(newcmdname[0]);
+                       }
+                       cmd = FuncRequest(LFUN_INSET_MODIFY, "changetype " + newcmdname);
+               }
+       }
+               // fall through
+       default:
+               InsetCommand::doDispatch(cur, cmd);
+       }
 }
 
 
-} // anon namespace
+bool InsetCitation::getStatus(Cursor & cur, FuncRequest const & cmd,
+       FuncStatus & status) const
+{
+       switch (cmd.action()) {
+       // Handle the alias case
+       case LFUN_INSET_MODIFY:
+               if (cmd.getArg(0) == "changetype") {
+                       string cmdname = getCmdName();
+                       string const alias =
+                               buffer().masterParams().getCiteAlias(cmdname);
+                       if (!alias.empty())
+                               cmdname = alias;
+                       if (suffixIs(cmdname, "*"))
+                               cmdname = rtrim(cmdname, "*");
+                       string const newtype = cmd.getArg(1);
+                       status.setEnabled(isCompatibleCommand(newtype));
+                       status.setOnOff(newtype == cmdname);
+               }
+               if (cmd.getArg(0) == "toggleparam") {
+                       string cmdname = getCmdName();
+                       string const alias =
+                               buffer().masterParams().getCiteAlias(cmdname);
+                       if (!alias.empty())
+                               cmdname = alias;
+                       vector<CitationStyle> citation_styles =
+                               buffer().masterParams().citeStyles();
+                       CitationStyle cs = getCitationStyle(buffer().masterParams(),
+                                                           cmdname, citation_styles);
+                       if (cmd.getArg(1) == "star") {
+                               status.setEnabled(cs.hasStarredVersion);
+                               status.setOnOff(suffixIs(cmdname, "*"));
+                       }
+                       else if (cmd.getArg(1) == "casing") {
+                               status.setEnabled(cs.forceUpperCase);
+                               status.setOnOff(isUpperCase(cmdname[0]));
+                       }
+               }
+               return true;
+       default:
+               return InsetCommand::getStatus(cur, cmd, status);
+       }
+}
 
 
-bool InsetCitation::isCompatibleCommand(string const & cmd)
+bool InsetCitation::addKey(string const & key)
 {
-       vector<string> const & possibles = possibleCiteCommands();
-       vector<string>::const_iterator const end = possibles.end();
-       return find(possibles.begin(), end, cmd) != end;
+       docstring const ukey = from_utf8(key);
+       docstring const & curkeys = getParam("key");
+       if (curkeys.empty()) {
+               setParam("key", ukey);
+               cache.recalculate = true;
+               return true;
+       }
+
+       vector<docstring> keys = getVectorFromString(curkeys);
+       vector<docstring>::const_iterator it = keys.begin();
+       vector<docstring>::const_iterator en = keys.end();
+       for (; it != en; ++it) {
+               if (*it == ukey) {
+                       LYXERR0("Key " << key << " already present.");
+                       return false;
+               }
+       }
+       keys.push_back(ukey);
+       setParam("key", getStringFromVector(keys));
+       cache.recalculate = true;
+       return true;
 }
 
 
@@ -114,105 +249,99 @@ docstring InsetCitation::toolTip(BufferView const & bv, int, int) const
        if (key.empty())
                return _("No citations selected!");
 
+       CiteItem ci;
+       ci.richtext = true;
        vector<docstring> keys = getVectorFromString(key);
-       vector<docstring>::const_iterator it = keys.begin();
-       vector<docstring>::const_iterator en = keys.end();
+       if (keys.size() == 1)
+               return bi.getInfo(keys[0], buffer(), ci);
+
        docstring tip;
-       for (; it != en; ++it) {
-               docstring const key_info = bi.getInfo(*it, buffer());
+       tip += "<ol>";
+       int count = 0;
+       for (docstring const & key : keys) {
+               docstring const key_info = bi.getInfo(key, buffer(), ci);
+               // limit to reasonable size.
+               if (count > 9 && keys.size() > 11) {
+                       tip.push_back(0x2026);// HORIZONTAL ELLIPSIS
+                       tip += "<p>"
+                               + bformat(_("+ %1$d more entries."), int(keys.size() - count))
+                               + "</p>";
+                       break;
+               }
                if (key_info.empty())
                        continue;
-               if (!tip.empty())
-                       tip += "\n";
-               tip += wrap(key_info, -4);
+               tip += "<li>" + key_info + "</li>";
+               ++count;
        }
+       tip += "</ol>";
        return tip;
 }
 
 
 namespace {
-       
-// FIXME See the header for the issue.
-string defaultCiteCommand(CiteEngine engine)
-{
-       string str;
-       switch (engine) {
-               case ENGINE_BASIC:
-                       str = "cite";
-                       break;
-               case ENGINE_NATBIB_AUTHORYEAR:
-                       str = "citet";
-                       break;
-               case ENGINE_NATBIB_NUMERICAL:
-                       str = "citep";
-                       break;
-               case ENGINE_JURABIB:
-                       str = "cite";
-                       break;
-       }
-       return str;
-}
 
-       
-string asValidLatexCommand(string const & input, CiteEngine const engine)
+CitationStyle asValidLatexCommand(BufferParams const & bp, string const & input,
+                                 vector<CitationStyle> const & valid_styles)
 {
-       string const default_str = defaultCiteCommand(engine);
-       if (!InsetCitation::isCompatibleCommand(input))
-               return default_str;
-
-       string output;
-       switch (engine) {
-               case ENGINE_BASIC:
-                       if (input == "nocite")
-                               output = input;
-                       else
-                               output = default_str;
-                       break;
-
-               case ENGINE_NATBIB_AUTHORYEAR:
-               case ENGINE_NATBIB_NUMERICAL:
-                       if (input == "cite" || input == "citefield"
-                           || input == "citetitle" || input == "cite*")
-                               output = default_str;
-                       else if (prefixIs(input, "foot"))
-                               output = input.substr(4);
-                       else
-                               output = input;
-                       break;
-
-               case ENGINE_JURABIB: {
-                       // Jurabib does not support the 'uppercase' natbib style.
-                       if (input[0] == 'C')
-                               output = string(1, 'c') + input.substr(1);
-                       else
-                               output = input;
-
-                       // Jurabib does not support the 'full' natbib style.
-                       string::size_type const n = output.size() - 1;
-                       if (output != "cite*" && output[n] == '*')
-                               output = output.substr(0, n);
-
+       CitationStyle cs = valid_styles[0];
+       cs.forceUpperCase = false;
+       cs.hasStarredVersion = false;
+
+       string normalized_input = input;
+       string::size_type const n = input.size() - 1;
+       if (isUpperCase(input[0]))
+               normalized_input[0] = lowercase(input[0]);
+       if (input[n] == '*')
+               normalized_input = normalized_input.substr(0, n);
+
+       string const alias = bp.getCiteAlias(normalized_input);
+       if (!alias.empty())
+               normalized_input = alias;
+
+       vector<CitationStyle>::const_iterator it  = valid_styles.begin();
+       vector<CitationStyle>::const_iterator end = valid_styles.end();
+       for (; it != end; ++it) {
+               CitationStyle this_cs = *it;
+               if (this_cs.name == normalized_input) {
+                       cs = *it;
                        break;
                }
        }
 
-       return output;
+       cs.forceUpperCase &= input[0] == uppercase(input[0]);
+       cs.hasStarredVersion &= input[n] == '*';
+
+       return cs;
 }
 
 
-inline docstring wrapCitation(docstring const & key, 
+inline docstring wrapCitation(docstring const & key,
                docstring const & content, bool for_xhtml)
 {
        if (!for_xhtml)
                return content;
        // we have to do the escaping here, because we will ultimately
        // write this as a raw string, so as not to escape the tags.
-       return "<a href='#" + key + "'>" +
+       return "<a href='#LyXCite-" + html::cleanAttr(key) + "'>" +
                        html::htmlize(content, XHTMLStream::ESCAPE_ALL) + "</a>";
 }
 
 } // anonymous namespace
 
+
+map<docstring, docstring> InsetCitation::getQualifiedLists(docstring const p) const
+{
+       vector<docstring> ps =
+               getVectorFromString(p, from_ascii("\t"));
+       std::map<docstring, docstring> res;
+       for (docstring const & s: ps) {
+               docstring key;
+               docstring val = split(s, key, ' ');
+               res[key] = val;
+       }
+       return res;
+}
+
 docstring InsetCitation::generateLabel(bool for_xhtml) const
 {
        docstring label;
@@ -237,193 +366,54 @@ docstring InsetCitation::complexLabel(bool for_xhtml) const
        if (biblist.empty())
                return docstring();
 
-       // the natbib citation-styles
-       // CITET:       author (year)
-       // CITEP:       (author,year)
-       // CITEALT:     author year
-       // CITEALP:     author, year
-       // CITEAUTHOR:  author
-       // CITEYEAR:    year
-       // CITEYEARPAR: (year)
-       // jurabib supports these plus
-       // CITE:        author/<before field>
-
-       CiteEngine const engine = buffer().params().citeEngine();
-       // We don't currently use the full or forceUCase fields.
-       string cite_type = asValidLatexCommand(getCmdName(), engine);
-       if (cite_type[0] == 'C')
-               // If we were going to use them, this would mean ForceUCase
-               cite_type = string(1, 'c') + cite_type.substr(1);
-       if (cite_type[cite_type.size() - 1] == '*')
-               // and this would mean FULL
-               cite_type = cite_type.substr(0, cite_type.size() - 1);
-
-       docstring const & before = getParam("before");
-       docstring before_str;
-       if (!before.empty()) {
-               // In CITET and CITEALT mode, the "before" string is
-               // attached to the label associated with each and every key.
-               // In CITEP, CITEALP and CITEYEARPAR mode, it is attached
-               // to the front of the whole only.
-               // In other modes, it is not used at all.
-               if (cite_type == "citet" ||
-                   cite_type == "citealt" ||
-                   cite_type == "citep" ||
-                   cite_type == "citealp" ||
-                   cite_type == "citeyearpar")
-                       before_str = before + ' ';
-               // In CITE (jurabib), the "before" string is used to attach
-               // the annotator (of legal texts) to the author(s) of the
-               // first reference.
-               else if (cite_type == "cite")
-                       before_str = '/' + before;
-       }
-
-       docstring const & after = getParam("after");
-       docstring after_str;
-       // The "after" key is appended only to the end of the whole.
-       if (cite_type == "nocite")
-               after_str =  " (" + _("not cited") + ')';
-       else if (!after.empty()) {
-               after_str = ", " + after;
-       }
+       docstring const & key = getParam("key");
+       if (key.empty())
+               return _("No citations selected!");
 
-       // One day, these might be tunable (as they are in BibTeX).
-       char op, cp;    // opening and closing parenthesis.
-       const char * sep;       // punctuation mark separating citation entries.
-       if (engine == ENGINE_BASIC) {
-               op  = '[';
-               cp  = ']';
-               sep = ",";
-       } else {
-               op  = '(';
-               cp  = ')';
-               sep = ";";
-       }
+       string cite_type = getCmdName();
+       bool const uppercase = isUpperCase(cite_type[0]);
+       if (uppercase)
+               cite_type[0] = lowercase(cite_type[0]);
+       bool const starred = (cite_type[cite_type.size() - 1] == '*');
+       if (starred)
+               cite_type = cite_type.substr(0, cite_type.size() - 1);
 
-       docstring const op_str = ' ' + docstring(1, op);
-       docstring const cp_str = docstring(1, cp) + ' ';
-       docstring const sep_str = from_ascii(sep) + ' ';
+       // handle alias
+       string const alias = buf.masterParams().getCiteAlias(cite_type);
+       if (!alias.empty())
+               cite_type = alias;
 
+       // FIXME: allow to add cite macros
+       /*
+       buffer().params().documentClass().addCiteMacro("!textbefore", to_utf8(before));
+       buffer().params().documentClass().addCiteMacro("!textafter", to_utf8(after));
+       */
        docstring label;
-       vector<docstring> keys = getVectorFromString(getParam("key"));
-       vector<docstring>::const_iterator it  = keys.begin();
-       vector<docstring>::const_iterator end = keys.end();
-       for (; it != end; ++it) {
-               // get the bibdata corresponding to the key
-               docstring const author = biblist.getAbbreviatedAuthor(*it);
-               docstring const year = biblist.getYear(*it, for_xhtml);
-               docstring const citenum = for_xhtml ? biblist.getCiteNumber(*it) : *it;
-
-               if (author.empty() || year.empty())
-                       // We can't construct a "complex" label without that info.
-                       // So fail safely.
-                       return docstring();
-
-               // authors1/<before>;  ... ;
-               //  authors_last, <after>
-               if (cite_type == "cite") {
-                       if (engine == ENGINE_BASIC) {
-                               label += wrapCitation(*it, citenum, for_xhtml) + sep_str;
-                       } else if (engine == ENGINE_JURABIB) {
-                               if (it == keys.begin())
-                                       label += wrapCitation(*it, author, for_xhtml) + before_str + sep_str;
-                               else
-                                       label += wrapCitation(*it, author, for_xhtml) + sep_str;
-                       }
-               } 
-               // nocite
-               else if (cite_type == "nocite") {
-                       label += *it + sep_str;
-               } 
-               // (authors1 (<before> year);  ... ;
-               //  authors_last (<before> year, <after>)
-               else if (cite_type == "citet") {
-                       switch (engine) {
-                       case ENGINE_NATBIB_AUTHORYEAR:
-                               label += author + op_str + before_str +
-                                       wrapCitation(*it, year, for_xhtml) + cp + sep_str;
-                               break;
-                       case ENGINE_NATBIB_NUMERICAL:
-                               label += author + op_str + before_str + 
-                                       wrapCitation(*it, citenum, for_xhtml) + cp + sep_str;
-                               break;
-                       case ENGINE_JURABIB:
-                               label += before_str + author + op_str +
-                                       wrapCitation(*it, year, for_xhtml) + cp + sep_str;
-                               break;
-                       case ENGINE_BASIC:
-                               break;
-                       }
-               } 
-               // author, year; author, year; ...      
-               else if (cite_type == "citep" ||
-                          cite_type == "citealp") {
-                       if (engine == ENGINE_NATBIB_NUMERICAL) {
-                               label += wrapCitation(*it, citenum, for_xhtml) + sep_str;
-                       } else {
-                               label += wrapCitation(*it, author + ", " + year, for_xhtml) + sep_str;
-                       }
-
-               } 
-               // (authors1 <before> year;
-               //  authors_last <before> year, <after>)
-               else if (cite_type == "citealt") {
-                       switch (engine) {
-                       case ENGINE_NATBIB_AUTHORYEAR:
-                               label += author + ' ' + before_str +
-                                       wrapCitation(*it, year, for_xhtml) + sep_str;
-                               break;
-                       case ENGINE_NATBIB_NUMERICAL:
-                               label += author + ' ' + before_str + '#' + 
-                                       wrapCitation(*it, citenum, for_xhtml) + sep_str;
-                               break;
-                       case ENGINE_JURABIB:
-                               label += before_str + 
-                                       wrapCitation(*it, author + ' ' + year, for_xhtml) + sep_str;
-                               break;
-                       case ENGINE_BASIC:
-                               break;
-                       }
-
-               
-               } 
-               // author; author; ...
-               else if (cite_type == "citeauthor") {
-                       label += wrapCitation(*it, author, for_xhtml) + sep_str;
-               }
-               // year; year; ...
-               else if (cite_type == "citeyear" ||
-                          cite_type == "citeyearpar") {
-                       label += wrapCitation(*it, year, for_xhtml) + sep_str;
-               }
-       }
-       label = rtrim(rtrim(label), sep);
-
-       if (!after_str.empty()) {
-               if (cite_type == "citet") {
-                       // insert "after" before last ')'
-                       label.insert(label.size() - 1, after_str);
-               } else {
-                       bool const add =
-                               !(engine == ENGINE_NATBIB_NUMERICAL &&
-                                 (cite_type == "citeauthor" ||
-                                  cite_type == "citeyear"));
-                       if (add)
-                               label += after_str;
-               }
-       }
-
-       if (!before_str.empty() && (cite_type == "citep" ||
-                                   cite_type == "citealp" ||
-                                   cite_type == "citeyearpar")) {
-               label = before_str + label;
+       vector<docstring> keys = getVectorFromString(key);
+       CitationStyle cs = getCitationStyle(buffer().masterParams(),
+                                           cite_type, buffer().masterParams().citeStyles());
+       bool const qualified = cs.hasQualifiedList
+               && (keys.size() > 1
+                   || !getParam("pretextlist").empty()
+                   || !getParam("posttextlist").empty());
+       map<docstring, docstring> pres = getQualifiedLists(getParam("pretextlist"));
+       map<docstring, docstring> posts = getQualifiedLists(getParam("posttextlist"));
+
+       CiteItem ci;
+       ci.textBefore = getParam("before");
+       ci.textAfter = getParam("after");
+       ci.forceUpperCase = uppercase;
+       ci.Starred = starred;
+       ci.max_size = UINT_MAX;
+       ci.isQualified = qualified;
+       ci.pretexts = pres;
+       ci.posttexts = posts;
+       if (for_xhtml) {
+               ci.max_key_size = UINT_MAX;
+               ci.context = CiteItem::Export;
        }
-
-       if (cite_type == "citep" || cite_type == "citeyearpar" || 
-           (cite_type == "cite" && engine == ENGINE_BASIC) )
-               label = op + label + cp;
-
+       ci.richtext = for_xhtml;
+       label = biblist.getLabel(keys, buffer(), cite_type, ci);
        return label;
 }
 
@@ -459,44 +449,43 @@ docstring InsetCitation::screenLabel() const
 
 void InsetCitation::updateBuffer(ParIterator const &, UpdateType)
 {
-       CiteEngine const engine = buffer().params().citeEngine();
-       if (cache.params == params() && cache.engine == engine)
+       if (!cache.recalculate && buffer().citeLabelsValid())
                return;
-
-       // The label has changed, so we have to re-create it.
+       // The label may have changed, so we have to re-create it.
        docstring const glabel = generateLabel();
-
-       unsigned int const maxLabelChars = 45;
-
-       docstring label = glabel;
-       if (label.size() > maxLabelChars) {
-               label.erase(maxLabelChars - 3);
-               label += "...";
-       }
-
-       cache.engine  = engine;
-       cache.params = params();
+       cache.recalculate = false;
        cache.generated_label = glabel;
-       cache.screen_label = label;
+       unsigned int const maxLabelChars = 45;
+       cache.screen_label = glabel.substr(0, maxLabelChars + 1);
+       support::truncateWithEllipsis(cache.screen_label, maxLabelChars);
 }
 
 
-void InsetCitation::addToToc(DocIterator const & cpit)
+void InsetCitation::addToToc(DocIterator const & cpit, bool output_active,
+                                                        UpdateType, TocBackend & backend) const
 {
        // NOTE
-       // XHTML output uses the TOC to collect the citations
-       // from the document. So if this gets changed, then we
-       // will need to change how the citations are collected.
+       // BiblioInfo::collectCitedEntries() uses the TOC to collect the citations
+       // from the document. It is used indirectly, via BiblioInfo::makeCitationLables,
+       // by both XHTML and plaintext output. So, if we change what goes into the TOC,
+       // then we will also need to change that routine.
        docstring const tocitem = getParam("key");
-       Toc & toc = buffer().tocBackend().toc("citation");
-       toc.push_back(TocItem(cpit, 0, tocitem));
+       TocBuilder & b = backend.builder("citation");
+       b.pushItem(cpit, tocitem, output_active);
+       b.pop();
 }
 
 
-int InsetCitation::plaintext(odocstream & os, OutputParams const &) const
+int InsetCitation::plaintext(odocstringstream & os,
+       OutputParams const &, size_t) const
 {
-       os << cache.generated_label;
-       return cache.generated_label.size();
+       string const & cmd = getCmdName();
+       if (cmd == "nocite")
+               return 0;
+
+       docstring const label = generateLabel(false);
+       os << label;
+       return label.size();
 }
 
 
@@ -542,66 +531,110 @@ docstring InsetCitation::xhtml(XHTMLStream & xs, OutputParams const &) const
 
 void InsetCitation::toString(odocstream & os) const
 {
-       plaintext(os, OutputParams(0));
+       odocstringstream ods;
+       plaintext(ods, OutputParams(0));
+       os << ods.str();
+}
+
+
+void InsetCitation::forOutliner(docstring & os, size_t const, bool const) const
+{
+       os += screenLabel();
 }
 
 
 // Have to overwrite the default InsetCommand method in order to check that
 // the \cite command is valid. Eg, the user has natbib enabled, inputs some
 // citations and then changes his mind, turning natbib support off. The output
-// should revert to \cite[]{}
-int InsetCitation::latex(odocstream & os, OutputParams const & runparams) const
+// should revert to the default citation command as provided by the citation
+// engine, e.g. \cite[]{} for the basic engine.
+void InsetCitation::latex(otexstream & os, OutputParams const & runparams) const
 {
-       CiteEngine cite_engine = buffer().params().citeEngine();
-       BiblioInfo const & bi = buffer().masterBibInfo();
+       // When this is a child compiled on its own, we use the childs
+       // own bibinfo, else the master's
+       BiblioInfo const & bi = runparams.is_child
+                       ? buffer().masterBibInfo() : buffer().bibInfo();
+       docstring const key = getParam("key");
+       // "keyonly" command: output the plain key and stop.
+       if (getCmdName() == "keyonly") {
+               // Special command to only return the key
+               if (!bi.isBibtex(getParam("key")))
+                       // escape chars with bibitems
+                       os << escape(cleanupWhitespace(key));
+               else
+                       os << cleanupWhitespace(key);
+               return;
+       }
+       vector<CitationStyle> citation_styles = buffer().masterParams().citeStyles();
+       CitationStyle cs = asValidLatexCommand(buffer().masterParams(),
+                                              getCmdName(), citation_styles);
        // FIXME UNICODE
-       docstring const cite_str = from_utf8(
-               asValidLatexCommand(getCmdName(), cite_engine));
+       docstring const cite_str = from_utf8(citationStyleToString(cs, true));
 
-       if (runparams.inulemcmd)
+       // check if we have to do a qualified list
+       vector<docstring> keys = getVectorFromString(cleanupWhitespace(key));
+       bool const qualified = cs.hasQualifiedList
+               && (!getParam("pretextlist").empty()
+                   || !getParam("posttextlist").empty());
+
+       if (runparams.inulemcmd > 0)
                os << "\\mbox{";
 
        os << "\\" << cite_str;
 
-       docstring const & before = getParam("before");
-       docstring const & after  = getParam("after");
-       if (!before.empty() && cite_engine != ENGINE_BASIC)
-               os << '[' << before << "][" << after << ']';
-       else if (!after.empty())
-               os << '[' << after << ']';
+       if (qualified)
+               os << "s";
+
+       ParamInfo const & pinfo = findInfo(string());
+       docstring before = params().prepareCommand(runparams, getParam("before"),
+                                                  pinfo["before"].handling());
+       docstring after = params().prepareCommand(runparams, getParam("after"),
+                                                  pinfo["after"].handling());
+       if (!before.empty() && cs.textBefore) {
+               if (qualified)
+                       os << '(' << protectArgument(before, '(', ')')
+                          << ")(" << protectArgument(after, '(', ')') << ')';
+               else
+                       os << '[' << protectArgument(before) << "]["
+                          << protectArgument(after) << ']';
+       } else if (!after.empty() && cs.textAfter) {
+               if (qualified)
+                       os << '(' << protectArgument(after, '(', ')') << ')';
+               else
+                       os << '[' << protectArgument(after) << ']';
+       }
 
-       if (!bi.isBibtex(getParam("key")))
+       if (!bi.isBibtex(key))
                // escape chars with bibitems
-               os << '{' << escape(cleanupWhitespace(getParam("key"))) << '}';
-       else
-               os << '{' << cleanupWhitespace(getParam("key")) << '}';
+               os << '{' << escape(cleanupWhitespace(key)) << '}';
+       else {
+               if (qualified) {
+                       map<docstring, docstring> pres = getQualifiedLists(getParam("pretextlist"));
+                       map<docstring, docstring> posts = getQualifiedLists(getParam("posttextlist"));
+                       for (docstring const & k: keys) {
+                               docstring bef = params().prepareCommand(runparams, pres[k],
+                                                  pinfo["pretextlist"].handling());
+                               docstring aft = params().prepareCommand(runparams, posts[k],
+                                                  pinfo["posttextlist"].handling());
+                               if (!bef.empty())
+                                       os << '[' << protectArgument(bef)
+                                          << "][" << protectArgument(aft) << ']';
+                               else if (!aft.empty())
+                                       os << '[' << protectArgument(aft) << ']';
+                               os << '{' << k << '}';
+                       }
+               } else
+                       os << '{' << cleanupWhitespace(key) << '}';
+       }
 
        if (runparams.inulemcmd)
                os << "}";
-
-       return 0;
-}
-
-
-void InsetCitation::validate(LaTeXFeatures & features) const
-{
-       switch (features.bufferParams().citeEngine()) {
-       case ENGINE_BASIC:
-               break;
-       case ENGINE_NATBIB_AUTHORYEAR:
-       case ENGINE_NATBIB_NUMERICAL:
-               features.require("natbib");
-               break;
-       case ENGINE_JURABIB:
-               features.require("jurabib");
-               break;
-       }
 }
 
 
-docstring InsetCitation::contextMenuName() const
+string InsetCitation::contextMenuName() const
 {
-       return from_ascii("context-citation");
+       return "context-citation";
 }