#LyX 2.3 created this file. For more info see http://www.lyx.org/
-\lyxformat 528
+\lyxformat 544
\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
\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
\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
\html_css_as_file 0
\html_be_strict true
\author -712698321 "Jürgen Spitzmüller"
-\author 2089657418 "Usti"
\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
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.)
+ 2.3, the current layout format is 63.)
\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 63
\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
\end_layout
\begin_layout Standard
-The module declaration should then be followed by lines like the following
+The module 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
\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_unchanged
-
\end_layout
\begin_layout Description
\end_inset
.
-
-\change_inserted -712698321 1483875199
Primarily used in cite engine files (see
\begin_inset CommandInset ref
LatexCommand ref
\end_inset
).
-\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
\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
, 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
-
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1477038425
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1477038295
PassThru
\end_layout
\begin_layout Plain Layout
-\change_inserted -712698321 1477038311
-
\emph on
inherited
\emph default
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
\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
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+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
+EndIsAutoNestedBy
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See also
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AutoNests
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\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 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
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.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
+ 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
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
Itemize
\end_layout
\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 1523696969
+\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.
+\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
\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
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 1523634088
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523633961
+NeedCProtect
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523633958
+
+\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 1523633958
+1
+\end_layout
+
+\end_inset
+
+] This causes macros that contain this inset to be protected with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523634038
+
+\backslash
+cprotect
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ (cf.
+ package
+\family sans
+cprotect
+\family default
+) if necessary and thus allows (some) verbatim stuff in macros.
+ Default is false.
+\change_unchanged
+
\end_layout
\begin_layout Description
\emph default
LabelFont
\emph on
- or
+
+\family roman
+or
+\family default
\emph default
DefaultFont
\end_layout
\end_layout
\begin_layout Subsection
-
-\change_inserted -712698321 1483869872
\begin_inset CommandInset label
LatexCommand label
name "subsec:Citation-engine-description"
\end_inset
-Citation engine description
+Cite engine description
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1483875281
The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483869913
CiteEngine
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Enumerate
-
-\change_inserted -712698321 1483875764
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483870430
default
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Enumerate
-
-\change_inserted -712698321 1483875766
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483870434
authoryear
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Enumerate
-
-\change_inserted -712698321 1483875769
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483870457
numerical
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1483870566
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483870552
CiteEngine
\end_layout
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483870590
CiteEngine default
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483870615
cite
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483870633
Citep*[][]
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483870652
citeyearpar[][]=parencite*
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483870652
...
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483870668
End
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1483871113
The tag following
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871085
CiteEngine
\end_layout
command and the \SpecialChar LaTeX
output or more complex in order to differentiate
things.
-
-\change_deleted -712698321 1483871114
-
-\end_layout
-
-\begin_layout Standard
-
-\change_inserted -712698321 1483871119
-The full syntax is:
+ The full syntax is:
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483870927
-LyXName|alias*<!_stardesc!_stardesctooltip>[][]=latexcmd
+LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1483871222
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871181
LyXName
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871216
*.lyx
-\change_unchanged
-
\end_layout
\end_inset
\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
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871402
latexcmd
\end_layout
\end_deeper
\begin_layout Itemize
-
-\change_inserted -712698321 1483871583
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871186
alias
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871257
LyXName
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871559
alias
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871278
ObsoletedBy
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1483871307
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871296
latexcmd
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1483871348
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871316
Alias
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871321
latexcmd
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871333
latexcmd
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871340
LyXName
\end_layout
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1483871604
Note further:
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1483871664
Capitalization indicates that the command also has a capitalized form (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1483871622
-
\backslash
Latexcmd
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1483871626
-
\backslash
latexcmd
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1483871690
Brackets
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871670
[]
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1483871747
A star
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871698
*
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1483871718
-
\backslash
latexcmd*
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1483871724
-
\backslash
latexcmd
-\change_unchanged
-
\end_layout
\end_inset
\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
\begin_inset Quotes eld
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871835
MaxCiteNames
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\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
-
-\change_inserted -712698321 1483871856
<!_stardesc!_stardesctooltip>
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483872014
!_
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1483872164
Note that these two macros have to be defined in a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483871983
CiteFormat
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483872023
!
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483872092
_stardesc Sta&rred command label
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483872184
_stardesctooltip Tooltip for the starred command checkbox.
\end_layout
\end_deeper
+\begin_layout Itemize
+A dollar sign
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$
+\end_layout
+
+\end_inset
+
+ indicates that this command features
+\begin_inset Quotes eld
+\end_inset
+
+qualified citation lists
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This is a
+\family sans
+Biblatex
+\family default
+-specific feature for multi-reference citations where an individual pre-
+ and postnote can be given to each reference in the list.
+ Please refer to the
+\family sans
+Biblatex
+\family default
+ manual for details.
+\end_layout
+
\begin_layout Subsection
\begin_inset CommandInset label
LatexCommand label
\end_inset
-Citation format description
+Cite format description
\end_layout
\begin_layout Standard
\begin_layout LyX-Code
End
-\change_inserted -712698321 1483867197
-
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1483867200
or
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483867195
CiteFormat
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483867204
cite ...
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483867359
citet*[][] ...
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -712698321 1483867195
End
-\change_unchanged
-
\end_layout
\begin_layout Standard
-
-\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
-
+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
-
-\change_unchanged
entry type
-\change_deleted -712698321 1483867552
-'
-\change_inserted -712698321 1483867552
-
\begin_inset Quotes ers
\end_inset
-
-\change_unchanged
that might be present in a Bib\SpecialChar TeX
file.
\SpecialChar LyX
, 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_inset Flex Code
\begin_layout Plain Layout
-\change_inserted -712698321 1483867674
-
\backslash
cite
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1483867679
-
\backslash
citet
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483875503
*.citeengine
\end_layout
\end_inset
).
-\change_unchanged
-
\end_layout
\begin_layout Standard
.
There must be no space between any of these.
-\change_inserted -712698321 1483867855
-
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1483867910
Next to the entry keys, there are some special keys that can be used for
these conditionals:
\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
-
\end_layout
\end_inset
\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]]}
\end_layout
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1483868138
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1483868076
{%next%[[true]]}
\end_layout
\end_layout
\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%second%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ if this is the second of multiple items, else the
+\begin_inset Quotes eld
+\end_inset
+
+false
+\begin_inset Quotes erd
+\end_inset
+
+ part
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifstar%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
-\change_inserted -712698321 1483868174
+ part for starred citation commands (such as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1483868144
-{%second%[[true]][[false]]}
+\backslash
+cite*
+\end_layout
+
+\end_inset
+
+), the false part for unstarred
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifentrytype:<type>%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ if the current entry type matches
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<type>
\end_layout
\end_inset
-: process the
-\begin_inset Quotes eld
-\end_inset
+, else the false part (e.g., in a citation definition:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifentrytype:book%[[this is a book]][[this is no book]]}
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifmultiple:<authortype>%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ if the current author type (author, editor etc.) has multiple authors, else
+ the false part (e.g., in a bibliography definition:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifmultiple:editor%[[eds.]][[ed.]]}
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifqualified%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ part if the current citation is a qualified citation list (a specific
+\family sans
+Biblatex
+\family default
+ format for multi-reference citations), the false part if this is not the
+ case.
+\end_layout
+
+\begin_layout Standard
+We said that
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%author%
+\end_layout
+
+\end_inset
+
+ prints the author key as it is recorded in the bibliography file.
+ This might not be what you want, since it will result in a string such
+ as
+\begin_inset Quotes eld
+\end_inset
+
+Miller, Peter and Smith, Mary and White, Jane
+\begin_inset Quotes erd
+\end_inset
+
+ (since
+\begin_inset Quotes eld
+\end_inset
+
+and
+\begin_inset Quotes erd
+\end_inset
+
+ is used by Bib\SpecialChar TeX
+ to delimit authors).
+ \SpecialChar LyX
+ therefore provides some methods to get properly formatted name lists (which
+ will also get translated).
+ The following keys are provided:
+\end_layout
+
+\begin_layout Enumerate
+For name lists with pre- and surname, suitable for the main authors/editors
+ of a bibliography item.
+ The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<nametype>
+\end_layout
+
+\end_inset
+
+ part denotes the kind of list that is requested (e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<nametype:author>
+\end_layout
+
+\end_inset
+
+):
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%abbrvnames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a name list which is abbreviated (with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) when
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+ is reached.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%fullnames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a full name list (never abbreviated with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%forceabbrvnames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a name list which is always abbreviated (with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) irrespective of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+Alternative name lists with pre- and surname, if the order of pre- and surname
+ inside the bibliography item differs (as in:
+\begin_inset Quotes eld
+\end_inset
+
+Miller, John: Some text, in: Mary Smith, ed.: A volume
+\begin_inset Quotes erd
+\end_inset
+
+):
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%abbrvbynames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a name list which is abbreviated (with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) when
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+ is reached.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%fullbynames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a full name list (never abbreviated with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%forceabbrvbynames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a name list which is always abbreviated (with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) irrespective of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+And finally name lists which consist of family names only, as used in author-yea
+r citation labels.
+ These do not take a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<nametype>
+\end_layout
+
+\end_inset
+
+ part, but always return either an author list or, if this does not exist,
+ an editor list (as common in author-year labels):
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%abbrvciteauthor%
+\end_layout
+
+\end_inset
+
+: Provides a name list which is abbreviated (with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) when
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+ is reached.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%fullciteauthor%
+\end_layout
-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 / lyx.git / blobdiff