anne/lyx_mirror
1
0
Fork 0
mirror of https://git.lyx.org/repos/lyx.git synced 2024-11-22 10:00:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

DocBook: support for <info> tags in inner sections.

Browse Source 
Previously, this code only worked correctly for the root tag.
This commit is contained in:
Thibaut Cuvelier 2020-10-26 03:55:25 +01:00
parent 4405f0164a
commit 661c5d256b
4 changed files with 34 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
autotests/export/docbook/svmono_light.xml
View File

@ -4,21 +4,22 @@
<book xml:lang="en_US" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:m="http://www.w3.org/1998/Math/MathML" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.2">
<title>Untitled Document</title>
<chapter xml:id="chap.intro">
<title>Chapter Heading</title>
<info>
<title>Chapter Heading</title>
<titleabbrev>chapter heading in the running head</titleabbrev>
<abstract role='not-printed'>
<para>Each chapter should be preceded by an abstract (10–15 lines long) that summarizes the content. The abstract will appear <emphasis>online at and be available with unrestricted access. This allows unregistered users to read the abstract as a teaser for the complete chapter. As a general rule the abstracts will not appear in the printed version of your book unless it is the style of your particular book or that of the series to which your book belongs.</emphasis><!-- \indent -->
<para>Each chapter should be preceded by an abstract (10–15 lines long) that summarizes the content. The abstract will appear <emphasis>online at <link xlink:href="www.SpringerLink.com">www.SpringerLink.com</link> and be available with unrestricted access. This allows unregistered users to read the abstract as a teaser for the complete chapter. As a general rule the abstracts will not appear in the printed version of your book unless it is the style of your particular book or that of the series to which your book belongs.</emphasis><!-- \indent -->
Please use the 'starred' version of the <code>abstract</code> environment for typesetting the text of the online abstracts. Use the plain <code>abstract</code> if the abstract is also to appear in the printed version of the book.</para>
</abstract>
<abstract>
<para>Each chapter should be preceded by an abstract (10–15 lines long) that summarizes the content. The abstract will appear <emphasis>online at and be available with unrestricted access. This allows unregistered users to read the abstract as a teaser for the complete chapter. As a general rule the abstracts will not appear in the printed version of your book unless it is the style of your particular book or that of the series to which your book belongs.</emphasis><!-- \indent -->
<para>Each chapter should be preceded by an abstract (10–15 lines long) that summarizes the content. The abstract will appear <emphasis>online at <link xlink:href="www.SpringerLink.com">www.SpringerLink.com</link> and be available with unrestricted access. This allows unregistered users to read the abstract as a teaser for the complete chapter. As a general rule the abstracts will not appear in the printed version of your book unless it is the style of your particular book or that of the series to which your book belongs.</emphasis><!-- \indent -->
Please use the 'starred' version of the <code>abstract</code> environment for typesetting the text of the online abstracts. Use the plain <code>abstract</code> if the abstract is also to appear in the printed version of the book.</para>
</abstract>
</info>
<section xml:id="sec.Section-Heading">
<title>Section Heading</title>
<titleabbrev>section heading in the running head</titleabbrev>
<para>bla</para>
</section>
<section xml:id="sec.Section-Heading-2">
<title>Section Heading 2</title>
@ -34,7 +35,9 @@
</m:mrow>
</m:math>
</informalequation>
however, for multiline equations we recommend to use the <emphasis role='sans'>eqnarray</emphasis> environment.
however, for multiline equations we recommend to use the <emphasis role='sans'>eqnarray</emphasis> environment<footnote>
<para>In physics texts please activate the class option <code>vecphys</code> to depict your vectors in <emphasis role='bold'><emphasis>boldface-italic</emphasis> type - as is customary for a wide range of physical subjects.</emphasis></para>
</footnote>.
<informalequation xml:id="eq.01">
<alt role='tex'>a\times b &amp; = &amp; c\nonumber \\
\vec{a}\cdot\vec{b} &amp; = &amp; c\label{eq:01}

3
lib/layouts/stdsections.inc
View File

@ -41,6 +41,7 @@ Style Part
HTMLTag h1
DocBookTag title
DocBookTagType paragraph
DocBookInInfo maybe
DocBookSectionTag part
DocBookForceAbstractTag partintro
End
@ -77,6 +78,7 @@ Style Chapter
HTMLTag h1
DocBookTag title
DocBookTagType paragraph
DocBookInInfo maybe
DocBookSectionTag chapter
End
@ -111,6 +113,7 @@ Style Section
HTMLTag h2
DocBookTag title
DocBookTagType paragraph
DocBookInInfo maybe
DocBookSectionTag section
End

2
lib/layouts/svcommon.inc
View File

@ -115,6 +115,7 @@ Style Part
DocBookTag title
DocBookTagType paragraph
DocBookSectionTag part
DocBookInInfo maybe
DocBookForceAbstractTag partintro
End
@ -166,6 +167,7 @@ Style Chapter
Align Left
DocBookTag title
DocBookTagType paragraph
DocBookInInfo maybe
DocBookSectionTag chapter
End

