#LyX 2.4 created this file. For more info see https://www.lyx.org/
-\lyxformat 575
+\lyxformat 608
\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 utf8
\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
\use_refstyle 0
\use_minted 0
\use_lineno 0
-\lineno_options
\notefontcolor #0000ff
\branch OutDated
\selected 0
\filename_suffix 0
-\color #f5fae7
+\color #f5fae7 #0a0518
\end_branch
\index Index
\shortcut idx
\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
+\docbook_mathml_prefix 1
+\author -970929547 "Thibaut Cuvelier"
\author -712698321 "Jürgen Spitzmüller"
+\author -584632292 "Richard Kimberly Heck"
\author -495245474 "Jean-Marc Lasgouttes"
+\author 5863208 "ab"
+\author 34634807 "Jean-Pierre"
+\author 232239728 "Owner"
\author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
+\author 1075283030 "Thibaut"
\end_header
\begin_body
status collapsed
\begin_layout Plain Layout
-\noindent
If you have comments or error corrections, please send them to the \SpecialChar LyX
Documentatio
n mailing list,
\end_inset
in the subject header, and please cc the current maintainer of this file,
- Richard Heck <rgheck@comcast.net>.
+ Richard
+\change_inserted 5863208 1604930692
+Kimberly
+\change_unchanged
+Heck <
+\change_inserted 5863208 1604930729
+rikiheck@lyx.org
+\change_deleted 5863208 1604930668
+rikiheck@lyx.org
+\change_unchanged
+>.
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
-Version 2.3.x
+Version 2.4.x
\end_layout
\begin_layout Standard
\end_inset
- and its sub-directories contain a number of files and that can be used
- to customize \SpecialChar LyX
+ and its sub-directories contain a number of files
+\change_deleted 232239728 1604787780
+and
+\change_unchanged
+ that can be used to customize \SpecialChar LyX
's behavior.
You can change many of these files from within \SpecialChar LyX
itself through the
\end_layout
\begin_layout Standard
-The files, which are to be found in
+The files found in
\begin_inset Flex Noun
status collapsed
\end_inset
-, are generated when you configure \SpecialChar LyX
+ are generated when you configure \SpecialChar LyX
.
- They contain various default values that are guessed by inspection.
+ They contain various default values that are
+\change_inserted 5863208 1604919565
+automatically detected during reconfiguration.
+\change_deleted 232239728 1604788241
+guessed by inspection
+\change_unchanged
In general, it is not a good idea to modify them, since they might be overwritt
en at any time.
\end_layout
\end_inset
- contains defaults for various commands.
+
+\change_deleted 5863208 1604919950
+
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 232239728 1604853928
+I capitalized the first word in all of these lists.
+ To me it looks better but it really is a stylistic thing, your call.
+ However if you are not going to capitalize them, the english in some needs
+ to be modified to make it read correctly as a sentence.
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\change_deleted 232239728 1604853510
+c
+\change_inserted 232239728 1604853510
+C
+\change_unchanged
+ontains defaults for various commands.
\end_layout
\begin_layout Labeling
\end_inset
- contains the list of packages that have been recognized by \SpecialChar LyX
+
+\change_deleted 232239728 1604853512
+c
+\change_inserted 232239728 1604853512
+C
+\change_unchanged
+ontains the list of packages that have been recognized by \SpecialChar LyX
.
It is currently unused by the \SpecialChar LyX
program itself, but the information extracted,
\end_inset
- the list of text classes that have been found in your
+
+\change_deleted 232239728 1604853515
+t
+\change_inserted 232239728 1604853515
+T
+\change_unchanged
+he list of text classes that have been found in your
\begin_inset Flex Code
status collapsed
\end_inset
- the list of layout modules found in your
+
+\change_deleted 232239728 1604853518
+t
+\change_inserted 232239728 1604853518
+T
+\change_unchanged
+he list of layout modules found in your
\begin_inset Flex Code
status collapsed
\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex Code
-status collapsed
+status open
\begin_layout Plain Layout
*files.lst
\end_inset
- lists of various sorts of \SpecialChar LaTeX
+
+\change_deleted 232239728 1604853523
+l
+\change_inserted 232239728 1604853523
+L
+\change_unchanged
+ists of various sorts of \SpecialChar LaTeX
-related files found on your system
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex Code
-status collapsed
+status open
\begin_layout Plain Layout
doc/\SpecialChar LaTeX
\end_layout
\begin_layout Standard
-These directories are duplicated between
+The
+\change_deleted 5863208 1604928729
+se
+\change_unchanged
+
+\change_inserted 5863208 1604928636
+following
+\change_unchanged
+directories
+\change_inserted 5863208 1604928661
+in
+\change_unchanged
+
\begin_inset Flex Code
status collapsed
\end_inset
- and
+
+\change_inserted 5863208 1604928662
+ can be
+\change_deleted 5863208 1604928642
+are
+\change_unchanged
+ duplicated
+\change_deleted 5863208 1604928669
+between
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXDir
+\end_layout
+
+\end_inset
+
+ and
+\change_inserted 5863208 1604928680
+in
+\change_unchanged
+
\begin_inset Flex Code
status collapsed
\end_inset
.
- If a particular files exists in both places, the one in
+ If a particular file
+\change_deleted 232239728 1604794430
+s
+\change_unchanged
+ exists in both places, the one in
\begin_inset Flex Code
status collapsed
\end_inset
- this directory contains files with the extension
+
+\change_deleted 232239728 1604794460
+t
+\change_inserted 232239728 1604794460
+T
+\change_unchanged
+his directory contains files with the extension
\begin_inset Flex Code
status collapsed
\end_inset
- contains files with the extension
+
+\change_deleted 232239728 1604794478
+c
+\change_inserted 232239728 1604794478
+C
+\change_unchanged
+ontains files with the extension
\begin_inset Flex Code
status collapsed
\end_inset
- contains graphics files that can be included in documents.
+
+\change_deleted 232239728 1604794483
+c
+\change_inserted 232239728 1604794486
+C
+\change_unchanged
+ontains graphics files that can be included in documents.
\end_layout
\end_inset
- contains \SpecialChar LyX
+
+\change_deleted 232239728 1604794492
+c
+\change_inserted 232239728 1604794492
+C
+\change_unchanged
+ontains \SpecialChar LyX
documentation files (including the one you are currently reading).
The file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+
+\change_deleted 232239728 1604794660
\SpecialChar LaTeX
+
+\change_inserted 232239728 1604794661
+LaTex
+\change_unchanged
Config.lyx
\end_layout
\end_inset
- contains example files that explain how to use some features.
+
+\change_deleted 232239728 1604794497
+c
+\change_inserted 232239728 1604794497
+C
+\change_unchanged
+ontains example files that explain how to use some features.
In the file browser, press the
\begin_inset Flex Noun
status collapsed
\end_inset
- contains image files that are used by the
+
+\change_deleted 232239728 1604794500
+c
+\change_inserted 232239728 1604794500
+C
+\change_unchanged
+ontains image files that are used by the
\begin_inset Flex Noun
status collapsed
\end_inset
- contains keyboard keymapping files.
+
+\change_deleted 232239728 1604794505
+c
+\change_inserted 232239728 1604794505
+C
+\change_unchanged
+ontains keyboard keymapping files.
See
\begin_inset CommandInset ref
LatexCommand ref
\end_inset
- contains the text class and module files described in
+
+\change_deleted 232239728 1604794508
+c
+\change_inserted 232239728 1604794508
+C
+\change_unchanged
+ontains the text class and module files described in
\begin_inset CommandInset ref
LatexCommand ref
reference "cha:Installing-New-Document"
\end_inset
- contains the
+
+\change_deleted 232239728 1604794513
+c
+\change_inserted 232239728 1604794513
+C
+\change_unchanged
+ontains the
\begin_inset Flex Code
status collapsed
Python scripts used to convert between \SpecialChar LyX
versions.
- These can be run from the command line if, say, you want to batch-convert
- files.
+ These can be run from the command line if
+\change_deleted 232239728 1604794749
+, say,
+\change_unchanged
+ you want to batch-convert files.
\end_layout
\begin_layout Labeling
\end_inset
- contains some files that demonstrate the capabilities of the
+
+\change_deleted 232239728 1604794516
+c
+\change_inserted 232239728 1604794516
+C
+\change_unchanged
+ontains some files that demonstrate the capabilities of the
\begin_inset Flex Noun
status collapsed
\end_inset
- contains the standard \SpecialChar LyX
+
+\change_deleted 232239728 1604794520
+c
+\change_inserted 232239728 1604794520
+C
+\change_unchanged
+ontains the standard \SpecialChar LyX
template files described in
\begin_inset CommandInset ref
LatexCommand ref
\end_inset
- contains files with the extension
+
+\change_deleted 232239728 1604794524
+c
+\change_inserted 232239728 1604794524
+C
+\change_unchanged
+ontains files with the extension
\begin_inset Flex Code
status collapsed
\end_inset
- contains files with the extension
+
+\change_deleted 232239728 1604794528
+c
+\change_inserted 232239728 1604794528
+C
+\change_unchanged
+ontains files with the extension
\begin_inset Flex Code
status collapsed
\end_inset
- this file contains the list of \SpecialChar LyX
+
+\change_deleted 232239728 1604797616
+t
+\change_inserted 232239728 1604797616
+T
+\change_unchanged
+his file contains the list of \SpecialChar LyX
developers.
The contents are displayed with the menu entry
\begin_inset Flex Noun
\end_inset
- this is a \SpecialChar LaTeX
+
+\change_deleted 232239728 1604797620
+t
+\change_inserted 232239728 1604797620
+T
+\change_unchanged
+his is a \SpecialChar LaTeX
script used during the configuration process.
Do not run directly.
\end_layout
\end_inset
- this is a Python script that is used to re-configure \SpecialChar LyX
+
+\change_deleted 232239728 1604797624
+t
+\change_inserted 232239728 1604797624
+T
+\change_unchanged
+his is a Python script that is used to re-configure \SpecialChar LyX
.
It creates configuration files in the directory it was run from.
\end_layout
\end_inset
- this contains tables describing how different character encodings can be
+
+\change_deleted 232239728 1604797580
+t
+\change_inserted 232239728 1604797580
+T
+\change_unchanged
+his contains tables describing how different character encodings can be
mapped to Unicode
\end_layout
\end_inset
- this file contains a list of all the languages currently supported by \SpecialChar LyX
+
+\change_deleted 232239728 1604797584
+t
+\change_inserted 232239728 1604797584
+T
+\change_unchanged
+his file contains a list of all the languages currently supported by \SpecialChar LyX
.
\end_layout
\end_inset
- contains information about the supported fonts.
+
+\change_deleted 232239728 1604797587
+c
+\change_inserted 232239728 1604797587
+C
+\change_unchanged
+ontains information about the supported fonts.
\end_layout
\begin_layout Labeling
\end_inset
- this file contains translations for internationalized paragraph styles
- (see
+
+\change_deleted 232239728 1604797591
+t
+\change_inserted 232239728 1604797591
+T
+\change_unchanged
+his file contains translations for internationalized paragraph styles (see
+
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:I18n"
\end_inset
- this file contains information about Unicode-encoded glyphs and the way
- they are supported by \SpecialChar LyX
+
+\change_deleted 232239728 1604797594
+t
+\change_inserted 232239728 1604797594
+T
+\change_unchanged
+his file contains information about Unicode-encoded glyphs and the way they
+ are supported by \SpecialChar LyX
via \SpecialChar LaTeX
.
\end_layout
\end_layout
\begin_layout Itemize
-If you get some updated documentation from \SpecialChar LyX
- ftp site and cannot install
- it because you do not have sysadmin rights on your system, you can just
- copy the files in
+If you get some updated documentation from
+\change_inserted 232239728 1604798171
+ a
+\change_unchanged
+ \SpecialChar LyX
+ ftp site and cannot install it because you do not have sysadmin rights
+ on your system, you can just copy the files
+\change_deleted 232239728 1604798193
+in
+\change_inserted 232239728 1604798193
+to
+\change_unchanged
+
\begin_inset Flex Code
status collapsed
\begin_layout Standard
The configuration freedom of the local configuration directory may not suffice
if you want to have more than one configuration at your disposal.
- For example, you may want to be use different key bindings or printer settings
- at different times.
+ For example, you may want to
+\change_deleted 232239728 1604798238
+be
+\change_unchanged
+use different key bindings or printer settings at different times.
You can achieve this by having several such directories.
You then specify which directory to use at run-time.
\end_layout
switch.) If the specified directory does not exist, \SpecialChar LyX
offers to create it
- for you, just like it does for the default directory on the first time
- you run the program.
+ for you, just like it does for the default directory
+\change_deleted 232239728 1604798318
+on
+\change_unchanged
+ the first time you run the program.
You can modify the configuration options in this additional user directory
exactly as you would for the default directory.
These directories are completely independent (but read on).
status collapsed
\begin_layout Plain Layout
-LYX_USERDIR_VER
+LYX_USERDIR_24x
\end_layout
\end_inset
\end_inset
-) which is configuration-specific.
+) which is configuration
+\change_deleted 232239728 1604798083
+-
+\change_inserted 232239728 1604798100
+
+\change_unchanged
+specific.
\end_layout
\begin_layout Chapter
\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
\end_layout
\begin_layout Chapter
+
+\change_inserted -584632292 1610232084
+Creating and
+\change_unchanged
Installing New Document Classes, Layouts, and Templates
\begin_inset CommandInset label
LatexCommand label
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_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
\change_inserted -712698321 1526898610
AddToCiteEngine <engine>
+\change_unchanged
+
\end_layout
\end_inset
\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_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>
+
+\change_inserted -970929547 1515112766
+string
+\change_unchanged
+
\end_layout
\end_inset
-] This tag indicates that the module (which is specified by filename without
- 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
-.module
+
+\change_inserted -970929547 1515112845
+article
+\change_unchanged
+
\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
+\begin_inset Quotes erd
\end_inset
- module that numbers theorems by section.
+.
+
+\change_deleted 1075283030 1594226862
+
+\change_inserted 1075283030 1594226777
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 1075283030 1594226859
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 1075283030 1594226785
+DocBookForceAbstract
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 1075283030 1594226804
+boolean
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] If
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+true
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+, the root element will always have an
+\family typewriter
+<abstract>
+\family default
+ tag.
+ The default value is
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+false
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\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
\end_inset
, which contains most of the basic layouts.
+\change_inserted -712698321 1611646803
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1611646804
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646837
+InputGlobal
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646804
+<filename>
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] is a variant of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646804
+Input
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ command which does not look for files in the user directory.
+ This allows to create a file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646804
+name.layout
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646804
+name.inc
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ in the user directory which includes a global file with the same name via
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646853
+InputGlobal name
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646855
+InputGlobal name.inc
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, respectively (with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646804
+Input
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, the file would recursively include itself).
+ This way, you can modify global files without having to completely copy
+ them.
+\change_unchanged
+
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1612018485
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ModifyStyle
+
+\change_inserted -712698321 1612018457
+ModifyInsetLayout
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<style>
+
+\change_inserted -712698321 1612018466
+<type>
+\change_unchanged
+
\end_layout
\end_inset
-] Modifies the properties of the given paragraph style.
- If the style does not exist, this section is ignored.
+] Modifies the layout of an inset.
+ If the layout does not exist, this section is ignored.
Must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -712698321 1612018452
End
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-NoCounter
+ModifyStyle
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<counter>
+<style>
\end_layout
\end_inset
-] Deletes an existing counter, usually one defined in an included file.
-\end_layout
+] Modifies the properties of the given paragraph style.
+ If the style does not exist, this section is ignored.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NoFloat
+End
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<float>
-\end_layout
+\begin_inset Quotes erd
\end_inset
-] Deletes an existing float.
- This is particularly useful when you want to suppress a float that has
- been defined in an input file.
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-NoStyle
+NoCounter
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<style>
+<counter>
\end_layout
\end_inset
-] Deletes an existing style.
+] Deletes an existing counter, usually one defined in an included file.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+NoFloat
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<float>
+\end_layout
+
+\end_inset
+
+] Deletes an existing float.
+ This is particularly useful when you want to suppress a float that has
+ been defined in an input file.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+NoStyle
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+] Deletes an existing style.
\end_layout
\begin_layout Description
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
.
+\change_inserted -712698321 1612018500
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1612018547
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1612018506
+ProvideInsetLayout
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1612018509
+<type>
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] Defines the layout of an inset if it does not already exist.
+ If the layout does exist, this section is ignored.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1612018500
+End
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\change_unchanged
+
\end_layout
\begin_layout Description
\change_inserted -712698321 1553617809
TableStyle
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1553617805
<name>
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1554308042
Formal_without_Footline
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1553618006
Simple_Grid
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1553618031
Grid_with_Head
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1553618043
Simple_Grid
+\change_unchanged
+
\end_layout
\end_inset
-, but with the header column offset with a second horizontal line.
+, but with the header
+\change_deleted 34634807 1619712593
+column
+\change_inserted 34634807 1619712594
+row
+\change_inserted -712698321 1553618309
+ offset with a second horizontal line.
This is also the default style of \SpecialChar LyX
.
\end_layout
\change_inserted -712698321 1553618261
No_Borders
+\change_unchanged
+
\end_layout
\end_inset
\end_inset
.
+
+\change_inserted -712698321 1565110196
+ Any number is possible.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1565110259
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565110199
+FontSizeFormat
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565110196
+string
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] The format for the font size option.
+ Default:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565110238
+$$spt
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565110248
+$$s
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ is a placeholder for the font size.
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_deleted 5863208 1594239483
\begin_inset Flex Code
status collapsed
\end_inset
.
+\change_inserted -712698321 1565101761
+
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1565180598
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PageStyle
+
+\change_inserted -712698321 1565101918
+PageSize
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string="empty|plain|headings|fancy"
+
+\change_inserted -712698321 1565105399
+string="letter|\SpecialChar allowbreak
+legal|\SpecialChar allowbreak
+executive|\SpecialChar allowbreak
+a0|\SpecialChar allowbreak
+a1|\SpecialChar allowbreak
+a2|\SpecialChar allowbreak
+a3|\SpecialChar allowbreak
+a4|\SpecialChar allowbreak
+a5|\SpecialChar allowbreak
+a6|\SpecialChar allowbreak
+b0|\SpecialChar allowbreak
+b1|\SpecialChar allowbreak
+b2|\SpecialChar allowbreak
+b3|\SpecialChar allowbreak
+b4|\SpecialChar allowbreak
+b5|\SpecialChar allowbreak
+b6|\SpecialChar allowbreak
+c0|\SpecialChar allowbreak
+c1|\SpecialChar allowbreak
+c
+2|\SpecialChar allowbreak
+c3|\SpecialChar allowbreak
+c4|\SpecialChar allowbreak
+c5|\SpecialChar allowbreak
+c6|\SpecialChar allowbreak
+b0j|\SpecialChar allowbreak
+b1j|\SpecialChar allowbreak
+b2j|\SpecialChar allowbreak
+b3j|\SpecialChar allowbreak
+b4j|\SpecialChar allowbreak
+b5j|\SpecialChar allowbreak
+b6j"
+\change_unchanged
+
\end_layout
\end_inset
-] The list of available page sty\SpecialChar softhyphen
-les, separated by
+] The list of available page sizes, separated by
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -712698321 1565101779
|
+\change_unchanged
+
\end_layout
\end_inset
\end_inset
.
+ Currently, only the listed sizes are supported.
+ Other sizes might be entered as custom class option.
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1565180623
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Other
+
+\change_inserted -712698321 1565180605
+PageSizeFormat
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+
+\change_inserted -712698321 1565180601
+string
+\change_unchanged
+
\end_layout
\end_inset
-] Some document class options, separated by a comma, that will be added
- to the optional part of the
+] The format for the page size option.
+ Default:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-documentclass
+\change_inserted -712698321 1565180618
+$$spaper
+\change_unchanged
+
\end_layout
\end_inset
- command.
-\end_layout
-
-\begin_layout Standard
-The
+.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+
+\change_inserted -712698321 1565180601
+$$s
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ is a placeholder for the paper size.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PageStyle
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string="empty|plain|headings|fancy"
+\end_layout
+
+\end_inset
+
+] The list of available page sty\SpecialChar softhyphen
+les, separated by
+\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
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Other
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string=""
+\end_layout
+
+\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_layout Plain Layout
+
+\backslash
+documentclass
+\end_layout
+
+\end_inset
+
+ command.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ClassOptions
\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
+
+\change_inserted -584632292 1615846868
+ The definition must end with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846867
+EndArgument
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+
+\change_unchanged
+
+\change_inserted -584632292 1615846880
+See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Arguments"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ for more information.
+
+\change_deleted -584632292 1615846694
+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
\begin_deeper
\begin_layout Quote
+\change_deleted -584632292 1615846694
+
\family typewriter
Argument 1
\end_layout
\begin_layout Quote
+\change_deleted -584632292 1615846694
+
\family typewriter
...
\end_layout
\begin_layout Quote
+\change_deleted -584632292 1615846694
+
\family typewriter
EndArgument
\end_layout
\begin_layout Quote
+\change_deleted -584632292 1615846694
+
\family typewriter
Argument 2
\end_layout
\begin_layout Quote
+\change_deleted -584632292 1615846694
+
\family typewriter
...
\end_layout
\begin_layout Quote
+\change_deleted -584632292 1615846694
+
\family typewriter
EndArgument
\end_layout
\begin_layout Standard
+
+\change_deleted -584632292 1615846694
Inside the
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_inset
-\change_inserted -712698321 1555579782
-
\end_layout
\begin_layout Itemize
-\change_inserted -712698321 1555579780
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\change_inserted -712698321 1555579780
NewlineCmd
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1555579780
[string]
+\change_unchanged
+
\end_layout
\end_inset
\backslash
+\change_unchanged
+
\end_layout
\end_inset
) to be used for line breaks.
The initial backslash must not be specified.
-\change_unchanged
-
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_inset
.
-\change_inserted -712698321 1559484228
-
\end_layout
\begin_layout Itemize
-\change_inserted -712698321 1559484228
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\change_inserted -712698321 1559484228
FreeSpacing
+\change_unchanged
+
\end_layout
\end_inset
\emph on
0
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1559484228
1
+\change_unchanged
+
\end_layout
\end_inset
\end_inset
.
-\change_unchanged
-
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\change_deleted -712698321 1559484200
Currently, only one argument per style\SpecialChar breakableslash
layout can be automatically inserted.
+\change_deleted -584632292 1615846694
+
+\end_layout
+
+\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559490711
+InsertOnNewline
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559490703
+[int=0]
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ If this is set to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559490703
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, this argument will be inserted on a new line with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491402
+AutoInsert
\change_unchanged
\end_layout
+\end_inset
+
+ (only available within Flex insets).
+\end_layout
+
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
+
+\change_deleted -584632292 1615846694
By default, the text entered in the \SpecialChar LyX
workarea in the respective layout is
the last (mandatory) argument of a command if the
\end_layout
\begin_layout Standard
+
+\change_deleted -584632292 1615846694
Arguments for list
\begin_inset Flex Code
status collapsed
\end_inset
).
-\change_inserted -712698321 1534487781
-
\end_layout
\begin_layout Standard
-\change_inserted -712698321 1534488561
+\change_deleted -584632292 1615846694
Finally, there is a special argument type with the prefix
\begin_inset Flex Code
status collapsed
\change_inserted -712698321 1534488412
Argument listpreamble:1
+\change_unchanged
+
\end_layout
\end_inset
Note that
\change_unchanged
\SpecialChar LyX
- will create protected blanks for the additional blanks when in
+ will create protected blanks for the additional blanks when
+\change_deleted 34634807 1619626461
+ in
+\change_unchanged
+
\change_inserted -495245474 1550490096
\begin_inset Flex Code
\change_inserted -495245474 1550490089
Passthru 1
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -495245474 1550247736
FreeSpacing
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -495245474 1550247755
KeepEmpty
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1523696950
NeedCProtect
+\change_unchanged
+
\end_layout
\end_inset
\emph on
0
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1523696950
1
+\change_unchanged
+
\end_layout
\end_inset
\backslash
cprotect
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1552395561
NeedMBoxProtect
+\change_unchanged
+
\end_layout
\end_inset
\emph on
0
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1552395557
1
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-StepMasterCounter
+Step
+\change_deleted 731793113 1604355211
+Master
+\change_inserted 731793113 1604355212
+Parent
+\change_unchanged
+Counter
\end_layout
\end_inset
\end_inset
-] Steps the master counter of a given counter at the beginning of a new
- sequence of layouts.
+] Steps the
+\change_deleted 731793113 1604355214
+master
+\change_inserted 731793113 1604355216
+parent
+\change_unchanged
+ 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
\end_inset
, which must be all caps.
+\change_inserted -712698321 1565605014
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1565605014
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565605014
+Requires
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565605014
+string
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+.
+\change_unchanged
+
\end_layout
\begin_layout Description
\end_layout
\begin_layout Standard
-Flex insets come in three different kinds:
+Flex insets come in
+\change_deleted 5863208 1594239511
+three
+\change_inserted 5863208 1594239512
+two
+\change_unchanged
+ different kinds:
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Itemize
+
+\change_deleted 5863208 1594239528
XML elements (
\begin_inset Flex Code
status collapsed
\end_inset
): For use with DocBook classes.
+\change_unchanged
+
\end_layout
\begin_layout Standard
\end_inset
- may be be any valid identifier not used by a pre-existing Flex inset.
+ may 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
\end_inset
- may be be any valid identifier of branch defined in user's document.
+ may 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
.
See
+\change_inserted -584632292 1615846847
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Arguments"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+
+\change_deleted -584632292 1615846847
+
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Paragraph-Styles"
\end_inset
- for details.
+
+\change_unchanged
+ for
+\change_deleted -584632292 1615846902
+details
+\change_inserted -584632292 1615846906
+more information
+\change_unchanged
+.
\end_layout
\begin_layout Description
\end_inset
-] Force a a line break in the \SpecialChar LaTeX
- output before the inset starts and after
- the inset ends.
+] Force 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
\end_inset
,
+\change_deleted -584632292 1615846609
+
\begin_inset Flex Code
status collapsed
\end_inset
- or
+
+\change_unchanged
+or
\begin_inset Flex Code
status collapsed
\change_inserted -712698321 1555575740
MenuString
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1555575740
[string]
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1555575781
My Inset|M
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1523633961
NeedCProtect
+\change_unchanged
+
\end_layout
\end_inset
\emph on
0
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1523633958
1
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1552395787
NeedMBoxProtect
+\change_unchanged
+
\end_layout
\end_inset
\emph on
0
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1552395787
1
+\change_unchanged
+
\end_layout
\end_inset
\backslash
cite
+\change_unchanged
+
\end_layout
\end_inset
\backslash
ref
+\change_unchanged
+
\end_layout
\end_inset
\backslash
mbox
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1555579658
NewlineCmd
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1555579651
[string]
+\change_unchanged
+
\end_layout
\end_inset
\end_inset
, while keeping backward compatibility.
+\change_inserted -712698321 1559491850
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1559492002
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491854
+ParbreakIgnored
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491850
+
+\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 1559491850
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] If this is set to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491881
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, paragraph breaks will be ignored in the output.
+ This might be useful for insets where the content should be alignable on
+ different lines only in the \SpecialChar LyX
+ workarea, without any effect in the output.
+\change_unchanged
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
+
+\emph on
0
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\emph on
1
\end_layout
\end_inset
-] Whether this inset should use the font of its surrounding environment
- or uses its own.
- Default is false: use the font of the surrounding environment.
-\end_layout
-
-\begin_layout Description
+]
+\change_inserted -712698321 1597733473
+If
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RightDelim
+
+\change_inserted -712698321 1597732178
+1
+\change_unchanged
+
\end_layout
\end_inset
- [
+, font changes are redone inside the respective inset (in the output) even
+ if the inset itself is in the context of this font changes (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\change_inserted -712698321 1597733683
+
+\backslash
+textbf{Sourrounding text
+\backslash
+myinset{
+\backslash
+textbf{content}}\SpecialChar ldots
+}
+\change_unchanged
+
\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
+ rather than
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<br/>
+
+\change_inserted -712698321 1597733686
+
+\backslash
+textbf{Sourrounding text
+\backslash
+myinset{content}\SpecialChar ldots
+}
+\change_unchanged
+
\end_layout
\end_inset
.
-\end_layout
+ Setting this makes sense for commands that internally reset font settings
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Description
+g., footnotes).
+ Note that wrongly setting this might lead to unwanted result (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Spellcheck
+
+\change_inserted -712698321 1597733688
+
+\backslash
+emph{Sourrounding text
+\backslash
+myinset{
+\backslash
+emph{content}}\SpecialChar ldots
+}
+\change_unchanged
+
\end_layout
\end_inset
- [
+, content is upright, as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
-\end_layout
-\end_inset
+\change_inserted -712698321 1597733278
+
+\backslash
+emph
+\change_unchanged
+
+\end_layout
-,
-\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
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-1
-\end_layout
-
-\end_inset
+\change_inserted -712698321 1597733292
+0
+\change_unchanged
-] Allow spell-checking the contents of this inset.
- Default is true.
\end_layout
-\begin_layout Subsection
-Counters
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Counters"
-
\end_inset
+\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 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
+RightDelim
\end_layout
\end_inset
-,
-\begin_inset Flex Noun
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-figure
+string
\end_layout
\end_inset
-, \SpecialChar ldots
-) in the text class itself.
- The standard counters are defined in the file
+] 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
-stdcounters.inc
+<br/>
\end_layout
\end_inset
-, so you may have to do no more than add
+.
\end_layout
-\begin_layout LyX-Code
-Input stdcounters.inc
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\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:
+\begin_layout Plain Layout
+Spellcheck
\end_layout
-\begin_layout LyX-Code
-Counter CounterName
-\end_layout
+\end_inset
-\begin_layout Standard
-where of course `
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CounterName
+0
\end_layout
\end_inset
-' is replaced by the name of the counter.
- And it must end with
-\begin_inset Quotes eld
+,
+\begin_inset space \thinspace{}
\end_inset
status collapsed
\begin_layout Plain Layout
-End
+
+\emph on
+1
\end_layout
\end_inset
+] Allow spell-checking the contents of this inset.
+ Default is true.
+\change_inserted -584632292 1615846659
+
+\end_layout
+
+\begin_layout Subsection
+
+\change_inserted -584632292 1615846729
+Arguments
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Arguments"
-\begin_inset Quotes erd
\end_inset
-.
- The following parameters can also be used:
+
\end_layout
-\begin_layout Description
+\begin_layout Standard
+
+\change_inserted -584632292 1615846807
+Both paragraph styles and inset layouts allow for
+\emph on
+arguments
+\emph default
+ as well as the main content.
+ This is especially useful for things like section headings and only makes
+ sense with \SpecialChar LaTeX
+.
+ Each (optional or required) argument of a command or environment—except
+ for the required argument that is associated with the content—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
-InitialValue
+
+\change_inserted -584632292 1615846730
+EndArgument
+\change_unchanged
+
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-int=1
+.
+ So a command with two optional arguments looks like:
\end_layout
-\end_inset
+\begin_layout Quote
-] Sets the initial value for the counter, to which it will be reset whenever
- that happens.
- Normally, one will want the default, 1.
+\change_inserted -584632292 1615846730
+
+\family typewriter
+Argument 1
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout Quote
-\begin_layout Plain Layout
-LabelString
+\change_inserted -584632292 1615846730
+
+\family typewriter
+...
\end_layout
-\end_inset
+\begin_layout Quote
- [
-\begin_inset Flex Code
-status collapsed
+\change_inserted -584632292 1615846730
-\begin_layout Plain Layout
-string
+\family typewriter
+EndArgument
\end_layout
-\end_inset
+\begin_layout Quote
-=
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -584632292 1615846730
+\family typewriter
+Argument 2
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Quote
-] When defined, this string defines how the counter is displayed.
- Setting this value sets
-\begin_inset Flex Code
-status collapsed
+\change_inserted -584632292 1615846730
-\begin_layout Plain Layout
-LabelStringAppendix
+\family typewriter
+...
\end_layout
-\end_inset
+\begin_layout Quote
- to the same value.
- The following special constructs can be used in the string:
+\change_inserted -584632292 1615846730
+
+\family typewriter
+EndArgument
\end_layout
-\begin_deeper
-\begin_layout Itemize
+\begin_layout Standard
+
+\change_inserted -584632292 1615846730
+Inside the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-thecounter
+\change_inserted -584632292 1615846730
+Argument
+\change_unchanged
+
\end_layout
\end_inset
- will be replaced by the expansion of the
+ definition, the following specifications are possible:
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
LabelString
+\change_unchanged
+
\end_layout
\end_inset
- (or
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
+
\end_layout
\end_inset
-) of the counter
+ 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
-counter
-\end_layout
-\end_inset
+\change_inserted -584632292 1615846730
+MenuString
+\change_unchanged
-.
-
\end_layout
-\begin_layout Itemize
-counter values can be expressed using \SpecialChar LaTeX
--like macros
-\begin_inset Newline newline
\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 Flex Code
-status collapsed
+|
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
-\backslash
+g.
+\begin_inset space \space{}
+\end_inset
-\emph on
-numbertype
-\emph default
-{
-\emph on
-counter
-\emph default
-}
-\end_layout
+\begin_inset Quotes eld
\end_inset
-, where
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-numbertype
+\change_inserted -584632292 1615846730
+Short Title|S
+\change_unchanged
+
\end_layout
\end_inset
- can be:
-\begin_inset Foot
-status collapsed
-\begin_layout Plain Layout
+\begin_inset Quotes erd
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Actually, the situation is a bit more complicated: any
-\family default
-\series default
-\shape default
-\emph default
-\bar default
-
-\size default
-\emph on
-\noun default
-\color inherit
-numbertype
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
- other than those described below will produce arabic numerals.
- It would not be surprising to see this change in the future.
+).
\end_layout
-\end_inset
+\begin_layout Itemize
-
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-arabic
+
+\change_inserted -584632292 1615846730
+MenuString
+\change_unchanged
+
\end_layout
\end_inset
-: 1, 2, 3,\SpecialChar ldots
-;
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-alph
+
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
+
\end_layout
\end_inset
- for lower-case letters: a, b, c, \SpecialChar ldots
-;
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Alph
-\end_layout
+ 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_inset Quotes erd
\end_inset
- for upper-case letters: A, B, C, \SpecialChar ldots
-;
-\begin_inset Flex Code
-status collapsed
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Plain Layout
-roman
-\end_layout
+g.
+\begin_inset space \space{}
+\end_inset
+
+\begin_inset Quotes eld
\end_inset
- for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
-;
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Roman
+
+\change_inserted -584632292 1615846730
+Short Title|S
+\change_unchanged
+
\end_layout
\end_inset
- for upper-case roman numerals: I, II, III\SpecialChar ldots
-;
+
+\begin_inset Quotes erd
+\end_inset
+
+).
+ This specification is optional.
+ If it is not given the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-hebrew
+
+\change_inserted -584632292 1615846730
+LabelString
+\change_unchanged
+
\end_layout
\end_inset
- for hebrew numerals.
+ will be used instead for the menu.
\end_layout
-\end_deeper
-\begin_layout Standard
-If LabelString is not defined, a default value is constructed as follows:
- if the counter has a master counter
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-master
+
+\change_inserted -584632292 1615846730
+Tooltip
+\change_unchanged
+
\end_layout
\end_inset
- (defined via
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Within
+
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
+
\end_layout
\end_inset
-), the string
-\begin_inset Newline newline
-\end_inset
+ A longer explanatory text that appears in the tooltip when hovering over
+ the argument inset.
+\end_layout
+\begin_layout Itemize
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-themaster.
-\backslash
-arabic{counter}
+\change_inserted -584632292 1615846730
+Mandatory
+\change_unchanged
+
\end_layout
\end_inset
- is used; otherwise the string
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-arabic{counter}
+\change_inserted -584632292 1615846730
+
+\emph on
+0
+\change_unchanged
+
\end_layout
\end_inset
- is used.
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+
+\change_inserted -584632292 1615846730
+1
+\change_unchanged
+
\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
-string
-\end_layout
-
-\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -584632292 1615846730
+{...}
+\change_unchanged
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] Same as
+, while optional arguments are delimited by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+
+\change_inserted -584632292 1615846730
+[...]
+\change_unchanged
+
\end_layout
\end_inset
-, but for use in the Appendix.
+
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PrettyFormat
+
+\change_inserted -584632292 1615846730
+NewlineCmd
+\change_unchanged
+
\end_layout
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
+
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+ Option to define a different command (from the default
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -584632292 1615846730
-] 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
+\backslash
-Section 2.4
-\begin_inset Quotes erd
-\end_inset
+\backslash
-.
- The string should contain
-\begin_inset Quotes eld
-\end_inset
+\change_unchanged
+
+\end_layout
-##
-\begin_inset Quotes erd
\end_inset
-.
- This will be replaced by the counter number itself.
- So, for sections, it would be: Section ##.
+) to be used for line breaks.
+ The initial backslash must not be specified.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Within
+
+\change_inserted -584632292 1615846730
+Requires
+\change_unchanged
+
\end_layout
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\change_inserted -584632292 1615846730
+[int=0]
+\change_unchanged
+
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+ defines another argument (by its number) which this argument requires to
+ be output if it is itself output.
+ E.
+\begin_inset space \thinspace{}
\end_inset
+g., in \SpecialChar LaTeX
+ commands, optional arguments often require previous optional arguments
+ to be output (at least empty), as in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+
+\backslash
+command[][argument]{text}
+\change_unchanged
+
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] If this is set to the name of another counter, the present counter will
- be reset every time the other one is increased.
- For example,
+.
+ This can be achieved by the statement
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-subsection
+
+\change_inserted -584632292 1615846730
+Requires 1
+\change_unchanged
+
\end_layout
\end_inset
- is numbered inside
+ within
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-section
+
+\change_inserted -584632292 1615846730
+Argument 2
+\change_unchanged
+
\end_layout
\end_inset
.
\end_layout
-\begin_layout Subsection
-Font description
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Font-description"
+\begin_layout Itemize
-\end_inset
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
-\end_layout
+\change_inserted -584632292 1615846730
+LeftDelim
+\change_unchanged
-\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
+\end_inset
+
-\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
-Color
+
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
+
\end_layout
\end_inset
- [
+ defines a custom left delimiter (instead of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-none
+\change_inserted -584632292 1615846730
+{
+\change_unchanged
+
\end_layout
\end_inset
-,
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-black
+
+\change_inserted -584632292 1615846730
+[
+\change_unchanged
+
\end_layout
\end_inset
-,
+).
+ A line break in the output can be indicated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-white
+
+\change_inserted -584632292 1615846730
+<br/>
+\change_unchanged
+
\end_layout
\end_inset
-,
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-red
+
+\change_inserted -584632292 1615846730
+RightDelim
+\change_unchanged
+
\end_layout
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-green
+
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
+
\end_layout
\end_inset
-,
+ defines a custom right delimiter (instead of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-blue
+
+\change_inserted -584632292 1615846730
+}
+\change_unchanged
+
\end_layout
\end_inset
-,
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-cyan
+
+\change_inserted -584632292 1615846730
+]
+\change_unchanged
+
\end_layout
\end_inset
-,
+).
+ A line break in the output can be indicated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-magenta
+
+\change_inserted -584632292 1615846730
+<br/>
+\change_unchanged
+
\end_layout
\end_inset
-,
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-yellow
+
+\change_inserted -584632292 1615846730
+DefaultArg
+\change_unchanged
+
\end_layout
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-brown
+
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
+
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+ defines an argument that is inserted if and only if no user-specified arguments
+ were given, i.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Plain Layout
-darkgray
+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
-\end_inset
+\begin_layout Itemize
-,
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-gray
+
+\change_inserted -584632292 1615846730
+PresetArg
+\change_unchanged
+
\end_layout
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lightgray
+
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
+
\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_layout Itemize
+
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lime
+
+\change_inserted -584632292 1615846730
+Font
+\change_unchanged
+
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+ The font used for the argument content, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
-\begin_layout Plain Layout
-orange
+\end_inset
+
+.
\end_layout
-\end_inset
+\begin_layout Itemize
-,
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-olive
+
+\change_inserted -584632292 1615846730
+FreeSpacing
+\change_unchanged
+
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-pink
+
+\change_inserted -584632292 1615846730
+
+\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
-purple
+
+\change_inserted -584632292 1615846730
+1
+\change_unchanged
+
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
-\begin_layout Plain Layout
-teal
+\end_inset
+
+.
\end_layout
-\end_inset
+\begin_layout Itemize
-,
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-violet
+
+\change_inserted -584632292 1615846730
+LabelFont
+\change_unchanged
+
\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
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Family
+
+\change_inserted -584632292 1615846730
+Decoration
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
+\change_inserted -584632292 1615846730
+
\emph on
-Roman
+Classic
+\emph default
+, Minimalistic, Conglomerate
+\change_unchanged
+
\end_layout
\end_inset
-,
+] describes the rendering style used for the inset's frame and buttons.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sans
+
+\change_inserted -584632292 1615846730
+AutoInsert
+\change_unchanged
+
\end_layout
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Typewriter
-\end_layout
-\end_inset
+\change_inserted -584632292 1615846730
+[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
-Misc
+
+\change_inserted -584632292 1615846730
+1
+\change_unchanged
+
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-string
+, this argument is automatically inserted when the respective style is selected.
\end_layout
-\end_inset
+\begin_layout Itemize
-] Valid arguments are:
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-emph
+
+\change_inserted -584632292 1615846730
+InsertOnNewline
+\change_unchanged
+
\end_layout
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-noun
+
+\change_inserted -584632292 1615846730
+[int=0]
+\change_unchanged
+
\end_layout
\end_inset
-,
+ If this is set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-strikeout
+
+\change_inserted -584632292 1615846730
+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
-underbar
+
+\change_inserted -584632292 1615846730
+AutoInsert
+\change_unchanged
+
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-uuline
+ (only available within Flex insets).
\end_layout
-\end_inset
+\begin_layout Itemize
-,
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-uwave
+
+\change_inserted -584632292 1615846730
+InsertCotext
+\change_unchanged
+
\end_layout
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
+
+\change_inserted -584632292 1615846730
+[int=0]
+\change_unchanged
+
\end_layout
\end_inset
-,
+ If this is set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_noun
+
+\change_inserted -584632292 1615846730
+1
+\change_unchanged
+
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-no_strikeout
+, this argument will be inserted with a copy of the co-text (either selected
+ text or the whole paragraph) as content.
\end_layout
-\end_inset
+\begin_layout Itemize
-,
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_bar
+
+\change_inserted -584632292 1615846730
+PassThru
+\change_unchanged
+
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_uuline
+
+\change_inserted -584632292 1615846730
+
+\emph on
+inherited
+\emph default
+, true, false
+\change_unchanged
+
\end_layout
\end_inset
- and
+] 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
-no_uwave
+
+\change_inserted -584632292 1615846730
+PassThru
+\change_unchanged
+
\end_layout
\end_inset
-.
- Each of these turns on or off the corresponding attribute.
- For example,
+ 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
+
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-emph
+
+\change_inserted -584632292 1615846730
+PassThruChars
+\change_unchanged
+
\end_layout
\end_inset
- turns on emphasis, and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
+
+\change_inserted -584632292 1615846730
+string of characters
+\change_unchanged
+
\end_layout
\end_inset
- turns it off.
+]
+\family typewriter
-\begin_inset Newline newline
+\family default
+Defines individual characters
+\begin_inset Newline linebreak
\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
+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
-\end_inset
-
- would turn off the emphasis that was anyway in effect, say, in a theorem
- environment.
-\end_layout
+\begin_layout Itemize
-\begin_layout Description
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Series
+
+\change_inserted -584632292 1615846730
+IsTocCaption
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
+\change_inserted -584632292 1615846730
+
\emph on
-Medium
+0
+\change_unchanged
+
\end_layout
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Bold
+
+\change_inserted -584632292 1615846730
+1
+\change_unchanged
+
\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 Description
+\begin_layout Standard
+
+\change_inserted -584632292 1615846730
+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
-Shape
+
+\change_inserted -584632292 1615846730
+LatexType
+\change_unchanged
+
\end_layout
\end_inset
- [
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-Up
+\change_inserted -584632292 1615846730
+Command
+\change_unchanged
+
\end_layout
\end_inset
-,
+.
+ However, arguments with the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Italic
+
+\change_inserted -584632292 1615846730
+post:
+\change_unchanged
+
\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
-SmallCaps
+
+\change_inserted -584632292 1615846730
+post:1
+\change_unchanged
+
\end_layout
\end_inset
-,
+.
+ Post-arguments are ignored in any other
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Slanted
-\end_layout
-\end_inset
+\change_inserted -584632292 1615846730
+LatexType
+\change_unchanged
-]
\end_layout
-\begin_layout Description
+\end_inset
+
+ than
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Size
+
+\change_inserted -584632292 1615846730
+Command
+\change_unchanged
+
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-tiny
+.
\end_layout
-\end_inset
+\begin_layout Standard
-,
+\change_inserted -584632292 1615846730
+Arguments for list
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-small
+
+\change_inserted -584632292 1615846730
+
+\backslash
+item
+\change_unchanged
+
\end_layout
\end_inset
-,
+s (as in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-normal
+\change_inserted -584632292 1615846730
+
+\backslash
+item[foo]
+\change_unchanged
+
\end_layout
\end_inset
-,
+) have the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-large
+
+\change_inserted -584632292 1615846730
+item:
+\change_unchanged
+
\end_layout
\end_inset
-,
+ 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
-larger
+
+\change_inserted -584632292 1615846730
+Argument item:1
+\change_unchanged
+
\end_layout
\end_inset
-,
+).
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -584632292 1615846730
+Finally, there is a special argument type with the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-largest
+
+\change_inserted -584632292 1615846730
+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
-huge
+
+\change_inserted -584632292 1615846730
+Argument listpreamble:1
+\change_unchanged
+
\end_layout
\end_inset
+).
+ As the name implies, it is targeted at lists such as
+\family sans
+Itemize
+\family default
+,
+\family sans
+Enumerate
+\family default
,
+\family sans
+Description
+\family default
+, or
+\family sans
+Bibliography
+\family default
+.
+ Its content will be output at the list start, before the first
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-giant
+
+\change_inserted -584632292 1615846730
+
+\backslash
+item
+\change_unchanged
+
\end_layout
\end_inset
-]
+, on an own line (a place that is otherwise not accessible in \SpecialChar LyX
+).
+ This way, users can insert redefinitions (of lengths etc.) to individual
+ lists.
+ By default, these arguments do not have a delimiter.
+\change_unchanged
+
\end_layout
\begin_layout Subsection
+Counters
\begin_inset CommandInset label
LatexCommand label
-name "subsec:Citation-engine-description"
+name "subsec:Counters"
\end_inset
-Cite engine description
+
\end_layout
\begin_layout Standard
-The
-\begin_inset Flex Code
+It is necessary to define the counters (
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-CiteEngine
+chapter
\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"
-
-\end_inset
+,
+\begin_inset Flex Noun
+status collapsed
-), define the citation commands provided by a specific
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+figure
+\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
+, \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
-default
+stdcounters.inc
\end_layout
\end_inset
-: the default Bib\SpecialChar TeX
- way to format citations, a simple numeric style (e.
-\begin_inset space \thinspace{}
-\end_inset
+, so you may have to do no more than add
+\end_layout
-g.,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout LyX-Code
+Input stdcounters.inc
+\end_layout
-[1]
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+to your layout file to get them to work.
+ But if you want to define custom counters, then you can do so.
+ The counter declaration must begin with:
+\end_layout
-)
+\begin_layout LyX-Code
+Counter CounterName
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+where of course `
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-authoryear
+CounterName
\end_layout
\end_inset
-: Harvard-styled citations using author names and publication year (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.,
+' is replaced by the name of the counter.
+ And it must end with
\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
-numerical
+End
\end_layout
\end_inset
-: extended numerical citations that also allow for author or title next
- to the number (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.,
-\begin_inset Quotes eld
-\end_inset
-Smith and Miller [1]
\begin_inset Quotes erd
\end_inset
-)
+.
+ The following parameters can also be used:
\end_layout
-\begin_layout Standard
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteEngine
+InitialValue
\end_layout
\end_inset
- blocks look like this:
-\end_layout
+ [
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-CiteEngine default
+\begin_layout Plain Layout
+int=1
\end_layout
-\begin_layout LyX-Code
- cite
-\end_layout
+\end_inset
-\begin_layout LyX-Code
- Citep*[][]
+] 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 LyX-Code
- citeyearpar[][]=parencite*
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
- ...
+\begin_layout Plain Layout
+LabelString
\end_layout
-\begin_layout LyX-Code
-End
-\end_layout
+\end_inset
-\begin_layout Standard
-The tag following
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteEngine
+string
\end_layout
\end_inset
- denotes the engine.
- The individual lines respectively define a cite command or cite command
- paradigm supported by this engine.
- The line can be as simple as a cite command that is used both to name the
- respective \SpecialChar LyX
- command and the \SpecialChar LaTeX
- output or more complex in order to differentiate
- things.
- The full syntax is:
-\end_layout
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
-\end_layout
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
+
+] 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
-: The name as used in the
+ to the same value.
+ The following special constructs can be used in the string:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-*.lyx
+
+\backslash
+thecounter
\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
+ will be replaced by the expansion of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latexcmd
+LabelString
\end_layout
\end_inset
- sometimes, if the \SpecialChar LaTeX
- command names differ).
-\end_layout
-
-\end_deeper
-\begin_layout Itemize
+ (or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-alias
+LabelStringAppendix
\end_layout
\end_inset
-: a (comma-separated) list of commands that fall back to the given
+) of the counter
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXName
+counter
\end_layout
\end_inset
- in the current engine.
- This eases the switch of citation packages and engines.
- The
+.
+
+\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
-alias
+
+\backslash
+
+\emph on
+numbertype
+\emph default
+{
+\emph on
+counter
+\emph default
+}
\end_layout
\end_inset
- can be compared to
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ObsoletedBy
+
+\emph on
+numbertype
\end_layout
\end_inset
- in layout definitions.
+ can be:
+\begin_inset Foot
+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.
\end_layout
-\begin_layout Itemize
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latexcmd
+arabic
\end_layout
\end_inset
-: The actual \SpecialChar LaTeX
- command that is output.
-
+: 1, 2, 3,\SpecialChar ldots
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+alph
\end_layout
-\begin_layout Standard
+\end_inset
+
+ for lower-case letters: a, b, c, \SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Alias
+Alph
\end_layout
\end_inset
- and
+ for upper-case letters: A, B, C, \SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latexcmd
+roman
\end_layout
\end_inset
- are optional.
- If no
+ for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latexcmd
+Roman
\end_layout
\end_inset
- is given, the
+ for upper-case roman numerals: I, II, III\SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXName
+hebrew
\end_layout
\end_inset
- will be output to \SpecialChar LaTeX
-.
+ for hebrew numerals.
\end_layout
+\end_deeper
\begin_layout Standard
-Note further:
-\end_layout
-
-\begin_layout Itemize
-Capitalization indicates that the command also has a capitalized form (
+If LabelString is not defined, a default value is constructed as follows:
+ if the counter has a
+\change_deleted 731793113 1604355218
+master
+\change_inserted 731793113 1604355221
+parent
+\change_unchanged
+ counter
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-Latexcmd
+\change_deleted 731793113 1604355223
+master
+\change_inserted 731793113 1604355226
+parent
+\change_unchanged
+
\end_layout
\end_inset
- vs.
-
+ (defined via
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-latexcmd
+Within
\end_layout
\end_inset
-).
- These usually enforce up-casing of name prefixes (
-\emph on
-von Goethe
-\emph default
-
-\begin_inset Formula $\Rightarrow$
+), the string
+\begin_inset Newline newline
\end_inset
-
-\emph on
-Von Goethe
-\emph default
-).
-\end_layout
-\begin_layout Itemize
-Brackets
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[]
+
+\backslash
+the
+\change_inserted 731793113 1604355228
+parent
+\change_deleted 731793113 1604355230
+master
+\change_unchanged
+.
+\backslash
+arabic{counter}
\end_layout
\end_inset
- indicate the number of optional arguments (there can be 0–2).
-\end_layout
-
-\begin_layout Itemize
-A star
+ is used; otherwise the string
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-*
+
+\backslash
+arabic{counter}
\end_layout
\end_inset
- indicates there is a starred version of the command (
+ is used.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-latexcmd*
+LabelStringAppendix
\end_layout
\end_inset
- vs.
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-latexcmd
+string
\end_layout
\end_inset
-).
-
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
-By default, the starred version means: Output all authors even if it should
- be shortened with
+=
\begin_inset Quotes eld
\end_inset
-et al.
+
\begin_inset Quotes erd
\end_inset
- due to the
+] Same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MaxCiteNames
+LabelString
\end_layout
\end_inset
- threshold.
+, but for use in the Appendix.
+\change_inserted -584632292 1607202551
+
\end_layout
-\begin_layout Standard
-If the star has a different meaning for a given command, it can be specified
- in angle brackets:
+\begin_layout Description
+
+\change_inserted -584632292 1607202682
\begin_inset Flex Code
-status collapsed
+status open
\begin_layout Plain Layout
-<!_stardesc!_stardesctooltip>
+LaTeXName
\end_layout
\end_inset
-.
- Maximal two translatable macro keywords, marked by the prefix
+ [
\begin_inset Flex Code
-status collapsed
+status open
\begin_layout Plain Layout
-!_
+
+\change_inserted -584632292 1607202576
+string
+\change_unchanged
+
\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.
-
+] The counter name as used in \SpecialChar LaTeX
+.
+ (
+\change_inserted 34634807 1619711355
+e
+\change_deleted 34634807 1619711355
+E
+\change_inserted -584632292 1607202682
+.g., in \SpecialChar LyX
+, there is a counter named `theorem', but it is output to \SpecialChar LaTeX
+ as `thm'.)
+\change_unchanged
+
\end_layout
-\begin_layout Standard
-Note that these two macros have to be defined in a
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
+PrettyFormat
\end_layout
\end_inset
- (see next section), dropping the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-!
+string
\end_layout
\end_inset
- from the prefix, like this:
-\end_layout
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-_stardesc Sta&rred command label
+
+\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
+
+.
+ 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 LyX-Code
-_stardesctooltip Tooltip for the starred command checkbox.
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Within
\end_layout
-\end_deeper
-\begin_layout Itemize
-A dollar sign
+\end_inset
+
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$
+string
\end_layout
\end_inset
- indicates that this command features
-\begin_inset Quotes eld
+=
+\begin_inset Quotes erd
\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
+] 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
\end_layout
-\begin_layout Standard
-
-\change_inserted -712698321 1526899524
-If you want to add a cite command to a cite engine (e.
-\begin_inset space \thinspace{}
\end_inset
-g., add a specific command provided by a class), you can use
+ is numbered inside
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1526898768
-AddToCiteEngine <engine type> \SpecialChar ldots
- End
-\change_unchanged
-
+section
\end_layout
\end_inset
.
- Note that only cite commands that do not exist yet are added.
-\change_unchanged
-
\end_layout
\begin_layout Subsection
+Font description
\begin_inset CommandInset label
LatexCommand label
-name "subsec:Citation-format-description"
+name "subsec:Font-description"
\end_inset
-Cite format description
+
\end_layout
\begin_layout Standard
-The
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-CiteFormat
+A font description looks like this:
\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:
+\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
-CiteFormat
+ ...
\end_layout
\begin_layout LyX-Code
- article ...
+EndFont
\end_layout
-\begin_layout LyX-Code
- book ...
+\begin_layout Standard
+The following commands are available:
\end_layout
-\begin_layout LyX-Code
-End
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Color
\end_layout
-\begin_layout Standard
-or
+\end_inset
+
+ [
+\change_deleted -712698321 1607682984
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+none
\end_layout
-\begin_layout LyX-Code
-CiteFormat
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+black
\end_layout
-\begin_layout LyX-Code
- cite ...
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+white
\end_layout
-\begin_layout LyX-Code
- citet*[][] ...
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+red
\end_layout
-\begin_layout LyX-Code
-End
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+green
\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 Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+blue
+\end_layout
+
\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
+cyan
\end_layout
\end_inset
-, which is included in most of \SpecialChar LyX
-'s document classes.
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+magenta
\end_layout
-\begin_layout Standard
-In the second case, the lines define how a specific citation command (in
- the example
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+yellow
+\end_layout
-\backslash
-cite
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+brown
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+darkgray
+\end_layout
+
+\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
+
+\begin_layout Plain Layout
+lime
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+orange
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+olive
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+pink
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+purple
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+teal
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+violet
+\end_layout
+
+\end_inset
+
+
+\change_inserted -712698321 1607683139
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1607683135
+string
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] See appendix
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:Names-of-colors"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ for
+\change_deleted -712698321 1607683144
+]
+\change_inserted -712698321 1607683146
+valid arguments.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
+\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
+
+\emph on
+Roman
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Sans
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Typewriter
+\end_layout
+
+\end_inset
+
+]
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Misc
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Valid arguments are:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+emph
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+noun
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+strikeout
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+underbar
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+uuline
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+uwave
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_emph
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_noun
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_strikeout
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_bar
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_uuline
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_uwave
+\end_layout
+
+\end_inset
+
+.
+ Each of these turns on or off the corresponding attribute.
+ For example,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+emph
+\end_layout
+
+\end_inset
+
+ turns on emphasis, and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_emph
+\end_layout
+
+\end_inset
+
+ turns it off.
+
+\begin_inset Newline newline
+\end_inset
+
+If the latter seems puzzling, remember that the font settings for the present
+ context are generally inherited from the surrounding context.
+ So
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_emph
+\end_layout
+
+\end_inset
+
+ would turn off the emphasis that was anyway in effect, say, in a theorem
+ environment.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Series
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+Medium
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Bold
+\end_layout
+
+\end_inset
+
+]
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Shape
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+Up
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Italic
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+SmallCaps
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Slanted
+\end_layout
+
+\end_inset
+
+]
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Size
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tiny
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+small
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+normal
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+large
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+larger
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+largest
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+huge
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+giant
+\end_layout
+
+\end_inset
+
+]
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Citation-engine-description"
+
+\end_inset
+
+Cite engine description
+\end_layout
+
+\begin_layout Standard
+The
+\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"
+
+\end_inset
+
+), 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 Enumerate
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+default
+\end_layout
+
+\end_inset
+
+: the default Bib\SpecialChar TeX
+ way to format citations, a simple numeric style (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
+\begin_inset Quotes eld
+\end_inset
+
+[1]
+\begin_inset Quotes erd
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Enumerate
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+authoryear
+\end_layout
+
+\end_inset
+
+: 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
+numerical
+\end_layout
+
+\end_inset
+
+: extended numerical citations that also allow for author or title next
+ to the number (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
+\begin_inset Quotes eld
+\end_inset
+
+Smith and Miller [1]
+\begin_inset Quotes erd
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteEngine
+\end_layout
+
+\end_inset
+
+ blocks look like this:
+\end_layout
+
+\begin_layout LyX-Code
+CiteEngine default
+\end_layout
+
+\begin_layout LyX-Code
+ cite
+\end_layout
+
+\begin_layout LyX-Code
+ Citep*[][]
+\end_layout
+
+\begin_layout LyX-Code
+ citeyearpar[][]=parencite*
+\end_layout
+
+\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
+CiteEngine
+\end_layout
+
+\end_inset
+
+ denotes the engine.
+ The individual lines respectively define a cite command or cite command
+ paradigm supported by this engine.
+ The line can be as simple as a cite command that is used both to name the
+ respective \SpecialChar LyX
+ command and the \SpecialChar LaTeX
+ output or more complex in order to differentiate
+ things.
+ The full syntax is:
+\end_layout
+
+\begin_layout LyX-Code
+LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXName
+\end_layout
+
+\end_inset
+
+: The name as used in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+*.lyx
+\end_layout
+
+\end_inset
+
+ file.
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+For portability reasons, we try to use the same name for same-formatted
+ commands in different cite packages (thus many names stem from natbib,
+ and thus we need to differentiate a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latexcmd
+\end_layout
+
+\end_inset
+
+ sometimes, if the \SpecialChar LaTeX
+ command names differ).
+\end_layout
+
+\end_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+alias
+\end_layout
+
+\end_inset
+
+: a (comma-separated) list of commands that fall back to the given
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXName
+\end_layout
+
+\end_inset
+
+ in the current engine.
+ This eases the switch of citation packages and engines.
+ The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+alias
+\end_layout
+
+\end_inset
+
+ can be compared to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ObsoletedBy
+\end_layout
+
+\end_inset
+
+ in layout definitions.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latexcmd
+\end_layout
+
+\end_inset
+
+: The actual \SpecialChar LaTeX
+ command that is output.
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Alias
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latexcmd
+\end_layout
+
+\end_inset
+
+ are optional.
+ If no
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latexcmd
+\end_layout
+
+\end_inset
+
+ is given, the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXName
+\end_layout
+
+\end_inset
+
+ will be output to \SpecialChar LaTeX
+.
+\end_layout
+
+\begin_layout Standard
+Note further:
+\end_layout
+
+\begin_layout Itemize
+Capitalization indicates that the command also has a capitalized form (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+Latexcmd
+\end_layout
+
+\end_inset
+
+ vs.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+latexcmd
+\end_layout
+
+\end_inset
+
+).
+ These usually enforce up-casing of name prefixes (
+\emph on
+von Goethe
+\emph default
+
+\begin_inset Formula $\Rightarrow$
+\end_inset
+
+
+\emph on
+Von Goethe
+\emph default
+).
+\end_layout
+
+\begin_layout Itemize
+Brackets
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+[]
+\end_layout
+
+\end_inset
+
+ indicate the number of optional arguments (there can be 0–2).
+\end_layout
+
+\begin_layout Itemize
+A star
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+*
+\end_layout
+
+\end_inset
+
+ indicates there is a starred version of the command (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+latexcmd*
+\end_layout
+
+\end_inset
+
+ vs.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+latexcmd
+\end_layout
+
+\end_inset
+
+).
+
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+By default, the starred version means: Output all authors even if it should
+ be shortened with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+ due to the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\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:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<!_stardesc!_stardesctooltip>
+\end_layout
+
+\end_inset
+
+.
+ Maximal two translatable macro keywords, marked by the prefix
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!_
+\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
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\end_layout
+
+\end_inset
+
+ (see next section), dropping the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!
+\end_layout
+
+\end_inset
+
+ from the prefix, like this:
+\end_layout
+
+\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
+
+\end_inset
+
+ 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 Standard
+
+\change_inserted -712698321 1526899524
+If you want to add a cite command to a cite engine (e.
+\begin_inset space \thinspace{}
+\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
+
+\end_inset
+
+.
+ Note that only cite commands that do not exist yet are added.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Citation-format-description"
+
+\end_inset
+
+Cite format description
+\end_layout
+
+\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
-\backslash
-citet
+\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
-) 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
+value
+\begin_inset Quotes erd
+\end_inset
-\family default
- in specific
-\begin_inset Flex Code
-status collapsed
+>
+\end_layout
-\begin_layout Plain Layout
-*.citeengine
+\begin_layout LyX-Code
+<labeltag>Label</labeltag>
\end_layout
+\begin_layout LyX-Code
+<innertag attr=
+\begin_inset Quotes erd
\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"
-
+value
+\begin_inset Quotes erd
\end_inset
-).
+>Contents of the inset.</innertag>
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
\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
+If the inset permits multiple paragraphs—that is, if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%
+MultiPar
\end_layout
\end_inset
- signs, e.g.:
+ 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
-%author%
-\end_layout
-
-\end_inset
-
-.
- So a simple definition might look like this:
+span
\end_layout
-\begin_layout LyX-Code
-misc %author%,
-\begin_inset Quotes eld
-\end_inset
-
-%title%
-\begin_inset Quotes erd
\end_inset
.
+ The inner tag is optional and, by default, does not appear.
\end_layout
\begin_layout Standard
-This would print the author, followed by a comma, followed by the title,
- in quotes, followed by a period.
+The specific tags and attributes output for each inset can be controlled
+ by means of the following layout tags.
\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_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%volume%[[vol.
-\begin_inset space ~
-\end_inset
-
-%volume%]]}
+HTMLAttr
\end_layout
\end_inset
-.
- This says: If the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-volume
+string
\end_layout
\end_inset
- key exists, then print
+] Specifies attribute information to be output with the main tag.
+ For example,
\begin_inset Quotes eld
\end_inset
-vol.
-\begin_inset space ~
+
+\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
- followed by the volume key.
- It is also possible to have an else clause in the conditional, such as:
-\begin_inset Newline newline
+.
+ By default, \SpecialChar LyX
+ will output
+\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-{%author%[[%author%]][[%editor%, ed.]]}
+class=`insetname'
\end_layout
\end_inset
-.
-\begin_inset Newline newline
+
+\begin_inset Quotes erd
\end_inset
-Here, the
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-author
+insetname
\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
+ is the \SpecialChar LyX
+ name of the inset, made lowercase and with non-alphanumeric characters
+ converted to underscores, for example: footnote.
+\end_layout
- Note that the key is again enclosed in
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%
+HTMLForceCSS
\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
-[[
+
+\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_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
- and
-\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 0.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-.
- There must be no space between any of these.
+\begin_layout Plain Layout
+HTMLInnerAttr
\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]]}
+string
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
+] Attributes for the inner tag.
+ Defaults to
+\begin_inset Newline newline
\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]]}
+class=`insetname_inner'
\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
+.
+\end_layout
-false
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
- part for other contexts (workarea, dialog)
+\begin_layout Plain Layout
+HTMLInnerTag
\end_layout
-\begin_layout Itemize
+\end_inset
+
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%next%[[true]]}
+string
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
+] The inner tag, replacing
+\begin_inset Flex Code
+status collapsed
-true
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+innertag
+\end_layout
- part if another item follows (e.
-\begin_inset space \thinspace{}
\end_inset
-g., in a citation with multiple keys)
+ in the examples above.
+ By default, there is none.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%second%[[true]][[false]]}
+HTMLIsBlock
\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
+0,
+\emph on
+1
+\end_layout
-false
-\begin_inset Quotes erd
\end_inset
- part
+] 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 Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%ifstar%[[true]][[false]]}
+HTMLLabel
\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
- part for starred citation commands (such as
+] 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
-cite*
+arabic{footnote}
\end_layout
\end_inset
-), the false part for unstarred
+.
+ This is optional, and there is no default.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%ifentrytype:<type>%[[true]][[false]]}
+HTMLPreamble
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
+ Information to be output in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<head>
+\end_layout
-true
-\begin_inset Quotes erd
\end_inset
- if the current entry type matches
+ 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
-<type>
+<script>
\end_layout
\end_inset
-, else the false part (e.g., in a citation definition:
+ block defining an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%ifentrytype:book%[[this is a book]][[this is no book]]}
+onclick
\end_layout
\end_inset
-)
+ handler.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%ifmultiple:<authortype>%[[true]][[false]]}
+HTMLStyle
\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:
+ 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
-{%ifmultiple:editor%[[eds.]][[ed.]]}
+<style>
\end_layout
\end_inset
-)
+ block, so only the CSS itself need be included.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%ifqualified%[[true]][[false]]}
+HTMLTag
\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%
+string
\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
+] The tag to be used for the main label, replacing
+\begin_inset Flex Code
+status collapsed
-Miller, Peter and Smith, Mary and White, Jane
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+tag
+\end_layout
- (since
-\begin_inset Quotes eld
\end_inset
-and
-\begin_inset Quotes erd
-\end_inset
+ in the examples above.
+ The default depends upon the setting of
+\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
+MultiPar
\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
+
+: If
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<nametype>
+MultiPar
\end_layout
\end_inset
- part denotes the kind of list that is requested (e.g.
-
+ is true, the default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<nametype:author>
+div
\end_layout
\end_inset
-):
-\end_layout
-
-\begin_deeper
-\begin_layout Itemize
+; if it is false, the default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%abbrvnames:<nametype>%
+span
\end_layout
\end_inset
-: Provides a name list which is abbreviated (with
-\begin_inset Quotes eld
+.
+\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
-et al.
+value
\begin_inset Quotes erd
\end_inset
-) when
+>
+\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
-MaxCiteNames
+HTMLAttr
\end_layout
\end_inset
- is reached.
-\end_layout
-
-\begin_layout Itemize
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%fullnames:<nametype>%
+string
\end_layout
\end_inset
-: Provides a full name list (never abbreviated with
+] Specifies attribute information to be output with the main tag.
+ For example,
\begin_inset Quotes eld
\end_inset
-et al.
+
+\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
-).
-\end_layout
+.
+ By default, \SpecialChar LyX
+ will output
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%forceabbrvnames:<nametype>%
+class=`float float-floattype'
\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
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MaxCiteNames
+floattype
\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
+ 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"
-Miller, John: Some text, in: Mary Smith, ed.: A volume
-\begin_inset Quotes erd
\end_inset
-):
+), though made lowercase and with non-alphanumeric characters converted
+ to underscores, for example: float-table.
\end_layout
-\begin_deeper
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%abbrvbynames:<nametype>%
+HTMLStyle
\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
+ 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
-MaxCiteNames
+<style>
\end_layout
\end_inset
- is reached.
+ block, so only the CSS itself need be included.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%fullbynames:<nametype>%
+HTMLTag
\end_layout
\end_inset
-: Provides a full name list (never abbreviated with
-\begin_inset Quotes eld
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
\end_inset
-et al.
-\begin_inset Quotes erd
+] The tag to be used for this float, replacing
+\begin_inset Quotes eld
\end_inset
-).
-\end_layout
-\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%forceabbrvbynames:<nametype>%
+tag
\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
+ in the example above.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MaxCiteNames
+div
\end_layout
\end_inset
-.
+ and will rarely need changing.
\end_layout
-\end_deeper
-\begin_layout Enumerate
-And finally name lists which consist of family names only, as used in author-yea
-r citation labels.
- These do not take a
+\begin_layout Subsection
+Bibliography formatting
+\end_layout
+
+\begin_layout Standard
+The bibliography can be formatted using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<nametype>
+CiteFormat
\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):
+ blocks.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Citation-format-description"
+
+\end_inset
+
+ for the details.
\end_layout
-\begin_deeper
-\begin_layout Itemize
+\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
-%abbrvciteauthor%
+Family
\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
+Series
\end_layout
\end_inset
- is reached.
-\end_layout
-
-\begin_layout Itemize
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%fullciteauthor%
+Shape
\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
+, and
+\begin_inset Flex Code
+status collapsed
-).
+\begin_layout Plain Layout
+Size
\end_layout
-\begin_layout Itemize
+\end_inset
+
+ specified in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%forceabbrvciteauthor%
+Font
\end_layout
\end_inset
-: Provides a name list which is always abbreviated (with
-\begin_inset Quotes eld
+ declaration (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
\end_inset
-et al.
-\begin_inset Quotes erd
+).
+ The translation is mostly straightforward and obvious.
+ For example,
+\begin_inset Quotes eld
\end_inset
-) irrespective of
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MaxCiteNames
+Family Sans
\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_inset Quotes erd
+\end_inset
+
+ becomes
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-!firstnameform %surname%, %prename%
+font-family: sans-serif;
\end_layout
\end_inset
- (first author in lists of type 1)
-\end_layout
-\begin_layout Itemize
+\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
-!othernameform %surname%, %prename%
+getSizeCSS()
\end_layout
\end_inset
- (other authors in lists of type 1)
-\end_layout
-
-\begin_layout Itemize
-\begin_inset Flex Code
+ function in
+\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
-!firstbynameform %prename% %surname%
+
+src/FontInfo.cpp
\end_layout
\end_inset
- (first author in lists of type 2)
+ for the details.
+\change_inserted -970929547 1496610908
+
\end_layout
-\begin_layout Itemize
-\begin_inset Flex Code
-status collapsed
+\begin_layout Section
-\begin_layout Plain Layout
-!otherbynameform %prename% %surname%
-\end_layout
+\change_inserted -970929547 1496610966
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Tags-for-DocBook"
\end_inset
- (other authors in lists of type 2)
+Tags for DocBook output
\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
+\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_inset Quotes erd
-\end_inset
+\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
-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>!}
+\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
-\end_inset
+\begin_layout Subsection
-.
- This defines a piece of formatting information that is to be used when
- creating
-\begin_inset Quotes eld
-\end_inset
+\change_inserted 1075283030 1597699417
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Paragraph-Style-DocBook"
-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
+\change_deleted 1075283030 1597699417
- and
-\begin_inset Quotes eld
-\end_inset
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Paragraph-Style-XHTML-1"
-!}
-\begin_inset Quotes erd
\end_inset
-.
+
+\change_inserted -970929547 1496610966
+Paragraph styles
\end_layout
\begin_layout Standard
-Two special sorts of definitions are also possible in a
+
+\change_inserted -970929547 1496612059
+The sort of DocBook \SpecialChar LyX
+ outputs for a paragraph depends upon whether we are
+ dealing with a normal paragraph, a command, or an environment, where this
+ is itself determined by the contents of the corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
-\end_layout
-\end_inset
+\change_inserted -970929547 1496610966
+\SpecialChar LaTeX
+Type
+\change_unchanged
- 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
+ tag.
+
+\end_layout
+\begin_layout Standard
+\change_inserted -970929547 1496612107
+For a command or normal paragraph, the output DocBook has the following
+ form:
\end_layout
-\begin_layout 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 LyX-Code
-\begin_layout Plain Layout
-%!quotetitle%
+\change_inserted -970929547 1515109666
+<tag attr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
-.
- \SpecialChar LyX
- will treat
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1496610966
+Contents of the paragraph.
+\end_layout
-\begin_layout Plain Layout
-%!quotetitle%
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1496610966
+</tag>
\end_layout
-\end_inset
+\begin_layout Standard
- exactly as it would treat its definition.
- So, let us issue the obvious
-\emph on
-warning
-\emph default
-.
- Do not do this:
+\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
-!funfun %funfun%
+
+\change_inserted -970929547 1515109671
+<tag attr>
\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_layout LyX-Code
+
+\change_inserted -970929547 1496612114
+<itemtag>First paragraph.</itemtag>
\end_layout
-\begin_layout Standard
-The second sort of special definition might look like this:
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1496610966
+<itemtag>Second paragraph.</itemtag>
\end_layout
\begin_layout LyX-Code
-B_pptext pp.
+
+\change_inserted -970929547 1496610966
+</tag>
\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%
+\change_inserted -970929547 1515109825
+For a list, the resulting DocBook takes this form:
\end_layout
-\end_inset
+\begin_layout LyX-Code
-.
- Note that there are two different translation paths: All definitions starting
- with
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515109672
+<tag attr>
+\end_layout
-\begin_layout Plain Layout
-B_
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515109676
+<itemtag attr>First item.</itemtag>
\end_layout
-\end_inset
+\begin_layout LyX-Code
-, 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:
+\change_inserted -970929547 1515109678
+<itemtag attr>Second item.</itemtag>
\end_layout
\begin_layout LyX-Code
-_addtobib Add to bibliography only.
+
+\change_inserted -970929547 1496610966
+</tag>
\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
+\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
-\end_inset
+\begin_layout Description
- and the diverse
+\change_inserted -970929547 1515110057
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-*.citeengine
-\end_layout
-\end_inset
+\change_inserted -970929547 1515109656
+DocBookAttr
+\change_unchanged
- 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
+ [
+\begin_inset Flex Code
+status collapsed
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Standard
-\noindent
+\change_inserted -970929547 1496610966
+string
+\change_unchanged
-\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
+] Specifies attribute information to be output with the main tag, replacing
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-author
-\end_layout
-
+\begin_inset Quotes eld
\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
+
+\change_inserted -970929547 1515110057
+attr
+\change_unchanged
+
\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 example above.
+ This information can be used in further processing of the DocBook files.
+
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -970929547 1496612296
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-editor
+
+\change_inserted -970929547 1496612269
+DocBookTag
+\change_unchanged
+
\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
+\change_inserted -970929547 1496610966
+string
+\change_unchanged
-, 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
+] The tag to be used for this inset, replacing
+\begin_inset Quotes eld
\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
+
+\change_inserted -970929547 1496612296
+tag
+\change_unchanged
+
\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.
+\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_inserted 1075283030 1597698868
+
\end_layout
-\begin_layout Standard
-Note that there are two tags,
+\begin_layout Description
+
+\change_inserted 1075283030 1597699399
\begin_inset Flex Code
status collapsed
-\begin_layout Plain Layout
-HTMLPreamble
+\begin_layout Plain Layout
+
+\change_inserted 1075283030 1597698872
+DocBookTagType
+\change_unchanged
+
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToHTMLPreamble
+
+\change_inserted 1075283030 1597700585
+block, paragraph, inline
+\change_unchanged
+
\end_layout
\end_inset
- that may appear outside style and inset declarations.
- See
+] The new-line policy for this tag, see Section
+\begin_inset space ~
+\end_inset
+
+
\begin_inset CommandInset ref
LatexCommand ref
-reference "subsec:General-text-class"
+reference "subsec:DocBook-New-line-policy"
+plural "false"
+caps "false"
+noprefix "false"
\end_inset
- for details on these.
+ for the details.
+
+\change_unchanged
+
\end_layout
\begin_layout Subsection
+
+\change_inserted 1075283030 1597699385
+New-line policy
\begin_inset CommandInset label
LatexCommand label
-name "subsec:Paragraph-Style-XHTML"
+name "subsec:DocBook-New-line-policy"
\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
+
+\change_inserted 1075283030 1597698993
+For all tags, there are three possible policies for outputting new lines
+ (given in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\SpecialChar LaTeX
-Type
-\end_layout
-\end_inset
+\change_inserted 1075283030 1597698987
+DocBook*TagType
+\change_unchanged
- tag.
-
\end_layout
-\begin_layout Standard
-For a command or normal paragraph, the output XHTML has the following form:
+\end_inset
+
+ attribute):
\end_layout
-\begin_layout LyX-Code
+\begin_layout Itemize
-\family sans
-<tag attr=
-\begin_inset Quotes erd
+\change_inserted 1075283030 1597699279
+\begin_inset Quotes eld
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
->
-\end_layout
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
+\begin_layout Plain Layout
+
+\change_inserted 1075283030 1597699012
+block
+\change_unchanged
+
+\end_layout
-\family sans
-<labeltag attr=
-\begin_inset Quotes erd
\end_inset
-value
+
\begin_inset Quotes erd
\end_inset
->Label</labeltag>
+: the opening and closing tags are on their own lines (i.e.
+ a line feed after and before the opening and the closing tags).
+ Typical elements are floats.
+ For instance:
\end_layout
\begin_layout LyX-Code
-\family sans
-Contents of the paragraph.
+\change_inserted 1075283030 1597699194
+Content before
\end_layout
\begin_layout LyX-Code
-\family sans
-</tag>
+\change_inserted 1075283030 1597699194
+<blocktag>
\end_layout
-\begin_layout Standard
-The label tags are of course omitted if the paragraph does not have a label.
-\end_layout
+\begin_layout LyX-Code
-\begin_layout Standard
-For an environment that is not some sort of list, the XHTML takes this form:
+\change_inserted 1075283030 1597699098
+ Contents of the block.
\end_layout
\begin_layout LyX-Code
-\family sans
-<tag attr=
-\begin_inset Quotes erd
-\end_inset
+\change_inserted 1075283030 1597699196
+</blocktag>
+\end_layout
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
->
+\change_inserted 1075283030 1597699198
+Content after
\end_layout
-\begin_layout LyX-Code
+\begin_layout Itemize
-\family sans
-<itemtag attr=
-\begin_inset Quotes erd
+\change_inserted 1075283030 1597699289
+\begin_inset Quotes eld
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
-><labeltag attr=
-\begin_inset Quotes erd
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 1075283030 1597699113
+paragraph
+\change_unchanged
+
+\end_layout
+
\end_inset
-value
+
\begin_inset Quotes erd
\end_inset
->Environment Label</labeltag>First paragraph.</itemtag>
+: the opening and closing tags are on the same, new line; a line feed is
+ output before the opening tag and after the closing tag.
+ Typical elements are paragraphs and list items.
+ For instance:
\end_layout
\begin_layout LyX-Code
-\family sans
-<itemtag>Second paragraph.</itemtag>
+\change_inserted 1075283030 1597699186
+Content before
\end_layout
\begin_layout LyX-Code
-\family sans
-</tag>
+\change_inserted 1075283030 1597699357
+<paratag>Contents of the paragraph.</paratag>
\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 LyX-Code
-\begin_layout Standard
-For a list, we have one of these forms:
+\change_inserted 1075283030 1597699231
+Content after
\end_layout
-\begin_layout LyX-Code
+\begin_layout Itemize
-\family sans
-<tag attr=
-\begin_inset Quotes erd
+\change_inserted 1075283030 1597699343
+\begin_inset Quotes eld
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
->
-\end_layout
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
+\begin_layout Plain Layout
-\family sans
-<itemtag attr=
-\begin_inset Quotes erd
-\end_inset
+\change_inserted 1075283030 1597699307
+inline
+\change_unchanged
-value
-\begin_inset Quotes erd
-\end_inset
+\end_layout
-><labeltag attr=
-\begin_inset Quotes erd
\end_inset
-value
+
\begin_inset Quotes erd
\end_inset
->List Label</labeltag>First item.</itemtag>
+: the opening and closing tags are on the same line as the rest of the content.
+ No line feeds are output.
+ Typical elements are fonts.
+ For instance:
\end_layout
\begin_layout LyX-Code
-\family sans
-<itemtag attr=
-\begin_inset Quotes erd
-\end_inset
+\change_inserted 1075283030 1597699585
+Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
+\end_layout
-value
-\begin_inset Quotes erd
+\begin_layout Standard
+
+\change_inserted 1075283030 1597699585
+The default value is always
+\begin_inset Quotes eld
\end_inset
-><labeltag attr=
-\begin_inset Quotes erd
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 1075283030 1597699585
+block
+\change_unchanged
+
+\end_layout
+
\end_inset
-value
+
\begin_inset Quotes erd
\end_inset
->List Label</labeltag>Second item.</itemtag>
+.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Subsection
+
+\change_inserted -970929547 1515111533
+InsetLayout DocBook
+\change_unchanged
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -970929547 1496611894
+The DocBook output of insets can also be controlled by information in layout
+ files.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -970929547 1496612045
+The DocBook \SpecialChar LyX
+ outputs for an inset has the following form:
\end_layout
\begin_layout LyX-Code
-\family sans
-</tag>
+\change_inserted -970929547 1515110861
+<wrappertag wrapperattr>
\end_layout
\begin_layout LyX-Code
+\change_inserted -970929547 1515110868
+ <tag attr>
\end_layout
\begin_layout LyX-Code
-\family sans
-<tag attr=
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -970929547 1515110869
+ <innertag innerattr>
+\end_layout
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
->
+\change_inserted -970929547 1515110869
+ Contents of the inset.
\end_layout
\begin_layout LyX-Code
-\family sans
-<labeltag attr=
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -970929547 1515110870
+ </innertag>
+\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 1515110871
+ </tag>
+\end_layout
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
->First item.</itemtag>
+\change_inserted -970929547 1515111172
+</wrappertag>
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -970929547 1515111186
+For an itemising inset, it rather looks like this:
\end_layout
\begin_layout LyX-Code
-\family sans
-<labeltag attr=
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -970929547 1515111186
+<wrappertag wrapperattr>
+\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 1515111186
+ <tag attr>
+\end_layout
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
->Second item.</itemtag>
+\change_inserted -970929547 1515111186
+ <innertag innerattr>
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111362
+ <itemwrappertag itemwrapperattr>
\end_layout
\begin_layout LyX-Code
-\family sans
-</tag>
+\change_inserted -970929547 1515111364
+ <itemlabeltag itemattr>
\end_layout
-\begin_layout Standard
-Note the different orders of
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-labeltag
+\change_inserted -970929547 1515111367
+ Label of the first item.
\end_layout
-\end_inset
+\begin_layout LyX-Code
- and
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111362
+ </itemtag>
+\change_unchanged
-\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 LyX-Code
-\begin_layout Plain Layout
-HTMLLabelFirst
+\change_inserted -970929547 1515111517
+ <itemtag itemattr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
-: If
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111517
+ <itemtag itemattr>
+\change_unchanged
-\begin_layout Plain Layout
-HTMLLabelFirst
\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 1515111516
+ Contents of the first 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 LyX-Code
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111514
+ </itemtag>
+\change_unchanged
-\begin_layout Plain Layout
-HTMLAttr
\end_layout
-\end_inset
+\begin_layout LyX-Code
- [
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111247
+ </itemtag>
+\change_unchanged
-\begin_layout Plain Layout
-string
\end_layout
-\end_inset
+\begin_layout LyX-Code
-] Specifies attribute information to be output with the main tag.
- For example,
-\begin_inset Quotes eld
-\end_inset
+\change_inserted -970929547 1515111221
+ </itemwrappertag>
+\end_layout
+\begin_layout LyX-Code
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111370
+ <itemwrappertag itemwrapperattr>
+\end_layout
-\begin_layout Plain Layout
-class=`mydiv'
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111370
+ <itemlabeltag itemattr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
+\change_inserted -970929547 1515111372
+ Label of the second item.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
-.
- By default, \SpecialChar LyX
- will output
-\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'
+\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
-, where
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-layoutname
+\change_inserted -970929547 1515111507
+ Contents of the second item.
\end_layout
-\end_inset
+\begin_layout LyX-Code
- 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
+\change_inserted -970929547 1515111509
+ </itemtag>
+\change_unchanged
-\begin_layout Plain Layout
-HTMLStyle
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111251
+ </itemtag>
+\change_unchanged
- for that purpose.
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111221
+ </itemwrappertag>
+\change_unchanged
-\begin_layout Plain Layout
-HTMLForceCSS
\end_layout
-\end_inset
+\begin_layout LyX-Code
- [
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111219
+ ...
+\change_unchanged
-\begin_layout Plain Layout
+\end_layout
-\emph on
-0
-\emph default
-,1
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111186
+ </innertag>
\end_layout
-\end_inset
+\begin_layout LyX-Code
-] 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
+\change_inserted -970929547 1515111186
+ </tag>
+\end_layout
-\begin_layout Plain Layout
-HTMLStyle
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111186
+</wrappertag>
\end_layout
-\end_inset
+\begin_layout Standard
-.
- Setting this to
+\change_inserted -970929547 1515111183
+If the inset permits multiple paragraphs—that is, if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+
+\change_inserted -970929547 1496610966
+MultiPar
+\change_unchanged
+
\end_layout
\end_inset
- allows you to alter or augment the generated CSS, rather than to override
- it completely.
- Default is
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-0
+ is true—then the contents of the inset will
+\change_deleted 34634807 1620029217
+itself
+\change_inserted 34634807 1620029219
+themselves
+\change_inserted -970929547 1515111183
+ 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
-\end_inset
+\begin_layout Standard
-.
+\change_inserted -970929547 1496610966
+The specific tags and attributes output for each inset can be controlled
+ by means of the following layout tags.
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515110317
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLItem
+
+\change_inserted -970929547 1515109695
+DocBookAttr
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1496611854
string
+\change_unchanged
+
\end_layout
\end_inset
-] The tag to be used for individual paragraphs of environments, replacing
+] 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
-itemtag
+
+\change_inserted -970929547 1515110044
+attr
+\change_unchanged
+
\end_layout
\end_inset
- in the examples above.
- Defaults to
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-div
-\end_layout
+\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
-HTMLItemAttr
+
+\change_inserted -970929547 1515110319
+DocBookInInfo
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-\end_inset
-
-] Attributes for the item tag.
- Defaults to
-\begin_inset Newline newline
-\end_inset
+\change_inserted -970929547 1515110384
+never, always, maybe
+\change_unchanged
+\end_layout
-\begin_inset Quotes eld
\end_inset
-
+] Specifies whether this tag goes into the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`layoutname_item'
-\end_layout
-\end_inset
+\change_inserted -970929547 1515110412
+<info>
+\change_unchanged
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
- This should
-\emph on
-not
-\emph default
- contain any style information.
- Use
+ tag at the beginning of the parent layout.
+
\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 1515110437
+never
+\change_unchanged
-\begin_layout Plain Layout
-HTMLLabel
\end_layout
\end_inset
- [
+ indicates that the tag never goes into
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\change_inserted -970929547 1515110497
+<info>
+\change_unchanged
+
\end_layout
\end_inset
-] The tag to be used for paragraph and item labels, replacing
+ (this is default value, and corresponds to usual content).
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-labeltag
+
+\change_inserted -970929547 1515110517
+always
+\change_unchanged
+
\end_layout
\end_inset
- in the examples above.
- Defaults to
+ indicates that the tag always goes into
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-span
+
+\change_inserted -970929547 1515110514
+<info>
+\change_unchanged
+
\end_layout
\end_inset
-, unless
+ (this corresponds to usual metadata): if there is no
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+
+\change_inserted -970929547 1515110550
+<info>
+\change_unchanged
+
\end_layout
\end_inset
- is either
+ tag for the parent, one
+\series bold
+will
+\series default
+ be generated.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+
+\change_inserted -970929547 1515110540
+maybe
+\change_unchanged
+
\end_layout
\end_inset
- or
+ indicates that the tag may go into
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+
+\change_inserted -970929547 1515110538
+<info>
+\change_unchanged
+
\end_layout
\end_inset
-, in which case it defaults to
+ (this is only the case for titles): if there is no
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+
+\change_inserted -970929547 1515110585
+<info>
+\change_unchanged
+
\end_layout
\end_inset
-.
+ tag for the parent,
+\series bold
+none
+\series default
+ will be generated, the corresponding tag will be output directly as content.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111461
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLLabelAttr
+
+\change_inserted -970929547 1515110974
+DocBookItemAttr
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1515110973
string
-\end_layout
+\change_unchanged
-\end_inset
+\end_layout
-] Attributes for the label tag.
- Defaults to
-\begin_inset Newline newline
\end_inset
-
+] Specifies attribute information to be output with the item tag, replacing
+
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-class=`layoutname_label'
-\end_layout
-\end_inset
+\change_inserted -970929547 1515110984
+itemattr
+\change_unchanged
+\end_layout
-\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
+\begin_inset Quotes erd
\end_inset
- for that purpose.
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111471
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLLabelFirst
+
+\change_inserted -970929547 1515111465
+DocBookItemInnerAttr
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
-\emph on
-0
-\emph default
-,1
+\change_inserted -970929547 1515111461
+string
+\change_unchanged
+
\end_layout
\end_inset
-] Meaningful only for list-like environments, this tag controls whether
- the label tag is output before or inside the item tag.
- This is used, for example, in the description environment, where we want
- `
+] Specifies attribute information to be output with the item inner tag,
+ replacing
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<dt>\SpecialChar ldots
-</dt><dd>\SpecialChar ldots
-</dd>
+
+\change_inserted -970929547 1515111476
+iteminnerattr
+\change_unchanged
+
\end_layout
\end_inset
-.
- Default is
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-0
-\end_layout
+\begin_inset Quotes erd
\end_inset
-: The label tag is output inside the item tag.
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111494
\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
+\change_inserted -970929547 1515111467
+DocBookItemInnerTag
+\change_unchanged
-\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>
+
+\change_inserted -970929547 1515111461
+string
+\change_unchanged
+
\end_layout
\end_inset
- block defining an
+] The tag to be used for the item inner tag within the inset, replacing
+
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-onclick
-\end_layout
-\end_inset
+\change_inserted -970929547 1515111486
+iteminnertag
+\change_unchanged
- handler.
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-HTMLStyle
-\end_layout
+\begin_inset Quotes erd
\end_inset
- CSS style information to be included when this style is used.
- Note that this will automatically be wrapped in a layout-generated
+ in the example above.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<style>
+
+\change_inserted -970929547 1515111461
+NONE
+\change_unchanged
+
\end_layout
\end_inset
- block, so only the CSS itself need be included.
- Must end with
+, 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_inserted 1075283030 1598469472
+The most likely value is
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndHTMLStyle
+
+\change_inserted 1075283030 1598469476
+para
+\change_unchanged
+
\end_layout
\end_inset
+
+\begin_inset Quotes erd
+\end_inset
+
.
+\begin_inset Newline newline
+\end_inset
+
+When a list item is split using a new line, the item inner tag will be repeated
+ for each part of the paragraph, parts being separated by new lines.
+
\end_layout
\begin_layout Description
+
+\change_inserted 1075283030 1597699866
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLTag
+
+\change_inserted 1075283030 1597699853
+DocBookItemInnerTagType
+\change_unchanged
+
\end_layout
\end_inset
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
+\change_inserted 1075283030 1597699866
+block, paragraph, inline
+\change_unchanged
-\begin_layout Plain Layout
-tag
\end_layout
\end_inset
- in the examples above.
- Defaults to
-\begin_inset Flex Code
-status collapsed
+] The new-line policy for this tag, see Section
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-div
-\end_layout
-\end_inset
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:DocBook-New-line-policy"
+plural "false"
+caps "false"
+noprefix "false"
-.
-\end_layout
+\end_inset
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+ for the details.
+
+\change_unchanged
-\begin_layout Plain Layout
-HTMLTitle
\end_layout
-\end_inset
+\begin_layout Description
- [
+\change_inserted -970929547 1515111290
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
-\emph default
-,1
+\change_inserted -970929547 1515111283
+DocBookItemLabelAttr
+\change_unchanged
+
\end_layout
\end_inset
-] Marks this style as the one to be used to generate the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<title>
-\end_layout
-
-\end_inset
- tag for the XHTML file.
- By default, it is false.
- The
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111279
+string
+\change_unchanged
-\begin_layout Plain Layout
-stdtitle.inc
\end_layout
\end_inset
- file sets it to true for the
+] 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
-title
+
+\change_inserted -970929547 1515111304
+itemlabelattr
+\change_unchanged
+
\end_layout
\end_inset
- environment.
+
+\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 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 1515111337
+\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 1515111285
+DocBookItemLabelTag
+\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 1515111279
+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
+] The tag to be used for the item label tag within the inset, 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 1515111311
+itemlabeltag
+\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>
-\end_layout
+ in the example above.
+ This parameter only makes sense when itemising layouts are used with a
+ notion of labels, such as definition lists.
+
+\change_inserted 1075283030 1597699874
-\begin_layout LyX-Code
-</tag>
\end_layout
-\begin_layout Standard
-If the inset permits multiple paragraphs—that is, if
+\begin_layout Description
+
+\change_inserted 1075283030 1597699874
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+
+\change_inserted 1075283030 1597699880
+DocBookItemLabelTagType
+\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 1075283030 1597699874
+block, paragraph, inline
+\change_unchanged
+
\end_layout
\end_inset
-.
- The inner tag is optional and, by default, does not appear.
-\end_layout
+] The new-line policy for this tag, see Section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:DocBook-New-line-policy"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ for the details.
+
+\change_unchanged
-\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
+
+\change_inserted -970929547 1515111124
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLAttr
+
+\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
-] Specifies attribute information to be output with the main tag.
- For example,
+] The tag to be used for the item tag within the inset, replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-class=`myinset' onclick=`\SpecialChar ldots
-'
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- By default, \SpecialChar LyX
- will output
-\begin_inset Quotes eld
-\end_inset
-
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111060
+itemtag
+\change_unchanged
-\begin_layout Plain Layout
-class=`insetname'
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-, where
+ in the example above.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-insetname
+
+\change_inserted -970929547 1515111060
+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 tag.
+ This parameter only makes sense when itemising layouts are used, such as
+ lists.
+
+\change_inserted 1075283030 1597699890
+
\end_layout
\begin_layout Description
+
+\change_inserted 1075283030 1597699890
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLForceCSS
+
+\change_inserted 1075283030 1597699890
+DocBookItemTagType
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
-\emph on
-0
-\emph default
-,1
+\change_inserted 1075283030 1597699890
+block, paragraph, inline
+\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 new-line policy for this tag, see Section
+\begin_inset space ~
\end_inset
-.
- Setting this to
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-1
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:DocBook-New-line-policy"
+plural "false"
+caps "false"
+noprefix "false"
\end_inset
- allows you to alter or augment the generated CSS, rather than to override
- it completely.
- Default is 0.
+ for the details.
+
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111298
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLInnerAttr
+
+\change_inserted -970929547 1515111124
+DocBookItemWrapperAttr
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1515111124
string
-\end_layout
+\change_unchanged
-\end_inset
+\end_layout
-] Attributes for the inner tag.
- Defaults to
-\begin_inset Newline newline
\end_inset
-
+] Specifies attribute information to be output with the item wrapper tag,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-class=`insetname_inner'
+
+\change_inserted -970929547 1515111150
+itemwrapperattr
+\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.
+
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111113
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLInnerTag
+
+\change_inserted -970929547 1515111073
+DocBookItemWrapperTag
+\change_unchanged
+
\end_layout
\end_inset
\begin_inset Flex Code
status collapsed
-\begin_layout Plain Layout
-string
+\begin_layout Plain Layout
+
+\change_inserted -970929547 1515111073
+string
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] 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
+
+\change_inserted -970929547 1515111083
+itemwrappertag
+\change_unchanged
+
\end_layout
\end_inset
-] The inner tag, replacing
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-innertag
+
+\change_inserted -970929547 1515111073
+NONE
+\change_unchanged
+
\end_layout
\end_inset
- in the examples above.
- By default, there is none.
+, 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_inserted 1075283030 1597699897
+
\end_layout
\begin_layout Description
+
+\change_inserted 1075283030 1597699897
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLIsBlock
+
+\change_inserted 1075283030 1597699900
+DocBookItemWrapperTagType
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-0,
-\emph on
-1
+
+\change_inserted 1075283030 1597699897
+block, paragraph, inline
+\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.
+] The new-line policy for this tag, see Section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:DocBook-New-line-policy"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ for the details.
+
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515110104
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLLabel
+
+\change_inserted -970929547 1515110104
+DocBookInnerAttr
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1515110104
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 inner tag, replacing
+
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-arabic{footnote}
+\change_inserted -970929547 1515110104
+innerattr
+\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.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515110906
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+
+\change_inserted -970929547 1515110104
+DocBookInnerTag
+\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 1515110104
+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 inner 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 1515110104
+innertag
+\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 1515110791
+NONE
+\change_unchanged
+
\end_layout
\end_inset
- handler.
+, indicating that there is no inner tag: content is directly output without
+ it.
+\change_inserted 1075283030 1597699904
+
\end_layout
\begin_layout Description
+
+\change_inserted 1075283030 1597699904
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+
+\change_inserted 1075283030 1597699904
+DocBookInnerTagType
+\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 1075283030 1597699904
+block, paragraph, inline
+\change_unchanged
+
\end_layout
\end_inset
- block, so only the CSS itself need be included.
+] The new-line policy for this tag, see Section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:DocBook-New-line-policy"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ for the details.
+
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515110753
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLTag
+
+\change_inserted -970929547 1515110665
+DocBookSectionTag
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1515110661
string
+\change_unchanged
+
\end_layout
\end_inset
-] The tag to be used for the main label, replacing
+] 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
\begin_layout Plain Layout
-tag
+
+\change_inserted -970929547 1515110721
+section
+\change_unchanged
+
\end_layout
\end_inset
- in the examples above.
- The default depends upon the setting of
-\begin_inset Flex Code
-status collapsed
+, and is only overridden when DocBook uses something else for sectioning
+ (
+\change_inserted 1075283030 1597699921
+typically,
+\change_inserted -970929547 1515110753
+parts and chapters of a book).
+
+\change_unchanged
-\begin_layout Plain Layout
-MultiPar
\end_layout
-\end_inset
+\begin_layout Description
-: If
+\change_inserted -970929547 1515110811
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+
+\change_inserted -970929547 1496612023
+DocBookTag
+\change_unchanged
+
\end_layout
\end_inset
- is true, the default is
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+
+\change_inserted -970929547 1496610966
+string
+\change_unchanged
+
\end_layout
\end_inset
-; if it is false, the default is
+] The tag to be used for this inset, replacing
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-span
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-\begin_layout Subsection
-Float XHTML
-\end_layout
+\change_inserted -970929547 1496612033
+tag
+\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
->
-\end_layout
-
-\begin_layout LyX-Code
-Contents of the float.
-\end_layout
-
-\begin_layout LyX-Code
-</tag>
-\end_layout
+ in the example above.
+ The default is the name of the float and always needs to be changed, as
+ DocBook provides no generic inset tag.
+\change_inserted 1075283030 1597699924
-\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
+
+\change_inserted 1075283030 1597699924
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLAttr
+
+\change_inserted 1075283030 1597699924
+DocBookTagType
+\change_unchanged
+
\end_layout
\end_inset
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
+\change_inserted 1075283030 1597699924
+block, paragraph, inline
+\change_unchanged
-\begin_layout Plain Layout
-class=`myfloat' onclick=`\SpecialChar ldots
-'
\end_layout
\end_inset
-
-\begin_inset Quotes erd
+] The new-line policy for this tag, see Section
+\begin_inset space ~
\end_inset
-.
- By default, \SpecialChar LyX
- will output
-\begin_inset Quotes eld
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:DocBook-New-line-policy"
+plural "false"
+caps "false"
+noprefix "false"
+
\end_inset
+ for the details.
+
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
+\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
+\change_inserted 34634807 1620057958
+wrapper
+\change_inserted -970929547 1515110832
+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_inserted 1075283030 1597699929
+
\end_layout
-\begin_layout Subsection
-Bibliography formatting
+\begin_layout Description
+
+\change_inserted 1075283030 1597699929
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 1075283030 1597699932
+DocBookWrapperTagType
+\change_unchanged
+
\end_layout
-\begin_layout Standard
-The bibliography can be formatted using
+\end_inset
+
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
+
+\change_inserted 1075283030 1597699929
+block, paragraph, inline
+\change_unchanged
+
\end_layout
\end_inset
- blocks.
- See
+] The new-line policy for this tag, see Section
+\begin_inset space ~
+\end_inset
+
+
\begin_inset CommandInset ref
LatexCommand ref
-reference "subsec:Citation-format-description"
+reference "subsec:DocBook-New-line-policy"
+plural "false"
+caps "false"
+noprefix "false"
\end_inset
for the details.
+
+\change_unchanged
+
\end_layout
\begin_layout Subsection
-\SpecialChar LyX
--generated CSS
+
+\change_inserted -970929547 1515110040
+Float DocBook
\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 1496611700
+The DocBook output for floats too can be controlled by layout information.
+ The output has the following form:
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515109700
+<tag attr>
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515110138
+ Contents of the float as DocBook.
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1496610966
+</tag>
\end_layout
\begin_layout Standard
-At present, \SpecialChar LyX
- auto-generates CSS only for font information, making use of
- the
+
+\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 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 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 1515110157
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Size
+
+\change_inserted -970929547 1496611782
+DocBookTag
+\change_unchanged
+
\end_layout
\end_inset
- specified in the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
-\end_layout
-\end_inset
+\change_inserted -970929547 1496610966
+string
+\change_unchanged
- declaration (see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
+\end_layout
\end_inset
-).
- The translation is mostly straightforward and obvious.
- For example,
+] The tag to be used for this float, replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-Family Sans
+
+\change_inserted -970929547 1496610966
+tag
+\change_unchanged
+
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
- becomes
-\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 float tag.
+\end_layout
+
+\begin_layout Subsection
+
+\change_inserted -970929547 1515110157
+Bibliography formatting
+\end_layout
+\begin_layout Standard
+\change_deleted 1075283030 1597699984
+The
+\change_inserted 1075283030 1597699985
+Included
+\change_inserted -970929547 1515110187
+bibliograph
+\change_deleted 1075283030 1597699987
+y
+\change_inserted 1075283030 1597699987
+ies
+\change_inserted -970929547 1515110187
+ cannot be formatted: all fields are always output in the database-like
+ DocBook format (equivalent to a BibTeX file)
+\change_inserted 1075283030 1597700117
+, using the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-font-family: sans-serif;
-\end_layout
-\end_inset
+\change_inserted 1075283030 1597700120
+biblioentry
+\change_unchanged
+\end_layout
-\begin_inset Quotes erd
\end_inset
+ tag
+\change_inserted -970929547 1515110187
.
- 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
+\change_inserted 1075283030 1597700092
-\begin_layout Plain Layout
-getSizeCSS()
\end_layout
-\end_inset
+\begin_layout Standard
- function in
-\begin_inset Flex URL
+\change_inserted 1075283030 1597700112
+When the bibliographic entries are manually inserted into the
+\change_deleted 34634807 1620057319
+LyX
+\change_inserted 34634807 1620057319
+\SpecialChar LyX
+
+\change_inserted 1075283030 1597700112
+ document as Bibliography Items, the user deals with formatting
+\change_unchanged
+them
+\change_inserted 1075283030 1597700112
+self: there is no attempt of parsing what the user wrote, the string is
+ directly used (with the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-src/FontInfo.cpp
+\change_inserted 1075283030 1597700076
+bibliomixed
+\change_unchanged
+
\end_layout
\end_inset
- for the details.
+ tag).
+
+\change_unchanged
+
\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
+\change_inserted -712698321 1607683177
+.
+ Please do
+\emph on
+not
+\emph default
+ use these colors in layout definitions, since they will not work well with
+ some color themes (such as dark themes)
+\change_unchanged
+:
\end_layout
\begin_layout Description
\begin_layout Description
tabularonoffline Table line color
+\change_inserted -712698321 1607682522
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1607682563
+textlabel1 Color 1 of layout and custom inset labels
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1607682565
+textlabel2 Color 2 of layout and custom inset labels
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1607682568
+textlabel3 Color 3 of layout and custom inset labels
+\change_unchanged
+
\end_layout
\begin_layout Description
projects / features.git / blobdiff