X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetNomencl.cpp;h=880f0fff52aec86df97c015b3ef9995e00c6af15;hb=83f214d636bff1c7eee6b99eb3293f064591429a;hp=0665ed26bfea89115e369b40486dff75e5883994;hpb=68aa0b5b91c3c7c0b1f410e78d61bd3d266832dc;p=lyx.git diff --git a/src/insets/InsetNomencl.cpp b/src/insets/InsetNomencl.cpp index 0665ed26bf..880f0fff52 100644 --- a/src/insets/InsetNomencl.cpp +++ b/src/insets/InsetNomencl.cpp @@ -24,15 +24,19 @@ #include "FuncStatus.h" #include "InsetIterator.h" #include "InsetList.h" +#include "Language.h" #include "LaTeXFeatures.h" #include "Length.h" #include "LyX.h" #include "OutputParams.h" #include "output_xhtml.h" #include "sgml.h" +#include "texstream.h" +#include "TocBackend.h" #include "frontends/FontMetrics.h" +#include "support/debug.h" #include "support/docstream.h" #include "support/gettext.h" #include "support/lstrings.h" @@ -61,9 +65,12 @@ ParamInfo const & InsetNomencl::findInfo(string const & /* cmdName */) if (param_info_.empty()) { param_info_.add("prefix", ParamInfo::LATEX_OPTIONAL); param_info_.add("symbol", ParamInfo::LATEX_REQUIRED, - ParamInfo::HANDLING_LATEXIFY); + ParamInfo::ParamHandling(ParamInfo::HANDLING_LATEXIFY + | ParamInfo::HANDLING_INDEX_ESCAPE)); param_info_.add("description", ParamInfo::LATEX_REQUIRED, - ParamInfo::HANDLING_LATEXIFY); + ParamInfo::ParamHandling(ParamInfo::HANDLING_LATEXIFY + | ParamInfo::HANDLING_INDEX_ESCAPE)); + param_info_.add("literal", ParamInfo::LYX_INTERNAL); } return param_info_; } @@ -72,12 +79,8 @@ ParamInfo const & InsetNomencl::findInfo(string const & /* cmdName */) docstring InsetNomencl::screenLabel() const { size_t const maxLabelChars = 25; - docstring label = _("Nom: ") + getParam("symbol"); - if (label.size() > maxLabelChars) { - label.erase(maxLabelChars - 3); - label += "..."; - } + support::truncateWithEllipsis(label, maxLabelChars); return label; } @@ -93,6 +96,14 @@ docstring InsetNomencl::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) } +int InsetNomencl::plaintext(odocstringstream & os, + OutputParams const &, size_t) const +{ + docstring s = "[" + getParam("symbol") + ": " + getParam("description") + "]"; + os << s; + return s.size(); +} + int InsetNomencl::docbook(odocstream & os, OutputParams const &) const { @@ -126,6 +137,17 @@ int InsetNomencl::docbookGlossary(odocstream & os) const void InsetNomencl::validate(LaTeXFeatures & features) const { features.require("nomencl"); + InsetCommand::validate(features); +} + + +void InsetNomencl::addToToc(DocIterator const & cpit, bool output_active, + UpdateType, TocBackend & backend) const +{ + docstring const str = getParam("symbol"); + TocBuilder & b = backend.builder("nomencl"); + b.pushItem(cpit, str, output_active); + b.pop(); } @@ -142,7 +164,7 @@ InsetPrintNomencl::InsetPrintNomencl(Buffer * buf, InsetCommandParams const & p) ParamInfo const & InsetPrintNomencl::findInfo(string const & /* cmdName */) { - // The symbol width is set via nomencl's \nomlabelwidth in + // The symbol width is set via nomencl's \nomlabelwidth in // InsetPrintNomencl::latex and not as optional parameter of // \printnomenclature static ParamInfo param_info_; @@ -163,6 +185,96 @@ docstring InsetPrintNomencl::screenLabel() const } +struct NomenclEntry { + NomenclEntry() : par(0) {} + NomenclEntry(docstring s, docstring d, Paragraph const * p) + : symbol(s), desc(d), par(p) + {} + + docstring symbol; + docstring desc; + Paragraph const * par; +}; + + +typedef map EntryMap; + + +docstring InsetPrintNomencl::xhtml(XHTMLStream &, OutputParams const & op) const +{ + shared_ptr toc = buffer().tocBackend().toc("nomencl"); + + EntryMap entries; + Toc::const_iterator it = toc->begin(); + Toc::const_iterator const en = toc->end(); + for (; it != en; ++it) { + DocIterator dit = it->dit(); + Paragraph const & par = dit.innerParagraph(); + Inset const * inset = par.getInset(dit.top().pos()); + if (!inset) + return docstring(); + InsetCommand const * ic = inset->asInsetCommand(); + if (!ic) + return docstring(); + + // FIXME We need a link to the paragraph here, so we + // need some kind of struct. + docstring const symbol = ic->getParam("symbol"); + docstring const desc = ic->getParam("description"); + docstring const prefix = ic->getParam("prefix"); + docstring const sortas = prefix.empty() ? symbol : prefix; + + entries[sortas] = NomenclEntry(symbol, desc, &par); + } + + if (entries.empty()) + return docstring(); + + // we'll use our own stream, because we are going to defer everything. + // that's how we deal with the fact that we're probably inside a standard + // paragraph, and we don't want to be. + odocstringstream ods; + XHTMLStream xs(ods); + + InsetLayout const & il = getLayout(); + string const & tag = il.htmltag(); + docstring toclabel = translateIfPossible(from_ascii("Nomenclature"), + op.local_font->language()->lang()); + + xs << html::StartTag("div", "class='nomencl'") + << html::StartTag(tag, "class='nomencl'") + << toclabel + << html::EndTag(tag) + << html::CR() + << html::StartTag("dl") + << html::CR(); + + EntryMap::const_iterator eit = entries.begin(); + EntryMap::const_iterator const een = entries.end(); + for (; eit != een; ++eit) { + NomenclEntry const & ne = eit->second; + string const parid = ne.par->magicLabel(); + xs << html::StartTag("dt") + << html::StartTag("a", "href='#" + parid + "' class='nomencl'") + << ne.symbol + << html::EndTag("a") + << html::EndTag("dt") + << html::CR() + << html::StartTag("dd") + << ne.desc + << html::EndTag("dd") + << html::CR(); + } + + xs << html::EndTag("dl") + << html::CR() + << html::EndTag("div") + << html::CR(); + + return ods.str(); +} + + void InsetPrintNomencl::doDispatch(Cursor & cur, FuncRequest & cmd) { switch (cmd.action()) { @@ -204,12 +316,6 @@ bool InsetPrintNomencl::getStatus(Cursor & cur, FuncRequest const & cmd, } -docstring InsetPrintNomencl::xhtml(XHTMLStream &, OutputParams const &) const -{ - return docstring(); -} - - // FIXME This should be changed to use the TOC. Perhaps // that could be done when XHTML output is added. int InsetPrintNomencl::docbook(odocstream & os, OutputParams const &) const @@ -258,8 +364,11 @@ docstring nomenclWidest(Buffer const & buffer, OutputParams const & runparams) if (inset->lyxCode() != NOMENCL_CODE) continue; nomencl = static_cast(inset); - docstring const symbol = - nomencl->getParam("symbol"); + // Use proper formatting. We do not escape makeindex chars here + docstring const symbol = nomencl ? + nomencl->params().prepareCommand(runparams, nomencl->getParam("symbol"), + ParamInfo::HANDLING_LATEXIFY) + : docstring(); // This is only an approximation, // but the best we can get. int const wx = use_gui ? @@ -272,32 +381,14 @@ docstring nomenclWidest(Buffer const & buffer, OutputParams const & runparams) } } // return the widest (or an empty) string - if (symb.empty()) - return symb; - - // we have to encode the string properly - docstring latex_symb; - for (size_t n = 0; n < symb.size(); ++n) { - try { - latex_symb += runparams.encoding->latexChar(symb[n]); - } catch (EncodingException & /* e */) { - if (runparams.dryrun) { - latex_symb += "<" + _("LyX Warning: ") - + _("uncodable character") + " '"; - latex_symb += docstring(1, symb[n]); - latex_symb += "'>"; - } - } - } - return latex_symb; + return symb; } -} // namespace anon +} // namespace -int InsetPrintNomencl::latex(odocstream & os, OutputParams const & runparams_in) const +void InsetPrintNomencl::latex(otexstream & os, OutputParams const & runparams_in) const { OutputParams runparams = runparams_in; - int lines = 0; if (getParam("set_width") == "auto") { docstring widest = nomenclWidest(buffer(), runparams); // Set the label width via nomencl's command \nomlabelwidth. @@ -306,7 +397,6 @@ int InsetPrintNomencl::latex(odocstream & os, OutputParams const & runparams_in) os << "\\settowidth{\\nomlabelwidth}{" << widest << "}\n"; - ++lines; } } else if (getParam("set_width") == "custom") { // custom length as optional arg of \printnomenclature @@ -316,17 +406,18 @@ int InsetPrintNomencl::latex(odocstream & os, OutputParams const & runparams_in) << from_ascii(getCmdName()) << '[' << from_ascii(width) - << "]{}"; - return lines; + << "]" + << termcmd; + return; } // output the command \printnomenclature os << getCommand(runparams); - return lines; } void InsetPrintNomencl::validate(LaTeXFeatures & features) const { + features.useInsetLayout(getLayout()); features.require("nomencl"); } @@ -337,9 +428,9 @@ InsetCode InsetPrintNomencl::lyxCode() const } -docstring InsetPrintNomencl::contextMenuName() const +string InsetPrintNomencl::contextMenuName() const { - return from_ascii("context-nomenclprint"); + return "context-nomenclprint"; }