src/output_docbook.cpp

   1 /**
   2  * \file output_docbook.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author José Matos
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "output_docbook.h"
  15
  16 #include "Buffer.h"
  17 #include "buffer_funcs.h"
  18 #include "BufferParams.h"
  19 #include "Font.h"
  20 #include "InsetList.h"
  21 #include "Paragraph.h"
  22 #include "ParagraphList.h"
  23 #include "ParagraphParameters.h"
  24 #include "xml.h"
  25 #include "Text.h"
  26 #include "TextClass.h"
  27
  28 #include "insets/InsetBibtex.h"
  29 #include "insets/InsetBibitem.h"
  30 #include "insets/InsetLabel.h"
  31 #include "mathed/InsetMath.h"
  32 #include "insets/InsetNote.h"
  33
  34 #include "support/lassert.h"
  35 #include "support/textutils.h"
  36
  37 #include <stack>
  38 #include <iostream>
  39 #include <algorithm>
  40 #include <sstream>
  41
  42 using namespace std;
  43 using namespace lyx::support;
  44
  45 namespace lyx {
  46
  47 namespace {
  48
  49 std::string fontToDocBookTag(xml::FontTypes type)
  50 {
  51         switch (type) {
  52         case xml::FontTypes::FT_EMPH:
  53         case xml::FontTypes::FT_BOLD:
  54                 return "emphasis";
  55         case xml::FontTypes::FT_NOUN:
  56                 return "personname";
  57         case xml::FontTypes::FT_UBAR:
  58         case xml::FontTypes::FT_WAVE:
  59         case xml::FontTypes::FT_DBAR:
  60         case xml::FontTypes::FT_SOUT:
  61         case xml::FontTypes::FT_XOUT:
  62         case xml::FontTypes::FT_ITALIC:
  63         case xml::FontTypes::FT_UPRIGHT:
  64         case xml::FontTypes::FT_SLANTED:
  65         case xml::FontTypes::FT_SMALLCAPS:
  66         case xml::FontTypes::FT_ROMAN:
  67         case xml::FontTypes::FT_SANS:
  68                 return "emphasis";
  69         case xml::FontTypes::FT_TYPE:
  70                 return "code";
  71         case xml::FontTypes::FT_SIZE_TINY:
  72         case xml::FontTypes::FT_SIZE_SCRIPT:
  73         case xml::FontTypes::FT_SIZE_FOOTNOTE:
  74         case xml::FontTypes::FT_SIZE_SMALL:
  75         case xml::FontTypes::FT_SIZE_NORMAL:
  76         case xml::FontTypes::FT_SIZE_LARGE:
  77         case xml::FontTypes::FT_SIZE_LARGER:
  78         case xml::FontTypes::FT_SIZE_LARGEST:
  79         case xml::FontTypes::FT_SIZE_HUGE:
  80         case xml::FontTypes::FT_SIZE_HUGER:
  81         case xml::FontTypes::FT_SIZE_INCREASE:
  82         case xml::FontTypes::FT_SIZE_DECREASE:
  83                 return "emphasis";
  84         default:
  85                 return "";
  86         }
  87 }
  88
  89
  90 string fontToRole(xml::FontTypes type)
  91 {
  92         // Specific fonts are achieved with roles. The only common ones are "" for basic emphasis,
  93         // and "bold"/"strong" for bold. With some specific options, other roles are copied into
  94         // HTML output (via the DocBook XSLT sheets); otherwise, if not recognised, they are just ignored.
  95         // Hence, it is not a problem to have many roles by default here.
  96         // See https://www.sourceware.org/ml/docbook/2003-05/msg00269.html
  97         switch (type) {
  98         case xml::FontTypes::FT_ITALIC:
  99         case xml::FontTypes::FT_EMPH:
 100                 return "";
 101         case xml::FontTypes::FT_BOLD:
 102                 return "bold";
 103         case xml::FontTypes::FT_NOUN: // Outputs a <person>
 104         case xml::FontTypes::FT_TYPE: // Outputs a <code>
 105                 return "";
 106         case xml::FontTypes::FT_UBAR:
 107                 return "underline";
 108
 109         // All other roles are non-standard for DocBook.
 110
 111         case xml::FontTypes::FT_WAVE:
 112                 return "wave";
 113         case xml::FontTypes::FT_DBAR:
 114                 return "dbar";
 115         case xml::FontTypes::FT_SOUT:
 116                 return "sout";
 117         case xml::FontTypes::FT_XOUT:
 118                 return "xout";
 119         case xml::FontTypes::FT_UPRIGHT:
 120                 return "upright";
 121         case xml::FontTypes::FT_SLANTED:
 122                 return "slanted";
 123         case xml::FontTypes::FT_SMALLCAPS:
 124                 return "smallcaps";
 125         case xml::FontTypes::FT_ROMAN:
 126                 return "roman";
 127         case xml::FontTypes::FT_SANS:
 128                 return "sans";
 129         case xml::FontTypes::FT_SIZE_TINY:
 130                 return "tiny";
 131         case xml::FontTypes::FT_SIZE_SCRIPT:
 132                 return "size_script";
 133         case xml::FontTypes::FT_SIZE_FOOTNOTE:
 134                 return "size_footnote";
 135         case xml::FontTypes::FT_SIZE_SMALL:
 136                 return "size_small";
 137         case xml::FontTypes::FT_SIZE_NORMAL:
 138                 return "size_normal";
 139         case xml::FontTypes::FT_SIZE_LARGE:
 140                 return "size_large";
 141         case xml::FontTypes::FT_SIZE_LARGER:
 142                 return "size_larger";
 143         case xml::FontTypes::FT_SIZE_LARGEST:
 144                 return "size_largest";
 145         case xml::FontTypes::FT_SIZE_HUGE:
 146                 return "size_huge";
 147         case xml::FontTypes::FT_SIZE_HUGER:
 148                 return "size_huger";
 149         case xml::FontTypes::FT_SIZE_INCREASE:
 150                 return "size_increase";
 151         case xml::FontTypes::FT_SIZE_DECREASE:
 152                 return "size_decrease";
 153         default:
 154                 return "";
 155         }
 156 }
 157
 158
 159 string fontToAttribute(xml::FontTypes type) {
 160         // If there is a role (i.e. nonstandard use of a tag), output the attribute. Otherwise, the sheer tag is sufficient
 161         // for the font.
 162         string role = fontToRole(type);
 163         if (!role.empty()) {
 164                 return "role='" + role + "'";
 165         } else {
 166                 return "";
 167         }
 168 }
 169
 170
 171 // Convenience functions to open and close tags. First, very low-level ones to ensure a consistent new-line behaviour.
 172 // Block style:
 173 //        Content before
 174 //        <blocktag>
 175 //          Contents of the block.
 176 //        </blocktag>
 177 //        Content after
 178 // Paragraph style:
 179 //        Content before
 180 //          <paratag>Contents of the paragraph.</paratag>
 181 //        Content after
 182 // Inline style:
 183 //    Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
 184
 185 void openInlineTag(XMLStream & xs, const std::string & tag, const std::string & attr)
 186 {
 187         xs << xml::StartTag(tag, attr);
 188 }
 189
 190
 191 void closeInlineTag(XMLStream & xs, const std::string & tag)
 192 {
 193         xs << xml::EndTag(tag);
 194 }
 195
 196
 197 void openParTag(XMLStream & xs, const std::string & tag, const std::string & attr)
 198 {
 199         if (!xs.isLastTagCR())
 200                 xs << xml::CR();
 201         xs << xml::StartTag(tag, attr);
 202 }
 203
 204
 205 void closeParTag(XMLStream & xs, const std::string & tag)
 206 {
 207         xs << xml::EndTag(tag);
 208         xs << xml::CR();
 209 }
 210
 211
 212 void openBlockTag(XMLStream & xs, const std::string & tag, const std::string & attr)
 213 {
 214         if (!xs.isLastTagCR())
 215                 xs << xml::CR();
 216         xs << xml::StartTag(tag, attr);
 217         xs << xml::CR();
 218 }
 219
 220
 221 void closeBlockTag(XMLStream & xs, const std::string & tag)
 222 {
 223         if (!xs.isLastTagCR())
 224                 xs << xml::CR();
 225         xs << xml::EndTag(tag);
 226         xs << xml::CR();
 227 }
 228
 229
 230 void openTag(XMLStream & xs, const std::string & tag, const std::string & attr, const std::string & tagtype)
 231 {
 232         if (tag.empty() || tag == "NONE") // Common check to be performed elsewhere, if it was not here.
 233                 return;
 234
 235         if (tag == "para" || tagtype == "paragraph") // Special case for <para>: always considered as a paragraph.
 236                 openParTag(xs, tag, attr);
 237         else if (tagtype == "block")
 238                 openBlockTag(xs, tag, attr);
 239         else if (tagtype == "inline")
 240                 openInlineTag(xs, tag, attr);
 241         else
 242                 xs.writeError("Unrecognised tag type '" + tagtype + "' for '" + tag + " " + attr + "'");
 243 }
 244
 245
 246 void closeTag(XMLStream & xs, const std::string & tag, const std::string & tagtype)
 247 {
 248         if (tag.empty() || tag == "NONE")
 249                 return;
 250
 251         if (tag == "para" || tagtype == "paragraph") // Special case for <para>: always considered as a paragraph.
 252                 closeParTag(xs, tag);
 253         else if (tagtype == "block")
 254                 closeBlockTag(xs, tag);
 255         else if (tagtype == "inline")
 256                 closeInlineTag(xs, tag);
 257         else
 258                 xs.writeError("Unrecognised tag type '" + tagtype + "' for '" + tag + "'");
 259 }
 260
 261
 262 void compTag(XMLStream & xs, const std::string & tag, const std::string & attr, const std::string & tagtype)
 263 {
 264         if (tag.empty() || tag == "NONE")
 265                 return;
 266
 267         // Special case for <para>: always considered as a paragraph.
 268         if (tag == "para" || tagtype == "paragraph" || tagtype == "block") {
 269                 if (!xs.isLastTagCR())
 270                         xs << xml::CR();
 271                 xs << xml::CompTag(tag, attr);
 272                 xs << xml::CR();
 273         } else if (tagtype == "inline") {
 274                 xs << xml::CompTag(tag, attr);
 275         } else {
 276                 xs.writeError("Unrecognised tag type '" + tagtype + "' for '" + tag + "'");
 277         }
 278 }
 279
 280
 281 // Higher-level convenience functions.
 282
 283 void openParTag(XMLStream & xs, const Paragraph * par, const Paragraph * prevpar)
 284 {
 285         if (par == prevpar)
 286                 prevpar = nullptr;
 287
 288         // When should the wrapper be opened here? Only if the previous paragraph has the SAME wrapper tag
 289         // (usually, they won't have the same layout) and the CURRENT one allows merging.
 290         // The main use case is author information in several paragraphs: if the name of the author is the
 291         // first paragraph of an author, then merging with the previous tag does not make sense. Say the
 292         // next paragraph is the affiliation, then it should be output in the same <author> tag (different
 293         // layout, same wrapper tag).
 294         Layout const & lay = par->layout();
 295         bool openWrapper = lay.docbookwrappertag() != "NONE";
 296         if (prevpar != nullptr) {
 297                 Layout const & prevlay = prevpar->layout();
 298                 if (prevlay.docbookwrappertag() != "NONE") {
 299                         if (prevlay.docbookwrappertag() == lay.docbookwrappertag() &&
 300                                         prevlay.docbookwrapperattr() == lay.docbookwrapperattr())
 301                                 openWrapper = !lay.docbookwrappermergewithprevious();
 302                         else
 303                                 openWrapper = true;
 304                 }
 305         }
 306
 307         // Main logic.
 308         if (openWrapper)
 309                 openTag(xs, lay.docbookwrappertag(), lay.docbookwrapperattr(), lay.docbookwrappertagtype());
 310
 311         const string & tag = lay.docbooktag();
 312         if (tag != "NONE") {
 313                 auto xmltag = xml::ParTag(tag, lay.docbookattr());
 314                 if (!xs.isTagOpen(xmltag, 1)) { // Don't nest a paragraph directly in a paragraph.
 315                         // TODO: required or not?
 316                         // TODO: avoid creating a ParTag object just for this query...
 317                         openTag(xs, lay.docbooktag(), lay.docbookattr(), lay.docbooktagtype());
 318                         openTag(xs, lay.docbookinnertag(), lay.docbookinnerattr(), lay.docbookinnertagtype());
 319                 }
 320         }
 321
 322         openTag(xs, lay.docbookitemtag(), lay.docbookitemattr(), lay.docbookitemtagtype());
 323         openTag(xs, lay.docbookiteminnertag(), lay.docbookiteminnerattr(), lay.docbookiteminnertagtype());
 324 }
 325
 326
 327 void closeParTag(XMLStream & xs, Paragraph const * par, Paragraph const * nextpar)
 328 {
 329         if (par == nextpar)
 330                 nextpar = nullptr;
 331
 332         // See comment in openParTag.
 333         Layout const & lay = par->layout();
 334         bool closeWrapper = lay.docbookwrappertag() != "NONE";
 335         if (nextpar != nullptr) {
 336                 Layout const & nextlay = nextpar->layout();
 337                 if (nextlay.docbookwrappertag() != "NONE") {
 338                         if (nextlay.docbookwrappertag() == lay.docbookwrappertag() &&
 339                                         nextlay.docbookwrapperattr() == lay.docbookwrapperattr())
 340                                 closeWrapper = !nextlay.docbookwrappermergewithprevious();
 341                         else
 342                                 closeWrapper = true;
 343                 }
 344         }
 345
 346         // Main logic.
 347         closeTag(xs, lay.docbookiteminnertag(), lay.docbookiteminnertagtype());
 348         closeTag(xs, lay.docbookitemtag(), lay.docbookitemtagtype());
 349         closeTag(xs, lay.docbookinnertag(), lay.docbookinnertagtype());
 350         closeTag(xs, lay.docbooktag(), lay.docbooktagtype());
 351         if (closeWrapper)
 352                 closeTag(xs, lay.docbookwrappertag(), lay.docbookwrappertagtype());
 353 }
 354
 355
 356 void makeBibliography(
 357                 Text const & text,
 358                 Buffer const & buf,
 359                 XMLStream & xs,
 360                 OutputParams const & runparams,
 361                 ParagraphList::const_iterator const & par)
 362 {
 363         // If this is the first paragraph in a bibliography, open the bibliography tag.
 364         auto const * pbegin_before = text.paragraphs().getParagraphBefore(par);
 365         if (pbegin_before == nullptr || (pbegin_before && pbegin_before->layout().latextype != LATEX_BIB_ENVIRONMENT)) {
 366                 xs << xml::StartTag("bibliography");
 367                 xs << xml::CR();
 368         }
 369
 370         // Start the precooked bibliography entry. This is very much like opening a paragraph tag.
 371         // Don't forget the citation ID!
 372         docstring attr;
 373         for (auto i = 0; i < par->size(); ++i) {
 374                 Inset const *ip = par->getInset(i);
 375                 if (!ip)
 376                         continue;
 377                 if (const auto * bibitem = dynamic_cast<const InsetBibitem*>(ip)) {
 378                         auto id = xml::cleanID(bibitem->getParam("key"));
 379                         attr = from_utf8("xml:id='") + id + from_utf8("'");
 380                         break;
 381                 }
 382         }
 383         xs << xml::StartTag(from_utf8("bibliomixed"), attr);
 384
 385         // Generate the entry. Concatenate the different parts of the paragraph if any.
 386         auto const begin = text.paragraphs().begin();
 387         auto pars = par->simpleDocBookOnePar(buf, runparams, text.outerFont(std::distance(begin, par)), 0);
 388         for (auto & parXML : pars)
 389                 xs << XMLStream::ESCAPE_NONE << parXML;
 390
 391         // End the precooked bibliography entry.
 392         xs << xml::EndTag("bibliomixed");
 393         xs << xml::CR();
 394
 395         // If this is the last paragraph in a bibliography, close the bibliography tag.
 396         auto const end = text.paragraphs().end();
 397         auto nextpar = par;
 398         ++nextpar;
 399         bool endBibliography = nextpar == end || nextpar->layout().latextype != LATEX_BIB_ENVIRONMENT;
 400
 401         if (endBibliography) {
 402                 xs << xml::EndTag("bibliography");
 403                 xs << xml::CR();
 404         }
 405 }
 406
 407
 408 void makeParagraph(
 409                 Text const & text,
 410                 Buffer const & buf,
 411                 XMLStream & xs,
 412                 OutputParams const & runparams,
 413                 ParagraphList::const_iterator const & par)
 414 {
 415         auto const begin = text.paragraphs().begin();
 416         auto const end = text.paragraphs().end();
 417         auto prevpar = text.paragraphs().getParagraphBefore(par);
 418
 419         // We want to open the paragraph tag if:
 420         //   (i) the current layout permits multiple paragraphs
 421         //  (ii) we are either not already inside a paragraph (HTMLIsBlock) OR
 422         //         we are, but this is not the first paragraph
 423         //
 424         // But there is also a special case, and we first see whether we are in it.
 425         // We do not want to open the paragraph tag if this paragraph contains
 426         // only one item, and that item is "inline", i.e., not HTMLIsBlock (such
 427         // as a branch). On the other hand, if that single item has a font change
 428         // applied to it, then we still do need to open the paragraph.
 429         //
 430         // Obviously, this is very fragile. The main reason we need to do this is
 431         // because of branches, e.g., a branch that contains an entire new section.
 432         // We do not really want to wrap that whole thing in a <div>...</div>.
 433         bool special_case = false;
 434         Inset const *specinset = par->size() == 1 ? par->getInset(0) : nullptr;
 435         if (specinset && !specinset->getLayout().htmlisblock()) { // TODO: Convert htmlisblock to a DocBook parameter?
 436                 Layout const &style = par->layout();
 437                 FontInfo const first_font = style.labeltype == LABEL_MANUAL ?
 438                                                                         style.labelfont : style.font;
 439                 FontInfo const our_font =
 440                                 par->getFont(buf.masterBuffer()->params(), 0,
 441                                                          text.outerFont(std::distance(begin, par))).fontInfo();
 442
 443                 if (first_font == our_font)
 444                         special_case = true;
 445         }
 446
 447         size_t nInsets = std::distance(par->insetList().begin(), par->insetList().end());
 448
 449         // Plain layouts must be ignored.
 450         special_case |= buf.params().documentClass().isPlainLayout(par->layout()) && !runparams.docbook_force_pars;
 451         // Equations do not deserve their own paragraph (DocBook allows them outside paragraphs).
 452         // Exception: any case that generates an <inlineequation> must still get a paragraph to be valid.
 453         special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
 454                 return inset.inset && inset.inset->asInsetMath() && inset.inset->asInsetMath()->getType() != hullSimple;
 455         });
 456         // Floats cannot be in paragraphs.
 457         special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
 458                 return inset.inset->lyxCode() == FLOAT_CODE;
 459         });
 460         // Bibliographies cannot be in paragraphs. Bibitems should still be handled as paragraphs, though
 461         // (see makeParagraphBibliography).
 462         special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
 463                 return inset.inset->lyxCode() == BIBTEX_CODE;
 464         });
 465         // ERTs are in comments, not paragraphs.
 466         special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
 467                 return inset.inset->lyxCode() == ERT_CODE;
 468         });
 469         // Listings should not get into their own paragraph.
 470         special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
 471                 return inset.inset->lyxCode() == LISTINGS_CODE;
 472         });
 473         // Boxes cannot get into their own paragraph.
 474         special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
 475                 return inset.inset->lyxCode() == BOX_CODE;
 476         });
 477         // Includes should not have a paragraph.
 478         special_case |= nInsets == (size_t) par->size() && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) {
 479                 return inset.inset->lyxCode() == INCLUDE_CODE;
 480         });
 481
 482         bool const open_par = runparams.docbook_make_pars
 483                                                   && !runparams.docbook_in_par
 484                                                   && !special_case;
 485
 486         // We want to issue the closing tag if either:
 487         //   (i)  We opened it, and either docbook_in_par is false,
 488         //              or we're not in the last paragraph, anyway.
 489         //   (ii) We didn't open it and docbook_in_par is true,
 490         //              but we are in the first par, and there is a next par.
 491         bool const close_par = open_par && (!runparams.docbook_in_par);
 492
 493         // Determine if this paragraph has some real content. Things like new pages are not caught
 494         // by Paragraph::empty(), even though they do not generate anything useful in DocBook.
 495         // Thus, remove all spaces (including new lines: \r, \n) before checking for emptiness.
 496         // std::all_of allows doing this check without having to copy the string.
 497         // Open and close tags around each contained paragraph.
 498         auto nextpar = par;
 499         ++nextpar;
 500         auto pars = par->simpleDocBookOnePar(buf, runparams, text.outerFont(distance(begin, par)), 0, nextpar == end, special_case);
 501         for (docstring const & parXML : pars) {
 502                 if (xml::isNotOnlySpace(parXML)) {
 503                         if (open_par)
 504                                 openParTag(xs, &*par, prevpar);
 505
 506                         xs << XMLStream::ESCAPE_NONE << parXML;
 507
 508                         if (close_par)
 509                                 closeParTag(xs, &*par, (nextpar != end) ? &*nextpar : nullptr);
 510                 }
 511         }
 512 }
 513
 514
 515 void makeEnvironment(Text const &text,
 516                                          Buffer const &buf,
 517                      XMLStream &xs,
 518                      OutputParams const &runparams,
 519                      ParagraphList::const_iterator const & par)
 520 {
 521         auto const end = text.paragraphs().end();
 522         auto nextpar = par;
 523         ++nextpar;
 524
 525         // Special cases for listing-like environments provided in layouts. This is quite ad-hoc, but provides a useful
 526         // default. This should not be used by too many environments (only LyX-Code right now).
 527         // This would be much simpler if LyX-Code was implemented as InsetListings...
 528         bool mimicListing = false;
 529         bool ignoreFonts = false;
 530         if (par->layout().docbooktag() == "programlisting") {
 531                 mimicListing = true;
 532                 ignoreFonts = true;
 533         }
 534
 535         // Output the opening tag for this environment, but only if it has not been previously opened (condition
 536         // implemented in openParTag).
 537         auto prevpar = text.paragraphs().getParagraphBefore(par);
 538         openParTag(xs, &*par, prevpar); // TODO: switch in layout for par/block?
 539
 540         // Generate the contents of this environment. There is a special case if this is like some environment.
 541         Layout const & style = par->layout();
 542         if (style.latextype == LATEX_COMMAND) {
 543                 // Nothing to do (otherwise, infinite loops).
 544         } else if (style.latextype == LATEX_ENVIRONMENT) {
 545                 // Generate the paragraph, if need be.
 546                 auto pars = par->simpleDocBookOnePar(buf, runparams, text.outerFont(std::distance(text.paragraphs().begin(), par)), 0, false, ignoreFonts);
 547
 548                 if (mimicListing) {
 549                         auto p = pars.begin();
 550                         while (p != pars.end()) {
 551                                 openTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnerattr(), par->layout().docbookiteminnertagtype());
 552                                 xs << XMLStream::ESCAPE_NONE << *p;
 553                                 closeTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnertagtype());
 554                                 ++p;
 555
 556                                 // Insert a new line after each "paragraph" (i.e. line in the listing), except for the last one.
 557                                 // Otherwise, there would one more new line in the output than in the LyX document.
 558                                 if (p != pars.end())
 559                                         xs << xml::CR();
 560                         }
 561                 } else {
 562                         for (auto const & p : pars) {
 563                                 openTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnerattr(), par->layout().docbookiteminnertagtype());
 564                                 xs << XMLStream::ESCAPE_NONE << p;
 565                                 closeTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnertagtype());
 566                         }
 567                 }
 568         } else {
 569                 makeAny(text, buf, xs, runparams, par);
 570         }
 571
 572         // Close the environment.
 573         closeParTag(xs, &*par, (nextpar != end) ? &*nextpar : nullptr); // TODO: switch in layout for par/block?
 574 }
 575
 576
 577 ParagraphList::const_iterator findEndOfEnvironment(
 578                 ParagraphList::const_iterator const & pstart,
 579                 ParagraphList::const_iterator const & pend)
 580 {
 581         // Copy-paste from XHTML. Should be factored out at some point...
 582         ParagraphList::const_iterator p = pstart;
 583         Layout const & bstyle = p->layout();
 584         size_t const depth = p->params().depth();
 585         for (++p; p != pend; ++p) {
 586                 Layout const & style = p->layout();
 587                 // It shouldn't happen that e.g. a section command occurs inside
 588                 // a quotation environment, at a higher depth, but as of 6/2009,
 589                 // it can happen. We pretend that it's just at lowest depth.
 590                 if (style.latextype == LATEX_COMMAND)
 591                         return p;
 592
 593                 // If depth is down, we're done
 594                 if (p->params().depth() < depth)
 595                         return p;
 596
 597                 // If depth is up, we're not done
 598                 if (p->params().depth() > depth)
 599                         continue;
 600
 601                 // FIXME I am not sure about the first check.
 602                 // Surely we *could* have different layouts that count as
 603                 // LATEX_PARAGRAPH, right?
 604                 if (style.latextype == LATEX_PARAGRAPH || style != bstyle)
 605                         return p;
 606         }
 607         return pend;
 608 }
 609
 610
 611 ParagraphList::const_iterator makeListEnvironment(Text const &text,
 612                                                                                                   Buffer const &buf,
 613                                                           XMLStream &xs,
 614                                                           OutputParams const &runparams,
 615                                                           ParagraphList::const_iterator const & begin)
 616 {
 617         auto par = begin;
 618         auto const end = text.paragraphs().end();
 619         auto const envend = findEndOfEnvironment(par, end);
 620
 621         // Output the opening tag for this environment.
 622         Layout const & envstyle = par->layout();
 623         openTag(xs, envstyle.docbookwrappertag(), envstyle.docbookwrapperattr(), envstyle.docbookwrappertagtype());
 624         openTag(xs, envstyle.docbooktag(), envstyle.docbookattr(), envstyle.docbooktagtype());
 625
 626         // Handle the content of the list environment, item by item.
 627         while (par != envend) {
 628                 // Skip this paragraph if it is both empty and the last one (otherwise, there may be deeper paragraphs after).
 629                 auto nextpar = par;
 630                 ++nextpar;
 631                 if (par->empty() && nextpar == envend)
 632                         break;
 633
 634                 // Open the item wrapper.
 635                 Layout const & style = par->layout();
 636                 openTag(xs, style.docbookitemwrappertag(), style.docbookitemwrapperattr(), style.docbookitemwrappertagtype());
 637
 638                 // Generate the label, if need be. If it is taken from the text, sep != 0 and corresponds to the first
 639                 // character after the label.
 640                 pos_type sep = 0;
 641                 if (style.labeltype != LABEL_NO_LABEL && style.docbookitemlabeltag() != "NONE") {
 642                         if (style.labeltype == LABEL_MANUAL) {
 643                                 // Only variablelist gets here (or similar items defined as an extension in the layout).
 644                                 openTag(xs, style.docbookitemlabeltag(), style.docbookitemlabelattr(), style.docbookitemlabeltagtype());
 645                                 sep = 1 + par->firstWordDocBook(xs, runparams);
 646                                 closeTag(xs, style.docbookitemlabeltag(), style.docbookitemlabeltagtype());
 647                         } else {
 648                                 // Usual cases: maybe there is something specified at the layout level. Highly unlikely, though.
 649                                 docstring const lbl = par->params().labelString();
 650
 651                                 if (!lbl.empty()) {
 652                                         openTag(xs, style.docbookitemlabeltag(), style.docbookitemlabelattr(), style.docbookitemlabeltagtype());
 653                                         xs << lbl;
 654                                         closeTag(xs, style.docbookitemlabeltag(), style.docbookitemlabeltagtype());
 655                                 }
 656                         }
 657                 }
 658
 659                 // Open the item (after the wrapper and the label).
 660                 openTag(xs, style.docbookitemtag(), style.docbookitemattr(), style.docbookitemtagtype());
 661
 662                 // Generate the content of the item.
 663                 if (sep < par->size()) {
 664                         auto pars = par->simpleDocBookOnePar(buf, runparams,
 665                                                              text.outerFont(std::distance(text.paragraphs().begin(), par)), sep);
 666                         for (auto &p : pars) {
 667                                 openTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnerattr(),
 668                                         par->layout().docbookiteminnertagtype());
 669                                 xs << XMLStream::ESCAPE_NONE << p;
 670                                 closeTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnertagtype());
 671                         }
 672                 } else {
 673                         // DocBook doesn't like emptiness.
 674                         compTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnerattr(),
 675                                 par->layout().docbookiteminnertagtype());
 676                 }
 677
 678                 // If the next item is deeper, it must go entirely within this item (do it recursively).
 679                 // By construction, with findEndOfEnvironment, depth can only stay constant or increase, never decrease.
 680                 depth_type currentDepth = par->getDepth();
 681                 ++par;
 682                 while (par != envend && par->getDepth() != currentDepth)
 683                         par = makeAny(text, buf, xs, runparams, par);
 684                 // Usually, this loop only makes one iteration, except in complex scenarios, like an item with a paragraph,
 685                 // a list, and another paragraph; or an item with two types of list (itemise then enumerate, for instance).
 686
 687                 // Close the item.
 688                 closeTag(xs, style.docbookitemtag(), style.docbookitemtagtype());
 689                 closeTag(xs, style.docbookitemwrappertag(), style.docbookitemwrappertagtype());
 690         }
 691
 692         // Close this environment in exactly the same way as it was opened.
 693         closeTag(xs, envstyle.docbooktag(), envstyle.docbooktagtype());
 694         closeTag(xs, envstyle.docbookwrappertag(), envstyle.docbookwrappertagtype());
 695
 696         return envend;
 697 }
 698
 699
 700 void makeCommand(
 701                 Text const & text,
 702                 Buffer const & buf,
 703                 XMLStream & xs,
 704                 OutputParams const & runparams,
 705                 ParagraphList::const_iterator const & par)
 706 {
 707         // Unlike XHTML, no need for labels, as they are handled by DocBook tags.
 708         auto const begin = text.paragraphs().begin();
 709         auto const end = text.paragraphs().end();
 710         auto nextpar = par;
 711         ++nextpar;
 712
 713         // Generate this command.
 714         auto prevpar = text.paragraphs().getParagraphBefore(par);
 715         openParTag(xs, &*par, prevpar);
 716
 717         auto pars = par->simpleDocBookOnePar(buf, runparams,text.outerFont(distance(begin, par)));
 718         for (auto & parXML : pars)
 719                 // TODO: decide what to do with openParTag/closeParTag in new lines.
 720                 xs << XMLStream::ESCAPE_NONE << parXML;
 721
 722         closeParTag(xs, &*par, (nextpar != end) ? &*nextpar : nullptr);
 723 }
 724
 725
 726 bool isLayoutSectioning(Layout const & lay)
 727 {
 728         if (lay.docbooksection()) // Special case: some DocBook styles must be handled as sections.
 729                 return true;
 730         else if (lay.category() == from_utf8("Sectioning") || lay.docbooktag() == "section") // Generic case.
 731                 return lay.toclevel != Layout::NOT_IN_TOC;
 732         return false;
 733 }
 734
 735
 736 bool isLayoutSectioningOrSimilar(Layout const & lay)
 737 {
 738         return isLayoutSectioning(lay) || lay.docbooktag() == "bridgehead";
 739 }
 740
 741
 742 using DocBookDocumentSectioning = tuple<bool, pit_type>;
 743
 744
 745 struct DocBookInfoTag
 746 {
 747         const set<pit_type> shouldBeInInfo;
 748         const set<pit_type> mustBeInInfo; // With the notable exception of the abstract!
 749         const set<pit_type> abstract;
 750         const bool abstractLayout;
 751         pit_type bpit;
 752         pit_type epit;
 753
 754         DocBookInfoTag(const set<pit_type> & shouldBeInInfo, const set<pit_type> & mustBeInInfo,
 755                                    const set<pit_type> & abstract, bool abstractLayout, pit_type bpit, pit_type epit) :
 756                                    shouldBeInInfo(shouldBeInInfo), mustBeInInfo(mustBeInInfo), abstract(abstract),
 757                                    abstractLayout(abstractLayout), bpit(bpit), epit(epit) {}
 758 };
 759
 760
 761 DocBookDocumentSectioning hasDocumentSectioning(ParagraphList const &paragraphs, pit_type bpit, pit_type const epit) {
 762         bool documentHasSections = false;
 763
 764         while (bpit < epit) {
 765                 Layout const &style = paragraphs[bpit].layout();
 766                 documentHasSections |= isLayoutSectioningOrSimilar(style);
 767
 768                 if (documentHasSections)
 769                         break;
 770                 bpit += 1;
 771         }
 772         // Paragraphs before the first section: [ runparams.par_begin ; eppit )
 773
 774         return make_tuple(documentHasSections, bpit);
 775 }
 776
 777
 778 bool hasOnlyNotes(Paragraph const & par)
 779 {
 780         // Precondition: the paragraph is not empty. Otherwise, the function will always return true...
 781         for (int i = 0; i < par.size(); ++i)
 782                 // If you find something that is not an inset (like actual text) or an inset that is not a note,
 783                 // return false.
 784                 if (!par.isInset(i) || par.getInset(i)->lyxCode() != NOTE_CODE)
 785                         return false;
 786
 787         // An empty paragraph may still require some output.
 788         if (par.layout().docbooksection())
 789                 return false;
 790
 791         // There should be really no content here.
 792         return true;
 793 }
 794
 795
 796 DocBookInfoTag getParagraphsWithInfo(ParagraphList const &paragraphs,
 797                                                                          pit_type bpit, pit_type const epit,
 798                                                                          // Typically, bpit is the beginning of the document and epit the end of the
 799                                                                          // document *or* the first section.
 800                                                                          bool documentHasSections,
 801                                                                          bool detectUnlayoutedAbstract
 802                                                                          // Whether paragraphs with no specific layout should be detected as abstracts.
 803                                                                          // For inner sections, an abstract should only be detected if it has a specific
 804                                                                          // layout. For others, anything that might look like an abstract should be sought.
 805                                                                          ) {
 806         set<pit_type> shouldBeInInfo;
 807         set<pit_type> mustBeInInfo;
 808         set<pit_type> abstractWithLayout;
 809         set<pit_type> abstractNoLayout;
 810
 811         // Find the first non empty paragraph by mutating bpit.
 812         while (bpit < epit) {
 813                 Paragraph const &par = paragraphs[bpit];
 814                 if (par.empty() || hasOnlyNotes(par))
 815                         bpit += 1;
 816                 else
 817                         break;
 818         }
 819
 820         // Traverse everything that might belong to <info>.
 821         bool hasAbstractLayout = false;
 822         pit_type cpit = bpit;
 823         for (; cpit < epit; ++cpit) {
 824                 // Skip paragraphs that don't generate anything in DocBook.
 825                 Paragraph const & par = paragraphs[cpit];
 826                 Layout const &style = par.layout();
 827                 if (hasOnlyNotes(par))
 828                         continue;
 829
 830                 // There should never be any section here, except for the first paragraph (a title can be part of <info>).
 831                 // (Just a sanity check: if this fails, this function could end up processing the whole document.)
 832                 if (cpit != bpit && isLayoutSectioningOrSimilar(par.layout())) {
 833                         LYXERR0("Assertion failed: section found in potential <info> paragraphs.");
 834                         break;
 835                 }
 836
 837                 // If this is marked as an abstract by the layout, put it in the right set.
 838                 if (style.docbookabstract()) {
 839                         hasAbstractLayout = true;
 840                         abstractWithLayout.emplace(cpit);
 841                         continue;
 842                 }
 843
 844                 // Based on layout information, store this paragraph in one set: should be in <info>, must be,
 845                 // or abstract (either because of layout or of position).
 846                 if (style.docbookininfo() == "always")
 847                         mustBeInInfo.emplace(cpit);
 848                 else if (style.docbookininfo() == "maybe")
 849                         shouldBeInInfo.emplace(cpit);
 850                 else if (documentHasSections && !hasAbstractLayout && detectUnlayoutedAbstract &&
 851                                 (style.docbooktag() == "NONE" || style.docbooktag() == "para") &&
 852                                 style.docbookwrappertag() == "NONE")
 853                         // In this case, it is very likely that style.docbookininfo() == "never"! Be extra careful
 854                         // about anything that gets caught here.
 855                         abstractNoLayout.emplace(cpit);
 856                 else // This should definitely not be in <info>.
 857                         break;
 858         }
 859         // Now, cpit points to the first paragraph that no more has things that could go in <info>.
 860         // bpit is the beginning of the <info> part.
 861
 862         return DocBookInfoTag(shouldBeInInfo, mustBeInInfo,
 863                                               hasAbstractLayout ? abstractWithLayout : abstractNoLayout,
 864                                               hasAbstractLayout, bpit, cpit);
 865 }
 866
 867 } // end anonymous namespace
 868
 869
 870 ParagraphList::const_iterator makeAny(Text const &text,
 871                                       Buffer const &buf,
 872                                       XMLStream &xs,
 873                                       OutputParams const &runparams,
 874                                       ParagraphList::const_iterator par)
 875 {
 876         switch (par->layout().latextype) {
 877         case LATEX_COMMAND:
 878                 makeCommand(text, buf, xs, runparams, par);
 879                 break;
 880         case LATEX_ENVIRONMENT:
 881                 makeEnvironment(text, buf, xs, runparams, par);
 882                 break;
 883         case LATEX_LIST_ENVIRONMENT:
 884         case LATEX_ITEM_ENVIRONMENT:
 885                 // Only case when makeAny() might consume more than one paragraph.
 886                 return makeListEnvironment(text, buf, xs, runparams, par);
 887         case LATEX_PARAGRAPH:
 888                 makeParagraph(text, buf, xs, runparams, par);
 889                 break;
 890         case LATEX_BIB_ENVIRONMENT:
 891                 makeBibliography(text, buf, xs, runparams, par);
 892                 break;
 893         }
 894         ++par;
 895         return par;
 896 }
 897
 898
 899 xml::FontTag docbookStartFontTag(xml::FontTypes type)
 900 {
 901         return xml::FontTag(from_utf8(fontToDocBookTag(type)), from_utf8(fontToAttribute(type)), type);
 902 }
 903
 904
 905 xml::EndFontTag docbookEndFontTag(xml::FontTypes type)
 906 {
 907         return xml::EndFontTag(from_utf8(fontToDocBookTag(type)), type);
 908 }
 909
 910
 911 void outputDocBookInfo(
 912                 Text const & text,
 913                 Buffer const & buf,
 914                 XMLStream & xs,
 915                 OutputParams const & runparams,
 916                 ParagraphList const & paragraphs,
 917                 DocBookInfoTag const & info)
 918 {
 919         // Perform an additional check on the abstract. Sometimes, there are many paragraphs that should go
 920         // into the abstract, but none generates actual content. Thus, first generate to a temporary stream,
 921         // then only create the <abstract> tag if these paragraphs generate some content.
 922         // This check must be performed *before* a decision on whether or not to output <info> is made.
 923         bool hasAbstract = !info.abstract.empty();
 924         docstring abstract;
 925         if (hasAbstract) {
 926                 // Generate the abstract XML into a string before further checks.
 927                 // Usually, makeAny only generates one paragraph at a time. However, for the specific case of lists, it might
 928                 // generate more than one paragraph, as indicated in the return value.
 929                 odocstringstream os2;
 930                 XMLStream xs2(os2);
 931
 932                 set<pit_type> doneParas;
 933                 for (auto const & p : info.abstract) {
 934                         if (doneParas.find(p) == doneParas.end()) {
 935                                 auto oldPar = paragraphs.iterator_at(p);
 936                                 auto newPar = makeAny(text, buf, xs2, runparams, oldPar);
 937
 938                                 // Insert the indices of all the paragraphs that were just generated (typically, one).
 939                                 // **Make the hypothesis that, when an abstract has a list, all its items are consecutive.**
 940                                 pit_type id = p;
 941                                 while (oldPar != newPar) {
 942                                         doneParas.emplace(id);
 943                                         ++oldPar;
 944                                         ++id;
 945                                 }
 946                         }
 947                 }
 948
 949                 // Actually output the abstract if there is something to do. Don't count line feeds or spaces in this,
 950                 // even though they must be properly output if there is some abstract.
 951                 abstract = os2.str();
 952                 docstring cleaned = abstract;
 953                 cleaned.erase(std::remove_if(cleaned.begin(), cleaned.end(), lyx::isSpace), cleaned.end());
 954
 955                 // Nothing? Then there is no abstract!
 956                 if (cleaned.empty())
 957                         hasAbstract = false;
 958         }
 959
 960         // The abstract must go in <info>. Otherwise, decide whether to open <info> based on the layouts.
 961         bool needInfo = !info.mustBeInInfo.empty() || hasAbstract;
 962
 963         // Start the <info> tag if required.
 964         if (needInfo) {
 965                 xs.startDivision(false);
 966                 xs << xml::StartTag("info");
 967                 xs << xml::CR();
 968         }
 969
 970         // Output the elements that should go in <info>, before and after the abstract.
 971         for (auto pit : info.shouldBeInInfo) // Typically, the title: these elements are so important and ubiquitous
 972                 // that mandating a wrapper like <info> would repel users. Thus, generate them first.
 973                 makeAny(text, buf, xs, runparams, paragraphs.iterator_at(pit));
 974         for (auto pit : info.mustBeInInfo)
 975                 makeAny(text, buf, xs, runparams, paragraphs.iterator_at(pit));
 976
 977         // If there is no title, generate one (required for the document to be valid).
 978         // This code is called for the main document, for table cells, etc., so be precise in this condition.
 979         if (text.isMainText() && info.shouldBeInInfo.empty() && !runparams.inInclude) {
 980                 xs << xml::StartTag("title");
 981                 xs << "Untitled Document";
 982                 xs << xml::EndTag("title");
 983                 xs << xml::CR();
 984         }
 985
 986         // Always output the abstract as the last item of the <info>, as it requires special treatment (especially if
 987         // it contains several paragraphs that are empty).
 988         if (hasAbstract) {
 989                 if (info.abstractLayout) {
 990                         xs << XMLStream::ESCAPE_NONE << abstract;
 991                         xs << xml::CR();
 992                 } else {
 993                         string tag = paragraphs[*info.abstract.begin()].layout().docbookforceabstracttag();
 994                         if (tag == "NONE")
 995                                 tag = "abstract";
 996
 997                         if (!xs.isLastTagCR())
 998                                 xs << xml::CR();
 999
1000                         xs << xml::StartTag(tag);
1001                         xs << xml::CR();
1002                         xs << XMLStream::ESCAPE_NONE << abstract;
1003                         xs << xml::EndTag(tag);
1004                         xs << xml::CR();
1005                 }
1006         }
1007
1008         // End the <info> tag if it was started.
1009         if (needInfo) {
1010                 if (!xs.isLastTagCR())
1011                         xs << xml::CR();
1012
1013                 xs << xml::EndTag("info");
1014                 xs << xml::CR();
1015                 xs.endDivision();
1016         }
1017 }
1018
1019
1020 void docbookSimpleAllParagraphs(
1021                 Text const & text,
1022                 Buffer const & buf,
1023                 XMLStream & xs,
1024                 OutputParams const & runparams)
1025 {
1026         // Handle the given text, supposing it has no sections (i.e. a "simple" text). The input may vary in length
1027         // between a single paragraph to a whole document.
1028         pit_type const bpit = runparams.par_begin;
1029         pit_type const epit = runparams.par_end;
1030         ParagraphList const &paragraphs = text.paragraphs();
1031
1032         // First, the <info> tag.
1033         DocBookInfoTag info = getParagraphsWithInfo(paragraphs, bpit, epit, false, true);
1034         outputDocBookInfo(text, buf, xs, runparams, paragraphs, info);
1035
1036         // Then, the content. It starts where the <info> ends.
1037         auto par = paragraphs.iterator_at(info.epit);
1038         auto end = paragraphs.iterator_at(epit);
1039         while (par != end) {
1040                 if (!hasOnlyNotes(*par))
1041                         par = makeAny(text, buf, xs, runparams, par);
1042                 else
1043                         ++par;
1044         }
1045 }
1046
1047
1048 void docbookParagraphs(Text const &text,
1049                                            Buffer const &buf,
1050                                            XMLStream &xs,
1051                                            OutputParams const &runparams) {
1052         ParagraphList const &paragraphs = text.paragraphs();
1053         if (runparams.par_begin == runparams.par_end) {
1054                 runparams.par_begin = 0;
1055                 runparams.par_end = paragraphs.size();
1056         }
1057         pit_type bpit = runparams.par_begin;
1058         pit_type const epit = runparams.par_end;
1059         LASSERT(bpit < epit,
1060                         {
1061                                 xs << XMLStream::ESCAPE_NONE << "<!-- DocBook output error! -->\n";
1062                                 return;
1063                         });
1064
1065         std::stack<std::pair<int, string>> headerLevels; // Used to determine when to open/close sections: store the depth
1066         // of the section and the tag that was used to open it.
1067
1068         // Detect whether the document contains sections. If there are no sections, treatment is largely simplified.
1069         // In particular, there can't be an abstract, unless it is manually marked.
1070         bool documentHasSections;
1071         pit_type eppit;
1072         tie(documentHasSections, eppit) = hasDocumentSectioning(paragraphs, bpit, epit);
1073
1074         // Deal with "simple" documents, i.e. those without sections.
1075         if (!documentHasSections) {
1076                 docbookSimpleAllParagraphs(text, buf, xs, runparams);
1077                 return;
1078         }
1079
1080         // Output the first <info> tag (or just the title).
1081         DocBookInfoTag info = getParagraphsWithInfo(paragraphs, bpit, eppit, true, true);
1082         outputDocBookInfo(text, buf, xs, runparams, paragraphs, info);
1083         bpit = info.epit;
1084
1085         // Then, iterate through the paragraphs of this document.
1086         bool currentlyInAppendix = false;
1087
1088         auto par = text.paragraphs().iterator_at(bpit);
1089         auto end = text.paragraphs().iterator_at(epit);
1090         while (par != end) {
1091                 OutputParams ourparams = runparams;
1092
1093                 if (par->params().startOfAppendix())
1094                         currentlyInAppendix = true;
1095                 if (hasOnlyNotes(*par)) {
1096                         ++par;
1097                         continue;
1098                 }
1099
1100                 Layout const &style = par->layout();
1101
1102                 // Think about adding <section> and/or </section>s.
1103                 if (isLayoutSectioning(style)) {
1104                         int level = style.toclevel;
1105
1106                         // Need to close a previous section if it has the same level or a higher one (close <section> if opening a
1107                         // <h2> after a <h2>, <h3>, <h4>, <h5> or <h6>). More examples:
1108                         //   - current: h2; back: h1; do not close any <section>
1109                         //   - current: h1; back: h2; close two <section> (first the <h2>, then the <h1>, so a new <h1> can come)
1110                         while (!headerLevels.empty() && level <= headerLevels.top().first) {
1111                                 // Output the tag only if it corresponds to a legit section.
1112                                 int stackLevel = headerLevels.top().first;
1113                                 if (stackLevel != Layout::NOT_IN_TOC) {
1114                                         xs << xml::EndTag(headerLevels.top().second);
1115                                         xs << xml::CR();
1116                                 }
1117                                 headerLevels.pop();
1118                         }
1119
1120                         // Open the new section: first push it onto the stack, then output it in DocBook.
1121                         string sectionTag = (currentlyInAppendix && style.docbooksectiontag() == "chapter") ?
1122                                                                 "appendix" : style.docbooksectiontag();
1123                         headerLevels.push(std::make_pair(level, sectionTag));
1124
1125                         // Some sectioning-like elements should not be output (such as FrontMatter).
1126                         if (level != Layout::NOT_IN_TOC) {
1127                                 // Look for a label in the title, i.e. a InsetLabel as a child.
1128                                 docstring id = docstring();
1129                                 for (pos_type i = 0; i < par->size(); ++i) {
1130                                         Inset const *inset = par->getInset(i);
1131                                         if (inset) {
1132                                                 if (auto label = dynamic_cast<InsetLabel const *>(inset)) {
1133                                                         // Generate the attributes for the section if need be.
1134                                                         id += "xml:id=\"" + xml::cleanID(label->screenLabel()) + "\"";
1135
1136                                                         // Don't output the ID as a DocBook <anchor>.
1137                                                         ourparams.docbook_anchors_to_ignore.emplace(label->screenLabel());
1138
1139                                                         // Cannot have multiple IDs per tag. If there is another ID inset in the document, it will
1140                                                         // be output as a DocBook anchor.
1141                                                         break;
1142                                                 }
1143                                         }
1144                                 }
1145
1146                                 // Write the open tag for this section.
1147                                 docstring attrs;
1148                                 if (!id.empty())
1149                                         attrs = id;
1150                                 xs << xml::StartTag(sectionTag, attrs);
1151                                 xs << xml::CR();
1152                         }
1153                 }
1154
1155                 // Close all sections before the bibliography.
1156                 // TODO: Only close all when the bibliography is at the end of the document? Or force to output the bibliography at the end of the document? Or don't care (as allowed by DocBook)?
1157                 if (!par->insetList().empty()) {
1158                         Inset const *firstInset = par->getInset(0);
1159                         if (firstInset && (firstInset->lyxCode() == BIBITEM_CODE || firstInset->lyxCode() == BIBTEX_CODE)) {
1160                                 while (!headerLevels.empty()) {
1161                                         int level = headerLevels.top().first;
1162                                         docstring tag = from_utf8("</" + headerLevels.top().second + ">");
1163                                         headerLevels.pop();
1164
1165                                         // Output the tag only if it corresponds to a legit section.
1166                                         if (level != Layout::NOT_IN_TOC) {
1167                                                 xs << XMLStream::ESCAPE_NONE << tag;
1168                                                 xs << xml::CR();
1169                                         }
1170                                 }
1171                         }
1172                 }
1173
1174                 // Generate the <info> tag if a section was just opened.
1175                 // Some sections may require abstracts (mostly parts, in books: DocBookForceAbstractTag will not be NONE),
1176                 // others can still have an abstract (it must be detected so that it can be output at the right place).
1177                 // TODO: docbookforceabstracttag is a bit contrived here, but it does the job. Having another field just for this would be cleaner, but that's just for <part> and <partintro>, so it's probably not worth the effort.
1178                 if (isLayoutSectioning(style)) {
1179                         // This abstract may be found between the next paragraph and the next title.
1180                         pit_type cpit = std::distance(text.paragraphs().begin(), par);
1181                         pit_type ppit = std::get<1>(hasDocumentSectioning(paragraphs, cpit + 1L, epit));
1182
1183                         // Generate this abstract (this code corresponds to parts of outputDocBookInfo).
1184                         DocBookInfoTag secInfo = getParagraphsWithInfo(paragraphs, cpit, ppit, true,
1185                                                                                                   style.docbookforceabstracttag() != "NONE");
1186
1187                         if (!secInfo.mustBeInInfo.empty() || !secInfo.shouldBeInInfo.empty() || !secInfo.abstract.empty()) {
1188                                 // Generate the <info>, if required. If DocBookForceAbstractTag != NONE, this abstract will not be in
1189                                 // <info>, unlike other ("standard") abstracts.
1190                                 bool hasStandardAbstract = !secInfo.abstract.empty() && style.docbookforceabstracttag() == "NONE";
1191                                 bool needInfo = !secInfo.mustBeInInfo.empty() || hasStandardAbstract;
1192
1193                                 if (needInfo) {
1194                                         xs.startDivision(false);
1195                                         xs << xml::StartTag("info");
1196                                         xs << xml::CR();
1197                                 }
1198
1199                                 // Output the elements that should go in <info>, before and after the abstract.
1200                                 for (auto pit : secInfo.shouldBeInInfo) // Typically, the title: these elements are so important and ubiquitous
1201                                         // that mandating a wrapper like <info> would repel users. Thus, generate them first.
1202                                         makeAny(text, buf, xs, ourparams, paragraphs.iterator_at(pit));
1203                                 for (auto pit : secInfo.mustBeInInfo)
1204                                         makeAny(text, buf, xs, ourparams, paragraphs.iterator_at(pit));
1205
1206                                 // Deal with the abstract in <info> if it is standard (i.e. its tag is <abstract>).
1207                                 if (!secInfo.abstract.empty() && hasStandardAbstract) {
1208                                         if (!secInfo.abstractLayout) {
1209                                                 xs << xml::StartTag("abstract");
1210                                                 xs << xml::CR();
1211                                         }
1212
1213                                         for (auto const &p : secInfo.abstract)
1214                                                 makeAny(text, buf, xs, ourparams, paragraphs.iterator_at(p));
1215
1216                                         if (!secInfo.abstractLayout) {
1217                                                 xs << xml::EndTag("abstract");
1218                                                 xs << xml::CR();
1219                                         }
1220                                 }
1221
1222                                 // End the <info> tag if it was started.
1223                                 if (needInfo) {
1224                                         if (!xs.isLastTagCR())
1225                                                 xs << xml::CR();
1226
1227                                         xs << xml::EndTag("info");
1228                                         xs << xml::CR();
1229                                         xs.endDivision();
1230                                 }
1231
1232                                 // Deal with the abstract outside <info> if it is not standard (i.e. its tag is layout-defined).
1233                                 if (!secInfo.abstract.empty() && !hasStandardAbstract) {
1234                                         // Assert: style.docbookforceabstracttag() != NONE.
1235                                         xs << xml::StartTag(style.docbookforceabstracttag());
1236                                         xs << xml::CR();
1237                                         for (auto const &p : secInfo.abstract)
1238                                                 makeAny(text, buf, xs, ourparams, paragraphs.iterator_at(p));
1239                                         xs << xml::EndTag(style.docbookforceabstracttag());
1240                                         xs << xml::CR();
1241                                 }
1242
1243                                 // Skip all the text that has just been generated.
1244                                 par = paragraphs.iterator_at(secInfo.epit);
1245                         } else {
1246                                 // No <info> tag to generate, proceed as for normal paragraphs.
1247                                 par = makeAny(text, buf, xs, ourparams, par);
1248                         }
1249                 } else {
1250                         // Generate this paragraph, as it has nothing special.
1251                         par = makeAny(text, buf, xs, ourparams, par);
1252                 }
1253         }
1254
1255         // If need be, close <section>s, but only at the end of the document (otherwise, dealt with at the beginning
1256         // of the loop).
1257         while (!headerLevels.empty() && headerLevels.top().first > Layout::NOT_IN_TOC) {
1258                 docstring tag = from_utf8("</" + headerLevels.top().second + ">");
1259                 headerLevels.pop();
1260                 xs << XMLStream::ESCAPE_NONE << tag;
1261                 xs << xml::CR();
1262         }
1263 }
1264
1265 } // namespace lyx