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         if (lay.docbooksection()) // Special case: some DocBook styles must be handled as sections.
 722                 return true;
 723         else if (lay.category() == from_utf8("Sectioning")) // Generic case.
 724                 return lay.toclevel != Layout::NOT_IN_TOC;
 725         return false;
 726 }
 727
 728
 729 using DocBookDocumentSectioning = tuple<bool, pit_type>;
 730
 731
 732 struct DocBookInfoTag
 733 {
 734         const set<pit_type> shouldBeInInfo;
 735         const set<pit_type> mustBeInInfo; // With the notable exception of the abstract!
 736         const set<pit_type> abstract;
 737         const bool abstractLayout;
 738         pit_type bpit;
 739         pit_type epit;
 740
 741         DocBookInfoTag(const set<pit_type> & shouldBeInInfo, const set<pit_type> & mustBeInInfo,
 742                                    const set<pit_type> & abstract, bool abstractLayout, pit_type bpit, pit_type epit) :
 743                                    shouldBeInInfo(shouldBeInInfo), mustBeInInfo(mustBeInInfo), abstract(abstract),
 744                                    abstractLayout(abstractLayout), bpit(bpit), epit(epit) {}
 745 };
 746
 747
 748 DocBookDocumentSectioning hasDocumentSectioning(ParagraphList const &paragraphs, pit_type bpit, pit_type const epit) {
 749         bool documentHasSections = false;
 750
 751         while (bpit < epit) {
 752                 Layout const &style = paragraphs[bpit].layout();
 753                 documentHasSections |= isLayoutSectioning(style);
 754
 755                 if (documentHasSections)
 756                         break;
 757                 bpit += 1;
 758         }
 759         // Paragraphs before the first section: [ runparams.par_begin ; eppit )
 760
 761         return make_tuple(documentHasSections, bpit);
 762 }
 763
 764
 765 bool hasOnlyNotes(Paragraph const & par)
 766 {
 767         // Precondition: the paragraph is not empty. Otherwise, the function will always return true...
 768         for (int i = 0; i < par.size(); ++i)
 769                 // If you find something that is not an inset (like actual text) or an inset that is not a note,
 770                 // return false.
 771                 if (!par.isInset(i) || par.getInset(i)->lyxCode() != NOTE_CODE)
 772                         return false;
 773
 774         // An empty paragraph may still require some output.
 775         if (par.layout().docbooksection())
 776                 return false;
 777
 778         // There should be really no content here.
 779         return true;
 780 }
 781
 782
 783 DocBookInfoTag getParagraphsWithInfo(ParagraphList const &paragraphs,
 784                                                                          pit_type bpit, pit_type const epit,
 785                                                                          // Typically, bpit is the beginning of the document and epit the end of the
 786                                                                          // document *or* the first section.
 787                                                                          bool documentHasSections,
 788                                                                          bool detectUnlayoutedAbstract
 789                                                                          // Whether paragraphs with no specific layout should be detected as abstracts.
 790                                                                          // For inner sections, an abstract should only be detected if it has a specific
 791                                                                          // layout. For others, anything that might look like an abstract should be sought.
 792                                                                          ) {
 793         set<pit_type> shouldBeInInfo;
 794         set<pit_type> mustBeInInfo;
 795         set<pit_type> abstractWithLayout;
 796         set<pit_type> abstractNoLayout;
 797
 798         // Find the first non empty paragraph by mutating bpit.
 799         while (bpit < epit) {
 800                 Paragraph const &par = paragraphs[bpit];
 801                 if (par.empty() || hasOnlyNotes(par))
 802                         bpit += 1;
 803                 else
 804                         break;
 805         }
 806
 807         // Traverse everything that might belong to <info>.
 808         bool hasAbstractLayout = false;
 809         pit_type cpit = bpit;
 810         for (; cpit < epit; ++cpit) {
 811                 // Skip paragraphs that don't generate anything in DocBook.
 812                 Paragraph const & par = paragraphs[cpit];
 813                 Layout const &style = par.layout();
 814                 if (hasOnlyNotes(par) || style.docbookininfo() == "never")
 815                         continue;
 816
 817                 // There should never be any section here. (Just a sanity check: if this fails, this function could end up
 818                 // processing the whole document.)
 819                 if (isLayoutSectioning(par.layout())) {
 820                         LYXERR0("Assertion failed: section found in potential <info> paragraphs.");
 821                         break;
 822                 }
 823
 824                 // If this is marked as an abstract by the layout, put it in the right set.
 825                 if (style.docbookabstract()) {
 826                         hasAbstractLayout = true;
 827                         abstractWithLayout.emplace(cpit);
 828                         continue;
 829                 }
 830
 831                 // Based on layout information, store this paragraph in one set: should be in <info>, must be,
 832                 // or abstract (either because of layout or of position).
 833                 if (style.docbookininfo() == "always")
 834                         mustBeInInfo.emplace(cpit);
 835                 else if (style.docbookininfo() == "maybe")
 836                         shouldBeInInfo.emplace(cpit);
 837                 else if (documentHasSections && !hasAbstractLayout && detectUnlayoutedAbstract)
 838                         abstractNoLayout.emplace(cpit);
 839                 else // This should definitely not be in <info>.
 840                         break;
 841         }
 842         // Now, cpit points to the first paragraph that no more has things that could go in <info>.
 843         // bpit is the beginning of the <info> part.
 844
 845         return DocBookInfoTag(shouldBeInInfo, mustBeInInfo,
 846                                               hasAbstractLayout ? abstractWithLayout : abstractNoLayout,
 847                                               hasAbstractLayout, bpit, cpit);
 848 }
 849
 850 } // end anonymous namespace
 851
 852
 853 ParagraphList::const_iterator makeAny(Text const &text,
 854                                       Buffer const &buf,
 855                                       XMLStream &xs,
 856                                       OutputParams const &runparams,
 857                                       ParagraphList::const_iterator par)
 858 {
 859         switch (par->layout().latextype) {
 860         case LATEX_COMMAND:
 861                 makeCommand(text, buf, xs, runparams, par);
 862                 break;
 863         case LATEX_ENVIRONMENT:
 864                 makeEnvironment(text, buf, xs, runparams, par);
 865                 break;
 866         case LATEX_LIST_ENVIRONMENT:
 867         case LATEX_ITEM_ENVIRONMENT:
 868                 // Only case when makeAny() might consume more than one paragraph.
 869                 return makeListEnvironment(text, buf, xs, runparams, par);
 870         case LATEX_PARAGRAPH:
 871                 makeParagraph(text, buf, xs, runparams, par);
 872                 break;
 873         case LATEX_BIB_ENVIRONMENT:
 874                 makeBibliography(text, buf, xs, runparams, par);
 875                 break;
 876         }
 877         ++par;
 878         return par;
 879 }
 880
 881
 882 xml::FontTag docbookStartFontTag(xml::FontTypes type)
 883 {
 884         return xml::FontTag(from_utf8(fontToDocBookTag(type)), from_utf8(fontToAttribute(type)), type);
 885 }
 886
 887
 888 xml::EndFontTag docbookEndFontTag(xml::FontTypes type)
 889 {
 890         return xml::EndFontTag(from_utf8(fontToDocBookTag(type)), type);
 891 }
 892
 893
 894 void outputDocBookInfo(
 895                 Text const & text,
 896                 Buffer const & buf,
 897                 XMLStream & xs,
 898                 OutputParams const & runparams,
 899                 ParagraphList const & paragraphs,
 900                 DocBookInfoTag const & info)
 901 {
 902         // Perform an additional check on the abstract. Sometimes, there are many paragraphs that should go
 903         // into the abstract, but none generates actual content. Thus, first generate to a temporary stream,
 904         // then only create the <abstract> tag if these paragraphs generate some content.
 905         // This check must be performed *before* a decision on whether or not to output <info> is made.
 906         bool hasAbstract = !info.abstract.empty();
 907         docstring abstract;
 908         if (hasAbstract) {
 909                 // Generate the abstract XML into a string before further checks.
 910                 odocstringstream os2;
 911                 XMLStream xs2(os2);
 912                 for (auto const & p : info.abstract)
 913                         makeAny(text, buf, xs2, runparams, paragraphs.iterator_at(p));
 914
 915                 // Actually output the abstract if there is something to do. Don't count line feeds or spaces in this,
 916                 // even though they must be properly output if there is some abstract.
 917                 abstract = os2.str();
 918                 docstring cleaned = abstract;
 919                 cleaned.erase(std::remove_if(cleaned.begin(), cleaned.end(), lyx::isSpace), cleaned.end());
 920
 921                 // Nothing? Then there is no abstract!
 922                 if (cleaned.empty())
 923                         hasAbstract = false;
 924         }
 925
 926         // The abstract must go in <info>. Otherwise, decide whether to open <info> based on the layouts.
 927         bool needInfo = !info.mustBeInInfo.empty() || hasAbstract;
 928
 929         // Start the <info> tag if required.
 930         if (needInfo) {
 931                 xs.startDivision(false);
 932                 xs << xml::StartTag("info");
 933                 xs << xml::CR();
 934         }
 935
 936         // Output the elements that should go in <info>, before and after the abstract.
 937         for (auto pit : info.shouldBeInInfo) // Typically, the title: these elements are so important and ubiquitous
 938                 // that mandating a wrapper like <info> would repel users. Thus, generate them first.
 939                 makeAny(text, buf, xs, runparams, paragraphs.iterator_at(pit));
 940         for (auto pit : info.mustBeInInfo)
 941                 makeAny(text, buf, xs, runparams, paragraphs.iterator_at(pit));
 942
 943         // If there is no title, generate one (required for the document to be valid).
 944         // This code is called for the main document, for table cells, etc., so be precise in this condition.
 945         if (text.isMainText() && info.shouldBeInInfo.empty() && !runparams.inInclude) {
 946                 xs << xml::StartTag("title");
 947                 xs << "Untitled Document";
 948                 xs << xml::EndTag("title");
 949                 xs << xml::CR();
 950         }
 951
 952         // Always output the abstract as the last item of the <info>, as it requires special treatment (especially if
 953         // it contains several paragraphs that are empty).
 954         if (hasAbstract) {
 955                 if (info.abstractLayout) {
 956                         xs << XMLStream::ESCAPE_NONE << abstract;
 957                         xs << xml::CR();
 958                 } else {
 959                         string tag = paragraphs[*info.abstract.begin()].layout().docbookforceabstracttag();
 960                         if (tag == "NONE")
 961                                 tag = "abstract";
 962
 963                         if (!xs.isLastTagCR())
 964                                 xs << xml::CR();
 965
 966                         xs << xml::StartTag(tag);
 967                         xs << xml::CR();
 968                         xs << XMLStream::ESCAPE_NONE << abstract;
 969                         xs << xml::EndTag(tag);
 970                         xs << xml::CR();
 971                 }
 972         }
 973
 974         // End the <info> tag if it was started.
 975         if (needInfo) {
 976                 if (!xs.isLastTagCR())
 977                         xs << xml::CR();
 978
 979                 xs << xml::EndTag("info");
 980                 xs << xml::CR();
 981                 xs.endDivision();
 982         }
 983 }
 984
 985
 986 void docbookSimpleAllParagraphs(
 987                 Text const & text,
 988                 Buffer const & buf,
 989                 XMLStream & xs,
 990                 OutputParams const & runparams)
 991 {
 992         // Handle the given text, supposing it has no sections (i.e. a "simple" text). The input may vary in length
 993         // between a single paragraph to a whole document.
 994         pit_type const bpit = runparams.par_begin;
 995         pit_type const epit = runparams.par_end;
 996         ParagraphList const &paragraphs = text.paragraphs();
 997
 998         // First, the <info> tag.
 999         DocBookInfoTag info = getParagraphsWithInfo(paragraphs, bpit, epit, false, true);
1000         outputDocBookInfo(text, buf, xs, runparams, paragraphs, info);
1001
1002         // Then, the content. It starts where the <info> ends.
1003         auto par = paragraphs.iterator_at(info.epit);
1004         auto end = paragraphs.iterator_at(epit);
1005         while (par != end) {
1006                 if (!hasOnlyNotes(*par))
1007                         par = makeAny(text, buf, xs, runparams, par);
1008                 else
1009                         ++par;
1010         }
1011 }
1012
1013
1014 void docbookParagraphs(Text const &text,
1015                                            Buffer const &buf,
1016                                            XMLStream &xs,
1017                                            OutputParams const &runparams) {
1018         ParagraphList const &paragraphs = text.paragraphs();
1019         if (runparams.par_begin == runparams.par_end) {
1020                 runparams.par_begin = 0;
1021                 runparams.par_end = paragraphs.size();
1022         }
1023         pit_type bpit = runparams.par_begin;
1024         pit_type const epit = runparams.par_end;
1025         LASSERT(bpit < epit,
1026                         {
1027                                 xs << XMLStream::ESCAPE_NONE << "<!-- DocBook output error! -->\n";
1028                                 return;
1029                         });
1030
1031         std::stack<std::pair<int, string>> headerLevels; // Used to determine when to open/close sections: store the depth
1032         // of the section and the tag that was used to open it.
1033
1034         // Detect whether the document contains sections. If there are no sections, treatment is largely simplified.
1035         // In particular, there can't be an abstract, unless it is manually marked.
1036         bool documentHasSections;
1037         pit_type eppit;
1038         tie(documentHasSections, eppit) = hasDocumentSectioning(paragraphs, bpit, epit);
1039
1040         // Deal with "simple" documents, i.e. those without sections.
1041         if (!documentHasSections) {
1042                 docbookSimpleAllParagraphs(text, buf, xs, runparams);
1043                 return;
1044         }
1045
1046         // Output the first <info> tag (or just the title).
1047         DocBookInfoTag info = getParagraphsWithInfo(paragraphs, bpit, eppit, true, true);
1048         outputDocBookInfo(text, buf, xs, runparams, paragraphs, info);
1049         bpit = info.epit;
1050
1051         // Then, iterate through the paragraphs of this document.
1052         bool currentlyInAppendix = false;
1053
1054         auto par = text.paragraphs().iterator_at(bpit);
1055         auto end = text.paragraphs().iterator_at(epit);
1056         while (par != end) {
1057                 OutputParams ourparams = runparams;
1058
1059                 if (par->params().startOfAppendix())
1060                         currentlyInAppendix = true;
1061                 if (hasOnlyNotes(*par)) {
1062                         ++par;
1063                         continue;
1064                 }
1065
1066                 Layout const &style = par->layout();
1067
1068                 // Think about adding <section> and/or </section>s.
1069                 if (isLayoutSectioning(style)) {
1070                         int level = style.toclevel;
1071
1072                         // Need to close a previous section if it has the same level or a higher one (close <section> if opening a
1073                         // <h2> after a <h2>, <h3>, <h4>, <h5> or <h6>). More examples:
1074                         //   - current: h2; back: h1; do not close any <section>
1075                         //   - current: h1; back: h2; close two <section> (first the <h2>, then the <h1>, so a new <h1> can come)
1076                         while (!headerLevels.empty() && level <= headerLevels.top().first) {
1077                                 // Output the tag only if it corresponds to a legit section.
1078                                 int stackLevel = headerLevels.top().first;
1079                                 if (stackLevel != Layout::NOT_IN_TOC) {
1080                                         xs << xml::EndTag(headerLevels.top().second);
1081                                         xs << xml::CR();
1082                                 }
1083                                 headerLevels.pop();
1084                         }
1085
1086                         // Open the new section: first push it onto the stack, then output it in DocBook.
1087                         string sectionTag = (currentlyInAppendix && style.docbooksectiontag() == "chapter") ?
1088                                                                 "appendix" : style.docbooksectiontag();
1089                         headerLevels.push(std::make_pair(level, sectionTag));
1090
1091                         // Some sectioning-like elements should not be output (such as FrontMatter).
1092                         if (level != Layout::NOT_IN_TOC) {
1093                                 // Look for a label in the title, i.e. a InsetLabel as a child.
1094                                 docstring id = docstring();
1095                                 for (pos_type i = 0; i < par->size(); ++i) {
1096                                         Inset const *inset = par->getInset(i);
1097                                         if (inset) {
1098                                                 if (auto label = dynamic_cast<InsetLabel const *>(inset)) {
1099                                                         // Generate the attributes for the section if need be.
1100                                                         id += "xml:id=\"" + xml::cleanID(label->screenLabel()) + "\"";
1101
1102                                                         // Don't output the ID as a DocBook <anchor>.
1103                                                         ourparams.docbook_anchors_to_ignore.emplace(label->screenLabel());
1104
1105                                                         // Cannot have multiple IDs per tag.
1106                                                         break;
1107                                                 }
1108                                         }
1109                                 }
1110
1111                                 // Write the open tag for this section.
1112                                 docstring attrs;
1113                                 if (!id.empty())
1114                                         attrs = id;
1115                                 xs << xml::StartTag(sectionTag, attrs);
1116                                 xs << xml::CR();
1117                         }
1118                 }
1119
1120                 // Close all sections before the bibliography.
1121                 // 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)?
1122                 if (!par->insetList().empty()) {
1123                         Inset const *firstInset = par->getInset(0);
1124                         if (firstInset && (firstInset->lyxCode() == BIBITEM_CODE || firstInset->lyxCode() == BIBTEX_CODE)) {
1125                                 while (!headerLevels.empty()) {
1126                                         int level = headerLevels.top().first;
1127                                         docstring tag = from_utf8("</" + headerLevels.top().second + ">");
1128                                         headerLevels.pop();
1129
1130                                         // Output the tag only if it corresponds to a legit section.
1131                                         if (level != Layout::NOT_IN_TOC) {
1132                                                 xs << XMLStream::ESCAPE_NONE << tag;
1133                                                 xs << xml::CR();
1134                                         }
1135                                 }
1136                         }
1137                 }
1138
1139                 // Generate this paragraph.
1140                 par = makeAny(text, buf, xs, ourparams, par);
1141
1142                 // Some sections may require abstracts (mostly parts, in books: DocBookForceAbstractTag will not be NONE),
1143                 // others can still have an abstract (it must be detected so that it can be output at the right place).
1144                 // 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.
1145                 if (isLayoutSectioning(style)) {
1146                         // This abstract may be found between the next paragraph and the next title.
1147                         pit_type cpit = std::distance(text.paragraphs().begin(), par);
1148                         pit_type ppit = std::get<1>(hasDocumentSectioning(paragraphs, cpit, epit));
1149
1150                         // Generate this abstract (this code corresponds to parts of outputDocBookInfo).
1151                         DocBookInfoTag secInfo = getParagraphsWithInfo(paragraphs, cpit, ppit, true,
1152                                                                                                   style.docbookforceabstracttag() != "NONE");
1153
1154                         if (!secInfo.mustBeInInfo.empty() || !secInfo.shouldBeInInfo.empty() || !secInfo.abstract.empty()) {
1155                                 // Generate the <info>, if required. If DocBookForceAbstractTag != NONE, this abstract will not be in
1156                                 // <info>, unlike other ("standard") abstracts.
1157                                 bool hasStandardAbstract = !secInfo.abstract.empty() && style.docbookforceabstracttag() == "NONE";
1158                                 bool needInfo = !secInfo.mustBeInInfo.empty() || hasStandardAbstract;
1159
1160                                 if (needInfo) {
1161                                         xs.startDivision(false);
1162                                         xs << xml::StartTag("info");
1163                                         xs << xml::CR();
1164                                 }
1165
1166                                 // Output the elements that should go in <info>, before and after the abstract.
1167                                 for (auto pit : secInfo.shouldBeInInfo) // Typically, the title: these elements are so important and ubiquitous
1168                                         // that mandating a wrapper like <info> would repel users. Thus, generate them first.
1169                                         makeAny(text, buf, xs, runparams, paragraphs.iterator_at(pit));
1170                                 for (auto pit : secInfo.mustBeInInfo)
1171                                         makeAny(text, buf, xs, runparams, paragraphs.iterator_at(pit));
1172
1173                                 // Deal with the abstract in <info> if it is standard (i.e. its tag is <abstract>).
1174                                 if (!secInfo.abstract.empty() && hasStandardAbstract) {
1175                                         if (!secInfo.abstractLayout) {
1176                                                 xs << xml::StartTag("abstract");
1177                                                 xs << xml::CR();
1178                                         }
1179
1180                                         for (auto const &p : secInfo.abstract)
1181                                                 makeAny(text, buf, xs, runparams, paragraphs.iterator_at(p));
1182
1183                                         if (!secInfo.abstractLayout) {
1184                                                 xs << xml::EndTag("abstract");
1185                                                 xs << xml::CR();
1186                                         }
1187                                 }
1188
1189                                 // End the <info> tag if it was started.
1190                                 if (needInfo) {
1191                                         if (!xs.isLastTagCR())
1192                                                 xs << xml::CR();
1193
1194                                         xs << xml::EndTag("info");
1195                                         xs << xml::CR();
1196                                         xs.endDivision();
1197                                 }
1198
1199                                 // Deal with the abstract outside <info> if it is not standard (i.e. its tag is layout-defined).
1200                                 if (!secInfo.abstract.empty() && !hasStandardAbstract) {
1201                                         // Assert: style.docbookforceabstracttag() != NONE.
1202                                         xs << xml::StartTag(style.docbookforceabstracttag());
1203                                         xs << xml::CR();
1204                                         for (auto const &p : secInfo.abstract)
1205                                                 makeAny(text, buf, xs, runparams, paragraphs.iterator_at(p));
1206                                         xs << xml::EndTag(style.docbookforceabstracttag());
1207                                         xs << xml::CR();
1208                                 }
1209
1210                                 // Skip all the text that just has been generated.
1211                                 par = paragraphs.iterator_at(ppit);
1212                         }
1213                 }
1214         }
1215
1216         // If need be, close <section>s, but only at the end of the document (otherwise, dealt with at the beginning
1217         // of the loop).
1218         while (!headerLevels.empty() && headerLevels.top().first > Layout::NOT_IN_TOC) {
1219                 docstring tag = from_utf8("</" + headerLevels.top().second + ">");
1220                 headerLevels.pop();
1221                 xs << XMLStream::ESCAPE_NONE << tag;
1222                 xs << xml::CR();
1223         }
1224 }
1225
1226 } // namespace lyx