X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Foutput_docbook.cpp;h=5e1f6d12cf2829fc281a1cd95268d9967249270f;hb=b41293352ea8d52890b7668f059fd07f09bd6bb6;hp=ce6b702f647fedf73adfdd59dd68ff4049a019e1;hpb=0c5e10f36b0b42eefa41806cac12790a2b49c043;p=features.git diff --git a/src/output_docbook.cpp b/src/output_docbook.cpp index ce6b702f64..5e1f6d12cf 100644 --- a/src/output_docbook.cpp +++ b/src/output_docbook.cpp @@ -286,9 +286,17 @@ void makeBibliography( // Generate the entry. Concatenate the different parts of the paragraph if any. auto const begin = text.paragraphs().begin(); - auto pars = par->simpleDocBookOnePar(buf, runparams, text.outerFont(std::distance(begin, par)), 0); + std::vector pars_prepend; + std::vector pars; + std::vector pars_append; + tie(pars_prepend, pars, pars_append) = par->simpleDocBookOnePar(buf, runparams, text.outerFont(std::distance(begin, par)), 0); + + for (auto & parXML : pars_prepend) + xs << XMLStream::ESCAPE_NONE << parXML; for (auto & parXML : pars) xs << XMLStream::ESCAPE_NONE << parXML; + for (auto & parXML : pars_append) + xs << XMLStream::ESCAPE_NONE << parXML; // End the precooked bibliography entry. xs << xml::EndTag("bibliomixed"); @@ -335,7 +343,7 @@ void makeParagraph( // We do not really want to wrap that whole thing in a
...
. bool special_case = false; Inset const *specinset = par->size() == 1 ? par->getInset(0) : nullptr; - if (specinset && !specinset->getLayout().htmlisblock()) { // TODO: Convert htmlisblock to a DocBook parameter? + if (specinset && !specinset->getLayout().htmlisblock()) { // TODO: Convert htmlisblock to a DocBook parameter? docbooknotinpara should be enough in most cases. Layout const &style = par->layout(); FontInfo const first_font = style.labeltype == LABEL_MANUAL ? style.labelfont : style.font; @@ -352,11 +360,13 @@ void makeParagraph( // Plain layouts must be ignored. special_case |= buf.params().documentClass().isPlainLayout(par->layout()) && !runparams.docbook_force_pars; + // Equations do not deserve their own paragraph (DocBook allows them outside paragraphs). // Exception: any case that generates an must still get a paragraph to be valid. - special_case |= nInsets == parSize && std::all_of(par->insetList().begin(), par->insetList().end(), [](InsetList::Element inset) { + auto isEquationSpecialCase = [](InsetList::Element inset) { return inset.inset && inset.inset->asInsetMath() && inset.inset->asInsetMath()->getType() != hullSimple; - }); + }; + special_case |= nInsets == parSize && std::all_of(par->insetList().begin(), par->insetList().end(), isEquationSpecialCase); // Things that should not get into their own paragraph. (Only valid for DocBook.) static std::set lyxCodeSpecialCases = { @@ -412,6 +422,12 @@ void makeParagraph( }; special_case |= nInsets == parSize && std::all_of(par->insetList().begin(), par->insetList().end(), isFlexSpecialCase); + // If the insets should be rendered as images, enter the special case. + auto isRenderedAsImageSpecialCase = [](InsetList::Element inset) { + return inset.inset && inset.inset->getLayout().docbookrenderasimage(); + }; + special_case |= nInsets == parSize && std::all_of(par->insetList().begin(), par->insetList().end(), isRenderedAsImageSpecialCase); + // Open a paragraph if it is allowed, we are not already within a paragraph, and the insets in the paragraph do // not forbid paragraphs (aka special cases). bool const open_par = runparams.docbook_make_pars @@ -432,7 +448,14 @@ void makeParagraph( // Open and close tags around each contained paragraph. auto nextpar = par; ++nextpar; - auto pars = par->simpleDocBookOnePar(buf, runparams, text.outerFont(distance(begin, par)), 0, nextpar == end, special_case); + + std::vector pars_prepend; + std::vector pars; + std::vector pars_append; + tie(pars_prepend, pars, pars_append) = par->simpleDocBookOnePar(buf, runparams, text.outerFont(distance(begin, par)), 0, nextpar == end, special_case); + + for (docstring const & parXML : pars_prepend) + xs << XMLStream::ESCAPE_NONE << parXML; for (docstring const & parXML : pars) { if (!xml::isNotOnlySpace(parXML)) continue; @@ -445,6 +468,8 @@ void makeParagraph( if (close_par) closeParTag(xs, &*par, (nextpar != end) ? &*nextpar : nullptr, runparams); } + for (docstring const & parXML : pars_append) + xs << XMLStream::ESCAPE_NONE << parXML; } @@ -480,8 +505,13 @@ void makeEnvironment(Text const &text, // Nothing to do (otherwise, infinite loops). } else if (style.latextype == LATEX_ENVIRONMENT) { // Generate the paragraph, if need be. - auto pars = par->simpleDocBookOnePar(buf, runparams, text.outerFont(std::distance(text.paragraphs().begin(), par)), 0, false, ignoreFonts); + std::vector pars_prepend; + std::vector pars; + std::vector pars_append; + tie(pars_prepend, pars, pars_append) = par->simpleDocBookOnePar(buf, runparams, text.outerFont(std::distance(text.paragraphs().begin(), par)), 0, false, ignoreFonts); + for (docstring const & parXML : pars_prepend) + xs << XMLStream::ESCAPE_NONE << parXML; if (mimicListing) { auto p = pars.begin(); while (p != pars.end()) { @@ -504,6 +534,8 @@ void makeEnvironment(Text const &text, xml::closeTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnertagtype()); } } + for (docstring const & parXML : pars_append) + xs << XMLStream::ESCAPE_NONE << parXML; } else { makeAny(text, buf, xs, runparams, par); } @@ -604,14 +636,21 @@ ParagraphList::const_iterator makeListEnvironment(Text const &text, // Generate the content of the item. if (sep < par->size()) { - auto pars = par->simpleDocBookOnePar(buf, runparams, + std::vector pars_prepend; + std::vector pars; + std::vector pars_append; + tie(pars_prepend, pars, pars_append) = par->simpleDocBookOnePar(buf, runparams, text.outerFont(std::distance(text.paragraphs().begin(), par)), sep); + for (docstring const & parXML : pars_prepend) + xs << XMLStream::ESCAPE_NONE << parXML; for (auto &p : pars) { xml::openTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnerattr(), par->layout().docbookiteminnertagtype()); xs << XMLStream::ESCAPE_NONE << p; xml::closeTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnertagtype()); } + for (docstring const & parXML : pars_append) + xs << XMLStream::ESCAPE_NONE << parXML; } else { // DocBook doesn't like emptiness. xml::compTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnerattr(), @@ -656,14 +695,23 @@ void makeCommand( // Generate this command. auto prevpar = text.paragraphs().getParagraphBefore(par); - openParTag(xs, &*par, prevpar, runparams); - auto pars = par->simpleDocBookOnePar(buf, runparams,text.outerFont(distance(begin, par))); + std::vector pars_prepend; + std::vector pars; + std::vector pars_append; + tie(pars_prepend, pars, pars_append) = par->simpleDocBookOnePar(buf, runparams,text.outerFont(distance(begin, par))); + + for (docstring const & parXML : pars_prepend) + xs << XMLStream::ESCAPE_NONE << parXML; + + openParTag(xs, &*par, prevpar, runparams); for (auto & parXML : pars) // TODO: decide what to do with openParTag/closeParTag in new lines. xs << XMLStream::ESCAPE_NONE << parXML; + closeParTag(xs, &*par, (nextpar != end) ? &*nextpar : nullptr, runparams); - closeParTag(xs, &*par, (nextpar != end) ? &*nextpar : nullptr, runparams); + for (docstring const & parXML : pars_append) + xs << XMLStream::ESCAPE_NONE << parXML; } @@ -706,6 +754,8 @@ DocBookDocumentSectioning hasDocumentSectioning(ParagraphList const ¶graphs, bool documentHasSections = false; while (bpit < epit) { + LASSERT(static_cast(bpit) < paragraphs.size(), return make_tuple(documentHasSections, bpit)); + Layout const &style = paragraphs[bpit].layout(); documentHasSections |= isLayoutSectioningOrSimilar(style); @@ -752,7 +802,7 @@ DocBookInfoTag getParagraphsWithInfo(ParagraphList const ¶graphs, set abstractWithLayout; set abstractNoLayout; - // Find the first non empty paragraph by mutating bpit. + // Find the first nonempty paragraph by mutating bpit. while (bpit < epit) { Paragraph const &par = paragraphs[bpit]; if (par.empty() || hasOnlyNotes(par)) @@ -776,7 +826,7 @@ DocBookInfoTag getParagraphsWithInfo(ParagraphList const ¶graphs, // There should never be any section here, except for the first paragraph (a title can be part of ). // (Just a sanity check: if this fails, this function could end up processing the whole document.) if (cpit != bpit && isLayoutSectioningOrSimilar(par.layout())) { - LYXERR0("Assertion failed: section found in potential paragraphs."); + LYXERR(Debug::OUTFILE, "Assertion failed: section found in potential paragraphs."); break; } @@ -970,12 +1020,20 @@ void outputDocBookInfo( } } - // Actually output the abstract if there is something to do. Don't count line feeds or spaces in this, - // even though they must be properly output if there is some abstract. + // Actually output the abstract if there is something to do. Don't count line feeds, spaces, or comments + // in this -- even though line feeds and spaces must be properly output if there is some abstract. abstract = os2.str(); docstring cleaned = abstract; cleaned.erase(std::remove_if(cleaned.begin(), cleaned.end(), lyx::isSpace), cleaned.end()); + size_t beginComment; + size_t endComment; + while ((beginComment = cleaned.find(from_ascii(""), beginComment)) != lyx::docstring::npos) { + cleaned.erase(cleaned.begin() + beginComment, cleaned.begin() + endComment + 3); + } + } + // Nothing? Then there is no abstract! if (cleaned.empty()) hasAbstract = false; @@ -1102,6 +1160,63 @@ void docbookParagraphs(Text const &text, outputDocBookInfo(text, buf, xs, runparams, paragraphs, info); bpit = info.epit; + // In the specific case of books, there must be parts or chapters. In some cases, star sections are used at the + // beginning for many things like acknowledgements or licenses. DocBook has tags for many of these cases, but not + // the LyX layouts... Gather everything in a , that's the closest in meaning. + // This is only useful if the things after the tag are not already parts or chapters! + if (buf.params().documentClass().docbookroot() == "book") { + // Check the condition on the first few elements. + bool hasPreface = false; + pit_type pref_bpit = bpit; + pit_type pref_epit = bpit; + + static const std::set allowedElements = { + // List from https://tdg.docbook.org/tdg/5.2/book.html + "acknowledgements", "appendix", "article", "bibliography", "chapter", "colophon", "dedication", + "glossary", "index", "part", "preface", "reference", "toc" + }; + + for (; pref_epit < epit; ++pref_epit) { + auto par = text.paragraphs().iterator_at(pref_epit); + if (allowedElements.find(par->layout().docbooktag()) != allowedElements.end() || + allowedElements.find(par->layout().docbooksectiontag()) != allowedElements.end()) + break; + + hasPreface = true; + } + + // Output a preface if required. A title is needed for the document to be valid... + if (hasPreface) { + xs << xml::StartTag("preface"); + xs << xml::CR(); + + xs << xml::StartTag("title"); + xs << "Preface"; + xs << xml::EndTag("title"); + xs << xml::CR(); + + auto pref_par = text.paragraphs().iterator_at(pref_bpit); + auto pref_end = text.paragraphs().iterator_at(pref_epit); + while (pref_par != pref_end) { + // Skip paragraphs not producing any output. + if (hasOnlyNotes(*pref_par)) { + ++pref_par; + continue; + } + + // TODO: must sections be handled here? If so, it might be useful to extract the corresponding loop + // in the rest of this function to use the same here (and avoid copy-paste mistakes). + pref_par = makeAny(text, buf, xs, runparams, pref_par); + } + + xs << xml::EndTag("preface"); + xs << xml::CR(); + + // Skip what has just been generated in the preface. + bpit = pref_epit; + } + } + std::stack> headerLevels; // Used to determine when to open/close sections: store the depth // of the section and the tag that was used to open it.