DocBook: fixes in lists.

Actually output something when list item is empty. XMLStream discarded the sequence StartTag/EndTag (nothing in between).

New-line behaviour around term in description lists.
This commit is contained in:
Thibaut Cuvelier 2020-08-30 22:05:40 +02:00
parent 5b01c80635
commit 6688b076cc
8 changed files with 68 additions and 45 deletions

View File

@ -6,7 +6,7 @@
<subtitle>Version 2.3.x</subtitle> <subtitle>Version 2.3.x</subtitle>
<section> <section>
<title>File formats</title> <title>File formats</title>
<section xml:id="sec.When-is-an-0"> <section xml:id="sec.When-is-an">
<title>When is an update of the .lyx file format number needed?</title> <title>When is an update of the .lyx file format number needed?</title>
<para>When you are working on a new feature you may ask yourself whether it needs an update of the .lyx file format number. Whether an update is needed or not is not always obvious. Rule of thumb: </para> <para>When you are working on a new feature you may ask yourself whether it needs an update of the .lyx file format number. Whether an update is needed or not is not always obvious. Rule of thumb: </para>
<blockquote> <blockquote>
@ -17,30 +17,30 @@
<varlistentry> <varlistentry>
<term>New&#xA0;document&#xA0;setting</term> <term>New&#xA0;document&#xA0;setting</term>
<listitem> <listitem>
<para> Whenever you introduce a new setting that is stored in the document header, a file format update is needed.</para> <para>Whenever you introduce a new setting that is stored in the document header, a file format update is needed.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Removed&#xA0;document&#xA0;setting</term> <term>Removed&#xA0;document&#xA0;setting</term>
<listitem> <listitem>
<para> If a certain setting becomes obsolete and gets removed, a file format update is needed.</para> <para>If a certain setting becomes obsolete and gets removed, a file format update is needed.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>New&#xA0;valid&#xA0;value&#xA0;for&#xA0;an&#xA0;existing&#xA0;setting,</term> <term>New&#xA0;valid&#xA0;value&#xA0;for&#xA0;an&#xA0;existing&#xA0;setting,</term>
<listitem> <listitem>
<para> e.&#x2009;g.</para> <para>e.&#x2009;g.</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>Automatically&#xA0;loaded&#xA0;math&#xA0;package</term> <term>Automatically&#xA0;loaded&#xA0;math&#xA0;package</term>
<listitem> <listitem>
<para> The reason for this is that there is no true ERT inset for math formulas: Each command is parsed, and if a user happens to define a local command with the same name as a command that triggers an automatic load of a package, they need to be able to switch off the automatic loading of that package. This switch is stored by the use_package header setting.</para> <para>The reason for this is that there is no true ERT inset for math formulas: Each command is parsed, and if a user happens to define a local command with the same name as a command that triggers an automatic load of a package, they need to be able to switch off the automatic loading of that package. This switch is stored by the use_package header setting.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>New&#xA0;language</term> <term>New&#xA0;language</term>
<listitem> <listitem>
<para> that is stored in \language. </para> <para>that is stored in \language. </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -49,49 +49,49 @@
<varlistentry> <varlistentry>
<term>New&#xA0;inset</term> <term>New&#xA0;inset</term>
<listitem> <listitem>
<para> Of course a new inset requires a file format update.</para> <para>Of course a new inset requires a file format update.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>New&#xA0;style</term> <term>New&#xA0;style</term>
<listitem> <listitem>
<para> If a new style or inset layout is added to any layout file or module shipped with LyX, then a new file format is needed in the master (development) branch. It is possible to backport new styles to the stable version without a file format change.</para> <para>If a new style or inset layout is added to any layout file or module shipped with LyX, then a new file format is needed in the master (development) branch. It is possible to backport new styles to the stable version without a file format change.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Removed&#xA0;style</term> <term>Removed&#xA0;style</term>
<listitem> <listitem>
<para> If a style or inset layout is removed in any layout file or module shipped with LyX, a new file format is required.</para> <para>If a style or inset layout is removed in any layout file or module shipped with LyX, a new file format is required.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para>However, <emphasis role='bold'>new</emphasis> layouts and modules do <emphasis role='bold'>not</emphasis> require a file format update (changed 03/16). </para> <para>However, <emphasis role='bold'>new</emphasis> layouts and modules do <emphasis role='bold'>not</emphasis> require a file format update (changed 03/16). </para>
<para>If you are still unsure, please ask on the development list.</para> <para>If you are still unsure, please ask on the development list.</para>
<section xml:id="par.export-test-output-formats-1"> <section xml:id="par.export-test-output-formats">
<title>Output formats</title> <title>Output formats</title>
<para>The following output formats are currently tested for each sample document:</para> <para>The following output formats are currently tested for each sample document:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>LyX:</term> <term>LyX:</term>
<listitem> <listitem>
<para />
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>lyx16</term> <term>lyx16</term>
<listitem> <listitem>
<para> LyX 1.6 file format (lyx2lyx)</para> <para>LyX 1.6 file format (lyx2lyx)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>lyx21</term> <term>lyx21</term>
<listitem> <listitem>
<para> LyX 2.1 file format (lyx2lyx)</para> <para>LyX 2.1 file format (lyx2lyx)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>xhtml</term> <term>xhtml</term>
<listitem> <listitem>
<para> LyXHTML (native LyX HTML export)</para> <para>LyXHTML (native LyX HTML export)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -100,54 +100,54 @@
<varlistentry> <varlistentry>
<term>LyX&#xA0;+&#xA0;LaTeX:</term> <term>LyX&#xA0;+&#xA0;LaTeX:</term>
<listitem> <listitem>
<para />
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>dvi</term> <term>dvi</term>
<listitem> <listitem>
<para> DVI (8-bit latex)</para> <para>DVI (8-bit latex)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>dvi3_texF</term> <term>dvi3_texF</term>
<listitem> <listitem>
<para> DVI (LuaTeX with 8-bit TeX fonts)</para> <para>DVI (LuaTeX with 8-bit TeX fonts)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>dvi3_systemF</term> <term>dvi3_systemF</term>
<listitem> <listitem>
<para> DVI (LuaTeX with Unicode fonts)</para> <para>DVI (LuaTeX with Unicode fonts)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>pdf2</term> <term>pdf2</term>
<listitem> <listitem>
<para> PDF (pdflatex)</para> <para>PDF (pdflatex)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>pdf4_texF</term> <term>pdf4_texF</term>
<listitem> <listitem>
<para> PDF (XeTeX with 8-bit TeX fonts)</para> <para>PDF (XeTeX with 8-bit TeX fonts)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>pdf4_systemF</term> <term>pdf4_systemF</term>
<listitem> <listitem>
<para> PDF (XeTeX with Unicode fonts)</para> <para>PDF (XeTeX with Unicode fonts)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>pdf5_texF</term> <term>pdf5_texF</term>
<listitem> <listitem>
<para> PDF (LuaTeX with 8-bit TeX fonts)</para> <para>PDF (LuaTeX with 8-bit TeX fonts)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>pdf5_systemF</term> <term>pdf5_systemF</term>
<listitem> <listitem>
<para> PDF (LuaTeX with Unicode fonts)</para> <para>PDF (LuaTeX with Unicode fonts)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -156,18 +156,18 @@
<varlistentry> <varlistentry>
<term>LyX&#xA0;+&#xA0;LaTeX&#xA0;+&#xA0;postprocessing:</term> <term>LyX&#xA0;+&#xA0;LaTeX&#xA0;+&#xA0;postprocessing:</term>
<listitem> <listitem>
<para />
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>pdf</term> <term>pdf</term>
<listitem> <listitem>
<para> DVI -&gt; PS (dvips) -&gt; PDF (ps2pdf)</para> <para>DVI -&gt; PS (dvips) -&gt; PDF (ps2pdf)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>pdf3</term> <term>pdf3</term>
<listitem> <listitem>
<para> DVI -&gt; PDF (dvipdfm)</para> <para>DVI -&gt; PDF (dvipdfm)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -176,90 +176,90 @@
<varlistentry> <varlistentry>
<term>not&#xA0;tested:</term> <term>not&#xA0;tested:</term>
<listitem> <listitem>
<para> (or only if set as default output format in the document source)</para> <para>(or only if set as default output format in the document source)</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>latex</term> <term>latex</term>
<listitem> <listitem>
<para> LaTeX (plain)</para> <para>LaTeX (plain)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>luatex</term> <term>luatex</term>
<listitem> <listitem>
<para> LaTeX (LuaTeX)</para> <para>LaTeX (LuaTeX)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>dviluatex</term> <term>dviluatex</term>
<listitem> <listitem>
<para> LaTeX (dviluatex)</para> <para>LaTeX (dviluatex)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>pdflatex</term> <term>pdflatex</term>
<listitem> <listitem>
<para> LaTeX (pdflatex)</para> <para>LaTeX (pdflatex)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>platex</term> <term>platex</term>
<listitem> <listitem>
<para> LaTeX (pLaTeX)</para> <para>LaTeX (pLaTeX)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>xetex</term> <term>xetex</term>
<listitem> <listitem>
<para> LaTeX (XeTeX) </para> <para>LaTeX (XeTeX) </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>eps3</term> <term>eps3</term>
<listitem> <listitem>
<para> EPS (encapsulated Postscript) (cropped)</para> <para>EPS (encapsulated Postscript) (cropped)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>ps</term> <term>ps</term>
<listitem> <listitem>
<para> DVI -&gt; Postscript (dvips)</para> <para>DVI -&gt; Postscript (dvips)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>odf</term> <term>odf</term>
<listitem> <listitem>
<para> </para> <para />
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>text</term> <term>text</term>
<listitem> <listitem>
<para> (nor text2, ..., text4)</para> <para>(nor text2, ..., text4)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>textparagraph</term> <term>textparagraph</term>
<listitem> <listitem>
<para> </para> <para />
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>word</term> <term>word</term>
<listitem> <listitem>
<para> </para> <para />
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>word2</term> <term>word2</term>
<listitem> <listitem>
<para> </para> <para />
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>wordhtml</term> <term>wordhtml</term>
<listitem> <listitem>
<para> </para> <para />
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -269,5 +269,4 @@
</section> </section>
</section> </section>
</section> </section>
</article> </article>

