-#LyX 2.2 created this file. For more info see http://www.lyx.org/
-\lyxformat 503
+#LyX 2.3 created this file. For more info see http://www.lyx.org/
+\lyxformat 544
\begin_document
\begin_header
-\origin unavailable
+\save_transient_properties true
+\origin /systemlyxdir/doc/
\textclass scrbook
\begin_preamble
% DO NOT ALTER THIS PREAMBLE!!!
% the documentation team
% email: lyx-docs@lists.lyx.org
-\usepackage{ifpdf} % part of the hyperref bundle
-\ifpdf % if pdflatex is used
-
- % set fonts for nicer pdf view
- \IfFileExists{lmodern.sty}
- {\usepackage{lmodern}}{}
-
-\fi % end if pdflatex is used
-
% the pages of the TOC is numbered roman
% and a pdf-bookmark for the TOC is added
\let\myTOC\tableofcontents
}
}{}
\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
\end_modules
\maintain_unincluded_children false
-\begin_local_layout
-Format 57
-InsetLayout Flex:MenuItem
-LyxType charstyle
-LabelString menu
-LatexType command
-LatexName menuitem
-Font
-Family Sans
-EndFont
-Preamble
-\newcommand*{\menuitem}[1]{{\sffamily #1}}
-EndPreamble
-ResetsFont true
-End
-# In case we need to do with sans...
-#InsetLayout CharStyle:Code
-#Font
-#Family Sans
-#EndFont
-#Preamble
-#\renewcommand{\code}[1]{{\sffamily #1}}
-#EndPreamble
-#End
-\end_local_layout
\language english
\language_package default
\inputencoding auto
\fontencoding global
-\font_roman "default" "default"
-\font_sans "default" "default"
-\font_typewriter "default" "default"
+\font_roman "lmodern" "default"
+\font_sans "lmss" "default"
+\font_typewriter "lmtt" "default"
\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_osf false
\font_sf_scale 100 100
\font_tt_scale 100 100
+\use_microtype false
+\use_dash_ligatures true
\graphics default
-\default_output_format default
+\default_output_format pdf2
\output_sync 0
\bibtex_command default
\index_command default
\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
\filename_suffix 0
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation default
-\quotes_language english
+\is_math_indent 1
+\math_indentation default
+\math_numbering_side default
+\quotes_style english
+\dynamic_quotes 0
\papercolumns 1
\papersides 2
\paperpagestyle headings
-\tracking_changes false
+\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"
\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.1.x
+Version 2.3.x
\end_layout
\begin_layout Standard
\begin_layout Standard
\begin_inset Branch OutDated
+inverted 0
status collapsed
\begin_layout Standard
Before continuing to read this chapter, you should find out where your
\SpecialChar LyX
library and user directories are by using
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and the latter
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
's behavior.
You can change many of these files from within \SpecialChar LyX
itself through the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The files, which are to be found in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
It is currently unused by the \SpecialChar LyX
program itself, but the information extracted,
and more, is made available with
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+citeengines/
+\end_layout
+
+\end_inset
+
+ contains files with the extension
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.citeengine
+\end_layout
+
+\end_inset
+
+ which define the diverse citation possibilities (natbib, biblatex etc.).
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ for details.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
clipart/
\end_layout
contains example files that explain how to use some features.
In the file browser, press the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
contains image files that are used by the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
contains some files that demonstrate the capabilities of the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
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
this file contains the list of \SpecialChar LyX
developers.
The contents are displayed with the menu entry
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain 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 MenuItem
-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
.
\end_inset
in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
The preferences set in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
When you reconfigure using
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
will be added to the list of classes in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and the items in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
subdirectory, however, since it contains a file written by the configuration
script (also accessible through
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The first step is to define your file formats if they are not already defined.
To do so, open the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
dialog.
Under
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
press the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
button to define your new format.
The
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
field contains the name used to identify the format in the GUI.
The
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
You will also need to enter a file extension.
These are all required.
The optional
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
field is used to provide a keyboard shortcut on the menus.
(For example, pressing
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
will
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
A Format can have a
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and an
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
associated with it.
For example, you might want to use
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
next section.
The viewer is launched when you view an image in \SpecialChar LyX
or use the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
menu.
The editor is for example launched when you right-click on an image and
choose
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
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 Standard
The
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
), the format will appear in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
menu.
The format will also appear in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The option
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
that a format can contain vector graphics.
This information is used to determine the target format of included graphics
for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
export.
Included graphics may need to be converted to either
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, or
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, since
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
cannot handle other image formats.
If an included graphic is not already in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, or
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
format, it is converted to
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
if the vector format option is set, and otherwise to
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-The definitions of the copiers may use four variables:
+The definitions of the copiers may use eight variables:
\end_layout
\begin_layout Labeling
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
—and make it executable, if you need to do so on your platform.
Then, in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
dialog, select under
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
into the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
For example, if appropriate programs are found, \SpecialChar LyX
will automatically install
copiers for the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, so HTML generated from
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
will end up in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
You can define your own Converters to convert files between different formats.
This is done in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
To define a new converter, select the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
from the drop-down lists, enter the command needed for the conversion,
and then press the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
In the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\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
Needs the \SpecialChar LaTeX
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\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
\begin_layout Standard
The following three flags are not really flags at all because they take
an argument in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
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_layout Enumerate
Directly, using
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
via (DVI and) PostScript, using
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
via DVI, using
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
directly using
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
directly using
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
.
For example, in the standard configuration, the formats named
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
(for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
),
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
(for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
),
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
(for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
),
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
(for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
), and
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
(for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
) are defined, all of which share the extension
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_inset CommandInset href
LatexCommand href
name "information on the web"
-target "http://www.lyx.org/HowToUseSVN"
+target "https://www.lyx.org/HowToUseGIT"
+literal "false"
\end_inset
\end_inset
- files, as well.
+ files, as well, see
+\begin_inset Flex URL
+status open
+
+\begin_layout Plain Layout
+
+https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
+\backslash
+#PO-Mode
+\end_layout
+
+\end_inset
+
+.
\end_layout
\end_inset
\begin_layout Standard
The online documentation (in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
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
\end_inset
(
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
directory.
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+Note:
+\series default
+ For a complex document with external material (images, etc.), if you make
+ a copy e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+in a temp dir, beware that the links to external material may be broken
+ when the document is moved to a different place.
+ The best way is to retrieve the \SpecialChar LyX
+ tree from git (see
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+https://www.lyx.org/HowToUseGIT
+\end_layout
+
+\end_inset
+
+) and to edit the doc file in place.
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Itemize
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
\begin_layout Standard
\begin_inset Branch OutDated
+inverted 0
status collapsed
\begin_layout Section
\begin_layout Standard
An example of a
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
statement to cause the symbol
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
to be output for the keystroke
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\family default
Note that a
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\family default
\emph default
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
This allows you to press
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\family default
\shape default
in this case cancels the last dead key, so if you press
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
For example, in order to map
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
.
You could bind the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
file.
Now, whenever you type the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
never takes a circumflex accent.
Hitting
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Please note this last point! If you bind a key to a dead-key, you'll need
to rebind the character on that key to yet another key.
Binding the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
One common way to bind dead-keys is to use
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, and
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
acts in some ways just like
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
files.
I have my
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
symbolic keys bound such things as
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
key: One of the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
You can edit your preferences so that your desired language environment
is automatically configured when \SpecialChar LyX
starts up, via the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
LatexCommand href
name "CTAN"
target "http://www.ctan.org/"
+literal "false"
\end_inset
\begin_layout Enumerate
Now you need to decide if the package should be available for all users
or only for you.
-\begin_inset Separator parbreak
-\end_inset
-
-
\end_layout
\begin_deeper
\end_inset
-.
+ or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
+Live
+ distribution.
The location of the `user' \SpecialChar TeX
tree is defined by
\begin_inset Flex Code
$HOME/texmf
\end_layout
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\family sans
+$HOME/.texliveXXXX
+\end_layout
+
\end_inset
.
.)
\begin_inset Foot
-status open
+status collapsed
\begin_layout Plain Layout
Note that this will be the correct path only on English installations.
that there are new files.
This depends on the used \SpecialChar LaTeX
-Distribution:
-\begin_inset Separator parbreak
-\end_inset
-
-
\end_layout
\begin_deeper
that there are new packages available.
So, in \SpecialChar LyX
, use the menu
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
status collapsed
\begin_layout Plain Layout
-Slides
-\begin_inset space ~
-\end_inset
-
-(FoilTex)
+FoilTex
\end_layout
\end_inset
will now be available under
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-.
+ (in the
+\begin_inset Quotes eld
+\end_inset
+
+Presentations
+\begin_inset Quotes erd
+\end_inset
+
+ category).
\end_layout
If you would like to use a \SpecialChar LaTeX
document class that is not even listed in the
menu
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain 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
requires editing that file.
Modules, by contrast, are selected in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
appear in the menu.
However, changes you make to the module will be seen immediately, if you
open
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Any format is acceptable, but one would normally use the format current
at the time.
(In \SpecialChar LyX
- 2.1, the current layout format is 48.) You should be aware that local
- layout is not supported by versions of \SpecialChar LyX
- prior to 1.6, so you should not
- use it if you want to be able to export your document to \SpecialChar LyX
- 1.5 or earlier
- (without, that is, losing the local layout information).
- If you wish to be able to export to 1.6—local layout is supported in 1.6,
- though there is no UI for it—then you should use format 11 and, of course,
- use only layout constructs that were available in \SpecialChar LyX
- 1.6.
+ 2.3, the current layout format is 63.)
\end_layout
\begin_layout Standard
\begin_layout Subsection
Layout for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
document class.
For the sake of the example, we'll assume that the style file is called
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and that it is meant to be used with
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout LyX-Code
\backslash
-Declare\SpecialChar LaTeX
-Class{report}
+DeclareLaTeXClass{Report (Standard Class)}
\end_layout
\begin_layout Standard
\begin_layout LyX-Code
\backslash
-Declare\SpecialChar LaTeX
-Class[report, myclass.sty]{report (myclass)}
+DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
\end_layout
\begin_layout Standard
\begin_layout Standard
Start \SpecialChar LyX
and select
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Then restart \SpecialChar LyX
and try creating a new document.
You should see "
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-report (myclass)
+Report (My Class)
\end_layout
\end_inset
" as a document class option in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
If
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\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 35
+Format 63
\begin_inset Newline newline
\end_inset
\backslash
-usepackage{mypkg}
+usepackage{myclass}
\begin_inset Newline newline
\end_inset
\begin_layout Subsection
Layout for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
There are two possibilities here.
One is that the class file is itself based upon an existing document class.
For example, many thesis classes are based upon
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout LyX-Code
\backslash
-Declare\SpecialChar LaTeX
-Class[thesis,book]{thesis}
+DeclareLaTeXClass[thesis,book]{thesis}
\end_layout
\begin_layout Standard
\end_inset
to the same place, and redefine the template path in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\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
.
This template is loaded every time you create a new document with
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
To create this template from inside \SpecialChar LyX
, all you have to do is to open a document
with the correct settings, and use the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
have to be converted separately.
\end_layout
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Cite-Engine-Files"
+
+\end_inset
+
+Cite engine files
+\end_layout
+
+\begin_layout Standard
+A specific form of layout files are the so-called
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+*.citeengine
+\end_layout
+
+\end_inset
+
+ files that are located in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+citeengines/
+\end_layout
+
+\end_inset
+
+ sub-directory.
+ Their purpose is to define the specifics of \SpecialChar LaTeX
+ packages aimed at bibliography
+ generation, such as
+\family sans
+natbib
+\family default
+,
+\family sans
+ jurabib
+\family default
+ or
+\family sans
+biblatex
+\family default
+, but also the way how normal Bib\SpecialChar TeX
+ citations (without additional packages)
+ are handled in \SpecialChar LyX
+ is defined in such a file.
+
+\end_layout
+
+\begin_layout Standard
+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 the workarea,
+ the dialogs, the context menus) as well as in the XHTML and plain text
+ output.
+ Furthermore, the files specify available style variants (author-year, numerical
+, etc.) and their specifics.
+ The cite engine files are also used to generate the options that are available
+ in
+\family sans
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Bibliography\SpecialChar menuseparator
+Style engine
+\family default
+.
+\end_layout
+
+\begin_layout Standard
+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
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFramework
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteEngine
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\end_layout
+
+\end_inset
+
+ blocks.
+ The syntax of the latter two is described in
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Citation-engine-description"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ and
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Citation-format-description"
+
+\end_inset
+
+, as well as in the files themselves.
+\end_layout
+
\begin_layout Section
\begin_inset CommandInset label
LatexCommand label
\end_inset
that appears above is used as a description of the text class in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
in the example) is also used in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, run
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
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
You can force a reload of the current layout by using the \SpecialChar LyX
function
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Warning
\emph default
:
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The mandatory argument, in curly brackets, is the name of the module, as
it should appear in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
packages
on which the module depends.
It is also possible to use the form
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\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
\begin_layout Standard
The description is used in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
.
\end_layout
+\begin_layout Subsection
+The CiteEngine file declaration
+\end_layout
+
+\begin_layout Standard
+A cite engine file must begin with a line like the following:
+\end_layout
+
+\begin_layout LyX-Code
+#
+\backslash
+DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
+\end_layout
+
+\begin_layout Standard
+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
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Bibliography
+\end_layout
+
+\end_inset
+
+.
+ The argument in square brackets is optional: It declares any \SpecialChar LaTeX
+ packages
+ on which the cite engine depends.
+\end_layout
+
+\begin_layout Standard
+The cite engine declaration should then be followed by lines like the following:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+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
+ will be thus translated with the next interface update.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout LyX-Code
+# DescriptionBegin
+\end_layout
+
+\begin_layout LyX-Code
+# Biblatex supports many author-year and numerical styles.
+\end_layout
+
+\begin_layout LyX-Code
+# It is mainly aimed at the Humanities.
+ It is highly
+\end_layout
+
+\begin_layout LyX-Code
+# customizable, fully localized and provides many features
+\end_layout
+
+\begin_layout LyX-Code
+# that are not possible with BibTeX.
+ The use of 'biber' as
+\end_layout
+
+\begin_layout LyX-Code
+# bibliography processor is advised.
+\end_layout
+
+\begin_layout LyX-Code
+# DescriptionEnd
+\end_layout
+
+\begin_layout Standard
+The description is used in
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Bibliography
+\end_layout
+
+\end_inset
+
+ to provide the user with information about the cite engine.
+\end_layout
+
\begin_layout Subsection
Format number
\end_layout
.
The format for the present version of \SpecialChar LyX
- is format 35.
+ is format 60.
But each version of \SpecialChar LyX
is capable of reading earlier versions' layout files,
just as they are capable of reading files produced by earlier versions
status collapsed
\begin_layout Plain Layout
-CiteFormat
+CiteEngine <engine>
\end_layout
\end_inset
- Defines formats for use in the display of bibliographic information.
+ Defines the possibilities for displaying citation references.
See
\begin_inset CommandInset ref
LatexCommand ref
-reference "subsec:Citation-format-description"
+reference "subsec:Citation-engine-description"
+plural "false"
+caps "false"
+noprefix "false"
\end_inset
\end_inset
.
+ Primarily used in cite engine files (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ClassOptions
+CiteFormat
\end_layout
\end_inset
- Describes various global options supported by the document class.
+ Defines formats for use in the display of bibliographic information.
See
\begin_inset CommandInset ref
LatexCommand ref
-reference "subsec:ClassOptions"
+reference "subsec:Citation-format-description"
\end_inset
- for a description.
+ for details.
Must end with
\begin_inset Quotes eld
\end_inset
\end_inset
.
+ Primarily used in cite engine files (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Columns
+CiteFramework
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-1
+bibtex
\end_layout
\end_inset
,
-\begin_inset space \thinspace{}
-\end_inset
-
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-2
+biblatex
\end_layout
\end_inset
-] Whether the class should
-\emph on
-default
-\emph default
- to having one or two columns.
- Can be changed in the
-\begin_inset Flex MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings
-\end_layout
+] Determines whether
+\family sans
+Biblatex
+\family default
+ or Bib\SpecialChar TeX
+ is used to generate a Bibliography.
+ Primarily used in cite engine files (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
\end_inset
- dialog.
+).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Counter
+ClassOptions
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
+ Describes various global options supported by the document class.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:ClassOptions"
+
+\end_inset
+
+ for a description.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+End
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Columns
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+2
+\end_layout
+
+\end_inset
+
+] Whether the class should
+\emph on
+default
+\emph default
+ to having one or two columns.
+ Can be changed in the
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+ dialog.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Counter
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
string
\end_layout
\end_inset
] This is the style that will be assigned to new paragraphs, usually
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_inset Flex Code
status collapsed
-\begin_layout Plain Layout
-IfStyle
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<style>
-\end_layout
-
-\end_inset
-
-] Modifies the properties of the given paragraph style.
- If the style does not exist, the statement is ignored.
- Must end with
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-End
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
\begin_layout Plain Layout
Input
\end_layout
status collapsed
\begin_layout Plain Layout
-NoCounter
+MaxCiteNames
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<counter>
+integer
\end_layout
\end_inset
-] Deletes an existing counter, usually one defined in an included file.
+] An integer that determines the maximal number of names displayed in an
+ author-year citation before the citation switches to
+\begin_inset Quotes eld
+\end_inset
+
+FirstAuthor et al.
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Primarily used in cite engine files (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-NoFloat
+ModifyStyle
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<float>
+<style>
\end_layout
\end_inset
-] Deletes an existing float.
- This is particularly useful when you want to suppress a float that has
- been defined in an input file.
-\end_layout
+] Modifies the properties of the given paragraph style.
+ If the style does not exist, this section is ignored.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NoStyle
+End
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<style>
-\end_layout
+\begin_inset Quotes erd
\end_inset
-] Deletes an existing style.
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-OutputFormat
+NoCounter
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<format>
+<counter>
\end_layout
\end_inset
-] The file format (as defined in the \SpecialChar LyX
- preferences) produced by this document
- class.
- It is mainly useful when
+] Deletes an existing counter, usually one defined in an included file.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-OutputType
+NoFloat
\end_layout
\end_inset
- is
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-literate
+<float>
\end_layout
\end_inset
- and one wants to define a new type of literate document.
- The format is reset to
-\begin_inset Quotes eld
-\end_inset
-
+] Deletes an existing float.
+ This is particularly useful when you want to suppress a float that has
+ been defined in an input file.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-docbook
+NoStyle
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
- or
-\begin_inset Quotes eld
-\end_inset
-
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latex
+<style>
\end_layout
\end_inset
+] Deletes an existing style.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
- when the corresponding
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-OutputType
+OutlinerName
\end_layout
\end_inset
- parameter is encountered.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-OutputType
+<type>
\end_layout
\end_inset
- [
+] [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-lat
-\emph default
-ex
+<string>
\end_layout
\end_inset
-,
+] Define a new table of contents with type
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-docbook
+<type>
\end_layout
\end_inset
-,
+ and name
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-literate
+<string>
\end_layout
\end_inset
-] Specifies what sort of output documents using this class will produce.
+.
+ See also the AddToToc commands.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-PackageOptions
+OutputFormat
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<format>
+\end_layout
+
+\end_inset
+
+] The file format (as defined in the \SpecialChar LyX
+ preferences) produced by this document
+ class.
+ It is mainly useful when
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+OutputType
+\end_layout
+
+\end_inset
+
+ is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+literate
+\end_layout
+
+\end_inset
+
+ and one wants to define a new type of literate document.
+ The format is reset to
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+docbook
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ or
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latex
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ when the corresponding
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+OutputType
+\end_layout
+
+\end_inset
+
+ parameter is encountered.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+OutputType
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+lat
+\emph default
+ex
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+docbook
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+literate
+\end_layout
+
+\end_inset
+
+] Specifies what sort of output documents using this class will produce.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PackageOptions
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
] The default pagestyle.
Can be changed in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+ProvideStyle
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+] Creates a new paragraph style if it does not already exist.
+ If the style does exist, this section is ignored.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+End
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
Requires
\end_layout
] Whether the class-default should be printing on one or both sides of the
paper.
Can be changed in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain 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
.
So a command with two optional arguments has:
-\begin_inset Separator parbreak
-\end_inset
-
-
\end_layout
\begin_deeper
status collapsed
\begin_layout Plain Layout
-PassThruChars
+PassThru
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string of characters
+
+\emph on
+inherited
+\emph default
+, true, false
\end_layout
\end_inset
-]
-\family typewriter
-
-\family default
-Defines individual characters that should be output in raw form, meaning
+] Whether the contents of this argument should be output in raw form, meaning
without special translations that \SpecialChar LaTeX
would require.
- Note that, contrary to PassThru, this needs to be explicitly defined for
- arguments.
- That is, arguments do not inherit PassThruChars from their parent inset
- or layout.
-\end_layout
-
-\begin_layout Standard
-By default, the text entered in the \SpecialChar LyX
- workarea in the respective layout is
- the last (mandatory) argument of a command if the
+ By default, the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+PassThru
\end_layout
\end_inset
- is
+ status is inherited by the inset or paragraph layout the argument belongs
+ to, true and false change the status for the given argument only.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+PassThruChars
\end_layout
\end_inset
-.
- However, arguments with the prefix
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-post:
+string of characters
\end_layout
\end_inset
- are output after this workarea argument.
- Note that post-argument numbering restarts at 1, so the first argument
- following the workarea argument is
+]
+\family typewriter
+
+\family default
+Defines individual characters
+\begin_inset Newline linebreak
+\end_inset
+
+that should be output in raw form, meaning without special translations
+ that \SpecialChar LaTeX
+ would require.
+ Note that, contrary to PassThru, this needs to be explicitly defined for
+ arguments.
+ That is, arguments do not inherit PassThruChars from their parent inset
+ or layout.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-post:1
+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
+ the last (mandatory) argument of a command if the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LatexType
+\end_layout
+
+\end_inset
+
+ is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Command
+\end_layout
+
+\end_inset
+
+.
+ However, arguments with the prefix
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+post:
+\end_layout
+
+\end_inset
+
+ are output after this workarea argument.
+ Note that post-argument numbering restarts at 1, so the first argument
+ following the workarea argument is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+post:1
\end_layout
\end_inset
\end_inset
-)
+).
\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
- is a version number: If the style is read, and the version number is less
+ is a version number: if the style is read, and the version number is less
than the version number of the already existing style in the document class,
the new style is ignored.
If the version number is greater, the new style replaces the existing style.
\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
]
-\begin_inset Separator parbreak
-\end_inset
-
-
\end_layout
\begin_deeper
\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
\end_inset
-\begin_inset Separator parbreak
-\end_inset
-
-
\end_layout
\begin_deeper
\end_inset
can be defined in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
- but adds additionally the necessary mandatory argument (the longest label)
- to the begin statement of the bibliography environment:
+ but adds the necessary mandatory argument (the longest label) to the begin
+ statement of the bibliography environment:
\begin_inset Newline newline
\end_inset
\end_inset
+.
It is therefore only useful for bibliography environments.
The default longest label
\begin_inset Quotes eld
\end_inset
The kind of margin that the style has on the left side.
-\begin_inset Separator parbreak
-\end_inset
-
-
\end_layout
\begin_deeper
\end_inset
means that the left margin depends on the string entered in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
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
-Newline
+
+\change_inserted -712698321 1523696950
+NeedCProtect
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -712698321 1523696950
+
+\emph on
0
\end_layout
\begin_layout Plain Layout
-\emph on
+\change_inserted -712698321 1523696950
1
\end_layout
\end_inset
-] Whether newlines are translated into \SpecialChar LaTeX
- newlines (
+] This causes macros that contain this layout to be protected with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
+\change_inserted -712698321 1523696950
\backslash
-
+cprotect
\end_layout
\end_inset
-) or not.
- The translation can be switched off to allow more comfortable \SpecialChar LaTeX
- editing
- inside \SpecialChar LyX
-.
+ (cf.
+ package
+\family sans
+cprotect
+\family default
+) if necessary and thus allows (some) verbatim stuff in macros.
+\change_unchanged
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-NextNoIndent
+Newline
\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
-] If set to true, and if
+] Whether newlines are translated into \SpecialChar LaTeX
+ newlines (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DefaultStyle
+
+\backslash
+
+\backslash
+
\end_layout
\end_inset
- (usually
-\begin_inset Flex Code
-status collapsed
+) or not.
+ The translation can be switched off to allow more comfortable \SpecialChar LaTeX
+ editing
+ inside \SpecialChar LyX
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+NextNoIndent
+\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 set to true, and if
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+DefaultStyle
+\end_layout
+
+\end_inset
+
+ (usually
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
Standard
\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
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+ResumeCounter
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Resumes a counter that is usually reset at each new sequence of layouts.
+ This is currently only useful when
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelType
+\end_layout
+
+\end_inset
+
+ is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Enumerate
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
RightDelim
\end_layout
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+StepMasterCounter
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Steps the master counter of a given counter at the beginning of a new
+ sequence of layouts.
+ This is currently only useful when
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelType
+\end_layout
+
+\end_inset
+
+ is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Enumerate
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
TextFont
\end_layout
\begin_layout LyX-Code
Preamble
-\begin_inset Separator parbreak
-\end_inset
-
-
\end_layout
\begin_deeper
\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_layout Standard
It is necessary to define the floats (
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\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
\end_inset
-\begin_inset Separator parbreak
-\end_inset
-
-
\end_layout
\begin_deeper
status collapsed
\begin_layout Plain Layout
-LyXType
+LyxType
\end_layout
\end_inset
\end_inset
- to false.
+ to false and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ForcePlain
+\end_layout
+
+\end_inset
+
+ to true.
\begin_inset Flex Code
status collapsed
\end_inset
- can be set to true for
+ can be set to true, or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ForcePlain
+\end_layout
+
+\end_inset
+
+ to false, for
\begin_inset Flex Code
status collapsed
status collapsed
\begin_layout Plain Layout
-LyXType
+LyxType
\end_layout
\end_inset
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
-NoInsetLayout
+
+\change_inserted -712698321 1523633961
+NeedCProtect
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<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
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+NoInsetLayout
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<layout>
\end_layout
\end_inset
\begin_layout Standard
It is necessary to define the counters (
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
to the same value.
The following special constructs can be used in the string:
-\begin_inset Separator parbreak
-\end_inset
-
-
\end_layout
\begin_deeper
\emph default
LabelFont
\emph on
- or
+
+\family roman
+or
+\family default
\emph default
DefaultFont
\end_layout
\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+brown
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+darkgray
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+gray
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lightgray
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lime
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+orange
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+olive
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+pink
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+purple
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+teal
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+violet
+\end_layout
+
+\end_inset
+
]
\end_layout
\begin_layout Subsection
\begin_inset CommandInset label
LatexCommand label
-name "subsec:Citation-format-description"
+name "subsec:Citation-engine-description"
\end_inset
-Citation format description
+Cite engine description
\end_layout
\begin_layout Standard
status collapsed
\begin_layout Plain Layout
-CiteFormat
+CiteEngine
\end_layout
\end_inset
- blocks are used to describe how bibliographic information should be displayed,
- both within \SpecialChar LyX
- itself (in the citation dialog and in tooltips, for example)
- and in XHTML output.
- Such a block might look like this:
-\end_layout
+ blocks, as used mainly in cite engine files (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
-\begin_layout LyX-Code
-CiteFormat
-\end_layout
+\end_inset
-\begin_layout LyX-Code
- article ...
-\end_layout
+), define the citation commands provided by a specific
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
- book ...
-\end_layout
+cite engine
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-End
+.
+ A cite engine, in \SpecialChar LyX
+ terms, is way specific way to format citations, using
+ numbers, author names and/or years.
+ Currently, \SpecialChar LyX
+ supports three such engine types, namely:
\end_layout
-\begin_layout Standard
-The 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 `entry type' 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_layout Enumerate
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdciteformats.inc
+default
\end_layout
\end_inset
-, which is included in most of \SpecialChar LyX
-'s document classes.
+: 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 Standard
-The definitions use a simple language that allows Bib\SpecialChar TeX
- keys to be replaced
- with their values.
- Keys should be enclosed in
+\begin_layout Enumerate
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%
+authoryear
\end_layout
\end_inset
- signs, e.g.:
+: 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
-%author%
+numerical
\end_layout
\end_inset
-.
- So a simple definition might look like this:
-\end_layout
+: extended numerical citations that also allow for author or title next
+ to the number (e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout LyX-Code
-misc %author%,
+g.,
\begin_inset Quotes eld
\end_inset
-%title
+Smith and Miller [1]
\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 ~
+CiteEngine
+\end_layout
+
+\end_inset
+
+ blocks look like this:
+\end_layout
+
+\begin_layout LyX-Code
+CiteEngine default
+\end_layout
+
+\begin_layout LyX-Code
+ cite
+\end_layout
+
+\begin_layout LyX-Code
+ Citep*[][]
+\end_layout
+
+\begin_layout LyX-Code
+ citeyearpar[][]=parencite*
+\end_layout
+
+\begin_layout LyX-Code
+ ...
+\end_layout
+
+\begin_layout LyX-Code
+End
+\end_layout
+
+\begin_layout Standard
+The tag following
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteEngine
+\end_layout
+
+\end_inset
+
+ denotes the engine.
+ The individual lines respectively define a cite command or cite command
+ paradigm supported by this engine.
+ The line can be as simple as a cite command that is used both to name the
+ respective \SpecialChar LyX
+ command and the \SpecialChar LaTeX
+ output or more complex in order to differentiate
+ things.
+ The full syntax is:
+\end_layout
+
+\begin_layout LyX-Code
+LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXName
+\end_layout
+
+\end_inset
+
+: The name as used in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+*.lyx
+\end_layout
+
+\end_inset
+
+ file.
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+For portability reasons, we try to use the same name for same-formatted
+ commands in different cite packages (thus many names stem from natbib,
+ and thus we need to differentiate a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latexcmd
+\end_layout
+
+\end_inset
+
+ sometimes, if the \SpecialChar LaTeX
+ command names differ).
+\end_layout
+
+\end_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+alias
+\end_layout
+
+\end_inset
+
+: a (comma-separated) list of commands that fall back to the given
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXName
+\end_layout
+
+\end_inset
+
+ in the current engine.
+ This eases the switch of citation packages and engines.
+ The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+alias
+\end_layout
+
+\end_inset
+
+ can be compared to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ObsoletedBy
+\end_layout
+
+\end_inset
+
+ in layout definitions.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latexcmd
+\end_layout
+
+\end_inset
+
+: The actual \SpecialChar LaTeX
+ command that is output.
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Alias
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latexcmd
+\end_layout
+
+\end_inset
+
+ are optional.
+ If no
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latexcmd
+\end_layout
+
+\end_inset
+
+ is given, the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXName
+\end_layout
+
+\end_inset
+
+ will be output to \SpecialChar LaTeX
+.
+\end_layout
+
+\begin_layout Standard
+Note further:
+\end_layout
+
+\begin_layout Itemize
+Capitalization indicates that the command also has a capitalized form (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+Latexcmd
+\end_layout
+
+\end_inset
+
+ vs.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+latexcmd
+\end_layout
+
+\end_inset
+
+).
+ These usually enforce up-casing of name prefixes (
+\emph on
+von Goethe
+\emph default
+
+\begin_inset Formula $\Rightarrow$
+\end_inset
+
+
+\emph on
+Von Goethe
+\emph default
+).
+\end_layout
+
+\begin_layout Itemize
+Brackets
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+[]
+\end_layout
+
+\end_inset
+
+ indicate the number of optional arguments (there can be 0–2).
+\end_layout
+
+\begin_layout Itemize
+A star
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+*
+\end_layout
+
+\end_inset
+
+ indicates there is a starred version of the command (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+latexcmd*
+\end_layout
+
+\end_inset
+
+ vs.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+latexcmd
+\end_layout
+
+\end_inset
+
+).
+
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+By default, the starred version means: Output all authors even if it should
+ be shortened with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+ due to the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+ threshold.
+\end_layout
+
+\begin_layout Standard
+If the star has a different meaning for a given command, it can be specified
+ in angle brackets:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<!_stardesc!_stardesctooltip>
+\end_layout
+
+\end_inset
+
+.
+ Maximal two translatable macro keywords, marked by the prefix
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!_
+\end_layout
+
+\end_inset
+
+, can be given.
+ The first points to the string that replaces the
+\begin_inset Quotes eld
+\end_inset
+
+Full aut&hor list
+\begin_inset Quotes erd
+\end_inset
+
+ checkbox label in the citation dialog, the second one to an optional tool
+ tip for this checkbox.
+
+\end_layout
+
+\begin_layout Standard
+Note that these two macros have to be defined in a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\end_layout
+
+\end_inset
+
+ (see next section), dropping the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!
+\end_layout
+
+\end_inset
+
+ from the prefix, like this:
+\end_layout
+
+\begin_layout LyX-Code
+_stardesc Sta&rred command label
+\end_layout
+
+\begin_layout LyX-Code
+_stardesctooltip Tooltip for the starred command checkbox.
+\end_layout
+
+\end_deeper
+\begin_layout Itemize
+A dollar sign
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$
+\end_layout
+
+\end_inset
+
+ indicates that this command features
+\begin_inset Quotes eld
+\end_inset
+
+qualified citation lists
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This is a
+\family sans
+Biblatex
+\family default
+-specific feature for multi-reference citations where an individual pre-
+ and postnote can be given to each reference in the list.
+ Please refer to the
+\family sans
+Biblatex
+\family default
+ manual for details.
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Citation-format-description"
+
+\end_inset
+
+Cite format description
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\end_layout
+
+\end_inset
+
+ blocks are used to describe how bibliographic information should be displayed,
+ both within \SpecialChar LyX
+ itself (in the citation dialog and in tooltips, for example)
+ and in XHTML output.
+ Such a block might look like this:
+\end_layout
+
+\begin_layout LyX-Code
+CiteFormat
+\end_layout
+
+\begin_layout LyX-Code
+ article ...
+\end_layout
+
+\begin_layout LyX-Code
+ book ...
+\end_layout
+
+\begin_layout LyX-Code
+End
+\end_layout
+
+\begin_layout Standard
+or
+\end_layout
+
+\begin_layout LyX-Code
+CiteFormat
+\end_layout
+
+\begin_layout LyX-Code
+ cite ...
+\end_layout
+
+\begin_layout LyX-Code
+ citet*[][] ...
+\end_layout
+
+\begin_layout LyX-Code
+End
+\end_layout
+
+\begin_layout Standard
+In the first case, the individual lines define how the bibliographic information
+ associated with an article or book, respectively, is to be displayed, and
+ such a definition can be given for any
+\begin_inset Quotes els
+\end_inset
+
+entry type
+\begin_inset Quotes ers
+\end_inset
+
+ that might be present in a Bib\SpecialChar TeX
+ file.
+ \SpecialChar LyX
+ defines a default format in the source code that will be used if no specific
+ definition has been given.
+ \SpecialChar LyX
+ predefines several formats in the file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdciteformats.inc
+\end_layout
+
+\end_inset
+
+, which is included in most of \SpecialChar LyX
+'s document classes.
+\end_layout
+
+\begin_layout Standard
+In the second case, the lines define how a specific citation command (in
+ the example
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+cite
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+citet
+\end_layout
+
+\end_inset
+
+) is to be displayed on the citation inset label, in the citation dialog,
+ menu or XHTML output.
+ \SpecialChar LyX
+ defines such formats for the citation style variants it supports via
+\family sans
+Document\SpecialChar menuseparator
+Setting\SpecialChar menuseparator
+Bibliography\SpecialChar ldots
+
+\family default
+ in specific
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+*.citeengine
+\end_layout
+
+\end_inset
+
+ files that are shipped with \SpecialChar LyX
+ (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Standard
+The definitions use a simple language that allows Bib\SpecialChar TeX
+ keys to be replaced
+ with their values.
+ Keys should be enclosed in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%
+\end_layout
+
+\end_inset
+
+ signs, e.g.:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%author%
+\end_layout
+
+\end_inset
+
+.
+ So a simple definition might look like this:
+\end_layout
+
+\begin_layout LyX-Code
+misc %author%,
+\begin_inset Quotes eld
+\end_inset
+
+%title%
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+This would print the author, followed by a comma, followed by the title,
+ in quotes, followed by a period.
+\end_layout
+
+\begin_layout Standard
+Of course, sometimes you may want to print a key only if it exists.
+ This can be done by using a conditional construction, such as:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%volume%[[vol.
+\begin_inset space ~
\end_inset
%volume%]]}
\end_inset
.
- This says: If the
+ This says: If the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+volume
+\end_layout
+
+\end_inset
+
+ key exists, then print
+\begin_inset Quotes eld
+\end_inset
+
+vol.
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ followed by the volume key.
+ It is also possible to have an else clause in the conditional, such as:
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%author%[[%author%]][[%editor%, ed.]]}
+\end_layout
+
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+Here, the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+author
+\end_layout
+
+\end_inset
+
+ key is printed if it exists; otherwise, the editor key is printed, followed
+ by
+\begin_inset Quotes eld
+\end_inset
+
+,
+\begin_inset space ~
+\end_inset
+
+ed.
+\begin_inset Quotes erd
+\end_inset
+
+ Note that the key is again enclosed in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%
+\end_layout
+
+\end_inset
+
+ signs; the entire conditional is enclosed in braces; and the if and else
+ clauses are enclosed in double brackets,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+[[
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+]]
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ There must be no space between any of these.
+\end_layout
+
+\begin_layout Standard
+Next to the entry keys, there are some special keys that can be used for
+ these conditionals:
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%dialog%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ part for dialogs and menus, the
+\begin_inset Quotes eld
+\end_inset
+
+false
+\begin_inset Quotes erd
+\end_inset
+
+ part for other contexts (workarea, export)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%export%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ part for export and menus, the
+\begin_inset Quotes eld
+\end_inset
+
+false
+\begin_inset Quotes erd
+\end_inset
+
+ part for other contexts (workarea, dialog)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%next%[[true]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ part if another item follows (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., in a citation with multiple keys)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%second%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ if this is the second of multiple items, else the
+\begin_inset Quotes eld
+\end_inset
+
+false
+\begin_inset Quotes erd
+\end_inset
+
+ part
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifstar%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ part for starred citation commands (such as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+cite*
+\end_layout
+
+\end_inset
+
+), the false part for unstarred
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifentrytype:<type>%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ if the current entry type matches
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<type>
+\end_layout
+
+\end_inset
+
+, else the false part (e.g., in a citation definition:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifentrytype:book%[[this is a book]][[this is no book]]}
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifmultiple:<authortype>%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ if the current author type (author, editor etc.) has multiple authors, else
+ the false part (e.g., in a bibliography definition:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifmultiple:editor%[[eds.]][[ed.]]}
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifqualified%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ part if the current citation is a qualified citation list (a specific
+\family sans
+Biblatex
+\family default
+ format for multi-reference citations), the false part if this is not the
+ case.
+\end_layout
+
+\begin_layout Standard
+We said that
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%author%
+\end_layout
+
+\end_inset
+
+ prints the author key as it is recorded in the bibliography file.
+ This might not be what you want, since it will result in a string such
+ as
+\begin_inset Quotes eld
+\end_inset
+
+Miller, Peter and Smith, Mary and White, Jane
+\begin_inset Quotes erd
+\end_inset
+
+ (since
+\begin_inset Quotes eld
+\end_inset
+
+and
+\begin_inset Quotes erd
+\end_inset
+
+ is used by Bib\SpecialChar TeX
+ to delimit authors).
+ \SpecialChar LyX
+ therefore provides some methods to get properly formatted name lists (which
+ will also get translated).
+ The following keys are provided:
+\end_layout
+
+\begin_layout Enumerate
+For name lists with pre- and surname, suitable for the main authors/editors
+ of a bibliography item.
+ The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<nametype>
+\end_layout
+
+\end_inset
+
+ part denotes the kind of list that is requested (e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<nametype:author>
+\end_layout
+
+\end_inset
+
+):
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%abbrvnames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a name list which is abbreviated (with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) when
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+ is reached.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%fullnames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a full name list (never abbreviated with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%forceabbrvnames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a name list which is always abbreviated (with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) irrespective of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+Alternative name lists with pre- and surname, if the order of pre- and surname
+ inside the bibliography item differs (as in:
+\begin_inset Quotes eld
+\end_inset
+
+Miller, John: Some text, in: Mary Smith, ed.: A volume
+\begin_inset Quotes erd
+\end_inset
+
+):
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-volume
+%abbrvbynames:<nametype>%
\end_layout
\end_inset
- key exists, then print
+: Provides a name list which is abbreviated (with
\begin_inset Quotes eld
\end_inset
-vol.
-\begin_inset space ~
+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
- followed by the volume key.
- It is also possible to have an else clause in the conditional, such as:
-\begin_inset Newline newline
+).
+\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
-{%author%[[%author%]][[%editor%, ed.]]}
+%fullciteauthor%
\end_layout
\end_inset
-.
-\begin_inset Newline newline
+: Provides a full name list (never abbreviated with
+\begin_inset Quotes eld
\end_inset
-Here, the
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-author
+%forceabbrvciteauthor%
\end_layout
\end_inset
- key is printed if it exists; otherwise, the editor key is printed, followed
- by
+: Provides a name list which is always 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
+) irrespective of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%
+MaxCiteNames
\end_layout
\end_inset
- signs; the entire conditional is enclosed in braces; and the if and else
- clauses are enclosed in double brackets,
-\begin_inset Quotes eld
-\end_inset
+.
+\end_layout
+\end_deeper
+\begin_layout Standard
+The order of pre- and surname in the former two lists can be adjusted by
+ these macros:
+\end_layout
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[[
+!firstnameform %surname%, %prename%
\end_layout
\end_inset
+ (first author in lists of type 1)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!othernameform %surname%, %prename%
+\end_layout
-\begin_inset Quotes eld
\end_inset
- and
-\begin_inset Quotes eld
+ (other authors in lists of type 1)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!firstbynameform %prename% %surname%
+\end_layout
+
\end_inset
+ (first author in lists of type 2)
+\end_layout
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-]]
+!otherbynameform %prename% %surname%
+\end_layout
+
+\end_inset
+
+ (other authors in lists of type 2)
\end_layout
+\begin_layout Standard
+This allows you to configure namings like
+\begin_inset Quotes eld
\end_inset
+Miller, Peter and Mary Smith: \SpecialChar ldots
+, in: John Doe and Pat Green, eds.:\SpecialChar ldots
\begin_inset Quotes erd
\end_inset
.
- There must be no space between any of these.
\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 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
+B_
+\end_layout
+
+\end_inset
+
+, such as in the example above, will be translated to the currently active
+ buffer language (so the translation will match the generated document).
+ All definitions starting with underscore only will be translated to the
+ GUI language.
+ This is the proper translation for strings that only occur in the dialogs
+ or on buttons, such as this one:
+\end_layout
+
+\begin_layout LyX-Code
+_addtobib Add to bibliography only.
+\end_layout
+
+\begin_layout Standard
+Several of these translatable strings are predefined in
\begin_inset Flex Code
status collapsed
\end_inset
-.
+ and the diverse
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+*.citeengine
+\end_layout
+
+\end_inset
+
+ files.
Note that these are not macros, in the sense just defined.
They will not be expanded.
\end_layout
\begin_layout Standard
-So here then is an example that 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
comes with predefined templates for Xfig figures, various
raster format images, chess diagrams, and LilyPond music notation.
You can check the actual list by using the menu
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\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 LyX-Code
-Format \SpecialChar LaTeX
-
+Format LaTeX
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout LyX-Code
-Format PDF\SpecialChar LaTeX
-
+Format PDFLaTeX
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout LyX-Code
-Product "$$Contents(
-\backslash
-"$$AbsPath$$Basename.asc
-\backslash
-")"
-\end_layout
-
-\begin_layout LyX-Code
-UpdateFormat asciixfig
-\end_layout
-
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.asc"
+Product "[XFig: $$FName]"
\end_layout
\begin_layout LyX-Code
FormatEnd
\end_layout
-\begin_layout LyX-Code
-Product "[XFig: $$FName]"
-\end_layout
-
-\begin_layout LyX-Code
-FormatEnd
-\end_layout
-
\begin_layout LyX-Code
TemplateEnd
\end_layout
\begin_inset space ~
\end_inset
-LaTeX|PDFLaTeX|PlainText|DocBook
+LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
\end_layout
\end_inset
The file format of the converted file.
This must be the name of a format that is known to \SpecialChar LyX
(see the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\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
-buttonbg Color used for bottom background
+buttonbg Color used for button background
\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