-#LyX 2.3 created this file. For more info see http://www.lyx.org/
-\lyxformat 528
+#LyX 2.4 created this file. For more info see https://www.lyx.org/
+\lyxformat 575
\begin_document
\begin_header
\save_transient_properties true
}
}{}
\end_preamble
-\options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
+\options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
\use_default_options false
\begin_modules
logicalmkup
\maintain_unincluded_children false
\language english
\language_package default
-\inputencoding auto
-\fontencoding global
+\inputencoding utf8
+\fontencoding auto
\font_roman "lmodern" "default"
\font_sans "lmss" "default"
\font_typewriter "lmtt" "default"
\font_sf_scale 100 100
\font_tt_scale 100 100
\use_microtype false
+\use_dash_ligatures true
\graphics default
\default_output_format pdf2
\output_sync 0
\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
\papersize default
\use_geometry false
-\use_package amsmath 0
-\use_package amssymb 0
-\use_package cancel 0
-\use_package esint 0
+\use_package amsmath 1
+\use_package amssymb 1
+\use_package cancel 1
+\use_package esint 1
\use_package mathdots 1
-\use_package mathtools 0
-\use_package mhchem 0
-\use_package stackrel 0
-\use_package stmaryrd 0
-\use_package undertilde 0
+\use_package mathtools 1
+\use_package mhchem 1
+\use_package stackrel 1
+\use_package stmaryrd 1
+\use_package undertilde 1
\cite_engine basic
\cite_engine_type default
\biblio_style plain
\suppress_date false
\justification true
\use_refstyle 0
+\use_minted 0
+\use_lineno 0
+\lineno_options
\notefontcolor #0000ff
\branch OutDated
\selected 0
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation default
+\is_math_indent 1
+\math_indentation default
+\math_numbering_side default
\quotes_style english
\dynamic_quotes 0
\papercolumns 1
\papersides 2
\paperpagestyle headings
+\tablestyle default
\tracking_changes true
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict true
\author -712698321 "Jürgen Spitzmüller"
-\author 2089657418 "Usti"
+\author -495245474 "Jean-Marc Lasgouttes"
+\author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
\end_header
\begin_body
LatexCommand href
target "lyx-docs@lists.lyx.org"
type "mailto:"
+literal "false"
\end_inset
\begin_inset Newline newline
\end_inset
-Version 2.2.x
+Version 2.3.x
\end_layout
\begin_layout Standard
\end_inset
, that will be used first.
-\change_inserted -712698321 1483535138
-
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-
-\change_inserted -712698321 1483874001
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483535144
citeengines/
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483869840
.citeengine
-\change_unchanged
-
\end_layout
\end_inset
\end_inset
for details.
-\change_unchanged
-
\end_layout
\begin_layout Labeling
appearing on the toolbar.
\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+xtemplates/
+\end_layout
+
+\end_inset
+
+ contains files with the extension
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.xtemplate
+\end_layout
+
+\end_inset
+
+ which define the templates for the insertion of external material to a
+ \SpecialChar LyX
+ document; see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:Including-External-Material"
+
+\end_inset
+
+.
+\end_layout
+
\begin_layout Subsection
Files you don't want to modify
\end_layout
\begin_inset Flex Code
status collapsed
-\begin_layout Plain Layout
-external_templates
-\end_layout
-
-\end_inset
-
- this file contains the templates available to the new
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-External
-\begin_inset space ~
-\end_inset
-
-Template
-\end_layout
-
-\end_inset
-
- feature, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "chap:Including-External-Material"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Labeling
-\labelwidthstring 00.00.0000
-\begin_inset Flex Code
-status collapsed
-
\begin_layout Plain Layout
languages
\end_layout
\end_inset
- this file contains information about unicode-encoded glyphs and the way
+ this file contains information about Unicode-encoded glyphs and the way
they are supported by \SpecialChar LyX
via \SpecialChar LaTeX
.
LatexCommand href
name "IANA"
target "http://www.iana.org/assignments/media-types/"
+literal "false"
\end_inset
LatexCommand href
name "freedesktop.org"
target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
+literal "false"
\end_inset
\begin_layout Plain Layout
latex
+\change_inserted -712698321 1524656940
+=flavor
+\change_unchanged
+
\end_layout
\end_inset
This will make \SpecialChar LyX
's \SpecialChar LaTeX
error logs available.
+
+\change_inserted -712698321 1524657018
+ The optional
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657012
+flavor
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ value specifies the form of \SpecialChar LaTeX
+ that is run (
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657005
+latex, pdflatex, platex, xetex, luatex
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+).
+ If no value is specified,
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657018
+latex
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ is used.
+\change_unchanged
+
\end_layout
\begin_layout Labeling
\begin_layout Plain Layout
needaux
+\change_inserted -712698321 1524656935
+=flavor
+\change_unchanged
+
\end_layout
\end_inset
\end_inset
file for the conversion.
+
+\change_inserted -712698321 1524657047
+ The optional
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657030
+flavor
+\end_layout
+
+\end_inset
+
+ value specifies the form of \SpecialChar LaTeX
+ that is run in order to generate the
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657047
+.aux
+\end_layout
+
+\end_inset
+
+ file (
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657030
+latex, pdflatex, platex, xetex, luatex
+\end_layout
+
+\end_inset
+
+).
+ If no value is specified,
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657030
+latex
+\end_layout
+
+\end_inset
+
+ is used.
+\change_unchanged
+
\end_layout
\begin_layout Labeling
format:
\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+
+\change_inserted -712698321 1523206314
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523206193
+hyperref-driver
+\end_layout
+
+\end_inset
+
+ The name of the driver that needs to be loaded with the
+\family sans
+hyperref
+\family default
+ package for this converter.
+ The loading of the correct driver is necessary to get some PDF-specific
+ features.
+ See the
+\family sans
+hyperref
+\family default
+ manual for details.
+\end_layout
+
\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex Code
\end_layout
\begin_layout Standard
-None of these last three are presently used in any of the converters that
- are installed with \SpecialChar LyX
+
+\change_inserted -712698321 1523206384
+A suitable hyperref-driver is set for some converters that are installed
+ with \SpecialChar LyX
+.
+
+\change_deleted -712698321 1523206388
+None of these
+\change_inserted -712698321 1523206389
+The
+\change_unchanged
+ last three
+\change_inserted -712698321 1523206400
+ flags, however,
+\change_unchanged
+ are presently
+\change_inserted -712698321 1523206407
+not
+\change_unchanged
+used in any of the
+\change_inserted -712698321 1523206437
+pre-installed
+\change_unchanged
+converters
+\change_deleted -712698321 1523206442
+ that are installed with \SpecialChar LyX
+
+\change_unchanged
.
\end_layout
\begin_inset CommandInset href
LatexCommand href
name "information on the web"
-target "http://www.lyx.org/HowToUseGIT"
+target "https://www.lyx.org/HowToUseGIT"
+literal "false"
\end_inset
\begin_layout Plain Layout
-https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
-\backslash
-#PO-Mode
+https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
\end_layout
\end_inset
Check out the documentation translation web page at
\begin_inset CommandInset href
LatexCommand href
-name "http://www.lyx.org/Translation"
-target "http://www.lyx.org/Translation"
+name "https://www.lyx.org/Translation"
+target "https://www.lyx.org/Translation"
+literal "false"
\end_inset
\begin_layout Plain Layout
-http://www.lyx.org/HowToUseGIT
+https://www.lyx.org/HowToUseGIT
\end_layout
\end_inset
Use the source viewer at
\begin_inset CommandInset href
LatexCommand href
-name "http://www.lyx.org/trac/timeline"
-target "http://www.lyx.org/trac/timeline"
+name "https://www.lyx.org/trac/timeline"
+target "https://www.lyx.org/trac/timeline"
+literal "false"
\end_inset
LatexCommand href
name "CTAN"
target "http://www.ctan.org/"
+literal "false"
\end_inset
\begin_layout Plain Layout
\family sans
-\lang french
$HOME/.texliveXXXX
\end_layout
status collapsed
\begin_layout Plain Layout
-Slides
-\begin_inset space ~
-\end_inset
-
-(FoilTex)
+FoilTex
\end_layout
\end_inset
\end_inset
-.
+ (in the
+\begin_inset Quotes eld
+\end_inset
+
+Presentations
+\begin_inset Quotes erd
+\end_inset
+
+ category).
\end_layout
\begin_inset CommandInset href
LatexCommand href
name "layout section on the LyX wiki"
-target "http://wiki.lyx.org/Layouts/Layouts"
+target "https://wiki.lyx.org/Layouts/Layouts"
+literal "false"
\end_inset
Any format is acceptable, but one would normally use the format current
at the time.
(In \SpecialChar LyX
- 2.2, the current layout format is 60.)
+
+\begin_inset Info
+type "lyxinfo"
+arg "version"
+\end_inset
+
+, the current layout format is
+\begin_inset Info
+type "lyxinfo"
+arg "layoutformat"
+\end_inset
+
+.)
\end_layout
\begin_layout Standard
\begin_layout LyX-Code
\backslash
-DeclareLaTeXClass{report}
+DeclareLaTeXClass{Report (Standard Class)}
\end_layout
\begin_layout Standard
\begin_layout LyX-Code
\backslash
-DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
+DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
\end_layout
\begin_layout Standard
status collapsed
\begin_layout Plain Layout
-report (myclass)
+Report (My Class)
\end_layout
\end_inset
\begin_layout LyX-Code
#
\backslash
-DeclareLyXModule{My Package}
+DeclareLyXModule{My Class}
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout LyX-Code
-#Support for mypkg.sty.
+#Support for myclass.sty.
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout LyX-Code
-Format 60
+Format
+\begin_inset Info
+type "lyxinfo"
+arg "layoutformat"
+\end_inset
+
+
\begin_inset Newline newline
\end_inset
\backslash
-usepackage{mypkg}
+usepackage{myclass}
\begin_inset Newline newline
\end_inset
\begin_layout Standard
Note, by the way, that there is a template which has a particular meaning:
-
+\begin_inset Newline linebreak
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Standard
Note that manual conversion does not affect included files, so these will
have to be converted separately.
-\change_inserted -712698321 1483873435
-
\end_layout
\begin_layout Subsection
-
-\change_inserted -712698321 1483875083
\begin_inset CommandInset label
LatexCommand label
name "subsec:Cite-Engine-Files"
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1483874213
A specific form of layout files are the so-called
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483873546
*.citeengine
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483873546
citeengines/
\end_layout
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1483874969
More specifically, it is defined which packages \SpecialChar LyX
needs to load, which citation
commands are available, how these are to be displayed in \SpecialChar LyX
in
\family sans
Document\SpecialChar menuseparator
-Settings\SpecialChar ldots
-\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
Bibliography\SpecialChar menuseparator
Style engine
\family default
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1483875180
Even though a cite engine file is essentially a normal layout file that
could theoretically include any layout information, it usually primarily
includes some specific parameters such as
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483874688
MaxCiteNames
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483875180
CiteFramework
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483874477
CiteEngine
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483874482
CiteFormat
-\change_unchanged
-
\end_layout
\end_inset
\end_inset
, as well as in the files themselves.
-\change_unchanged
-
\end_layout
\begin_layout Section
Once the layout file is installed, you can edit it and see your changes
without having to reconfigure or to restart \SpecialChar LyX
.
-
\begin_inset Foot
status collapsed
\begin_layout LyX-Code
#
\backslash
-DeclareLyXModule[endnotes.sty]{Endnotes}
-\end_layout
-
-\begin_layout Standard
-The mandatory argument, in curly brackets, is the name of the module, as
- it should appear in
-\begin_inset Flex Noun
-status collapsed
+DeclareLyXModule[endnotes.sty]{Endnotes}
+\change_inserted -712698321 1554395911
-\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Modules
\end_layout
-\end_inset
+\begin_layout LyX-Code
-.
- The argument in square brackets is optional: It declares any \SpecialChar LaTeX
- packages
- on which the module depends.
- It is also possible to use the form
-\begin_inset Flex Noun
-status collapsed
+\change_inserted -712698321 1554395924
+
+\size small
+#
+\backslash
+DeclareCategory{Foot- and Endnotes}
+\change_deleted -712698321 1554395911
+
+\size default
+
+\change_unchanged
+
+\end_layout
+
+\begin_layout Standard
+The mandatory argument
+\change_inserted -712698321 1554395956
+ of
+\family typewriter
+
+\backslash
+DeclareLyXModule
+\change_unchanged
+
+\family default
+, in curly brackets, is the name of the module, as it should appear in
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Modules
+\end_layout
+
+\end_inset
+
+.
+ The argument in square brackets is optional: It declares any \SpecialChar LaTeX
+ packages
+ on which the module depends.
+ It is also possible to use the form
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
from->to
\end_inset
'.
+
+\change_inserted -712698321 1554396133
+ The
+\family typewriter
+
+\backslash
+DeclareCategory
+\family default
+ declaration is not strictly mandatory, but you should add it, since it
+ is helpful to find the module.
+ Please have a look at the existing module categories and if appropriate,
+ use one of those.
+\change_unchanged
+
\end_layout
\begin_layout Standard
-The module declaration should then be followed by lines like the following
+The module
+\change_inserted -712698321 1554395988
+and category
+\change_unchanged
+declaration should then be followed by lines like the following:
\begin_inset Foot
status collapsed
\end_inset
-:
+
\end_layout
\begin_layout LyX-Code
\end_inset
.
-\change_inserted -712698321 1483873000
-
\end_layout
\begin_layout Subsection
-
-\change_inserted -712698321 1483873010
The CiteEngine file declaration
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1483873022
A cite engine file must begin with a line like the following:
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483873047
#
\backslash
DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1483873077
-The mandatory argument, in curly brackets, is the name of the module, as
- it should appear in
+The mandatory argument, in curly brackets, is the name of the cite style,
+ as it should appear in
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483873068
Document\SpecialChar menuseparator
Settings\SpecialChar menuseparator
Bibliography
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1483873102
-The cite engine declaration should then be followed by lines like the following
+The cite engine declaration should then be followed by lines like the following:
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483873000
Preferably in English if the module should be published with \SpecialChar LyX
.
This description will appear in the list of messages to be translated and
\end_inset
-:
+
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483873128
# DescriptionBegin
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483873140
# Biblatex supports many author-year and numerical styles.
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483873152
# It is mainly aimed at the Humanities.
It is highly
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483873160
# customizable, fully localized and provides many features
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483873170
# that are not possible with BibTeX.
The use of 'biber' as
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483873174
# bibliography processor is advised.
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483873224
# DescriptionEnd
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1483873207
The description is used in
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483873194
Document\SpecialChar menuseparator
Settings\SpecialChar menuseparator
Bibliography
\end_inset
to provide the user with information about the cite engine.
-\change_unchanged
-
\end_layout
\begin_layout Subsection
A module can contain any layout tag.)
\end_layout
+\begin_layout Description
+
+\change_inserted -712698321 1526899478
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1526898610
+AddToCiteEngine <engine>
+\end_layout
+
+\end_inset
+
+ Extends the possibilities for displaying citation references.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Citation-engine-description"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ for details.
+ Must end with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1526898823
+End
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
\begin_layout Description
\begin_inset Flex Code
status collapsed
\end_inset
.
-\change_inserted -712698321 1483872509
-
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1483874560
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483872558
CiteEngine <engine>
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483872548
End
\end_layout
\end_inset
).
+
+\change_inserted -712698321 1526898530
+ Note that if you specify this in a layout file or module, any cite engine
+ definition will be overridden.
+ Also see
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1526898530
+AddToCiteEngine
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
\change_unchanged
\end_layout
\end_inset
.
-
-\change_inserted -712698321 1483875199
Primarily used in cite engine files (see
\begin_inset CommandInset ref
LatexCommand ref
\end_inset
).
+
+\change_inserted -712698321 1526898585
+ A cite format defined in a layout or module will override the cite engine
+ definition.
\change_unchanged
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1483874578
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483872820
CiteFramework
\end_layout
\begin_layout Plain Layout
-\change_inserted -712698321 1483872852
-
\emph on
bibtex
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483872857
biblatex
-\change_unchanged
-
\end_layout
\end_inset
\end_inset
).
-\change_unchanged
-
\end_layout
\begin_layout Description
\end_inset
.)
-\change_inserted -712698321 1483872681
-
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1483874598
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483872687
MaxCiteNames
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483872692
integer
\end_layout
\end_inset
).
-\change_unchanged
-
\end_layout
\begin_layout Description
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+OutlinerName
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<type>
+\end_layout
+
+\end_inset
+
+] [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<string>
+\end_layout
+
+\end_inset
+
+] Define a new table of contents with type
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<type>
+\end_layout
+
+\end_inset
+
+ and name
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<string>
+\end_layout
+
+\end_inset
+
+.
+ See also the AddToToc commands.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
OutputFormat
\end_layout
\end_inset
for details on paragraph styles.
+\change_inserted -712698321 1553617804
+
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1553617862
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+
+\change_inserted -712698321 1553617809
+TableStyle
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string="maketitle"
+
+\change_inserted -712698321 1553617805
+<name>
\end_layout
\end_inset
-] The name of the command or environment to be used with
+] defines the default table style that is used when inserting a table.
+ The following styles are available:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+
+\change_inserted -712698321 1554308039
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+
+\change_inserted -712698321 1554307928
+Formal_with_Footline
+\change_unchanged
+
\end_layout
\end_inset
-.
-\end_layout
+: formal (
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+booktabs
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-TitleLatexType
+) style with horizontal lines only, using a bold top and bottom line, the
+ first and last row are additionally separated from the table body with
+ a thin middle line.
\end_layout
-\end_inset
+\begin_layout Itemize
- [
+\change_inserted -712698321 1554308087
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-CommandAfter
+\change_inserted -712698321 1554308042
+Formal_without_Footline
\end_layout
\end_inset
-,
+: same as the above, but the last row is not separated with a middle line
+ from the body.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1553618031
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+
+\change_inserted -712698321 1553618006
+Simple_Grid
\end_layout
\end_inset
-] Indicates what kind of markup is used to define the title of a document.
-
+: Simple table lines.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1553618309
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CommandAfter
+
+\change_inserted -712698321 1553618031
+Grid_with_Head
\end_layout
\end_inset
- means that the macro with name
+: Like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+
+\change_inserted -712698321 1553618043
+Simple_Grid
\end_layout
\end_inset
- will be inserted after the last layout which has
-\begin_inset Quotes eld
-\end_inset
+, but with the header column offset with a second horizontal line.
+ This is also the default style of \SpecialChar LyX
+.
+\end_layout
+\begin_layout Itemize
+\change_inserted -712698321 1553618280
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InTitle
-\begin_inset space ~
-\end_inset
-1
+\change_inserted -712698321 1553618261
+No_Borders
\end_layout
\end_inset
+: Table without lines.
+\change_unchanged
-\begin_inset Quotes erd
-\end_inset
+\end_layout
+
+\end_deeper
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+TitleLatexName
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string="maketitle"
+\end_layout
+
+\end_inset
+
+] The name of the command or environment to be used with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+TitleLatexType
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+TitleLatexType
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+CommandAfter
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Environment
+\end_layout
+
+\end_inset
+
+] Indicates what kind of markup is used to define the title of a document.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CommandAfter
+\end_layout
+
+\end_inset
+
+ means that the macro with name
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+TitleLatexName
+\end_layout
+
+\end_inset
+
+ will be inserted after the last layout which has
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InTitle
+\begin_inset space ~
+\end_inset
+
+1
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
.
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+AddToToc
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+=""] This paragraph will appear in the table of contents of the given type.
+ An empty string disables.
+ See also the OutlinerName and the IsTocCaption commands.
+ Default: disabled.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
Align
\end_layout
\end_inset
+\change_inserted -712698321 1555579782
+
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1555579780
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555579780
+NewlineCmd
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555579780
+[string]
+\end_layout
+
+\end_inset
+
+ Option to define a different command (from the default
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555579780
+
+\backslash
+
+\backslash
+
+\end_layout
+
+\end_inset
+
+) to be used for line breaks.
+ The initial backslash must not be specified.
+\change_unchanged
+
\end_layout
\begin_layout Itemize
\end_inset
.
+\change_inserted -712698321 1559484228
+
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1559484228
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559484228
+FreeSpacing
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559484228
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559484228
+1
+\end_layout
+
+\end_inset
+
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+.
+\change_unchanged
+
\end_layout
\begin_layout Itemize
\end_inset
, this argument is automatically inserted when the respective style is selected.
+
+\change_deleted -712698321 1559484200
Currently, only one argument per style\SpecialChar breakableslash
layout can be automatically inserted.
+\change_unchanged
+
\end_layout
\begin_layout Itemize
+
+\change_inserted -712698321 1559491402
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsertCotext
+
+\change_inserted -712698321 1559490711
+InsertOnNewline
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -712698321 1559490703
[int=0]
\end_layout
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -712698321 1559490703
1
\end_layout
\end_inset
-, this argument will be inserted with a copy of the co-text (either selected
- text or the whole paragraph) as content.
-\change_inserted -712698321 1477038290
+, 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
\end_layout
-\begin_layout Itemize
+\end_inset
+
+ (only available within Flex insets).
+\end_layout
-\change_inserted -712698321 1477038425
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1477038295
-PassThru
+InsertCotext
\end_layout
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1477038311
-
-\emph on
-inherited
-\emph default
-, true, false
+[int=0]
+\end_layout
+
+\end_inset
+
+ If this is set to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+, this argument will be inserted with a copy of the co-text (either selected
+ text or the whole paragraph) as content.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PassThru
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+inherited
+\emph default
+, true, false
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1477038356
PassThru
\end_layout
status is inherited by the inset or paragraph layout the argument belongs
to, true and false change the status for the given argument only.
-\change_unchanged
-
\end_layout
\begin_layout Itemize
\family typewriter
\family default
-Defines individual characters that should be output in raw form, meaning
- without special translations that \SpecialChar LaTeX
+Defines individual characters
+\begin_inset Newline linebreak
+\end_inset
+
+that should be output in raw form, meaning without special translations
+ that \SpecialChar LaTeX
would require.
Note that, contrary to PassThru, this needs to be explicitly defined for
arguments.
or layout.
\end_layout
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+IsTocCaption
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] If this is set to 1, the argument will output its content in the corresponding
+ item in the table of contents.
+ See AddToToc.
+\end_layout
+
\begin_layout Standard
By default, the text entered in the \SpecialChar LyX
workarea in the respective layout is
\end_inset
).
+\change_inserted -712698321 1534487781
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1534488561
+Finally, there is a special argument type with the prefix
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1534487844
+listpreamble:
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+ It is not really an argument, but uses the argument interface (thus, the
+ prefix is also followed by a number, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1534488412
+Argument listpreamble:1
+\end_layout
+
+\end_inset
+
+).
+ As the name implies, it is targeted at lists such as
+\family sans
+Itemize
+\family default
+,
+\family sans
+Enumerate
+\family default
+,
+\family sans
+Description
+\family default
+, or
+\family sans
+Bibliography
+\family default
+.
+ Its content will be output at the list start, before the first
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1534488058
+
+\backslash
+item
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, on an own line (a place that is otherwise not accessible in \SpecialChar LyX
+).
+ This way, users can insert redefinitions (of lengths etc.) to individual
+ lists.
+ By default, these arguments do not have a delimiter.
+\change_unchanged
+
\end_layout
\end_deeper
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+AutoNests
+\end_layout
+
+\end_inset
+
+ Includes a comma-separated list of layouts that should be nested in and
+ after the current layout.
+ Only makes sense for nestable layouts (such as environments).
+ Must be ended by
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndAutoNests
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See also
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+IsAutoNestedBy
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
BabelPreamble
\end_layout
\end_inset
can be enabled.
- Note that \SpecialChar LyX
- will create protected blanks for the additional blanks when
- in another mode than \SpecialChar LaTeX
+
+\change_deleted -495245474 1550490105
+Note that
+\change_unchanged
+\SpecialChar LyX
+ will create protected blanks for the additional blanks when in
+\change_inserted -495245474 1550490096
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -495245474 1550490089
+Passthru 1
+\end_layout
+
+\end_inset
+
+ is not specified.
+\change_deleted -495245474 1550490116
+another mode than \SpecialChar LaTeX
-mode.
+
+\change_inserted -495245474 1550247760
+ Note that
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -495245474 1550247736
+FreeSpacing
+\end_layout
+
+\end_inset
+
+ implies
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -495245474 1550247755
+KeepEmpty
+\end_layout
+
+\end_inset
+
+.
+\change_unchanged
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ItemCommand
+IsAutoNestedBy
\end_layout
\end_inset
- [
+ Includes a comma-separated list of layouts after which this one should
+ be nested.
+ Only makes sense with regard to nestable layouts (such as environments).
+ Must be ended by
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string="item"
+EndIsAutoNestedBy
\end_layout
\end_inset
-] The \SpecialChar LaTeX
- command sequence declaring an item in a list.
- The command is to be defined without the preceding backslash (the default
- is
-\begin_inset Quotes eld
-\end_inset
-item
\begin_inset Quotes erd
\end_inset
-, resulting in
+.
+ See also
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-item
+AutoNests
\end_layout
\end_inset
- in the \SpecialChar LaTeX
- output).
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ItemSep
+IsTocCaption
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-float=0
+
+\emph on
+0
\end_layout
\end_inset
-] This provides extra space between paragraphs that have the same style.
- If you put other styles into an environment, each is separated with the
- environment's
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ParSep
+1
+\end_layout
+
+\end_inset
+
+] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
+ of its contents in its item in the table of contents.
+ Otherwise, only the label, if it exists, appears.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ItemCommand
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string="item"
+\end_layout
+
+\end_inset
+
+] The \SpecialChar LaTeX
+ command sequence declaring an item in a list.
+ The command is to be defined without the preceding backslash (the default
+ is
+\begin_inset Quotes eld
+\end_inset
+
+item
+\begin_inset Quotes erd
+\end_inset
+
+, resulting in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+item
+\end_layout
+
+\end_inset
+
+ in the \SpecialChar LaTeX
+ output).
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ItemSep
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+float=0
+\end_layout
+
+\end_inset
+
+] This provides extra space between paragraphs that have the same style.
+ If you put other styles into an environment, each is separated with the
+ environment's
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ParSep
\end_layout
\end_inset
\end_inset
produces the usual sort of enumeration labels.
- At present, it is hardcoded to use Arabic numerals, lowercase letters,
- small Roman numerals, and uppercase letters for the four possible depths.
+ The number type needs to be set in the
+\family sans
+Counter
+\family default
+, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Counters"
+
+\end_inset
+
+.
\end_layout
\begin_layout Description
\end_inset
produces various bullets at the different levels.
- It is also hardcoded.
+ The bullet types displayed can be set via
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Bullets
+\end_layout
+
+\end_inset
+
+.
\end_layout
\begin_layout Description
not
\emph default
whether this command should itself be protected.)
+\change_inserted -712698321 1523696949
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1552395557
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523696950
+NeedCProtect
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523696950
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523696950
+1
+\end_layout
+
+\end_inset
+
+] This causes macros that contain this layout to be protected with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523696950
+
+\backslash
+cprotect
+\end_layout
+
+\end_inset
+
+ (cf.
+ package
+\family sans
+cprotect
+\family default
+) if necessary and thus allows (some) verbatim stuff in macros.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1552395844
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395561
+NeedMBoxProtect
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395557
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395557
+1
+\end_layout
+
+\end_inset
+
+] Whether specific commands in this style (such as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395655
+
+\backslash
+cite
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395661
+
+\backslash
+ref
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+) should be protected in an
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395631
+
+\backslash
+mbox
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+ This is particularly needed for styles that draw on
+\family sans
+ulem
+\family default
+ or
+\family sans
+soul
+\family default
+ commands which parse their content in complex ways.
+\change_unchanged
+
\end_layout
\begin_layout Description
\end_inset
-] Determines whether consecutive pragraphs of the same type are treated
+] Determines whether consecutive paragraphs of the same type are treated
as belonging together.
This has the effect that the
\begin_inset Flex Code
\end_inset
, but you do not want to inherit its (required and optional) arguments.
-\change_inserted 2089657418 1476488475
-
\end_layout
\begin_layout Description
-
-\change_inserted 2089657418 1476488475
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2089657418 1476488475
ResumeCounter
\end_layout
\begin_layout Plain Layout
-\change_inserted 2089657418 1476488475
-
\emph on
0
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2089657418 1476488475
1
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2089657418 1476488475
LabelType
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2089657418 1476488475
Enumerate
\end_layout
\end_inset
.
-\change_unchanged
-
\end_layout
\begin_layout Description
] Allow spell-checking paragraphs of this style.
Default is true.
-\change_inserted 2089657418 1476488264
-
\end_layout
\begin_layout Description
-
-\change_inserted 2089657418 1476488264
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2089657418 1476488264
StepMasterCounter
\end_layout
\begin_layout Plain Layout
-\change_inserted 2089657418 1476488264
-
\emph on
0
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2089657418 1476488264
1
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2089657418 1476488264
LabelType
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2089657418 1476488264
Enumerate
\end_layout
\end_inset
.
-\change_unchanged
-
\end_layout
\begin_layout Description
\begin_inset space \space{}
\end_inset
-from 2.0.x to 2.1.y) will introduce new translations or corrections.
+from 2.0.x to 2.1.0) will introduce new translations or corrections.
\end_layout
\begin_layout Subsection
\begin_inset space ~
\end_inset
-Captions
+Captions
+\begin_inset Newline linebreak
+\end_inset
+
+
\family default
(
\begin_inset Flex Code
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+AddToToc
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+=""] This inset will appear in the table of contents of the given type.
+ An empty string disables.
+ See also the OutlinerName and the IsTocCaption commands.
+ This is only implemented for Flex insets.
+ Default: disabled.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
Argument
\end_layout
tags.
Default is true.
+\change_inserted 731793113 1538674858
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 731793113 1538674891
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted 731793113 1538674863
+EditExternal
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\emph on
+0
+\emph default
+,1] Allow the contents of the inset to be edited externally (using whatever
+ editor is defined for the document's output format).
+\change_unchanged
+
\end_layout
\begin_layout Description
\end_inset
] Whether to include the contents of this inset in the strings generated
- for the `Outline' pane.
+ for the `Outline' pane for all table of contents, regardless of the AddToToc
+ setting.
One would not, for example, want the content of a footnote in a section
header to be included in the TOC displayed in the outline, but one would
normally want the content of a character style displayed.
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+IsTocCaption
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] If this is set to 1 and AddToToc is enabled, the inset adds a summary
+ of its contents in its item in the table of contents.
+ Otherwise, only the label appears.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
KeepEmpty
\end_layout
\end_inset
.
+\change_inserted -712698321 1555575738
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1555575844
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555575740
+MenuString
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555575740
+[string]
+\end_layout
+
+\end_inset
+
+ A dedicated string for the menu.
+ You can define an accelerator by appending the respective character to
+ the string, divided by
+\begin_inset Quotes eld
+\end_inset
+
+|
+\begin_inset Quotes erd
+\end_inset
+
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555575781
+My Inset|M
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+).
+ This specification is optional.
+ If it is not given the inset name as specified in the type declaration
+ will be used instead for the menu.
+\change_unchanged
+
\end_layout
\begin_layout Description
not
\emph default
whether the command should itself be protected.) Default is false.
+\change_inserted -712698321 1523633958
+
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1552395786
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NoInsetLayout
+
+\change_inserted -712698321 1523633961
+NeedCProtect
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<layout>
-\end_layout
-\end_inset
-
-] Deletes an existing
-\begin_inset Flex Code
-status collapsed
+\change_inserted -712698321 1523633958
-\begin_layout Plain Layout
-InsetLayout
+\emph on
+0
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-ObsoletedBy
-\end_layout
-
+,
+\begin_inset space \thinspace{}
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<layout>
-\end_layout
-
-\end_inset
-] Name of an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+
+\change_inserted -712698321 1523633958
+1
\end_layout
\end_inset
- that has replaced this
+] This causes macros that contain this inset to be protected with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
-\end_layout
-\end_inset
+\change_inserted -712698321 1523634038
-.
- This is used to rename an
-\begin_inset Flex Code
-status collapsed
+\backslash
+cprotect
+\change_unchanged
-\begin_layout Plain Layout
-InsetLayout
\end_layout
\end_inset
-, while keeping backward compatibility.
+ (cf.
+ package
+\family sans
+cprotect
+\family default
+) if necessary and thus allows (some) verbatim stuff in macros.
+ Default is false.
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1555579651
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ParbreakIsNewline
+
+\change_inserted -712698321 1552395787
+NeedMBoxProtect
\end_layout
\end_inset
\begin_layout Plain Layout
+\change_inserted -712698321 1552395787
+
\emph on
0
\end_layout
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395787
1
\end_layout
\end_inset
-] As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
-
-\end_inset
-
-.
- Default is false.
-\end_layout
-
-\begin_layout Description
+] Whether specific commands in this inset (such as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru
+
+\change_inserted -712698321 1552395787
+
+\backslash
+cite
\end_layout
\end_inset
- [
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
-\end_layout
+\change_inserted -712698321 1552395787
-\end_inset
+\backslash
+ref
+\end_layout
-,
-\begin_inset space \thinspace{}
\end_inset
-
+) should be protected in an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
-\end_layout
-\end_inset
+\change_inserted -712698321 1552395787
-] As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
+\backslash
+mbox
+\end_layout
\end_inset
.
+ This is particularly needed for insets that draw on
+\family sans
+ulem
+\family default
+ or
+\family sans
+soul
+\family default
+ commands which parse their content in complex ways.
Default is false.
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1555579742
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preamble
-\end_layout
-\end_inset
-
- As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
+\change_inserted -712698321 1555579658
+NewlineCmd
+\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RefPrefix
+
+\change_inserted -712698321 1555579651
+[string]
\end_layout
\end_inset
- [
+ Option to define a different command (from the default
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\change_inserted -712698321 1555579742
+
+\backslash
+
+\backslash
+
+\change_unchanged
+
\end_layout
\end_inset
-] The prefix to use when creating labels referring to insets of this type.
- This allows the use of formatted references.
+) to be used for line breaks.
+ The initial backslash must not be specified.
+\change_unchanged
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Requires
+NoInsetLayout
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<layout>
\end_layout
\end_inset
-] As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
+] Deletes an existing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-ResetArgs
+ObsoletedBy
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+<layout>
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+] Name of an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+InsetLayout
\end_layout
\end_inset
-] Resets the \SpecialChar LaTeX
- arguments of this layout (as defined via the
+ that has replaced this
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+InsetLayout
\end_layout
\end_inset
- tag).
- This is useful if you have copied a style via
+.
+ This is used to rename an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+InsetLayout
\end_layout
\end_inset
-, but you do not want to inherit its (required and optional) arguments.
+, while keeping backward compatibility.
+\change_inserted -712698321 1559491850
+
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1559492002
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ResetsFont
+
+\change_inserted -712698321 1559491854
+ParbreakIgnored
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491850
+
+\emph on
0
\end_layout
\begin_layout Plain Layout
-\emph on
+\change_inserted -712698321 1559491850
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.
+] 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
-RightDelim
+ParbreakIsNewline
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+0
\end_layout
\end_inset
-] A string that is put at the end of the layout content.
- A line break in the output can be indicated by
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<br/>
+1
\end_layout
\end_inset
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
.
+ Default is false.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Spellcheck
+PassThru
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\emph on
0
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\emph on
1
\end_layout
\end_inset
-] Allow spell-checking the contents of this inset.
- Default is true.
-\end_layout
-
-\begin_layout Subsection
-Counters
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Counters"
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
\end_inset
-
+.
+ Default is false.
\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
+Preamble
\end_layout
\end_inset
-,
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-figure
-\end_layout
+ As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
\end_inset
-, \SpecialChar ldots
-) in the text class itself.
- The standard counters are defined in the file
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdcounters.inc
+RefPrefix
\end_layout
\end_inset
-, so you may have to do no more than add
-\end_layout
+ [
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-Input stdcounters.inc
+\begin_layout Plain Layout
+string
\end_layout
-\begin_layout Standard
-to your layout file to get them to work.
- But if you want to define custom counters, then you can do so.
- The counter declaration must begin with:
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-Counter CounterName
+] The prefix to use when creating labels referring to insets of this type.
+ This allows the use of formatted references.
\end_layout
-\begin_layout Standard
-where of course `
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CounterName
+Requires
\end_layout
\end_inset
-' is replaced by the name of the counter.
- And it must end with
-\begin_inset Quotes eld
-\end_inset
-
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
+string
\end_layout
\end_inset
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
-\begin_inset Quotes erd
\end_inset
.
- The following parameters can also be used:
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-InitialValue
+ResetArgs
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-int=1
+
+\emph on
+0
\end_layout
\end_inset
-] Sets the initial value for the counter, to which it will be reset whenever
- that happens.
- Normally, one will want the default, 1.
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+1
\end_layout
\end_inset
- [
+] Resets the \SpecialChar LaTeX
+ arguments of this layout (as defined via the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Argument
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+ tag).
+ This is useful if you have copied a style via
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+CopyStyle
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] When defined, this string defines how the counter is displayed.
- Setting this value sets
+, but you do not want to inherit its (required and optional) arguments.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+ResetsFont
\end_layout
\end_inset
- to the same value.
- The following special constructs can be used in the string:
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
\end_layout
-\begin_deeper
-\begin_layout Itemize
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-thecounter
+\emph on
+1
\end_layout
\end_inset
- will be replaced by the expansion of the
+] 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
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+RightDelim
\end_layout
\end_inset
- (or
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+string
\end_layout
\end_inset
-) of the counter
+] 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
-counter
+<br/>
\end_layout
\end_inset
.
-
\end_layout
-\begin_layout Itemize
-counter values can be expressed using \SpecialChar LaTeX
--like macros
-\begin_inset Newline newline
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\emph on
-numbertype
-\emph default
-{
-\emph on
-counter
-\emph default
-}
+Spellcheck
\end_layout
\end_inset
-, where
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-numbertype
+0
\end_layout
\end_inset
- can be:
-\begin_inset Foot
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Actually, the situation is a bit more complicated: any
-\family default
-\series default
-\shape default
-\emph default
-\bar default
-
-\size default
\emph on
-\noun default
-\color inherit
-numbertype
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
- other than those described below will produce arabic numerals.
- It would not be surprising to see this change in the future.
+1
\end_layout
\end_inset
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-arabic
+] 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
-: 1, 2, 3,\SpecialChar ldots
-;
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-alph
\end_layout
-\end_inset
-
- for lower-case letters: a, b, c, \SpecialChar ldots
-;
-\begin_inset Flex Code
+\begin_layout Standard
+It is necessary to define the counters (
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Alph
+chapter
\end_layout
\end_inset
- for upper-case letters: A, B, C, \SpecialChar ldots
-;
-\begin_inset Flex Code
+,
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-roman
+figure
\end_layout
\end_inset
- for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
-;
+, \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
-Roman
+stdcounters.inc
\end_layout
\end_inset
- for upper-case roman numerals: I, II, III\SpecialChar ldots
-;
-\begin_inset Flex Code
-status collapsed
+, so you may have to do no more than add
+\end_layout
-\begin_layout Plain Layout
-hebrew
+\begin_layout LyX-Code
+Input stdcounters.inc
\end_layout
-\end_inset
+\begin_layout Standard
+to your layout file to get them to work.
+ But if you want to define custom counters, then you can do so.
+ The counter declaration must begin with:
+\end_layout
- for hebrew numerals.
+\begin_layout LyX-Code
+Counter CounterName
\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
+where of course `
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-master
+CounterName
\end_layout
\end_inset
- (defined via
+' is replaced by the name of the counter.
+ And it must end with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Within
+End
\end_layout
\end_inset
-), the string
-\begin_inset Newline newline
+
+\begin_inset Quotes erd
\end_inset
+.
+ The following parameters can also be used:
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-themaster.
-\backslash
-arabic{counter}
+InitialValue
\end_layout
\end_inset
- is used; otherwise the string
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-arabic{counter}
+int=1
\end_layout
\end_inset
- is used.
+] Sets the initial value for the counter, to which it will be reset whenever
+ that happens.
+ Normally, one will want the default, 1.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+LabelString
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-] Same as
+] When defined, this string defines how the counter is displayed.
+ Setting this value sets
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+LabelStringAppendix
\end_layout
\end_inset
-, but for use in the Appendix.
+ to the same value.
+ The following special constructs can be used in the string:
\end_layout
-\begin_layout Description
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PrettyFormat
+
+\backslash
+thecounter
\end_layout
\end_inset
- [
+ will be replaced by the expansion of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+LabelString
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+ (or
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+LabelStringAppendix
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] A format for use with formatted references to this counter.
- For example, one might want to have references to section numbers appear
- as
-\begin_inset Quotes eld
-\end_inset
-
-Section 2.4
-\begin_inset Quotes erd
+) of the counter
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+counter
+\end_layout
+
\end_inset
.
- The string should contain
-\begin_inset Quotes eld
-\end_inset
+
+\end_layout
-##
-\begin_inset Quotes erd
+\begin_layout Itemize
+counter values can be expressed using \SpecialChar LaTeX
+-like macros
+\begin_inset Newline newline
\end_inset
-.
- This will be replaced by the counter number itself.
- So, for sections, it would be: Section ##.
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Within
-\end_layout
-
-\end_inset
- [
-\begin_inset Flex Code
-status collapsed
+\backslash
-\begin_layout Plain Layout
-string
+\emph on
+numbertype
+\emph default
+{
+\emph on
+counter
+\emph default
+}
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] If this is set to the name of another counter, the present counter will
- be reset every time the other one is increased.
- For example,
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-subsection
+
+\emph on
+numbertype
\end_layout
\end_inset
- is numbered inside
-\begin_inset Flex Code
+ can be:
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-section
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Subsection
-Font description
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Font-description"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-A font description looks like this:
-\end_layout
-\begin_layout LyX-Code
-Font
\family roman
-\emph on
-or
+\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
- LabelFont
+\bar default
+
+\size default
\emph on
- or
-\emph default
- DefaultFont
-\end_layout
-
-\begin_layout LyX-Code
- ...
-\end_layout
-
-\begin_layout LyX-Code
-EndFont
+\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 Standard
-The following commands are available:
-\end_layout
+\end_inset
-\begin_layout Description
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Color
+arabic
\end_layout
\end_inset
- [
+: 1, 2, 3,\SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-none
+alph
\end_layout
\end_inset
-,
+ for lower-case letters: a, b, c, \SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-black
+Alph
\end_layout
\end_inset
-,
+ for upper-case letters: A, B, C, \SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-white
+roman
\end_layout
\end_inset
-,
+ for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-red
+Roman
\end_layout
\end_inset
-,
+ for upper-case roman numerals: I, II, III\SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-green
+hebrew
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-blue
+ for hebrew numerals.
\end_layout
-\end_inset
-
-,
+\end_deeper
+\begin_layout Standard
+If LabelString is not defined, a default value is constructed as follows:
+ if the counter has a master counter
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-cyan
+master
\end_layout
\end_inset
-,
+ (defined via
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-magenta
+Within
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-yellow
-\end_layout
-
+), the string
+\begin_inset Newline newline
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-brown
+
+\backslash
+themaster.
+\backslash
+arabic{counter}
\end_layout
\end_inset
-,
+ is used; otherwise the string
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-darkgray
+
+\backslash
+arabic{counter}
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-gray
+ is used.
\end_layout
-\end_inset
-
-,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lightgray
+LabelStringAppendix
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lime
+string
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-orange
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
+] Same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-olive
+LabelString
\end_layout
\end_inset
-,
+, but for use in the Appendix.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-pink
+PrettyFormat
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-purple
+string
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-teal
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-violet
-\end_layout
+] 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 Description
status collapsed
\begin_layout Plain Layout
-Family
+Within
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Roman
+string
\end_layout
\end_inset
-,
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] If this is set to the name of another counter, the present counter will
+ be reset every time the other one is increased.
+ For example,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sans
+subsection
\end_layout
\end_inset
-,
+ is numbered inside
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Typewriter
+section
\end_layout
\end_inset
-]
+.
+\end_layout
+
+\begin_layout Subsection
+Font description
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Font-description"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+A font description looks like this:
+\end_layout
+
+\begin_layout LyX-Code
+Font
+\family roman
+\emph on
+or
+\family default
+\emph default
+ LabelFont
+\emph on
+
+\family roman
+or
+\family default
+\emph default
+ DefaultFont
+\end_layout
+
+\begin_layout LyX-Code
+ ...
+\end_layout
+
+\begin_layout LyX-Code
+EndFont
+\end_layout
+
+\begin_layout Standard
+The following commands are available:
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Misc
+Color
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+none
\end_layout
\end_inset
-] Valid arguments are:
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-emph
+black
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-noun
+white
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-strikeout
+red
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-underbar
+green
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-uuline
+blue
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-uwave
+cyan
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-no_emph
+magenta
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-no_noun
+yellow
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-no_strikeout
+brown
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-no_bar
+darkgray
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-no_uuline
+gray
\end_layout
\end_inset
- and
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_uwave
+lightgray
\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
+lime
\end_layout
\end_inset
- turns on emphasis, and
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
+orange
\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
+olive
\end_layout
\end_inset
- would turn off the emphasis that was anyway in effect, say, in a theorem
- environment.
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+pink
\end_layout
-\begin_layout Description
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Series
+purple
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Medium
+teal
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Bold
+violet
\end_layout
\end_inset
-]
+]
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Shape
+Family
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-Up
+Roman
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Italic
+Sans
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-SmallCaps
+Typewriter
\end_layout
\end_inset
-,
+]
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Slanted
+Misc
\end_layout
\end_inset
-]
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Size
+string
\end_layout
\end_inset
- [
+] Valid arguments are:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tiny
+emph
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-small
+noun
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-normal
+strikeout
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-large
+underbar
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-larger
+uuline
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-largest
+uwave
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-huge
+no_emph
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-giant
+no_noun
\end_layout
\end_inset
-]
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_strikeout
\end_layout
-\begin_layout Subsection
+\end_inset
-\change_inserted -712698321 1483869872
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Citation-engine-description"
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_bar
+\end_layout
\end_inset
-Citation engine description
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_uuline
\end_layout
-\begin_layout Standard
+\end_inset
-\change_inserted -712698321 1483875281
-The
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+no_uwave
+\end_layout
-\change_inserted -712698321 1483869913
-CiteEngine
-\change_unchanged
+\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
- 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
-
-\change_inserted -712698321 1483875764
+ turns on emphasis, and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483870430
-default
-\change_unchanged
-
+no_emph
\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
+ turns it off.
+
+\begin_inset Newline newline
\end_inset
-)
-\end_layout
-
-\begin_layout Enumerate
-
-\change_inserted -712698321 1483875766
+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
-
-\change_inserted -712698321 1483870434
-authoryear
-\change_unchanged
-
+no_emph
\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
-
-)
+ would turn off the emphasis that was anyway in effect, say, in a theorem
+ environment.
\end_layout
-\begin_layout Enumerate
-
-\change_inserted -712698321 1483875769
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483870457
-numerical
-\change_unchanged
-
+Series
\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
+ [
+\begin_inset Flex Code
+status collapsed
-Smith and Miller [1]
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-)
+\emph on
+Medium
\end_layout
-\begin_layout Standard
+\end_inset
-\change_inserted -712698321 1483870566
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483870552
-CiteEngine
+Bold
\end_layout
\end_inset
- blocks look like this:
-\end_layout
-
-\begin_layout LyX-Code
-
-\change_inserted -712698321 1483870590
-CiteEngine default
+]
\end_layout
-\begin_layout LyX-Code
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\change_inserted -712698321 1483870615
- cite
+\begin_layout Plain Layout
+Shape
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\change_inserted -712698321 1483870633
- Citep*[][]
-\end_layout
+ [
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
+\begin_layout Plain Layout
-\change_inserted -712698321 1483870652
- citeyearpar[][]=parencite*
+\emph on
+Up
\end_layout
-\begin_layout LyX-Code
-
-\change_inserted -712698321 1483870652
- ...
-\end_layout
+\end_inset
-\begin_layout LyX-Code
+,
+\begin_inset Flex Code
+status collapsed
-\change_inserted -712698321 1483870668
-End
+\begin_layout Plain Layout
+Italic
\end_layout
-\begin_layout Standard
+\end_inset
-\change_inserted -712698321 1483871113
-The tag following
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871085
-CiteEngine
+SmallCaps
\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.
-
-\change_deleted -712698321 1483871114
+,
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+Slanted
\end_layout
-\begin_layout Standard
+\end_inset
-\change_inserted -712698321 1483871119
-The full syntax is:
+]
\end_layout
-\begin_layout LyX-Code
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\change_inserted -712698321 1483870927
-LyXName|alias*<!_stardesc!_stardesctooltip>[][]=latexcmd
+\begin_layout Plain Layout
+Size
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_inserted -712698321 1483871222
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871181
-LyXName
-\change_unchanged
-
+tiny
\end_layout
\end_inset
-: The name as used in the
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871216
-*.lyx
-\change_unchanged
-
+small
\end_layout
\end_inset
- file.
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
-
-\change_inserted -712698321 1483871487
-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
-\change_inserted -712698321 1483871402
-latexcmd
+\emph on
+normal
\end_layout
\end_inset
- sometimes, if the \SpecialChar LaTeX
- command names differ).
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+large
\end_layout
-\end_deeper
-\begin_layout Itemize
+\end_inset
-\change_inserted -712698321 1483871583
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871186
-alias
-\change_unchanged
-
+larger
\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
-
-\change_inserted -712698321 1483871257
-LyXName
+largest
\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
-
-\change_inserted -712698321 1483871559
-alias
+huge
\end_layout
\end_inset
- can be compared to
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+giant
+\end_layout
-\change_inserted -712698321 1483871278
-ObsoletedBy
-\change_unchanged
+\end_inset
+]
\end_layout
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Citation-engine-description"
+
\end_inset
- in layout definitions.
+Cite engine description
\end_layout
-\begin_layout Itemize
-
-\change_inserted -712698321 1483871307
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871296
-latexcmd
-\change_unchanged
-
+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
\end_layout
-\begin_layout Standard
-
-\change_inserted -712698321 1483871348
+\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
-\change_inserted -712698321 1483871316
-Alias
-\change_unchanged
+\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
- and
+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 1483871321
-latexcmd
+\change_inserted -712698321 1526898768
+AddToCiteEngine <engine type> \SpecialChar ldots
+ End
\change_unchanged
\end_layout
\end_inset
- are optional.
- If no
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
+.
+ Note that only cite commands that do not exist yet are added.
+\change_unchanged
-\change_inserted -712698321 1483871333
-latexcmd
\end_layout
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Citation-format-description"
+
\end_inset
- is given, the
+Cite format description
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871340
-LyXName
+CiteFormat
\end_layout
\end_inset
- will be output to \SpecialChar LaTeX
-.
+ 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
-\change_inserted -712698321 1483871604
-Note further:
+\begin_layout LyX-Code
+CiteFormat
\end_layout
-\begin_layout Itemize
+\begin_layout LyX-Code
+ cite ...
+\end_layout
-\change_inserted -712698321 1483871664
-Capitalization indicates that the command also has a capitalized form (
+\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
-\change_inserted -712698321 1483871622
+\end_inset
-\backslash
-Latexcmd
-\change_unchanged
+, 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
- vs.
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1483871626
-
\backslash
-latexcmd
-\change_unchanged
+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
-).
- These usually enforce up-casing of name prefixes (
-\emph on
-von Goethe
-\emph default
-
-\begin_inset Formula $\Rightarrow$
+ 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
-
-\emph on
-Von Goethe
-\emph default
).
\end_layout
-\begin_layout Itemize
+\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
-\change_inserted -712698321 1483871690
-Brackets
+\begin_layout Plain Layout
+%
+\end_layout
+
+\end_inset
+
+ signs, e.g.:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+%author%
+\end_layout
-\change_inserted -712698321 1483871670
-[]
-\change_unchanged
+\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
- indicate the number of optional arguments (there can be 0–2).
+%volume%]]}
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_inserted -712698321 1483871747
-A star
+.
+ 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
-\change_inserted -712698321 1483871698
-*
-\change_unchanged
+\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
- indicates there is a starred version of the command (
+.
+\begin_inset Newline newline
+\end_inset
+
+Here, the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+author
+\end_layout
-\change_inserted -712698321 1483871718
+\end_inset
-\backslash
-latexcmd*
-\change_unchanged
+ key is printed if it exists; otherwise, the editor key is printed, followed
+ by
+\begin_inset Quotes eld
+\end_inset
-\end_layout
+,
+\begin_inset space ~
+\end_inset
+ed.
+\begin_inset Quotes erd
\end_inset
- vs.
-
+ Note that the key is again enclosed in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871724
-
-\backslash
-latexcmd
-\change_unchanged
-
+%
\end_layout
\end_inset
-).
-
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
-
-\change_inserted -712698321 1483871864
-By default, the starred version means: Output all authors even if it should
- be shortened with
+ 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
-et al.
-\begin_inset Quotes erd
-\end_inset
- due to the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+[[
+\end_layout
-\change_inserted -712698321 1483871835
-MaxCiteNames
-\change_unchanged
+\end_inset
-\end_layout
+\begin_inset Quotes eld
\end_inset
- threshold.
-\end_layout
+ and
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-\change_inserted -712698321 1483872045
-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
+]]
+\end_layout
-\change_inserted -712698321 1483871856
-<!_stardesc!_stardesctooltip>
-\change_unchanged
+\end_inset
-\end_layout
+\begin_inset Quotes erd
\end_inset
.
- Maximal two translatable macro keywords, marked by the prefix
+ 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
-\change_inserted -712698321 1483872014
-!_
-\change_unchanged
+\end_inset
-\end_layout
+: process the
+\begin_inset Quotes eld
+\end_inset
+true
+\begin_inset Quotes erd
\end_inset
-, can be given.
- The first points to the string that replaces the
+ part for dialogs and menus, the
\begin_inset Quotes eld
\end_inset
-Full aut&hor list
+false
\begin_inset Quotes erd
\end_inset
- checkbox label in the citation dialog, the second one to an optional tool
- tip for this checkbox.
-
+ part for other contexts (workarea, export)
\end_layout
-\begin_layout Standard
-
-\change_inserted -712698321 1483872164
-Note that these two macros have to be defined in a
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871983
-CiteFormat
-\change_unchanged
-
+{%export%[[true]][[false]]}
\end_layout
\end_inset
- (see next section), dropping the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
+: process the
+\begin_inset Quotes eld
+\end_inset
-\change_inserted -712698321 1483872023
-!
-\change_unchanged
+true
+\begin_inset Quotes erd
+\end_inset
-\end_layout
+ part for export and menus, the
+\begin_inset Quotes eld
+\end_inset
+false
+\begin_inset Quotes erd
\end_inset
- from the prefix, like this:
+ part for other contexts (workarea, dialog)
\end_layout
-\begin_layout LyX-Code
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
-\change_inserted -712698321 1483872092
-_stardesc Sta&rred command label
+\begin_layout Plain Layout
+{%next%[[true]]}
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\change_inserted -712698321 1483872184
-_stardesctooltip Tooltip for the starred command checkbox.
-\end_layout
+: process the
+\begin_inset Quotes eld
+\end_inset
-\end_deeper
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Citation-format-description"
+true
+\begin_inset Quotes erd
+\end_inset
+ part if another item follows (e.
+\begin_inset space \thinspace{}
\end_inset
-Citation format description
+g., in a citation with multiple keys)
\end_layout
-\begin_layout Standard
-The
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
+{%second%[[true]][[false]]}
\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
+: process the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
-CiteFormat
-\end_layout
+true
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
- article ...
-\end_layout
+ if this is the second of multiple items, else the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
- book ...
+false
+\begin_inset Quotes erd
+\end_inset
+
+ part
\end_layout
-\begin_layout LyX-Code
-End
-\change_inserted -712698321 1483867197
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+{%ifstar%[[true]][[false]]}
\end_layout
-\begin_layout Standard
+\end_inset
-\change_inserted -712698321 1483867200
-or
-\end_layout
+: process the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
+true
+\begin_inset Quotes erd
+\end_inset
-\change_inserted -712698321 1483867195
-CiteFormat
-\end_layout
+ part for starred citation commands (such as
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
+\begin_layout Plain Layout
-\change_inserted -712698321 1483867204
- cite ...
+\backslash
+cite*
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\change_inserted -712698321 1483867359
- citet*[][] ...
+), the false part for unstarred
\end_layout
-\begin_layout LyX-Code
-
-\change_inserted -712698321 1483867195
-End
-\change_unchanged
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+{%ifentrytype:<type>%[[true]][[false]]}
\end_layout
-\begin_layout Standard
+\end_inset
-\change_inserted -712698321 1483867269
-In the first case,
-\change_deleted -712698321 1483867270
-T
-\change_inserted -712698321 1483867270
-t
-\change_unchanged
-he individual lines define how the bibliographic information associated
- with an article or book, respectively, is to be displayed, and such a definitio
-n can be given for any
-\change_deleted -712698321 1483867550
-`
-\change_inserted -712698321 1483867550
+: process the
+\begin_inset Quotes eld
+\end_inset
-\begin_inset Quotes els
+true
+\begin_inset Quotes erd
\end_inset
+ if the current entry type matches
+\begin_inset Flex Code
+status collapsed
-\change_unchanged
-entry type
-\change_deleted -712698321 1483867552
-'
-\change_inserted -712698321 1483867552
+\begin_layout Plain Layout
+<type>
+\end_layout
-\begin_inset Quotes ers
\end_inset
-
-\change_unchanged
- 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
+, else the false part (e.g., in a citation definition:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdciteformats.inc
+{%ifentrytype:book%[[this is a book]][[this is no book]]}
\end_layout
\end_inset
-, which is included in most of \SpecialChar LyX
-'s document classes.
-\change_inserted -712698321 1483867288
-
+)
\end_layout
-\begin_layout Standard
-
-\change_inserted -712698321 1483875512
-In the second case, the lines define how a specific citation command (in
- the example
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+{%ifmultiple:<authortype>%[[true]][[false]]}
+\end_layout
-\change_inserted -712698321 1483867674
-
-\backslash
-cite
-\change_unchanged
+\end_inset
-\end_layout
+: 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
-
-\change_inserted -712698321 1483867679
-
-\backslash
-citet
-\change_unchanged
-
+{%ifmultiple:editor%[[eds.]][[ed.]]}
\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
+)
+\end_layout
-\family default
- in specific
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483875503
-*.citeengine
+{%ifqualified%[[true]][[false]]}
\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"
-
+: process the
+\begin_inset Quotes eld
\end_inset
-).
-\change_unchanged
+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
-The definitions use a simple language that allows Bib\SpecialChar TeX
- keys to be replaced
- with their values.
- Keys should be enclosed in
+We said that
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%
+%author%
\end_layout
\end_inset
- signs, e.g.:
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-%author%
-\end_layout
-
+ 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
-.
- So a simple definition might look like this:
-\end_layout
+Miller, Peter and Smith, Mary and White, Jane
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-misc %author%,
+ (since
\begin_inset Quotes eld
\end_inset
-%title%
+and
\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.
+ 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 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 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
-{%volume%[[vol.
-\begin_inset space ~
-\end_inset
-
-%volume%]]}
+<nametype>
\end_layout
\end_inset
-.
- This says: If the
+ part denotes the kind of list that is requested (e.g.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-volume
+<nametype:author>
\end_layout
\end_inset
- key exists, then print
-\begin_inset Quotes eld
-\end_inset
+):
+\end_layout
-vol.
-\begin_inset space ~
-\end_inset
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+%abbrvnames:<nametype>%
+\end_layout
-\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
+: 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
-{%author%[[%author%]][[%editor%, ed.]]}
+MaxCiteNames
\end_layout
\end_inset
-.
-\begin_inset Newline newline
-\end_inset
+ is reached.
+\end_layout
-Here, the
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-author
+%fullnames:<nametype>%
\end_layout
\end_inset
- key is printed if it exists; otherwise, the editor key is printed, followed
- by
+: Provides a full name list (never abbreviated with
\begin_inset Quotes eld
\end_inset
-,
-\begin_inset space ~
-\end_inset
-
-ed.
+et al.
\begin_inset Quotes erd
\end_inset
- Note that the key is again enclosed in
+).
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%
+%forceabbrvnames:<nametype>%
\end_layout
\end_inset
- signs; the entire conditional is enclosed in braces; and the if and else
- clauses are enclosed in double brackets,
+: 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
- and
-\begin_inset Quotes eld
+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
-.
- There must be no space between any of these.
-\change_inserted -712698321 1483867855
+) when
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+MaxCiteNames
\end_layout
-\begin_layout Standard
+\end_inset
-\change_inserted -712698321 1483867910
-Next to the entry keys, there are some special keys that can be used for
- these conditionals:
+ is reached.
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1483868049
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483867962
-{%dialog%[[true]][[false]]}
-\change_unchanged
-
+%fullbynames:<nametype>%
\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
+: Provides a full name list (never abbreviated with
\begin_inset Quotes eld
\end_inset
-false
+et al.
\begin_inset Quotes erd
\end_inset
- part for other contexts (workarea, export)
+).
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1483868068
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483868052
-{%export%[[true]][[false]]}
+%forceabbrvbynames:<nametype>%
\end_layout
\end_inset
-: process the
+: Provides a name list which is always abbreviated (with
\begin_inset Quotes eld
\end_inset
-true
+et al.
\begin_inset Quotes erd
\end_inset
- part for export and menus, the
-\begin_inset Quotes eld
+) irrespective of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
\end_inset
-false
-\begin_inset Quotes erd
+.
+\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 for other contexts (workarea, dialog)
+ 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
-
-\change_inserted -712698321 1483868138
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483868076
-{%next%[[true]]}
+%abbrvciteauthor%
\end_layout
\end_inset
-: process the
+: Provides a name list which is abbreviated (with
\begin_inset Quotes eld
\end_inset
-true
+et al.
\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
-
-\change_inserted -712698321 1483868174
+) when
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483868144
-{%second%[[true]][[false]]}
+MaxCiteNames
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
+ is reached.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%fullciteauthor%
+\end_layout
-true
-\begin_inset Quotes erd
\end_inset
- if this is the second of multiple items, else the
+: Provides a full name list (never abbreviated with
\begin_inset Quotes eld
\end_inset
-false
+et al.
\begin_inset Quotes erd
\end_inset
- part
+).
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1483868321
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483868259
-{%ifstar%[[true]][[false]]}
+%forceabbrvciteauthor%
\end_layout
\end_inset
-: process the
+: Provides a name list which is always abbreviated (with
\begin_inset Quotes eld
\end_inset
-true
+et al.
\begin_inset Quotes erd
\end_inset
- part for starred citation commands (such as
+) irrespective of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
-\change_inserted -712698321 1483868310
+\end_inset
-\backslash
-cite*
-\change_unchanged
+.
+\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
-), the false part for unstarred
+ (first author in lists of type 1)
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1483868404
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483868330
-{%ifentrytype:<type>%[[true]][[false]]}
+!othernameform %surname%, %prename%
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
-
-true
-\begin_inset Quotes erd
-\end_inset
+ (other authors in lists of type 1)
+\end_layout
- if the current entry type matches
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483868364
-<type>
-\change_unchanged
-
+!firstbynameform %prename% %surname%
\end_layout
\end_inset
-, else the false part (e.g., in a citation definition:
+ (first author in lists of type 2)
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
-status open
+status collapsed
\begin_layout Plain Layout
+!otherbynameform %prename% %surname%
+\end_layout
-\change_inserted -712698321 1483868420
-{%ifentrytype:book%[[this is a book]][[this is no book]]}
-\change_unchanged
+\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
-)
-\change_unchanged
+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
\end_layout
\begin_layout LyX-Code
-_pptext pp.
+B_pptext pp.
\end_layout
\begin_layout Standard
This defines a translatable piece of text, which allows relevant parts of
- the bibliography
-\change_inserted -712698321 1483868477
-or citation
-\change_unchanged
-to be translated.
+ 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
-%_pptext%
+%B_pptext%
\end_layout
\end_inset
.
- Several of these are predefined in
+ Note that there are two different translation paths: All definitions starting
+ with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdciteformats.inc
+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
-\change_inserted -712698321 1483868503
- and the diverse
+\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
-\change_inserted -712698321 1483868503
-*.citeengine
-\change_unchanged
+\end_inset
+
+ and the diverse
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+*.citeengine
\end_layout
\end_inset
- files
-\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 use all these features:
+So here then is an example that uses several of these features:
\begin_inset VSpace defskip
\end_inset
\begin_layout Standard
\noindent
-\family typewriter
-!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
+\family sans
+!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
\end_layout
\begin_layout Standard
status collapsed
\begin_layout Plain Layout
-_edtext
+B_edtext
\end_layout
\end_inset
\end_layout
\begin_layout LyX-Code
+
+\family sans
<tag attr=
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout LyX-Code
+
+\family sans
<labeltag attr=
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout LyX-Code
+
+\family sans
Contents of the paragraph.
\end_layout
\begin_layout LyX-Code
+
+\family sans
</tag>
\end_layout
\end_layout
\begin_layout LyX-Code
+
+\family sans
<tag attr=
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout LyX-Code
+
+\family sans
<itemtag attr=
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout LyX-Code
+
+\family sans
<itemtag>Second paragraph.</itemtag>
\end_layout
\begin_layout LyX-Code
+
+\family sans
</tag>
\end_layout
\end_layout
\begin_layout LyX-Code
+
+\family sans
<tag attr=
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout LyX-Code
+
+\family sans
<itemtag attr=
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout LyX-Code
+
+\family sans
<itemtag attr=
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout LyX-Code
+
+\family sans
</tag>
\end_layout
\end_layout
\begin_layout LyX-Code
+
+\family sans
<tag attr=
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout LyX-Code
+
+\family sans
<labeltag attr=
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout LyX-Code
+
+\family sans
<labeltag attr=
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout LyX-Code
+
+\family sans
</tag>
\end_layout
\end_inset
] Attributes for the item tag.
- Defaults to
+ Defaults to
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Quotes eld
\end_inset
\end_inset
] Attributes for the label tag.
- Defaults to
+ Defaults to
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Quotes eld
\end_inset
\end_inset
] Attributes for the inner tag.
- Defaults to
+ Defaults to
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Section
-The external template configuration file
+The external template configuration files
\end_layout
\begin_layout Standard
status collapsed
\begin_layout Plain Layout
-LyXDir/lib/external_templates
+*.xtemplate
\end_layout
\end_inset
- file.
- You can place your own version in
+ files that are stored in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UserDir/external_templates
+LyXDir/lib/xtemplates/
\end_layout
\end_inset
-.
+ directory.
+ Each template is defined in a file of its own.
+ You can place your own templates in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+UserDir/xtemplates/
+\end_layout
+
+\end_inset
+
+ or copy existing templates to that directory in order to modify them.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-The colors listed here are the standard colors and the those that you can
- adjust in the \SpecialChar LyX
+The colors listed below are the standard colors and those that you can adjust
+ in the \SpecialChar LyX
preferences.
\end_layout
+\begin_layout Section
+Color functions
+\end_layout
+
+\begin_layout Standard
+The following are no real colors, but rather act on color definitions:
+\end_layout
+
+\begin_layout Description
+ignore The color is ignored
+\end_layout
+
+\begin_layout Description
+inherit The color is inherited
+\end_layout
+
\begin_layout Description
none
\family roman
No particular color – clear or default
\end_layout
+\begin_layout Section
+Static colors
+\end_layout
+
+\begin_layout Standard
+These are fixed colors that cannot me customized:
+\end_layout
+
\begin_layout Description
black
\end_layout
\end_layout
\begin_layout Description
-red
+blue
+\end_layout
+
+\begin_layout Description
+brown
+\end_layout
+
+\begin_layout Description
+cyan
+\end_layout
+
+\begin_layout Description
+darkgray
+\end_layout
+
+\begin_layout Description
+gray
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-blue
+lightgray
\end_layout
\begin_layout Description
-cyan
+lime
\end_layout
\begin_layout Description
magenta
\end_layout
+\begin_layout Description
+olive
+\end_layout
+
+\begin_layout Description
+orange
+\end_layout
+
+\begin_layout Description
+pink
+\end_layout
+
+\begin_layout Description
+purple
+\end_layout
+
+\begin_layout Description
+red
+\end_layout
+
+\begin_layout Description
+teal
+\end_layout
+
+\begin_layout Description
+violet
+\end_layout
+
\begin_layout Description
yellow
\end_layout
+\begin_layout Section
+Dynamic colors
+\end_layout
+
+\begin_layout Standard
+These are the colors allocated to specific elements in
+\begin_inset Info
+type "menu"
+arg "dialog-show prefs"
+\end_inset
+
+:
+\end_layout
+
\begin_layout Description
-added_space Added space marker color
+added_space Added space color
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-buttonhoverbg Color used for button background under focus
+buttonframe Color for inset button frames
\end_layout
\begin_layout Description
-buttonframe Color for inset button frames
+buttonhoverbg Color used for button background under focus
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-collapsable_inset_frame Collapsable insets framecolor
+collapsible Collapsible insets text color
\end_layout
\begin_layout Description
-collapsable_inset_text Collapsable insets text color
+collapsibleframe Collapsible insets framecolor
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-comment color for comments
+comment Label color for comments
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-graphicsbg Graphics inset background color
+foreground Foreground color
\end_layout
\begin_layout Description
-greyedout Label color for greyedout insets
+graphicsbg Graphics inset background color
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-greyedouttext Color for greyedout inset text
-\end_layout
-
-\begin_layout Description
-indexlabel Label color for index insets
+greyedoutlabel Label color for greyedout insets
\end_layout
\begin_layout Description
-ignore The color is ignored
+greyedouttext Color for greyedout inset text
\end_layout
\begin_layout Description
-inherit The color is inherited
+indexlabel Label color for index insets
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-notebg Background color of notes
+note Label color for notes
\end_layout
\begin_layout Description
-notelabel Label color for notes
+notebg Background color of notes
\end_layout
\begin_layout Description
regexpframe Color for regexp frame
\end_layout
+\begin_layout Description
+scroll Color that indicates when a row can be scrolled
+\end_layout
+
\begin_layout Description
selection Background color of selected text
\end_layout
projects / features.git / blobdiff