View File

@ -234,6 +234,7 @@ Style Description
DocBookItemTag listitem DocBookItemTag listitem
DocBookItemInnerTag para DocBookItemInnerTag para
DocBookItemLabelTag term DocBookItemLabelTag term
DocBookItemLabelTagType paragraph
End End

View File

@ -269,6 +269,7 @@ Style Description
DocBookItemTag listitem DocBookItemTag listitem
DocBookItemInnerTag para DocBookItemInnerTag para
DocBookItemLabelTag term DocBookItemLabelTag term
DocBookItemLabelTagType paragraph
End End

View File

@ -142,6 +142,7 @@ Style Description
DocBookItemTag listitem DocBookItemTag listitem
DocBookItemInnerTag para DocBookItemInnerTag para
DocBookItemLabelTag term DocBookItemLabelTag term
DocBookItemLabelTagType paragraph
End End

View File

@ -69,6 +69,7 @@ Style Labeling
DocBookItemTag listitem DocBookItemTag listitem
DocBookItemInnerTag para DocBookItemInnerTag para
DocBookItemLabelTag term DocBookItemLabelTag term
DocBookItemLabelTagType paragraph
End End
Input stdsections.inc Input stdsections.inc

View File

@ -620,6 +620,7 @@ Style Description
DocBookItemTag listitem DocBookItemTag listitem
DocBookItemInnerTag para DocBookItemInnerTag para
DocBookItemLabelTag term DocBookItemLabelTag term
DocBookItemLabelTagType paragraph
End End
Style Petit Style Petit

