DocBook: documentation for the new tags.

This commit is contained in:
Thibaut Cuvelier 2020-08-17 23:35:40 +02:00
parent 6998e76495
commit 360139a091
2 changed files with 645 additions and 6 deletions

View File

@ -27208,13 +27208,24 @@ Labels are rarely output, as they are redundant in DocBook: this information
\begin_layout Subsection
\change_inserted -970929547 1496610966
\change_inserted 1075283030 1597699417
\begin_inset CommandInset label
LatexCommand label
name "subsec:Paragraph-Style-DocBook"
\end_inset
\change_deleted 1075283030 1597699417
\begin_inset CommandInset label
LatexCommand label
name "subsec:Paragraph-Style-XHTML-1"
\end_inset
\change_inserted -970929547 1496610966
Paragraph styles
\end_layout
@ -27454,6 +27465,252 @@ tag
in the example above.
The default is the name of the float and always needs to be changed, as
DocBook provides no generic tag.
\change_inserted 1075283030 1597698868
\end_layout
\begin_layout Description
\change_inserted 1075283030 1597699399
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597698872
DocBookTagType
\end_layout
\end_inset
[
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597700585
block, paragraph, inline
\change_unchanged
\end_layout
\end_inset
] The new-line policy for this tag, see Section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:DocBook-New-line-policy"
plural "false"
caps "false"
noprefix "false"
\end_inset
for the details.
\change_unchanged
\end_layout
\begin_layout Subsection
\change_inserted 1075283030 1597699385
New-line policy
\begin_inset CommandInset label
LatexCommand label
name "subsec:DocBook-New-line-policy"
\end_inset
\end_layout
\begin_layout Standard
\change_inserted 1075283030 1597698993
For all tags, there are three possible policies for outputting new lines
(given in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597698987
DocBook*TagType
\end_layout
\end_inset
attribute):
\end_layout
\begin_layout Itemize
\change_inserted 1075283030 1597699279
\begin_inset Quotes eld
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699012
block
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
: the opening and closing tags are on their own lines (i.e.
a line feed after and before the opening and the closing tags).
Typical elements are floats.
For instance:
\end_layout
\begin_layout LyX-Code
\change_inserted 1075283030 1597699194
Content before
\end_layout
\begin_layout LyX-Code
\change_inserted 1075283030 1597699194
<blocktag>
\end_layout
\begin_layout LyX-Code
\change_inserted 1075283030 1597699098
Contents of the block.
\end_layout
\begin_layout LyX-Code
\change_inserted 1075283030 1597699196
</blocktag>
\end_layout
\begin_layout LyX-Code
\change_inserted 1075283030 1597699198
Content after
\end_layout
\begin_layout Itemize
\change_inserted 1075283030 1597699289
\begin_inset Quotes eld
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699113
paragraph
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
: the opening and closing tags are on the same, new line; a line feed is
output before the opening tag and after the closing tag.
Typical elements are paragraphs and list items.
For instance:
\end_layout
\begin_layout LyX-Code
\change_inserted 1075283030 1597699186
Content before
\end_layout
\begin_layout LyX-Code
\change_inserted 1075283030 1597699357
<paratag>Contents of the paragraph.</paratag>
\end_layout
\begin_layout LyX-Code
\change_inserted 1075283030 1597699231
Content after
\end_layout
\begin_layout Itemize
\change_inserted 1075283030 1597699343
\begin_inset Quotes eld
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699307
inline
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
: the opening and closing tags are on the same line as the rest of the content.
No line feeds are output.
Typical elements are fonts.
For instance:
\end_layout
\begin_layout LyX-Code
\change_inserted 1075283030 1597699585
Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
\end_layout
\begin_layout Standard
\change_inserted 1075283030 1597699585
The default value is always
\begin_inset Quotes eld
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699585
block
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
.
\change_unchanged
\end_layout
@ -28158,6 +28415,52 @@ NONE
This parameter only makes sense when itemising layouts are used, such as
lists.
\change_inserted 1075283030 1597699848
\end_layout
\begin_layout Description
\change_inserted 1075283030 1597699866
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699853
DocBookItemInnerTagType
\end_layout
\end_inset
[
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699866
block, paragraph, inline
\end_layout
\end_inset
] The new-line policy for this tag, see Section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:DocBook-New-line-policy"
plural "false"
caps "false"
noprefix "false"
\end_inset
for the details.
\change_unchanged
\end_layout
@ -28277,6 +28580,52 @@ itemlabeltag
This parameter only makes sense when itemising layouts are used with a
notion of labels, such as definition lists.
\change_inserted 1075283030 1597699874
\end_layout
\begin_layout Description
\change_inserted 1075283030 1597699874
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699880
DocBookItemLabelTagType
\end_layout
\end_inset
[
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699874
block, paragraph, inline
\end_layout
\end_inset
] The new-line policy for this tag, see Section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:DocBook-New-line-policy"
plural "false"
caps "false"
noprefix "false"
\end_inset
for the details.
\change_unchanged
\end_layout
@ -28352,6 +28701,54 @@ NONE
This parameter only makes sense when itemising layouts are used, such as
lists.
\change_inserted 1075283030 1597699890
\end_layout
\begin_layout Description
\change_inserted 1075283030 1597699890
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699890
DocBookItemTagType
\end_layout
\end_inset
[
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699890
block, paragraph, inline
\end_layout
\end_inset
] The new-line policy for this tag, see Section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:DocBook-New-line-policy"
plural "false"
caps "false"
noprefix "false"
\end_inset
for the details.
\change_unchanged
\end_layout
\begin_layout Description
@ -28487,6 +28884,52 @@ NONE
This parameter only makes sense when itemising layouts are used, such as
lists.
\change_inserted 1075283030 1597699897
\end_layout
\begin_layout Description
\change_inserted 1075283030 1597699897
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699900
DocBookItemWrapperTagType
\end_layout
\end_inset
[
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699897
block, paragraph, inline
\end_layout
\end_inset
] The new-line policy for this tag, see Section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:DocBook-New-line-policy"
plural "false"
caps "false"
noprefix "false"
\end_inset
for the details.
\change_unchanged
\end_layout
@ -28618,6 +29061,54 @@ NONE
, indicating that there is no inner tag: content is directly output without
it.
\change_inserted 1075283030 1597699904
\end_layout
\begin_layout Description
\change_inserted 1075283030 1597699904
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699904
DocBookInnerTagType
\end_layout
\end_inset
[
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699904
block, paragraph, inline
\end_layout
\end_inset
] The new-line policy for this tag, see Section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:DocBook-New-line-policy"
plural "false"
caps "false"
noprefix "false"
\end_inset
for the details.
\change_unchanged
\end_layout
\begin_layout Description
@ -28668,7 +29159,11 @@ section
\end_inset
, and is only overridden when DocBook uses something else for sectioning
(parts and chapters of a book).
(
\change_inserted 1075283030 1597699921
typically,
\change_inserted -970929547 1515110753
parts and chapters of a book).
\change_unchanged
@ -28729,6 +29224,54 @@ tag
in the example above.
The default is the name of the float and always needs to be changed, as
DocBook provides no generic inset tag.
\change_inserted 1075283030 1597699924
\end_layout
\begin_layout Description
\change_inserted 1075283030 1597699924
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699924
DocBookTagType
\end_layout
\end_inset
[
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699924
block, paragraph, inline
\end_layout
\end_inset
] The new-line policy for this tag, see Section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:DocBook-New-line-policy"
plural "false"
caps "false"
noprefix "false"
\end_inset
for the details.
\change_unchanged
\end_layout
\begin_layout Description
@ -28858,7 +29401,53 @@ NONE
, indicating that there is no wrapper tag: tag and content are directly
output without it.
\change_deleted -970929547 1515111523
\change_inserted 1075283030 1597699929
\end_layout
\begin_layout Description
\change_inserted 1075283030 1597699929
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699932
DocBookWrapperTagType
\end_layout
\end_inset
[
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597699929
block, paragraph, inline
\end_layout
\end_inset
] The new-line policy for this tag, see Section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:DocBook-New-line-policy"
plural "false"
caps "false"
noprefix "false"
\end_inset
for the details.
\change_unchanged
\end_layout
@ -29024,9 +29613,59 @@ Bibliography formatting
\begin_layout Standard
\change_deleted 1075283030 1597699984
The
\change_inserted 1075283030 1597699985
Included
\change_inserted -970929547 1515110187
The bibliography cannot be formatted: all fields are always output in the
database-like DocBook format (equivalent to a BibTeX file).
bibliograph
\change_deleted 1075283030 1597699987
y
\change_inserted 1075283030 1597699987
ies
\change_inserted -970929547 1515110187
cannot be formatted: all fields are always output in the database-like
DocBook format (equivalent to a BibTeX file)
\change_inserted 1075283030 1597700117
, using the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597700120
biblioentry
\end_layout
\end_inset
tag
\change_inserted -970929547 1515110187
.
\change_inserted 1075283030 1597700092
\end_layout
\begin_layout Standard
\change_inserted 1075283030 1597700112
When the bibliographic entries are manually inserted into the LyX document
as Bibliography Items, the user deals with formatting themself: there is
no attempt of parsing what the user wrote, the string is directly used
(with the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\change_inserted 1075283030 1597700076
bibliomixed
\end_layout
\end_inset
tag).
\change_unchanged
\end_layout

View File

@ -650,7 +650,7 @@ contributors = [
"Re: Patches to improve compatibility with modern C++ standard",
"m=158862338815864",
"4 May 2020",
u"Windows compatibility patches, Docbook backend"),
u"Windows compatibility patches, DocBook backend"),
contributor(u"Matthias Kalle Dalheimer",
"kalle () kdab ! net",