InsetIndex: Some comments and indentation fixes

[features.git] / src / insets / InsetFloat.cpp

diff --git a/src/insets/InsetFloat.cpp b/src/insets/InsetFloat.cpp
index 7068b0ab07026443975851fd3b78e4dba78cce0e..cb05e49aa6b57c91ccd669df653ded358ea2b58c 100644 (file)
--- a/src/insets/InsetFloat.cpp
+++ b/src/insets/InsetFloat.cpp
@@ -759,8 +759,7 @@ void docbookGenerateFillerTable(XMLStream & xs, BufferParams::TableOutput format
 
 
 void docbookNoSubfigures(XMLStream & xs, OutputParams const & runparams, const InsetCaption * caption,
-                         const InsetLabel * label, Floating const & ftype, const InsetFloat * thisFloat)
-{
+                         const InsetLabel * label, Floating const & ftype, const InsetFloat * thisFloat) {
        // Ensure there is no label output, it is supposed to be handled as xml:id.
        OutputParams rpNoLabel = runparams;
        if (label)
@@ -774,11 +773,29 @@ void docbookNoSubfigures(XMLStream & xs, OutputParams const & runparams, const I
                rpNoTitle.docbook_in_table = true;
 
        // Generate the contents of the float (to check for emptiness).
-       odocstringstream os2;
-       XMLStream xs2(os2);
-       thisFloat->InsetText::docbook(xs2, rpNoTitle);
+       odocstringstream osFloatContent;
+       bool hasFloat = false;
+
+       if (thisFloat) {
+               XMLStream xsFloatContent(osFloatContent);
+               thisFloat->InsetText::docbook(xsFloatContent, rpNoTitle);
+               hasFloat = !osFloatContent.str().empty();
+       }
+
+       // Do the same for the caption.
+       odocstringstream osCaptionContent;
+       bool hasCaption = false;
+
+       if (caption != nullptr) {
+               XMLStream xsCaptionContent(osCaptionContent);
+               caption->getCaptionAsDocBook(xsCaptionContent, rpNoLabel);
+               hasCaption = !osCaptionContent.str().empty();
+       }
 
-       // Organisation: <float> <title if any/> <contents without title/> </float>.
+       // Organisation: <float with xml:id if any> <title if any/> <contents without title nor xml:id/> </float>.
+       // Titles and xml:id are generated with specific insets and must be dealt with using OutputParams.
+
+       // - Generate the attributes for the float tag.
        docstring attr = docstring();
        if (label)
                attr += "xml:id=\"" + xml::cleanID(label->screenLabel()) + "\"";
@@ -789,39 +806,35 @@ void docbookNoSubfigures(XMLStream & xs, OutputParams const & runparams, const I
        }
 
        // - Open the float tag.
-       xs << xml::StartTag(ftype.docbookTag(caption != nullptr), attr);
+       xs << xml::StartTag(ftype.docbookTag(hasCaption), attr);
        xs << xml::CR();
 
        // - Generate the caption.
-       if (caption) {
+       if (hasCaption) {
                string const &titleTag = ftype.docbookCaption();
                xs << xml::StartTag(titleTag);
-               caption->getCaptionAsDocBook(xs, rpNoLabel);
+               xs << XMLStream::ESCAPE_NONE << osCaptionContent.str();
                xs << xml::EndTag(titleTag);
                xs << xml::CR();
        }
 
-       // - Output the actual content of the float.
-       if (!os2.str().empty())
-               xs << XMLStream::ESCAPE_NONE << os2.str();
+       // - Output the actual content of the float or some dummy content (to ensure that the output
+       // document is valid).
+       if (hasFloat)
+               xs << XMLStream::ESCAPE_NONE << osFloatContent.str();
        else if (ftype.docbookFloatType() == "table")
                docbookGenerateFillerTable(xs, thisFloat->buffer().params().docbook_table_output);
        else
                docbookGenerateFillerMedia(xs);
 
        // - Close the float.
-       xs << xml::EndTag(ftype.docbookTag(caption != nullptr));
+       xs << xml::EndTag(ftype.docbookTag(hasCaption));
        xs << xml::CR();
 }
 
 
 void InsetFloat::docbook(XMLStream & xs, OutputParams const & runparams) const
 {
-//     if (runparams.docbook_in_par) {
-//             xs << xml::EndTag("para");
-//             xs << xml::CR();
-//     }
-
        const InsetCaption* caption = getCaptionInset();
        const InsetLabel* label = getLabelInset();
 
@@ -845,11 +858,6 @@ void InsetFloat::docbook(XMLStream & xs, OutputParams const & runparams) const
                docbookSubfigures(xs, runparams, caption, label, subfigures);
        else
                docbookNoSubfigures(xs, runparams, caption, label, ftype, this);
-
-//     if (runparams.docbook_in_par) {
-//             xs << xml::CR();
-//             xs << xml::StartTag("para");
-//     }
 }
 
 
@@ -900,10 +908,10 @@ void InsetFloat::setSubfloat(bool s, bool update_label)
 
 void InsetFloat::setNewLabel()
 {
-       docstring lab = _("float: ");
+       docstring lab = _("Float: ");
 
        if (params_.subfloat)
-               lab = _("subfloat: ");
+               lab = _("Subfloat: ");
 
        lab += floatName(params_.type);