View File

@ -255,6 +255,25 @@ void closeTag(XMLStream & xs, const std::string & tag, const std::string & tagty
} }
void compTag(XMLStream & xs, const std::string & tag, const std::string & attr, const std::string & tagtype)
{
if (tag.empty() || tag == "NONE")
return;
// Special case for <para>: always considered as a paragraph.
if (tag == "para" || tagtype == "paragraph" || tagtype == "block") {
if (!xs.isLastTagCR())
xs << xml::CR();
xs << xml::CompTag(tag, attr);
xs << xml::CR();
} else if (tagtype == "inline") {
xs << xml::CompTag(tag, attr);
} else {
xs.writeError("Unrecognised tag type '" + tagtype + "' for '" + tag + "'");
}
}
// Higher-level convenience functions. // Higher-level convenience functions.
void openParTag(XMLStream & xs, const Paragraph * par, const Paragraph * prevpar) void openParTag(XMLStream & xs, const Paragraph * par, const Paragraph * prevpar)
@ -692,9 +711,8 @@ ParagraphList::const_iterator makeListEnvironment(Text const &text,
} }
} else { } else {
// DocBook doesn't like emptiness. // DocBook doesn't like emptiness.
openTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnerattr(), compTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnerattr(),
par->layout().docbookiteminnertagtype()); par->layout().docbookiteminnertagtype());
closeTag(xs, par->layout().docbookiteminnertag(), par->layout().docbookiteminnertagtype());
} }
// If the next item is deeper, it must go entirely within this item (do it recursively). // If the next item is deeper, it must go entirely within this item (do it recursively).

View File

@ -651,7 +651,8 @@ docstring xml::cleanID(docstring const & orig)
// as both of them would be transformed as "a.b". With this procedure, one will become "a.b" and the other "a.b-1". // as both of them would be transformed as "a.b". With this procedure, one will become "a.b" and the other "a.b-1".
if (mangle && mangledNames.find(content) != mangledNames.end()) { if (mangle && mangledNames.find(content) != mangledNames.end()) {
int & mangleID = tMangleID.localData(); int & mangleID = tMangleID.localData();
content += "-" + convert<docstring>(mangleID); if (mangleID > 0)
content += "-" + convert<docstring>(mangleID);
mangleID += 1; mangleID += 1;
} }