]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetFloat.cpp
New DocBook support
[lyx.git] / src / insets / InsetFloat.cpp
index d4271da7d0616d6fd5aa9c017c5905a32c6035ad..6644d7169302fa69d714363064ebaac21891c634 100644 (file)
  * Full author contact details are available in file CREDITS.
  */
 
+#include <typeinfo>
+
 #include <config.h>
+#include <output_docbook.h>
+#include <xml.h>
 
-#include "InsetFloat.h"
+#include "InsetBox.h"
 #include "InsetCaption.h"
+#include "InsetFloat.h"
+#include "InsetGraphics.h"
+#include "InsetLabel.h"
 
 #include "Buffer.h"
 #include "BufferParams.h"
 #include "FuncStatus.h"
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
+#include "output_xhtml.h"
 #include "ParIterator.h"
+#include "TexRow.h"
+#include "texstream.h"
 #include "TextClass.h"
+#include "InsetList.h"
 
 #include "support/debug.h"
 #include "support/docstream.h"
@@ -38,6 +49,7 @@
 #include "frontends/Application.h"
 
 using namespace std;
+using namespace lyx::support;
 
 
 namespace lyx {
@@ -47,7 +59,7 @@ namespace lyx {
 // classes we can support similar functionality in other formats
 // (read DocBook).
 // By using float.sty we will have the same handling for all floats, both
-// for those already in existance (table and figure) and all user created
+// for those already in existence (table and figure) and all user created
 // onesĀ¹. So suddenly we give the users the possibility of creating new
 // kinds of floats on the fly. (and with a uniform look)
 //
@@ -109,31 +121,38 @@ namespace lyx {
 //
 // Lgb
 
-
-InsetFloat::InsetFloat(Buffer const & buf, string const & type)
-       : InsetCollapsable(buf), name_(from_utf8(type))
+//FIXME: why do we set in stone the type here?
+InsetFloat::InsetFloat(Buffer * buf, string const & params_str)
+       : InsetCaptionable(buf)
 {
-       setLabel(_("float: ") + floatName(type, buf.params()));
-       params_.type = type;
+       string2params(params_str, params_);
+       setCaptionType(params_.type);
 }
 
 
-InsetFloat::~InsetFloat()
+// Enforce equality of float type and caption type.
+void InsetFloat::setCaptionType(std::string const & type)
 {
-       hideDialogs("float", this);
+       InsetCaptionable::setCaptionType(type);
+       params_.type = captionType();
+       // check if the float type exists
+       if (buffer().params().documentClass().floats().typeExist(params_.type))
+               setNewLabel();
+       else
+               setLabel(bformat(_("ERROR: Unknown float type: %1$s"), from_utf8(params_.type)));
 }
 
 
-docstring InsetFloat::name() const 
-{ 
-       return "Float:" + name_; 
+docstring InsetFloat::layoutName() const
+{
+       return "Float:" + from_utf8(params_.type);
 }
 
 
 docstring InsetFloat::toolTip(BufferView const & bv, int x, int y) const
 {
-       if (InsetCollapsable::toolTip(bv, x, y).empty() || isOpen(bv))
-               return docstring();
+       if (isOpen(bv))
+               return InsetCaptionable::toolTip(bv, x, y);
 
        OutputParams rp(&buffer().params().encoding());
        return getCaptionText(rp);
@@ -142,22 +161,26 @@ docstring InsetFloat::toolTip(BufferView const & bv, int x, int y) const
 
 void InsetFloat::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-       switch (cmd.action) {
+       switch (cmd.action()) {
 
        case LFUN_INSET_MODIFY: {
                InsetFloatParams params;
                string2params(to_utf8(cmd.argument()), params);
+               cur.recordUndoInset(this);
 
                // placement, wide and sideways are not used for subfloats
                if (!params_.subfloat) {
                        params_.placement = params.placement;
                        params_.wide      = params.wide;
                        params_.sideways  = params.sideways;
-                       setWide(params_.wide, cur.buffer()->params(), false);
-                       setSideways(params_.sideways, cur.buffer()->params(), false);
                }
-
-               setNewLabel(cur.buffer()->params());
+               params_.alignment  = params.alignment;
+               setNewLabel();
+               if (params_.type != params.type)
+                       setCaptionType(params.type);
+               // what we really want here is a TOC update, but that means
+               // a full buffer update
+               cur.forceBufferUpdate();
                break;
        }
 
@@ -167,7 +190,7 @@ void InsetFloat::doDispatch(Cursor & cur, FuncRequest & cmd)
        }
 
        default:
-               InsetCollapsable::doDispatch(cur, cmd);
+               InsetCaptionable::doDispatch(cur, cmd);
                break;
        }
 }
@@ -176,51 +199,84 @@ void InsetFloat::doDispatch(Cursor & cur, FuncRequest & cmd)
 bool InsetFloat::getStatus(Cursor & cur, FuncRequest const & cmd,
                FuncStatus & flag) const
 {
-       switch (cmd.action) {
+       switch (cmd.action()) {
 
        case LFUN_INSET_MODIFY:
        case LFUN_INSET_DIALOG_UPDATE:
                flag.setEnabled(true);
                return true;
 
+       case LFUN_INSET_SETTINGS:
+               if (InsetCaptionable::getStatus(cur, cmd, flag)) {
+                       flag.setEnabled(flag.enabled() && !params_.subfloat);
+                       return true;
+               } else
+                       return false;
+
+       case LFUN_NEWLINE_INSERT:
+               if (params_.subfloat) {
+                       flag.setEnabled(false);
+                       return true;
+               }
+               // no subfloat:
+               // fall through
+
        default:
-               return InsetCollapsable::getStatus(cur, cmd, flag);
+               return InsetCaptionable::getStatus(cur, cmd, flag);
+       }
+}
+
+
+bool InsetFloat::hasSubCaptions(ParIterator const & it) const
+{
+       return (it.innerInsetOfType(FLOAT_CODE) || it.innerInsetOfType(WRAP_CODE));
+}
+
+
+string InsetFloat::getAlignment() const
+{
+       string alignment;
+       string const buf_alignment = buffer().params().float_alignment;
+       if (params_.alignment == "document"
+           && !buf_alignment.empty()) {
+               alignment = buf_alignment;
+       } else if (!params_.alignment.empty()
+                  && params_.alignment != "class"
+                  && params_.alignment != "document") {
+               alignment = params_.alignment;
        }
+       return alignment;
 }
 
 
-void InsetFloat::updateLabels(ParIterator const & it)
+LyXAlignment InsetFloat::contentAlignment() const
 {
-       Counters & cnts =
-               buffer().masterBuffer()->params().documentClass().counters();
-       string const saveflt = cnts.current_float();
-       bool const savesubflt = cnts.isSubfloat();
-
-       bool const subflt = (it.innerInsetOfType(FLOAT_CODE)
-                            || it.innerInsetOfType(WRAP_CODE));
-       // floats can only embed subfloats of their own kind
-       if (subflt)
-               params_.type = saveflt;
-       setSubfloat(subflt, buffer().params());
-
-       // Tell to captions what the current float is
-       cnts.current_float(params().type);
-       cnts.isSubfloat(subflt);
-
-       InsetCollapsable::updateLabels(it);
-
-       //reset afterwards
-       cnts.current_float(saveflt);
-       cnts.isSubfloat(savesubflt);
+       LyXAlignment align = LYX_ALIGN_NONE;
+       string alignment = getAlignment();
+       if (alignment == "left")
+               align = LYX_ALIGN_LEFT;
+       else if (alignment == "center")
+               align = LYX_ALIGN_CENTER;
+       else if (alignment == "right")
+               align = LYX_ALIGN_RIGHT;
+
+       return align;
 }
 
 
 void InsetFloatParams::write(ostream & os) const
 {
-       os << "Float " << type << '\n';
+       if (type.empty()) {
+               // Better this than creating a parse error. This in fact happens in the
+               // parameters dialog via InsetFloatParams::params2string.
+               os << "senseless" << '\n';
+       } else
+               os << type << '\n';
 
        if (!placement.empty())
                os << "placement " << placement << "\n";
+       if (!alignment.empty())
+               os << "alignment " << alignment << "\n";
 
        if (wide)
                os << "wide true\n";
@@ -237,8 +293,11 @@ void InsetFloatParams::write(ostream & os) const
 void InsetFloatParams::read(Lexer & lex)
 {
        lex.setContext("InsetFloatParams::read");
+       lex >> type;
        if (lex.checkFor("placement"))
                lex >> placement;
+       if (lex.checkFor("alignment"))
+               lex >> alignment;
        lex >> "wide" >> wide;
        lex >> "sideways" >> sideways;
 }
@@ -246,15 +305,17 @@ void InsetFloatParams::read(Lexer & lex)
 
 void InsetFloat::write(ostream & os) const
 {
+       os << "Float ";
        params_.write(os);
-       InsetCollapsable::write(os);
+       InsetCaptionable::write(os);
 }
 
 
 void InsetFloat::read(Lexer & lex)
 {
        params_.read(lex);
-       InsetCollapsable::read(lex);
+       InsetCaptionable::read(lex);
+       setCaptionType(params_.type);
 }
 
 
@@ -269,215 +330,449 @@ void InsetFloat::validate(LaTeXFeatures & features) const
        if (features.inFloat())
                features.require("subfig");
 
+       if (features.inDeletedInset()) {
+               features.require("tikz");
+               features.require("ct-tikz-object-sout");
+       }
+
        features.useFloat(params_.type, features.inFloat());
        features.inFloat(true);
-       InsetCollapsable::validate(features);
+       InsetCaptionable::validate(features);
        features.inFloat(false);
 }
 
 
-docstring InsetFloat::editMessage() const
-{
-       return _("Opened Float Inset");
-}
-
-
-docstring InsetFloat::xhtml(odocstream & os, OutputParams const & rp) const
+docstring InsetFloat::xhtml(XMLStream & xs, OutputParams const & rp) const
 {
        FloatList const & floats = buffer().params().documentClass().floats();
        Floating const & ftype = floats.getType(params_.type);
-       string const htmltype = ftype.htmlType().empty() ? 
-                       "div" : ftype.htmlType();
-       string const htmlclass = ftype.htmlClass().empty() ?
-                       "float-" + params_.type : ftype.htmlClass();
-       docstring const otag = 
-                       from_ascii("<" + htmltype + " class='float " + htmlclass + "'>\n");
-       docstring const ctag = from_ascii("</" + htmltype + ">\n");
-
-       odocstringstream out;
+       string const & htmltype = ftype.htmlTag();
+       string const & attr = ftype.htmlAttrib();
 
-       out << otag;
-       docstring def = InsetText::xhtml(out, rp);
-       out << ctag;
-
-       if (rp.inFloat == OutputParams::NONFLOAT)
+       odocstringstream ods;
+       XMLStream newxs(ods);
+       newxs << xml::StartTag(htmltype, attr);
+       InsetText::XHTMLOptions const opts =
+               InsetText::WriteLabel | InsetText::WriteInnerTag;
+       docstring deferred = InsetText::insetAsXHTML(newxs, rp, opts);
+       newxs << xml::EndTag(htmltype);
+
+       if (rp.inFloat == OutputParams::NONFLOAT) {
                // In this case, this float needs to be deferred, but we'll put it
                // before anything the text itself deferred.
-               def = out.str() + '\n' + def;
-       else 
+               deferred = ods.str() + '\n' + deferred;
+       } else {
                // In this case, the whole thing is already being deferred, so
                // we can write to the stream.
-               os << out.str();
-       return def;
+               // Note that things will already have been escaped, so we do not
+               // want to escape them again.
+               xs << XMLStream::ESCAPE_NONE << ods.str();
+       }
+       return deferred;
 }
 
 
-int InsetFloat::latex(odocstream & os, OutputParams const & runparams_in) const
+void InsetFloat::latex(otexstream & os, OutputParams const & runparams_in) const
 {
        if (runparams_in.inFloat != OutputParams::NONFLOAT) {
+               if (!paragraphs().empty() && !runparams_in.nice)
+                       // improve TexRow precision in non-nice mode
+                       os << safebreakln;
+
                if (runparams_in.moving_arg)
                        os << "\\protect";
                os << "\\subfloat";
-       
+
                OutputParams rp = runparams_in;
-               docstring const caption = getCaption(rp);
-               if (!caption.empty()) {
-                       os << caption;
-               }
+               rp.moving_arg = true;
+               os << getCaption(rp);
                os << '{';
+               // The main argument is the contents of the float. This is not a moving argument.
+               rp.moving_arg = false;
                rp.inFloat = OutputParams::SUBFLOAT;
-               int const i = InsetText::latex(os, rp);
+               InsetText::latex(os, rp);
                os << "}";
-       
-               return i + 1;
+
+               return;
        }
        OutputParams runparams(runparams_in);
        runparams.inFloat = OutputParams::MAINFLOAT;
 
        FloatList const & floats = buffer().params().documentClass().floats();
        string tmptype = params_.type;
-       if (params_.sideways)
+       if (params_.sideways && floats.allowsSideways(params_.type))
                tmptype = "sideways" + params_.type;
-       if (params_.wide && (!params_.sideways ||
-                            params_.type == "figure" ||
-                            params_.type == "table"))
+       if (params_.wide && floats.allowsWide(params_.type)
+               && (!params_.sideways ||
+                    params_.type == "figure" ||
+                    params_.type == "table"))
                tmptype += "*";
        // Figure out the float placement to use.
        // From lowest to highest:
        // - float default placement
        // - document wide default placement
        // - specific float placement
-       string placement;
+       string tmpplacement;
        string const buf_placement = buffer().params().float_placement;
        string const def_placement = floats.defaultPlacement(params_.type);
-       if (!params_.placement.empty()
-           && params_.placement != def_placement) {
-               placement = params_.placement;
-       } else if (params_.placement.empty()
-                  && !buf_placement.empty()
-                  && buf_placement != def_placement) {
-               placement = buf_placement;
+       if (params_.placement == "document"
+           && !buf_placement.empty()
+           && buf_placement != def_placement) {
+               tmpplacement = buf_placement;
+       } else if (!params_.placement.empty()
+                  && params_.placement != "document"
+                  && params_.placement != def_placement) {
+               tmpplacement = params_.placement;
+       }
+
+       // Check if placement is allowed by this float
+       string const allowed_placement =
+               floats.allowedPlacement(params_.type);
+       string placement;
+       string::const_iterator lit = tmpplacement.begin();
+       string::const_iterator end = tmpplacement.end();
+       for (; lit != end; ++lit) {
+               if (contains(allowed_placement, *lit))
+                       placement += *lit;
        }
 
-       // The \n is used to force \begin{<floatname>} to appear in a new line.
-       // The % is needed to prevent two consecutive \n chars in the case
-       // when the current output line is empty.
-       os << "%\n\\begin{" << from_ascii(tmptype) << '}';
+       // Force \begin{<floatname>} to appear in a new line.
+       os << breakln << "\\begin{" << from_ascii(tmptype) << '}';
+       if (runparams.lastid != -1)
+               os.texrow().start(runparams.lastid, runparams.lastpos);
        // We only output placement if different from the def_placement.
-       // sidewaysfloats always use their own page
-       if (!placement.empty() && !params_.sideways) {
+       // sidewaysfloats always use their own page,
+       // therefore don't output the p option that is always set
+       if (!placement.empty()
+           && (!params_.sideways || from_ascii(placement) != "p"))
                os << '[' << from_ascii(placement) << ']';
-       }
        os << '\n';
 
-       int const i = InsetText::latex(os, runparams);
+       if (runparams.inDeletedInset) {
+               // This has to be done manually since we need it inside the float
+               OutputParams::CtObject ctobject = runparams.ctObject;
+               runparams.ctObject = OutputParams::CT_DISPLAYOBJECT;
+               Changes::latexMarkChange(os, buffer().params(), Change(Change::UNCHANGED),
+                                        Change(Change::DELETED), runparams);
+               runparams.ctObject = ctobject;
+       }
+
+       string alignment = getAlignment();
+       if (alignment == "left")
+               os << "\\raggedright" << breakln;
+       else if (alignment == "center")
+               os << "\\centering" << breakln;
+       else if (alignment == "right")
+               os << "\\raggedleft" << breakln;
 
-       // The \n is used to force \end{<floatname>} to appear in a new line.
-       // In this case, we do not case if the current output line is empty.
-       os << "\n\\end{" << from_ascii(tmptype) << "}\n";
+       InsetText::latex(os, runparams);
 
-       return i + 4;
+       if (runparams.inDeletedInset)
+               os << "}";
+
+       // Force \end{<floatname>} to appear in a new line.
+       os << breakln << "\\end{" << from_ascii(tmptype) << "}\n";
 }
 
 
-int InsetFloat::plaintext(odocstream & os, OutputParams const & runparams) const
+int InsetFloat::plaintext(odocstringstream & os, OutputParams const & runparams, size_t max_length) const
 {
        os << '[' << buffer().B_("float") << ' '
-               << floatName(params_.type, buffer().params()) << ":\n";
-       InsetText::plaintext(os, runparams);
+               << floatName(params_.type) << ":\n";
+       InsetText::plaintext(os, runparams, max_length);
        os << "\n]";
 
        return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 }
 
 
-int InsetFloat::docbook(odocstream & os, OutputParams const & runparams) const
+std::vector<const InsetBox *> findSubfiguresInParagraph(const Paragraph &par)
 {
-       // FIXME Implement subfloat!
-       // FIXME UNICODE
-       os << '<' << from_ascii(params_.type) << '>';
-       int const i = InsetText::docbook(os, runparams);
-       os << "</" << from_ascii(params_.type) << '>';
 
-       return i;
+       // Don't make the hypothesis that all subfigures are in the same paragraph.
+       // Similarly, there may be several subfigures in the same paragraph (most likely case, based on the documentation).
+       // Any box is considered as a subfigure, even though the most likely case is \minipage.
+       std::vector<const InsetBox *> subfigures;
+       for (pos_type pos = 0; pos < par.size(); ++pos) {
+               const Inset *inset = par.getInset(pos);
+               if (!inset)
+                       continue;
+               if (const auto box = dynamic_cast<const InsetBox *>(inset))
+                       subfigures.push_back(box);
+       }
+       return subfigures;
 }
 
 
-bool InsetFloat::insetAllowed(InsetCode code) const
+const InsetLabel* findLabelInParagraph(const Paragraph &par)
 {
-       return code != FOOT_CODE
-           && code != MARGIN_CODE
-           && (code != FLOAT_CODE || !params_.subfloat);
+       for (pos_type pos = 0; pos < par.size(); ++pos) {
+               // If this inset is a subfigure, skip it.
+               const Inset *inset = par.getInset(pos);
+               if (dynamic_cast<const InsetBox *>(inset)) {
+                       continue;
+               }
+
+               // Maybe an inset is directly a label, in which case no more work is needed.
+               if (inset && dynamic_cast<const InsetLabel *>(inset))
+                       return dynamic_cast<const InsetLabel *>(inset);
+
+               // More likely, the label is hidden in an inset of a paragraph (only if a subtype of InsetText).
+               if (!dynamic_cast<const InsetText *>(inset))
+                       continue;
+
+               auto insetAsText = dynamic_cast<const InsetText *>(inset);
+               auto itIn = insetAsText->paragraphs().begin();
+               auto endIn = insetAsText->paragraphs().end();
+               for (; itIn != endIn; ++itIn) {
+                       for (pos_type posIn = 0; posIn < itIn->size(); ++posIn) {
+                               const Inset *insetIn = itIn->getInset(posIn);
+                               if (insetIn && dynamic_cast<const InsetLabel *>(insetIn)) {
+                                       return dynamic_cast<const InsetLabel *>(insetIn);
+                               }
+                       }
+               }
+
+               // Obviously, this solution does not scale with more levels of paragraphs-insets, but this should be enough.
+       }
+
+       return nullptr;
 }
 
 
-bool InsetFloat::showInsetDialog(BufferView * bv) const
+const InsetCaption* findCaptionInParagraph(const Paragraph &par)
 {
-       if (!InsetText::showInsetDialog(bv))
-               bv->showDialog("float", params2string(params()),
-                       const_cast<InsetFloat *>(this));
-       return true;
+       // Don't dive too deep, otherwise, this could be a subfigure caption.
+       for (pos_type pos = 0; pos < par.size(); ++pos) {
+               // If this inset is a subfigure, skip it.
+               const Inset *inset = par.getInset(pos);
+               if (dynamic_cast<const InsetBox *>(inset))
+                       continue;
+
+               if (inset && dynamic_cast<const InsetCaption *>(inset))
+                       return dynamic_cast<const InsetCaption *>(inset);
+       }
+
+       return nullptr;
 }
 
 
-void InsetFloat::setWide(bool w, BufferParams const & bp, bool update_label)
+void InsetFloat::docbook(XMLStream & xs, OutputParams const & runparams) const
 {
-       params_.wide = w;
+       // Determine whether the float has a title or not. For this, iterate through the paragraphs and look
+       // for an InsetCaption. Do the same for labels and subfigures.
+       // The caption and the label for each subfigure is handled by recursive calls.
+       const InsetCaption* caption = nullptr;
+       const InsetLabel* label = nullptr;
+       std::vector<const InsetBox *> subfigures;
+
+       auto end = paragraphs().end();
+       for (auto it = paragraphs().begin(); it != end; ++it) {
+               std::vector<const InsetBox *> foundSubfigures = findSubfiguresInParagraph(*it);
+               if (!foundSubfigures.empty()) {
+                       subfigures.reserve(subfigures.size() + foundSubfigures.size());
+                       subfigures.insert(subfigures.end(), foundSubfigures.begin(), foundSubfigures.end());
+               }
+
+               if (!caption)
+                       caption = findCaptionInParagraph(*it);
+               if (!label)
+                       label = findLabelInParagraph(*it);
+       }
+
+       // Gather a few things from global environment that are shared between all following cases.
+       FloatList const &floats = buffer().params().documentClass().floats();
+       Floating const &ftype = floats.getType(params_.type);
+       string const &titleTag = ftype.docbookCaption();
+
+       // Ensure there is no label output, it is supposed to be handled as xml:id.
+       OutputParams rpNoLabel = runparams;
+       if (label)
+               rpNoLabel.docbook_anchors_to_ignore.emplace(label->screenLabel());
+
+       // Ensure the float does not output its caption, as it is handled here (DocBook mandates a specific place for
+       // captions, they cannot appear at the end of the float, albeit LyX is happy with that).
+       OutputParams rpNoTitle = runparams;
+       rpNoTitle.docbook_in_float = true;
+
+       // Deal with subfigures.
+       if (!subfigures.empty()) {
+               // First, open the formal group.
+               docstring attr = docstring();
+               if (label)
+                       attr += "xml:id=\"" + xml::cleanID(label->screenLabel()) + "\"";
+
+               xs.startDivision(false);
+               xs << xml::StartTag("formalgroup", attr);
+               xs << xml::CR();
+
+               xs << xml::StartTag("title", attr);
+               if (caption) {
+                       caption->getCaptionAsDocBook(xs, rpNoLabel);
+               } else {
+                       xs << "No caption";
+                       // No caption has been detected, but this tag is required for the document to be valid DocBook.
+               }
+               xs << xml::EndTag("title");
+               xs << xml::CR();
+
+               // Deal with each subfigure individually. This should also deal with their caption and their label.
+               // This should be a recursive call to InsetFloat.
+               for (const InsetBox *subfigure: subfigures) {
+                       // If there is no InsetFloat in the paragraphs, output a warning.
+                       bool foundInsetFloat = false;
+                       for (auto it = subfigure->paragraphs().begin(); it != subfigure->paragraphs().end(); ++it) {
+                               for (pos_type posIn = 0; posIn < it->size(); ++posIn) {
+                                       const Inset *inset = it->getInset(posIn);
+                                       if (inset && dynamic_cast<const InsetFloat*>(inset)) {
+                                               foundInsetFloat = true;
+                                               break;
+                                       }
+                               }
+
+                               if (foundInsetFloat)
+                                       break;
+                       }
+
+                       if (!foundInsetFloat)
+                               xs << XMLStream::ESCAPE_NONE << "Error: no float found in the box. "
+                                                                       "To use subfigures in DocBook, elements must be wrapped in a float "
+                                                   "inset and have a title/caption.";
+                       // TODO: could also output a table, that would ensure that the document is correct and *displays* correctly (but without the right semantics), instead of just an error.
+
+                       // Finally, recurse.
+                       subfigure->docbook(xs, runparams);
+               }
+
+               // Every subfigure is done: close the formal group.
+               xs << xml::EndTag("formalgroup");
+               xs << xml::CR();
+               xs.endDivision();
+       }
+
+       // Here, ensured not to have subfigures.
+
+       // Organisation: <float> <title if any/> <contents without title/> </float>
+       docstring attr = docstring();
+       if (label)
+               attr += "xml:id=\"" + xml::cleanID(label->screenLabel()) + "\"";
+       if (!ftype.docbookAttr().empty()) {
+               if (!attr.empty())
+                       attr += " ";
+               attr += from_utf8(ftype.docbookAttr());
+       }
+
+       xs << xml::StartTag(ftype.docbookTag(caption != nullptr), attr);
+       xs << xml::CR();
+       if (caption != nullptr) {
+               xs << xml::StartTag(titleTag);
+               caption->getCaptionAsDocBook(xs, rpNoLabel);
+               xs << xml::EndTag(titleTag);
+               xs << xml::CR();
+       }
+       InsetText::docbook(xs, rpNoTitle);
+       xs << xml::EndTag(ftype.docbookTag(caption != nullptr));
+       xs << xml::CR();
+}
+
+
+bool InsetFloat::insetAllowed(InsetCode code) const
+{
+       // The case that code == FLOAT_CODE is handled in Text3.cpp,
+       // because we need to know what type of float is meant.
+       switch(code) {
+       case WRAP_CODE:
+       case FOOT_CODE:
+       case MARGIN_CODE:
+               return false;
+       default:
+               return InsetCaptionable::insetAllowed(code);
+       }
+}
+
+
+void InsetFloat::setWide(bool w, bool update_label)
+{
+       if (!buffer().params().documentClass().floats().allowsWide(params_.type))
+               params_.wide = false;
+       else
+           params_.wide = w;
        if (update_label)
-               setNewLabel(bp);
+               setNewLabel();
 }
 
 
-void InsetFloat::setSideways(bool s, BufferParams const & bp, bool update_label)
+void InsetFloat::setSideways(bool s, bool update_label)
 {
-       params_.sideways = s;
+       if (!buffer().params().documentClass().floats().allowsSideways(params_.type))
+               params_.sideways = false;
+       else
+               params_.sideways = s;
        if (update_label)
-               setNewLabel(bp);
+               setNewLabel();
 }
 
 
-void InsetFloat::setSubfloat(bool s, BufferParams const & bp, bool update_label)
+void InsetFloat::setSubfloat(bool s, bool update_label)
 {
        params_.subfloat = s;
        if (update_label)
-               setNewLabel(bp);
+               setNewLabel();
 }
 
 
-void InsetFloat::setNewLabel(BufferParams const & bp)
+void InsetFloat::setNewLabel()
 {
        docstring lab = _("float: ");
 
        if (params_.subfloat)
                lab = _("subfloat: ");
 
-       lab += floatName(params_.type, bp);
+       lab += floatName(params_.type);
 
-       if (params_.wide)
+       FloatList const & floats = buffer().params().documentClass().floats();
+
+       if (params_.wide && floats.allowsWide(params_.type))
                lab += '*';
 
-       if (params_.sideways)
+       if (params_.sideways && floats.allowsSideways(params_.type))
                lab += _(" (sideways)");
 
        setLabel(lab);
 }
 
 
-docstring InsetFloat::getCaption(OutputParams const & runparams) const
+bool InsetFloat::allowsCaptionVariation(std::string const & newtype) const
 {
-       if (paragraphs().empty())
-               return docstring();
+       return !params_.subfloat && newtype != "Unnumbered";
+}
+
 
+TexString InsetFloat::getCaption(OutputParams const & runparams) const
+{
        InsetCaption const * ins = getCaptionInset();
        if (ins == 0)
-               return docstring();
-
-       odocstringstream ods;
-       ins->getOptArg(ods, runparams);
-       ods << '[';
-       ins->getArgument(ods, runparams);
-       ods << ']';
-       return ods.str();
+               return TexString();
+
+       otexstringstream os;
+       ins->getArgs(os, runparams);
+
+       if (!runparams.nice)
+               // increase TexRow precision in non-nice mode
+               os << safebreakln;
+       os << '[';
+       otexstringstream os2;
+       ins->getArgument(os2, runparams);
+       TexString ts = os2.release();
+       docstring & arg = ts.str;
+       // Protect ']'
+       if (arg.find(']') != docstring::npos)
+               arg = '{' + arg + '}';
+       os << move(ts);
+       os << ']';
+       if (!runparams.nice)
+               os << safebreakln;
+       return os.release();
 }
 
 
@@ -491,8 +786,6 @@ void InsetFloat::string2params(string const & in, InsetFloatParams & params)
        Lexer lex;
        lex.setStream(data);
        lex.setContext("InsetFloat::string2params");
-       lex >> "float" >> "Float";
-       lex >> params.type; // We have to read the type here!
        params.read(lex);
 }
 
@@ -500,7 +793,6 @@ void InsetFloat::string2params(string const & in, InsetFloatParams & params)
 string InsetFloat::params2string(InsetFloatParams const & params)
 {
        ostringstream data;
-       data << "float" << ' ';
        params.write(data);
        return data.str();
 }