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