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         Layout const & lay = par->layout();
 286
 287         if (par == prevpar)
 288                 prevpar = nullptr;
 289
 290         // When should the wrapper be opened here? Only if the previous paragraph has the SAME wrapper tag
 291         // (usually, they won't have the same layout) and the CURRENT one allows merging.
 292         // The main use case is author information in several paragraphs: if the name of the author is the
 293         // first paragraph of an author, then merging with the previous tag does not make sense. Say the
 294         // next paragraph is the affiliation, then it should be output in the same <author> tag (different
 295         // layout, same wrapper tag).
 296         bool openWrapper = lay.docbookwrappertag() != "NONE";
 297         if (prevpar != nullptr) {
 298                 Layout const & prevlay = prevpar->layout();
 299                 if (prevlay.docbookwrappertag() != "NONE") {
 300                         if (prevlay.docbookwrappertag() == lay.docbookwrappertag() &&
 301                                         prevlay.docbookwrapperattr() == lay.docbookwrapperattr())
 302                                 openWrapper = !lay.docbookwrappermergewithprevious();
 303                         else
 304                                 openWrapper = true;
 305                 }
 306         }
 307
 308         // Main logic.
 309         if (openWrapper)
 310                 openTag(xs, lay.docbookwrappertag(), lay.docbookwrapperattr(), lay.docbookwrappertagtype());
 311
 312         const string & tag = lay.docbooktag();
 313         if (tag != "NONE") {
 314                 auto xmltag = xml::ParTag(tag, lay.docbookattr());
 315                 if (!xs.isTagOpen(xmltag, 1)) { // Don't nest a paragraph directly in a paragraph.
 316                         // TODO: required or not?
 317                         // TODO: avoid creating a ParTag object just for this query...
 318                         openTag(xs, lay.docbooktag(), lay.docbookattr(), lay.docbooktagtype());
 319                         openTag(xs, lay.docbookinnertag(), lay.docbookinnerattr(), lay.docbookinnertagtype());
 320                 }
 321         }
 322
 323         openTag(xs, lay.docbookitemtag(), lay.docbookitemattr(), lay.docbookitemtagtype());
 324         openTag(xs, lay.docbookiteminnertag(), lay.docbookiteminnerattr(), lay.docbookiteminnertagtype());
 325 }
 326
 327
 328 void closeParTag(XMLStream & xs, Paragraph const * par, Paragraph const * nextpar)
 329 {
 330         if (par == nextpar)
 331                 nextpar = nullptr;
 332
 333         // See comment in openParTag.
 334         Layout const & lay = par->layout();
 335         bool closeWrapper = lay.docbookwrappertag() != "NONE";
 336         if (nextpar != nullptr) {
 337                 Layout const & nextlay = nextpar->layout();
 338                 if (nextlay.docbookwrappertag() != "NONE") {
 339                         if (nextlay.docbookwrappertag() == lay.docbookwrappertag() &&
 340                                         nextlay.docbookwrapperattr() == lay.docbookwrapperattr())
 341                                 closeWrapper = !nextlay.docbookwrappermergewithprevious();
 342                         else
 343                                 closeWrapper = true;
 344                 }
 345         }
 346
 347         // Main logic.
 348         closeTag(xs, lay.docbookiteminnertag(), lay.docbookiteminnertagtype());
 349         closeTag(xs, lay.docbookitemtag(), lay.docbookitemtagtype());
 350         closeTag(xs, lay.docbookinnertag(), lay.docbookinnertagtype());
 351         closeTag(xs, lay.docbooktag(), lay.docbooktagtype());
 352         if (closeWrapper)
 353                 closeTag(xs, lay.docbookwrappertag(), lay.docbookwrappertagtype());
 354 }
 355
 356
 357 void makeBibliography(
 358                 Text const & text,
 359                 Buffer const & buf,
 360                 XMLStream & xs,
 361                 OutputParams const & runparams,
 362                 ParagraphList::const_iterator const & par)
 363 {
 364         // If this is the first paragraph in a bibliography, open the bibliography tag.
 365         auto const * pbegin_before = text.paragraphs().getParagraphBefore(par);
 366         if (pbegin_before == nullptr || (pbegin_before && pbegin_before->layout().latextype != LATEX_BIB_ENVIRONMENT)) {
 367                 xs << xml::StartTag("bibliography");
 368                 xs << xml::CR();
 369         }
 370
 371         // Start the precooked bibliography entry. This is very much like opening a paragraph tag.
 372         // Don't forget the citation ID!
 373         docstring attr;
 374         for (auto i = 0; i < par->size(); ++i) {
 375                 Inset const *ip = par->getInset(i);
 376                 if (!ip)
 377                         continue;
 378                 if (const auto * bibitem = dynamic_cast<const InsetBibitem*>(ip)) {
 379                         attr = from_utf8("xml:id='") + bibitem->getParam("key") + 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                                 if (p != pars.end())
 557                                         xs << xml::CR();
 558                         }
 559                 } else {
 560                         for (auto const & p : pars) {
 561                                 openTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnerattr(), par->layout().docbookiteminnertagtype());
 562                                 xs << XMLStream::ESCAPE_NONE << p;
 563                                 closeTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnertagtype());
 564                         }
 565                 }
 566         } else {
 567                 makeAny(text, buf, xs, runparams, par);
 568         }
 569
 570         // Close the environment.
 571         closeParTag(xs, &*par, (nextpar != end) ? &*nextpar : nullptr); // TODO: switch in layout for par/block?
 572 }
 573
 574
 575 ParagraphList::const_iterator findEndOfEnvironment(
 576                 ParagraphList::const_iterator const & pstart,
 577                 ParagraphList::const_iterator const & pend)
 578 {
 579         // Copy-paste from XHTML. Should be factored out at some point...
 580         ParagraphList::const_iterator p = pstart;
 581         Layout const & bstyle = p->layout();
 582         size_t const depth = p->params().depth();
 583         for (++p; p != pend; ++p) {
 584                 Layout const & style = p->layout();
 585                 // It shouldn't happen that e.g. a section command occurs inside
 586                 // a quotation environment, at a higher depth, but as of 6/2009,
 587                 // it can happen. We pretend that it's just at lowest depth.
 588                 if (style.latextype == LATEX_COMMAND)
 589                         return p;
 590
 591                 // If depth is down, we're done
 592                 if (p->params().depth() < depth)
 593                         return p;
 594
 595                 // If depth is up, we're not done
 596                 if (p->params().depth() > depth)
 597                         continue;
 598
 599                 // FIXME I am not sure about the first check.
 600                 // Surely we *could* have different layouts that count as
 601                 // LATEX_PARAGRAPH, right?
 602                 if (style.latextype == LATEX_PARAGRAPH || style != bstyle)
 603                         return p;
 604         }
 605         return pend;
 606 }
 607
 608
 609 ParagraphList::const_iterator makeListEnvironment(Text const &text,
 610                                                                                                   Buffer const &buf,
 611                                                           XMLStream &xs,
 612                                                           OutputParams const &runparams,
 613                                                           ParagraphList::const_iterator const & begin)
 614 {
 615         auto par = begin;
 616         auto const end = text.paragraphs().end();
 617         auto const envend = findEndOfEnvironment(par, end);
 618
 619         // Output the opening tag for this environment.
 620         Layout const & envstyle = par->layout();
 621         openTag(xs, envstyle.docbookwrappertag(), envstyle.docbookwrapperattr(), envstyle.docbookwrappertagtype());
 622         openTag(xs, envstyle.docbooktag(), envstyle.docbookattr(), envstyle.docbooktagtype());
 623
 624         // Handle the content of the list environment, item by item.
 625         while (par != envend) {
 626                 Layout const & style = par->layout();
 627
 628                 // Open the item wrapper.
 629                 openTag(xs, style.docbookitemwrappertag(), style.docbookitemwrapperattr(), style.docbookitemwrappertagtype());
 630
 631                 // Generate the label, if need be. If it is taken from the text, sep != 0 and corresponds to the first
 632                 // character after the label.
 633                 pos_type sep = 0;
 634                 if (style.labeltype != LABEL_NO_LABEL && style.docbookitemlabeltag() != "NONE") {
 635                         if (style.labeltype == LABEL_MANUAL) {
 636                                 // Only variablelist gets here (or similar items defined as an extension in the layout).
 637                                 openTag(xs, style.docbookitemlabeltag(), style.docbookitemlabelattr(), style.docbookitemlabeltagtype());
 638                                 sep = 1 + par->firstWordDocBook(xs, runparams);
 639                                 closeTag(xs, style.docbookitemlabeltag(), style.docbookitemlabeltagtype());
 640                         } else {
 641                                 // Usual cases: maybe there is something specified at the layout level. Highly unlikely, though.
 642                                 docstring const lbl = par->params().labelString();
 643
 644                                 if (!lbl.empty()) {
 645                                         openTag(xs, style.docbookitemlabeltag(), style.docbookitemlabelattr(), style.docbookitemlabeltagtype());
 646                                         xs << lbl;
 647                                         closeTag(xs, style.docbookitemlabeltag(), style.docbookitemlabeltagtype());
 648                                 }
 649                         }
 650                 }
 651
 652                 // Open the item (after the wrapper and the label).
 653                 openTag(xs, style.docbookitemtag(), style.docbookitemattr(), style.docbookitemtagtype());
 654
 655                 // Generate the content of the item.
 656                 if (sep < par->size()) {
 657                         auto pars = par->simpleDocBookOnePar(buf, runparams,
 658                                                              text.outerFont(std::distance(text.paragraphs().begin(), par)), sep);
 659                         for (auto &p : pars) {
 660                                 openTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnerattr(),
 661                                         par->layout().docbookiteminnertagtype());
 662                                 xs << XMLStream::ESCAPE_NONE << p;
 663                                 closeTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnertagtype());
 664                         }
 665                 } else {
 666                         // DocBook doesn't like emptiness.
 667                         compTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnerattr(),
 668                                 par->layout().docbookiteminnertagtype());
 669                 }
 670
 671                 // If the next item is deeper, it must go entirely within this item (do it recursively).
 672                 // By construction, with findEndOfEnvironment, depth can only stay constant or increase, never decrease.
 673                 depth_type currentDepth = par->getDepth();
 674                 ++par;
 675                 while (par != envend && par->getDepth() != currentDepth)
 676                         par = makeAny(text, buf, xs, runparams, par);
 677                 // Usually, this loop only makes one iteration, except in complex scenarios, like an item with a paragraph,
 678                 // a list, and another paragraph; or an item with two types of list (itemise then enumerate, for instance).
 679
 680                 // Close the item.
 681                 closeTag(xs, style.docbookitemtag(), style.docbookitemtagtype());
 682                 closeTag(xs, style.docbookitemwrappertag(), style.docbookitemwrappertagtype());
 683         }
 684
 685         // Close this environment in exactly the same way as it was opened.
 686         closeTag(xs, envstyle.docbooktag(), envstyle.docbooktagtype());
 687         closeTag(xs, envstyle.docbookwrappertag(), envstyle.docbookwrappertagtype());
 688
 689         return envend;
 690 }
 691
 692
 693 void makeCommand(
 694                 Text const & text,
 695                 Buffer const & buf,
 696                 XMLStream & xs,
 697                 OutputParams const & runparams,
 698                 ParagraphList::const_iterator const & par)
 699 {
 700         // Unlike XHTML, no need for labels, as they are handled by DocBook tags.
 701         auto const begin = text.paragraphs().begin();
 702         auto const end = text.paragraphs().end();
 703         auto nextpar = par;
 704         ++nextpar;
 705
 706         // Generate this command.
 707         auto prevpar = text.paragraphs().getParagraphBefore(par);
 708         openParTag(xs, &*par, prevpar);
 709
 710         auto pars = par->simpleDocBookOnePar(buf, runparams,text.outerFont(distance(begin, par)));
 711         for (auto & parXML : pars)
 712                 // TODO: decide what to do with openParTag/closeParTag in new lines.
 713                 xs << XMLStream::ESCAPE_NONE << parXML;
 714
 715         closeParTag(xs, &*par, (nextpar != end) ? &*nextpar : nullptr);
 716 }
 717
 718
 719 bool isLayoutSectioning(Layout const & lay)
 720 {
 721         return lay.docbooksection() || lay.category() == from_utf8("Sectioning");
 722 }
 723
 724
 725 using DocBookDocumentSectioning = tuple<bool, pit_type>;
 726
 727
 728 struct DocBookInfoTag
 729 {
 730         const set<pit_type> shouldBeInInfo;
 731         const set<pit_type> mustBeInInfo; // With the notable exception of the abstract!
 732         const set<pit_type> abstract;
 733         const bool abstractLayout;
 734         pit_type bpit;
 735         pit_type epit;
 736
 737         DocBookInfoTag(const set<pit_type> & shouldBeInInfo, const set<pit_type> & mustBeInInfo,
 738                                    const set<pit_type> & abstract, bool abstractLayout, pit_type bpit, pit_type epit) :
 739                                    shouldBeInInfo(shouldBeInInfo), mustBeInInfo(mustBeInInfo), abstract(abstract),
 740                                    abstractLayout(abstractLayout), bpit(bpit), epit(epit) {}
 741 };
 742
 743
 744 DocBookDocumentSectioning hasDocumentSectioning(ParagraphList const &paragraphs, pit_type bpit, pit_type const epit) {
 745         bool documentHasSections = false;
 746
 747         while (bpit < epit) {
 748                 Layout const &style = paragraphs[bpit].layout();
 749                 documentHasSections |= isLayoutSectioning(style);
 750
 751                 if (documentHasSections)
 752                         break;
 753                 bpit += 1;
 754         }
 755         // Paragraphs before the first section: [ runparams.par_begin ; eppit )
 756
 757         return make_tuple(documentHasSections, bpit);
 758 }
 759
 760
 761 bool hasOnlyNotes(Paragraph const & par)
 762 {
 763         // Precondition: the paragraph is not empty. Otherwise, the function will always return true...
 764         for (int i = 0; i < par.size(); ++i)
 765                 // If you find something that is not an inset (like actual text) or an inset that is not a note,
 766                 // return false.
 767                 if (!par.isInset(i) || par.getInset(i)->lyxCode() != NOTE_CODE)
 768                         return false;
 769
 770         // An empty paragraph may still require some output.
 771         if (par.layout().docbooksection())
 772                 return false;
 773
 774         // There should be really no content here.
 775         return true;
 776 }
 777
 778
 779 DocBookInfoTag getParagraphsWithInfo(ParagraphList const &paragraphs,
 780                                                                          pit_type bpit, pit_type const epit,
 781                                                                          // Typically, bpit is the beginning of the document and epit the end *or* the first section.
 782                                                                          bool documentHasSections) {
 783         set<pit_type> shouldBeInInfo;
 784         set<pit_type> mustBeInInfo;
 785         set<pit_type> abstractWithLayout;
 786         set<pit_type> abstractNoLayout;
 787
 788         // Find the first non empty paragraph by mutating bpit.
 789         while (bpit < epit) {
 790                 Paragraph const &par = paragraphs[bpit];
 791                 if (par.empty() || hasOnlyNotes(par))
 792                         bpit += 1;
 793                 else
 794                         break;
 795         }
 796
 797         // Traverse everything that might belong to <info>.
 798         bool hasAbstractLayout = false;
 799         pit_type cpit = bpit;
 800         for (; cpit < epit; ++cpit) {
 801                 // Skip paragraphs that don't generate anything in DocBook.
 802                 Paragraph const & par = paragraphs[cpit];
 803                 if (hasOnlyNotes(par))
 804                         continue;
 805
 806                 // There should never be any section here. (Just a sanity check: if this fails, this function could end up
 807                 // processing the whole document.)
 808                 if (isLayoutSectioning(par.layout())) {
 809                         LYXERR0("Assertion failed: section found in potential <info> paragraphs.");
 810                         break;
 811                 }
 812
 813                 // If this is marked as an abstract by the layout, put it in the right set.
 814                 if (par.layout().docbookabstract()) {
 815                         hasAbstractLayout = true;
 816                         abstractWithLayout.emplace(cpit);
 817                         continue;
 818                 }
 819
 820                 // Based on layout information, store this paragraph in one set: should be in <info>, must be,
 821                 // or abstract (either because of layout or of position).
 822                 Layout const &style = par.layout();
 823
 824                 if (style.docbookininfo() == "always")
 825                         mustBeInInfo.emplace(cpit);
 826                 else if (style.docbookininfo() == "maybe")
 827                         shouldBeInInfo.emplace(cpit);
 828                 else if (documentHasSections && !hasAbstractLayout)
 829                         abstractNoLayout.emplace(cpit);
 830                 else // This should definitely not be in <info>.
 831                         break;
 832         }
 833         // Now, cpit points to the first paragraph that no more has things that could go in <info>.
 834         // bpit is the beginning of the <info> part.
 835
 836         return DocBookInfoTag(shouldBeInInfo, mustBeInInfo,
 837                                               hasAbstractLayout ? abstractWithLayout : abstractNoLayout,
 838                                               hasAbstractLayout, bpit, cpit);
 839 }
 840
 841 } // end anonymous namespace
 842
 843
 844 ParagraphList::const_iterator makeAny(Text const &text,
 845                                       Buffer const &buf,
 846                                       XMLStream &xs,
 847                                       OutputParams const &runparams,
 848                                       ParagraphList::const_iterator par)
 849 {
 850         switch (par->layout().latextype) {
 851         case LATEX_COMMAND:
 852                 makeCommand(text, buf, xs, runparams, par);
 853                 break;
 854         case LATEX_ENVIRONMENT:
 855                 makeEnvironment(text, buf, xs, runparams, par);
 856                 break;
 857         case LATEX_LIST_ENVIRONMENT:
 858         case LATEX_ITEM_ENVIRONMENT:
 859                 // Only case when makeAny() might consume more than one paragraph.
 860                 return makeListEnvironment(text, buf, xs, runparams, par);
 861         case LATEX_PARAGRAPH:
 862                 makeParagraph(text, buf, xs, runparams, par);
 863                 break;
 864         case LATEX_BIB_ENVIRONMENT:
 865                 makeBibliography(text, buf, xs, runparams, par);
 866                 break;
 867         }
 868         ++par;
 869         return par;
 870 }
 871
 872
 873 xml::FontTag docbookStartFontTag(xml::FontTypes type)
 874 {
 875         return xml::FontTag(from_utf8(fontToDocBookTag(type)), from_utf8(fontToAttribute(type)), type);
 876 }
 877
 878
 879 xml::EndFontTag docbookEndFontTag(xml::FontTypes type)
 880 {
 881         return xml::EndFontTag(from_utf8(fontToDocBookTag(type)), type);
 882 }
 883
 884
 885 void outputDocBookInfo(
 886                 Text const & text,
 887                 Buffer const & buf,
 888                 XMLStream & xs,
 889                 OutputParams const & runparams,
 890                 ParagraphList const & paragraphs,
 891                 DocBookInfoTag const & info)
 892 {
 893         // Perform an additional check on the abstract. Sometimes, there are many paragraphs that should go
 894         // into the abstract, but none generates actual content. Thus, first generate to a temporary stream,
 895         // then only create the <abstract> tag if these paragraphs generate some content.
 896         // This check must be performed *before* a decision on whether or not to output <info> is made.
 897         bool hasAbstract = !info.abstract.empty();
 898         docstring abstract;
 899         if (hasAbstract) {
 900                 // Generate the abstract XML into a string before further checks.
 901                 odocstringstream os2;
 902                 XMLStream xs2(os2);
 903                 for (auto const & p : info.abstract)
 904                         makeAny(text, buf, xs2, runparams, paragraphs.iterator_at(p));
 905
 906                 // Actually output the abstract if there is something to do. Don't count line feeds or spaces in this,
 907                 // even though they must be properly output if there is some abstract.
 908                 abstract = os2.str();
 909                 docstring cleaned = abstract;
 910                 cleaned.erase(std::remove_if(cleaned.begin(), cleaned.end(), lyx::isSpace), cleaned.end());
 911
 912                 // Nothing? Then there is no abstract!
 913                 if (cleaned.empty())
 914                         hasAbstract = false;
 915         }
 916
 917         // The abstract must go in <info>. Otherwise, decide whether to open <info> based on the layouts.
 918         bool needInfo = !info.mustBeInInfo.empty() || hasAbstract;
 919
 920         // Start the <info> tag if required.
 921         if (needInfo) {
 922                 xs.startDivision(false);
 923                 xs << xml::StartTag("info");
 924                 xs << xml::CR();
 925         }
 926
 927         // Output the elements that should go in <info>, before and after the abstract.
 928         for (auto pit : info.shouldBeInInfo) // Typically, the title: these elements are so important and ubiquitous
 929                 // that mandating a wrapper like <info> would repel users. Thus, generate them first.
 930                 makeAny(text, buf, xs, runparams, paragraphs.iterator_at(pit));
 931         for (auto pit : info.mustBeInInfo)
 932                 makeAny(text, buf, xs, runparams, paragraphs.iterator_at(pit));
 933
 934         // If there is no title, generate one (required for the document to be valid).
 935         // This code is called for the main document, for table cells, etc., so be precise in this condition.
 936         if (text.isMainText() && info.shouldBeInInfo.empty() && !runparams.inInclude) {
 937                 xs << xml::StartTag("title");
 938                 xs << "Untitled Document";
 939                 xs << xml::EndTag("title");
 940                 xs << xml::CR();
 941         }
 942
 943         // Always output the abstract as the last item of the <info>, as it requires special treatment (especially if
 944         // it contains several paragraphs that are empty).
 945         if (hasAbstract) {
 946                 if (info.abstractLayout) {
 947                         xs << XMLStream::ESCAPE_NONE << abstract;
 948                         xs << xml::CR();
 949                 } else {
 950                         string tag = paragraphs[*info.abstract.begin()].layout().docbookforceabstracttag();
 951                         if (tag == "NONE")
 952                                 tag = "abstract";
 953
 954                         if (!xs.isLastTagCR())
 955                                 xs << xml::CR();
 956
 957                         xs << xml::StartTag(tag);
 958                         xs << xml::CR();
 959                         xs << XMLStream::ESCAPE_NONE << abstract;
 960                         xs << xml::EndTag(tag);
 961                         xs << xml::CR();
 962                 }
 963         }
 964
 965         // End the <info> tag if it was started.
 966         if (needInfo) {
 967                 if (!xs.isLastTagCR())
 968                         xs << xml::CR();
 969
 970                 xs << xml::EndTag("info");
 971                 xs << xml::CR();
 972                 xs.endDivision();
 973         }
 974 }
 975
 976
 977 void docbookSimpleAllParagraphs(
 978                 Text const & text,
 979                 Buffer const & buf,
 980                 XMLStream & xs,
 981                 OutputParams const & runparams)
 982 {
 983         // Handle the given text, supposing it has no sections (i.e. a "simple" text). The input may vary in length
 984         // between a single paragraph to a whole document.
 985         pit_type const bpit = runparams.par_begin;
 986         pit_type const epit = runparams.par_end;
 987         ParagraphList const &paragraphs = text.paragraphs();
 988
 989         // First, the <info> tag.
 990         DocBookInfoTag info = getParagraphsWithInfo(paragraphs, bpit, epit, false);
 991         outputDocBookInfo(text, buf, xs, runparams, paragraphs, info);
 992
 993         // Then, the content. It starts where the <info> ends.
 994         auto par = paragraphs.iterator_at(info.epit);
 995         auto end = paragraphs.iterator_at(epit);
 996         while (par != end) {
 997                 if (!hasOnlyNotes(*par))
 998                         par = makeAny(text, buf, xs, runparams, par);
 999                 else
1000                         ++par;
1001         }
1002 }
1003
1004
1005 void docbookParagraphs(Text const &text,
1006                                            Buffer const &buf,
1007                                            XMLStream &xs,
1008                                            OutputParams const &runparams) {
1009         ParagraphList const &paragraphs = text.paragraphs();
1010         if (runparams.par_begin == runparams.par_end) {
1011                 runparams.par_begin = 0;
1012                 runparams.par_end = paragraphs.size();
1013         }
1014         pit_type bpit = runparams.par_begin;
1015         pit_type const epit = runparams.par_end;
1016         LASSERT(bpit < epit,
1017                         {
1018                                 xs << XMLStream::ESCAPE_NONE << "<!-- DocBook output error! -->\n";
1019                                 return;
1020                         });
1021
1022         std::stack<std::pair<int, string>> headerLevels; // Used to determine when to open/close sections: store the depth
1023         // of the section and the tag that was used to open it.
1024
1025         // Detect whether the document contains sections. If there are no sections, treatment is largely simplified.
1026         // In particular, there can't be an abstract, unless it is manually marked.
1027         bool documentHasSections;
1028         pit_type eppit;
1029         tie(documentHasSections, eppit) = hasDocumentSectioning(paragraphs, bpit, epit);
1030
1031         // Deal with "simple" documents, i.e. those without sections.
1032         if (!documentHasSections) {
1033                 docbookSimpleAllParagraphs(text, buf, xs, runparams);
1034                 return;
1035         }
1036
1037         // Output the first <info> tag (or just the title).
1038         DocBookInfoTag info = getParagraphsWithInfo(paragraphs, bpit, eppit, true);
1039         outputDocBookInfo(text, buf, xs, runparams, paragraphs, info);
1040         bpit = info.epit;
1041
1042         // Then, iterate through the paragraphs of this document.
1043         bool currentlyInAppendix = false;
1044
1045         auto par = text.paragraphs().iterator_at(bpit);
1046         auto end = text.paragraphs().iterator_at(epit);
1047         while (par != end) {
1048                 OutputParams ourparams = runparams;
1049
1050                 if (par->params().startOfAppendix())
1051                         currentlyInAppendix = true;
1052                 if (hasOnlyNotes(*par)) {
1053                         ++par;
1054                         continue;
1055                 }
1056
1057                 Layout const &style = par->layout();
1058
1059                 // Think about adding <section> and/or </section>s.
1060                 if (isLayoutSectioning(style)) {
1061                         int level = style.toclevel;
1062
1063                         // Need to close a previous section if it has the same level or a higher one (close <section> if opening a
1064                         // <h2> after a <h2>, <h3>, <h4>, <h5> or <h6>). More examples:
1065                         //   - current: h2; back: h1; do not close any <section>
1066                         //   - current: h1; back: h2; close two <section> (first the <h2>, then the <h1>, so a new <h1> can come)
1067                         while (!headerLevels.empty() && level <= headerLevels.top().first) {
1068                                 // Output the tag only if it corresponds to a legit section.
1069                                 int stackLevel = headerLevels.top().first;
1070                                 if (stackLevel != Layout::NOT_IN_TOC) {
1071                                         xs << xml::EndTag(headerLevels.top().second);
1072                                         xs << xml::CR();
1073                                 }
1074                                 headerLevels.pop();
1075                         }
1076
1077                         // Open the new section: first push it onto the stack, then output it in DocBook.
1078                         string sectionTag = (currentlyInAppendix && style.docbooksectiontag() == "chapter") ?
1079                                                                 "appendix" : style.docbooksectiontag();
1080                         headerLevels.push(std::make_pair(level, sectionTag));
1081
1082                         // Some sectioning-like elements should not be output (such as FrontMatter).
1083                         if (level != Layout::NOT_IN_TOC) {
1084                                 // Look for a label in the title, i.e. a InsetLabel as a child.
1085                                 docstring id = docstring();
1086                                 for (pos_type i = 0; i < par->size(); ++i) {
1087                                         Inset const *inset = par->getInset(i);
1088                                         if (inset) {
1089                                                 if (auto label = dynamic_cast<InsetLabel const *>(inset)) {
1090                                                         // Generate the attributes for the section if need be.
1091                                                         id += "xml:id=\"" + xml::cleanID(label->screenLabel()) + "\"";
1092
1093                                                         // Don't output the ID as a DocBook <anchor>.
1094                                                         ourparams.docbook_anchors_to_ignore.emplace(label->screenLabel());
1095
1096                                                         // Cannot have multiple IDs per tag.
1097                                                         break;
1098                                                 }
1099                                         }
1100                                 }
1101
1102                                 // Write the open tag for this section.
1103                                 docstring attrs;
1104                                 if (!id.empty())
1105                                         attrs = id;
1106                                 xs << xml::StartTag(sectionTag, attrs);
1107                                 xs << xml::CR();
1108                         }
1109                 }
1110
1111                 // Close all sections before the bibliography.
1112                 // 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)?
1113                 if (!par->insetList().empty()) {
1114                         Inset const *firstInset = par->getInset(0);
1115                         if (firstInset && (firstInset->lyxCode() == BIBITEM_CODE || firstInset->lyxCode() == BIBTEX_CODE)) {
1116                                 while (!headerLevels.empty()) {
1117                                         int level = headerLevels.top().first;
1118                                         docstring tag = from_utf8("</" + headerLevels.top().second + ">");
1119                                         headerLevels.pop();
1120
1121                                         // Output the tag only if it corresponds to a legit section.
1122                                         if (level != Layout::NOT_IN_TOC) {
1123                                                 xs << XMLStream::ESCAPE_NONE << tag;
1124                                                 xs << xml::CR();
1125                                         }
1126                                 }
1127                         }
1128                 }
1129
1130                 // Generate this paragraph.
1131                 par = makeAny(text, buf, xs, ourparams, par);
1132
1133                 // Some special sections may require abstracts (mostly parts, in books).
1134                 // 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.
1135                 if (isLayoutSectioning(style) && style.docbookforceabstracttag() != "NONE") {
1136                         // This abstract may be found between the next paragraph and the next title.
1137                         pit_type cpit = std::distance(text.paragraphs().begin(), par);
1138                         pit_type ppit = std::get<1>(hasDocumentSectioning(paragraphs, cpit, epit));
1139
1140                         // Generate this abstract (this code corresponds to parts of outputDocBookInfo).
1141                         DocBookInfoTag secInfo = getParagraphsWithInfo(paragraphs, cpit, ppit, true);
1142
1143                         if (!secInfo.abstract.empty()) {
1144                                 xs << xml::StartTag(style.docbookforceabstracttag());
1145                                 xs << xml::CR();
1146                                 for (auto const &p : secInfo.abstract)
1147                                         makeAny(text, buf, xs, runparams, paragraphs.iterator_at(p));
1148                                 xs << xml::EndTag(style.docbookforceabstracttag());
1149                                 xs << xml::CR();
1150                         }
1151
1152                         // Skip all the text that just has been generated.
1153                         par = paragraphs.iterator_at(ppit);
1154                 }
1155         }
1156
1157         // If need be, close <section>s, but only at the end of the document (otherwise, dealt with at the beginning
1158         // of the loop).
1159         while (!headerLevels.empty() && headerLevels.top().first > Layout::NOT_IN_TOC) {
1160                 docstring tag = from_utf8("</" + headerLevels.top().second + ">");
1161                 headerLevels.pop();
1162                 xs << XMLStream::ESCAPE_NONE << tag;
1163                 xs << xml::CR();
1164         }
1165 }
1166
1167 } // namespace lyx