-#LyX 2.3 created this file. For more info see http://www.lyx.org/
-\lyxformat 544
+#LyX 2.4 created this file. For more info see https://www.lyx.org/
+\lyxformat 598
\begin_document
\begin_header
\save_transient_properties true
\begin_modules
logicalmkup
\end_modules
-\maintain_unincluded_children false
+\maintain_unincluded_children no
\language english
\language_package default
-\inputencoding auto
-\fontencoding global
+\inputencoding utf8
+\fontencoding auto
\font_roman "lmodern" "default"
\font_sans "lmss" "default"
\font_typewriter "lmtt" "default"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
-\font_osf false
+\font_roman_osf false
+\font_sans_osf false
+\font_typewriter_osf false
\font_sf_scale 100 100
\font_tt_scale 100 100
\use_microtype false
\justification true
\use_refstyle 0
\use_minted 0
+\use_lineno 0
\notefontcolor #0000ff
\branch OutDated
\selected 0
\papercolumns 1
\papersides 2
\paperpagestyle headings
-\tracking_changes false
+\tablestyle default
+\tracking_changes true
\output_changes false
+\change_bars false
+\postpone_fragile_content false
\html_math_output 0
\html_css_as_file 0
\html_be_strict true
+\docbook_table_output 0
+\author -970929547 "Thibaut Cuvelier"
+\author -712698321 "Jürgen Spitzmüller"
+\author -495245474 "Jean-Marc Lasgouttes"
+\author 5863208 "ab"
+\author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
+\author 1075283030 "Thibaut"
\end_header
\begin_body
\begin_layout Plain Layout
latex
+\change_inserted -712698321 1524656940
+=flavor
+\change_unchanged
+
\end_layout
\end_inset
This will make \SpecialChar LyX
's \SpecialChar LaTeX
error logs available.
+
+\change_inserted -712698321 1524657018
+ The optional
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657012
+flavor
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ value specifies the form of \SpecialChar LaTeX
+ that is run (
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657005
+latex, pdflatex, platex, xetex, luatex
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+).
+ If no value is specified,
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657018
+latex
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ is used.
+\change_unchanged
+
\end_layout
\begin_layout Labeling
\begin_layout Plain Layout
needaux
+\change_inserted -712698321 1524656935
+=flavor
+\change_unchanged
+
\end_layout
\end_inset
\end_inset
file for the conversion.
+
+\change_inserted -712698321 1524657047
+ The optional
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657030
+flavor
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ value specifies the form of \SpecialChar LaTeX
+ that is run in order to generate the
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657047
+.aux
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ file (
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657030
+latex, pdflatex, platex, xetex, luatex
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+).
+ If no value is specified,
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657030
+latex
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ is used.
+\change_unchanged
+
\end_layout
\begin_layout Labeling
format:
\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+
+\change_inserted -712698321 1523206314
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523206193
+hyperref-driver
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ The name of the driver that needs to be loaded with the
+\family sans
+hyperref
+\family default
+ package for this converter.
+ The loading of the correct driver is necessary to get some PDF-specific
+ features.
+ See the
+\family sans
+hyperref
+\family default
+ manual for details.
+\end_layout
+
\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex Code
\end_layout
\begin_layout Standard
-None of these last three are presently used in any of the converters that
- are installed with \SpecialChar LyX
+
+\change_inserted -712698321 1523206384
+A suitable hyperref-driver is set for some converters that are installed
+ with \SpecialChar LyX
+.
+
+\change_deleted -712698321 1523206388
+None of these
+\change_inserted -712698321 1523206389
+The
+\change_unchanged
+ last three
+\change_inserted -712698321 1523206400
+ flags, however,
+\change_unchanged
+ are presently
+\change_inserted -712698321 1523206407
+not
+\change_unchanged
+used in any of the
+\change_inserted -712698321 1523206437
+pre-installed
+\change_unchanged
+converters
+\change_deleted -712698321 1523206442
+ that are installed with \SpecialChar LyX
+
+\change_unchanged
.
\end_layout
\begin_layout Plain Layout
-https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
-\backslash
-#PO-Mode
+https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
\end_layout
\end_inset
Any format is acceptable, but one would normally use the format current
at the time.
(In \SpecialChar LyX
- 2.3, the current layout format is 63.)
+
+\begin_inset Info
+type "lyxinfo"
+arg "version"
+\end_inset
+
+, the current layout format is
+\begin_inset Info
+type "lyxinfo"
+arg "layoutformat"
+\end_inset
+
+.)
\end_layout
\begin_layout Standard
Supporting a style file is usually fairly easy.
Supporting a new class file is a bit harder.
We'll discuss the former in this section and the latter in the next.
- Similar remarks apply, of course, if you want to support a new DocBook
- DTD.
+
+\change_deleted 5863208 1594239023
+Similar remarks apply, of course, if you want to support a new DocBook DTD.
+\change_unchanged
+
\end_layout
\begin_layout Standard
\end_layout
\begin_layout LyX-Code
-Format 63
+Format
+\begin_inset Info
+type "lyxinfo"
+arg "layoutformat"
+\end_inset
+
+
\begin_inset Newline newline
\end_inset
\end_inset
package.
- Finally, it is also possible to declare classes for DocBook code.
+
+\change_deleted 5863208 1594239179
+Finally, it is also possible to declare classes for DocBook code.
Typical declarations will look like:
\end_layout
\begin_layout LyX-Code
+\change_deleted 5863208 1594239179
+
\size small
#% Do not delete the line below; configure depends on this
\end_layout
\begin_layout LyX-Code
+\change_deleted 5863208 1594239179
+
\size small
#
\backslash
\begin_layout LyX-Code
+\change_deleted 5863208 1594239179
+
\size small
#
\backslash
DeclareCategory{Articles (DocBook)}
+\change_unchanged
+
\end_layout
\begin_layout Standard
\begin_layout LyX-Code
#
\backslash
-DeclareLyXModule[endnotes.sty]{Endnotes}
+DeclareLyXModule[endnotes.sty]{Endnotes}
+\change_inserted -712698321 1554395911
+
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -712698321 1554395924
+
+\size small
+#
+\backslash
+DeclareCategory{Foot- and Endnotes}
+\change_deleted -712698321 1554395911
+
+\size default
+
+\change_unchanged
+
\end_layout
\begin_layout Standard
-The mandatory argument, in curly brackets, is the name of the module, as
- it should appear in
+The mandatory argument
+\change_inserted -712698321 1554395956
+ of
+\family typewriter
+
+\backslash
+DeclareLyXModule
+\change_unchanged
+
+\family default
+, in curly brackets, is the name of the module, as it should appear in
\begin_inset Flex Noun
status collapsed
\end_inset
'.
+
+\change_inserted -712698321 1554396133
+ The
+\family typewriter
+
+\backslash
+DeclareCategory
+\family default
+ declaration is not strictly mandatory, but you should add it, since it
+ is helpful to find the module.
+ Please have a look at the existing module categories and if appropriate,
+ use one of those.
+\change_unchanged
+
\end_layout
\begin_layout Standard
-The module declaration should then be followed by lines like the following:
+The module
+\change_inserted -712698321 1554395988
+and category
+\change_unchanged
+declaration should then be followed by lines like the following:
\begin_inset Foot
status collapsed
A module can contain any layout tag.)
\end_layout
+\begin_layout Description
+
+\change_inserted -712698321 1526899478
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1526898610
+AddToCiteEngine <engine>
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ Extends the possibilities for displaying citation references.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Citation-engine-description"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ for details.
+ Must end with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1526898823
+End
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
\begin_layout Description
\begin_inset Flex Code
status collapsed
\end_inset
.
+\change_inserted -712698321 1562592950
+
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1562593040
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteEngine <engine>
+
+\change_inserted -712698321 1562592954
+BibInToc
+\change_unchanged
+
\end_layout
\end_inset
- Defines the possibilities for displaying citation references.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Citation-engine-description"
-plural "false"
-caps "false"
-noprefix "false"
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1562592950
+
+\emph on
+0
+\change_unchanged
+
+\end_layout
\end_inset
- for details.
- Must end with
-\begin_inset Quotes eld
+,
+\begin_inset space \thinspace{}
\end_inset
status collapsed
\begin_layout Plain Layout
-End
+
+\change_inserted -712698321 1562592950
+1
+\change_unchanged
+
\end_layout
\end_inset
+] If the document class adds the bibliography to the table of contents,
+ add this option with value
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1562592996
+1
+\change_unchanged
+
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
- Primarily used in cite engine files (see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Cite-Engine-Files"
-plural "false"
-caps "false"
-noprefix "false"
+ (or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1562593006
+true
+\change_unchanged
+
+\end_layout
\end_inset
).
+ This prevents the bibliography from being added twice.
+\change_unchanged
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-CiteFormat
+CiteEngine <engine>
+\end_layout
+
+\end_inset
+
+ Defines the possibilities for displaying citation references.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Citation-engine-description"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ for details.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+End
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Primarily used in cite engine files (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+).
+
+\change_inserted -712698321 1526898530
+ Note that if you specify this in a layout file or module, any cite engine
+ definition will be overridden.
+ Also see
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1526898530
+AddToCiteEngine
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
\end_layout
\end_inset
\end_inset
).
+
+\change_inserted -712698321 1526898585
+ A cite format defined in a layout or module will override the cite engine
+ definition.
+\change_unchanged
+
\end_layout
\begin_layout Description
encouraged to use this directive.
\end_layout
+\begin_layout Description
+
+\change_inserted -970929547 1515112870
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -970929547 1515112782
+DocBookRoot
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -970929547 1515112766
+string
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] The root element (at the top of the document) to use when outputting documents
+ with this class in DocBook.
+ The default value is
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -970929547 1515112845
+article
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+
+\change_deleted 1075283030 1594226862
+
+\change_inserted 1075283030 1594226777
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 1075283030 1594226859
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 1075283030 1594226785
+DocBookForceAbstract
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 1075283030 1594226804
+boolean
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] If
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+true
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+, the root element will always have an
+\family typewriter
+<abstract>
+\family default
+ tag.
+ The default value is
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+false
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\change_unchanged
+
+\end_layout
+
\begin_layout Description
\begin_inset Flex Code
status collapsed
and one wants to define a new type of literate document.
The format is reset to
+\change_deleted 5863208 1594239413
+
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- or
+ or
+\change_unchanged
+
\begin_inset Quotes eld
\end_inset
\end_inset
,
+\change_deleted 5863208 1594239430
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+\change_unchanged
+
\begin_inset Flex Code
status collapsed
\end_inset
.)
+\change_inserted -712698321 1565102364
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1565102470
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565102365
+PageSize
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565105222
+
+\emph on
+custom
+\emph default
+, letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
+ b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] The default page size.
+ This is used by some converters.
+\change_unchanged
+
\end_layout
\begin_layout Description
\end_inset
for details on paragraph styles.
+\change_inserted -712698321 1553617804
+
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1553617862
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+
+\change_inserted -712698321 1553617809
+TableStyle
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string="maketitle"
+
+\change_inserted -712698321 1553617805
+<name>
+\change_unchanged
+
\end_layout
\end_inset
-] The name of the command or environment to be used with
+] defines the default table style that is used when inserting a table.
+ The following styles are available:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+
+\change_inserted -712698321 1554308039
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+
+\change_inserted -712698321 1554307928
+Formal_with_Footline
+\change_unchanged
+
\end_layout
\end_inset
-.
+: formal (
+\begin_inset Quotes eld
+\end_inset
+
+booktabs
+\begin_inset Quotes erd
+\end_inset
+
+) style with horizontal lines only, using a bold top and bottom line, the
+ first and last row are additionally separated from the table body with
+ a thin middle line.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+
+\change_inserted -712698321 1554308087
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+
+\change_inserted -712698321 1554308042
+Formal_without_Footline
+\change_unchanged
+
\end_layout
\end_inset
- [
+: same as the above, but the last row is not separated with a middle line
+ from the body.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1553618031
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-CommandAfter
+\change_inserted -712698321 1553618006
+Simple_Grid
+\change_unchanged
+
\end_layout
\end_inset
-,
+: Simple table lines.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1553618309
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1553618031
+Grid_with_Head
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+: Like
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1553618043
+Simple_Grid
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, but with the header column offset with a second horizontal line.
+ This is also the default style of \SpecialChar LyX
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1553618280
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1553618261
+No_Borders
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+: Table without lines.
+\change_unchanged
+
+\end_layout
+
+\end_deeper
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+TitleLatexName
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string="maketitle"
+\end_layout
+
+\end_inset
+
+] The name of the command or environment to be used with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+TitleLatexType
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+TitleLatexType
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+CommandAfter
+\end_layout
+
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\end_inset
.
+
+\change_inserted -712698321 1565110196
+ Any number is possible.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1565110259
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565110199
+FontSizeFormat
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565110196
+string
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] The format for the font size option.
+ Default:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565110238
+$$spt
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565110248
+$$s
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ is a placeholder for the font size.
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_deleted 5863208 1594239483
\begin_inset Flex Code
status collapsed
\end_inset
.
+\change_inserted -712698321 1565101761
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1565180598
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565101918
+PageSize
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565105399
+string="letter|\SpecialChar allowbreak
+legal|\SpecialChar allowbreak
+executive|\SpecialChar allowbreak
+a0|\SpecialChar allowbreak
+a1|\SpecialChar allowbreak
+a2|\SpecialChar allowbreak
+a3|\SpecialChar allowbreak
+a4|\SpecialChar allowbreak
+a5|\SpecialChar allowbreak
+a6|\SpecialChar allowbreak
+b0|\SpecialChar allowbreak
+b1|\SpecialChar allowbreak
+b2|\SpecialChar allowbreak
+b3|\SpecialChar allowbreak
+b4|\SpecialChar allowbreak
+b5|\SpecialChar allowbreak
+b6|\SpecialChar allowbreak
+c0|\SpecialChar allowbreak
+c1|\SpecialChar allowbreak
+c
+2|\SpecialChar allowbreak
+c3|\SpecialChar allowbreak
+c4|\SpecialChar allowbreak
+c5|\SpecialChar allowbreak
+c6|\SpecialChar allowbreak
+b0j|\SpecialChar allowbreak
+b1j|\SpecialChar allowbreak
+b2j|\SpecialChar allowbreak
+b3j|\SpecialChar allowbreak
+b4j|\SpecialChar allowbreak
+b5j|\SpecialChar allowbreak
+b6j"
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] The list of available page sizes, separated by
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565101779
+|
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Currently, only the listed sizes are supported.
+ Other sizes might be entered as custom class option.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1565180623
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565180605
+PageSizeFormat
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565180601
+string
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] The format for the page size option.
+ Default:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565180618
+$$spaper
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565180601
+$$s
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ is a placeholder for the paper size.
+\change_unchanged
+
\end_layout
\begin_layout Description
\end_inset
+\change_inserted -712698321 1555579782
+
\end_layout
\begin_layout Itemize
+
+\change_inserted -712698321 1555579780
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Requires
+
+\change_inserted -712698321 1555579780
+NewlineCmd
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-[int=0]
-\end_layout
-\end_inset
+\change_inserted -712698321 1555579780
+[string]
+\change_unchanged
+
+\end_layout
- defines another argument (by its number) which this argument requires to
- be output if it is itself output.
- E.
-\begin_inset space \thinspace{}
\end_inset
-g., in \SpecialChar LaTeX
- commands, optional arguments often require previous optional arguments
- to be output (at least empty), as in
+ Option to define a different command (from the default
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555579780
+
+\backslash
+
+\backslash
+
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+) to be used for line breaks.
+ The initial backslash must not be specified.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Requires
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+[int=0]
+\end_layout
+
+\end_inset
+
+ defines another argument (by its number) which this argument requires to
+ be output if it is itself output.
+ E.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., in \SpecialChar LaTeX
+ commands, optional arguments often require previous optional arguments
+ to be output (at least empty), as in
\begin_inset Flex Code
status collapsed
\end_inset
.
+\change_inserted -712698321 1559484228
+
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1559484228
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559484228
+FreeSpacing
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559484228
+
+\emph on
+0
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559484228
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+.
+\change_unchanged
+
\end_layout
\begin_layout Itemize
\end_inset
, this argument is automatically inserted when the respective style is selected.
+
+\change_deleted -712698321 1559484200
Currently, only one argument per style\SpecialChar breakableslash
layout can be automatically inserted.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1559491402
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559490711
+InsertOnNewline
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559490703
+[int=0]
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ If this is set to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559490703
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, this argument will be inserted on a new line with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491402
+AutoInsert
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ (only available within Flex insets).
\end_layout
\begin_layout Itemize
\end_inset
).
+\change_inserted -712698321 1534487781
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1534488561
+Finally, there is a special argument type with the prefix
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1534487844
+listpreamble:
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+ It is not really an argument, but uses the argument interface (thus, the
+ prefix is also followed by a number, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1534488412
+Argument listpreamble:1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+).
+ As the name implies, it is targeted at lists such as
+\family sans
+Itemize
+\family default
+,
+\family sans
+Enumerate
+\family default
+,
+\family sans
+Description
+\family default
+, or
+\family sans
+Bibliography
+\family default
+.
+ Its content will be output at the list start, before the first
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1534488058
+
+\backslash
+item
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, on an own line (a place that is otherwise not accessible in \SpecialChar LyX
+).
+ This way, users can insert redefinitions (of lengths etc.) to individual
+ lists.
+ By default, these arguments do not have a delimiter.
+\change_unchanged
+
\end_layout
\end_deeper
\end_inset
can be enabled.
- Note that \SpecialChar LyX
- will create protected blanks for the additional blanks when
- in another mode than \SpecialChar LaTeX
+
+\change_deleted -495245474 1550490105
+Note that
+\change_unchanged
+\SpecialChar LyX
+ will create protected blanks for the additional blanks when in
+\change_inserted -495245474 1550490096
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -495245474 1550490089
+Passthru 1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ is not specified.
+\change_deleted -495245474 1550490116
+another mode than \SpecialChar LaTeX
-mode.
+
+\change_inserted -495245474 1550247760
+ Note that
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -495245474 1550247736
+FreeSpacing
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ implies
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -495245474 1550247755
+KeepEmpty
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\change_unchanged
+
\end_layout
\begin_layout Description
not
\emph default
whether this command should itself be protected.)
+\change_inserted -712698321 1523696949
+
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1552395557
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Newline
+
+\change_inserted -712698321 1523696950
+NeedCProtect
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523696950
+
+\emph on
+0
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523696950
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] This causes macros that contain this layout to be protected with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523696950
+
+\backslash
+cprotect
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ (cf.
+ package
+\family sans
+cprotect
+\family default
+) if necessary and thus allows (some) verbatim stuff in macros.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1552395844
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395561
+NeedMBoxProtect
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395557
+
+\emph on
+0
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395557
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] Whether specific commands in this style (such as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395655
+
+\backslash
+cite
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395661
+
+\backslash
+ref
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+) should be protected in an
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395631
+
+\backslash
+mbox
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+ This is particularly needed for styles that draw on
+\family sans
+ulem
+\family default
+ or
+\family sans
+soul
+\family default
+ commands which parse their content in complex ways.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Newline
\end_layout
\end_inset
\end_inset
, which must be all caps.
+\change_inserted -712698321 1565605014
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1565605014
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565605014
+Requires
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565605014
+string
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+.
+\change_unchanged
+
\end_layout
\begin_layout Description
\end_layout
\begin_layout Standard
-Flex insets come in three different kinds:
+Flex insets come in
+\change_deleted 5863208 1594239511
+three
+\change_inserted 5863208 1594239512
+two
+\change_unchanged
+ different kinds:
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Itemize
+
+\change_deleted 5863208 1594239528
XML elements (
\begin_inset Flex Code
status collapsed
\end_inset
): For use with DocBook classes.
+\change_unchanged
+
\end_layout
\begin_layout Standard
tags.
Default is true.
+\change_inserted 731793113 1538674858
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 731793113 1538674891
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted 731793113 1538674863
+EditExternal
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\emph on
+0
+\emph default
+,1] Allow the contents of the inset to be edited externally (using whatever
+ editor is defined for the document's output format).
+\change_unchanged
+
\end_layout
\begin_layout Description
\end_inset
.
+\change_inserted -712698321 1555575738
+
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1555575844
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+
+\change_inserted -712698321 1555575740
+MenuString
+\change_unchanged
+
\end_layout
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
+\change_inserted -712698321 1555575740
+[string]
+\change_unchanged
+
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+ A dedicated string for the menu.
+ You can define an accelerator by appending the respective character to
+ the string, divided by
+\begin_inset Quotes eld
\end_inset
+|
+\begin_inset Quotes erd
+\end_inset
-\begin_inset Flex Code
-status collapsed
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Plain Layout
-1
-\end_layout
+g.
+\begin_inset space \space{}
+\end_inset
+
+\begin_inset Quotes eld
\end_inset
-] Whether multiple paragraphs are permitted in this inset.
- This will also set
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CustomPars
+
+\change_inserted -712698321 1555575781
+My Inset|M
+\change_unchanged
+
\end_layout
\end_inset
- to the same value and
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-ForcePlain
-\end_layout
+\begin_inset Quotes erd
\end_inset
- to the opposite value.
- These can be reset to other values, if they are used
-\emph on
-after
-\emph default
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-MultiPar
-\end_layout
-
-\end_inset
+).
+ This specification is optional.
+ If it is not given the inset name as specified in the type declaration
+ will be used instead for the menu.
+\change_unchanged
-.
- Default is true.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-NeedProtect
+MultiPar
\end_layout
\end_inset
\end_inset
-] Whether fragile commands in this inset should be
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-protect
-\end_layout
-
-\end_inset
-
-'ed.
- (Note: This is
-\emph on
-not
-\emph default
- whether the command should itself be protected.) Default is false.
-\end_layout
-
-\begin_layout Description
+] Whether multiple paragraphs are permitted in this inset.
+ This will also set
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NoInsetLayout
+CustomPars
\end_layout
\end_inset
- [
+ to the same value and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<layout>
+ForcePlain
\end_layout
\end_inset
-] Deletes an existing
+ to the opposite value.
+ These can be reset to other values, if they are used
+\emph on
+after
+\emph default
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+MultiPar
\end_layout
\end_inset
.
+ Default is true.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ObsoletedBy
+NeedProtect
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<layout>
+
+\emph on
+0
\end_layout
\end_inset
-] Name of an
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-InsetLayout
-\end_layout
-
+,
+\begin_inset space \thinspace{}
\end_inset
- that has replaced this
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+1
\end_layout
\end_inset
-.
- This is used to rename an
+] Whether fragile commands in this inset should be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+
+\backslash
+protect
\end_layout
\end_inset
-, while keeping backward compatibility.
+'ed.
+ (Note: This is
+\emph on
+not
+\emph default
+ whether the command should itself be protected.) Default is false.
+\change_inserted -712698321 1523633958
+
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1552395786
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ParbreakIsNewline
+
+\change_inserted -712698321 1523633961
+NeedCProtect
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
+\change_inserted -712698321 1523633958
+
\emph on
0
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -712698321 1523633958
1
+\change_unchanged
+
\end_layout
\end_inset
-] As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
+] This causes macros that contain this inset to be protected with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523634038
+
+\backslash
+cprotect
+\change_unchanged
+
+\end_layout
\end_inset
-.
+ (cf.
+ package
+\family sans
+cprotect
+\family default
+) if necessary and thus allows (some) verbatim stuff in macros.
Default is false.
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1555579651
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru
+
+\change_inserted -712698321 1552395787
+NeedMBoxProtect
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
+\change_inserted -712698321 1552395787
+
\emph on
0
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395787
1
+\change_unchanged
+
\end_layout
\end_inset
-] As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
+] Whether specific commands in this inset (such as
+\begin_inset Flex Code
+status collapsed
-\end_inset
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395787
+
+\backslash
+cite
+\change_unchanged
-.
- Default is false.
\end_layout
-\begin_layout Description
+\end_inset
+
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preamble
+
+\change_inserted -712698321 1552395787
+
+\backslash
+ref
+\change_unchanged
+
\end_layout
\end_inset
- As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
+) should be protected in an
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395787
+
+\backslash
+mbox
+\change_unchanged
+
+\end_layout
\end_inset
.
+ This is particularly needed for insets that draw on
+\family sans
+ulem
+\family default
+ or
+\family sans
+soul
+\family default
+ commands which parse their content in complex ways.
+ Default is false.
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1555579742
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RefPrefix
+
+\change_inserted -712698321 1555579658
+NewlineCmd
+\change_unchanged
+
\end_layout
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\change_inserted -712698321 1555579651
+[string]
+\change_unchanged
+
\end_layout
\end_inset
-] The prefix to use when creating labels referring to insets of this type.
- This allows the use of formatted references.
+ Option to define a different command (from the default
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555579742
+
+\backslash
+
+\backslash
+
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+) to be used for line breaks.
+ The initial backslash must not be specified.
+\change_unchanged
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Requires
+NoInsetLayout
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<layout>
\end_layout
\end_inset
-] As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
+] Deletes an existing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-ResetArgs
+ObsoletedBy
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+<layout>
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+] Name of an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+InsetLayout
\end_layout
\end_inset
-] Resets the \SpecialChar LaTeX
- arguments of this layout (as defined via the
+ that has replaced this
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+InsetLayout
\end_layout
\end_inset
- tag).
- This is useful if you have copied a style via
+.
+ This is used to rename an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+InsetLayout
\end_layout
\end_inset
-, but you do not want to inherit its (required and optional) arguments.
+, while keeping backward compatibility.
+\change_inserted -712698321 1559491850
+
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1559492002
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ResetsFont
+
+\change_inserted -712698321 1559491854
+ParbreakIgnored
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491850
+
+\emph on
0
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
-\emph on
+\change_inserted -712698321 1559491850
1
+\change_unchanged
+
\end_layout
\end_inset
-] Whether this inset should use the font of its surrounding environment
- or uses its own.
- Default is false: use the font of the surrounding environment.
-\end_layout
-
-\begin_layout Description
+] If this is set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RightDelim
-\end_layout
-
-\end_inset
- [
-\begin_inset Flex Code
-status collapsed
+\change_inserted -712698321 1559491881
+1
+\change_unchanged
-\begin_layout Plain Layout
-string
\end_layout
\end_inset
-] A string that is put at the end of the layout content.
- A line break in the output can be indicated by
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<br/>
-\end_layout
-
-\end_inset
+, paragraph breaks will be ignored in the output.
+ This might be useful for insets where the content should be alignable on
+ different lines only in the \SpecialChar LyX
+ workarea, without any effect in the output.
+\change_unchanged
-.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Spellcheck
+ParbreakIsNewline
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\emph on
0
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\emph on
1
\end_layout
\end_inset
-] Allow spell-checking the contents of this inset.
- Default is true.
-\end_layout
-
-\begin_layout Subsection
-Counters
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Counters"
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-It is necessary to define the counters (
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-chapter
+.
+ Default is false.
\end_layout
-\end_inset
-
-,
-\begin_inset Flex Noun
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-figure
+PassThru
\end_layout
\end_inset
-, \SpecialChar ldots
-) in the text class itself.
- The standard counters are defined in the file
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdcounters.inc
-\end_layout
-
-\end_inset
-, so you may have to do no more than add
+\emph on
+0
\end_layout
-\begin_layout LyX-Code
-Input stdcounters.inc
-\end_layout
+\end_inset
-\begin_layout Standard
-to your layout file to get them to work.
- But if you want to define custom counters, then you can do so.
- The counter declaration must begin with:
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout LyX-Code
-Counter CounterName
-\end_layout
-\begin_layout Standard
-where of course `
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CounterName
+1
\end_layout
\end_inset
-' is replaced by the name of the counter.
- And it must end with
-\begin_inset Quotes eld
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
\end_inset
+.
+ Default is false.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
+Preamble
\end_layout
\end_inset
+ As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
-\begin_inset Quotes erd
\end_inset
.
- The following parameters can also be used:
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-InitialValue
+RefPrefix
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-int=1
+string
\end_layout
\end_inset
-] Sets the initial value for the counter, to which it will be reset whenever
- that happens.
- Normally, one will want the default, 1.
+] The prefix to use when creating labels referring to insets of this type.
+ This allows the use of formatted references.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelString
+Requires
\end_layout
\end_inset
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
-\begin_inset Quotes erd
\end_inset
-] When defined, this string defines how the counter is displayed.
- Setting this value sets
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+ResetArgs
\end_layout
\end_inset
- to the same value.
- The following special constructs can be used in the string:
-\end_layout
-
-\begin_deeper
-\begin_layout Itemize
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-thecounter
+\emph on
+0
\end_layout
\end_inset
- will be replaced by the expansion of the
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+1
\end_layout
\end_inset
- (or
+] Resets the \SpecialChar LaTeX
+ arguments of this layout (as defined via the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+Argument
\end_layout
\end_inset
-) of the counter
+ tag).
+ This is useful if you have copied a style via
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-counter
+CopyStyle
\end_layout
\end_inset
-.
-
+, but you do not want to inherit its (required and optional) arguments.
\end_layout
-\begin_layout Itemize
-counter values can be expressed using \SpecialChar LaTeX
--like macros
-\begin_inset Newline newline
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\emph on
-numbertype
-\emph default
-{
-\emph on
-counter
-\emph default
-}
+ResetsFont
\end_layout
\end_inset
-, where
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph on
-numbertype
+0
\end_layout
\end_inset
- can be:
-\begin_inset Foot
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Actually, the situation is a bit more complicated: any
-\family default
-\series default
-\shape default
-\emph default
-\bar default
-
-\size default
-\emph on
-\noun default
-\color inherit
-numbertype
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
- other than those described below will produce arabic numerals.
- It would not be surprising to see this change in the future.
+1
\end_layout
\end_inset
-
+]
+\change_inserted -712698321 1597733473
+If
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-arabic
+
+\change_inserted -712698321 1597732178
+1
+\change_unchanged
+
\end_layout
\end_inset
-: 1, 2, 3,\SpecialChar ldots
-;
+, font changes are redone inside the respective inset (in the output) even
+ if the inset itself is in the context of this font changes (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-alph
+
+\change_inserted -712698321 1597733683
+
+\backslash
+textbf{Sourrounding text
+\backslash
+myinset{
+\backslash
+textbf{content}}\SpecialChar ldots
+}
+\change_unchanged
+
\end_layout
\end_inset
- for lower-case letters: a, b, c, \SpecialChar ldots
-;
+ rather than
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Alph
+
+\change_inserted -712698321 1597733686
+
+\backslash
+textbf{Sourrounding text
+\backslash
+myinset{content}\SpecialChar ldots
+}
\end_layout
\end_inset
- for upper-case letters: A, B, C, \SpecialChar ldots
-;
+.
+ Setting this makes sense for commands that internally reset font settings
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., footnotes).
+ Note that wrongly setting this might lead to unwanted result (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-roman
+
+\change_inserted -712698321 1597733688
+
+\backslash
+emph{Sourrounding text
+\backslash
+myinset{
+\backslash
+emph{content}}\SpecialChar ldots
+}
\end_layout
\end_inset
- for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
-;
+, content is upright, as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Roman
+
+\change_inserted -712698321 1597733278
+
+\backslash
+emph
\end_layout
\end_inset
- for upper-case roman numerals: I, II, III\SpecialChar ldots
-;
+ toggles.
+
+\change_deleted -712698321 1597733283
+Whether this inset should use the font of its surrounding environment or
+ uses its own.
+
+\change_unchanged
+Default is
+\change_deleted -712698321 1597733290
+false
+\change_inserted -712698321 1597733290
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-hebrew
+
+\change_inserted -712698321 1597733292
+0
\end_layout
\end_inset
- for hebrew numerals.
+
+\change_unchanged
+:
+\change_deleted -712698321 1597733327
+use the font of the surrounding environment
+\change_inserted -712698321 1597733343
+font changes are not redone inside the inset
+\change_unchanged
+.
\end_layout
-\end_deeper
-\begin_layout Standard
-If LabelString is not defined, a default value is constructed as follows:
- if the counter has a master counter
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-master
+RightDelim
\end_layout
\end_inset
- (defined via
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Within
+string
\end_layout
\end_inset
-), the string
-\begin_inset Newline newline
+] A string that is put at the end of the layout content.
+ A line break in the output can be indicated by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<br/>
+\end_layout
+
\end_inset
+.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-themaster.
-\backslash
-arabic{counter}
+Spellcheck
\end_layout
\end_inset
- is used; otherwise the string
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-arabic{counter}
+0
\end_layout
\end_inset
- is used.
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+
+\emph on
+1
\end_layout
\end_inset
- [
-\begin_inset Flex Code
+] Allow spell-checking the contents of this inset.
+ Default is true.
+\end_layout
+
+\begin_layout Subsection
+Counters
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Counters"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+It is necessary to define the counters (
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-string
+chapter
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+,
+\begin_inset Flex Noun
+status collapsed
+\begin_layout Plain Layout
+figure
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] Same as
+, \SpecialChar ldots
+) in the text class itself.
+ The standard counters are defined in the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+stdcounters.inc
\end_layout
\end_inset
-, but for use in the Appendix.
+, so you may have to do no more than add
\end_layout
-\begin_layout Description
+\begin_layout LyX-Code
+Input stdcounters.inc
+\end_layout
+
+\begin_layout Standard
+to your layout file to get them to work.
+ But if you want to define custom counters, then you can do so.
+ The counter declaration must begin with:
+\end_layout
+
+\begin_layout LyX-Code
+Counter CounterName
+\end_layout
+
+\begin_layout Standard
+where of course `
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PrettyFormat
+CounterName
\end_layout
\end_inset
- [
+' is replaced by the name of the counter.
+ And it must end with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+End
\end_layout
\end_inset
-=
+
\begin_inset Quotes erd
\end_inset
+.
+ The following parameters can also be used:
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-] A format for use with formatted references to this counter.
- For example, one might want to have references to section numbers appear
- as
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+InitialValue
+\end_layout
-Section 2.4
-\begin_inset Quotes erd
\end_inset
-.
- The string should contain
-\begin_inset Quotes eld
-\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+int=1
+\end_layout
-##
-\begin_inset Quotes erd
\end_inset
-.
- This will be replaced by the counter number itself.
- So, for sections, it would be: Section ##.
+] Sets the initial value for the counter, to which it will be reset whenever
+ that happens.
+ Normally, one will want the default, 1.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Within
+LabelString
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-] If this is set to the name of another counter, the present counter will
- be reset every time the other one is increased.
- For example,
+] When defined, this string defines how the counter is displayed.
+ Setting this value sets
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-subsection
+LabelStringAppendix
\end_layout
\end_inset
- is numbered inside
+ to the same value.
+ The following special constructs can be used in the string:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-section
+
+\backslash
+thecounter
\end_layout
\end_inset
-.
+ will be replaced by the expansion of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelString
\end_layout
-\begin_layout Subsection
-Font description
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Font-description"
+\end_inset
+
+ (or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelStringAppendix
+\end_layout
\end_inset
+) of the counter
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+counter
\end_layout
-\begin_layout Standard
-A font description looks like this:
+\end_inset
+
+.
+
\end_layout
-\begin_layout LyX-Code
-Font
-\family roman
-\emph on
-or
-\family default
-\emph default
- LabelFont
-\emph on
-
-\family roman
-or
-\family default
-\emph default
- DefaultFont
-\end_layout
-
-\begin_layout LyX-Code
- ...
-\end_layout
-
-\begin_layout LyX-Code
-EndFont
-\end_layout
+\begin_layout Itemize
+counter values can be expressed using \SpecialChar LaTeX
+-like macros
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-The following commands are available:
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Color
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
+\backslash
\emph on
-none
+numbertype
+\emph default
+{
+\emph on
+counter
+\emph default
+}
\end_layout
\end_inset
-,
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-black
+
+\emph on
+numbertype
\end_layout
\end_inset
-,
-\begin_inset Flex Code
+ can be:
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-white
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Actually, the situation is a bit more complicated: any
+\family default
+\series default
+\shape default
+\emph default
+\bar default
+
+\size default
+\emph on
+\noun default
+\color inherit
+numbertype
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+ other than those described below will produce arabic numerals.
+ It would not be surprising to see this change in the future.
\end_layout
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-red
+arabic
\end_layout
\end_inset
-,
+: 1, 2, 3,\SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-green
+alph
\end_layout
\end_inset
-,
+ for lower-case letters: a, b, c, \SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-blue
+Alph
\end_layout
\end_inset
-,
+ for upper-case letters: A, B, C, \SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-cyan
+roman
\end_layout
\end_inset
-,
+ for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-magenta
+Roman
\end_layout
\end_inset
-,
+ for upper-case roman numerals: I, II, III\SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-yellow
+hebrew
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-brown
+ for hebrew numerals.
\end_layout
-\end_inset
-
-,
+\end_deeper
+\begin_layout Standard
+If LabelString is not defined, a default value is constructed as follows:
+ if the counter has a master counter
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-darkgray
+master
\end_layout
\end_inset
-,
+ (defined via
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-gray
+Within
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lightgray
-\end_layout
-
+), the string
+\begin_inset Newline newline
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lime
+
+\backslash
+themaster.
+\backslash
+arabic{counter}
\end_layout
\end_inset
-,
+ is used; otherwise the string
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-orange
+
+\backslash
+arabic{counter}
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-olive
+ is used.
\end_layout
-\end_inset
-
-,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-pink
+LabelStringAppendix
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-purple
+string
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-teal
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
+] Same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-violet
+LabelString
\end_layout
\end_inset
-]
+, but for use in the Appendix.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Family
+PrettyFormat
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Roman
+string
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Sans
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+
+] A format for use with formatted references to this counter.
+ For example, one might want to have references to section numbers appear
+ as
+\begin_inset Quotes eld
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+Section 2.4
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Typewriter
-\end_layout
+.
+ The string should contain
+\begin_inset Quotes eld
+\end_inset
+##
+\begin_inset Quotes erd
\end_inset
-]
+.
+ This will be replaced by the counter number itself.
+ So, for sections, it would be: Section ##.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Misc
+Within
\end_layout
\end_inset
\end_inset
-] Valid arguments are:
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-emph
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
+] If this is set to the name of another counter, the present counter will
+ be reset every time the other one is increased.
+ For example,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-noun
+subsection
\end_layout
\end_inset
-,
+ is numbered inside
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-strikeout
+section
\end_layout
\end_inset
-,
+.
+\end_layout
+
+\begin_layout Subsection
+Font description
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Font-description"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+A font description looks like this:
+\end_layout
+
+\begin_layout LyX-Code
+Font
+\family roman
+\emph on
+or
+\family default
+\emph default
+ LabelFont
+\emph on
+
+\family roman
+or
+\family default
+\emph default
+ DefaultFont
+\end_layout
+
+\begin_layout LyX-Code
+ ...
+\end_layout
+
+\begin_layout LyX-Code
+EndFont
+\end_layout
+
+\begin_layout Standard
+The following commands are available:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-underbar
+Color
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-uuline
+
+\emph on
+none
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-uwave
+black
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-no_emph
+white
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-no_noun
+red
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-no_strikeout
+green
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-no_bar
+blue
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-no_uuline
+cyan
\end_layout
\end_inset
- and
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_uwave
+magenta
\end_layout
\end_inset
-.
- Each of these turns on or off the corresponding attribute.
- For example,
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-emph
+yellow
\end_layout
\end_inset
- turns on emphasis, and
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
+brown
\end_layout
\end_inset
- turns it off.
-
-\begin_inset Newline newline
-\end_inset
-
-If the latter seems puzzling, remember that the font settings for the present
- context are generally inherited from the surrounding context.
- So
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
+darkgray
\end_layout
\end_inset
- would turn off the emphasis that was anyway in effect, say, in a theorem
- environment.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Series
+gray
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Medium
+lightgray
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Bold
+lime
\end_layout
\end_inset
-]
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+orange
\end_layout
-\begin_layout Description
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Shape
+olive
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Up
+pink
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Italic
+purple
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-SmallCaps
+teal
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Slanted
+violet
\end_layout
\end_inset
-]
+]
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Size
+Family
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-tiny
+
+\emph on
+Roman
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-small
+Sans
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-normal
+Typewriter
\end_layout
\end_inset
-,
+]
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-large
+Misc
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-larger
+string
\end_layout
\end_inset
-,
+] Valid arguments are:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-largest
+emph
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-huge
+noun
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-giant
+strikeout
\end_layout
\end_inset
-]
-\end_layout
+,
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Citation-engine-description"
+\begin_layout Plain Layout
+underbar
+\end_layout
\end_inset
-Cite engine description
-\end_layout
-
-\begin_layout Standard
-The
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteEngine
+uuline
\end_layout
\end_inset
- blocks, as used mainly in cite engine files (see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Cite-Engine-Files"
-plural "false"
-caps "false"
-noprefix "false"
+,
+\begin_inset Flex Code
+status collapsed
-\end_inset
+\begin_layout Plain Layout
+uwave
+\end_layout
-), define the citation commands provided by a specific
-\begin_inset Quotes eld
\end_inset
-cite engine
-\begin_inset Quotes erd
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
-.
- A cite engine, in \SpecialChar LyX
- terms, is way specific way to format citations, using
- numbers, author names and/or years.
- Currently, \SpecialChar LyX
- supports three such engine types, namely:
+\begin_layout Plain Layout
+no_emph
\end_layout
-\begin_layout Enumerate
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-default
+no_noun
\end_layout
\end_inset
-: the default Bib\SpecialChar TeX
- way to format citations, a simple numeric style (e.
-\begin_inset space \thinspace{}
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
-g.,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+no_strikeout
+\end_layout
-[1]
-\begin_inset Quotes erd
\end_inset
-)
-\end_layout
-
-\begin_layout Enumerate
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-authoryear
+no_bar
\end_layout
\end_inset
-: Harvard-styled citations using author names and publication year (e.
-\begin_inset space \thinspace{}
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_uuline
+\end_layout
+
\end_inset
-g.,
-\begin_inset Quotes eld
-\end_inset
-
-Smith and Miller (2017b)
-\begin_inset Quotes erd
-\end_inset
-
-)
-\end_layout
-
-\begin_layout Enumerate
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-numerical
+no_uwave
\end_layout
\end_inset
-: extended numerical citations that also allow for author or title next
- to the number (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.,
-\begin_inset Quotes eld
-\end_inset
-
-Smith and Miller [1]
-\begin_inset Quotes erd
-\end_inset
-
-)
-\end_layout
-
-\begin_layout Standard
+.
+ Each of these turns on or off the corresponding attribute.
+ For example,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteEngine
+emph
\end_layout
\end_inset
- blocks look like this:
-\end_layout
-
-\begin_layout LyX-Code
-CiteEngine default
-\end_layout
-
-\begin_layout LyX-Code
- cite
-\end_layout
-
-\begin_layout LyX-Code
- Citep*[][]
-\end_layout
+ turns on emphasis, and
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
- citeyearpar[][]=parencite*
+\begin_layout Plain Layout
+no_emph
\end_layout
-\begin_layout LyX-Code
- ...
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-End
-\end_layout
+ turns it off.
+
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-The tag following
+If the latter seems puzzling, remember that the font settings for the present
+ context are generally inherited from the surrounding context.
+ So
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteEngine
+no_emph
\end_layout
\end_inset
- denotes the engine.
- The individual lines respectively define a cite command or cite command
- paradigm supported by this engine.
- The line can be as simple as a cite command that is used both to name the
- respective \SpecialChar LyX
- command and the \SpecialChar LaTeX
- output or more complex in order to differentiate
- things.
- The full syntax is:
-\end_layout
-
-\begin_layout LyX-Code
-LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
+ would turn off the emphasis that was anyway in effect, say, in a theorem
+ environment.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXName
+Series
\end_layout
\end_inset
-: The name as used in the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-*.lyx
+
+\emph on
+Medium
\end_layout
\end_inset
- file.
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
-For portability reasons, we try to use the same name for same-formatted
- commands in different cite packages (thus many names stem from natbib,
- and thus we need to differentiate a
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latexcmd
+Bold
\end_layout
\end_inset
- sometimes, if the \SpecialChar LaTeX
- command names differ).
+]
\end_layout
-\end_deeper
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-alias
+Shape
\end_layout
\end_inset
-: a (comma-separated) list of commands that fall back to the given
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXName
+
+\emph on
+Up
\end_layout
\end_inset
- in the current engine.
- This eases the switch of citation packages and engines.
- The
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-alias
+Italic
\end_layout
\end_inset
- can be compared to
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ObsoletedBy
+SmallCaps
\end_layout
\end_inset
- in layout definitions.
-\end_layout
-
-\begin_layout Itemize
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latexcmd
+Slanted
\end_layout
\end_inset
-: The actual \SpecialChar LaTeX
- command that is output.
-
+]
\end_layout
-\begin_layout Standard
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Alias
+Size
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latexcmd
+tiny
\end_layout
\end_inset
- are optional.
- If no
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latexcmd
+small
\end_layout
\end_inset
- is given, the
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXName
-\end_layout
-
-\end_inset
- will be output to \SpecialChar LaTeX
-.
+\emph on
+normal
\end_layout
-\begin_layout Standard
-Note further:
-\end_layout
+\end_inset
-\begin_layout Itemize
-Capitalization indicates that the command also has a capitalized form (
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-Latexcmd
+large
\end_layout
\end_inset
- vs.
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-latexcmd
+larger
\end_layout
\end_inset
-).
- These usually enforce up-casing of name prefixes (
-\emph on
-von Goethe
-\emph default
-
-\begin_inset Formula $\Rightarrow$
-\end_inset
-
-
-\emph on
-Von Goethe
-\emph default
-).
-\end_layout
-
-\begin_layout Itemize
-Brackets
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[]
+largest
\end_layout
\end_inset
- indicate the number of optional arguments (there can be 0–2).
-\end_layout
-
-\begin_layout Itemize
-A star
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-*
+huge
\end_layout
\end_inset
- indicates there is a starred version of the command (
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-latexcmd*
+giant
\end_layout
\end_inset
- vs.
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-latexcmd
+]
\end_layout
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Citation-engine-description"
+
\end_inset
-).
-
+Cite engine description
\end_layout
-\begin_deeper
\begin_layout Standard
-By default, the starred version means: Output all authors even if it should
- be shortened with
-\begin_inset Quotes eld
-\end_inset
-
-et al.
-\begin_inset Quotes erd
-\end_inset
-
- due to the
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MaxCiteNames
+CiteEngine
\end_layout
\end_inset
- threshold.
-\end_layout
+ blocks, as used mainly in cite engine files (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
-\begin_layout Standard
-If the star has a different meaning for a given command, it can be specified
- in angle brackets:
-\begin_inset Flex Code
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-<!_stardesc!_stardesctooltip>
-\end_layout
+), define the citation commands provided by a specific
+\begin_inset Quotes eld
+\end_inset
+cite engine
+\begin_inset Quotes erd
\end_inset
.
- Maximal two translatable macro keywords, marked by the prefix
+ A cite engine, in \SpecialChar LyX
+ terms, is way specific way to format citations, using
+ numbers, author names and/or years.
+ Currently, \SpecialChar LyX
+ supports three such engine types, namely:
+\end_layout
+
+\begin_layout Enumerate
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-!_
+default
\end_layout
\end_inset
-, can be given.
- The first points to the string that replaces the
+: the default Bib\SpecialChar TeX
+ way to format citations, a simple numeric style (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
\begin_inset Quotes eld
\end_inset
-Full aut&hor list
+[1]
\begin_inset Quotes erd
\end_inset
- checkbox label in the citation dialog, the second one to an optional tool
- tip for this checkbox.
-
+)
\end_layout
-\begin_layout Standard
-Note that these two macros have to be defined in a
+\begin_layout Enumerate
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
+authoryear
\end_layout
\end_inset
- (see next section), dropping the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-!
-\end_layout
-
+: Harvard-styled citations using author names and publication year (e.
+\begin_inset space \thinspace{}
\end_inset
- from the prefix, like this:
-\end_layout
+g.,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
-_stardesc Sta&rred command label
-\end_layout
+Smith and Miller (2017b)
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-_stardesctooltip Tooltip for the starred command checkbox.
+)
\end_layout
-\end_deeper
-\begin_layout Itemize
-A dollar sign
+\begin_layout Enumerate
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$
+numerical
\end_layout
\end_inset
- indicates that this command features
-\begin_inset Quotes eld
+: extended numerical citations that also allow for author or title next
+ to the number (e.
+\begin_inset space \thinspace{}
\end_inset
-qualified citation lists
-\begin_inset Quotes erd
+g.,
+\begin_inset Quotes eld
\end_inset
-.
- This is a
-\family sans
-Biblatex
-\family default
--specific feature for multi-reference citations where an individual pre-
- and postnote can be given to each reference in the list.
- Please refer to the
-\family sans
-Biblatex
-\family default
- manual for details.
-\end_layout
-
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Citation-format-description"
-
+Smith and Miller [1]
+\begin_inset Quotes erd
\end_inset
-Cite format description
+)
\end_layout
\begin_layout Standard
-The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
+CiteEngine
\end_layout
\end_inset
- blocks are used to describe how bibliographic information should be displayed,
- both within \SpecialChar LyX
- itself (in the citation dialog and in tooltips, for example)
- and in XHTML output.
- Such a block might look like this:
+ blocks look like this:
\end_layout
\begin_layout LyX-Code
-CiteFormat
+CiteEngine default
\end_layout
\begin_layout LyX-Code
- article ...
+ cite
\end_layout
\begin_layout LyX-Code
- book ...
+ Citep*[][]
\end_layout
\begin_layout LyX-Code
-End
+ citeyearpar[][]=parencite*
\end_layout
-\begin_layout Standard
-or
+\begin_layout LyX-Code
+ ...
\end_layout
\begin_layout LyX-Code
-CiteFormat
+End
\end_layout
-\begin_layout LyX-Code
- cite ...
+\begin_layout Standard
+The tag following
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteEngine
\end_layout
-\begin_layout LyX-Code
- citet*[][] ...
+\end_inset
+
+ denotes the engine.
+ The individual lines respectively define a cite command or cite command
+ paradigm supported by this engine.
+ The line can be as simple as a cite command that is used both to name the
+ respective \SpecialChar LyX
+ command and the \SpecialChar LaTeX
+ output or more complex in order to differentiate
+ things.
+ The full syntax is:
\end_layout
\begin_layout LyX-Code
-End
+LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
\end_layout
-\begin_layout Standard
-In the first case, the individual lines define how the bibliographic information
- associated with an article or book, respectively, is to be displayed, and
- such a definition can be given for any
-\begin_inset Quotes els
-\end_inset
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXName
+\end_layout
-entry type
-\begin_inset Quotes ers
\end_inset
- that might be present in a Bib\SpecialChar TeX
- file.
- \SpecialChar LyX
- defines a default format in the source code that will be used if no specific
- definition has been given.
- \SpecialChar LyX
- predefines several formats in the file
+: The name as used in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdciteformats.inc
+*.lyx
\end_layout
\end_inset
-, which is included in most of \SpecialChar LyX
-'s document classes.
+ file.
\end_layout
+\begin_deeper
\begin_layout Standard
-In the second case, the lines define how a specific citation command (in
- the example
+For portability reasons, we try to use the same name for same-formatted
+ commands in different cite packages (thus many names stem from natbib,
+ and thus we need to differentiate a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-cite
+latexcmd
\end_layout
\end_inset
-,
+ sometimes, if the \SpecialChar LaTeX
+ command names differ).
+\end_layout
+
+\end_deeper
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-citet
+alias
\end_layout
\end_inset
-) is to be displayed on the citation inset label, in the citation dialog,
- menu or XHTML output.
- \SpecialChar LyX
- defines such formats for the citation style variants it supports via
-\family sans
-Document\SpecialChar menuseparator
-Setting\SpecialChar menuseparator
-Bibliography\SpecialChar ldots
-
-\family default
- in specific
+: a (comma-separated) list of commands that fall back to the given
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-*.citeengine
+LyXName
\end_layout
\end_inset
- files that are shipped with \SpecialChar LyX
- (see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Cite-Engine-Files"
-plural "false"
-caps "false"
-noprefix "false"
-
-\end_inset
-
-).
-\end_layout
-
-\begin_layout Standard
-The definitions use a simple language that allows Bib\SpecialChar TeX
- keys to be replaced
- with their values.
- Keys should be enclosed in
+ in the current engine.
+ This eases the switch of citation packages and engines.
+ The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%
+alias
\end_layout
\end_inset
- signs, e.g.:
+ can be compared to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%author%
+ObsoletedBy
\end_layout
\end_inset
-.
- So a simple definition might look like this:
+ in layout definitions.
\end_layout
-\begin_layout LyX-Code
-misc %author%,
-\begin_inset Quotes eld
-\end_inset
-
-%title%
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
-.
+\begin_layout Plain Layout
+latexcmd
\end_layout
-\begin_layout Standard
-This would print the author, followed by a comma, followed by the title,
- in quotes, followed by a period.
+\end_inset
+
+: The actual \SpecialChar LaTeX
+ command that is output.
+
\end_layout
\begin_layout Standard
-Of course, sometimes you may want to print a key only if it exists.
- This can be done by using a conditional construction, such as:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%volume%[[vol.
-\begin_inset space ~
-\end_inset
-
-%volume%]]}
+Alias
\end_layout
\end_inset
-.
- This says: If the
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-volume
+latexcmd
\end_layout
\end_inset
- key exists, then print
-\begin_inset Quotes eld
-\end_inset
-
-vol.
-\begin_inset space ~
-\end_inset
-
+ are optional.
+ If no
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+latexcmd
+\end_layout
- followed by the volume key.
- It is also possible to have an else clause in the conditional, such as:
-\begin_inset Newline newline
\end_inset
-
+ is given, the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%author%[[%author%]][[%editor%, ed.]]}
+LyXName
\end_layout
\end_inset
+ will be output to \SpecialChar LaTeX
.
-\begin_inset Newline newline
-\end_inset
+\end_layout
-Here, the
+\begin_layout Standard
+Note further:
+\end_layout
+
+\begin_layout Itemize
+Capitalization indicates that the command also has a capitalized form (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-author
-\end_layout
-
-\end_inset
- key is printed if it exists; otherwise, the editor key is printed, followed
- by
-\begin_inset Quotes eld
-\end_inset
-
-,
-\begin_inset space ~
-\end_inset
+\backslash
+Latexcmd
+\end_layout
-ed.
-\begin_inset Quotes erd
\end_inset
- Note that the key is again enclosed in
+ vs.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%
+
+\backslash
+latexcmd
\end_layout
\end_inset
- signs; the entire conditional is enclosed in braces; and the if and else
- clauses are enclosed in double brackets,
-\begin_inset Quotes eld
+).
+ These usually enforce up-casing of name prefixes (
+\emph on
+von Goethe
+\emph default
+
+\begin_inset Formula $\Rightarrow$
\end_inset
+
+\emph on
+Von Goethe
+\emph default
+).
+\end_layout
+\begin_layout Itemize
+Brackets
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[[
+[]
\end_layout
\end_inset
+ indicate the number of optional arguments (there can be 0–2).
+\end_layout
-\begin_inset Quotes eld
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-
+\begin_layout Itemize
+A star
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-]]
+*
\end_layout
\end_inset
+ indicates there is a starred version of the command (
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-.
- There must be no space between any of these.
+\backslash
+latexcmd*
\end_layout
-\begin_layout Standard
-Next to the entry keys, there are some special keys that can be used for
- these conditionals:
-\end_layout
+\end_inset
-\begin_layout Itemize
+ vs.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%dialog%[[true]][[false]]}
-\end_layout
-\end_inset
+\backslash
+latexcmd
+\end_layout
-: process the
-\begin_inset Quotes eld
\end_inset
-true
-\begin_inset Quotes erd
-\end_inset
+).
+
+\end_layout
- part for dialogs and menus, the
+\begin_deeper
+\begin_layout Standard
+By default, the starred version means: Output all authors even if it should
+ be shortened with
\begin_inset Quotes eld
\end_inset
-false
+et al.
\begin_inset Quotes erd
\end_inset
- part for other contexts (workarea, export)
-\end_layout
-
-\begin_layout Itemize
+ due to the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%export%[[true]][[false]]}
+MaxCiteNames
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
+ threshold.
+\end_layout
-true
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+If the star has a different meaning for a given command, it can be specified
+ in angle brackets:
+\begin_inset Flex Code
+status collapsed
- part for export and menus, the
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+<!_stardesc!_stardesctooltip>
+\end_layout
-false
-\begin_inset Quotes erd
\end_inset
- part for other contexts (workarea, dialog)
-\end_layout
-
-\begin_layout Itemize
+.
+ Maximal two translatable macro keywords, marked by the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%next%[[true]]}
+!_
\end_layout
\end_inset
-: process the
+, can be given.
+ The first points to the string that replaces the
\begin_inset Quotes eld
\end_inset
-true
+Full aut&hor list
\begin_inset Quotes erd
\end_inset
- part if another item follows (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g., in a citation with multiple keys)
+ checkbox label in the citation dialog, the second one to an optional tool
+ tip for this checkbox.
+
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Note that these two macros have to be defined in a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%second%[[true]][[false]]}
+CiteFormat
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
+ (see next section), dropping the
+\begin_inset Flex Code
+status collapsed
-true
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+!
+\end_layout
- if this is the second of multiple items, else the
-\begin_inset Quotes eld
\end_inset
-false
-\begin_inset Quotes erd
-\end_inset
+ from the prefix, like this:
+\end_layout
- part
+\begin_layout LyX-Code
+_stardesc Sta&rred command label
+\end_layout
+
+\begin_layout LyX-Code
+_stardesctooltip Tooltip for the starred command checkbox.
\end_layout
+\end_deeper
\begin_layout Itemize
+A dollar sign
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%ifstar%[[true]][[false]]}
+$
\end_layout
\end_inset
-: process the
+ indicates that this command features
\begin_inset Quotes eld
\end_inset
-true
+qualified citation lists
\begin_inset Quotes erd
\end_inset
- part for starred citation commands (such as
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
+.
+ This is a
+\family sans
+Biblatex
+\family default
+-specific feature for multi-reference citations where an individual pre-
+ and postnote can be given to each reference in the list.
+ Please refer to the
+\family sans
+Biblatex
+\family default
+ manual for details.
+\change_inserted -712698321 1526898670
-\backslash
-cite*
\end_layout
-\end_inset
+\begin_layout Standard
-), the false part for unstarred
-\end_layout
+\change_inserted -712698321 1526899524
+If you want to add a cite command to a cite engine (e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Itemize
+g., add a specific command provided by a class), you can use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%ifentrytype:<type>%[[true]][[false]]}
+
+\change_inserted -712698321 1526898768
+AddToCiteEngine <engine type> \SpecialChar ldots
+ End
+\change_unchanged
+
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
+.
+ Note that only cite commands that do not exist yet are added.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Citation-format-description"
-true
-\begin_inset Quotes erd
\end_inset
- if the current entry type matches
+Cite format description
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<type>
+CiteFormat
\end_layout
\end_inset
-, else the false part (e.g., in a citation definition:
-\begin_inset Flex Code
-status collapsed
+ blocks are used to describe how bibliographic information should be displayed,
+ both within \SpecialChar LyX
+ itself (in the citation dialog and in tooltips, for example)
+ and in XHTML output.
+ Such a block might look like this:
+\end_layout
-\begin_layout Plain Layout
-{%ifentrytype:book%[[this is a book]][[this is no book]]}
+\begin_layout LyX-Code
+CiteFormat
\end_layout
-\end_inset
+\begin_layout LyX-Code
+ article ...
+\end_layout
-)
+\begin_layout LyX-Code
+ book ...
\end_layout
-\begin_layout Itemize
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+End
+\end_layout
-\begin_layout Plain Layout
-{%ifmultiple:<authortype>%[[true]][[false]]}
+\begin_layout Standard
+or
\end_layout
-\end_inset
+\begin_layout LyX-Code
+CiteFormat
+\end_layout
-: process the
-\begin_inset Quotes eld
+\begin_layout LyX-Code
+ cite ...
+\end_layout
+
+\begin_layout LyX-Code
+ citet*[][] ...
+\end_layout
+
+\begin_layout LyX-Code
+End
+\end_layout
+
+\begin_layout Standard
+In the first case, the individual lines define how the bibliographic information
+ associated with an article or book, respectively, is to be displayed, and
+ such a definition can be given for any
+\begin_inset Quotes els
\end_inset
-true
-\begin_inset Quotes erd
+entry type
+\begin_inset Quotes ers
\end_inset
- if the current author type (author, editor etc.) has multiple authors, else
- the false part (e.g., in a bibliography definition:
+ that might be present in a Bib\SpecialChar TeX
+ file.
+ \SpecialChar LyX
+ defines a default format in the source code that will be used if no specific
+ definition has been given.
+ \SpecialChar LyX
+ predefines several formats in the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%ifmultiple:editor%[[eds.]][[ed.]]}
+stdciteformats.inc
\end_layout
\end_inset
-)
+, which is included in most of \SpecialChar LyX
+'s document classes.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+In the second case, the lines define how a specific citation command (in
+ the example
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%ifqualified%[[true]][[false]]}
+
+\backslash
+cite
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+citet
+\end_layout
-true
-\begin_inset Quotes erd
\end_inset
- part if the current citation is a qualified citation list (a specific
+) is to be displayed on the citation inset label, in the citation dialog,
+ menu or XHTML output.
+ \SpecialChar LyX
+ defines such formats for the citation style variants it supports via
\family sans
-Biblatex
-\family default
- format for multi-reference citations), the false part if this is not the
- case.
-\end_layout
+Document\SpecialChar menuseparator
+Setting\SpecialChar menuseparator
+Bibliography\SpecialChar ldots
-\begin_layout Standard
-We said that
+\family default
+ in specific
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%author%
+*.citeengine
\end_layout
\end_inset
- prints the author key as it is recorded in the bibliography file.
- This might not be what you want, since it will result in a string such
- as
-\begin_inset Quotes eld
-\end_inset
-
-Miller, Peter and Smith, Mary and White, Jane
-\begin_inset Quotes erd
-\end_inset
-
- (since
-\begin_inset Quotes eld
-\end_inset
+ files that are shipped with \SpecialChar LyX
+ (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
-and
-\begin_inset Quotes erd
\end_inset
- is used by Bib\SpecialChar TeX
- to delimit authors).
- \SpecialChar LyX
- therefore provides some methods to get properly formatted name lists (which
- will also get translated).
- The following keys are provided:
+).
\end_layout
-\begin_layout Enumerate
-For name lists with pre- and surname, suitable for the main authors/editors
- of a bibliography item.
- The
+\begin_layout Standard
+The definitions use a simple language that allows Bib\SpecialChar TeX
+ keys to be replaced
+ with their values.
+ Keys should be enclosed in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<nametype>
+%
\end_layout
\end_inset
- part denotes the kind of list that is requested (e.g.
-
+ signs, e.g.:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<nametype:author>
+%author%
\end_layout
\end_inset
-):
-\end_layout
-
-\begin_deeper
-\begin_layout Itemize
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-%abbrvnames:<nametype>%
+.
+ So a simple definition might look like this:
\end_layout
-\end_inset
-
-: Provides a name list which is abbreviated (with
+\begin_layout LyX-Code
+misc %author%,
\begin_inset Quotes eld
\end_inset
-et al.
+%title%
\begin_inset Quotes erd
\end_inset
-) when
+.
+\end_layout
+
+\begin_layout Standard
+This would print the author, followed by a comma, followed by the title,
+ in quotes, followed by a period.
+\end_layout
+
+\begin_layout Standard
+Of course, sometimes you may want to print a key only if it exists.
+ This can be done by using a conditional construction, such as:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MaxCiteNames
-\end_layout
-
+{%volume%[[vol.
+\begin_inset space ~
\end_inset
- is reached.
+%volume%]]}
\end_layout
-\begin_layout Itemize
+\end_inset
+
+.
+ This says: If the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%fullnames:<nametype>%
+volume
\end_layout
\end_inset
-: Provides a full name list (never abbreviated with
+ key exists, then print
\begin_inset Quotes eld
\end_inset
-et al.
-\begin_inset Quotes erd
+vol.
+\begin_inset space ~
\end_inset
-).
+
+\begin_inset Quotes erd
+\end_inset
+
+ followed by the volume key.
+ It is also possible to have an else clause in the conditional, such as:
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%author%[[%author%]][[%editor%, ed.]]}
\end_layout
-\begin_layout Itemize
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+Here, the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%forceabbrvnames:<nametype>%
+author
\end_layout
\end_inset
-: Provides a name list which is always abbreviated (with
+ key is printed if it exists; otherwise, the editor key is printed, followed
+ by
\begin_inset Quotes eld
\end_inset
-et al.
+,
+\begin_inset space ~
+\end_inset
+
+ed.
\begin_inset Quotes erd
\end_inset
-) irrespective of
+ Note that the key is again enclosed in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MaxCiteNames
+%
\end_layout
\end_inset
-.
-\end_layout
-
-\end_deeper
-\begin_layout Enumerate
-Alternative name lists with pre- and surname, if the order of pre- and surname
- inside the bibliography item differs (as in:
+ signs; the entire conditional is enclosed in braces; and the if and else
+ clauses are enclosed in double brackets,
\begin_inset Quotes eld
\end_inset
-Miller, John: Some text, in: Mary Smith, ed.: A volume
-\begin_inset Quotes erd
-\end_inset
-
-):
-\end_layout
-\begin_deeper
-\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%abbrvbynames:<nametype>%
+[[
\end_layout
\end_inset
-: Provides a name list which is abbreviated (with
+
\begin_inset Quotes eld
\end_inset
-et al.
-\begin_inset Quotes erd
+ and
+\begin_inset Quotes eld
\end_inset
-) when
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MaxCiteNames
+]]
\end_layout
\end_inset
- is reached.
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ There must be no space between any of these.
+\end_layout
+
+\begin_layout Standard
+Next to the entry keys, there are some special keys that can be used for
+ these conditionals:
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-%fullbynames:<nametype>%
+{%dialog%[[true]][[false]]}
\end_layout
\end_inset
-: Provides a full name list (never abbreviated with
+: process the
\begin_inset Quotes eld
\end_inset
-et al.
+true
\begin_inset Quotes erd
\end_inset
-).
+ part for dialogs and menus, the
+\begin_inset Quotes eld
+\end_inset
+
+false
+\begin_inset Quotes erd
+\end_inset
+
+ part for other contexts (workarea, export)
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-%forceabbrvbynames:<nametype>%
+{%export%[[true]][[false]]}
\end_layout
\end_inset
-: Provides a name list which is always abbreviated (with
+: process the
\begin_inset Quotes eld
\end_inset
-et al.
+true
\begin_inset Quotes erd
\end_inset
-) irrespective of
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-MaxCiteNames
-\end_layout
+ part for export and menus, the
+\begin_inset Quotes eld
+\end_inset
+false
+\begin_inset Quotes erd
\end_inset
-.
+ part for other contexts (workarea, dialog)
\end_layout
-\end_deeper
-\begin_layout Enumerate
-And finally name lists which consist of family names only, as used in author-yea
-r citation labels.
- These do not take a
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<nametype>
+{%next%[[true]]}
\end_layout
\end_inset
- part, but always return either an author list or, if this does not exist,
- an editor list (as common in author-year labels):
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ part if another item follows (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., in a citation with multiple keys)
\end_layout
-\begin_deeper
\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%abbrvciteauthor%
+{%second%[[true]][[false]]}
\end_layout
\end_inset
-: Provides a name list which is abbreviated (with
+: process the
\begin_inset Quotes eld
\end_inset
-et al.
+true
\begin_inset Quotes erd
\end_inset
-) when
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-MaxCiteNames
-\end_layout
+ if this is the second of multiple items, else the
+\begin_inset Quotes eld
+\end_inset
+false
+\begin_inset Quotes erd
\end_inset
- is reached.
+ part
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-%fullciteauthor%
+{%ifstar%[[true]][[false]]}
\end_layout
\end_inset
-: Provides a full name list (never abbreviated with
+: process the
\begin_inset Quotes eld
\end_inset
-et al.
+true
\begin_inset Quotes erd
\end_inset
-).
+ part for starred citation commands (such as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+cite*
+\end_layout
+
+\end_inset
+
+), the false part for unstarred
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-%forceabbrvciteauthor%
+{%ifentrytype:<type>%[[true]][[false]]}
\end_layout
\end_inset
-: Provides a name list which is always abbreviated (with
+: process the
\begin_inset Quotes eld
\end_inset
-et al.
+true
\begin_inset Quotes erd
\end_inset
-) irrespective of
+ if the current entry type matches
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MaxCiteNames
+<type>
\end_layout
\end_inset
-.
-\end_layout
-
-\end_deeper
-\begin_layout Standard
-The order of pre- and surname in the former two lists can be adjusted by
- these macros:
-\end_layout
-
-\begin_layout Itemize
+, else the false part (e.g., in a citation definition:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-!firstnameform %surname%, %prename%
+{%ifentrytype:book%[[this is a book]][[this is no book]]}
\end_layout
\end_inset
- (first author in lists of type 1)
+)
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-!othernameform %surname%, %prename%
+{%ifmultiple:<authortype>%[[true]][[false]]}
\end_layout
\end_inset
- (other authors in lists of type 1)
-\end_layout
+: process the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+true
+\begin_inset Quotes erd
+\end_inset
+
+ if the current author type (author, editor etc.) has multiple authors, else
+ the false part (e.g., in a bibliography definition:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-!firstbynameform %prename% %surname%
+{%ifmultiple:editor%[[eds.]][[ed.]]}
\end_layout
\end_inset
- (first author in lists of type 2)
+)
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-!otherbynameform %prename% %surname%
+{%ifqualified%[[true]][[false]]}
\end_layout
\end_inset
- (other authors in lists of type 2)
-\end_layout
-
-\begin_layout Standard
-This allows you to configure namings like
+: process the
\begin_inset Quotes eld
\end_inset
-Miller, Peter and Mary Smith: \SpecialChar ldots
-, in: John Doe and Pat Green, eds.:\SpecialChar ldots
-
+true
\begin_inset Quotes erd
\end_inset
-.
+ part if the current citation is a qualified citation list (a specific
+\family sans
+Biblatex
+\family default
+ format for multi-reference citations), the false part if this is not the
+ case.
\end_layout
\begin_layout Standard
-There is one other piece of syntax available in definitions, which looks
- like this:
+We said that
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{!<i>!}
+%author%
\end_layout
\end_inset
-.
- This defines a piece of formatting information that is to be used when
- creating
+ prints the author key as it is recorded in the bibliography file.
+ This might not be what you want, since it will result in a string such
+ as
\begin_inset Quotes eld
\end_inset
-rich text
+Miller, Peter and Smith, Mary and White, Jane
\begin_inset Quotes erd
\end_inset
-.
- Obviously, we do not want to output HTML tags when writing plain text,
- so they should be wrapped in
+ (since
\begin_inset Quotes eld
\end_inset
-{!
+and
\begin_inset Quotes erd
\end_inset
- and
-\begin_inset Quotes eld
-\end_inset
+ is used by Bib\SpecialChar TeX
+ to delimit authors).
+ \SpecialChar LyX
+ therefore provides some methods to get properly formatted name lists (which
+ will also get translated).
+ The following keys are provided:
+\end_layout
-!}
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
+For name lists with pre- and surname, suitable for the main authors/editors
+ of a bibliography item.
+ The
+\begin_inset Flex Code
+status collapsed
-.
+\begin_layout Plain Layout
+<nametype>
\end_layout
-\begin_layout Standard
-Two special sorts of definitions are also possible in a
+\end_inset
+
+ part denotes the kind of list that is requested (e.g.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
+<nametype:author>
\end_layout
\end_inset
- block.
- An example of the first would be:
+):
\end_layout
-\begin_layout LyX-Code
-!quotetitle
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%abbrvnames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a name list which is abbreviated (with
\begin_inset Quotes eld
\end_inset
-%title%
+et al.
\begin_inset Quotes erd
\end_inset
+) when
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+MaxCiteNames
\end_layout
-\begin_layout Standard
-This is an abbreviation, or macro, and it can be used by treating it as
- if it were a key:
+\end_inset
+
+ is reached.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%!quotetitle%
+%fullnames:<nametype>%
\end_layout
\end_inset
-.
- \SpecialChar LyX
- will treat
+: Provides a full name list (never abbreviated with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%!quotetitle%
+%forceabbrvnames:<nametype>%
\end_layout
\end_inset
- exactly as it would treat its definition.
- So, let us issue the obvious
-\emph on
-warning
-\emph default
-.
- Do not do this:
-\end_layout
+: Provides a name list which is always abbreviated (with
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
-!funfun %funfun%
-\end_layout
+et al.
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-or anything like it.
- \SpecialChar LyX
- shouldn't go into an infinite loop, but it may go into a long one before
- it gives up.
+) irrespective of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
\end_layout
-\begin_layout Standard
-The second sort of special definition might look like this:
+\end_inset
+
+.
\end_layout
-\begin_layout LyX-Code
-B_pptext pp.
+\end_deeper
+\begin_layout Enumerate
+Alternative name lists with pre- and surname, if the order of pre- and surname
+ inside the bibliography item differs (as in:
+\begin_inset Quotes eld
+\end_inset
+
+Miller, John: Some text, in: Mary Smith, ed.: A volume
+\begin_inset Quotes erd
+\end_inset
+
+):
\end_layout
-\begin_layout Standard
-This defines a translatable piece of text, which allows relevant parts of
- the bibliography or citation to be translated.
- It can be included in a definition by treating it as a key:
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%B_pptext%
+%abbrvbynames:<nametype>%
\end_layout
\end_inset
-.
- Note that there are two different translation paths: All definitions starting
- with
+: Provides a name list which is abbreviated (with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) when
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-B_
+MaxCiteNames
\end_layout
\end_inset
-, such as in the example above, will be translated to the currently active
- buffer language (so the translation will match the generated document).
- All definitions starting with underscore only will be translated to the
- GUI language.
- This is the proper translation for strings that only occur in the dialogs
- or on buttons, such as this one:
-\end_layout
-
-\begin_layout LyX-Code
-_addtobib Add to bibliography only.
+ is reached.
\end_layout
-\begin_layout Standard
-Several of these translatable strings are predefined in
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdciteformats.inc
+%fullbynames:<nametype>%
\end_layout
\end_inset
- and the diverse
+: Provides a full name list (never abbreviated with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-*.citeengine
+%forceabbrvbynames:<nametype>%
\end_layout
\end_inset
- files.
- Note that these are not macros, in the sense just defined.
- They will not be expanded.
-\end_layout
+: Provides a name list which is always abbreviated (with
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-So here then is an example that uses several of these features:
-\begin_inset VSpace defskip
+et al.
+\begin_inset Quotes erd
\end_inset
+) irrespective of
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+MaxCiteNames
\end_layout
-\begin_layout Standard
-\noindent
+\end_inset
-\family sans
-!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
+.
\end_layout
-\begin_layout Standard
-\begin_inset VSpace defskip
-\end_inset
-
-This defines a macro that prints the author, followed by a comma, if the
-
+\end_deeper
+\begin_layout Enumerate
+And finally name lists which consist of family names only, as used in author-yea
+r citation labels.
+ These do not take a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-author
+<nametype>
\end_layout
\end_inset
- key is defined, or else prints the name of the editor, followed by the
-
+ part, but always return either an author list or, if this does not exist,
+ an editor list (as common in author-year labels):
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-B_edtext
+%abbrvciteauthor%
\end_layout
\end_inset
- or its translation (it is by default
+: Provides a name list which is abbreviated (with
\begin_inset Quotes eld
\end_inset
-ed.
+et al.
\begin_inset Quotes erd
\end_inset
-), if the
+) when
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-editor
+MaxCiteNames
\end_layout
\end_inset
- key is defined.
- Note that this is in fact defined in
+ is reached.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdciteformats.inc
+%fullciteauthor%
\end_layout
\end_inset
-, so you can use it in your own definitions, or re-definitions, if you load
- that file first.
-\end_layout
-
-\begin_layout Section
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:Tags-for-XHTML"
+: Provides a full name list (never abbreviated with
+\begin_inset Quotes eld
+\end_inset
+et al.
+\begin_inset Quotes erd
\end_inset
-Tags for XHTML output
+).
\end_layout
-\begin_layout Standard
-As with \SpecialChar LaTeX
- or DocBook, the format of \SpecialChar LyX
-'s XHTML output is also controlled by
- layout information.
- In general, \SpecialChar LyX
- provides sensible defaults and, as mentioned earlier, it will
- even construct default CSS style rules from the other layout tags.
- For example, \SpecialChar LyX
- will attempt to use the information provided in the
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+%forceabbrvciteauthor%
\end_layout
\end_inset
- declaration for the Chapter style to write CSS that will appropriately
- format chapter headings.
+: Provides a name list which is always abbreviated (with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) irrespective of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
\end_layout
-\begin_layout Standard
-In many cases, then, you may not have to do anything at all to get acceptable
- XHTML output for your own environments, custom insets, and so forth.
- But in some cases you will, and so \SpecialChar LyX
- provides a number of layout tags that
- can be used to customize the XHTML and CSS that are generated.
+\end_inset
+
+.
\end_layout
+\end_deeper
\begin_layout Standard
-Note that there are two tags,
+The order of pre- and surname in the former two lists can be adjusted by
+ these macros:
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+!firstnameform %surname%, %prename%
\end_layout
\end_inset
- and
+ (first author in lists of type 1)
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToHTMLPreamble
+!othernameform %surname%, %prename%
\end_layout
\end_inset
- that may appear outside style and inset declarations.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:General-text-class"
+ (other authors in lists of type 1)
+\end_layout
-\end_inset
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
- for details on these.
+\begin_layout Plain Layout
+!firstbynameform %prename% %surname%
\end_layout
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Paragraph-Style-XHTML"
-
\end_inset
-Paragraph styles
+ (first author in lists of type 2)
\end_layout
-\begin_layout Standard
-The sort of XHTML \SpecialChar LyX
- outputs for a paragraph depends upon whether we are dealing
- with a normal paragraph, a command, or an environment, where this is itself
- determined by the contents of the corresponding
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\SpecialChar LaTeX
-Type
+!otherbynameform %prename% %surname%
\end_layout
\end_inset
- tag.
-
+ (other authors in lists of type 2)
\end_layout
\begin_layout Standard
-For a command or normal paragraph, the output XHTML has the following form:
-\end_layout
+This allows you to configure namings like
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
+Miller, Peter and Mary Smith: \SpecialChar ldots
+, in: John Doe and Pat Green, eds.:\SpecialChar ldots
-\family sans
-<tag attr=
\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
+.
+\end_layout
->
+\begin_layout Standard
+There is one other piece of syntax available in definitions, which looks
+ like this:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{!<i>!}
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\family sans
-<labeltag attr=
-\begin_inset Quotes erd
+.
+ This defines a piece of formatting information that is to be used when
+ creating
+\begin_inset Quotes eld
\end_inset
-value
+rich text
\begin_inset Quotes erd
\end_inset
->Label</labeltag>
-\end_layout
+.
+ Obviously, we do not want to output HTML tags when writing plain text,
+ so they should be wrapped in
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
+{!
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Contents of the paragraph.
-\end_layout
+ and
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
+!}
+\begin_inset Quotes erd
+\end_inset
-\family sans
-</tag>
+.
\end_layout
\begin_layout Standard
-The label tags are of course omitted if the paragraph does not have a label.
+Two special sorts of definitions are also possible in a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
\end_layout
-\begin_layout Standard
-For an environment that is not some sort of list, the XHTML takes this form:
+\end_inset
+
+ block.
+ An example of the first would be:
\end_layout
\begin_layout LyX-Code
-
-\family sans
-<tag attr=
-\begin_inset Quotes erd
+!quotetitle
+\begin_inset Quotes eld
\end_inset
-value
+%title%
\begin_inset Quotes erd
\end_inset
->
-\end_layout
-\begin_layout LyX-Code
+\end_layout
-\family sans
-<itemtag attr=
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+This is an abbreviation, or macro, and it can be used by treating it as
+ if it were a key:
+\begin_inset Flex Code
+status collapsed
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+%!quotetitle%
+\end_layout
-><labeltag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
+.
+ \SpecialChar LyX
+ will treat
+\begin_inset Flex Code
+status collapsed
->Environment Label</labeltag>First paragraph.</itemtag>
+\begin_layout Plain Layout
+%!quotetitle%
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\family sans
-<itemtag>Second paragraph.</itemtag>
+ exactly as it would treat its definition.
+ So, let us issue the obvious
+\emph on
+warning
+\emph default
+.
+ Do not do this:
\end_layout
\begin_layout LyX-Code
-
-\family sans
-</tag>
+!funfun %funfun%
\end_layout
\begin_layout Standard
-Note that the label is output only for the first paragraph, as it should
- be for a theorem, for example.
-
+or anything like it.
+ \SpecialChar LyX
+ shouldn't go into an infinite loop, but it may go into a long one before
+ it gives up.
\end_layout
\begin_layout Standard
-For a list, we have one of these forms:
+The second sort of special definition might look like this:
\end_layout
\begin_layout LyX-Code
+B_pptext pp.
+\end_layout
-\family sans
-<tag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+This defines a translatable piece of text, which allows relevant parts of
+ the bibliography or citation to be translated.
+ It can be included in a definition by treating it as a key:
+\begin_inset Flex Code
+status collapsed
->
+\begin_layout Plain Layout
+%B_pptext%
\end_layout
-\begin_layout LyX-Code
-
-\family sans
-<itemtag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
-
-><labeltag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
-\end_inset
+.
+ Note that there are two different translation paths: All definitions starting
+ with
+\begin_inset Flex Code
+status collapsed
->List Label</labeltag>First item.</itemtag>
+\begin_layout Plain Layout
+B_
\end_layout
-\begin_layout LyX-Code
-
-\family sans
-<itemtag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
-\end_inset
-
-><labeltag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
\end_inset
->List Label</labeltag>Second item.</itemtag>
+, such as in the example above, will be translated to the currently active
+ buffer language (so the translation will match the generated document).
+ All definitions starting with underscore only will be translated to the
+ GUI language.
+ This is the proper translation for strings that only occur in the dialogs
+ or on buttons, such as this one:
\end_layout
\begin_layout LyX-Code
-
-\family sans
-</tag>
+_addtobib Add to bibliography only.
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+Several of these translatable strings are predefined in
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+stdciteformats.inc
\end_layout
-\begin_layout LyX-Code
-
-\family sans
-<tag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
+ and the diverse
+\begin_inset Flex Code
+status collapsed
->
+\begin_layout Plain Layout
+*.citeengine
\end_layout
-\begin_layout LyX-Code
-
-\family sans
-<labeltag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
-\end_inset
-
->List Label</labeltag><itemtag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
\end_inset
->First item.</itemtag>
+ files.
+ Note that these are not macros, in the sense just defined.
+ They will not be expanded.
\end_layout
-\begin_layout LyX-Code
-
-\family sans
-<labeltag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
-\end_inset
-
->List Label</labeltag><itemtag attr=
-\begin_inset Quotes erd
+\begin_layout Standard
+So here then is an example that uses several of these features:
+\begin_inset VSpace defskip
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
->Second item.</itemtag>
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+\noindent
\family sans
-</tag>
+!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
\end_layout
\begin_layout Standard
-Note the different orders of
+\begin_inset VSpace defskip
+\end_inset
+
+This defines a macro that prints the author, followed by a comma, if the
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-labeltag
+author
\end_layout
\end_inset
- and
+ key is defined, or else prints the name of the editor, followed by the
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-itemtag
+B_edtext
\end_layout
\end_inset
-.
- Which order we get depends upon the setting of
+ or its translation (it is by default
+\begin_inset Quotes eld
+\end_inset
+
+ed.
+\begin_inset Quotes erd
+\end_inset
+
+), if the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLLabelFirst
+editor
\end_layout
\end_inset
-: If
+ key is defined.
+ Note that this is in fact defined in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLLabelFirst
+stdciteformats.inc
\end_layout
\end_inset
- is false (the default), you get the first of these, with the label within
- the item; if true, you get the second, with the label outside the item.
+, so you can use it in your own definitions, or re-definitions, if you load
+ that file first.
\end_layout
-\begin_layout Standard
-The specific tags and attributes output for each paragraph type can be controlle
-d by means of the layout tags we are about to describe.
- As mentioned earlier, however, \SpecialChar LyX
- uses sensible defaults for many of these,
- so you often may not need to do very much to get good XHTML output.
- Think of the available tags as there so you can tweak things to your liking.
+\begin_layout Section
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Tags-for-XHTML"
+
+\end_inset
+
+Tags for XHTML output
\end_layout
-\begin_layout Description
+\begin_layout Standard
+As with \SpecialChar LaTeX
+ or DocBook, the format of \SpecialChar LyX
+'s XHTML output is also controlled by
+ layout information.
+ In general, \SpecialChar LyX
+ provides sensible defaults and, as mentioned earlier, it will
+ even construct default CSS style rules from the other layout tags.
+ For example, \SpecialChar LyX
+ will attempt to use the information provided in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLAttr
+Font
\end_layout
\end_inset
- [
+ declaration for the Chapter style to write CSS that will appropriately
+ format chapter headings.
+\end_layout
+
+\begin_layout Standard
+In many cases, then, you may not have to do anything at all to get acceptable
+ XHTML output for your own environments, custom insets, and so forth.
+ But in some cases you will, and so \SpecialChar LyX
+ provides a number of layout tags that
+ can be used to customize the XHTML and CSS that are generated.
+\end_layout
+
+\begin_layout Standard
+Note that there are two tags,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+HTMLPreamble
\end_layout
\end_inset
-] Specifies attribute information to be output with the main tag.
- For example,
-\begin_inset Quotes eld
-\end_inset
-
-
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`mydiv'
+AddToHTMLPreamble
\end_layout
\end_inset
+ that may appear outside style and inset declarations.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:General-text-class"
-\begin_inset Quotes erd
\end_inset
-.
- By default, \SpecialChar LyX
- will output
-\begin_inset Quotes eld
+ for details on these.
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Paragraph-Style-XHTML"
+
\end_inset
+Paragraph styles
+\end_layout
+\begin_layout Standard
+The sort of XHTML \SpecialChar LyX
+ outputs for a paragraph depends upon whether we are dealing
+ with a normal paragraph, a command, or an environment, where this is itself
+ determined by the contents of the corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`layoutname'
+\SpecialChar LaTeX
+Type
\end_layout
\end_inset
+ tag.
+
+\end_layout
+
+\begin_layout Standard
+For a command or normal paragraph, the output XHTML has the following form:
+\end_layout
+
+\begin_layout LyX-Code
+\family sans
+<tag attr=
\begin_inset Quotes erd
\end_inset
-, where
-\begin_inset Flex Code
-status collapsed
+value
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-layoutname
+>
\end_layout
+\begin_layout LyX-Code
+
+\family sans
+<labeltag attr=
+\begin_inset Quotes erd
\end_inset
- is the \SpecialChar LyX
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Label</labeltag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+Contents of the paragraph.
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+</tag>
+\end_layout
+
+\begin_layout Standard
+The label tags are of course omitted if the paragraph does not have a label.
+\end_layout
+
+\begin_layout Standard
+For an environment that is not some sort of list, the XHTML takes this form:
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+<itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Environment Label</labeltag>First paragraph.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+<itemtag>Second paragraph.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+</tag>
+\end_layout
+
+\begin_layout Standard
+Note that the label is output only for the first paragraph, as it should
+ be for a theorem, for example.
+
+\end_layout
+
+\begin_layout Standard
+For a list, we have one of these forms:
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+<itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag>First item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+<itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag>Second item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+</tag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+<labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag><itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>First item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+<labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag><itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Second item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+</tag>
+\end_layout
+
+\begin_layout Standard
+Note the different orders of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+labeltag
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+itemtag
+\end_layout
+
+\end_inset
+
+.
+ Which order we get depends upon the setting of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabelFirst
+\end_layout
+
+\end_inset
+
+: If
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabelFirst
+\end_layout
+
+\end_inset
+
+ is false (the default), you get the first of these, with the label within
+ the item; if true, you get the second, with the label outside the item.
+\end_layout
+
+\begin_layout Standard
+The specific tags and attributes output for each paragraph type can be controlle
+d by means of the layout tags we are about to describe.
+ As mentioned earlier, however, \SpecialChar LyX
+ uses sensible defaults for many of these,
+ so you often may not need to do very much to get good XHTML output.
+ Think of the available tags as there so you can tweak things to your liking.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Specifies attribute information to be output with the main tag.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`mydiv'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default, \SpecialChar LyX
+ will output
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`layoutname'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+layoutname
+\end_layout
+
+\end_inset
+
+ is the \SpecialChar LyX
name of the layout, made lowercase, for example: chapter.
This should
\emph on
-not
-\emph default
- contain any style information.
- Use
+not
+\emph default
+ contain any style information.
+ Use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ for that purpose.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLForceCSS
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\emph default
+,1
+\end_layout
+
+\end_inset
+
+] Whether to output the default CSS information \SpecialChar LyX
+ generates for this layout,
+ even if additional information is explicitly provided via
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+.
+ Setting this to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+ allows you to alter or augment the generated CSS, rather than to override
+ it completely.
+ Default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLItem
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The tag to be used for individual paragraphs of environments, replacing
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+itemtag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ Defaults to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLItemAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Attributes for the item tag.
+ Defaults to
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`layoutname_item'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This should
+\emph on
+not
+\emph default
+ contain any style information.
+ Use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ for that purpose.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabel
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The tag to be used for paragraph and item labels, replacing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+labeltag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ Defaults to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+span
+\end_layout
+
+\end_inset
+
+, unless
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelType
+\end_layout
+
+\end_inset
+
+ is either
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Top_Environment
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Centered_Top_Environment
+\end_layout
+
+\end_inset
+
+, in which case it defaults to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabelAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Attributes for the label tag.
+ Defaults to
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`layoutname_label'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This should
+\emph on
+not
+\emph default
+ contain any style information.
+ Use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ for that purpose.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabelFirst
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\emph default
+,1
+\end_layout
+
+\end_inset
+
+] Meaningful only for list-like environments, this tag controls whether
+ the label tag is output before or inside the item tag.
+ This is used, for example, in the description environment, where we want
+ `
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<dt>\SpecialChar ldots
+</dt><dd>\SpecialChar ldots
+</dd>
+\end_layout
+
+\end_inset
+
+.
+ Default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+: The label tag is output inside the item tag.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLPreamble
+\end_layout
+
+\end_inset
+
+ Information to be output in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<head>
+\end_layout
+
+\end_inset
+
+ section when this style is used.
+ This might, for example, be used to include a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<script>
+\end_layout
+
+\end_inset
+
+ block defining an
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+onclick
+\end_layout
+
+\end_inset
+
+ handler.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ CSS style information to be included when this style is used.
+ Note that this will automatically be wrapped in a layout-generated
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+ block, so only the CSS itself need be included.
+ Must end with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndHTMLStyle
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLTag
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The tag to be used for the main label, replacing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ Defaults to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLTitle
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\emph default
+,1
+\end_layout
+
+\end_inset
+
+] Marks this style as the one to be used to generate the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<title>
+\end_layout
+
+\end_inset
+
+ tag for the XHTML file.
+ By default, it is false.
+ The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdtitle.inc
+\end_layout
+
+\end_inset
+
+ file sets it to true for the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+title
+\end_layout
+
+\end_inset
+
+ environment.
+
+\end_layout
+
+\begin_layout Subsection
+InsetLayout XHTML
+\end_layout
+
+\begin_layout Standard
+The XHTML output of insets can also be controlled by information in layout
+ files.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+At present, this is true only for
+\begin_inset Quotes eld
+\end_inset
+
+text
+\begin_inset Quotes erd
+\end_inset
+
+ insets (insets you can type into) and is not true for
+\begin_inset Quotes eld
+\end_inset
+
+command
+\begin_inset Quotes erd
+\end_inset
+
+ insets (insets that are associated with dialog boxes).
+\end_layout
+
+\end_inset
+
+ Here, too, \SpecialChar LyX
+ tries to provide sensible defaults, and it constructs default
+ CSS style rules.
+ But everything can be customized.
+\end_layout
+
+\begin_layout Standard
+The XHTML \SpecialChar LyX
+ outputs for an inset has the following form:
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+<labeltag>Label</labeltag>
+\end_layout
+
+\begin_layout LyX-Code
+<innertag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Contents of the inset.</innertag>
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+If the inset permits multiple paragraphs—that is, if
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+ is true—then the contents of the inset will itself be output as paragraphs
+ formatted according to the styles used for those paragraphs (standard,
+ quote, and the like).
+ The label tag is of course omitted if the paragraph does not have a label
+ and, at present, is always
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+span
+\end_layout
+
+\end_inset
+
+.
+ The inner tag is optional and, by default, does not appear.
+\end_layout
+
+\begin_layout Standard
+The specific tags and attributes output for each inset can be controlled
+ by means of the following layout tags.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Specifies attribute information to be output with the main tag.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`myinset' onclick=`\SpecialChar ldots
+'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default, \SpecialChar LyX
+ will output
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`insetname'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+insetname
+\end_layout
+
+\end_inset
+
+ is the \SpecialChar LyX
+ name of the inset, made lowercase and with non-alphanumeric characters
+ converted to underscores, for example: footnote.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLForceCSS
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\emph default
+,1
+\end_layout
+
+\end_inset
+
+] Whether to output the default CSS information \SpecialChar LyX
+ generates for this layout,
+ even if additional information is explicitly provided via
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+.
+ Setting this to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+ allows you to alter or augment the generated CSS, rather than to override
+ it completely.
+ Default is 0.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLInnerAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Attributes for the inner tag.
+ Defaults to
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`insetname_inner'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLInnerTag
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The inner tag, replacing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+innertag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ By default, there is none.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLIsBlock
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0,
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Whether this inset represents a standalone block of text (such as a footnote)
+ or instead represents material that is included in the surrounding text
+ (such as a branch).
+ Defaults to 1.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabel
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] A label for this inset, possibly including a reference to a counter.
+ For example, for footnote, it might be:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+arabic{footnote}
+\end_layout
+
+\end_inset
+
+.
+ This is optional, and there is no default.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLPreamble
+\end_layout
+
+\end_inset
+
+ Information to be output in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<head>
+\end_layout
+
+\end_inset
+
+ section when this style is used.
+ This might, for example, be used to include a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<script>
+\end_layout
+
+\end_inset
+
+ block defining an
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+onclick
+\end_layout
+
+\end_inset
+
+ handler.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ CSS style information to be included when this style is used.
+ Note that this will automatically be wrapped in a layout-generated
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+ block, so only the CSS itself need be included.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLTag
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The tag to be used for the main label, replacing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ The default depends upon the setting of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+: If
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+ is true, the default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
+
+\end_inset
+
+; if it is false, the default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+span
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsection
+Float XHTML
+\end_layout
+
+\begin_layout Standard
+The XHTML output for floats too can be controlled by layout information.
+ The output has the following form:
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+Contents of the float.
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+The caption, if there is one, is a separate inset and will be output as
+ such.
+ Its appearance can be controlled via the InsetLayout for caption insets.
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Specifies attribute information to be output with the main tag.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`myfloat' onclick=`\SpecialChar ldots
+'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default, \SpecialChar LyX
+ will output
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`float float-floattype'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+floattype
+\end_layout
+
+\end_inset
+
+ is \SpecialChar LyX
+'s name for this type of float, as determined by the float declaration
+ (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Floats"
+
+\end_inset
+
+), though made lowercase and with non-alphanumeric characters converted
+ to underscores, for example: float-table.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ CSS style information to be included when this float is used.
+ Note that this will automatically be wrapped in a layout-generated
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+ block, so only the CSS itself need be included.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLTag
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The tag to be used for this float, replacing
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tag
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ The default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
+
+\end_inset
+
+ and will rarely need changing.
+\end_layout
+
+\begin_layout Subsection
+Bibliography formatting
+\end_layout
+
+\begin_layout Standard
+The bibliography can be formatted using
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\end_layout
+
+\end_inset
+
+ blocks.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Citation-format-description"
+
+\end_inset
+
+ for the details.
+\end_layout
+
+\begin_layout Subsection
+\SpecialChar LyX
+-generated CSS
+\end_layout
+
+\begin_layout Standard
+We have several times mentioned that \SpecialChar LyX
+ will generate default CSS style rules
+ for both insets and paragraph styles, based upon the other layout information
+ that is provided.
+ In this section, we shall say a word about which layout information \SpecialChar LyX
+ uses
+ and how.
+\end_layout
+
+\begin_layout Standard
+At present, \SpecialChar LyX
+ auto-generates CSS only for font information, making use of
+ the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+Family
\end_layout
\end_inset
- for that purpose.
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Series
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Shape
+\end_layout
+
+\end_inset
+
+, and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Size
+\end_layout
+
+\end_inset
+
+ specified in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\end_layout
+
+\end_inset
+
+ declaration (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
+\end_inset
+
+).
+ The translation is mostly straightforward and obvious.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Family Sans
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ becomes
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+font-family: sans-serif;
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The correspondence of \SpecialChar LyX
+ sizes and CSS sizes is a little less obvious but
+ nonetheless intuitive.
+ See the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+getSizeCSS()
+\end_layout
+
+\end_inset
+
+ function in
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+src/FontInfo.cpp
+\end_layout
+
+\end_inset
+
+ for the details.
+\change_inserted -970929547 1496610908
+
+\end_layout
+
+\begin_layout Section
+
+\change_inserted -970929547 1496610966
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Tags-for-DocBook"
+
+\end_inset
+
+Tags for DocBook output
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -970929547 1496611615
+As with \SpecialChar LaTeX
+ or XHTML, the format of \SpecialChar LyX
+'s DocBook output is also controlled by
+ layout information.
+ In general, \SpecialChar LyX
+ provides sensible defaults; however, much of the styling is
+ lost during the conversion, as DocBook is strictly semantic and does not
+ allow formatting.
+ When possible, information from \SpecialChar LyX
+ will be rendered in
+\family typewriter
+role
+\family default
+ attributes.
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -970929547 1496612080
+In many cases, then, you may not have to do anything at all to get acceptable
+ DocBook output for your own environments, custom insets, and so forth.
+ But in some cases you will, and so \SpecialChar LyX
+ provides a number of layout tags that
+ can be used to customize the DocBook that is generated.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -970929547 1515109912
+Labels are rarely output, as they are redundant in DocBook: this information
+ is carried by the tags themselves, and whether labels appear in the final
+ documents (after processing of DocBook files) is controlled by the stylesheets.
+ However, sometimes, labels are not redundant content, such as definition
+ lists: in this case, the term being defined will be the label.
+
+\end_layout
+
+\begin_layout Subsection
+
+\change_inserted -970929547 1496610966
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Paragraph-Style-XHTML-1"
+
+\end_inset
+
+Paragraph styles
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -970929547 1496612059
+The sort of DocBook \SpecialChar LyX
+ outputs for a paragraph depends upon whether we are
+ dealing with a normal paragraph, a command, or an environment, where this
+ is itself determined by the contents of the corresponding
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -970929547 1496610966
+\SpecialChar LaTeX
+Type
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ tag.
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -970929547 1496612107
+For a command or normal paragraph, the output DocBook has the following
+ form:
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515109666
+<tag attr>
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1496610966
+Contents of the paragraph.
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1496610966
+</tag>
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -970929547 1515109821
+For an environment that is not some sort of list, the generated DocBook
+ takes this form:
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515109671
+<tag attr>
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1496612114
+<itemtag>First paragraph.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1496610966
+<itemtag>Second paragraph.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1496610966
+</tag>
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -970929547 1515109825
+For a list, the resulting DocBook takes this form:
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515109672
+<tag attr>
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515109676
+<itemtag attr>First item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515109678
+<itemtag attr>Second item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1496610966
+</tag>
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -970929547 1496612243
+The specific tags and roles output for each paragraph type can be controlled
+ by means of the layout tags we are about to describe.
+ Please note that, due to the very nature of DocBook, no sensible defaults
+ really exist, and the values must always be carefully chosen.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515110057
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLForceCSS
+
+\change_inserted -970929547 1515109656
+DocBookAttr
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
-\emph on
-0
-\emph default
-,1
+\change_inserted -970929547 1496610966
+string
+\change_unchanged
+
\end_layout
\end_inset
-] Whether to output the default CSS information \SpecialChar LyX
- generates for this layout,
- even if additional information is explicitly provided via
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-HTMLStyle
-\end_layout
-
+] Specifies attribute information to be output with the main tag, replacing
+
+\begin_inset Quotes eld
\end_inset
-.
- Setting this to
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+
+\change_inserted -970929547 1515110057
+attr
+\change_unchanged
+
\end_layout
\end_inset
- allows you to alter or augment the generated CSS, rather than to override
- it completely.
- Default is
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-0
-\end_layout
+\begin_inset Quotes erd
\end_inset
-.
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1496612296
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLItem
+
+\change_inserted -970929547 1496612269
+DocBookTag
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1496610966
string
+\change_unchanged
+
\end_layout
\end_inset
-] The tag to be used for individual paragraphs of environments, replacing
-
+] The tag to be used for this inset, replacing
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-itemtag
+
+\change_inserted -970929547 1496612296
+tag
+\change_unchanged
+
\end_layout
\end_inset
- in the examples above.
- Defaults to
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-div
+\begin_inset Quotes erd
+\end_inset
+
+ 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_unchanged
+
\end_layout
-\end_inset
+\begin_layout Subsection
+
+\change_inserted -970929547 1515111533
+InsetLayout DocBook
+\change_unchanged
-.
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout Standard
-\begin_layout Plain Layout
-HTMLItemAttr
+\change_inserted -970929547 1496611894
+The DocBook output of insets can also be controlled by information in layout
+ files.
\end_layout
-\end_inset
+\begin_layout Standard
- [
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1496612045
+The DocBook \SpecialChar LyX
+ outputs for an inset has the following form:
+\end_layout
-\begin_layout Plain Layout
-string
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515110861
+<wrappertag wrapperattr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
-] Attributes for the item tag.
- Defaults to
-\begin_inset Newline newline
-\end_inset
+\change_inserted -970929547 1515110868
+ <tag attr>
+\end_layout
+\begin_layout LyX-Code
-\begin_inset Quotes eld
-\end_inset
+\change_inserted -970929547 1515110869
+ <innertag innerattr>
+\end_layout
+\begin_layout LyX-Code
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515110869
+ Contents of the inset.
+\end_layout
-\begin_layout Plain Layout
-class=`layoutname_item'
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515110870
+ </innertag>
\end_layout
-\end_inset
+\begin_layout LyX-Code
+\change_inserted -970929547 1515110871
+ </tag>
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
-.
- This should
-\emph on
-not
-\emph default
- contain any style information.
- Use
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111172
+</wrappertag>
+\end_layout
-\begin_layout Plain Layout
-HTMLStyle
+\begin_layout Standard
+
+\change_inserted -970929547 1515111186
+For an itemising inset, it rather looks like this:
\end_layout
-\end_inset
+\begin_layout LyX-Code
- for that purpose.
+\change_inserted -970929547 1515111186
+<wrappertag wrapperattr>
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-HTMLLabel
+\change_inserted -970929547 1515111186
+ <tag attr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
- [
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111186
+ <innertag innerattr>
+\end_layout
-\begin_layout Plain Layout
-string
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111362
+ <itemwrappertag itemwrapperattr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
-] The tag to be used for paragraph and item labels, replacing
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111364
+ <itemlabeltag itemattr>
+\end_layout
-\begin_layout Plain Layout
-labeltag
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111367
+ Label of the first item.
\end_layout
-\end_inset
+\begin_layout LyX-Code
- in the examples above.
- Defaults to
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111362
+ </itemtag>
+\change_unchanged
-\begin_layout Plain Layout
-span
\end_layout
-\end_inset
+\begin_layout LyX-Code
-, unless
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111517
+ <itemtag itemattr>
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111517
+ <itemtag itemattr>
+\change_unchanged
-\begin_layout Plain Layout
-LabelType
\end_layout
-\end_inset
+\begin_layout LyX-Code
- is either
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111516
+ Contents of the first item.
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111514
+ </itemtag>
+\change_unchanged
-\begin_layout Plain Layout
-Top_Environment
\end_layout
-\end_inset
+\begin_layout LyX-Code
- or
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111247
+ </itemtag>
+\change_unchanged
-\begin_layout Plain Layout
-Centered_Top_Environment
\end_layout
-\end_inset
+\begin_layout LyX-Code
-, in which case it defaults to
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111221
+ </itemwrappertag>
+\end_layout
-\begin_layout Plain Layout
-div
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111370
+ <itemwrappertag itemwrapperattr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
-.
+\change_inserted -970929547 1515111370
+ <itemlabeltag itemattr>
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-HTMLLabelAttr
+\change_inserted -970929547 1515111372
+ Label of the second item.
\end_layout
-\end_inset
+\begin_layout LyX-Code
- [
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111370
+ </itemtag>
+\change_unchanged
-\begin_layout Plain Layout
-string
\end_layout
-\end_inset
+\begin_layout LyX-Code
-] Attributes for the label tag.
- Defaults to
-\begin_inset Newline newline
-\end_inset
+\change_inserted -970929547 1515111504
+ <itemtag itemattr>
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111505
+ <itemtag itemattr>
+\change_unchanged
+
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111507
+ Contents of the second item.
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111509
+ </itemtag>
+\change_unchanged
+
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111251
+ </itemtag>
+\change_unchanged
+
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111221
+ </itemwrappertag>
+\change_unchanged
+
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111219
+ ...
+\change_unchanged
+\end_layout
-\begin_inset Quotes eld
-\end_inset
+\begin_layout LyX-Code
+\change_inserted -970929547 1515111186
+ </innertag>
+\end_layout
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-class=`layoutname_label'
+\change_inserted -970929547 1515111186
+ </tag>
\end_layout
-\end_inset
+\begin_layout LyX-Code
+\change_inserted -970929547 1515111186
+</wrappertag>
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
-.
- This should
-\emph on
-not
-\emph default
- contain any style information.
- Use
+\change_inserted -970929547 1515111183
+If the inset permits multiple paragraphs—that is, if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+
+\change_inserted -970929547 1496610966
+MultiPar
+\change_unchanged
+
\end_layout
\end_inset
- for that purpose.
+ is true—then the contents of the inset will itself be output as paragraphs
+ formatted according to the styles used for those paragraphs (standard,
+ quote, and the like).
+ The inner tag is optional and, by default, does not appear.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -970929547 1496610966
+The specific tags and attributes output for each inset can be controlled
+ by means of the following layout tags.
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515110317
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLLabelFirst
+
+\change_inserted -970929547 1515109695
+DocBookAttr
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
-\emph on
-0
-\emph default
-,1
+\change_inserted -970929547 1496611854
+string
+\change_unchanged
+
\end_layout
\end_inset
-] Meaningful only for list-like environments, this tag controls whether
- the label tag is output before or inside the item tag.
- This is used, for example, in the description environment, where we want
- `
+] Specifies attribute information to be output with the main tag, replacing
+
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<dt>\SpecialChar ldots
-</dt><dd>\SpecialChar ldots
-</dd>
+
+\change_inserted -970929547 1515110044
+attr
+\change_unchanged
+
\end_layout
\end_inset
-.
- Default is
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-0
-\end_layout
+\begin_inset Quotes erd
\end_inset
-: The label tag is output inside the item tag.
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515110973
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+
+\change_inserted -970929547 1515110319
+DocBookInInfo
+\change_unchanged
+
\end_layout
\end_inset
- Information to be output in the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<head>
+
+\change_inserted -970929547 1515110384
+never, always, maybe
+\change_unchanged
+
\end_layout
\end_inset
- section when this style is used.
- This might, for example, be used to include a
+] Specifies whether this tag goes into the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<script>
+
+\change_inserted -970929547 1515110412
+<info>
+\change_unchanged
+
\end_layout
\end_inset
- block defining an
+ tag at the beginning of the parent layout.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-onclick
-\end_layout
-\end_inset
+\change_inserted -970929547 1515110437
+never
+\change_unchanged
- handler.
\end_layout
-\begin_layout Description
+\end_inset
+
+ indicates that the tag never goes into
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+
+\change_inserted -970929547 1515110497
+<info>
+\change_unchanged
+
\end_layout
\end_inset
- CSS style information to be included when this style is used.
- Note that this will automatically be wrapped in a layout-generated
+ (this is default value, and corresponds to usual content).
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<style>
+
+\change_inserted -970929547 1515110517
+always
+\change_unchanged
+
\end_layout
\end_inset
- block, so only the CSS itself need be included.
- Must end with
+ indicates that the tag always goes into
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndHTMLStyle
-\end_layout
-\end_inset
+\change_inserted -970929547 1515110514
+<info>
+\change_unchanged
-.
\end_layout
-\begin_layout Description
+\end_inset
+
+ (this corresponds to usual metadata): if there is no
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLTag
+
+\change_inserted -970929547 1515110550
+<info>
+\change_unchanged
+
\end_layout
\end_inset
- [
+ tag for the parent, one
+\series bold
+will
+\series default
+ be generated.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\change_inserted -970929547 1515110540
+maybe
+\change_unchanged
+
\end_layout
\end_inset
-] The tag to be used for the main label, replacing
+ indicates that the tag may go into
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tag
+
+\change_inserted -970929547 1515110538
+<info>
+\change_unchanged
+
\end_layout
\end_inset
- in the examples above.
- Defaults to
+ (this is only the case for titles): if there is no
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+
+\change_inserted -970929547 1515110585
+<info>
+\change_unchanged
+
\end_layout
\end_inset
-.
+ tag for the parent,
+\series bold
+none
+\series default
+ will be generated, the corresponding tag will be output directly as content.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111461
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLTitle
+
+\change_inserted -970929547 1515110974
+DocBookItemAttr
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
-\emph on
-0
-\emph default
-,1
+\change_inserted -970929547 1515110973
+string
+\change_unchanged
+
\end_layout
\end_inset
-] Marks this style as the one to be used to generate the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<title>
-\end_layout
-
+] Specifies attribute information to be output with the item tag, replacing
+
+\begin_inset Quotes eld
\end_inset
- tag for the XHTML file.
- By default, it is false.
- The
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdtitle.inc
+
+\change_inserted -970929547 1515110984
+itemattr
+\change_unchanged
+
\end_layout
\end_inset
- file sets it to true for the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-title
-\end_layout
+\begin_inset Quotes erd
\end_inset
- environment.
+ in the example above.
+ This information can be used in further processing of the DocBook files.
\end_layout
-\begin_layout Subsection
-InsetLayout XHTML
-\end_layout
+\begin_layout Description
-\begin_layout Standard
-The XHTML output of insets can also be controlled by information in layout
- files.
-\begin_inset Foot
+\change_inserted -970929547 1515111471
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-At present, this is true only for
-\begin_inset Quotes eld
-\end_inset
-text
-\begin_inset Quotes erd
-\end_inset
-
- insets (insets you can type into) and is not true for
-\begin_inset Quotes eld
-\end_inset
-
-command
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -970929547 1515111465
+DocBookItemInnerAttr
+\change_unchanged
- insets (insets that are associated with dialog boxes).
\end_layout
\end_inset
- Here, too, \SpecialChar LyX
- tries to provide sensible defaults, and it constructs default
- CSS style rules.
- But everything can be customized.
-\end_layout
-
-\begin_layout Standard
-The XHTML \SpecialChar LyX
- outputs for an inset has the following form:
-\end_layout
-
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
-\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
->
-\end_layout
+\change_inserted -970929547 1515111461
+string
+\change_unchanged
-\begin_layout LyX-Code
-<labeltag>Label</labeltag>
\end_layout
-\begin_layout LyX-Code
-<innertag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
+] Specifies attribute information to be output with the item inner tag,
+ replacing
+\begin_inset Quotes eld
\end_inset
->Contents of the inset.</innertag>
-\end_layout
-
-\begin_layout LyX-Code
-</tag>
-\end_layout
-\begin_layout Standard
-If the inset permits multiple paragraphs—that is, if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
-\end_layout
-
-\end_inset
- is true—then the contents of the inset will itself be output as paragraphs
- formatted according to the styles used for those paragraphs (standard,
- quote, and the like).
- The label tag is of course omitted if the paragraph does not have a label
- and, at present, is always
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111476
+iteminnerattr
+\change_unchanged
-\begin_layout Plain Layout
-span
\end_layout
\end_inset
-.
- The inner tag is optional and, by default, does not appear.
-\end_layout
-\begin_layout Standard
-The specific tags and attributes output for each inset can be controlled
- by means of the following layout tags.
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111494
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLAttr
+
+\change_inserted -970929547 1515111467
+DocBookItemInnerTag
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1515111461
string
+\change_unchanged
+
\end_layout
\end_inset
-] Specifies attribute information to be output with the main tag.
- For example,
+] The tag to be used for the item inner tag within the inset, replacing
+
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-class=`myinset' onclick=`\SpecialChar ldots
-'
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- By default, \SpecialChar LyX
- will output
-\begin_inset Quotes eld
-\end_inset
-
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111486
+iteminnertag
+\change_unchanged
-\begin_layout Plain Layout
-class=`insetname'
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-, where
+ in the example above.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-insetname
+
+\change_inserted -970929547 1515111461
+NONE
+\change_unchanged
+
\end_layout
\end_inset
- is the \SpecialChar LyX
- name of the inset, made lowercase and with non-alphanumeric characters
- converted to underscores, for example: footnote.
+, indicating that there is no item inner tag: content is directly output
+ without it for each itemised element.
+ This parameter only makes sense when itemising layouts are used, such as
+ lists.
+
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111290
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLForceCSS
+
+\change_inserted -970929547 1515111283
+DocBookItemLabelAttr
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
-\emph on
-0
-\emph default
-,1
+\change_inserted -970929547 1515111279
+string
+\change_unchanged
+
\end_layout
\end_inset
-] Whether to output the default CSS information \SpecialChar LyX
- generates for this layout,
- even if additional information is explicitly provided via
+] Specifies attribute information to be output with the item label tag,
+ replacing
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+
+\change_inserted -970929547 1515111304
+itemlabelattr
+\change_unchanged
+
\end_layout
\end_inset
-.
- Setting this to
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-1
-\end_layout
+\begin_inset Quotes erd
\end_inset
- allows you to alter or augment the generated CSS, rather than to override
- it completely.
- Default is 0.
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111337
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLInnerAttr
+
+\change_inserted -970929547 1515111285
+DocBookItemLabelTag
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1515111279
string
-\end_layout
+\change_unchanged
-\end_inset
+\end_layout
-] Attributes for the inner tag.
- Defaults to
-\begin_inset Newline newline
\end_inset
-
+] The tag to be used for the item label tag within the inset, replacing
+
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-class=`insetname_inner'
+
+\change_inserted -970929547 1515111311
+itemlabeltag
+\change_unchanged
+
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-.
+ in the example above.
+ This parameter only makes sense when itemising layouts are used with a
+ notion of labels, such as definition lists.
+
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111124
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLInnerTag
+
+\change_inserted -970929547 1515111060
+DocBookItemTag
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1515111060
string
+\change_unchanged
+
\end_layout
\end_inset
-] The inner tag, replacing
+] The tag to be used for the item tag within the inset, replacing
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-innertag
-\end_layout
-\end_inset
+\change_inserted -970929547 1515111060
+itemtag
+\change_unchanged
- in the examples above.
- By default, there is none.
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-HTMLIsBlock
-\end_layout
+\begin_inset Quotes erd
\end_inset
- [
+ in the example above.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0,
-\emph on
-1
+
+\change_inserted -970929547 1515111060
+NONE
+\change_unchanged
+
\end_layout
\end_inset
-] Whether this inset represents a standalone block of text (such as a footnote)
- or instead represents material that is included in the surrounding text
- (such as a branch).
- Defaults to 1.
+, indicating that there is no item tag.
+ This parameter only makes sense when itemising layouts are used, such as
+ lists.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111298
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLLabel
+
+\change_inserted -970929547 1515111124
+DocBookItemWrapperAttr
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1515111124
string
+\change_unchanged
+
\end_layout
\end_inset
-] A label for this inset, possibly including a reference to a counter.
- For example, for footnote, it might be:
+] Specifies attribute information to be output with the item wrapper tag,
+ replacing
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-arabic{footnote}
+\change_inserted -970929547 1515111150
+itemwrapperattr
+\change_unchanged
+
\end_layout
\end_inset
-.
- This is optional, and there is no default.
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111113
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+
+\change_inserted -970929547 1515111073
+DocBookItemWrapperTag
+\change_unchanged
+
\end_layout
\end_inset
- Information to be output in the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<head>
+
+\change_inserted -970929547 1515111073
+string
+\change_unchanged
+
\end_layout
\end_inset
- section when this style is used.
- This might, for example, be used to include a
+] The tag to be used for the item wrapper tag within the inset, replacing
+
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<script>
+
+\change_inserted -970929547 1515111083
+itemwrappertag
+\change_unchanged
+
\end_layout
\end_inset
- block defining an
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-onclick
+
+\change_inserted -970929547 1515111073
+NONE
+\change_unchanged
+
\end_layout
\end_inset
- handler.
+, indicating that there is no item wrapper tag: tag and content are directly
+ output without it for each itemised element.
+ This parameter only makes sense when itemising layouts are used, such as
+ lists.
+
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515110104
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+
+\change_inserted -970929547 1515110104
+DocBookInnerAttr
+\change_unchanged
+
\end_layout
\end_inset
- CSS style information to be included when this style is used.
- Note that this will automatically be wrapped in a layout-generated
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<style>
+
+\change_inserted -970929547 1515110104
+string
+\change_unchanged
+
\end_layout
\end_inset
- block, so only the CSS itself need be included.
-\end_layout
+] Specifies attribute information to be output with the inner tag, replacing
+
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLTag
+
+\change_inserted -970929547 1515110104
+innerattr
+\change_unchanged
+
\end_layout
\end_inset
- [
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -970929547 1515110906
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\change_inserted -970929547 1515110104
+DocBookInnerTag
+\change_unchanged
+
\end_layout
\end_inset
-] The tag to be used for the main label, replacing
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tag
+
+\change_inserted -970929547 1515110104
+string
+\change_unchanged
+
\end_layout
\end_inset
- in the examples above.
- The default depends upon the setting of
+] The tag to be used for the inner tag within the inset, replacing
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+
+\change_inserted -970929547 1515110104
+innertag
+\change_unchanged
+
\end_layout
\end_inset
-: If
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+
+\change_inserted -970929547 1515110791
+NONE
+\change_unchanged
+
\end_layout
\end_inset
- is true, the default is
+, indicating that there is no inner tag: content is directly output without
+ it.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -970929547 1515110753
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+
+\change_inserted -970929547 1515110665
+DocBookSectionTag
+\change_unchanged
+
\end_layout
\end_inset
-; if it is false, the default is
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-span
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-\begin_layout Subsection
-Float XHTML
-\end_layout
+\change_inserted -970929547 1515110661
+string
+\change_unchanged
-\begin_layout Standard
-The XHTML output for floats too can be controlled by layout information.
- The output has the following form:
\end_layout
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
+] Specifies the tag that corresponds to this kind of section.
+ This parameter only makes sense for sectioning elements (part, chapter,
+ section, etc.).
+ The default value is
+\begin_inset Flex Code
+status collapsed
->
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-Contents of the float.
-\end_layout
+\change_inserted -970929547 1515110721
+section
+\change_unchanged
-\begin_layout LyX-Code
-</tag>
\end_layout
-\begin_layout Standard
-The caption, if there is one, is a separate inset and will be output as
- such.
- Its appearance can be controlled via the InsetLayout for caption insets.
+\end_inset
+
+, and is only overridden when DocBook uses something else for sectioning
+ (parts and chapters of a book).
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515110811
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLAttr
+
+\change_inserted -970929547 1496612023
+DocBookTag
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1496610966
string
+\change_unchanged
+
\end_layout
\end_inset
-] Specifies attribute information to be output with the main tag.
- For example,
+] The tag to be used for this inset, replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-class=`myfloat' onclick=`\SpecialChar ldots
-'
+
+\change_inserted -970929547 1496612033
+tag
+\change_unchanged
+
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-.
- By default, \SpecialChar LyX
- will output
-\begin_inset Quotes eld
-\end_inset
+ 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.
+\end_layout
+\begin_layout Description
+\change_inserted -970929547 1515110832
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`float float-floattype'
-\end_layout
-\end_inset
+\change_inserted -970929547 1515110822
+DocBookWrapperAttr
+\change_unchanged
+\end_layout
-\begin_inset Quotes erd
\end_inset
-, where
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-floattype
+
+\change_inserted -970929547 1515110811
+string
+\change_unchanged
+
\end_layout
\end_inset
- is \SpecialChar LyX
-'s name for this type of float, as determined by the float declaration
- (see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Floats"
-
+] Specifies attribute information to be output with the outer tag, replacing
+
+\begin_inset Quotes eld
\end_inset
-), though made lowercase and with non-alphanumeric characters converted
- to underscores, for example: float-table.
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+
+\change_inserted -970929547 1515110845
+wrapperattr
+\change_unchanged
+
\end_layout
\end_inset
- CSS style information to be included when this float is used.
- Note that this will automatically be wrapped in a layout-generated
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<style>
-\end_layout
+\begin_inset Quotes erd
\end_inset
- block, so only the CSS itself need be included.
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515110917
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLTag
+
+\change_inserted -970929547 1515110826
+DocBookWrapperTag
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1515110811
string
+\change_unchanged
+
\end_layout
\end_inset
-] The tag to be used for this float, replacing
+] The tag to be used for the wrapper tag around the inset, replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-tag
+
+\change_inserted -970929547 1515110842
+wrappertag
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-div
+
+\change_inserted -970929547 1515110811
+NONE
+\change_unchanged
+
\end_layout
\end_inset
- and will rarely need changing.
+, indicating that there is no wrapper tag: tag and content are directly
+ output without it.
+\change_deleted -970929547 1515111523
+
\end_layout
\begin_layout Subsection
-Bibliography formatting
+
+\change_inserted -970929547 1515110040
+Float DocBook
\end_layout
\begin_layout Standard
-The bibliography can be formatted using
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-CiteFormat
+\change_inserted -970929547 1496611700
+The DocBook output for floats too can be controlled by layout information.
+ The output has the following form:
\end_layout
-\end_inset
+\begin_layout LyX-Code
- blocks.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Citation-format-description"
+\change_inserted -970929547 1515109700
+<tag attr>
+\end_layout
-\end_inset
+\begin_layout LyX-Code
- for the details.
+\change_inserted -970929547 1515110138
+ Contents of the float as DocBook.
\end_layout
-\begin_layout Subsection
-\SpecialChar LyX
--generated CSS
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1496610966
+</tag>
\end_layout
\begin_layout Standard
-We have several times mentioned that \SpecialChar LyX
- will generate default CSS style rules
- for both insets and paragraph styles, based upon the other layout information
- that is provided.
- In this section, we shall say a word about which layout information \SpecialChar LyX
- uses
- and how.
+
+\change_inserted -970929547 1496611715
+The caption, if there is one, is a separate inset and will be output as
+ a title.
+
\end_layout
-\begin_layout Standard
-At present, \SpecialChar LyX
- auto-generates CSS only for font information, making use of
- the
+\begin_layout Description
+
+\change_inserted -970929547 1515110033
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Family
+
+\change_inserted -970929547 1515109702
+DocBookAttr
+\change_unchanged
+
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Series
+
+\change_inserted -970929547 1496610966
+string
+\change_unchanged
+
\end_layout
\end_inset
-,
+] Specifies attribute information to be output with the main tag, replacing
+
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Shape
+
+\change_inserted -970929547 1515110035
+attr
+\change_unchanged
+
\end_layout
\end_inset
-, and
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-Size
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
\end_layout
-\end_inset
+\begin_layout Description
- specified in the
+\change_inserted -970929547 1515110157
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
-\end_layout
-
-\end_inset
- declaration (see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
+\change_inserted -970929547 1496611782
+DocBookTag
+\change_unchanged
-\end_inset
+\end_layout
-).
- The translation is mostly straightforward and obvious.
- For example,
-\begin_inset Quotes eld
\end_inset
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Family Sans
-\end_layout
-\end_inset
+\change_inserted -970929547 1496610966
+string
+\change_unchanged
+\end_layout
-\begin_inset Quotes erd
\end_inset
- becomes
+] The tag to be used for this float, replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-font-family: sans-serif;
+
+\change_inserted -970929547 1496610966
+tag
+\change_unchanged
+
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-.
- The correspondence of \SpecialChar LyX
- sizes and CSS sizes is a little less obvious but
- nonetheless intuitive.
- See the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-getSizeCSS()
+ in the example above.
+ The default is the name of the float and always needs to be changed, as
+ DocBook provides no generic float tag.
\end_layout
-\end_inset
-
- function in
-\begin_inset Flex URL
-status collapsed
-
-\begin_layout Plain Layout
+\begin_layout Subsection
-src/FontInfo.cpp
+\change_inserted -970929547 1515110157
+Bibliography formatting
\end_layout
-\end_inset
+\begin_layout Standard
+
+\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).
+\change_unchanged
- for the details.
\end_layout
\begin_layout Chapter
\end_layout
\begin_layout Standard
-These are fixed colors that cannot me customized:
+These are fixed colors that cannot be customized:
\end_layout
\begin_layout Description
projects / lyx.git / blobdiff