-#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
+\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
\change_inserted -712698321 1524657030
flavor
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1524657047
.aux
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1524657030
latex, pdflatex, platex, xetex, luatex
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1524657030
latex
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1523206193
hyperref-driver
+\change_unchanged
+
\end_layout
\end_inset
\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
+
+\change_inserted -712698321 1562592954
+BibInToc
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1562592950
+
+\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 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
+
+\end_inset
+
+ (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
\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
\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
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515112870
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ExcludesModule
+
+\change_inserted -970929547 1515112782
+DocBookRoot
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<module>
-\end_layout
-
-\end_inset
-] This tag indicates that the module (which is specified by filename without
- the
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515112766
+string
+\change_unchanged
-\begin_layout Plain Layout
-.module
\end_layout
\end_inset
- extension) cannot be used with this document class.
- This might be used in a journal-specific layout file to prevent, say, the
- use of the
+] 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
-theorems-sec
+
+\change_inserted -970929547 1515112845
+article
+\change_unchanged
+
\end_layout
\end_inset
- module that numbers theorems by section.
- This tag may
-\emph on
-not
-\emph default
- be used in a module.
- Modules have their own way of excluding other modules (see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Layout-modules"
+\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
-Float
+
+\change_inserted 1075283030 1594226785
+DocBookForceAbstract
+\change_unchanged
+
\end_layout
\end_inset
- Defines a new float.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Floats"
+ [
+\begin_inset Flex Code
+status collapsed
-\end_inset
+\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
+
+\begin_layout Plain Layout
+ExcludesModule
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<module>
+\end_layout
+
+\end_inset
+
+] This tag indicates that the module (which is specified by filename without
+ the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.module
+\end_layout
+
+\end_inset
+
+ extension) cannot be used with this document class.
+ This might be used in a journal-specific layout file to prevent, say, the
+ use of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+theorems-sec
+\end_layout
+
+\end_inset
+
+ module that numbers theorems by section.
+ This tag may
+\emph on
+not
+\emph default
+ be used in a module.
+ Modules have their own way of excluding other modules (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Layout-modules"
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Float
+\end_layout
+
+\end_inset
+
+ Defines a new float.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Floats"
+
+\end_inset
for details.
Must end with
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"
-\end_layout
-
-\end_inset
-] The name of the command or environment to be used with
-\begin_inset Flex Code
-status collapsed
+\change_inserted -712698321 1553617805
+<name>
+\change_unchanged
-\begin_layout Plain Layout
-TitleLatexType
\end_layout
\end_inset
-.
+] defines the default table style that is used when inserting a table.
+ The following styles are available:
\end_layout
-\begin_layout Description
+\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
- [
-\begin_inset Flex Code
-status collapsed
+: formal (
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+booktabs
+\begin_inset Quotes erd
+\end_inset
-\emph on
-CommandAfter
+) 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
-\end_inset
+\begin_layout Itemize
-,
+\change_inserted -712698321 1554308087
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+
+\change_inserted -712698321 1554308042
+Formal_without_Footline
+\change_unchanged
+
\end_layout
\end_inset
-] Indicates what kind of markup is used to define the title of a document.
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-CommandAfter
+: same as the above, but the last row is not separated with a middle line
+ from the body.
\end_layout
-\end_inset
+\begin_layout Itemize
- means that the macro with name
+\change_inserted -712698321 1553618031
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+
+\change_inserted -712698321 1553618006
+Simple_Grid
+\change_unchanged
+
\end_layout
\end_inset
- will be inserted after the last layout which has
-\begin_inset Quotes eld
-\end_inset
+: Simple table lines.
+\end_layout
+\begin_layout Itemize
+\change_inserted -712698321 1553618309
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InTitle
-\begin_inset space ~
-\end_inset
-1
-\end_layout
-
-\end_inset
+\change_inserted -712698321 1553618031
+Grid_with_Head
+\change_unchanged
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
-
+: Like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+
+\change_inserted -712698321 1553618043
+Simple_Grid
+\change_unchanged
+
\end_layout
\end_inset
- corresponds to the case where all layouts which have
-\begin_inset Quotes eld
-\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
-InTitle
-\begin_inset space ~
-\end_inset
-1
+\change_inserted -712698321 1553618261
+No_Borders
+\change_unchanged
+
\end_layout
\end_inset
+: Table without lines.
+\change_unchanged
-\begin_inset Quotes erd
-\end_inset
+\end_layout
- should be enclosed into the
+\end_deeper
+\begin_layout Description
\begin_inset Flex Code
status collapsed
TitleLatexName
\end_layout
-\end_inset
-
- environment.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-TocDepth
-\end_layout
-
\end_inset
[
status collapsed
\begin_layout Plain Layout
-int=3
+string="maketitle"
\end_layout
\end_inset
-] Sets which divisions are included in the table of contents.
- Corresponds to the
+] The name of the command or environment to be used with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tocdepth
+TitleLatexType
\end_layout
\end_inset
- counter in \SpecialChar LaTeX
.
\end_layout
-\begin_layout Subsection
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+TitleLatexType
\end_layout
\end_inset
- section
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:ClassOptions"
-
-\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+\emph on
+CommandAfter
\end_layout
-\begin_layout Standard
-The
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+Environment
\end_layout
\end_inset
- section can contain the following entries:
-\end_layout
-
-\begin_layout Description
+] Indicates what kind of markup is used to define the title of a document.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FontSize
+CommandAfter
\end_layout
\end_inset
- [
+ means that the macro with name
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string="10|11|12"
+TitleLatexName
\end_layout
\end_inset
-] The list of available font sizes for the document's main font, separated
- by
+ will be inserted after the last layout which has
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-|
+InTitle
+\begin_inset space ~
+\end_inset
+
+1
\end_layout
\end_inset
\end_inset
.
-\end_layout
-
-\begin_layout Description
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Header
+Environment
\end_layout
\end_inset
- Used to set the DTD line with XML-based output classes.
- E.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.: PUBLIC
+ corresponds to the case where all layouts which have
\begin_inset Quotes eld
\end_inset
--//OASIS//DTD DocBook V4.2//EN
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PageStyle
-\end_layout
-
+InTitle
+\begin_inset space ~
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-string="empty|plain|headings|fancy"
+1
\end_layout
\end_inset
-] The list of available page sty\SpecialChar softhyphen
-les, separated by
-\begin_inset Quotes eld
-\end_inset
+\begin_inset Quotes erd
+\end_inset
+ should be enclosed into the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-|
+TitleLatexName
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
+ environment.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Other
+TocDepth
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+int=3
\end_layout
\end_inset
-] Some document class options, separated by a comma, that will be added
- to the optional part of the
+] Sets which divisions are included in the table of contents.
+ Corresponds to the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-documentclass
+tocdepth
\end_layout
\end_inset
- command.
+ counter in \SpecialChar LaTeX
+.
\end_layout
-\begin_layout Standard
-The
+\begin_layout Subsection
\begin_inset Flex Code
status collapsed
\end_inset
- section 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
-
-.
-\end_layout
-
-\begin_layout Subsection
-Paragraph styles
+ section
\begin_inset CommandInset label
LatexCommand label
-name "subsec:Paragraph-Styles"
+name "subsec:ClassOptions"
\end_inset
\end_layout
\begin_layout Standard
-A paragraph style description looks like this:
-\begin_inset Foot
+The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that this will either define a new style or modify an existing one.
+ClassOptions
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout LyX-Code
-Style
-\family roman
-\emph on
-name
+ section can contain the following entries:
\end_layout
-\begin_layout LyX-Code
- ...
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-End
+\begin_layout Plain Layout
+FontSize
\end_layout
-\begin_layout Standard
-where the following commands are allowed:
-\end_layout
+\end_inset
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToToc
+string="10|11|12"
\end_layout
\end_inset
- [
+] The list of available font sizes for the document's main font, separated
+ by
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+|
\end_layout
\end_inset
-=""] This paragraph will appear in the table of contents of the given type.
- An empty string disables.
- See also the OutlinerName and the IsTocCaption commands.
- Default: disabled.
+
+\begin_inset Quotes erd
+\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
-Align
+
+\change_inserted -712698321 1565110199
+FontSizeFormat
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
-\emph on
-block
-\emph default
-, left, right, center
+\change_inserted -712698321 1565110196
+string
+\change_unchanged
+
\end_layout
\end_inset
-] Paragraph alignment.
-\end_layout
-
-\begin_layout Description
+] The format for the font size option.
+ Default:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AlignPossible
+
+\change_inserted -712698321 1565110238
+$$spt
+\change_unchanged
+
\end_layout
\end_inset
- [
+.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-block
-\emph default
-, left, right, center
+\change_inserted -712698321 1565110248
+$$s
+\change_unchanged
+
\end_layout
\end_inset
-] A comma separated list of permitted alignments.
- (Some \SpecialChar LaTeX
- styles prohibit certain alignments, since those wouldn't make sense.
- For example a right-aligned or centered enumeration isn't possible.)
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+ is a placeholder for the font size.
+\change_unchanged
-\begin_layout Plain Layout
-Argument
\end_layout
-\end_inset
+\begin_layout Description
- [
+\change_deleted 5863208 1594239483
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-int
+Header
\end_layout
\end_inset
-] Defines argument number <int> of a command\SpecialChar breakableslash
-environment associated with
- the current style.
- This is useful for things like section headings, and only makes sense with
- \SpecialChar LaTeX
+ Used to set the DTD line with XML-based output classes.
+ E.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.: PUBLIC
+\begin_inset Quotes eld
+\end_inset
+
+-//OASIS//DTD DocBook V4.2//EN
+\begin_inset Quotes erd
+\end_inset
+
.
- Every (optional or required) argument of a command or environment – except
- for the required argument that is associated with the content of the paragraph
- itself – has a separate definition, where the number specifies the order
- of the arguments.
- The definition must end with
+\change_inserted -712698321 1565101761
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1565180598
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndArgument
+
+\change_inserted -712698321 1565101918
+PageSize
+\change_unchanged
+
\end_layout
\end_inset
-.
- So a command with two optional arguments has:
-\end_layout
+ [
+\begin_inset Flex Code
+status collapsed
-\begin_deeper
-\begin_layout Quote
+\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
-\family typewriter
-Argument 1
\end_layout
-\begin_layout Quote
+\end_inset
-\family typewriter
-...
-\end_layout
+] The list of available page sizes, separated by
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Quote
-\family typewriter
-EndArgument
-\end_layout
+\begin_inset Flex Code
+status collapsed
-\begin_layout Quote
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565101779
+|
+\change_unchanged
-\family typewriter
-Argument 2
\end_layout
-\begin_layout Quote
+\end_inset
-\family typewriter
-...
-\end_layout
-\begin_layout Quote
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
-EndArgument
+.
+ Currently, only the listed sizes are supported.
+ Other sizes might be entered as custom class option.
\end_layout
-\begin_layout Standard
-Inside the
+\begin_layout Description
+
+\change_inserted -712698321 1565180623
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+
+\change_inserted -712698321 1565180605
+PageSizeFormat
+\change_unchanged
+
\end_layout
\end_inset
- definition, the following specifications are possible:
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565180601
+string
+\change_unchanged
+
\end_layout
-\begin_layout Itemize
+\end_inset
+
+] The format for the page size option.
+ Default:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+
+\change_inserted -712698321 1565180618
+$$spaper
+\change_unchanged
+
\end_layout
\end_inset
+.
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[string]
+
+\change_inserted -712698321 1565180601
+$$s
+\change_unchanged
+
\end_layout
\end_inset
- The string that will appear both in the menu (to insert this argument)
- and on the argument inset button (unless you also specify a separate
+ is a placeholder for the paper size.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MenuString
+PageStyle
\end_layout
\end_inset
-).
- 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
+string="empty|plain|headings|fancy"
+\end_layout
-g.
-\begin_inset space \space{}
\end_inset
-
+] The list of available page sty\SpecialChar softhyphen
+les, separated by
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-Short Title|S
+|
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-).
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MenuString
+Other
\end_layout
\end_inset
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[string]
+string=""
\end_layout
\end_inset
- A separate 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
+] Some document class options, separated by a comma, that will be added
+ to the optional part of the
+\begin_inset Flex Code
+status collapsed
-|
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
- (e.
-\begin_inset space \thinspace{}
-\end_inset
+\backslash
+documentclass
+\end_layout
-g.
-\begin_inset space \space{}
\end_inset
+ command.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ClassOptions
+\end_layout
+
+\end_inset
+ section must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-Short Title|S
+End
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-).
- This specification is optional.
- If it is not given the
-\begin_inset Flex Code
+.
+\end_layout
+
+\begin_layout Subsection
+Paragraph styles
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Paragraph-Styles"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+A paragraph style description looks like this:
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-LabelString
+Note that this will either define a new style or modify an existing one.
\end_layout
\end_inset
- will be used instead for the menu.
+
\end_layout
-\begin_layout Itemize
+\begin_layout LyX-Code
+Style
+\family roman
+\emph on
+name
+\end_layout
+
+\begin_layout LyX-Code
+ ...
+\end_layout
+
+\begin_layout LyX-Code
+End
+\end_layout
+
+\begin_layout Standard
+where the following commands are allowed:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Tooltip
+AddToToc
\end_layout
\end_inset
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[string]
+string
\end_layout
\end_inset
- A longer explanatory text that appears in the tooltip when hovering over
- the argument inset.
+=""] This paragraph will appear in the table of contents of the given type.
+ An empty string disables.
+ See also the OutlinerName and the IsTocCaption commands.
+ Default: disabled.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Mandatory
+Align
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-0
+block
+\emph default
+, left, right, center
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
+] Paragraph alignment.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+AlignPossible
\end_layout
\end_inset
-] Declare if this is a mandatory (1) or an optional (0) argument.
- Mandatory arguments will be output empty if not given, while optional arguments
- will not be output at all.
- By default, mandatory arguments are delimited by
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{...}
+
+\emph on
+block
+\emph default
+, left, right, center
\end_layout
\end_inset
-, while optional arguments are delimited by
+] A comma separated list of permitted alignments.
+ (Some \SpecialChar LaTeX
+ styles prohibit certain alignments, since those wouldn't make sense.
+ For example a right-aligned or centered enumeration isn't possible.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[...]
+Argument
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout Itemize
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Requires
+int
\end_layout
\end_inset
-
+] Defines argument number <int> of a command\SpecialChar breakableslash
+environment associated with
+ the current style.
+ This is useful for things like section headings, and only makes sense with
+ \SpecialChar LaTeX
+.
+ Every (optional or required) argument of a command or environment – except
+ for the required argument that is associated with the content of the paragraph
+ itself – has a separate definition, where the number specifies the order
+ of the arguments.
+ The definition must end with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[int=0]
+EndArgument
\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
+.
+ So a command with two optional arguments has:
+\end_layout
-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
+\begin_deeper
+\begin_layout Quote
-\begin_layout Plain Layout
+\family typewriter
+Argument 1
+\end_layout
-\backslash
-command[][argument]{text}
+\begin_layout Quote
+
+\family typewriter
+...
\end_layout
-\end_inset
+\begin_layout Quote
-.
- This can be achieved by the statement
-\begin_inset Flex Code
-status collapsed
+\family typewriter
+EndArgument
+\end_layout
-\begin_layout Plain Layout
-Requires 1
+\begin_layout Quote
+
+\family typewriter
+Argument 2
\end_layout
-\end_inset
+\begin_layout Quote
- within
+\family typewriter
+...
+\end_layout
+
+\begin_layout Quote
+
+\family typewriter
+EndArgument
+\end_layout
+
+\begin_layout Standard
+Inside the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument 2
+Argument
\end_layout
\end_inset
-.
+ definition, the following specifications are possible:
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-LeftDelim
+LabelString
\end_layout
\end_inset
\end_inset
- defines a custom left delimiter (instead of
+ The string that will appear both in the menu (to insert this argument)
+ and on the argument inset button (unless you also specify a separate
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{
+MenuString
\end_layout
\end_inset
- or
-\begin_inset Flex Code
-status collapsed
+).
+ 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_layout Plain Layout
-[
-\end_layout
+|
+\begin_inset Quotes erd
+\end_inset
+ (e.
+\begin_inset space \thinspace{}
\end_inset
-).
- A line break in the output can be indicated by
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<br/>
+Short Title|S
\end_layout
\end_inset
-.
+
+\begin_inset Quotes erd
+\end_inset
+
+).
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-RightDelim
+MenuString
\end_layout
\end_inset
\end_inset
- defines a custom right delimiter (instead of
-\begin_inset Flex Code
-status collapsed
+ A separate 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_layout Plain Layout
-}
-\end_layout
+|
+\begin_inset Quotes erd
+\end_inset
+ (e.
+\begin_inset space \thinspace{}
\end_inset
- or
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-]
+Short Title|S
\end_layout
\end_inset
+
+\begin_inset Quotes erd
+\end_inset
+
).
- A line break in the output can be indicated by
+ This specification is optional.
+ If it is not given the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<br/>
+LabelString
\end_layout
\end_inset
-.
+ will be used instead for the menu.
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-DefaultArg
+Tooltip
\end_layout
\end_inset
\end_inset
- defines an argument that is inserted if and only if no user-specified arguments
- were given, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-e.
-\begin_inset space \space{}
-\end_inset
-
-if no argument inset has been inserted (note that also an empty argument
- inset omits the DefaultArg).
- Multiple arguments need to be separated by comma.
+ A longer explanatory text that appears in the tooltip when hovering over
+ the argument inset.
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-PresetArg
+Mandatory
\end_layout
\end_inset
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[string]
+
+\emph on
+0
\end_layout
\end_inset
- defines an argument that is inserted in any case (alone or in addition
- to user-specified arguments).
- Multiple arguments need to be separated by comma.
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+1
\end_layout
\end_inset
- The font used for the argument content, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
-
-\end_inset
+] Declare if this is a mandatory (1) or an optional (0) argument.
+ Mandatory arguments will be output empty if not given, while optional arguments
+ will not be output at all.
+ By default, mandatory arguments are delimited by
+\begin_inset Flex Code
+status collapsed
-.
+\begin_layout Plain Layout
+{...}
\end_layout
-\begin_layout Itemize
+\end_inset
+
+, while optional arguments are delimited by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+[...]
\end_layout
\end_inset
- The font used for the label; see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-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
-Decoration
-\end_layout
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
+\change_inserted -712698321 1555579780
+NewlineCmd
+\change_unchanged
-\emph on
-Classic
-\emph default
-, Minimalistic, Conglomerate
\end_layout
\end_inset
-] describes the rendering style used for the inset's frame and buttons.
-\end_layout
-
-\begin_layout Itemize
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AutoInsert
+
+\change_inserted -712698321 1555579780
+[string]
+\change_unchanged
+
\end_layout
\end_inset
-
+ Option to define a different command (from the default
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[int=0]
-\end_layout
-\end_inset
+\change_inserted -712698321 1555579780
- If this is set to
-\begin_inset Flex Code
-status collapsed
+\backslash
+
+\backslash
+
+\change_unchanged
-\begin_layout Plain Layout
-1
\end_layout
\end_inset
-, this argument is automatically inserted when the respective style is selected.
- Currently, only one argument per style\SpecialChar breakableslash
-layout can be automatically inserted.
+) to be used for line breaks.
+ The initial backslash must not be specified.
+\change_unchanged
+
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-InsertCotext
+Requires
\end_layout
\end_inset
\end_inset
- If this is set to
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-1
-\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
-, this argument will be inserted with a copy of the co-text (either selected
- text or the whole paragraph) as content.
-\end_layout
-
-\begin_layout Itemize
+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
\begin_layout Plain Layout
-PassThru
+
+\backslash
+command[][argument]{text}
\end_layout
\end_inset
- [
+.
+ This can be achieved by the statement
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-inherited
-\emph default
-, true, false
+Requires 1
\end_layout
\end_inset
-] Whether the contents of this argument should be output in raw form, meaning
- without special translations that \SpecialChar LaTeX
- would require.
- By default, the
+ within
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru
+Argument 2
\end_layout
\end_inset
- status is inherited by the inset or paragraph layout the argument belongs
- to, true and false change the status for the given argument only.
+.
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-PassThruChars
+LeftDelim
\end_layout
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string of characters
+[string]
\end_layout
\end_inset
-]
-\family typewriter
-
-\family default
-Defines individual characters
-\begin_inset Newline linebreak
-\end_inset
-
-that should be output in raw form, meaning without special translations
- that \SpecialChar LaTeX
- would require.
- Note that, contrary to PassThru, this needs to be explicitly defined for
- arguments.
- That is, arguments do not inherit PassThruChars from their parent inset
- or layout.
-\end_layout
-
-\begin_layout Itemize
+ defines a custom left delimiter (instead of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-IsTocCaption
+{
\end_layout
\end_inset
- [
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+[
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+).
+ A line break in the output can be indicated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+<br/>
\end_layout
\end_inset
-] If this is set to 1, the argument will output its content in the corresponding
- item in the table of contents.
- See AddToToc.
-\end_layout
-
-\begin_layout Standard
-By default, the text entered in the \SpecialChar LyX
- workarea in the respective layout is
- the last (mandatory) argument of a command if the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-LatexType
+.
\end_layout
-\end_inset
-
- is
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+RightDelim
\end_layout
\end_inset
-.
- However, arguments with the prefix
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-post:
+[string]
\end_layout
\end_inset
- are output after this workarea argument.
- Note that post-argument numbering restarts at 1, so the first argument
- following the workarea argument is
+ defines a custom right delimiter (instead of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-post:1
+}
\end_layout
\end_inset
-.
- Post-arguments are ignored in any other
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+]
\end_layout
\end_inset
- than
+).
+ A line break in the output can be indicated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+<br/>
\end_layout
\end_inset
.
\end_layout
-\begin_layout Standard
-Arguments for list
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-item
-\end_layout
-
-\end_inset
-
-s (as in
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-item[foo]
+DefaultArg
\end_layout
\end_inset
-) have the prefix
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-item:
+[string]
\end_layout
\end_inset
- followed by the number (e.
+ defines an argument that is inserted if and only if no user-specified arguments
+ were given, i.
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
+if no argument inset has been inserted (note that also an empty argument
+ inset omits the DefaultArg).
+ Multiple arguments need to be separated by comma.
+\end_layout
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument item:1
+PresetArg
\end_layout
\end_inset
-).
-\end_layout
-
-\end_deeper
-\begin_layout Description
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AutoNests
+[string]
\end_layout
\end_inset
- Includes a comma-separated list of layouts that should be nested in and
- after the current layout.
- Only makes sense for nestable layouts (such as environments).
- Must be ended by
-\begin_inset Quotes eld
-\end_inset
-
+ defines an argument that is inserted in any case (alone or in addition
+ to user-specified arguments).
+ Multiple arguments need to be separated by comma.
+\end_layout
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndAutoNests
+Font
\end_layout
\end_inset
+ The font used for the argument content, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
-\begin_inset Quotes erd
\end_inset
.
- See also
-\begin_inset Flex Code
-status collapsed
+\change_inserted -712698321 1559484228
-\begin_layout Plain Layout
-IsAutoNestedBy
\end_layout
-\end_inset
-
-.
-\end_layout
+\begin_layout Itemize
-\begin_layout Description
+\change_inserted -712698321 1559484228
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+
+\change_inserted -712698321 1559484228
+FreeSpacing
+\change_unchanged
+
\end_layout
\end_inset
- Note that this will completely override any prior
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+
+\change_inserted -712698321 1559484228
+
+\emph on
+0
+\change_unchanged
+
\end_layout
\end_inset
- declaration for this style.
- Must end with
-\begin_inset Quotes eld
+,
+\begin_inset space \thinspace{}
\end_inset
status collapsed
\begin_layout Plain Layout
-EndBabelPreamble
+
+\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"
-\begin_inset Quotes erd
\end_inset
.
- See
+\change_unchanged
+
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelFont
+\end_layout
+
+\end_inset
+
+ The font used for the label; see
\begin_inset CommandInset ref
LatexCommand ref
-reference "subsec:I18n"
+reference "subsec:Font-description"
\end_inset
- for details on its use.
+.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BottomSep
+Decoration
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-float=0
+
+\emph on
+Classic
+\emph default
+, Minimalistic, Conglomerate
\end_layout
\end_inset
-]
-\begin_inset Foot
+] describes the rendering style used for the inset's frame and buttons.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that a `float' here is a real number, such as: 1.5.
+AutoInsert
\end_layout
\end_inset
- The vertical space with which the last of a chain of paragraphs with this
- style is separated from the following paragraph.
- If the next paragraph has another style, the separations are not simply
- added, but the maximum is taken.
-\end_layout
-
-\begin_layout Description
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Category
+[int=0]
\end_layout
\end_inset
- [
+ If this is set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+1
\end_layout
\end_inset
-] The category for this style.
- This is used to group related styles in the style combobox on the toolbar.
- Any string can be used, but you may want to use existing categories with
- your own styles.
-
+, 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 Description
+\begin_layout Itemize
+
+\change_inserted -712698321 1559491402
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CommandDepth
+
+\change_inserted -712698321 1559490711
+InsertOnNewline
+\change_unchanged
+
\end_layout
\end_inset
- Depth of XML command.
- Used only with XML-type formats.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559490703
+[int=0]
+\change_unchanged
+
\end_layout
-\begin_layout Description
+\end_inset
+
+ If this is set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+
+\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
-string
+
+\change_inserted -712698321 1559491402
+AutoInsert
+\change_unchanged
+
\end_layout
\end_inset
-] Copies all the features of an existing style into the current one.
-
+ (only available within Flex insets).
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DependsOn
+InsertCotext
\end_layout
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<name>
+[int=0]
\end_layout
\end_inset
-] The name of a style whose preamble should be output
-\emph on
-before
-\emph default
- this one.
- This allows to ensure some ordering of the preamble snippets when macros
- definitions depend on one another.
-\begin_inset Foot
+ If this is set to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that, besides that functionality, there is no way to ensure any ordering
- of preambles.
- The ordering that you see in a given version of \SpecialChar LyX
- may change without warning
- in later versions.
+1
\end_layout
\end_inset
-
+, this argument will be inserted with a copy of the co-text (either selected
+ text or the whole paragraph) as content.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabeltype
+PassThru
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-No_Label
+inherited
\emph default
-, Box, Filled_Box, Static
+, true, false
\end_layout
\end_inset
-] The type of label that stands at the end of the paragraph (or sequence
- of paragraphs if
+] Whether the contents of this argument should be output in raw form, meaning
+ without special translations that \SpecialChar LaTeX
+ would require.
+ By default, the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+PassThru
\end_layout
\end_inset
- is
-\begin_inset Newline newline
-\end_inset
-
+ status is inherited by the inset or paragraph layout the argument belongs
+ to, true and false change the status for the given argument only.
+\end_layout
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+PassThruChars
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+string of characters
\end_layout
\end_inset
- or
+]
+\family typewriter
+
+\family default
+Defines individual characters
+\begin_inset Newline linebreak
+\end_inset
+
+that should be output in raw form, meaning without special translations
+ that \SpecialChar LaTeX
+ would require.
+ Note that, contrary to PassThru, this needs to be explicitly defined for
+ arguments.
+ That is, arguments do not inherit PassThruChars from their parent inset
+ or layout.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+IsTocCaption
\end_layout
\end_inset
-).
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-No_Label
+
+\emph on
+0
\end_layout
\end_inset
- means
-\begin_inset Quotes eld
+,
+\begin_inset space \thinspace{}
\end_inset
-nothing
-\begin_inset Quotes erd
-\end_inset
-,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box
+1
\end_layout
\end_inset
- (resp.
-\begin_inset space \space{}
-\end_inset
-
+] If this is set to 1, the argument will output its content in the corresponding
+ item in the table of contents.
+ See AddToToc.
+\end_layout
+\begin_layout Standard
+By default, the text entered in the \SpecialChar LyX
+ workarea in the respective layout is
+ the last (mandatory) argument of a command if the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Filled_Box
+LatexType
\end_layout
\end_inset
-) is a white (resp.
-\begin_inset space ~
-\end_inset
-
-black) square suitable for end of proof markers,
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+Command
\end_layout
\end_inset
- is an explicit text string.
-\end_layout
-
-\begin_layout Description
+.
+ However, arguments with the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabelString
+post:
\end_layout
\end_inset
- [
+ are output after this workarea argument.
+ Note that post-argument numbering restarts at 1, so the first argument
+ following the workarea argument is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+post:1
\end_layout
\end_inset
-] The string used for a label with a
+.
+ Post-arguments are ignored in any other
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+LatexType
\end_layout
\end_inset
-
-\begin_inset Newline newline
-\end_inset
-
-
+ than
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabelType
+Command
\end_layout
\end_inset
.
-
\end_layout
-\begin_layout Description
+\begin_layout Standard
+Arguments for list
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+
+\backslash
+item
\end_layout
\end_inset
- The font used for both the text body
-\emph on
-and
-\emph default
- the label.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
+s (as in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+item[foo]
+\end_layout
\end_inset
-.
- Note that defining this font automatically defines the
+) have the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+item:
\end_layout
\end_inset
- to the same value.
- So you should define this one first if you also want to define
+ followed by the number (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Argument item:1
\end_layout
\end_inset
-.
+).
+\change_inserted -712698321 1534487781
+
\end_layout
-\begin_layout Description
+\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
-ForceLocal
+
+\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
-int=0
+
+\change_inserted -712698321 1534488412
+Argument listpreamble:1
+\change_unchanged
+
\end_layout
\end_inset
-] Used for backporting new styles to stable \SpecialChar LyX
- versions.
- The first stable version that supports this tag is \SpecialChar LyX
- 2.1.0.
- The argument is a number which may either be 0, -1 or any value greater
- than zero.
- If the
+).
+ 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
-ForceLocal
+
+\change_inserted -712698321 1534488058
+
+\backslash
+item
+\change_unchanged
+
\end_layout
\end_inset
- flag of a style is greater than zero, it will always be written to the
- document header.
- If a .lyx file is read, the style definitions from the document header are
- added to the document class.
- Therefore even older \SpecialChar LyX
- versions can handle the style.
- The argument of
+, 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
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForceLocal
+AutoNests
\end_layout
\end_inset
- is a version number: if the style is read, and the version number is less
- than the version number of the already existing style in the document class,
- the new style is ignored.
- If the version number is greater, the new style replaces the existing style.
- A value of -1 means an infinite version number, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-e.
-\begin_inset space \space{}
+ Includes a comma-separated list of layouts that should be nested in and
+ after the current layout.
+ Only makes sense for nestable layouts (such as environments).
+ Must be ended by
+\begin_inset Quotes eld
\end_inset
-the style is always used.
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+EndAutoNests
\end_layout
\end_inset
- [
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See also
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+IsAutoNestedBy
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
+.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+BabelPreamble
\end_layout
\end_inset
-] Usually \SpecialChar LyX
- does not allow you to insert more than one space between words,
- since a space is considered as the separation between two words, not a
- character or symbol of its own.
- This is a very fine thing but sometimes annoying, for example, when typing
- program code or plain \SpecialChar LaTeX
- code.
- For this reason,
+ Note that this will completely override any prior
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+BabelPreamble
\end_layout
\end_inset
- can be enabled.
- Note that \SpecialChar LyX
- will create protected blanks for the additional blanks when
- in another mode than \SpecialChar LaTeX
--mode.
-\end_layout
+ declaration for this style.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTML*
+EndBabelPreamble
\end_layout
\end_inset
- These tags are used with XHTML output.
+
+\begin_inset Quotes erd
+\end_inset
+
+.
See
\begin_inset CommandInset ref
LatexCommand ref
-reference "subsec:Paragraph-Style-XHTML"
+reference "subsec:I18n"
\end_inset
-.
+ for details on its use.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-InnerTag
+BottomSep
\end_layout
\end_inset
- [FIXME] (Used only with XML-type formats.)
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InPreamble
+float=0
\end_layout
\end_inset
- [
-\begin_inset Flex Code
+]
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Note that a `float' here is a real number, such as: 1.5.
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
+ The vertical space with which the last of a chain of paragraphs with this
+ style is separated from the following paragraph.
+ If the next paragraph has another style, the separations are not simply
+ added, but the maximum is taken.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Category
\end_layout
\end_inset
-] If
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+string
\end_layout
\end_inset
-, marks the style as to be included in the document preamble and not in
- the document body.
- This is useful for document classes that want such information as the title
- and author to appear in the preamble.
- Note that this works only for styles for which the
+] The category for this style.
+ This is used to group related styles in the style combobox on the toolbar.
+ Any string can be used, but you may want to use existing categories with
+ your own styles.
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+CommandDepth
\end_layout
\end_inset
- is
+ Depth of XML command.
+ Used only with XML-type formats.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+CopyStyle
\end_layout
\end_inset
- or
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Paragraph
+string
\end_layout
\end_inset
-.
+] Copies all the features of an existing style into the current one.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-InTitle
+DependsOn
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+<name>
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
-\begin_inset Flex Code
+] The name of a style whose preamble should be output
+\emph on
+before
+\emph default
+ this one.
+ This allows to ensure some ordering of the preamble snippets when macros
+ definitions depend on one another.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-1
+Note that, besides that functionality, there is no way to ensure any ordering
+ of preambles.
+ The ordering that you see in a given version of \SpecialChar LyX
+ may change without warning
+ in later versions.
\end_layout
\end_inset
-] If
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-1
\end_layout
-\end_inset
-
-, marks the style as being part of a title block (see also the
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+EndLabeltype
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+
+\emph on
+No_Label
+\emph default
+, Box, Filled_Box, Static
\end_layout
\end_inset
- global entries).
-\end_layout
-
-\begin_layout Description
+] The type of label that stands at the end of the paragraph (or sequence
+ of paragraphs if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-IsAutoNestedBy
+LatexType
\end_layout
\end_inset
- Includes a comma-separated list of layouts after which this one should
- be nested.
- Only makes sense with regard to nestable layouts (such as environments).
- Must be ended by
-\begin_inset Quotes eld
+ is
+\begin_inset Newline newline
\end_inset
status collapsed
\begin_layout Plain Layout
-EndIsAutoNestedBy
+Environment
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- See also
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AutoNests
+Item_Environment
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-IsTocCaption
+List_Environment
\end_layout
\end_inset
- [
+).
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+No_Label
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+ means
+\begin_inset Quotes eld
\end_inset
+nothing
+\begin_inset Quotes erd
+\end_inset
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Box
\end_layout
\end_inset
-] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
- of its contents in its item in the table of contents.
- Otherwise, only the label, if it exists, appears.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-ItemCommand
-\end_layout
-
+ (resp.
+\begin_inset space \space{}
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string="item"
+Filled_Box
\end_layout
\end_inset
-] The \SpecialChar LaTeX
- command sequence declaring an item in a list.
- The command is to be defined without the preceding backslash (the default
- is
-\begin_inset Quotes eld
-\end_inset
-
-item
-\begin_inset Quotes erd
+) is a white (resp.
+\begin_inset space ~
\end_inset
-, resulting in
+black) square suitable for end of proof markers,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-item
+Static
\end_layout
\end_inset
- in the \SpecialChar LaTeX
- output).
+ is an explicit text string.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ItemSep
+EndLabelString
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-float=0
+string=""
\end_layout
\end_inset
-] This provides extra space between paragraphs that have the same style.
- If you put other styles into an environment, each is separated with the
- environment's
+] The string used for a label with a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ParSep
+Static
\end_layout
\end_inset
-.
- But the whole items of the environment are additionally separated with
- this
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-ItemSep
-\end_layout
+\begin_inset Newline newline
\end_inset
-.
- Note that this is a
-\emph on
- multiplier.
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ItemTag
+EndLabelType
\end_layout
\end_inset
- [FIXME] (Used only with XML-type formats.)
+.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+Font
\end_layout
\end_inset
- [
+ The font used for both the text body
+\emph on
+and
+\emph default
+ the label.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
+\end_inset
+
+.
+ Note that defining this font automatically defines the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+LabelFont
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+ to the same value.
+ So you should define this one first if you also want to define
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+LabelFont
\end_layout
\end_inset
-] Usually \SpecialChar LyX
- does not allow you to leave a paragraph empty, since it would
- lead to empty \SpecialChar LaTeX
- output.
- There are some cases where this could be desirable however: in a letter
- template, the required fields can be provided as empty fields, so that
- people do not forget them; in some special classes, a style can be used
- as some kind of break, which does not contain actual text.
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelBottomsep
+ForceLocal
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-float=0
+int=0
\end_layout
\end_inset
-] The vertical space between the label and the text body.
- Only used for labels that are above the text body (
+] Used for backporting new styles to stable \SpecialChar LyX
+ versions.
+ The first stable version that supports this tag is \SpecialChar LyX
+ 2.1.0.
+ The argument is a number which may either be 0, -1 or any value greater
+ than zero.
+ If the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+ForceLocal
\end_layout
\end_inset
- and
-\begin_inset Newline newline
-\end_inset
-
-
+ flag of a style is greater than zero, it will always be written to the
+ document header.
+ If a .lyx file is read, the style definitions from the document header are
+ added to the document class.
+ Therefore even older \SpecialChar LyX
+ versions can handle the style.
+ The argument of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+ForceLocal
\end_layout
\end_inset
-).
+ is a version number: if the style is read, and the version number is less
+ than the version number of the already existing style in the document class,
+ the new style is ignored.
+ If the version number is greater, the new style replaces the existing style.
+ A value of -1 means an infinite version number, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e.
+\begin_inset space \space{}
+\end_inset
+
+the style is always used.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelCounter
+FreeSpacing
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+
+\emph on
+0
\end_layout
\end_inset
-] The name of the counter for automatic numbering.
- In order to have the counter appear with your label, you will need to reference
- it in the
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\family typewriter
-LabelString
-\end_layout
+1
+\end_layout
\end_inset
-.
- This will work with
+] Usually \SpecialChar LyX
+ does not allow you to insert more than one space between words,
+ since a space is considered as the separation between two words, not a
+ character or symbol of its own.
+ This is a very fine thing but sometimes annoying, for example, when typing
+ program code or plain \SpecialChar LaTeX
+ code.
+ For this reason,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+FreeSpacing
\end_layout
\end_inset
-s,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Static
-\end_layout
-
-\end_inset
+ can be enabled.
+
+\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
-Above
-\end_layout
-
-\end_inset
- and
-\begin_inset Flex Code
-status collapsed
+\change_inserted -495245474 1550490089
+Passthru 1
+\change_unchanged
-\begin_layout Plain Layout
-Centered
\end_layout
\end_inset
-, at least.
-\begin_inset Newline newline
-\end_inset
+ is not specified.
+\change_deleted -495245474 1550490116
+another mode than \SpecialChar LaTeX
+-mode.
-This
-\emph on
-may
-\emph default
- also be given if
+\change_inserted -495245474 1550247760
+ Note that
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+
+\change_inserted -495245474 1550247736
+FreeSpacing
+\change_unchanged
+
\end_layout
\end_inset
- is
+ implies
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Enumerate
+
+\change_inserted -495245474 1550247755
+KeepEmpty
+\change_unchanged
+
\end_layout
\end_inset
-, though this case is a bit complicated.
- Suppose you declare
-\begin_inset Quotes eld
-\end_inset
+.
+\change_unchanged
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelCounter myenum
+HTML*
\end_layout
\end_inset
+ These tags are used with XHTML output.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Style-XHTML"
-\begin_inset Quotes erd
\end_inset
.
- Then the actual counters used are
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-myenumi
\end_layout
-\end_inset
-
-,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumii
+InnerTag
\end_layout
\end_inset
-,
+ [FIXME] (Used only with XML-type formats.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumiii
+InPreamble
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumiv
-\end_layout
-\end_inset
+\emph on
+0
+\end_layout
-, much as in \SpecialChar LaTeX
-.
- These counters must all be declared separately.
-\begin_inset Newline newline
\end_inset
-See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Counters"
-
+,
+\begin_inset space \thinspace{}
\end_inset
- for details on counters.
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+1
\end_layout
\end_inset
- The font used for the label.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
+] If
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelIndent
+1
\end_layout
\end_inset
- [
+, marks the style as to be included in the document preamble and not in
+ the document body.
+ This is useful for document classes that want such information as the title
+ and author to appear in the preamble.
+ Note that this works only for styles for which the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+LatexType
\end_layout
\end_inset
-] Text that indicates how far a label should be indented.
-\end_layout
-
-\begin_layout Description
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelSep
+Command
\end_layout
\end_inset
- [
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+Paragraph
\end_layout
\end_inset
-] Text that indicates the amount of horizontal space between the label and
- the text body.
- Only used for labels that are not above the text body.
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelString
+InTitle
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+
+\emph on
+0
\end_layout
\end_inset
-] The string used for the label.
- When
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelCounter
+1
\end_layout
\end_inset
- is set, this string can be contain the special formatting commands described
- in
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Counters"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
+] If
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+1
\end_layout
\end_inset
- [
+, marks the style as being part of a title block (see also the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+TitleLatexType
\end_layout
\end_inset
-] This is used inside the appendix instead of
-\begin_inset Newline newline
-\end_inset
-
-
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+TitleLatexName
\end_layout
\end_inset
-.
- Note that every
+ global entries).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+IsAutoNestedBy
\end_layout
\end_inset
- statement resets
-\begin_inset Newline newline
+ Includes a comma-separated list of layouts after which this one should
+ be nested.
+ Only makes sense with regard to nestable layouts (such as environments).
+ Must be ended by
+\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+EndIsAutoNestedBy
\end_layout
\end_inset
- too.
-\end_layout
-\begin_layout Description
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See also
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelTag
+AutoNests
\end_layout
\end_inset
- [FIXME] (Used only with XML-type formats.)
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelType
+IsTocCaption
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-No_Label
-\emph default
-, Manual, Static, Above,
-\begin_inset Newline newline
-\end_inset
+0
+\end_layout
-Centered, Sensitive, Enumerate,
-\begin_inset Newline newline
\end_inset
-Itemize, Bibliography
-\end_layout
-
+,
+\begin_inset space \thinspace{}
\end_inset
-]
-\end_layout
-\begin_deeper
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+1
\end_layout
\end_inset
- means the label is the very first word (up to the first real blank).
- Use protected spaces if you want more than one word as the label.
-
+] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
+ of its contents in its item in the table of contents.
+ Otherwise, only the label, if it exists, appears.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Static
+ItemCommand
\end_layout
\end_inset
- means the label is simply what is declared as
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+string="item"
\end_layout
\end_inset
-.
- This will be displayed
+] The \SpecialChar LaTeX
+ command sequence declaring an item in a list.
+ The command is to be defined without the preceding backslash (the default
+ is
\begin_inset Quotes eld
\end_inset
-inline
+item
\begin_inset Quotes erd
\end_inset
-, at the beginning of the paragraph.
- If the
+, resulting in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+
+\backslash
+item
\end_layout
\end_inset
- is
+ in the \SpecialChar LaTeX
+ output).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+ItemSep
\end_layout
\end_inset
-, then it will be displayed only in the first paragraph of any sequence
- of paragraphs with the same
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Style
+float=0
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+] This provides extra space between paragraphs that have the same style.
+ If you put other styles into an environment, each is separated with the
+ environment's
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Above
+ParSep
\end_layout
\end_inset
+.
+ But the whole items of the environment are additionally separated with
+ this
+\begin_inset Flex Code
+status collapsed
-\begin_inset space ~
-\end_inset
+\begin_layout Plain Layout
+ItemSep
+\end_layout
-and
-\begin_inset space ~
\end_inset
+.
+ Note that this is a
+\emph on
+ multiplier.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Centered
+ItemTag
\end_layout
\end_inset
- are special cases of
+ [FIXME] (Used only with XML-type formats.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+KeepEmpty
\end_layout
\end_inset
-.
- The label will be printed above the paragraph either at the beginning of
- the line or centered.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sensitive
+
+\emph on
+0
\end_layout
\end_inset
- is a special case for the caption-labels
-\begin_inset Quotes eld
+,
+\begin_inset space \thinspace{}
\end_inset
-Figure
-\begin_inset Quotes erd
-\end_inset
- and
-\begin_inset Quotes eld
-\end_inset
+\begin_inset Flex Code
+status collapsed
-Table
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+1
+\end_layout
-.
-\begin_inset Newline newline
\end_inset
+] Usually \SpecialChar LyX
+ does not allow you to leave a paragraph empty, since it would
+ lead to empty \SpecialChar LaTeX
+ output.
+ There are some cases where this could be desirable however: in a letter
+ template, the required fields can be provided as empty fields, so that
+ people do not forget them; in some special classes, a style can be used
+ as some kind of break, which does not contain actual text.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sensitive
+LabelBottomsep
\end_layout
\end_inset
- means the (hardcoded) label string depends on the kind of float: It is
- hardcoded to be `FloatType N', where N is the value of the counter associated
- with the float.
- For the case that a caption is inserted outside of a float the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+float=0
\end_layout
\end_inset
- will appear as
-\begin_inset Quotes eld
+] The vertical space between the label and the text body.
+ Only used for labels that are above the text body (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Top_Environment
+\end_layout
+
\end_inset
-Senseless!
-\begin_inset Quotes erd
+ and
+\begin_inset Newline newline
\end_inset
-.
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Enumerate
+Centered_Top_Environment
\end_layout
\end_inset
- produces the usual sort of enumeration labels.
- The number type needs to be set in the
-\family sans
-Counter
-\family default
-, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Counters"
+).
+\end_layout
-\end_inset
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-.
+\begin_layout Plain Layout
+LabelCounter
\end_layout
-\begin_layout Description
+\end_inset
+
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Itemize
+string=""
\end_layout
\end_inset
- produces various bullets at the different levels.
- The bullet types displayed can be set via
-\begin_inset Flex Noun
+] The name of the counter for automatic numbering.
+ In order to have the counter appear with your label, you will need to reference
+ it in the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Bullets
+
+\family typewriter
+LabelString
\end_layout
\end_inset
.
+ This will work with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelType
\end_layout
-\begin_layout Description
+\end_inset
+
+s,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Bibliography
+Static
\end_layout
\end_inset
- should be used only with
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType BibEnvironment
+Above
\end_layout
\end_inset
-.
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Centered
\end_layout
-\end_deeper
-\begin_layout Description
+\end_inset
+
+, at least.
+\begin_inset Newline newline
+\end_inset
+
+This
+\emph on
+may
+\emph default
+ also be given if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+LabelType
\end_layout
\end_inset
- Note that this will completely override any prior
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+Enumerate
\end_layout
\end_inset
- declaration for this style.
- Must end with
+, though this case is a bit complicated.
+ Suppose you declare
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-EndLangPreamble
+LabelCounter myenum
\end_layout
\end_inset
\end_inset
.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:I18n"
-
-\end_inset
-
- for details on its use.
-\end_layout
-
-\begin_layout Description
+ Then the actual counters used are
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+myenumi
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<name>
+myenumii
\end_layout
\end_inset
-] The name of the corresponding \SpecialChar LaTeX
- stuff.
- Either the environment or command name.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexParam
+myenumiii
\end_layout
\end_inset
- [
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<parameter>
+myenumiv
\end_layout
\end_inset
-] An optional parameter for the corresponding
+, much as in \SpecialChar LaTeX
+.
+ These counters must all be declared separately.
+\begin_inset Newline newline
+\end_inset
+
+See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Counters"
+
+\end_inset
+
+ for details on counters.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+LabelFont
\end_layout
\end_inset
- stuff.
- This parameter cannot be changed from within \SpecialChar LyX
- (use
+ The font used for the label.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+LabelIndent
\end_layout
\end_inset
- for customizable parameters).
- This will be output as is after all \SpecialChar LaTeX
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+string=""
\end_layout
\end_inset
-s.
+] Text that indicates how far a label should be indented.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LatexType
+LabelSep
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+string=""
+\end_layout
-\emph on
-Paragraph
-\emph default
-, Command, Environment, Item_Environment,
-\begin_inset Newline newline
\end_inset
-List_Environment, Bib_Environment
+] Text that indicates the amount of horizontal space between the label and
+ the text body.
+ Only used for labels that are not above the text body.
\end_layout
-\end_inset
-
-] How the style should be translated into \SpecialChar LaTeX
-.
-\begin_inset Foot
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+LabelString
+\end_layout
+
+\end_inset
+
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+string=""
\end_layout
\end_inset
- is perhaps a bit misleading, since these rules apply to SGML classes, too.
- Visit the SGML class files for specific examples.
+] The string used for the label.
+ When
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelCounter
\end_layout
\end_inset
+ is set, this string can be contain the special formatting commands described
+ in
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Counters"
+
+\end_inset
+.
\end_layout
-\begin_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Paragraph
+LabelStringAppendix
\end_layout
\end_inset
- means nothing special.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+string=""
\end_layout
\end_inset
- means
+] This is used inside the appendix instead of
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\emph on
-LatexName
-\emph default
-{\SpecialChar ldots
-}
+LabelString
\end_layout
\end_inset
.
-\end_layout
-
-\begin_layout Description
+ Note that every
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+LabelString
\end_layout
\end_inset
- means
+ statement resets
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}\SpecialChar ldots
-
-\backslash
-end{
-\emph on
-LatexName
-\emph default
-}
+LabelStringAppendix
\end_layout
\end_inset
-.
-
+ too.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Item_Environment
+LabelTag
\end_layout
\end_inset
- is the same as
+ [FIXME] (Used only with XML-type formats.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+LabelType
\end_layout
\end_inset
-, except that an
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-item
+\emph on
+No_Label
+\emph default
+, Manual, Static, Above,
+\begin_inset Newline newline
+\end_inset
+
+Centered, Sensitive, Enumerate,
+\begin_inset Newline newline
+\end_inset
+
+Itemize, Bibliography
\end_layout
\end_inset
- is generated for each paragraph of this environment.
-
+]
\end_layout
+\begin_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+Manual
\end_layout
\end_inset
- is the same as
+ means the label is the very first word (up to the first real blank).
+ Use protected spaces if you want more than one word as the label.
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+Static
\end_layout
\end_inset
-, except that
-\begin_inset Newline newline
-\end_inset
-
-
+ means the label is simply what is declared as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+LabelString
\end_layout
\end_inset
- is passed as an argument to the environment.
-\begin_inset Newline newline
+.
+ This will be displayed
+\begin_inset Quotes eld
\end_inset
+inline
+\begin_inset Quotes erd
+\end_inset
+, at the beginning of the paragraph.
+ If the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+LatexType
\end_layout
\end_inset
- can be defined in the
-\begin_inset Flex Noun
+ is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Edit\SpecialChar menuseparator
-Paragraph
-\begin_inset space ~
+Environment
+\end_layout
+
\end_inset
-settings
+, then it will be displayed only in the first paragraph of any sequence
+ of paragraphs with the same
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Style
\end_layout
\end_inset
- dialog.
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Bib_Environment
+Above
\end_layout
\end_inset
- is like
+
+\begin_inset space ~
+\end_inset
+
+and
+\begin_inset space ~
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+Centered
\end_layout
\end_inset
- but adds the necessary mandatory argument (the longest label) to the begin
- statement of the bibliography environment:
-\begin_inset Newline newline
-\end_inset
-
-
+ are special cases of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{thebibliography}{99}
+Static
\end_layout
\end_inset
.
- It is therefore only useful for bibliography environments.
- The default longest label
-\begin_inset Quotes eld
-\end_inset
+ The label will be printed above the paragraph either at the beginning of
+ the line or centered.
+\end_layout
-99
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
- can be changed by the user in the paragraph settings of a bibliography
- item.
+\begin_layout Plain Layout
+Sensitive
\end_layout
-\begin_layout Standard
-Putting the last few things together, the \SpecialChar LaTeX
- output will be either:
-\end_layout
+\end_inset
-\begin_layout LyX-Code
+ is a special case for the caption-labels
+\begin_inset Quotes eld
+\end_inset
-\backslash
-LatexName[LatexParam]{\SpecialChar ldots
-}
-\end_layout
+Figure
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-or:
-\end_layout
+ and
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
+Table
+\begin_inset Quotes erd
+\end_inset
-\backslash
-begin{LatexName}[LatexParam] \SpecialChar ldots
-
-\backslash
-end{LatexName}.
-\end_layout
+.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-depending upon the \SpecialChar LaTeX
- type.
-\end_layout
-\end_deeper
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LeftDelim
+Sensitive
\end_layout
\end_inset
- [
+ means the (hardcoded) label string depends on the kind of float: It is
+ hardcoded to be `FloatType N', where N is the value of the counter associated
+ with the float.
+ For the case that a caption is inserted outside of a float the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+LabelString
\end_layout
\end_inset
-] A string that is put at the beginning of the style content.
- A line break in the output can be indicated by
+ will appear as
+\begin_inset Quotes eld
+\end_inset
+
+Senseless!
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<br/>
+Enumerate
\end_layout
+\end_inset
+
+ produces the usual sort of enumeration labels.
+ The number type needs to be set in the
+\family sans
+Counter
+\family default
+, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Counters"
+
\end_inset
.
status collapsed
\begin_layout Plain Layout
-LeftMargin
+Itemize
\end_layout
\end_inset
- [
-\begin_inset Flex Code
+ produces various bullets at the different levels.
+ The bullet types displayed can be set via
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-string=""
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Bullets
\end_layout
\end_inset
-] If you put styles into environments, the different
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+Bibliography
\end_layout
\end_inset
- are not simply added, but added with a factor
-\begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
-\end_inset
-
-.
- Note that this parameter is also used when
+ should be used only with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Margin
+LatexType BibEnvironment
\end_layout
\end_inset
- is defined as
+.
+\end_layout
+
+\end_deeper
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+LangPreamble
\end_layout
\end_inset
- or
+ Note that this will completely override any prior
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Dynamic
+LangPreamble
\end_layout
\end_inset
-.
- Then it is added to the manual or dynamic margin.
-\begin_inset Newline newline
-\end_inset
-
-For example
+ declaration for this style.
+ Must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-MM
+EndLangPreamble
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
- means that the paragraph is indented with the width of
-\begin_inset Quotes eld
+.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:I18n"
+
\end_inset
+ for details on its use.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MM
+LatexName
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
- in the normal font.
- You can get a negative width by prefixing the string with
-\begin_inset Quotes eld
-\end_inset
-
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
--
+<name>
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- This way was chosen so that the look is the same with each used screen
- font.
+] The name of the corresponding \SpecialChar LaTeX
+ stuff.
+ Either the environment or command name.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Margin
+LatexParam
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Static
-\emph default
-, Manual, Dynamic, First_Dynamic, Right_Address_Box
+<parameter>
\end_layout
\end_inset
-]
-\begin_inset Newline newline
+] An optional parameter for the corresponding
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LatexName
+\end_layout
+
\end_inset
-The kind of margin that the style has on the left side.
+ stuff.
+ This parameter cannot be changed from within \SpecialChar LyX
+ (use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Argument
\end_layout
-\begin_deeper
-\begin_layout Description
+\end_inset
+
+ for customizable parameters).
+ This will be output as is after all \SpecialChar LaTeX
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+Argument
\end_layout
\end_inset
- just means a fixed margin.
+s.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Manual
+LatexType
\end_layout
\end_inset
- means that the left margin depends on the string entered in the
-\begin_inset Flex Noun
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Edit\SpecialChar menuseparator
+
+\emph on
Paragraph
-\begin_inset space ~
+\emph default
+, Command, Environment, Item_Environment,
+\begin_inset Newline newline
\end_inset
-Settings
+List_Environment, Bib_Environment
\end_layout
\end_inset
- dialog.
- This is used to typeset nice lists without tabulators.
-\end_layout
+] How the style should be translated into \SpecialChar LaTeX
+.
+\begin_inset Foot
+status collapsed
-\begin_layout Description
+\begin_layout Plain Layout
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Dynamic
+LatexType
\end_layout
\end_inset
- means that the margin depends on the size of the label.
- This is used for automatic enumerated headlines.
- It is obvious that the headline
-\begin_inset Quotes eld
-\end_inset
+ is perhaps a bit misleading, since these rules apply to SGML classes, too.
+ Visit the SGML class files for specific examples.
+\end_layout
-5.4.3.2.1 Very long headline
-\begin_inset Quotes erd
\end_inset
- must have a wider left margin (as wide as
-\begin_inset Quotes eld
-\end_inset
-5.4.3.2.1
-\begin_inset Quotes erd
-\end_inset
+\end_layout
- plus the space) than
-\begin_inset Quotes eld
-\end_inset
-
-3.2 Very long headline
-\begin_inset Quotes erd
-\end_inset
+\begin_deeper
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-, even if standard
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+Paragraph
+\end_layout
-word processors
-\begin_inset Quotes erd
\end_inset
- are not able to do this.
+ means nothing special.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-First_Dynamic
+Command
\end_layout
\end_inset
- is similar, but only the very first row of the paragraph is dynamic, while
- the others are static; this is used, for example, for descriptions.
-\end_layout
-
-\begin_layout Description
+ means
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Right_Address_Box
+
+\backslash
+
+\emph on
+LatexName
+\emph default
+{\SpecialChar ldots
+}
\end_layout
\end_inset
- means the margin is chosen in a way that the longest row of this paragraph
- fits to the right margin.
- This is used to typeset an address on the right edge of the page.
+.
\end_layout
-\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NeedProtect
+Environment
\end_layout
\end_inset
- [
+ means
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+\backslash
+begin{
\emph on
-0
+LatexName
+\emph default
+}\SpecialChar ldots
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
+.
+
+\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Item_Environment
+\end_layout
+
+\end_inset
+ is the same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Environment
\end_layout
\end_inset
-] Whether fragile commands in this style should be
+, except that an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\backslash
-protect
+item
\end_layout
\end_inset
-'ed.
- (Note: This is
-\emph on
-not
-\emph default
- whether this command should itself be protected.)
-\change_inserted -712698321 1523696949
-
+ is generated for each paragraph of this environment.
+
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1523696969
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1523696950
-NeedCProtect
+List_Environment
\end_layout
\end_inset
- [
+ is the same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1523696950
-
-\emph on
-0
+Item_Environment
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+, except that
+\begin_inset Newline newline
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1523696950
-1
+LabelWidthString
\end_layout
\end_inset
-] This causes macros that contain this layout to be protected with
+ is passed as an argument to the environment.
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+LabelWidthString
+\end_layout
-\change_inserted -712698321 1523696950
+\end_inset
-\backslash
-cprotect
-\end_layout
+ can be defined in the
+\begin_inset Flex Noun
+status collapsed
+\begin_layout Plain Layout
+Edit\SpecialChar menuseparator
+Paragraph
+\begin_inset space ~
\end_inset
- (cf.
- package
-\family sans
-cprotect
-\family default
-) if necessary and thus allows (some) verbatim stuff in macros.
-\change_unchanged
+settings
+\end_layout
+\end_inset
+
+ dialog.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Newline
+Bib_Environment
\end_layout
\end_inset
- [
+ is like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Environment
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+ but adds the necessary mandatory argument (the longest label) to the begin
+ statement of the bibliography environment:
+\begin_inset Newline newline
\end_inset
\begin_layout Plain Layout
-\emph on
-1
+\backslash
+begin{thebibliography}{99}
\end_layout
\end_inset
-] Whether newlines are translated into \SpecialChar LaTeX
- newlines (
-\begin_inset Flex Code
-status collapsed
+.
+ It is therefore only useful for bibliography environments.
+ The default longest label
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+99
+\begin_inset Quotes erd
+\end_inset
-\backslash
+ can be changed by the user in the paragraph settings of a bibliography
+ item.
+\end_layout
+
+\begin_layout Standard
+Putting the last few things together, the \SpecialChar LaTeX
+ output will be either:
+\end_layout
+
+\begin_layout LyX-Code
\backslash
+LatexName[LatexParam]{\SpecialChar ldots
+}
+\end_layout
+\begin_layout Standard
+or:
\end_layout
-\end_inset
+\begin_layout LyX-Code
-) or not.
- The translation can be switched off to allow more comfortable \SpecialChar LaTeX
- editing
- inside \SpecialChar LyX
-.
+\backslash
+begin{LatexName}[LatexParam] \SpecialChar ldots
+
+\backslash
+end{LatexName}.
+\end_layout
+
+\begin_layout Standard
+depending upon the \SpecialChar LaTeX
+ type.
\end_layout
+\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NextNoIndent
+LeftDelim
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+string
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+] A string that is put at the beginning of the style content.
+ A line break in the output can be indicated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+<br/>
\end_layout
\end_inset
-] If set to true, and if
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DefaultStyle
+LeftMargin
\end_layout
\end_inset
- (usually
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Standard
+string=""
\end_layout
\end_inset
-) paragraphs are being indented, then the indentation of such a paragraph
- following one of this type will be suppressed.
- (So this will not affect the display of non-default paragraphs.)
-\end_layout
-
-\begin_layout Description
+] If you put styles into environments, the different
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ObsoletedBy
+LeftMargin
\end_layout
\end_inset
- [
+ are not simply added, but added with a factor
+\begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
+\end_inset
+
+.
+ Note that this parameter is also used when
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<name>
+Margin
\end_layout
\end_inset
-] Name of a style that has replaced this style.
- This is used to rename a style, while keeping backward compatibility.
-\end_layout
-
-\begin_layout Description
+ is defined as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ParagraphGroup
+Manual
\end_layout
\end_inset
- [
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Dynamic
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+.
+ Then it is added to the manual or dynamic margin.
+\begin_inset Newline newline
\end_inset
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-1
-\end_layout
-
+For example
+\begin_inset Quotes eld
\end_inset
-] Determines whether consecutive paragraphs of the same type are treated
- as belonging together.
- This has the effect that the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-GuiLabel
-\end_layout
-
-\end_inset
- is only printed once before such a group.
- By default, this is true for
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LaTeXType
+MM
\end_layout
\end_inset
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Environment
-\end_layout
+\begin_inset Quotes erd
\end_inset
- and
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Bib_Environment
-\end_layout
-
+ means that the paragraph is indented with the width of
+\begin_inset Quotes eld
\end_inset
- and false for all other types.
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ParbreakIsNewline
+MM
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-0
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
-\begin_inset space \thinspace{}
+ in the normal font.
+ You can get a negative width by prefixing the string with
+\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-1
+-
\end_layout
\end_inset
-] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
- output,
- but only by a line break; together with
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-PassThru 1
-\end_layout
+\begin_inset Quotes erd
\end_inset
-, this allows to emulate a plain text editor (like the ERT inset).
+.
+ This way was chosen so that the look is the same with each used screen
+ font.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ParIndent
+Margin
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+
+\emph on
+Static
+\emph default
+, Manual, Dynamic, First_Dynamic, Right_Address_Box
\end_layout
\end_inset
-] The indent of the very first line of a paragraph.
- The
+]
\begin_inset Newline newline
\end_inset
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Parindent
-\end_layout
-
-\end_inset
-
- will be fixed for a certain style.
- The exception is the default style, since the indentation for these paragraphs
- can be prohibited with
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-NextNoIndent
+The kind of margin that the style has on the left side.
\end_layout
-\end_inset
-
-.
- Also,
+\begin_deeper
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Standard
+Static
\end_layout
\end_inset
- style paragraphs inside environments use the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Parindent
+ just means a fixed margin.
\end_layout
-\end_inset
-
- of the environment, not their native one.
- For example,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Standard
+Manual
\end_layout
\end_inset
- paragraphs inside an enumeration are not indented.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
+ means that the left margin depends on the string entered in the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-ParSep
-\end_layout
-
+Edit\SpecialChar menuseparator
+Paragraph
+\begin_inset space ~
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-float=0
+Settings
\end_layout
\end_inset
-] The vertical space between two paragraphs of this style.
+ dialog.
+ This is used to typeset nice lists without tabulators.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Parskip
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-float=0
+Dynamic
\end_layout
\end_inset
-] \SpecialChar LyX
- allows the user to choose either
+ means that the margin depends on the size of the label.
+ This is used for automatic enumerated headlines.
+ It is obvious that the headline
\begin_inset Quotes eld
\end_inset
-indent
+5.4.3.2.1 Very long headline
\begin_inset Quotes erd
\end_inset
- or
+ must have a wider left margin (as wide as
\begin_inset Quotes eld
\end_inset
-skip
+5.4.3.2.1
\begin_inset Quotes erd
\end_inset
- to separate paragraphs.
- When
+ plus the space) than
\begin_inset Quotes eld
\end_inset
-indent
+3.2 Very long headline
\begin_inset Quotes erd
\end_inset
- is chosen,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Parskip
-\end_layout
-
-\end_inset
-
- is ignored.
- When
+, even if standard
\begin_inset Quotes eld
\end_inset
-skip
+word processors
\begin_inset Quotes erd
\end_inset
- is chosen,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-ParIndent
+ are not able to do this.
\end_layout
-\end_inset
-
- is ignored and all paragraphs are separated by the
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parskip
+First_Dynamic
\end_layout
\end_inset
- argument.
- The vertical space is calculated with
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Parskip
-\begin_inset space ~
-\end_inset
-
-* DefaultHeight
+ is similar, but only the very first row of the paragraph is dynamic, while
+ the others are static; this is used, for example, for descriptions.
\end_layout
-\end_inset
-
- where
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DefaultHeight
+Right_Address_Box
\end_layout
\end_inset
- is the height of a row with the normal font.
- This way, the look stays the same with different screen fonts.
+ means the margin is chosen in a way that the longest row of this paragraph
+ fits to the right margin.
+ This is used to typeset an address on the right edge of the page.
\end_layout
+\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru
+NeedProtect
\end_layout
\end_inset
\end_inset
-] Whether the contents of this paragraph should be output in raw form, meaning
- without special translations that \SpecialChar LaTeX
- would require.
-\end_layout
-
-\begin_layout Description
+] Whether fragile commands in this style should be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThruChars
-\end_layout
+
+\backslash
+protect
+\end_layout
\end_inset
- [
+'ed.
+ (Note: This is
+\emph on
+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
-string
-\end_layout
-\end_inset
+\change_inserted -712698321 1523696950
+NeedCProtect
+\change_unchanged
-]
-\family typewriter
-
-\family default
-Defines individual characters that should be output in raw form, meaning
- without special translations that \SpecialChar LaTeX
- would require.
\end_layout
-\begin_layout Description
+\end_inset
+
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preamble
+
+\change_inserted -712698321 1523696950
+
+\emph on
+0
+\change_unchanged
+
\end_layout
\end_inset
- Information to be included in the \SpecialChar LaTeX
- preamble when this style is used.
- Used to define macros, load packages, etc., required by this particular
- style.
- Must end with
-\begin_inset Quotes eld
+,
+\begin_inset space \thinspace{}
\end_inset
status collapsed
\begin_layout Plain Layout
-EndPreamble
+
+\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
-\begin_inset Quotes erd
\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
-RefPrefix
+
+\change_inserted -712698321 1552395561
+NeedMBoxProtect
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\change_inserted -712698321 1552395557
+
+\emph on
+0
+\change_unchanged
+
\end_layout
\end_inset
-] The prefix to use when creating labels referring to paragraphs of this
- type.
- This allows the use of formatted references.
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Requires
+
+\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
-string
+
+\change_inserted -712698321 1552395655
+
+\backslash
+cite
+\change_unchanged
+
\end_layout
\end_inset
-] Whether the style requires the feature
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-\end_inset
+\change_inserted -712698321 1552395661
- (see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "chap:List-of-functions"
+\backslash
+ref
+\change_unchanged
+
+\end_layout
\end_inset
- for the list of features).
- If you require a package with specific options, you can additionally use
-
+) should be protected in an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PackageOptions
-\end_layout
-\end_inset
+\change_inserted -712698321 1552395631
- as a general text class parameter (see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:General-text-class"
+\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
status collapsed
\begin_layout Plain Layout
-ResetArgs
+Newline
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
0
\end_layout
\end_inset
,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+
+\emph on
1
\end_layout
\end_inset
-] Resets the \SpecialChar LaTeX
- arguments of this style (as defined via the
+] Whether newlines are translated into \SpecialChar LaTeX
+ newlines (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
-\end_layout
-\end_inset
+\backslash
- tag).
- This is useful if you have copied a style via
-\begin_inset Flex Code
-status collapsed
+\backslash
-\begin_layout Plain Layout
-CopyStyle
\end_layout
\end_inset
-, but you do not want to inherit its (required and optional) arguments.
+) or not.
+ The translation can be switched off to allow more comfortable \SpecialChar LaTeX
+ editing
+ inside \SpecialChar LyX
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ResumeCounter
+NextNoIndent
\end_layout
\end_inset
\end_inset
,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\end_inset
-] Resumes a counter that is usually reset at each new sequence of layouts.
- This is currently only useful when
+] If set to true, and if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+DefaultStyle
\end_layout
\end_inset
- is
+ (usually
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Enumerate
+Standard
\end_layout
\end_inset
-.
+) paragraphs are being indented, then the indentation of such a paragraph
+ following one of this type will be suppressed.
+ (So this will not affect the display of non-default paragraphs.)
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-RightDelim
+ObsoletedBy
\end_layout
\end_inset
status collapsed
\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/>
+<name>
\end_layout
\end_inset
-.
+] Name of a style that has replaced this style.
+ This is used to rename a style, while keeping backward compatibility.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-RightMargin
+ParagraphGroup
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+0
\end_layout
\end_inset
-] Similar to
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+1
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+] Determines whether consecutive paragraphs of the same type are treated
+ as belonging together.
+ This has the effect that the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Spacing
+GuiLabel
\end_layout
\end_inset
- [
+ is only printed once before such a group.
+ By default, this is true for
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-single
+LaTeXType
\end_layout
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-onehalf
+Environment
\end_layout
\end_inset
-,
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-double
+Bib_Environment
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-other
-\begin_inset space ~
-\end_inset
-
-<value>
+ and false for all other types.
\end_layout
-\end_inset
-
-] This defines what the default spacing should be in the style.
- The arguments
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-single
+ParbreakIsNewline
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-onehalf
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-double
+\emph on
+0
\end_layout
\end_inset
- correspond respectively to a multiplier value of 1, 1.25 and 1.667.
- If you specify the argument
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-other
-\end_layout
-
+,
+\begin_inset space \thinspace{}
\end_inset
-, then you must also provide a value argument which will be the actual multiplie
-r value.
- Note that, contrary to other parameters,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Spacing
+1
\end_layout
\end_inset
- implies the generation of specific \SpecialChar LaTeX
- code, using the \SpecialChar LaTeX
- package
-\family roman
-
+] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
+ output,
+ but only by a line break; together with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-setspace
+PassThru 1
\end_layout
\end_inset
-.
+, this allows to emulate a plain text editor (like the ERT inset).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Spellcheck
+ParIndent
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-0
+string=""
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+] The indent of the very first line of a paragraph.
+ The
+\begin_inset Newline newline
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+Parindent
\end_layout
\end_inset
-] Allow spell-checking paragraphs of this style.
- Default is true.
-\end_layout
-
-\begin_layout Description
+ will be fixed for a certain style.
+ The exception is the default style, since the indentation for these paragraphs
+ can be prohibited with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-StepMasterCounter
+NextNoIndent
\end_layout
\end_inset
- [
+.
+ Also,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Standard
\end_layout
\end_inset
-,
+ style paragraphs inside environments use the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Parindent
\end_layout
\end_inset
-] Steps the master counter of a given counter at the beginning of a new
- sequence of layouts.
- This is currently only useful when
+ of the environment, not their native one.
+ For example,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+Standard
\end_layout
\end_inset
- is
+ paragraphs inside an enumeration are not indented.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Enumerate
+ParSep
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TextFont
+float=0
\end_layout
\end_inset
- The font used for the text body .
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
-
-\end_inset
-
-.
+] The vertical space between two paragraphs of this style.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TocLevel
+Parskip
\end_layout
\end_inset
-
-\series medium
[
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\series medium
-int=3
+float=0
\end_layout
\end_inset
-]
-\series default
- The level of the style in the table of contents.
- This is used for automatic numbering of section headings.
-\end_layout
+] \SpecialChar LyX
+ allows the user to choose either
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Description
+indent
+\begin_inset Quotes erd
+\end_inset
+
+ or
+\begin_inset Quotes eld
+\end_inset
+
+skip
+\begin_inset Quotes erd
+\end_inset
+
+ to separate paragraphs.
+ When
+\begin_inset Quotes eld
+\end_inset
+
+indent
+\begin_inset Quotes erd
+\end_inset
+
+ is chosen,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ToggleIndent
+Parskip
\end_layout
\end_inset
- [
-\emph on
+ is ignored.
+ When
+\begin_inset Quotes eld
+\end_inset
+
+skip
+\begin_inset Quotes erd
+\end_inset
+ is chosen,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-default
+ParIndent
\end_layout
\end_inset
-
-\emph default
-,
+ is ignored and all paragraphs are separated by the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-always
+Parskip
\end_layout
\end_inset
-,
+ argument.
+ The vertical space is calculated with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-never
+Parskip
+\begin_inset space ~
+\end_inset
+
+* DefaultHeight
\end_layout
\end_inset
-] This tag determines whether the first line indentation of this paragraph
- can be toggled via the Paragraph settings dialog.
- If
-\emph on
-
+ where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph off
-default
+DefaultHeight
\end_layout
\end_inset
+ is the height of a row with the normal font.
+ This way, the look stays the same with different screen fonts.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\emph default
- is set, indentation can be toggled if the document settings use
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+PassThru
+\end_layout
-indent
-\begin_inset Quotes erd
\end_inset
- paragraph style, with
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-always
+
+\emph on
+0
\end_layout
\end_inset
-, indentation can always be toggled, notwithstanding the document settings,
- with
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-never
+1
\end_layout
\end_inset
-, indentation can never be toggled.
+] Whether the contents of this paragraph should be output in raw form, meaning
+ without special translations that \SpecialChar LaTeX
+ would require.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TopSep
+PassThruChars
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-float=0
+string
\end_layout
\end_inset
-] The vertical space with which the very first of a chain of paragraphs
- with this style is separated from the previous paragraph.
- If the previous paragraph has another style, the separations are not simply
- added, but the maximum is taken.
+]
+\family typewriter
+
+\family default
+Defines individual characters that should be output in raw form, meaning
+ without special translations that \SpecialChar LaTeX
+ would require.
\end_layout
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:I18n"
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Preamble
+\end_layout
\end_inset
-Internationalization of Paragraph Styles
+ Information to be included in the \SpecialChar LaTeX
+ preamble when this style is used.
+ Used to define macros, load packages, etc., required by this particular
+ style.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndPreamble
\end_layout
-\begin_layout Standard
-\SpecialChar LyX
- has long supported internationalization of layout information, but, until
- version 2.0, this applied only to the user interface and not to, say, PDF
- output.
- Thus, French authors were forced to resort to ugly hacks if they wanted
- `
-\lang french
-Théorème
-\lang english
- 1' instead of `Theorem 1'.
- Thanks to Georg Baum, that is no longer the case.
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout Standard
-If a
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Style
+RefPrefix
\end_layout
\end_inset
- defines text that is to appear in the typeset document, it may use
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+string
\end_layout
\end_inset
- and
+] The prefix to use when creating labels referring to paragraphs of this
+ type.
+ This allows the use of formatted references.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+Requires
\end_layout
\end_inset
- to support non-English and even multi-language documents correctly.
- The following excerpt (from the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-theorems-ams.inc
+string
\end_layout
\end_inset
- file) shows how this works:
-\end_layout
+] Whether the style requires the feature
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-Preamble
+\begin_layout Plain Layout
+string
\end_layout
-\begin_deeper
-\begin_layout LyX-Code
-
-\backslash
-theoremstyle{remark}
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-
-\backslash
-newtheorem{claim}[thm]{
-\backslash
-protect
-\backslash
-claimname}
-\end_layout
+ (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:List-of-functions"
-\begin_layout LyX-Code
-EndPreamble
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-LangPreamble
-\end_layout
+ for the list of features).
+ If you require a package with specific options, you can additionally use
+
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-
-\backslash
-providecommand{
-\backslash
-claimname}{_(Claim)}
+\begin_layout Plain Layout
+PackageOptions
\end_layout
-\begin_layout LyX-Code
-EndLangPreamble
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-BabelPreamble
-\end_layout
+ as a general text class parameter (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:General-text-class"
-\begin_layout LyX-Code
-
-\backslash
-addto
-\backslash
-captions$$lang{
-\backslash
-renewcommand{
-\backslash
-claimname}{_(Claim)}}
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-EndBabelPreamble
+).
\end_layout
-\end_deeper
-\begin_layout Standard
-In principle, any legal \SpecialChar LaTeX
- may appear in the
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+ResetArgs
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+
+\emph on
+0
\end_layout
\end_inset
- tags, but in practice they will typically look as they do here.
- The key to correct translation of the typeset text is the definition of
- the \SpecialChar LaTeX
- command
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-claimname
+1
\end_layout
\end_inset
- and its use in
+] Resets the \SpecialChar LaTeX
+ arguments of this style (as defined via the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+Argument
+\end_layout
-\backslash
-newtheorem
+\end_inset
+
+ tag).
+ This is useful if you have copied a style via
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CopyStyle
\end_layout
\end_inset
-.
-
+, but you do not want to inherit its (required and optional) arguments.
\end_layout
-\begin_layout Standard
-The
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+ResumeCounter
\end_layout
\end_inset
- tag provides for internationalization based upon the overall language of
- the document.
- The contents of the tag will be included in the preamble, just as with
- the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preamble
+
+\emph on
+0
\end_layout
\end_inset
- tag.
- What makes it special is the use of the
-\begin_inset Quotes eld
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
-function
-\begin_inset Quotes erd
\end_inset
-
+] Resumes a counter that is usually reset at each new sequence of layouts.
+ This is currently only useful when
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-_()
+LabelType
\end_layout
\end_inset
-, which will be replaced, when \SpecialChar LyX
- produces \SpecialChar LaTeX
- output, with the translation of
- its argument into the document language.
-\end_layout
-
-\begin_layout Standard
-The
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+Enumerate
\end_layout
\end_inset
- tag is more complex, since it is meant to provide support for multi-language
- documents and so offers an interface to the
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-babel
+RightDelim
\end_layout
\end_inset
- package.
- Its contents will be added to the preamble once for each language that
- appears in the document.
- In this case, the argument to
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-_()
+string
\end_layout
\end_inset
- will be replaced with its translation into the language in question; the
- expression
+] 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
-$$lang
+<br/>
\end_layout
\end_inset
- is replaced by the language name (as used by the babel package).
+.
\end_layout
-\begin_layout Standard
-A German document that also included a French section would thus have the
- following in the preamble:
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-addto
-\backslash
-captionsfrench{
-\backslash
-renewcommand{
-\backslash
-claimname}{Affirmation}}
-\begin_inset Newline newline
-\end_inset
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+RightMargin
+\end_layout
-\backslash
-addto
-\backslash
-captionsngerman{
-\backslash
-renewcommand{
-\backslash
-claimname}{Behauptung}}
-\begin_inset Newline newline
\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
-\backslash
-providecommand{
-\backslash
-claimname}{Behauptung}
+\begin_layout Plain Layout
+string=""
\end_layout
-\begin_layout Standard
-\SpecialChar LaTeX
- and
+\end_inset
+
+] Similar to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-babel
+LeftMargin
\end_layout
\end_inset
- will then conspire to produce the correct text in the output.
+.
\end_layout
-\begin_layout Standard
-One important point to note here is that the translations are provided by
- \SpecialChar LyX
- itself, through the file
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-layouttranslations
+Spacing
\end_layout
\end_inset
-.
- This means, in effect, that
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+
+\emph on
+single
\end_layout
\end_inset
- and
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+onehalf
\end_layout
\end_inset
- are really only of use in layout files that are provided with \SpecialChar LyX
-, since text
- entered in user-created layout files will not be seen by \SpecialChar LyX
-'s internationalizatio
-n routines unless the
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-layouttranslations
+double
\end_layout
\end_inset
- file is modified accordingly.
- That said, however, any layout created with the intention that it will
- be included with \SpecialChar LyX
- should use these tags where appropriate.
- Please note that the paragraph style translations provided by \SpecialChar LyX
- will never
- change with a minor update (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-from version 2.1.x to 2.1.y).
- It is however quite likely that a major update (e.
-\begin_inset space \thinspace{}
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
-g.
-\begin_inset space \space{}
+\begin_layout Plain Layout
+other
+\begin_inset space ~
\end_inset
-from 2.0.x to 2.1.0) will introduce new translations or corrections.
+<value>
\end_layout
-\begin_layout Subsection
-Floats
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Floats"
-
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-It is necessary to define the floats (
-\begin_inset Flex Noun
+] This defines what the default spacing should be in the style.
+ The arguments
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-figure
+single
\end_layout
\end_inset
,
-\begin_inset Flex Noun
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-table
+onehalf
\end_layout
\end_inset
-, \SpecialChar ldots
-) in the text class itself.
- Standard floats are included in the file
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdfloats.inc
+double
\end_layout
\end_inset
-, so you may have to do no more than add
-\end_layout
-
-\begin_layout LyX-Code
-Input stdfloats.inc
-\end_layout
-
-\begin_layout Standard
-to your layout file.
- If you want to implement a text class that proposes some other float types
- (like the AGU class bundled with \SpecialChar LyX
-), the information below will hopefully
- help you:
-\end_layout
-
-\begin_layout Description
+ correspond respectively to a multiplier value of 1, 1.25 and 1.667.
+ If you specify the argument
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AllowedPlacement
+other
\end_layout
\end_inset
- [
+, then you must also provide a value argument which will be the actual multiplie
+r value.
+ Note that, contrary to other parameters,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Spacing
\end_layout
\end_inset
-=!htbpH] Allowed placement options for this float type.
- The value is a string of placement characters.
- Possible characters include:
-\emph on
-h
-\emph default
- (
-\begin_inset Quotes eld
-\end_inset
-
-here if possible
-\begin_inset Quotes erd
-\end_inset
-
-),
-\emph on
-t
-\emph default
- (
-\begin_inset Quotes eld
-\end_inset
-
-top of page
-\begin_inset Quotes erd
-\end_inset
-
-),
-\emph on
-b
-\emph default
- (
-\begin_inset Quotes eld
-\end_inset
-
-bottom of page
-\begin_inset Quotes erd
-\end_inset
-
-),
-\emph on
-p
-\emph default
- (
-\begin_inset Quotes eld
-\end_inset
-
-page of floats
-\begin_inset Quotes erd
-\end_inset
-
-),
-\emph on
-H
-\emph default
- (
-\begin_inset Quotes eld
-\end_inset
+ implies the generation of specific \SpecialChar LaTeX
+ code, using the \SpecialChar LaTeX
+ package
+\family roman
-here definitely
-\begin_inset Quotes erd
-\end_inset
+\begin_inset Flex Code
+status collapsed
-) and
-\emph on
-!
-\emph default
- (
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+setspace
+\end_layout
-ignore LaTeX rules
-\begin_inset Quotes erd
\end_inset
-).
- The order of the characters in the string does not matter.
- If no placement options are allowed, use the string
-\emph on
-none
-\emph default
.
\end_layout
status collapsed
\begin_layout Plain Layout
-AllowsSideways
+Spellcheck
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph off
0
\end_layout
\end_inset
-\emph on
-
\begin_inset Flex Code
status collapsed
\end_inset
+] Allow spell-checking paragraphs of this style.
+ Default is true.
+\end_layout
-\emph default
-] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
--package
-\family typewriter
-rotfloat
-\family default
- (sidewaysfloat).
- Set to
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
-\end_layout
-
-\end_inset
-
- if the float does not support this feature.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-AllowsWide
+StepMasterCounter
\end_layout
\end_inset
\begin_layout Plain Layout
-\emph off
+\emph on
0
\end_layout
\end_inset
,
-\begin_inset space \thinspace{}
-\end_inset
-
-
-\emph on
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
1
\end_layout
\end_inset
-
-\emph default
-] Defines whether the float has a starred variant that spans columns in
- a two column paragraph.
- Set to
+] Steps the master counter of a given counter at the beginning of a new
+ sequence of layouts.
+ This is currently only useful when
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+LabelType
\end_layout
\end_inset
- if the float does not support this feature.
-\end_layout
-
-\begin_layout Description
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Extension
+Enumerate
\end_layout
\end_inset
- [
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+TextFont
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
+ The font used for the text body .
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
-\begin_inset Quotes erd
\end_inset
-] The file name extension of an auxiliary file for the list of figures (or
- whatever).
- \SpecialChar LaTeX
- writes the captions to this file.
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-GuiName
+TocLevel
\end_layout
\end_inset
+
+\series medium
[
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-
-\end_inset
-
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The string that will be used in the menus and also for the caption.
- This is translated to the current language if babel is used.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-HTML*
+\series medium
+int=3
\end_layout
\end_inset
- These tags control the XHTML output.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Tags-for-XHTML"
-
-\end_inset
-
-.
+]
+\series default
+ The level of the style in the table of contents.
+ This is used for automatic numbering of section headings.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-IsPredefined
+ToggleIndent
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-0
+
+\emph on
+default
\end_layout
\end_inset
\emph default
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+always
\end_layout
\end_inset
-] Indicates whether the float is already defined in the document class or
- if instead the \SpecialChar LaTeX
- package
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float
+never
\end_layout
\end_inset
- needs to be loaded to define it on-the-fly.
- The default is
+] This tag determines whether the first line indentation of this paragraph
+ can be toggled via the Paragraph settings dialog.
+ If
+\emph on
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+
+\emph off
+default
\end_layout
\end_inset
-, which means:
+
+\emph default
+ is set, indentation can be toggled if the document settings use
+\begin_inset Quotes eld
+\end_inset
+
+indent
+\begin_inset Quotes erd
+\end_inset
+
+ paragraph style, with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float
+always
\end_layout
\end_inset
- is used.
- It should be set to
+, indentation can always be toggled, notwithstanding the document settings,
+ with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+never
\end_layout
\end_inset
- if the float is already defined by the \SpecialChar LaTeX
- document class.
+, indentation can never be toggled.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ListCommand
+TopSep
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+float=0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+] The vertical space with which the very first of a chain of paragraphs
+ with this style is separated from the previous paragraph.
+ If the previous paragraph has another style, the separations are not simply
+ added, but the maximum is taken.
+\end_layout
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:I18n"
-\begin_inset Quotes erd
\end_inset
-] The command used to generate a list of floats of this type; the leading
+Internationalization of Paragraph Styles
+\end_layout
+
+\begin_layout Standard
+\SpecialChar LyX
+ has long supported internationalization of layout information, but, until
+ version 2.0, this applied only to the user interface and not to, say, PDF
+ output.
+ Thus, French authors were forced to resort to ugly hacks if they wanted
`
-\backslash
-' must be omitted.
- This
-\emph on
-must
-\emph default
- be given if
+\lang french
+Théorème
+\lang english
+ 1' instead of `Theorem 1'.
+ Thanks to Georg Baum, that is no longer the case.
+\end_layout
+
+\begin_layout Standard
+If a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UsesFloatPkg
+Style
\end_layout
\end_inset
- is false, since there is no standard way to generate this command.
- It is ignored if
+ defines text that is to appear in the typeset document, it may use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UsesFloatPkg
+LangPreamble
\end_layout
\end_inset
- is true, since in that case there is a standard way to define the command.
-\end_layout
-
-\begin_layout Description
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ListName
+BabelPreamble
\end_layout
\end_inset
- [
+ to support non-English and even multi-language documents correctly.
+ The following excerpt (from the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+theorems-ams.inc
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] A title for a list of floats of this kind (list of figures, tables, or
- whatever).
- It is used for the screen label within \SpecialChar LyX
-, it is used by \SpecialChar LaTeX
- for the title and
- it is used as the title in the XHTML output.
- It will be translated to the document language.
+ file) shows how this works:
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-NumberWithin
+\begin_layout LyX-Code
+Preamble
\end_layout
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-string
+\begin_deeper
+\begin_layout LyX-Code
+
+\backslash
+theoremstyle{remark}
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
+newtheorem{claim}[thm]{
+\backslash
+protect
+\backslash
+claimname}
+\end_layout
-=
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
+EndPreamble
+\end_layout
+\begin_layout LyX-Code
+LangPreamble
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
+providecommand{
+\backslash
+claimname}{_(Claim)}
+\end_layout
-] This (optional) argument determines whether floats of this class will
- be numbered within some sectional unit of the document.
- For example, if
+\begin_layout LyX-Code
+EndLangPreamble
+\end_layout
+
+\begin_layout LyX-Code
+BabelPreamble
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+addto
+\backslash
+captions$$lang{
+\backslash
+renewcommand{
+\backslash
+claimname}{_(Claim)}}
+\end_layout
+
+\begin_layout LyX-Code
+EndBabelPreamble
+\end_layout
+
+\end_deeper
+\begin_layout Standard
+In principle, any legal \SpecialChar LaTeX
+ may appear in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NumberWithin
+LangPreamble
\end_layout
\end_inset
- is set to
-\begin_inset Quotes eld
-\end_inset
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+BabelPreamble
+\end_layout
+\end_inset
+ tags, but in practice they will typically look as they do here.
+ The key to correct translation of the typeset text is the definition of
+ the \SpecialChar LaTeX
+ command
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-chapter
+
+\backslash
+claimname
\end_layout
\end_inset
+ and its use in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+newtheorem
+\end_layout
-\begin_inset Quotes erd
\end_inset
-, the floats will be numbered within chapters.
+.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Placement
+LangPreamble
\end_layout
\end_inset
- [
+ tag provides for internationalization based upon the overall language of
+ the document.
+ The contents of the tag will be included in the preamble, just as with
+ the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Preamble
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+ tag.
+ What makes it special is the use of the
+\begin_inset Quotes eld
\end_inset
-
+function
\begin_inset Quotes erd
\end_inset
-] The default placement for the given class of floats.
- The string should be as in standard \SpecialChar LaTeX
-:
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-t
+_()
\end_layout
\end_inset
-,
+, which will be replaced, when \SpecialChar LyX
+ produces \SpecialChar LaTeX
+ output, with the translation of
+ its argument into the document language.
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-b
+BabelPreamble
\end_layout
\end_inset
-,
+ tag is more complex, since it is meant to provide support for multi-language
+ documents and so offers an interface to the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-p
+babel
\end_layout
\end_inset
- and
+ package.
+ Its contents will be added to the preamble once for each language that
+ appears in the document.
+ In this case, the argument to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-h
+_()
\end_layout
\end_inset
- for top, bottom, page, and here, respectively.
-\begin_inset Foot
+ will be replaced with its translation into the language in question; the
+ expression
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that the order of these letters in the string is irrelevant, like in
- \SpecialChar LaTeX
-.
+$$lang
\end_layout
\end_inset
- On top of that there is a new type,
-\begin_inset Flex Code
-status collapsed
+ is replaced by the language name (as used by the babel package).
+\end_layout
-\begin_layout Plain Layout
-H
+\begin_layout Standard
+A German document that also included a French section would thus have the
+ following in the preamble:
\end_layout
-\end_inset
+\begin_layout LyX-Code
-, which does not really correspond to a float, since it means: put it
-\begin_inset Quotes eld
+\backslash
+addto
+\backslash
+captionsfrench{
+\backslash
+renewcommand{
+\backslash
+claimname}{Affirmation}}
+\begin_inset Newline newline
\end_inset
-here
-\begin_inset Quotes erd
+
+\backslash
+addto
+\backslash
+captionsngerman{
+\backslash
+renewcommand{
+\backslash
+claimname}{Behauptung}}
+\begin_inset Newline newline
\end_inset
- and nowhere else.
- Note however that the
+
+\backslash
+providecommand{
+\backslash
+claimname}{Behauptung}
+\end_layout
+
+\begin_layout Standard
+\SpecialChar LaTeX
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-H
+babel
\end_layout
\end_inset
- specifier is special and, because of implementation details, cannot be
- used in non-built in float types.
- If you do not understand what this means, just use
-\begin_inset Quotes eld
-\end_inset
-
+ will then conspire to produce the correct text in the output.
+\end_layout
+\begin_layout Standard
+One important point to note here is that the translations are provided by
+ \SpecialChar LyX
+ itself, through the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tbp
+layouttranslations
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
.
-\end_layout
-
-\begin_layout Description
+ This means, in effect, that
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RefPrefix
+LangPreamble
\end_layout
\end_inset
- [
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+BabelPreamble
\end_layout
\end_inset
-] The prefix to use when creating labels referring to floats of this type.
- This allows the use of formatted references.
- Note that you can remove any
+ are really only of use in layout files that are provided with \SpecialChar LyX
+, since text
+ entered in user-created layout files will not be seen by \SpecialChar LyX
+'s internationalizatio
+n routines unless the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RefPrefix
+layouttranslations
\end_layout
\end_inset
- set by a copied style by using the special value
-\begin_inset Quotes eld
+ file is modified accordingly.
+ That said, however, any layout created with the intention that it will
+ be included with \SpecialChar LyX
+ should use these tags where appropriate.
+ Please note that the paragraph style translations provided by \SpecialChar LyX
+ will never
+ change with a minor update (e.
+\begin_inset space \thinspace{}
\end_inset
-OFF
-\begin_inset Quotes erd
+g.
+\begin_inset space \space{}
\end_inset
-, which must be all caps.
-\end_layout
+from version 2.1.x to 2.1.y).
+ It is however quite likely that a major update (e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Plain Layout
-Style
+from 2.0.x to 2.1.0) will introduce new translations or corrections.
\end_layout
+\begin_layout Subsection
+Floats
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Floats"
+
\end_inset
- [
-\begin_inset Flex Code
+
+\end_layout
+
+\begin_layout Standard
+It is necessary to define the floats (
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-string
+figure
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+,
+\begin_inset Flex Noun
+status collapsed
+\begin_layout Plain Layout
+table
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] The style used when defining the float using
+, \SpecialChar ldots
+) in the text class itself.
+ Standard floats are included in the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-newfloat
+stdfloats.inc
\end_layout
\end_inset
-.
+, so you may have to do no more than add
+\end_layout
+
+\begin_layout LyX-Code
+Input stdfloats.inc
+\end_layout
+
+\begin_layout Standard
+to your layout file.
+ If you want to implement a text class that proposes some other float types
+ (like the AGU class bundled with \SpecialChar LyX
+), the information below will hopefully
+ help you:
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Type
+AllowedPlacement
\end_layout
\end_inset
\end_inset
-=
-\begin_inset Quotes erd
+=!htbpH] Allowed placement options for this float type.
+ The value is a string of placement characters.
+ Possible characters include:
+\emph on
+h
+\emph default
+ (
+\begin_inset Quotes eld
\end_inset
-
+here if possible
\begin_inset Quotes erd
\end_inset
-] The
+),
+\emph on
+t
+\emph default
+ (
\begin_inset Quotes eld
\end_inset
-type
+top of page
\begin_inset Quotes erd
\end_inset
- of the new class of floats, like program or algorithm.
- After the appropriate
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-newfloat
-\end_layout
-
+),
+\emph on
+b
+\emph default
+ (
+\begin_inset Quotes eld
\end_inset
-, commands such as
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
+bottom of page
+\begin_inset Quotes erd
+\end_inset
-\backslash
-begin{program}
-\end_layout
+),
+\emph on
+p
+\emph default
+ (
+\begin_inset Quotes eld
+\end_inset
+page of floats
+\begin_inset Quotes erd
\end_inset
- or
-\begin_inset Flex Code
-status collapsed
+),
+\emph on
+H
+\emph default
+ (
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+here definitely
+\begin_inset Quotes erd
+\end_inset
-\backslash
-end{algorithm*}
-\end_layout
+) and
+\emph on
+!
+\emph default
+ (
+\begin_inset Quotes eld
+\end_inset
+ignore LaTeX rules
+\begin_inset Quotes erd
\end_inset
- will be available.
+).
+ The order of the characters in the string does not matter.
+ If no placement options are allowed, use the string
+\emph on
+none
+\emph default
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-UsesFloatPkg
+AllowsSideways
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\emph off
0
\end_layout
\end_inset
+\emph on
+
\begin_inset Flex Code
status collapsed
\end_inset
-] Specifies whether this float is defined using the \SpecialChar LaTeX
- package
+
+\emph default
+] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
+-package
+\family typewriter
+rotfloat
+\family default
+ (sidewaysfloat).
+ Set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float
+0
\end_layout
\end_inset
-, either by the class file, another package or on-the-fly by \SpecialChar LyX
- itself.
+ if the float does not support this feature.
\end_layout
-\begin_layout Standard
-Note that defining a float with type
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-type
+AllowsWide
\end_layout
\end_inset
- automatically defines the corresponding counter with name
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-type
+\emph off
+0
\end_layout
\end_inset
-.
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Subsection
-Flex insets and InsetLayout
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Flex-insets-and"
-\end_inset
+\emph on
+\begin_inset Flex Code
+status collapsed
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Standard
-Flex insets come in three different kinds:
+\emph on
+1
\end_layout
-\begin_layout Itemize
-character style (
+\end_inset
+
+
+\emph default
+] Defines whether the float has a starred variant that spans columns in
+ a two column paragraph.
+ Set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CharStyle
+0
\end_layout
\end_inset
-): These define semantic markup corresponding to such \SpecialChar LaTeX
- commands as
+ if the float does not support this feature.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-noun
+Extension
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-code
+string
\end_layout
\end_inset
-.
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] The file name extension of an auxiliary file for the list of figures (or
+ whatever).
+ \SpecialChar LaTeX
+ writes the captions to this file.
\end_layout
-\begin_layout Itemize
-user custom (
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Custom
+GuiName
\end_layout
\end_inset
-): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
- code,
- footnote, and the like.
- An obvious example is an endnote inset, which is defined in the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-endnote
+string
\end_layout
\end_inset
- module.
-\end_layout
-
-\begin_layout Itemize
-XML elements (
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Element
-\end_layout
+\begin_inset Quotes erd
\end_inset
-): For use with DocBook classes.
+] The string that will be used in the menus and also for the caption.
+ This is translated to the current language if babel is used.
\end_layout
-\begin_layout Standard
-Flex insets are defined using the
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+HTML*
\end_layout
\end_inset
- tag, which shall be explained in a moment.
-\end_layout
+ These tags control the XHTML output.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Tags-for-XHTML"
-\begin_layout Standard
-The
-\begin_inset Flex Code
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-InsetLayout
+.
\end_layout
-\end_inset
-
- tag also serves another function: It can be used to customize the general
- layout of many different types of insets.
- Currently,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+IsPredefined
\end_layout
\end_inset
- can be used to customize the layout parameters for footnotes, marginal
- notes, note insets, \SpecialChar TeX
- code (ERT) insets, branches, listings, indexes, boxes,
- tables, algorithms, URLs, and captions, as well as to define Flex insets.
-\end_layout
+ [
+\emph on
-\begin_layout Standard
-The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+0
\end_layout
\end_inset
- definition must begin with a line of the form:
-\end_layout
-\begin_layout LyX-Code
-InsetLayout <type>
-\end_layout
+\emph default
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\begin_layout Standard
-Here
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+1
\end_layout
\end_inset
- indicates the inset whose layout is being defined, and here there are four
- cases.
-\end_layout
-
-\begin_layout Enumerate
-The layout for a pre-existing inset is being modified.
- In this case, can be
+] Indicates whether the float is already defined in the document class or
+ if instead the \SpecialChar LaTeX
+ package
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+float
\end_layout
\end_inset
- any one of the following:
+ needs to be loaded to define it on-the-fly.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Algorithm
+0
\end_layout
\end_inset
-,
+, which means:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Branch
+float
\end_layout
\end_inset
-,
+ is used.
+ It should be set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box
+1
\end_layout
\end_inset
-,
+ if the float is already defined by the \SpecialChar LaTeX
+ document class.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box:shaded
+ListCommand
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Caption:Standard
+string
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-ERT
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
+] The command used to generate a list of floats of this type; the leading
+ `
+\backslash
+' must be omitted.
+ This
+\emph on
+must
+\emph default
+ be given if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Figure
+UsesFloatPkg
\end_layout
\end_inset
-,
+ is false, since there is no standard way to generate this command.
+ It is ignored if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Foot
+UsesFloatPkg
\end_layout
\end_inset
-,
+ is true, since in that case there is a standard way to define the command.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Index
+ListName
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info
+string
\end_layout
\end_inset
-,
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] A title for a list of floats of this kind (list of figures, tables, or
+ whatever).
+ It is used for the screen label within \SpecialChar LyX
+, it is used by \SpecialChar LaTeX
+ for the title and
+ it is used as the title in the XHTML output.
+ It will be translated to the document language.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:menu
+NumberWithin
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:shortcut
+string
\end_layout
\end_inset
-,
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] This (optional) argument determines whether floats of this class will
+ be numbered within some sectional unit of the document.
+ For example, if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:shortcuts
+NumberWithin
\end_layout
\end_inset
-,
+ is set to
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Listings
+chapter
\end_layout
\end_inset
-,
+
+\begin_inset Quotes erd
+\end_inset
+
+, the floats will be numbered within chapters.
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Marginal
+Placement
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note:Comment
+string
\end_layout
\end_inset
-,
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] The default placement for the given class of floats.
+ The string should be as in standard \SpecialChar LaTeX
+:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note:Note
+t
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Note:Greyedout
+b
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Table
+p
\end_layout
\end_inset
-, or
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-URL
+h
\end_layout
\end_inset
+ for top, bottom, page, and here, respectively.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Note that the order of these letters in the string is irrelevant, like in
+ \SpecialChar LaTeX
.
\end_layout
-\begin_layout Enumerate
-The layout for a Flex inset is being defined.
- In this case,
+\end_inset
+
+ On top of that there is a new type,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+H
\end_layout
\end_inset
- must be of the form
+, which does not really correspond to a float, since it means: put it
\begin_inset Quotes eld
\end_inset
+here
+\begin_inset Quotes erd
+\end_inset
+ and nowhere else.
+ Note however that the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Flex:<name>
+H
\end_layout
\end_inset
-
-\begin_inset Quotes erd
+ specifier is special and, because of implementation details, cannot be
+ used in non-built in float types.
+ If you do not understand what this means, just use
+\begin_inset Quotes eld
\end_inset
-, where
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-name
-\end_layout
-
-\end_inset
- may be be any valid identifier not used by a pre-existing Flex inset.
- The identifier may include spaces, but in that case the whole thing must
- be wrapped in quotes.
- Note that the definition of a flex inset
-\emph on
-must
-\emph default
-also include a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXType
+tbp
\end_layout
\end_inset
- entry, declaring which type of inset it defines.
-\end_layout
-
-\begin_layout Enumerate
-The layout for user specific branch is being defined.
- In this case,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<Type>
-\end_layout
-
-\end_inset
- must be of the form
-\begin_inset Quotes eld
+\begin_inset Quotes erd
\end_inset
+.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Branch:<name>
+RefPrefix
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-, where
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-name
+string
\end_layout
\end_inset
- may be be any valid identifier of branch defined in user's document.
- The identifier may include spaces, but in that case the whole thing must
- be wrapped in quotes.
- The main purpose of this feature is to allow \SpecialChar LaTeX
- wrapping around specific
- branches as user needs.
-\end_layout
-
-\begin_layout Enumerate
-The layout of a user (or class) specific caption is being defined.
- In this case,
+] The prefix to use when creating labels referring to floats of this type.
+ This allows the use of formatted references.
+ Note that you can remove any
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+RefPrefix
\end_layout
\end_inset
- must be of the form
+ set by a copied style by using the special value
\begin_inset Quotes eld
\end_inset
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Caption:<name>
-\end_layout
-
-\end_inset
-
-
+OFF
\begin_inset Quotes erd
\end_inset
-, where
-\begin_inset Flex Code
-status collapsed
+, which must be all caps.
+\change_inserted -712698321 1565605014
-\begin_layout Plain Layout
-name
\end_layout
-\end_inset
+\begin_layout Description
- specifies the name of the caption as it appears in the menu.
- Have a look at the standard caption (
+\change_inserted -712698321 1565605014
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Caption:Standard
-\end_layout
-
-\end_inset
-), the specific captions of the KOMA-Script classes (
-\begin_inset Flex Code
-status collapsed
+\change_inserted -712698321 1565605014
+Requires
+\change_unchanged
-\begin_layout Plain Layout
-Caption:Above
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Caption:Below
+
+\change_inserted -712698321 1565605014
+string
+\change_unchanged
+
\end_layout
\end_inset
-) or the module
-\family sans
-Multilingual
-\begin_inset space ~
-\end_inset
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
-Captions
-\begin_inset Newline linebreak
\end_inset
+.
+\change_unchanged
+
+\end_layout
-\family default
-(
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Caption:Bicaption
+Style
\end_layout
\end_inset
-) for applications.
-\end_layout
-
-\begin_layout Standard
-The
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+string
\end_layout
\end_inset
- definition can contain the following entries:
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-AddToToc
-\end_layout
+\begin_inset Quotes erd
\end_inset
- [
+] The style used when defining the float using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\backslash
+newfloat
\end_layout
\end_inset
-=""] This inset will appear in the table of contents of the given type.
- An empty string disables.
- See also the OutlinerName and the IsTocCaption commands.
- This is only implemented for Flex insets.
- Default: disabled.
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Argument
+Type
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-int
+string
\end_layout
\end_inset
-] Defines argument number of a command\SpecialChar breakableslash
-environment associated with the current
- layout.
- The definition must end with
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-EndArgument
-\end_layout
+\begin_inset Quotes erd
\end_inset
-.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
-
+] The
+\begin_inset Quotes eld
\end_inset
- for details.
-\end_layout
+type
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Description
+ of the new class of floats, like program or algorithm.
+ After the appropriate
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
-\end_layout
-
-\end_inset
- Preamble for changing language commands; see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:I18n"
+\backslash
+newfloat
+\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+, commands such as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BgColor
+
+\backslash
+begin{program}
\end_layout
\end_inset
- [
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<name>
-\end_layout
-
-\end_inset
-] The color for the inset's background.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "chap:Names-of-colors"
+\backslash
+end{algorithm*}
+\end_layout
\end_inset
- for a list of the available color names.
+ will be available.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ContentAsLabel
+UsesFloatPkg
\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
-] Whether to use the content of the inset as the label, when the inset is
- closed.
- Default is false.
-\end_layout
-
-\begin_layout Description
+] Specifies whether this float is defined using the \SpecialChar LaTeX
+ package
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+float
\end_layout
\end_inset
- [
+, either by the class file, another package or on-the-fly by \SpecialChar LyX
+ itself.
+\end_layout
+
+\begin_layout Standard
+Note that defining a float with type
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<type>
+
+\emph on
+type
\end_layout
\end_inset
-] As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
+ automatically defines the corresponding counter with name
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+type
+\end_layout
\end_inset
.
- Note that you need to specify the complete type, e.
-\begin_inset space \thinspace{}
-\end_inset
+\end_layout
-g.
-\begin_inset space ~
-\end_inset
+\begin_layout Subsection
+Flex insets and InsetLayout
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Flex-insets-and"
+\end_inset
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-CopyStyle Flex:<name>
\end_layout
-\end_inset
-
-.
+\begin_layout Standard
+Flex insets come in
+\change_deleted 5863208 1594239511
+three
+\change_inserted 5863208 1594239512
+two
+\change_unchanged
+ different kinds:
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+character style (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CustomPars
+CharStyle
\end_layout
\end_inset
- [
+): These define semantic markup corresponding to such \SpecialChar LaTeX
+ commands as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
+\backslash
+noun
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+
+\backslash
+code
\end_layout
\end_inset
-] Indicates whether the user may employ the Paragraph Settings dialog to
- customize the paragraph.
+.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+user custom (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Decoration
+Custom
\end_layout
\end_inset
- can be
+): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
+ code,
+ footnote, and the like.
+ An obvious example is an endnote inset, which is defined in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Classic
+endnote
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Minimalistic
+ module.
\end_layout
-\end_inset
+\begin_layout Itemize
-, or
+\change_deleted 5863208 1594239528
+XML elements (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Conglomerate
+Element
\end_layout
\end_inset
-, describing the rendering style used for the inset's frame and buttons.
- Footnotes generally use
+): For use with DocBook classes.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Standard
+Flex insets are defined using the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Classic
+InsetLayout
\end_layout
\end_inset
-, ERT insets generally
+ tag, which shall be explained in a moment.
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
+InsetLayout
\end_layout
\end_inset
-, and character styles
+ tag also serves another function: It can be used to customize the general
+ layout of many different types of insets.
+ Currently,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Conglomerate
+InsetLayout
\end_layout
\end_inset
-.
+ can be used to customize the layout parameters for footnotes, marginal
+ notes, note insets, \SpecialChar TeX
+ code (ERT) insets, branches, listings, indexes, boxes,
+ tables, algorithms, URLs, and captions, as well as to define Flex insets.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Display
+InsetLayout
\end_layout
\end_inset
- [
+ definition must begin with a line of the form:
+\end_layout
+
+\begin_layout LyX-Code
+InsetLayout <type>
+\end_layout
+
+\begin_layout Standard
+Here
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+<Type>
\end_layout
\end_inset
-,
-\emph on
-
-\begin_inset space \thinspace{}
-\end_inset
-
-
-\emph default
+ indicates the inset whose layout is being defined, and here there are four
+ cases.
+\end_layout
+\begin_layout Enumerate
+The layout for a pre-existing inset is being modified.
+ In this case, can be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+<Type>
\end_layout
\end_inset
-] Only useful if
+ any one of the following:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+Algorithm
\end_layout
\end_inset
- is
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+Branch
\end_layout
\end_inset
-.
- Indicates whether the environment will stand on its own in the output or
- will appear inline with the surrounding text.
- If set to false, it is supposed that the \SpecialChar LaTeX
- environment ignores white space
- (including one newline character) after the
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}
+Box
\end_layout
\end_inset
- and
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-end{
-\emph on
-LatexName
-\emph default
-}
+Box:shaded
\end_layout
\end_inset
- tags.
- Default is true.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
+Caption:Standard
\end_layout
\end_inset
- Required at the end of the
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+ERT
\end_layout
\end_inset
- declarations.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+Figure
\end_layout
\end_inset
- The font used for both the text body
-\emph on
-and
-\emph default
- the label.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
-
-\end_inset
-
-.
- Note that defining this font automatically defines the
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Foot
\end_layout
\end_inset
- to the same value, so define this first and define
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Index
\end_layout
\end_inset
- later if you want them to be different.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FixedWidthPreambleEncoding
+Info
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Info:menu
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Info:shortcut
\end_layout
\end_inset
-] Force a fixed width encoding for the translated contents of
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+Info:shortcuts
\end_layout
\end_inset
- and
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+Listings
\end_layout
\end_inset
- code generated by this layout.
- This is needed for special \SpecialChar LaTeX
--packages like
-\family typewriter
-listings
-\family default
- that do not work with variable width encodings such as
-\family sans
-utf8
-\family default
-.
- This setting is ignored if fully Unicode aware \SpecialChar LaTeX
- backends such as Xe\SpecialChar TeX
- or
- Lua\SpecialChar TeX
- are used.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForceLocalFontSwitch
+Marginal
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Note:Comment
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Note:Note
\end_layout
\end_inset
-] When using babel, always use a local font switch (
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-foreignlanguage
+Note:Greyedout
\end_layout
\end_inset
-), never a global one (such as
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-selectlanguage
+Table
\end_layout
\end_inset
-).
-\end_layout
-
-\begin_layout Description
+, or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForceLTR
+URL
\end_layout
\end_inset
- [
+.
+\end_layout
+
+\begin_layout Enumerate
+The layout for a Flex inset is being defined.
+ In this case,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+<Type>
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+ must be of the form
+\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-1
+Flex:<name>
\end_layout
\end_inset
-] Force the
-\begin_inset Quotes eld
-\end_inset
-latex
\begin_inset Quotes erd
\end_inset
- language, leading to Left-to-Right (Latin) output, e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
+, where
+\begin_inset Flex Code
+status collapsed
-in \SpecialChar TeX
- code or URL.
- A kludge.
+\begin_layout Plain Layout
+name
\end_layout
-\begin_layout Description
+\end_inset
+
+ may be be any valid identifier not used by a pre-existing Flex inset.
+ The identifier may include spaces, but in that case the whole thing must
+ be wrapped in quotes.
+ Note that the definition of a flex inset
+\emph on
+must
+\emph default
+also include a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForceOwnlines
+LyXType
\end_layout
\end_inset
- [
+ entry, declaring which type of inset it defines.
+\end_layout
+
+\begin_layout Enumerate
+The layout for user specific branch is being defined.
+ In this case,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+<Type>
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+ must be of the form
+\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-1
+Branch:<name>
\end_layout
\end_inset
-] Force a a line break in the \SpecialChar LaTeX
- output before the inset starts and after
- the inset ends.
- This assures the inset itself is output on its own lines, for parsing purposes.
-\end_layout
-\begin_layout Description
+\begin_inset Quotes erd
+\end_inset
+
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForcePlain
+name
\end_layout
\end_inset
- [
+ may be be any valid identifier of branch defined in user's document.
+ The identifier may include spaces, but in that case the whole thing must
+ be wrapped in quotes.
+ The main purpose of this feature is to allow \SpecialChar LaTeX
+ wrapping around specific
+ branches as user needs.
+\end_layout
+
+\begin_layout Enumerate
+The layout of a user (or class) specific caption is being defined.
+ In this case,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+<Type>
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+ must be of the form
+\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-1
+Caption:<name>
\end_layout
\end_inset
-] Indicates whether the
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PlainLayout
+name
\end_layout
\end_inset
- should be used or, instead, the user can change the paragraph style used
- in the inset.
- Default is false.
-\end_layout
-
-\begin_layout Description
+ specifies the name of the caption as it appears in the menu.
+ Have a look at the standard caption (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+Caption:Standard
\end_layout
\end_inset
- [
+), the specific captions of the KOMA-Script classes (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Caption:Above
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Caption:Below
\end_layout
\end_inset
-] As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
+) or the module
+\family sans
+Multilingual
+\begin_inset space ~
+\end_inset
+Captions
+\begin_inset Newline linebreak
\end_inset
-.
-\end_layout
-\begin_layout Description
+\family default
+(
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTML*
+Caption:Bicaption
\end_layout
\end_inset
- These tags control the XHTML output.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Tags-for-XHTML"
-
-\end_inset
-
-.
+) for applications.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InToc
+InsetLayout
\end_layout
\end_inset
- [
+ definition can contain the following entries:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+AddToToc
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+string
\end_layout
\end_inset
-] Whether to include the contents of this inset in the strings generated
- for the `Outline' pane for all table of contents, regardless of the AddToToc
- setting.
- One would not, for example, want the content of a footnote in a section
- header to be included in the TOC displayed in the outline, but one would
- normally want the content of a character style displayed.
- Default is false: not to include.
+=""] This inset will appear in the table of contents of the given type.
+ An empty string disables.
+ See also the OutlinerName and the IsTocCaption commands.
+ This is only implemented for Flex insets.
+ Default: disabled.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-IsTocCaption
+Argument
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+int
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+] Defines argument number of a command\SpecialChar breakableslash
+environment associated with the current
+ layout.
+ The definition must end with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+EndArgument
\end_layout
\end_inset
-] If this is set to 1 and AddToToc is enabled, the inset adds a summary
- of its contents in its item in the table of contents.
- Otherwise, only the label appears.
+.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+ for details.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+BabelPreamble
\end_layout
\end_inset
- [
-\emph on
+ Preamble for changing language commands; see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:I18n"
+
+\end_inset
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+BgColor
\end_layout
\end_inset
-
-\emph default
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+<name>
\end_layout
\end_inset
-] As with paragraph styles, see
+] The color for the inset's background.
+ See
\begin_inset CommandInset ref
LatexCommand ref
-reference "subsec:Paragraph-Styles"
+reference "chap:Names-of-colors"
\end_inset
-.
+ for a list of the available color names.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelFont
+ContentAsLabel
\end_layout
\end_inset
- The font used for the label.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
\end_inset
-.
- Note that this definition can never appear before
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+1
\end_layout
\end_inset
-, lest it be ineffective.
+] Whether to use the content of the inset as the label, when the inset is
+ closed.
+ Default is false.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelString
+CopyStyle
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<type>
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
\end_inset
+.
+ Note that you need to specify the complete type, e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_inset Quotes erd
+g.
+\begin_inset space ~
\end_inset
-] What will be displayed on the button or elsewhere as the inset label.
- Some inset types (
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\SpecialChar TeX
- code
+CopyStyle Flex:<name>
\end_layout
\end_inset
- and
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Branch
+CustomPars
\end_layout
\end_inset
-) modify this label on the fly.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+
+\emph on
+0
\end_layout
\end_inset
- Language dependent preamble; see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:I18n"
-
+,
+\begin_inset space \thinspace{}
\end_inset
-.
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+1
\end_layout
\end_inset
- [
+] Indicates whether the user may employ the Paragraph Settings dialog to
+ customize the paragraph.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<name>
+Decoration
\end_layout
\end_inset
-] The name of the corresponding \SpecialChar LaTeX
- stuff.
- Either the environment or command name.
-\end_layout
-
-\begin_layout Description
+ can be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexParam
+Classic
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<parameter>
+Minimalistic
\end_layout
\end_inset
-] The optional parameter for the corresponding
+, or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+Conglomerate
\end_layout
\end_inset
- stuff, including possible bracket pairs like
+, describing the rendering style used for the inset's frame and buttons.
+ Footnotes generally use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[]
+Classic
\end_layout
\end_inset
-.
- This parameter cannot be changed from within \SpecialChar LyX
- (use
+, ERT insets generally
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+Minimalistic
\end_layout
\end_inset
- for customizable parameters).
- It will be output as is after all \SpecialChar LaTeX
-
+, and character styles
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+Conglomerate
\end_layout
\end_inset
-s.
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LatexType
+Display
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Command, Environment, None
+0
\end_layout
\end_inset
-] How the style should be translated into \SpecialChar LaTeX
-.
-\begin_inset Foot
-status collapsed
+,
+\emph on
+
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\emph default
-\begin_layout Plain Layout
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
-\end_layout
-
-\end_inset
- is perhaps a bit misleading, since these rules apply to SGML classes too.
- Visit the SGML class files for specific examples.
+\emph on
+1
\end_layout
\end_inset
-
-\end_layout
-
-\begin_deeper
-\begin_layout Description
+] Only useful if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-None
+LatexType
\end_layout
\end_inset
- means nothing special
-\end_layout
-
-\begin_layout Description
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+Environment
\end_layout
\end_inset
- means
+.
+ Indicates whether the environment will stand on its own in the output or
+ will appear inline with the surrounding text.
+ If set to false, it is supposed that the \SpecialChar LaTeX
+ environment ignores white space
+ (including one newline character) after the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\backslash
-
+begin{
\emph on
LatexName
\emph default
-{\SpecialChar ldots
}
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Environment
-\end_layout
-
-\end_inset
-
- means
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}\SpecialChar ldots
-
\backslash
end{
\emph on
\end_inset
+ tags.
+ Default is true.
+\change_inserted 731793113 1538674858
\end_layout
-\begin_layout Standard
-Putting the last few things together, the \SpecialChar LaTeX
- output will be either:
-\end_layout
-
-\begin_layout LyX-Code
+\begin_layout Description
-\backslash
-LatexName[LatexParam]{\SpecialChar ldots
-}
-\end_layout
+\change_inserted 731793113 1538674891
+\begin_inset Flex Code
+status open
-\begin_layout Standard
-or:
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
+\change_inserted 731793113 1538674863
+EditExternal
+\change_unchanged
-\backslash
-begin{LatexName}[LatexParam] \SpecialChar ldots
-
-\backslash
-end{LatexName}
\end_layout
-\begin_layout Standard
-depending upon the \SpecialChar LaTeX
- type.
-\end_layout
+\end_inset
-\end_deeper
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+ [
+\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
-\begin_layout Plain Layout
-LeftDelim
\end_layout
-\end_inset
-
- [
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+End
\end_layout
\end_inset
-] A string that is put at the beginning of the layout content.
- A line break in the output can be indicated by
+ Required at the end of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<br/>
+InsetLayout
\end_layout
\end_inset
-.
+ declarations.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LyxType
+Font
\end_layout
\end_inset
- Can be
+ The font used for both the text body
+\emph on
+and
+\emph default
+ the label.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
+\end_inset
+
+.
+ Note that defining this font automatically defines the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-charstyle
+LabelFont
\end_layout
\end_inset
-,
+ to the same value, so define this first and define
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-custom
+LabelFont
\end_layout
\end_inset
-,
+ later if you want them to be different.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-element
+FixedWidthPreambleEncoding
\end_layout
\end_inset
- or
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-end
+
+\emph on
+0
\end_layout
\end_inset
- (indicating a dummy definition ending definitions of charstyles, etc).
- This entry is required in and is only meaningful for Flex insets.
- Among other things, it determines on which menu this inset will appear.
- Setting
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyxType
+1
\end_layout
\end_inset
- to
+] Force a fixed width encoding for the translated contents of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-charstyle
+BabelPreamble
\end_layout
\end_inset
- will automatically set
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+LangPreamble
\end_layout
\end_inset
- to false and
+ code generated by this layout.
+ This is needed for special \SpecialChar LaTeX
+-packages like
+\family typewriter
+listings
+\family default
+ that do not work with variable width encodings such as
+\family sans
+utf8
+\family default
+.
+ This setting is ignored if fully Unicode aware \SpecialChar LaTeX
+ backends such as Xe\SpecialChar TeX
+ or
+ Lua\SpecialChar TeX
+ are used.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForcePlain
+ForceLocalFontSwitch
\end_layout
\end_inset
- to true.
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+
+\emph on
+0
\end_layout
\end_inset
- can be set to true, or
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForcePlain
+1
\end_layout
\end_inset
- to false, for
+] When using babel, always use a local font switch (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-charstyle
+
+\backslash
+foreignlanguage
\end_layout
\end_inset
- insets by setting it
-\emph on
-after
-\emph default
- you set the
+), never a global one (such as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyxType
+
+\backslash
+selectlanguage
\end_layout
\end_inset
-.
+).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-MultiPar
+ForceLTR
\end_layout
\end_inset
\end_inset
-] Whether multiple paragraphs are permitted in this inset.
- This will also set
+] Force the
+\begin_inset Quotes eld
+\end_inset
+
+latex
+\begin_inset Quotes erd
+\end_inset
+
+ language, leading to Left-to-Right (Latin) output, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+in \SpecialChar TeX
+ code or URL.
+ A kludge.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CustomPars
+ForceOwnlines
\end_layout
\end_inset
- to the same value and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForcePlain
+
+\emph on
+0
\end_layout
\end_inset
- to the opposite value.
- These can be reset to other values, if they are used
-\emph on
-after
-\emph default
-
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+1
\end_layout
\end_inset
-.
- Default is true.
+] Force a a line break in the \SpecialChar LaTeX
+ output before the inset starts and after
+ the inset ends.
+ This assures the inset itself is output on its own lines, for parsing purposes.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-NeedProtect
+ForcePlain
\end_layout
\end_inset
\end_inset
-] Whether fragile commands in this inset should be
+] Indicates whether the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-protect
+PlainLayout
\end_layout
\end_inset
-'ed.
- (Note: This is
-\emph on
-not
-\emph default
- whether the command should itself be protected.) Default is false.
-\change_inserted -712698321 1523633958
-
+ should be used or, instead, the user can change the paragraph style used
+ in the inset.
+ Default is false.
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1523634088
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1523633961
-NeedCProtect
+FreeSpacing
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1523633958
-
\emph on
0
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1523633958
1
\end_layout
\end_inset
-] This causes macros that contain this inset to be protected with
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\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.
-\change_unchanged
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-NoInsetLayout
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<layout>
-\end_layout
+HTML*
+\end_layout
\end_inset
-] Deletes an existing
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-InsetLayout
-\end_layout
+ These tags control the XHTML output.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Tags-for-XHTML"
\end_inset
status collapsed
\begin_layout Plain Layout
-ObsoletedBy
+InToc
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<layout>
-\end_layout
-
-\end_inset
-
-] Name of an
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-InsetLayout
+\emph on
+0
\end_layout
\end_inset
- that has replaced this
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-InsetLayout
-\end_layout
-
+,
+\begin_inset space \thinspace{}
\end_inset
-.
- This is used to rename an
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+1
\end_layout
\end_inset
-, while keeping backward compatibility.
+] Whether to include the contents of this inset in the strings generated
+ for the `Outline' pane for all table of contents, regardless of the AddToToc
+ setting.
+ One would not, for example, want the content of a footnote in a section
+ header to be included in the TOC displayed in the outline, but one would
+ normally want the content of a character style displayed.
+ Default is false: not to include.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ParbreakIsNewline
+IsTocCaption
\end_layout
\end_inset
\end_inset
-] As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
-
-\end_inset
-
-.
- Default is false.
+] If this is set to 1 and AddToToc is enabled, the inset adds a summary
+ of its contents in its item in the table of contents.
+ Otherwise, only the label appears.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-PassThru
+KeepEmpty
\end_layout
\end_inset
[
+\emph on
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
0
\end_layout
\end_inset
+
+\emph default
,
\begin_inset space \thinspace{}
\end_inset
\end_inset
.
- Default is false.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Preamble
+LabelFont
\end_layout
\end_inset
- As with paragraph styles, see
+ The font used for the label.
+ See
\begin_inset CommandInset ref
LatexCommand ref
-reference "subsec:Paragraph-Styles"
+reference "subsec:Font-description"
\end_inset
.
+ Note that this definition can never appear before
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\end_layout
+
+\end_inset
+
+, lest it be ineffective.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-RefPrefix
+LabelString
\end_layout
\end_inset
\end_inset
-] The prefix to use when creating labels referring to insets of this type.
- This allows the use of formatted references.
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] What will be displayed on the button or elsewhere as the inset label.
+ Some inset types (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+\SpecialChar TeX
+ code
\end_layout
-\begin_layout Description
+\end_inset
+
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Requires
+Branch
\end_layout
\end_inset
- [
+) modify this label on the fly.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+LangPreamble
\end_layout
\end_inset
-] As with paragraph styles, see
+ Language dependent preamble; see
\begin_inset CommandInset ref
LatexCommand ref
-reference "subsec:Paragraph-Styles"
+reference "subsec:I18n"
\end_inset
status collapsed
\begin_layout Plain Layout
-ResetArgs
+LatexName
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+<name>
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
+] The name of the corresponding \SpecialChar LaTeX
+ stuff.
+ Either the environment or command name.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+LatexParam
\end_layout
\end_inset
-] Resets the \SpecialChar LaTeX
- arguments of this layout (as defined via the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+<parameter>
\end_layout
\end_inset
- tag).
- This is useful if you have copied a style via
+] The optional parameter for the corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+LatexName
\end_layout
\end_inset
-, but you do not want to inherit its (required and optional) arguments.
-\end_layout
-
-\begin_layout Description
+ stuff, including possible bracket pairs like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ResetsFont
+[]
\end_layout
\end_inset
- [
+.
+ This parameter cannot be changed from within \SpecialChar LyX
+ (use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Argument
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+ for customizable parameters).
+ It will be output as is after all \SpecialChar LaTeX
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+Argument
\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.
+s.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-RightDelim
+LatexType
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+Command, Environment, None
\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
+] How the style should be translated into \SpecialChar LaTeX
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<br/>
+LatexType
\end_layout
\end_inset
-.
+ is perhaps a bit misleading, since these rules apply to SGML classes too.
+ Visit the SGML class files for specific examples.
+\end_layout
+
+\end_inset
+
+
\end_layout
+\begin_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Spellcheck
+None
\end_layout
\end_inset
- [
+ means nothing special
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Command
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+ means
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-1
-\end_layout
-
-\end_inset
+\backslash
-] Allow spell-checking the contents of this inset.
- Default is true.
+\emph on
+LatexName
+\emph default
+{\SpecialChar ldots
+}
\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
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-chapter
+Environment
\end_layout
\end_inset
-,
-\begin_inset Flex Noun
+ means
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-figure
+
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}\SpecialChar ldots
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
\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
+\begin_layout Standard
+Putting the last few things together, the \SpecialChar LaTeX
+ output will be either:
\end_layout
\begin_layout LyX-Code
-Input stdcounters.inc
+
+\backslash
+LatexName[LatexParam]{\SpecialChar ldots
+}
\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:
+or:
\end_layout
\begin_layout LyX-Code
-Counter CounterName
+
+\backslash
+begin{LatexName}[LatexParam] \SpecialChar ldots
+
+\backslash
+end{LatexName}
\end_layout
\begin_layout Standard
-where of course `
+depending upon the \SpecialChar LaTeX
+ type.
+\end_layout
+
+\end_deeper
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CounterName
+LeftDelim
\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
-End
+string
\end_layout
\end_inset
+] A string that is put at the beginning 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
-\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
+LyxType
\end_layout
\end_inset
- [
+ Can be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-int=1
+charstyle
\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.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+custom
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+element
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] When defined, this string defines how the counter is displayed.
- Setting this value sets
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+end
\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
+ (indicating a dummy definition ending definitions of charstyles, etc).
+ This entry is required in and is only meaningful for Flex insets.
+ Among other things, it determines on which menu this inset will appear.
+ Setting
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-thecounter
+LyxType
\end_layout
\end_inset
- will be replaced by the expansion of the
+ to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+charstyle
\end_layout
\end_inset
- (or
+ will automatically set
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+MultiPar
\end_layout
\end_inset
-) of the counter
+ to false and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-counter
+ForcePlain
\end_layout
\end_inset
-.
+ to true.
-\end_layout
-
-\begin_layout Itemize
-counter values can be expressed using \SpecialChar LaTeX
--like macros
-\begin_inset Newline newline
-\end_inset
-
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\emph on
-numbertype
-\emph default
-{
-\emph on
-counter
-\emph default
-}
+MultiPar
\end_layout
\end_inset
-, where
+ can be set to true, or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-numbertype
+ForcePlain
\end_layout
\end_inset
- can be:
-\begin_inset Foot
+ to false, for
+\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.
+charstyle
\end_layout
\end_inset
-
+ insets by setting it
+\emph on
+after
+\emph default
+ you set the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-arabic
+LyxType
\end_layout
\end_inset
-: 1, 2, 3,\SpecialChar ldots
-;
-\begin_inset Flex Code
-status collapsed
+.
+\change_inserted -712698321 1555575738
-\begin_layout Plain Layout
-alph
\end_layout
-\end_inset
+\begin_layout Description
- for lower-case letters: a, b, c, \SpecialChar ldots
-;
+\change_inserted -712698321 1555575844
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Alph
+
+\change_inserted -712698321 1555575740
+MenuString
+\change_unchanged
+
\end_layout
\end_inset
- for upper-case letters: A, B, C, \SpecialChar ldots
-;
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-roman
-\end_layout
-
-\end_inset
- for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
-;
-\begin_inset Flex Code
-status collapsed
+\change_inserted -712698321 1555575740
+[string]
+\change_unchanged
-\begin_layout Plain Layout
-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
-hebrew
-\end_layout
-
+ 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
- for hebrew numerals.
-\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_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-master
-\end_layout
-
+|
+\begin_inset Quotes erd
\end_inset
- (defined via
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Within
-\end_layout
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
\end_inset
-), the string
-\begin_inset Newline newline
+
+\begin_inset Quotes eld
\end_inset
\begin_layout Plain Layout
-\backslash
-themaster.
-\backslash
-arabic{counter}
+\change_inserted -712698321 1555575781
+My Inset|M
+\change_unchanged
+
\end_layout
\end_inset
- is used; otherwise the string
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-arabic{counter}
-\end_layout
+\begin_inset Quotes erd
\end_inset
- is used.
+).
+ 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
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+MultiPar
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+,
+\begin_inset space \thinspace{}
\end_inset
-\begin_inset Quotes erd
-\end_inset
-
-] Same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+1
\end_layout
\end_inset
-, but for use in the Appendix.
-\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
-PrettyFormat
+CustomPars
\end_layout
\end_inset
- [
+ to the same value and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+ForcePlain
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\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
-
-Section 2.4
-\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
-.
- The string should contain
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+MultiPar
+\end_layout
-##
-\begin_inset Quotes erd
\end_inset
.
- This will be replaced by the counter number itself.
- So, for sections, it would be: Section ##.
+ Default is true.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Within
+NeedProtect
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+,
+\begin_inset space \thinspace{}
\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,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-subsection
+1
\end_layout
\end_inset
- is numbered inside
+] Whether fragile commands in this inset should be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-section
-\end_layout
-
-\end_inset
-.
+\backslash
+protect
\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
+'ed.
+ (Note: This is
\emph on
-
-\family roman
-or
-\family default
+not
\emph default
- DefaultFont
-\end_layout
-
-\begin_layout LyX-Code
- ...
-\end_layout
-
-\begin_layout LyX-Code
-EndFont
-\end_layout
+ whether the command should itself be protected.) Default is false.
+\change_inserted -712698321 1523633958
-\begin_layout Standard
-The following commands are available:
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1552395786
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Color
+
+\change_inserted -712698321 1523633961
+NeedCProtect
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
+\change_inserted -712698321 1523633958
+
\emph on
-none
+0
+\change_unchanged
+
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-black
-\end_layout
-
+,
+\begin_inset space \thinspace{}
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-white
+
+\change_inserted -712698321 1523633958
+1
+\change_unchanged
+
\end_layout
\end_inset
-,
+] This causes macros that contain this inset to be protected with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-red
-\end_layout
-\end_inset
+\change_inserted -712698321 1523634038
-,
-\begin_inset Flex Code
-status collapsed
+\backslash
+cprotect
+\change_unchanged
-\begin_layout Plain Layout
-green
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-blue
+ (cf.
+ package
+\family sans
+cprotect
+\family default
+) if necessary and thus allows (some) verbatim stuff in macros.
+ Default is false.
\end_layout
-\end_inset
+\begin_layout Description
-,
+\change_inserted -712698321 1555579651
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-cyan
-\end_layout
-
-\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+\change_inserted -712698321 1552395787
+NeedMBoxProtect
+\change_unchanged
-\begin_layout Plain Layout
-magenta
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-yellow
-\end_layout
-\end_inset
+\change_inserted -712698321 1552395787
-,
-\begin_inset Flex Code
-status collapsed
+\emph on
+0
+\change_unchanged
-\begin_layout Plain Layout
-brown
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-darkgray
-\end_layout
-
+,
+\begin_inset space \thinspace{}
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-gray
-\end_layout
-
-\end_inset
-,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lightgray
-\end_layout
-
-\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+\change_inserted -712698321 1552395787
+1
+\change_unchanged
-\begin_layout Plain Layout
-lime
\end_layout
\end_inset
-,
+] Whether specific commands in this inset (such as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-orange
-\end_layout
-\end_inset
+\change_inserted -712698321 1552395787
-,
-\begin_inset Flex Code
-status collapsed
+\backslash
+cite
+\change_unchanged
-\begin_layout Plain Layout
-olive
\end_layout
\end_inset
-,
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-pink
-\end_layout
-\end_inset
+\change_inserted -712698321 1552395787
-,
-\begin_inset Flex Code
-status collapsed
+\backslash
+ref
+\change_unchanged
-\begin_layout Plain Layout
-purple
\end_layout
\end_inset
-,
+) should be protected in an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-teal
-\end_layout
-\end_inset
+\change_inserted -712698321 1552395787
-,
-\begin_inset Flex Code
-status collapsed
+\backslash
+mbox
+\change_unchanged
-\begin_layout Plain Layout
-violet
\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
-Family
+
+\change_inserted -712698321 1555579658
+NewlineCmd
+\change_unchanged
+
\end_layout
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-Roman
+\change_inserted -712698321 1555579651
+[string]
+\change_unchanged
+
\end_layout
\end_inset
-,
+ Option to define a different command (from the default
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sans
-\end_layout
-\end_inset
+\change_inserted -712698321 1555579742
-,
-\begin_inset Flex Code
-status collapsed
+\backslash
+
+\backslash
+
+\change_unchanged
-\begin_layout Plain Layout
-Typewriter
\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
-Misc
+NoInsetLayout
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<layout>
\end_layout
\end_inset
-] Valid arguments are:
+] Deletes an existing
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-emph
+InsetLayout
\end_layout
\end_inset
-,
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-noun
+ObsoletedBy
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-strikeout
+<layout>
\end_layout
\end_inset
-,
+] Name of an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-underbar
+InsetLayout
\end_layout
\end_inset
-,
+ that has replaced this
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-uuline
+InsetLayout
\end_layout
\end_inset
-,
+.
+ This is used to rename an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-uwave
+InsetLayout
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+, while keeping backward compatibility.
+\change_inserted -712698321 1559491850
-\begin_layout Plain Layout
-no_emph
\end_layout
-\end_inset
+\begin_layout Description
-,
+\change_inserted -712698321 1559492002
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_noun
+
+\change_inserted -712698321 1559491854
+ParbreakIgnored
+\change_unchanged
+
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_strikeout
-\end_layout
-\end_inset
+\change_inserted -712698321 1559491850
-,
-\begin_inset Flex Code
-status collapsed
+\emph on
+0
+\change_unchanged
-\begin_layout Plain Layout
-no_bar
\end_layout
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_uuline
+
+\change_inserted -712698321 1559491850
+1
+\change_unchanged
+
\end_layout
\end_inset
- and
+] If this is set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_uwave
+
+\change_inserted -712698321 1559491881
+1
+\change_unchanged
+
\end_layout
\end_inset
-.
- Each of these turns on or off the corresponding attribute.
- For example,
+, 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
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-emph
+ParbreakIsNewline
\end_layout
\end_inset
- turns on emphasis, and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
+
+\emph on
+0
\end_layout
\end_inset
- turns it off.
-
-\begin_inset Newline newline
+,
+\begin_inset space \thinspace{}
\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
+1
\end_layout
\end_inset
- would turn off the emphasis that was anyway in effect, say, in a theorem
- environment.
+] 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
status collapsed
\begin_layout Plain Layout
-Series
+PassThru
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-Medium
+0
\end_layout
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Bold
+1
\end_layout
\end_inset
-]
+] 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
status collapsed
\begin_layout Plain Layout
-Shape
+Preamble
\end_layout
\end_inset
- [
+ As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Up
+RefPrefix
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Italic
+string
\end_layout
\end_inset
-,
+] 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
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-SmallCaps
+Requires
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Slanted
+string
\end_layout
\end_inset
-]
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Size
+ResetArgs
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-tiny
+
+\emph on
+0
\end_layout
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-small
+1
\end_layout
\end_inset
-,
+] Resets the \SpecialChar LaTeX
+ arguments of this layout (as defined via the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-normal
+Argument
\end_layout
\end_inset
-,
+ tag).
+ This is useful if you have copied a style via
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-large
+CopyStyle
\end_layout
\end_inset
-,
+, but you do not want to inherit its (required and optional) arguments.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-larger
+ResetsFont
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-largest
+
+\emph on
+0
\end_layout
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-huge
+1
\end_layout
\end_inset
-,
+]
+\change_inserted -712698321 1597733473
+If
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-giant
-\end_layout
-\end_inset
+\change_inserted -712698321 1597732178
+1
+\change_unchanged
-]
\end_layout
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Citation-engine-description"
-
\end_inset
-Cite engine description
-\end_layout
+, 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
-\begin_layout Standard
-The
+g.,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteEngine
-\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"
+\change_inserted -712698321 1597733683
-\end_inset
+\backslash
+textbf{Sourrounding text
+\backslash
+myinset{
+\backslash
+textbf{content}}\SpecialChar ldots
+}
+\change_unchanged
-), define the citation commands provided by a specific
-\begin_inset Quotes eld
-\end_inset
+\end_layout
-cite engine
-\begin_inset Quotes erd
\end_inset
-.
- 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
+ rather than
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-default
+
+\change_inserted -712698321 1597733686
+
+\backslash
+textbf{Sourrounding text
+\backslash
+myinset{content}\SpecialChar ldots
+}
\end_layout
\end_inset
-: the default Bib\SpecialChar TeX
- way to format citations, a simple numeric style (e.
+.
+ Setting this makes sense for commands that internally reset font settings
+ (e.
\begin_inset space \thinspace{}
\end_inset
-g.,
-\begin_inset Quotes eld
+g., footnotes).
+ Note that wrongly setting this might lead to unwanted result (e.
+\begin_inset space \thinspace{}
\end_inset
-[1]
-\begin_inset Quotes erd
-\end_inset
+g., with
+\begin_inset Flex Code
+status collapsed
-)
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1597733688
+
+\backslash
+emph{Sourrounding text
+\backslash
+myinset{
+\backslash
+emph{content}}\SpecialChar ldots
+}
\end_layout
-\begin_layout Enumerate
+\end_inset
+
+, content is upright, as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-authoryear
+
+\change_inserted -712698321 1597733278
+
+\backslash
+emph
\end_layout
\end_inset
-: Harvard-styled citations using author names and publication year (e.
-\begin_inset space \thinspace{}
-\end_inset
+ 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
-g.,
-\begin_inset Quotes eld
-\end_inset
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1597733292
+0
+\end_layout
-Smith and Miller (2017b)
-\begin_inset Quotes erd
\end_inset
-)
+
+\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
-\begin_layout Enumerate
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-numerical
+RightDelim
\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
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
-g.,
-\begin_inset Quotes eld
\end_inset
-Smith and Miller [1]
-\begin_inset Quotes erd
+] 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 Standard
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteEngine
+Spellcheck
\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_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
- Citep*[][]
+\begin_layout Plain Layout
+0
\end_layout
-\begin_layout LyX-Code
- citeyearpar[][]=parencite*
-\end_layout
+\end_inset
-\begin_layout LyX-Code
- ...
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout LyX-Code
-End
-\end_layout
-\begin_layout Standard
-The tag following
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteEngine
+
+\emph on
+1
\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:
+] Allow spell-checking the contents of this inset.
+ Default is true.
\end_layout
-\begin_layout LyX-Code
-LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
+\begin_layout Subsection
+Counters
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Counters"
+
+\end_inset
+
+
\end_layout
-\begin_layout Itemize
-\begin_inset Flex Code
+\begin_layout Standard
+It is necessary to define the counters (
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-LyXName
+chapter
\end_layout
\end_inset
-: The name as used in the
-\begin_inset Flex Code
+,
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-*.lyx
+figure
\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
+, \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
-latexcmd
+stdcounters.inc
\end_layout
\end_inset
- sometimes, if the \SpecialChar LaTeX
- command names differ).
+, so you may have to do no more than add
\end_layout
-\end_deeper
-\begin_layout Itemize
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+Input stdcounters.inc
+\end_layout
-\begin_layout Plain Layout
-alias
+\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
-\end_inset
+\begin_layout LyX-Code
+Counter CounterName
+\end_layout
-: a (comma-separated) list of commands that fall back to the given
+\begin_layout Standard
+where of course `
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXName
+CounterName
\end_layout
\end_inset
- in the current engine.
- This eases the switch of citation packages and engines.
- The
+' 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
-alias
+End
\end_layout
\end_inset
- can be compared to
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The following parameters can also be used:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ObsoletedBy
+InitialValue
\end_layout
\end_inset
- in layout definitions.
-\end_layout
-
-\begin_layout Itemize
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latexcmd
+int=1
\end_layout
\end_inset
-: The actual \SpecialChar LaTeX
- command that is output.
-
+] 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 Standard
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Alias
+LabelString
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latexcmd
+string
\end_layout
\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
+\begin_inset Quotes erd
\end_inset
- is given, the
+] When defined, this string defines how the counter is displayed.
+ Setting this value sets
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXName
+LabelStringAppendix
\end_layout
\end_inset
- will be output to \SpecialChar LaTeX
-.
-\end_layout
-
-\begin_layout Standard
-Note further:
+ to the same value.
+ The following special constructs can be used in the string:
\end_layout
+\begin_deeper
\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
+thecounter
\end_layout
\end_inset
- vs.
-
+ will be replaced by the expansion of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-latexcmd
+LabelString
\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
+ (or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[]
+LabelStringAppendix
\end_layout
\end_inset
- indicate the number of optional arguments (there can be 0–2).
-\end_layout
-
-\begin_layout Itemize
-A star
+) of the counter
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-*
+counter
\end_layout
\end_inset
- indicates there is a starred version of the command (
+.
+
+\end_layout
+
+\begin_layout Itemize
+counter values can be expressed using \SpecialChar LaTeX
+-like macros
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\backslash
-latexcmd*
+
+\emph on
+numbertype
+\emph default
+{
+\emph on
+counter
+\emph default
+}
\end_layout
\end_inset
- vs.
-
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-latexcmd
+\emph on
+numbertype
\end_layout
\end_inset
-).
-
-\end_layout
+ can be:
+\begin_inset Foot
+status collapsed
-\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
+\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.
+\end_layout
-et al.
-\begin_inset Quotes erd
\end_inset
- due to the
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MaxCiteNames
+arabic
\end_layout
\end_inset
- threshold.
-\end_layout
-
-\begin_layout Standard
-If the star has a different meaning for a given command, it can be specified
- in angle brackets:
+: 1, 2, 3,\SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<!_stardesc!_stardesctooltip>
+alph
\end_layout
\end_inset
-.
- Maximal two translatable macro keywords, marked by the prefix
+ for lower-case letters: a, b, c, \SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-!_
+Alph
\end_layout
\end_inset
-, can be given.
- The first points to the string that replaces the
-\begin_inset Quotes eld
-\end_inset
-
-Full aut&hor list
-\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
+ for upper-case letters: A, B, C, \SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
+roman
\end_layout
\end_inset
- (see next section), dropping the
+ for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-!
+Roman
\end_layout
\end_inset
- from the prefix, like this:
-\end_layout
+ for upper-case roman numerals: I, II, III\SpecialChar ldots
+;
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-_stardesc Sta&rred command label
+\begin_layout Plain Layout
+hebrew
\end_layout
-\begin_layout LyX-Code
-_stardesctooltip Tooltip for the starred command checkbox.
+\end_inset
+
+ for hebrew numerals.
\end_layout
\end_deeper
-\begin_layout Itemize
-A dollar sign
+\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
-$
+master
\end_layout
\end_inset
- indicates that this command features
-\begin_inset Quotes eld
-\end_inset
-
-qualified citation lists
-\begin_inset Quotes erd
-\end_inset
+ (defined via
+\begin_inset Flex Code
+status collapsed
-.
- 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.
+\begin_layout Plain Layout
+Within
\end_layout
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Citation-format-description"
+\end_inset
+), the string
+\begin_inset Newline newline
\end_inset
-Cite format description
-\end_layout
-\begin_layout Standard
-The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
+
+\backslash
+themaster.
+\backslash
+arabic{counter}
\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:
-\end_layout
+ is used; otherwise the string
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-CiteFormat
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
- article ...
+\backslash
+arabic{counter}
\end_layout
-\begin_layout LyX-Code
- book ...
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-End
+ is used.
\end_layout
-\begin_layout Standard
-or
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-CiteFormat
+\begin_layout Plain Layout
+LabelStringAppendix
\end_layout
-\begin_layout LyX-Code
- cite ...
-\end_layout
+\end_inset
-\begin_layout LyX-Code
- citet*[][] ...
-\end_layout
+ [
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-End
+\begin_layout Plain Layout
+string
\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
-entry type
-\begin_inset Quotes ers
+=
+\begin_inset Quotes erd
\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
+
+\begin_inset Quotes erd
+\end_inset
+
+] Same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdciteformats.inc
+LabelString
\end_layout
\end_inset
-, which is included in most of \SpecialChar LyX
-'s document classes.
+, but for use in the Appendix.
\end_layout
-\begin_layout Standard
-In the second case, the lines define how a specific citation command (in
- the example
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-cite
+PrettyFormat
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-citet
+string
\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
+=
+\begin_inset Quotes erd
+\end_inset
-\family default
- in specific
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-*.citeengine
-\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
- 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"
+Section 2.4
+\begin_inset Quotes erd
+\end_inset
+.
+ 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 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_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%
+Within
\end_layout
\end_inset
- signs, e.g.:
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%author%
-\end_layout
-
-\end_inset
-
-.
- So a simple definition might look like this:
+string
\end_layout
-\begin_layout LyX-Code
-misc %author%,
-\begin_inset Quotes eld
\end_inset
-%title%
+=
\begin_inset Quotes erd
\end_inset
-.
-\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_inset Quotes erd
+\end_inset
-\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:
+] 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
-{%volume%[[vol.
-\begin_inset space ~
-\end_inset
-
-%volume%]]}
+subsection
\end_layout
\end_inset
-.
- This says: If the
+ is numbered inside
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-volume
+section
\end_layout
\end_inset
- key exists, then print
-\begin_inset Quotes eld
-\end_inset
+.
+\end_layout
+
+\begin_layout Subsection
+Font description
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Font-description"
-vol.
-\begin_inset space ~
\end_inset
-\begin_inset Quotes erd
-\end_inset
+\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
+\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
-{%author%[[%author%]][[%editor%, ed.]]}
+Color
\end_layout
\end_inset
-.
-\begin_inset Newline newline
-\end_inset
-
-Here, the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-author
+
+\emph on
+none
\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 Flex Code
+status collapsed
-,
-\begin_inset space ~
-\end_inset
+\begin_layout Plain Layout
+black
+\end_layout
-ed.
-\begin_inset Quotes erd
\end_inset
- Note that the key is again enclosed in
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%
+white
\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
-\end_inset
-
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[[
+red
\end_layout
\end_inset
+,
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+green
+\end_layout
- and
-\begin_inset Quotes eld
\end_inset
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-]]
+blue
\end_layout
\end_inset
+,
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
-
-.
- There must be no space between any of these.
+\begin_layout Plain Layout
+cyan
\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
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%dialog%[[true]][[false]]}
+magenta
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
-true
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+yellow
+\end_layout
- part for dialogs and menus, the
-\begin_inset Quotes eld
\end_inset
-false
-\begin_inset Quotes erd
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
- part for other contexts (workarea, export)
+\begin_layout Plain Layout
+brown
\end_layout
-\begin_layout Itemize
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%export%[[true]][[false]]}
+darkgray
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
-true
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+gray
+\end_layout
- part for export and menus, the
-\begin_inset Quotes eld
\end_inset
-false
-\begin_inset Quotes erd
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
- part for other contexts (workarea, dialog)
+\begin_layout Plain Layout
+lightgray
\end_layout
-\begin_layout Itemize
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%next%[[true]]}
+lime
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
-true
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+orange
+\end_layout
- part if another item follows (e.
-\begin_inset space \thinspace{}
\end_inset
-g., in a citation with multiple keys)
-\end_layout
-
-\begin_layout Itemize
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%second%[[true]][[false]]}
+olive
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
-
-true
-\begin_inset Quotes erd
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
- if this is the second of multiple items, else the
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+pink
+\end_layout
-false
-\begin_inset Quotes erd
\end_inset
- part
-\end_layout
-
-\begin_layout Itemize
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%ifstar%[[true]][[false]]}
+purple
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+teal
+\end_layout
-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*
+violet
\end_layout
\end_inset
-), the false part for unstarred
+]
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%ifentrytype:<type>%[[true]][[false]]}
+Family
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+Roman
+\end_layout
-true
-\begin_inset Quotes erd
\end_inset
- if the current entry type matches
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<type>
+Sans
\end_layout
\end_inset
-, else the false part (e.g., in a citation definition:
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%ifentrytype:book%[[this is a book]][[this is no book]]}
+Typewriter
\end_layout
\end_inset
-)
+]
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%ifmultiple:<authortype>%[[true]][[false]]}
+Misc
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
-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:
+] Valid arguments are:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%ifmultiple:editor%[[eds.]][[ed.]]}
+emph
\end_layout
\end_inset
-)
-\end_layout
-
-\begin_layout Itemize
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%ifqualified%[[true]][[false]]}
+noun
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
-
-true
-\begin_inset Quotes erd
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
- 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.
+\begin_layout Plain Layout
+strikeout
\end_layout
-\begin_layout Standard
-We said that
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%author%
+underbar
\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
+,
+\begin_inset Flex Code
+status collapsed
-Miller, Peter and Smith, Mary and White, Jane
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+uuline
+\end_layout
- (since
-\begin_inset Quotes eld
\end_inset
-and
-\begin_inset Quotes erd
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
- 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:
+\begin_layout Plain Layout
+uwave
\end_layout
-\begin_layout Enumerate
-For name lists with pre- and surname, suitable for the main authors/editors
- of a bibliography item.
- The
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<nametype>
+no_emph
\end_layout
\end_inset
- part denotes the kind of list that is requested (e.g.
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<nametype:author>
+no_noun
\end_layout
\end_inset
-):
-\end_layout
-
-\begin_deeper
-\begin_layout Itemize
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%abbrvnames:<nametype>%
+no_strikeout
\end_layout
\end_inset
-: Provides a name list which is abbreviated (with
-\begin_inset Quotes eld
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_bar
+\end_layout
-et al.
-\begin_inset Quotes erd
\end_inset
-) when
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MaxCiteNames
+no_uuline
\end_layout
\end_inset
- is reached.
-\end_layout
-
-\begin_layout Itemize
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%fullnames:<nametype>%
+no_uwave
\end_layout
\end_inset
-: Provides a full name list (never abbreviated with
-\begin_inset Quotes eld
-\end_inset
-
-et al.
-\begin_inset Quotes erd
-\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
\end_layout
-\begin_layout Itemize
+\end_inset
+
+ turns on emphasis, and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%forceabbrvnames:<nametype>%
+no_emph
\end_layout
\end_inset
-: Provides a name list which is always abbreviated (with
-\begin_inset Quotes eld
-\end_inset
-
-et al.
-\begin_inset Quotes erd
+ turns it off.
+
+\begin_inset Newline newline
\end_inset
-) irrespective of
+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
-MaxCiteNames
+no_emph
\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:
-\begin_inset Quotes eld
-\end_inset
-
-Miller, John: Some text, in: Mary Smith, ed.: A volume
-\begin_inset Quotes erd
-\end_inset
-
-):
+ would turn off the emphasis that was anyway in effect, say, in a theorem
+ environment.
\end_layout
-\begin_deeper
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%abbrvbynames:<nametype>%
+Series
\end_layout
\end_inset
-: Provides a name list which is abbreviated (with
-\begin_inset Quotes eld
-\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+Medium
+\end_layout
-et al.
-\begin_inset Quotes erd
\end_inset
-) when
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MaxCiteNames
+Bold
\end_layout
\end_inset
- is reached.
+]
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%fullbynames:<nametype>%
+Shape
\end_layout
\end_inset
-: Provides a full name list (never abbreviated with
-\begin_inset Quotes eld
-\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
-et al.
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-).
+\emph on
+Up
\end_layout
-\begin_layout Itemize
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%forceabbrvbynames:<nametype>%
+Italic
\end_layout
\end_inset
-: 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
+SmallCaps
\end_layout
\end_inset
-.
-\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_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<nametype>
+Slanted
\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):
+]
\end_layout
-\begin_deeper
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%abbrvciteauthor%
+Size
\end_layout
\end_inset
-: 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
-MaxCiteNames
+tiny
\end_layout
\end_inset
- is reached.
-\end_layout
-
-\begin_layout Itemize
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%fullciteauthor%
+small
\end_layout
\end_inset
-: 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
-%forceabbrvciteauthor%
-\end_layout
-
-\end_inset
-: Provides a name list which is always abbreviated (with
-\begin_inset Quotes eld
-\end_inset
+\emph on
+normal
+\end_layout
-et al.
-\begin_inset Quotes erd
\end_inset
-) irrespective of
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MaxCiteNames
+large
\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
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-!firstnameform %surname%, %prename%
+larger
\end_layout
\end_inset
- (first author in lists of type 1)
-\end_layout
-
-\begin_layout Itemize
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-!othernameform %surname%, %prename%
+largest
\end_layout
\end_inset
- (other authors in lists of type 1)
-\end_layout
-
-\begin_layout Itemize
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-!firstbynameform %prename% %surname%
+huge
\end_layout
\end_inset
- (first author in lists of type 2)
-\end_layout
-
-\begin_layout Itemize
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-!otherbynameform %prename% %surname%
+giant
\end_layout
\end_inset
- (other authors in lists of type 2)
+]
\end_layout
-\begin_layout Standard
-This allows you to configure namings like
-\begin_inset Quotes eld
-\end_inset
-
-Miller, Peter and Mary Smith: \SpecialChar ldots
-, in: John Doe and Pat Green, eds.:\SpecialChar ldots
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Citation-engine-description"
-\begin_inset Quotes erd
\end_inset
-.
+Cite engine description
\end_layout
\begin_layout Standard
-There is one other piece of syntax available in definitions, which looks
- like this:
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{!<i>!}
+CiteEngine
\end_layout
\end_inset
-.
- This defines a piece of formatting information that is to be used when
- creating
-\begin_inset Quotes eld
-\end_inset
-
-rich text
-\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
-\begin_inset Quotes eld
-\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 Quotes erd
\end_inset
- and
+), define the citation commands provided by a specific
\begin_inset Quotes eld
\end_inset
-!}
+cite engine
\begin_inset Quotes erd
\end_inset
.
+ 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 Standard
-Two special sorts of definitions are also possible in a
+\begin_layout Enumerate
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
+default
\end_layout
\end_inset
- block.
- An example of the first would be:
-\end_layout
+: the default Bib\SpecialChar TeX
+ way to format citations, a simple numeric style (e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout LyX-Code
-!quotetitle
+g.,
\begin_inset Quotes eld
\end_inset
-%title%
+[1]
\begin_inset Quotes erd
\end_inset
-
+)
\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:
+\begin_layout Enumerate
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%!quotetitle%
+authoryear
\end_layout
\end_inset
-.
- \SpecialChar LyX
- will treat
+: Harvard-styled citations using author names and publication year (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
+\begin_inset Quotes eld
+\end_inset
+
+Smith and Miller (2017b)
+\begin_inset Quotes erd
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Enumerate
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%!quotetitle%
+numerical
\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
+: extended numerical citations that also allow for author or title next
+ to the number (e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout LyX-Code
-!funfun %funfun%
+g.,
+\begin_inset Quotes eld
+\end_inset
+
+Smith and Miller [1]
+\begin_inset Quotes erd
+\end_inset
+
+)
\end_layout
\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.
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteEngine
\end_layout
-\begin_layout Standard
-The second sort of special definition might look like this:
+\end_inset
+
+ blocks look like this:
\end_layout
\begin_layout LyX-Code
-B_pptext pp.
+CiteEngine default
\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_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+ cite
+\end_layout
-\begin_layout Plain Layout
-%B_pptext%
+\begin_layout LyX-Code
+ Citep*[][]
\end_layout
-\end_inset
+\begin_layout LyX-Code
+ citeyearpar[][]=parencite*
+\end_layout
-.
- Note that there are two different translation paths: All definitions starting
- with
+\begin_layout LyX-Code
+ ...
+\end_layout
+
+\begin_layout LyX-Code
+End
+\end_layout
+
+\begin_layout Standard
+The tag following
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-B_
+CiteEngine
\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:
+ 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
-_addtobib Add to bibliography only.
+LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
\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
+LyXName
\end_layout
\end_inset
- and the diverse
+: The name as used in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-*.citeengine
+*.lyx
\end_layout
\end_inset
- files.
- Note that these are not macros, in the sense just defined.
- They will not be expanded.
+ file.
\end_layout
+\begin_deeper
\begin_layout Standard
-So here then is an example that uses several of these features:
-\begin_inset VSpace defskip
-\end_inset
-
+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
\end_layout
-\begin_layout Standard
-\noindent
+\end_inset
-\family sans
-!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
+ sometimes, if the \SpecialChar LaTeX
+ command names differ).
\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 Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-author
+alias
\end_layout
\end_inset
- key is defined, or else prints the name of the editor, followed by the
-
+: a (comma-separated) list of commands that fall back to the given
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-B_edtext
+LyXName
\end_layout
\end_inset
- or its translation (it is by default
-\begin_inset Quotes eld
-\end_inset
-
-ed.
-\begin_inset Quotes erd
-\end_inset
-
-), if the
+ in the current engine.
+ This eases the switch of citation packages and engines.
+ The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-editor
+alias
\end_layout
\end_inset
- key is defined.
- Note that this is in fact defined in
+ can be compared to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdciteformats.inc
-\end_layout
-
-\end_inset
-
-, so you can use it in your own definitions, or re-definitions, if you load
- that file first.
+ObsoletedBy
\end_layout
-\begin_layout Section
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:Tags-for-XHTML"
-
\end_inset
-Tags for XHTML output
+ in layout definitions.
\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
+latexcmd
\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.
+: The actual \SpecialChar LaTeX
+ command that is output.
+
\end_layout
\begin_layout Standard
-Note that there are two tags,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+Alias
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-AddToHTMLPreamble
+latexcmd
\end_layout
\end_inset
- that may appear outside style and inset declarations.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:General-text-class"
-
-\end_inset
+ are optional.
+ If no
+\begin_inset Flex Code
+status collapsed
- for details on these.
+\begin_layout Plain Layout
+latexcmd
\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
+ is given, the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\SpecialChar LaTeX
-Type
+LyXName
\end_layout
\end_inset
- tag.
-
+ will be output to \SpecialChar LaTeX
+.
\end_layout
\begin_layout Standard
-For a command or normal paragraph, the output XHTML has the following form:
+Note further:
\end_layout
-\begin_layout LyX-Code
+\begin_layout Itemize
+Capitalization indicates that the command also has a capitalized form (
+\begin_inset Flex Code
+status collapsed
-\family sans
-<tag attr=
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+
+\backslash
+Latexcmd
+\end_layout
-value
-\begin_inset Quotes erd
\end_inset
->
+ vs.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+latexcmd
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\family sans
-<labeltag attr=
-\begin_inset Quotes erd
+).
+ These usually enforce up-casing of name prefixes (
+\emph on
+von Goethe
+\emph default
+
+\begin_inset Formula $\Rightarrow$
\end_inset
-value
-\begin_inset Quotes erd
+
+\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
->Label</labeltag>
+ indicate the number of optional arguments (there can be 0–2).
\end_layout
-\begin_layout LyX-Code
+\begin_layout Itemize
+A star
+\begin_inset Flex Code
+status collapsed
-\family sans
-Contents of the paragraph.
+\begin_layout Plain Layout
+*
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\family sans
-</tag>
+ indicates there is a starred version of the command (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+latexcmd*
\end_layout
-\begin_layout Standard
-The label tags are of course omitted if the paragraph does not have a label.
+\end_inset
+
+ vs.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+latexcmd
\end_layout
-\begin_layout Standard
-For an environment that is not some sort of list, the XHTML takes this form:
+\end_inset
+
+).
+
\end_layout
-\begin_layout LyX-Code
+\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
-\family sans
-<tag attr=
+et al.
\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
+ due to the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
\end_inset
->
+ threshold.
\end_layout
-\begin_layout LyX-Code
+\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
+
+\begin_layout Plain Layout
+<!_stardesc!_stardesctooltip>
+\end_layout
-\family sans
-<itemtag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
+.
+ Maximal two translatable macro keywords, marked by the prefix
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!_
+\end_layout
+
\end_inset
-><labeltag attr=
-\begin_inset Quotes erd
+, can be given.
+ The first points to the string that replaces the
+\begin_inset Quotes eld
\end_inset
-value
+Full aut&hor list
\begin_inset Quotes erd
\end_inset
->Environment Label</labeltag>First paragraph.</itemtag>
+ checkbox label in the citation dialog, the second one to an optional tool
+ tip for this checkbox.
+
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+Note that these two macros have to be defined in a
+\begin_inset Flex Code
+status collapsed
-\family sans
-<itemtag>Second paragraph.</itemtag>
+\begin_layout Plain Layout
+CiteFormat
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\family sans
-</tag>
+ (see next section), dropping the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!
\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_inset
+
+ from the prefix, like this:
\end_layout
-\begin_layout Standard
-For a list, we have one of these forms:
+\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
+$
+\end_layout
-\family sans
-<tag attr=
-\begin_inset Quotes erd
\end_inset
-value
+ indicates that this command features
+\begin_inset Quotes eld
+\end_inset
+
+qualified citation lists
\begin_inset Quotes erd
\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.
+\change_inserted -712698321 1526898670
+
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
-\family sans
-<itemtag attr=
-\begin_inset Quotes erd
+\change_inserted -712698321 1526899524
+If you want to add a cite command to a cite engine (e.
+\begin_inset space \thinspace{}
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
+g., add a specific command provided by a class), you can use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1526898768
+AddToCiteEngine <engine type> \SpecialChar ldots
+ End
+\change_unchanged
+
+\end_layout
-><labeltag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
+.
+ 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"
+
\end_inset
->List Label</labeltag>First item.</itemtag>
+Cite format description
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\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:
+\end_layout
+
+\begin_layout LyX-Code
+CiteFormat
+\end_layout
+
+\begin_layout LyX-Code
+ article ...
+\end_layout
+
+\begin_layout LyX-Code
+ book ...
+\end_layout
+
+\begin_layout LyX-Code
+End
+\end_layout
+
+\begin_layout Standard
+or
+\end_layout
+
+\begin_layout LyX-Code
+CiteFormat
+\end_layout
+
+\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
+
+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
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdciteformats.inc
+\end_layout
+
+\end_inset
+
+, which is included in most of \SpecialChar LyX
+'s document classes.
+\end_layout
+
+\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
+
+\backslash
+cite
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+citet
+\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
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+*.citeengine
+\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
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%
+\end_layout
+
+\end_inset
+
+ signs, e.g.:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%author%
+\end_layout
+
+\end_inset
+
+.
+ So a simple definition might look like this:
+\end_layout
+
+\begin_layout LyX-Code
+misc %author%,
+\begin_inset Quotes eld
+\end_inset
+
+%title%
+\begin_inset Quotes erd
+\end_inset
+
+.
+\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
+{%volume%[[vol.
+\begin_inset space ~
+\end_inset
+
+%volume%]]}
+\end_layout
+
+\end_inset
+
+.
+ This says: If the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+volume
+\end_layout
+
+\end_inset
+
+ key exists, then print
+\begin_inset Quotes eld
+\end_inset
+
+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
+
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+Here, the
+\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
+
+ed.
+\begin_inset Quotes erd
+\end_inset
+
+ Note that the key is again enclosed in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%
+\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
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+[[
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+]]
+\end_layout
+
+\end_inset
+
+
+\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
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%dialog%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+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
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%export%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ 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
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%next%[[true]]}
+\end_layout
+
+\end_inset
+
+: 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_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%second%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ if this is the second of multiple items, else the
+\begin_inset Quotes eld
+\end_inset
+
+false
+\begin_inset Quotes erd
+\end_inset
+
+ part
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifstar%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+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
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifentrytype:<type>%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ if the current entry type matches
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<type>
+\end_layout
+
+\end_inset
+
+, else the false part (e.g., in a citation definition:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifentrytype:book%[[this is a book]][[this is no book]]}
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifmultiple:<authortype>%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+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
+{%ifmultiple:editor%[[eds.]][[ed.]]}
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifqualified%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+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
+We said that
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%author%
+\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
+
+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_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.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<nametype:author>
+\end_layout
+
+\end_inset
+
+):
+\end_layout
+
+\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
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) when
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+ is reached.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%fullnames:<nametype>%
+\end_layout
+
+\end_inset
+
+: 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
+%forceabbrvnames:<nametype>%
+\end_layout
+
+\end_inset
+
+: 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
+
+\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:
+\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
+\end_inset
+
+) when
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+ is reached.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%fullbynames:<nametype>%
+\end_layout
+
+\end_inset
+
+: 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
+%forceabbrvbynames:<nametype>%
+\end_layout
+
+\end_inset
+
+: 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
+
+\end_inset
+
+.
+\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_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<nametype>
+\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):
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%abbrvciteauthor%
+\end_layout
+
+\end_inset
+
+: 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
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+ is reached.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%fullciteauthor%
+\end_layout
+
+\end_inset
+
+: 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
+%forceabbrvciteauthor%
+\end_layout
+
+\end_inset
+
+: 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
+
+\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
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!firstnameform %surname%, %prename%
+\end_layout
+
+\end_inset
+
+ (first author in lists of type 1)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!othernameform %surname%, %prename%
+\end_layout
+
+\end_inset
+
+ (other authors in lists of type 1)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!firstbynameform %prename% %surname%
+\end_layout
+
+\end_inset
+
+ (first author in lists of type 2)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!otherbynameform %prename% %surname%
+\end_layout
+
+\end_inset
+
+ (other authors in lists of type 2)
+\end_layout
+
+\begin_layout Standard
+This allows you to configure namings like
+\begin_inset Quotes eld
+\end_inset
+
+Miller, Peter and Mary Smith: \SpecialChar ldots
+, in: John Doe and Pat Green, eds.:\SpecialChar ldots
+
+\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
+
+\end_inset
+
+.
+ This defines a piece of formatting information that is to be used when
+ creating
+\begin_inset Quotes eld
+\end_inset
+
+rich text
+\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
+\begin_inset Quotes eld
+\end_inset
+
+{!
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+!}
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Two special sorts of definitions are also possible in a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\end_layout
+
+\end_inset
+
+ block.
+ An example of the first would be:
+\end_layout
+
+\begin_layout LyX-Code
+!quotetitle
+\begin_inset Quotes eld
+\end_inset
+
+%title%
+\begin_inset Quotes erd
+\end_inset
+
+
+\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:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%!quotetitle%
+\end_layout
+
+\end_inset
+
+.
+ \SpecialChar LyX
+ will treat
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%!quotetitle%
+\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
+
+\begin_layout LyX-Code
+!funfun %funfun%
+\end_layout
+
+\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.
+\end_layout
+
+\begin_layout Standard
+The second sort of special definition might look like this:
+\end_layout
+
+\begin_layout LyX-Code
+B_pptext pp.
+\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_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%B_pptext%
+\end_layout
+
+\end_inset
+
+.
+ Note that there are two different translation paths: All definitions starting
+ with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+B_
+\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.
+\end_layout
+
+\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
+
+\end_inset
+
+ and the diverse
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+*.citeengine
+\end_layout
+
+\end_inset
+
+ files.
+ Note that these are not macros, in the sense just defined.
+ They will not be expanded.
+\end_layout
+
+\begin_layout Standard
+So here then is an example that uses several of these features:
+\begin_inset VSpace defskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\noindent
+
+\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
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+author
+\end_layout
+
+\end_inset
+
+ key is defined, or else prints the name of the editor, followed by the
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+B_edtext
+\end_layout
+
+\end_inset
+
+ 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
+editor
+\end_layout
+
+\end_inset
+
+ key is defined.
+ Note that this is in fact defined in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdciteformats.inc
+\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"
+
+\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_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+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
+HTMLPreamble
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+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"
+
+\end_inset
+
+ 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
+\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
+
+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
+
+>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
+\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
+Family
+\end_layout
+
+\end_inset
+
+,
+\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
-\family sans
-<itemtag attr=
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-value
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -970929547 1496610966
+\SpecialChar LaTeX
+Type
+\change_unchanged
-><labeltag attr=
-\begin_inset Quotes erd
-\end_inset
+\end_layout
-value
-\begin_inset Quotes erd
\end_inset
->List Label</labeltag>Second item.</itemtag>
+ tag.
+
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
-\family sans
-</tag>
+\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
-\family sans
-<tag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
-\end_inset
-
->
+\change_inserted -970929547 1496610966
+Contents of the paragraph.
\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
+\change_inserted -970929547 1496610966
+</tag>
+\end_layout
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
->First item.</itemtag>
+\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
-\family sans
-<labeltag attr=
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -970929547 1515109671
+<tag attr>
+\end_layout
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
->List Label</labeltag><itemtag attr=
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -970929547 1496612114
+<itemtag>First paragraph.</itemtag>
+\end_layout
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
->Second item.</itemtag>
+\change_inserted -970929547 1496610966
+<itemtag>Second paragraph.</itemtag>
\end_layout
\begin_layout LyX-Code
-\family sans
+\change_inserted -970929547 1496610966
</tag>
\end_layout
\begin_layout Standard
-Note the different orders of
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-labeltag
+\change_inserted -970929547 1515109825
+For a list, the resulting DocBook takes this form:
\end_layout
-\end_inset
-
- and
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-itemtag
+\change_inserted -970929547 1515109672
+<tag attr>
\end_layout
-\end_inset
-
-.
- Which order we get depends upon the setting of
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-HTMLLabelFirst
+\change_inserted -970929547 1515109676
+<itemtag attr>First item.</itemtag>
\end_layout
-\end_inset
-
-: If
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-HTMLLabelFirst
+\change_inserted -970929547 1515109678
+<itemtag attr>Second item.</itemtag>
\end_layout
-\end_inset
+\begin_layout LyX-Code
- 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.
+\change_inserted -970929547 1496610966
+</tag>
\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.
+
+\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
-HTMLAttr
+
+\change_inserted -970929547 1515109656
+DocBookAttr
+\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,
+] Specifies attribute information to be output with the main tag, replacing
+
\begin_inset Quotes eld
\end_inset
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
+\change_inserted -970929547 1515110057
+attr
+\change_unchanged
-\begin_layout Plain Layout
-class=`layoutname'
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-, where
-\begin_inset Flex Code
-status collapsed
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
+\change_unchanged
-\begin_layout Plain Layout
-layoutname
\end_layout
-\end_inset
+\begin_layout Description
- 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
+\change_inserted -970929547 1496612296
\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
+\change_inserted -970929547 1496612269
+DocBookTag
+\change_unchanged
-\begin_layout Plain Layout
-HTMLForceCSS
\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
-
+] The tag to be used for this inset, replacing
+\begin_inset Quotes eld
\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
+\change_inserted -970929547 1496612296
+tag
+\change_unchanged
-\begin_layout Plain Layout
-0
\end_layout
\end_inset
-.
-\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\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
-\begin_layout Plain Layout
-HTMLItem
\end_layout
-\end_inset
+\begin_layout Subsection
- [
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111533
+InsetLayout DocBook
+\change_unchanged
-\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 Standard
-\begin_layout Plain Layout
-itemtag
+\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
- in the examples above.
- Defaults to
-\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
-div
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515110861
+<wrappertag wrapperattr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
-.
+\change_inserted -970929547 1515110868
+ <tag attr>
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-HTMLItemAttr
+\change_inserted -970929547 1515110869
+ <innertag innerattr>
\end_layout
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-string
+\change_inserted -970929547 1515110869
+ Contents of the inset.
\end_layout
-\end_inset
-
-] Attributes for the item tag.
- Defaults to
-\begin_inset Newline newline
-\end_inset
+\begin_layout LyX-Code
+\change_inserted -970929547 1515110870
+ </innertag>
+\end_layout
-\begin_inset Quotes eld
-\end_inset
+\begin_layout LyX-Code
+\change_inserted -970929547 1515110871
+ </tag>
+\end_layout
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-class=`layoutname_item'
+\change_inserted -970929547 1515111172
+</wrappertag>
\end_layout
-\end_inset
+\begin_layout Standard
+\change_inserted -970929547 1515111186
+For an itemising inset, it rather looks like this:
+\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 1515111186
+<wrappertag wrapperattr>
+\end_layout
-\begin_layout Plain Layout
-HTMLStyle
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111186
+ <tag attr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
- for that purpose.
+\change_inserted -970929547 1515111186
+ <innertag innerattr>
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-HTMLLabel
+\change_inserted -970929547 1515111362
+ <itemwrappertag itemwrapperattr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
- [
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111364
+ <itemlabeltag itemattr>
+\end_layout
-\begin_layout Plain Layout
-string
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111367
+ Label of the first item.
\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 1515111362
+ </itemtag>
+\change_unchanged
-\begin_layout Plain Layout
-labeltag
\end_layout
-\end_inset
-
- in the examples above.
- Defaults to
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-span
+\change_inserted -970929547 1515111517
+ <itemtag itemattr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
-, unless
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111517
+ <itemtag itemattr>
+\change_unchanged
-\begin_layout Plain Layout
-LabelType
\end_layout
-\end_inset
-
- is either
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-Top_Environment
+\change_inserted -970929547 1515111516
+ Contents of the first item.
\end_layout
-\end_inset
+\begin_layout LyX-Code
- or
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111514
+ </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 1515111247
+ </itemtag>
+\change_unchanged
-\begin_layout Plain Layout
-div
\end_layout
-\end_inset
+\begin_layout LyX-Code
-.
+\change_inserted -970929547 1515111221
+ </itemwrappertag>
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-HTMLLabelAttr
+\change_inserted -970929547 1515111370
+ <itemwrappertag itemwrapperattr>
\end_layout
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-string
+\change_inserted -970929547 1515111370
+ <itemlabeltag itemattr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
-] Attributes for the label tag.
- Defaults to
-\begin_inset Newline newline
-\end_inset
+\change_inserted -970929547 1515111372
+ Label of the second item.
+\end_layout
+\begin_layout LyX-Code
-\begin_inset Quotes eld
-\end_inset
+\change_inserted -970929547 1515111370
+ </itemtag>
+\change_unchanged
+\end_layout
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-class=`layoutname_label'
+\change_inserted -970929547 1515111504
+ <itemtag itemattr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
+\change_inserted -970929547 1515111505
+ <itemtag itemattr>
+\change_unchanged
-\begin_inset Quotes erd
-\end_inset
+\end_layout
-.
- This should
-\emph on
-not
-\emph default
- contain any style information.
- Use
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-HTMLStyle
+\change_inserted -970929547 1515111507
+ Contents of the second item.
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111509
+ </itemtag>
+\change_unchanged
- for that purpose.
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-HTMLLabelFirst
-\end_layout
+\change_inserted -970929547 1515111251
+ </itemtag>
+\change_unchanged
-\end_inset
+\end_layout
- [
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
+\change_inserted -970929547 1515111221
+ </itemwrappertag>
+\change_unchanged
-\emph on
-0
-\emph default
-,1
\end_layout
-\end_inset
+\begin_layout LyX-Code
-] 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
+\change_inserted -970929547 1515111219
+ ...
+\change_unchanged
-\begin_layout Plain Layout
-<dt>\SpecialChar ldots
-</dt><dd>\SpecialChar ldots
-</dd>
\end_layout
-\end_inset
+\begin_layout LyX-Code
-.
- Default is
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111186
+ </innertag>
+\end_layout
-\begin_layout Plain Layout
-0
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111186
+ </tag>
\end_layout
-\end_inset
+\begin_layout LyX-Code
-: The label tag is output inside the item tag.
+\change_inserted -970929547 1515111186
+</wrappertag>
\end_layout
-\begin_layout Description
+\begin_layout Standard
+
+\change_inserted -970929547 1515111183
+If the inset permits multiple paragraphs—that is, if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+
+\change_inserted -970929547 1496610966
+MultiPar
+\change_unchanged
+
\end_layout
\end_inset
- Information to be output in the
-\begin_inset Flex Code
-status collapsed
+ 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 Plain Layout
-<head>
+\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
-\end_inset
+\begin_layout Description
- section when this style is used.
- This might, for example, be used to include a
+\change_inserted -970929547 1515110317
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<script>
+
+\change_inserted -970929547 1515109695
+DocBookAttr
+\change_unchanged
+
\end_layout
\end_inset
- block defining an
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-onclick
+
+\change_inserted -970929547 1496611854
+string
+\change_unchanged
+
\end_layout
\end_inset
- handler.
-\end_layout
+] Specifies attribute information to be output with the main tag, replacing
+
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+
+\change_inserted -970929547 1515110044
+attr
+\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 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 1515110973
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<style>
+
+\change_inserted -970929547 1515110319
+DocBookInInfo
+\change_unchanged
+
\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
+\change_inserted -970929547 1515110384
+never, always, maybe
+\change_unchanged
-.
\end_layout
-\begin_layout Description
+\end_inset
+
+] Specifies whether this tag goes into the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLTag
+
+\change_inserted -970929547 1515110412
+<info>
+\change_unchanged
+
\end_layout
\end_inset
- [
+ tag at the beginning of the parent layout.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\change_inserted -970929547 1515110437
+never
+\change_unchanged
+
\end_layout
\end_inset
-] The tag to be used for the main label, replacing
+ indicates that the tag never goes into
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tag
+
+\change_inserted -970929547 1515110497
+<info>
+\change_unchanged
+
\end_layout
\end_inset
- in the examples above.
- Defaults to
+ (this is default value, and corresponds to usual content).
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
-\end_layout
-\end_inset
+\change_inserted -970929547 1515110517
+always
+\change_unchanged
-.
\end_layout
-\begin_layout Description
+\end_inset
+
+ indicates that the tag always goes into
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLTitle
+
+\change_inserted -970929547 1515110514
+<info>
+\change_unchanged
+
\end_layout
\end_inset
- [
+ (this corresponds to usual metadata): if there is no
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
-\emph default
-,1
+\change_inserted -970929547 1515110550
+<info>
+\change_unchanged
+
\end_layout
\end_inset
-] Marks this style as the one to be used to generate the
+ tag for the parent, one
+\series bold
+will
+\series default
+ be generated.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<title>
+
+\change_inserted -970929547 1515110540
+maybe
+\change_unchanged
+
\end_layout
\end_inset
- tag for the XHTML file.
- By default, it is false.
- The
+ indicates that the tag may go into
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdtitle.inc
+
+\change_inserted -970929547 1515110538
+<info>
+\change_unchanged
+
\end_layout
\end_inset
- file sets it to true for the
+ (this is only the case for titles): if there is no
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-title
+
+\change_inserted -970929547 1515110585
+<info>
+\change_unchanged
+
\end_layout
\end_inset
- environment.
+ 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 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 1515111461
+\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
+\change_inserted -970929547 1515110974
+DocBookItemAttr
+\change_unchanged
- insets (insets you can type into) and is not true for
-\begin_inset Quotes eld
-\end_inset
+\end_layout
-command
-\begin_inset Quotes erd
\end_inset
- insets (insets that are associated with dialog boxes).
-\end_layout
+ [
+\begin_inset Flex Code
+status collapsed
-\end_inset
+\begin_layout Plain Layout
- Here, too, \SpecialChar LyX
- tries to provide sensible defaults, and it constructs default
- CSS style rules.
- But everything can be customized.
-\end_layout
+\change_inserted -970929547 1515110973
+string
+\change_unchanged
-\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
+] Specifies attribute information to be output with the item tag, replacing
+
+\begin_inset Quotes eld
\end_inset
->
-\end_layout
-\begin_layout LyX-Code
-<labeltag>Label</labeltag>
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -970929547 1515110984
+itemattr
+\change_unchanged
+
\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>
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
\end_layout
-\begin_layout LyX-Code
-</tag>
-\end_layout
+\begin_layout Description
-\begin_layout Standard
-If the inset permits multiple paragraphs—that is, if
+\change_inserted -970929547 1515111471
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+
+\change_inserted -970929547 1515111465
+DocBookItemInnerAttr
+\change_unchanged
+
\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
+
+\change_inserted -970929547 1515111461
+string
+\change_unchanged
+
\end_layout
\end_inset
-.
- The inner tag is optional and, by default, does not appear.
-\end_layout
+] Specifies attribute information to be output with the item inner tag,
+ replacing
+\begin_inset Quotes eld
+\end_inset
-\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
+
+\change_inserted -970929547 1515111476
+iteminnerattr
+\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 1515111494
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-\end_inset
+\change_inserted -970929547 1515111467
+DocBookItemInnerTag
+\change_unchanged
-] Specifies attribute information to be output with the main tag.
- For example,
-\begin_inset Quotes eld
-\end_inset
+\end_layout
+\end_inset
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`myinset' onclick=`\SpecialChar ldots
-'
-\end_layout
-\end_inset
+\change_inserted -970929547 1515111461
+string
+\change_unchanged
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
- By default, \SpecialChar LyX
- will output
+] 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=`insetname'
+
+\change_inserted -970929547 1515111486
+iteminnertag
+\change_unchanged
+
\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 Flex Code
-status collapsed
-\begin_layout Plain Layout
-string
+\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
-] The tag to be used for the main label, replacing
+\change_inserted -970929547 1515110906
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tag
+
+\change_inserted -970929547 1515110104
+DocBookInnerTag
+\change_unchanged
+
\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
+
+\change_inserted -970929547 1515110104
+string
+\change_unchanged
+
\end_layout
\end_inset
-: If
+] 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
- is true, the default is
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+
+\change_inserted -970929547 1515110791
+NONE
+\change_unchanged
+
\end_layout
\end_inset
-; if it is false, 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
-span
+
+\change_inserted -970929547 1515110665
+DocBookSectionTag
+\change_unchanged
+
\end_layout
\end_inset
-.
-\end_layout
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain 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