37
src/output_docbook.cpp
View File

@ -553,6 +553,8 @@ void makeEnvironment(Text const &text,
closeTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnertagtype());
++p;
// Insert a new line after each "paragraph" (i.e. line in the listing), except for the last one.
// Otherwise, there would one more new line in the output than in the LyX document.
if (p != pars.end())
xs << xml::CR();
}
@ -811,12 +813,12 @@ DocBookInfoTag getParagraphsWithInfo(ParagraphList const &paragraphs,
// Skip paragraphs that don't generate anything in DocBook.
Paragraph const & par = paragraphs[cpit];
Layout const &style = par.layout();
if (hasOnlyNotes(par) || style.docbookininfo() == "never")
if (hasOnlyNotes(par))
continue;
// There should never be any section here. (Just a sanity check: if this fails, this function could end up
// processing the whole document.)
if (isLayoutSectioning(par.layout())) {
// There should never be any section here, except for the first paragraph (a title can be part of <info>).
// (Just a sanity check: if this fails, this function could end up processing the whole document.)
if (cpit != bpit && isLayoutSectioning(par.layout())) {
LYXERR0("Assertion failed: section found in potential <info> paragraphs.");
break;
}
@ -1102,7 +1104,8 @@ void docbookParagraphs(Text const &text,
// Don't output the ID as a DocBook <anchor>.
ourparams.docbook_anchors_to_ignore.emplace(label->screenLabel());
// Cannot have multiple IDs per tag.
// Cannot have multiple IDs per tag. If there is another ID inset in the document, it will
// be output as a DocBook anchor.
break;
}
}
@ -1136,16 +1139,14 @@ void docbookParagraphs(Text const &text,
}
}
// Generate this paragraph.
par = makeAny(text, buf, xs, ourparams, par);
// Generate the <info> tag if a section was just opened.
// Some sections may require abstracts (mostly parts, in books: DocBookForceAbstractTag will not be NONE),
// others can still have an abstract (it must be detected so that it can be output at the right place).
// 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.
if (isLayoutSectioning(style)) {
// This abstract may be found between the next paragraph and the next title.
pit_type cpit = std::distance(text.paragraphs().begin(), par);
pit_type ppit = std::get<1>(hasDocumentSectioning(paragraphs, cpit, epit));
pit_type ppit = std::get<1>(hasDocumentSectioning(paragraphs, cpit + 1L, epit));
// Generate this abstract (this code corresponds to parts of outputDocBookInfo).
DocBookInfoTag secInfo = getParagraphsWithInfo(paragraphs, cpit, ppit, true,
@ -1166,9 +1167,9 @@ void docbookParagraphs(Text const &text,
// Output the elements that should go in <info>, before and after the abstract.
for (auto pit : secInfo.shouldBeInInfo) // Typically, the title: these elements are so important and ubiquitous
// that mandating a wrapper like <info> would repel users. Thus, generate them first.
makeAny(text, buf, xs, runparams, paragraphs.iterator_at(pit));
makeAny(text, buf, xs, ourparams, paragraphs.iterator_at(pit));
for (auto pit : secInfo.mustBeInInfo)
makeAny(text, buf, xs, runparams, paragraphs.iterator_at(pit));
makeAny(text, buf, xs, ourparams, paragraphs.iterator_at(pit));
// Deal with the abstract in <info> if it is standard (i.e. its tag is <abstract>).
if (!secInfo.abstract.empty() && hasStandardAbstract) {
@ -1178,7 +1179,7 @@ void docbookParagraphs(Text const &text,
}
for (auto const &p : secInfo.abstract)
makeAny(text, buf, xs, runparams, paragraphs.iterator_at(p));
makeAny(text, buf, xs, ourparams, paragraphs.iterator_at(p));
if (!secInfo.abstractLayout) {
xs << xml::EndTag("abstract");
@ -1202,14 +1203,20 @@ void docbookParagraphs(Text const &text,
xs << xml::StartTag(style.docbookforceabstracttag());
xs << xml::CR();
for (auto const &p : secInfo.abstract)
makeAny(text, buf, xs, runparams, paragraphs.iterator_at(p));
makeAny(text, buf, xs, ourparams, paragraphs.iterator_at(p));
xs << xml::EndTag(style.docbookforceabstracttag());
xs << xml::CR();
}
// Skip all the text that just has been generated.
par = paragraphs.iterator_at(ppit);
// Skip all the text that has just been generated.
par = paragraphs.iterator_at(secInfo.epit);
} else {
// No <info> tag to generate, proceed as for normal paragraphs.
par = makeAny(text, buf, xs, ourparams, par);
}
} else {
// Generate this paragraph, as it has nothing special.
par = makeAny(text, buf, xs, ourparams, par);
}
}