#LyX 2.4 created this file. For more info see https://www.lyx.org/
-\lyxformat 598
+\lyxformat 608
\begin_document
\begin_header
\save_transient_properties true
\branch OutDated
\selected 0
\filename_suffix 0
-\color #f5fae7
+\color #f5fae7 #0a0518
\end_branch
\index Index
\shortcut idx
\html_css_as_file 0
\html_be_strict true
\docbook_table_output 0
+\docbook_mathml_prefix 1
\author -970929547 "Thibaut Cuvelier"
\author -712698321 "Jürgen Spitzmüller"
+\author -584632292 "Richard Kimberly Heck"
\author -495245474 "Jean-Marc Lasgouttes"
\author 5863208 "ab"
+\author 34634807 "Jean-Pierre"
+\author 232239728 "Owner"
\author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
\author 1075283030 "Thibaut"
\end_header
status collapsed
\begin_layout Plain Layout
-\noindent
If you have comments or error corrections, please send them to the \SpecialChar LyX
Documentatio
n mailing list,
\end_inset
in the subject header, and please cc the current maintainer of this file,
- Richard Heck <rgheck@comcast.net>.
+ Richard
+\change_inserted 5863208 1604930692
+Kimberly
+\change_unchanged
+Heck <
+\change_inserted 5863208 1604930729
+rikiheck@lyx.org
+\change_deleted 5863208 1604930668
+rikiheck@lyx.org
+\change_unchanged
+>.
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
-Version 2.3.x
+Version 2.4.x
\end_layout
\begin_layout Standard
\end_inset
- and its sub-directories contain a number of files and that can be used
- to customize \SpecialChar LyX
+ and its sub-directories contain a number of files
+\change_deleted 232239728 1604787780
+and
+\change_unchanged
+ that can be used to customize \SpecialChar LyX
's behavior.
You can change many of these files from within \SpecialChar LyX
itself through the
\end_layout
\begin_layout Standard
-The files, which are to be found in
+The files found in
\begin_inset Flex Noun
status collapsed
\end_inset
-, are generated when you configure \SpecialChar LyX
+ are generated when you configure \SpecialChar LyX
.
- They contain various default values that are guessed by inspection.
+ They contain various default values that are
+\change_inserted 5863208 1604919565
+automatically detected during reconfiguration.
+\change_deleted 232239728 1604788241
+guessed by inspection
+\change_unchanged
In general, it is not a good idea to modify them, since they might be overwritt
en at any time.
\end_layout
\end_inset
- contains defaults for various commands.
+
+\change_deleted 5863208 1604919950
+
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 232239728 1604853928
+I capitalized the first word in all of these lists.
+ To me it looks better but it really is a stylistic thing, your call.
+ However if you are not going to capitalize them, the english in some needs
+ to be modified to make it read correctly as a sentence.
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\change_deleted 232239728 1604853510
+c
+\change_inserted 232239728 1604853510
+C
+\change_unchanged
+ontains defaults for various commands.
\end_layout
\begin_layout Labeling
\end_inset
- contains the list of packages that have been recognized by \SpecialChar LyX
+
+\change_deleted 232239728 1604853512
+c
+\change_inserted 232239728 1604853512
+C
+\change_unchanged
+ontains the list of packages that have been recognized by \SpecialChar LyX
.
It is currently unused by the \SpecialChar LyX
program itself, but the information extracted,
\end_inset
- the list of text classes that have been found in your
+
+\change_deleted 232239728 1604853515
+t
+\change_inserted 232239728 1604853515
+T
+\change_unchanged
+he list of text classes that have been found in your
\begin_inset Flex Code
status collapsed
\end_inset
- the list of layout modules found in your
+
+\change_deleted 232239728 1604853518
+t
+\change_inserted 232239728 1604853518
+T
+\change_unchanged
+he list of layout modules found in your
\begin_inset Flex Code
status collapsed
\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex Code
-status collapsed
+status open
\begin_layout Plain Layout
*files.lst
\end_inset
- lists of various sorts of \SpecialChar LaTeX
+
+\change_deleted 232239728 1604853523
+l
+\change_inserted 232239728 1604853523
+L
+\change_unchanged
+ists of various sorts of \SpecialChar LaTeX
-related files found on your system
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex Code
-status collapsed
+status open
\begin_layout Plain Layout
doc/\SpecialChar LaTeX
\end_layout
\begin_layout Standard
-These directories are duplicated between
+The
+\change_deleted 5863208 1604928729
+se
+\change_unchanged
+
+\change_inserted 5863208 1604928636
+following
+\change_unchanged
+directories
+\change_inserted 5863208 1604928661
+in
+\change_unchanged
+
\begin_inset Flex Code
status collapsed
\end_inset
- and
+
+\change_inserted 5863208 1604928662
+ can be
+\change_deleted 5863208 1604928642
+are
+\change_unchanged
+ duplicated
+\change_deleted 5863208 1604928669
+between
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXDir
+\end_layout
+
+\end_inset
+
+ and
+\change_inserted 5863208 1604928680
+in
+\change_unchanged
+
\begin_inset Flex Code
status collapsed
\end_inset
.
- If a particular files exists in both places, the one in
+ If a particular file
+\change_deleted 232239728 1604794430
+s
+\change_unchanged
+ exists in both places, the one in
\begin_inset Flex Code
status collapsed
\end_inset
- this directory contains files with the extension
+
+\change_deleted 232239728 1604794460
+t
+\change_inserted 232239728 1604794460
+T
+\change_unchanged
+his directory contains files with the extension
\begin_inset Flex Code
status collapsed
\end_inset
- contains files with the extension
+
+\change_deleted 232239728 1604794478
+c
+\change_inserted 232239728 1604794478
+C
+\change_unchanged
+ontains files with the extension
\begin_inset Flex Code
status collapsed
\end_inset
- contains graphics files that can be included in documents.
+
+\change_deleted 232239728 1604794483
+c
+\change_inserted 232239728 1604794486
+C
+\change_unchanged
+ontains graphics files that can be included in documents.
\end_layout
\end_inset
- contains \SpecialChar LyX
+
+\change_deleted 232239728 1604794492
+c
+\change_inserted 232239728 1604794492
+C
+\change_unchanged
+ontains \SpecialChar LyX
documentation files (including the one you are currently reading).
The file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+
+\change_deleted 232239728 1604794660
\SpecialChar LaTeX
+
+\change_inserted 232239728 1604794661
+LaTex
+\change_unchanged
Config.lyx
\end_layout
\end_inset
- contains example files that explain how to use some features.
+
+\change_deleted 232239728 1604794497
+c
+\change_inserted 232239728 1604794497
+C
+\change_unchanged
+ontains example files that explain how to use some features.
In the file browser, press the
\begin_inset Flex Noun
status collapsed
\end_inset
- contains image files that are used by the
+
+\change_deleted 232239728 1604794500
+c
+\change_inserted 232239728 1604794500
+C
+\change_unchanged
+ontains image files that are used by the
\begin_inset Flex Noun
status collapsed
\end_inset
- contains keyboard keymapping files.
+
+\change_deleted 232239728 1604794505
+c
+\change_inserted 232239728 1604794505
+C
+\change_unchanged
+ontains keyboard keymapping files.
See
\begin_inset CommandInset ref
LatexCommand ref
\end_inset
- contains the text class and module files described in
+
+\change_deleted 232239728 1604794508
+c
+\change_inserted 232239728 1604794508
+C
+\change_unchanged
+ontains the text class and module files described in
\begin_inset CommandInset ref
LatexCommand ref
reference "cha:Installing-New-Document"
\end_inset
- contains the
+
+\change_deleted 232239728 1604794513
+c
+\change_inserted 232239728 1604794513
+C
+\change_unchanged
+ontains the
\begin_inset Flex Code
status collapsed
Python scripts used to convert between \SpecialChar LyX
versions.
- These can be run from the command line if, say, you want to batch-convert
- files.
+ These can be run from the command line if
+\change_deleted 232239728 1604794749
+, say,
+\change_unchanged
+ you want to batch-convert files.
\end_layout
\begin_layout Labeling
\end_inset
- contains some files that demonstrate the capabilities of the
+
+\change_deleted 232239728 1604794516
+c
+\change_inserted 232239728 1604794516
+C
+\change_unchanged
+ontains some files that demonstrate the capabilities of the
\begin_inset Flex Noun
status collapsed
\end_inset
- contains the standard \SpecialChar LyX
+
+\change_deleted 232239728 1604794520
+c
+\change_inserted 232239728 1604794520
+C
+\change_unchanged
+ontains the standard \SpecialChar LyX
template files described in
\begin_inset CommandInset ref
LatexCommand ref
\end_inset
- contains files with the extension
+
+\change_deleted 232239728 1604794524
+c
+\change_inserted 232239728 1604794524
+C
+\change_unchanged
+ontains files with the extension
\begin_inset Flex Code
status collapsed
\end_inset
- contains files with the extension
+
+\change_deleted 232239728 1604794528
+c
+\change_inserted 232239728 1604794528
+C
+\change_unchanged
+ontains files with the extension
\begin_inset Flex Code
status collapsed
\end_inset
- this file contains the list of \SpecialChar LyX
+
+\change_deleted 232239728 1604797616
+t
+\change_inserted 232239728 1604797616
+T
+\change_unchanged
+his file contains the list of \SpecialChar LyX
developers.
The contents are displayed with the menu entry
\begin_inset Flex Noun
\end_inset
- this is a \SpecialChar LaTeX
+
+\change_deleted 232239728 1604797620
+t
+\change_inserted 232239728 1604797620
+T
+\change_unchanged
+his is a \SpecialChar LaTeX
script used during the configuration process.
Do not run directly.
\end_layout
\end_inset
- this is a Python script that is used to re-configure \SpecialChar LyX
+
+\change_deleted 232239728 1604797624
+t
+\change_inserted 232239728 1604797624
+T
+\change_unchanged
+his is a Python script that is used to re-configure \SpecialChar LyX
.
It creates configuration files in the directory it was run from.
\end_layout
\end_inset
- this contains tables describing how different character encodings can be
+
+\change_deleted 232239728 1604797580
+t
+\change_inserted 232239728 1604797580
+T
+\change_unchanged
+his contains tables describing how different character encodings can be
mapped to Unicode
\end_layout
\end_inset
- this file contains a list of all the languages currently supported by \SpecialChar LyX
+
+\change_deleted 232239728 1604797584
+t
+\change_inserted 232239728 1604797584
+T
+\change_unchanged
+his file contains a list of all the languages currently supported by \SpecialChar LyX
.
\end_layout
\end_inset
- contains information about the supported fonts.
+
+\change_deleted 232239728 1604797587
+c
+\change_inserted 232239728 1604797587
+C
+\change_unchanged
+ontains information about the supported fonts.
\end_layout
\begin_layout Labeling
\end_inset
- this file contains translations for internationalized paragraph styles
- (see
+
+\change_deleted 232239728 1604797591
+t
+\change_inserted 232239728 1604797591
+T
+\change_unchanged
+his file contains translations for internationalized paragraph styles (see
+
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:I18n"
\end_inset
- this file contains information about Unicode-encoded glyphs and the way
- they are supported by \SpecialChar LyX
+
+\change_deleted 232239728 1604797594
+t
+\change_inserted 232239728 1604797594
+T
+\change_unchanged
+his file contains information about Unicode-encoded glyphs and the way they
+ are supported by \SpecialChar LyX
via \SpecialChar LaTeX
.
\end_layout
\end_layout
\begin_layout Itemize
-If you get some updated documentation from \SpecialChar LyX
- ftp site and cannot install
- it because you do not have sysadmin rights on your system, you can just
- copy the files in
+If you get some updated documentation from
+\change_inserted 232239728 1604798171
+ a
+\change_unchanged
+ \SpecialChar LyX
+ ftp site and cannot install it because you do not have sysadmin rights
+ on your system, you can just copy the files
+\change_deleted 232239728 1604798193
+in
+\change_inserted 232239728 1604798193
+to
+\change_unchanged
+
\begin_inset Flex Code
status collapsed
\begin_layout Standard
The configuration freedom of the local configuration directory may not suffice
if you want to have more than one configuration at your disposal.
- For example, you may want to be use different key bindings or printer settings
- at different times.
+ For example, you may want to
+\change_deleted 232239728 1604798238
+be
+\change_unchanged
+use different key bindings or printer settings at different times.
You can achieve this by having several such directories.
You then specify which directory to use at run-time.
\end_layout
switch.) If the specified directory does not exist, \SpecialChar LyX
offers to create it
- for you, just like it does for the default directory on the first time
- you run the program.
+ for you, just like it does for the default directory
+\change_deleted 232239728 1604798318
+on
+\change_unchanged
+ the first time you run the program.
You can modify the configuration options in this additional user directory
exactly as you would for the default directory.
These directories are completely independent (but read on).
status collapsed
\begin_layout Plain Layout
-LYX_USERDIR_VER
+LYX_USERDIR_24x
\end_layout
\end_inset
\end_inset
-) which is configuration-specific.
+) which is configuration
+\change_deleted 232239728 1604798083
+-
+\change_inserted 232239728 1604798100
+
+\change_unchanged
+specific.
\end_layout
\begin_layout Chapter
\end_layout
\begin_layout Chapter
+
+\change_inserted -584632292 1610232084
+Creating and
+\change_unchanged
Installing New Document Classes, Layouts, and Templates
\begin_inset CommandInset label
LatexCommand label
\end_inset
, which contains most of the basic layouts.
+\change_inserted -712698321 1611646803
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1611646804
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646837
+InputGlobal
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646804
+<filename>
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] is a variant of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646804
+Input
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ command which does not look for files in the user directory.
+ This allows to create a file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646804
+name.layout
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646804
+name.inc
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ in the user directory which includes a global file with the same name via
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646853
+InputGlobal name
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646855
+InputGlobal name.inc
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, respectively (with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1611646804
+Input
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, the file would recursively include itself).
+ This way, you can modify global files without having to completely copy
+ them.
+\change_unchanged
+
\end_layout
\begin_layout Description
).
\end_layout
+\begin_layout Description
+
+\change_inserted -712698321 1612018485
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1612018457
+ModifyInsetLayout
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1612018466
+<type>
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] Modifies the layout of an inset.
+ If the layout does not exist, this section is ignored.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1612018452
+End
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
\begin_layout Description
\begin_inset Flex Code
status collapsed
\end_inset
.
+\change_inserted -712698321 1612018500
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1612018547
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1612018506
+ProvideInsetLayout
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1612018509
+<type>
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] Defines the layout of an inset if it does not already exist.
+ If the layout does exist, this section is ignored.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1612018500
+End
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\change_unchanged
+
\end_layout
\begin_layout Description
\end_inset
-, but with the header column offset with a second horizontal line.
+, but with the header
+\change_deleted 34634807 1619712593
+column
+\change_inserted 34634807 1619712594
+row
+\change_inserted -712698321 1553618309
+ offset with a second horizontal line.
This is also the default style of \SpecialChar LyX
.
\end_layout
] Defines argument number <int> of a command\SpecialChar breakableslash
environment associated with
the current style.
- This is useful for things like section headings, and only makes sense with
+
+\change_inserted -584632292 1615846868
+ The definition must end with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846867
+EndArgument
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+
+\change_unchanged
+
+\change_inserted -584632292 1615846880
+See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Arguments"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ for more information.
+
+\change_deleted -584632292 1615846694
+This is useful for things like section headings, and only makes sense with
\SpecialChar LaTeX
.
Every (optional or required) argument of a command or environment – except
\begin_deeper
\begin_layout Quote
+\change_deleted -584632292 1615846694
+
\family typewriter
Argument 1
\end_layout
\begin_layout Quote
+\change_deleted -584632292 1615846694
+
\family typewriter
...
\end_layout
\begin_layout Quote
+\change_deleted -584632292 1615846694
+
\family typewriter
EndArgument
\end_layout
\begin_layout Quote
+\change_deleted -584632292 1615846694
+
\family typewriter
Argument 2
\end_layout
\begin_layout Quote
+\change_deleted -584632292 1615846694
+
\family typewriter
...
\end_layout
\begin_layout Quote
+\change_deleted -584632292 1615846694
+
\family typewriter
EndArgument
\end_layout
\begin_layout Standard
+
+\change_deleted -584632292 1615846694
Inside the
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_inset
-\change_inserted -712698321 1555579782
-
\end_layout
\begin_layout Itemize
-\change_inserted -712698321 1555579780
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
) to be used for line breaks.
The initial backslash must not be specified.
-\change_unchanged
-
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_inset
.
-\change_inserted -712698321 1559484228
-
\end_layout
\begin_layout Itemize
-\change_inserted -712698321 1559484228
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_inset
.
-\change_unchanged
-
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\change_deleted -712698321 1559484200
Currently, only one argument per style\SpecialChar breakableslash
layout can be automatically inserted.
-\change_unchanged
+\change_deleted -584632292 1615846694
\end_layout
\begin_layout Itemize
-\change_inserted -712698321 1559491402
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
+
+\change_deleted -584632292 1615846694
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
+
+\change_deleted -584632292 1615846694
By default, the text entered in the \SpecialChar LyX
workarea in the respective layout is
the last (mandatory) argument of a command if the
\end_layout
\begin_layout Standard
+
+\change_deleted -584632292 1615846694
Arguments for list
\begin_inset Flex Code
status collapsed
\end_inset
).
-\change_inserted -712698321 1534487781
-
\end_layout
\begin_layout Standard
-\change_inserted -712698321 1534488561
+\change_deleted -584632292 1615846694
Finally, there is a special argument type with the prefix
\begin_inset Flex Code
status collapsed
Note that
\change_unchanged
\SpecialChar LyX
- will create protected blanks for the additional blanks when in
+ will create protected blanks for the additional blanks when
+\change_deleted 34634807 1619626461
+ in
+\change_unchanged
+
\change_inserted -495245474 1550490096
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-StepMasterCounter
+Step
+\change_deleted 731793113 1604355211
+Master
+\change_inserted 731793113 1604355212
+Parent
+\change_unchanged
+Counter
\end_layout
\end_inset
\end_inset
-] Steps the master counter of a given counter at the beginning of a new
- sequence of layouts.
+] Steps the
+\change_deleted 731793113 1604355214
+master
+\change_inserted 731793113 1604355216
+parent
+\change_unchanged
+ counter of a given counter at the beginning of a new sequence of layouts.
This is currently only useful when
\begin_inset Flex Code
status collapsed
\end_inset
- may be be any valid identifier not used by a pre-existing Flex inset.
+ may be any valid identifier not used by a pre-existing Flex inset.
The identifier may include spaces, but in that case the whole thing must
be wrapped in quotes.
Note that the definition of a flex inset
\end_inset
- may be be any valid identifier of branch defined in user's document.
+ may be any valid identifier of branch defined in user's document.
The identifier may include spaces, but in that case the whole thing must
be wrapped in quotes.
The main purpose of this feature is to allow \SpecialChar LaTeX
.
See
+\change_inserted -584632292 1615846847
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Arguments"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+
+\change_deleted -584632292 1615846847
+
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Paragraph-Styles"
\end_inset
- for details.
+
+\change_unchanged
+ for
+\change_deleted -584632292 1615846902
+details
+\change_inserted -584632292 1615846906
+more information
+\change_unchanged
+.
\end_layout
\begin_layout Description
\end_inset
-] Force a a line break in the \SpecialChar LaTeX
- output before the inset starts and after
- the inset ends.
+] Force a line break in the \SpecialChar LaTeX
+ output before the inset starts and after the
+ inset ends.
This assures the inset itself is output on its own lines, for parsing purposes.
\end_layout
\end_inset
,
+\change_deleted -584632292 1615846609
+
\begin_inset Flex Code
status collapsed
\end_inset
- or
+
+\change_unchanged
+or
\begin_inset Flex Code
status collapsed
\backslash
myinset{content}\SpecialChar ldots
}
+\change_unchanged
+
\end_layout
\end_inset
\backslash
emph{content}}\SpecialChar ldots
}
+\change_unchanged
+
\end_layout
\end_inset
\backslash
emph
+\change_unchanged
+
\end_layout
\end_inset
\change_inserted -712698321 1597733292
0
+\change_unchanged
+
\end_layout
\end_inset
] Allow spell-checking the contents of this inset.
Default is true.
+\change_inserted -584632292 1615846659
+
\end_layout
\begin_layout Subsection
-Counters
+
+\change_inserted -584632292 1615846729
+Arguments
\begin_inset CommandInset label
LatexCommand label
-name "subsec:Counters"
+name "subsec:Arguments"
\end_inset
\end_layout
\begin_layout Standard
-It is necessary to define the counters (
-\begin_inset Flex Noun
+
+\change_inserted -584632292 1615846807
+Both paragraph styles and inset layouts allow for
+\emph on
+arguments
+\emph default
+ as well as the main content.
+ This is especially useful for things like section headings and only makes
+ sense with \SpecialChar LaTeX
+.
+ Each (optional or required) argument of a command or environment—except
+ for the required argument that is associated with the content—has a separate
+ definition, where the number specifies the order of the arguments.
+ The definition must end with
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-chapter
+
+\change_inserted -584632292 1615846730
+EndArgument
+\change_unchanged
+
\end_layout
\end_inset
-,
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-figure
+.
+ So a command with two optional arguments looks like:
\end_layout
-\end_inset
+\begin_layout Quote
-, \SpecialChar ldots
-) in the text class itself.
- The standard counters are defined in the file
-\begin_inset Flex Code
-status collapsed
+\change_inserted -584632292 1615846730
-\begin_layout Plain Layout
-stdcounters.inc
+\family typewriter
+Argument 1
\end_layout
-\end_inset
+\begin_layout Quote
-, so you may have to do no more than add
-\end_layout
+\change_inserted -584632292 1615846730
-\begin_layout LyX-Code
-Input stdcounters.inc
+\family typewriter
+...
\end_layout
-\begin_layout Standard
-to your layout file to get them to work.
- But if you want to define custom counters, then you can do so.
- The counter declaration must begin with:
+\begin_layout Quote
+
+\change_inserted -584632292 1615846730
+
+\family typewriter
+EndArgument
\end_layout
-\begin_layout LyX-Code
-Counter CounterName
+\begin_layout Quote
+
+\change_inserted -584632292 1615846730
+
+\family typewriter
+Argument 2
\end_layout
-\begin_layout Standard
-where of course `
-\begin_inset Flex Code
-status collapsed
+\begin_layout Quote
-\begin_layout Plain Layout
-CounterName
+\change_inserted -584632292 1615846730
+
+\family typewriter
+...
\end_layout
-\end_inset
+\begin_layout Quote
-' is replaced by the name of the counter.
- And it must end with
-\begin_inset Quotes eld
-\end_inset
+\change_inserted -584632292 1615846730
+
+\family typewriter
+EndArgument
+\end_layout
+\begin_layout Standard
+\change_inserted -584632292 1615846730
+Inside the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
-\end_layout
-\end_inset
+\change_inserted -584632292 1615846730
+Argument
+\change_unchanged
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
- The following parameters can also be used:
+ definition, the following specifications are possible:
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InitialValue
+
+\change_inserted -584632292 1615846730
+LabelString
+\change_unchanged
+
\end_layout
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-int=1
-\end_layout
-\end_inset
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
-] Sets the initial value for the counter, to which it will be reset whenever
- that happens.
- Normally, one will want the default, 1.
\end_layout
-\begin_layout Description
+\end_inset
+
+ The string that will appear both in the menu (to insert this argument)
+ and on the argument inset button (unless you also specify a separate
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+
+\change_inserted -584632292 1615846730
+MenuString
+\change_unchanged
+
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
+).
+ For the menu, you can define an accelerator by appending the respective
+ character to the string, divided by
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-string
-\end_layout
+|
+\begin_inset Quotes erd
+\end_inset
+ (e.
+\begin_inset space \thinspace{}
\end_inset
-=
-\begin_inset Quotes erd
+g.
+\begin_inset space \space{}
\end_inset
-\begin_inset Quotes erd
+\begin_inset Quotes eld
\end_inset
-] When defined, this string defines how the counter is displayed.
- Setting this value sets
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+
+\change_inserted -584632292 1615846730
+Short Title|S
+\change_unchanged
+
\end_layout
\end_inset
- to the same value.
- The following special constructs can be used in the string:
+
+\begin_inset Quotes erd
+\end_inset
+
+).
\end_layout
-\begin_deeper
\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-thecounter
+\change_inserted -584632292 1615846730
+MenuString
+\change_unchanged
+
\end_layout
\end_inset
- will be replaced by the expansion of the
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
-\end_layout
-
-\end_inset
- (or
-\begin_inset Flex Code
-status collapsed
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
-\begin_layout Plain Layout
-LabelStringAppendix
\end_layout
\end_inset
-) of the counter
-\begin_inset Flex Code
-status collapsed
+ A separate string for the menu.
+ You can define an accelerator by appending the respective character to
+ the string, divided by
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-counter
-\end_layout
+|
+\begin_inset Quotes erd
+\end_inset
+ (e.
+\begin_inset space \thinspace{}
\end_inset
-.
-
-\end_layout
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Itemize
-counter values can be expressed using \SpecialChar LaTeX
--like macros
-\begin_inset Newline newline
+
+\begin_inset Quotes eld
\end_inset
\begin_layout Plain Layout
-\backslash
+\change_inserted -584632292 1615846730
+Short Title|S
+\change_unchanged
-\emph on
-numbertype
-\emph default
-{
-\emph on
-counter
-\emph default
-}
\end_layout
\end_inset
-, where
+
+\begin_inset Quotes erd
+\end_inset
+
+).
+ This specification is optional.
+ If it is not given the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-numbertype
+\change_inserted -584632292 1615846730
+LabelString
+\change_unchanged
+
\end_layout
\end_inset
- can be:
-\begin_inset Foot
+ will be used instead for the menu.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Actually, the situation is a bit more complicated: any
-\family default
-\series default
-\shape default
-\emph default
-\bar default
-
-\size default
-\emph on
-\noun default
-\color inherit
-numbertype
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
- other than those described below will produce arabic numerals.
- It would not be surprising to see this change in the future.
+\change_inserted -584632292 1615846730
+Tooltip
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-arabic
+
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
+
\end_layout
\end_inset
-: 1, 2, 3,\SpecialChar ldots
-;
+ A longer explanatory text that appears in the tooltip when hovering over
+ the argument inset.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-alph
+
+\change_inserted -584632292 1615846730
+Mandatory
+\change_unchanged
+
\end_layout
\end_inset
- for lower-case letters: a, b, c, \SpecialChar ldots
-;
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Alph
+
+\change_inserted -584632292 1615846730
+
+\emph on
+0
+\change_unchanged
+
\end_layout
\end_inset
- for upper-case letters: A, B, C, \SpecialChar ldots
-;
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-roman
+
+\change_inserted -584632292 1615846730
+1
+\change_unchanged
+
\end_layout
\end_inset
- for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
-;
+] Declare if this is a mandatory (1) or an optional (0) argument.
+ Mandatory arguments will be output empty if not given, while optional arguments
+ will not be output at all.
+ By default, mandatory arguments are delimited by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Roman
+
+\change_inserted -584632292 1615846730
+{...}
+\change_unchanged
+
\end_layout
\end_inset
- for upper-case roman numerals: I, II, III\SpecialChar ldots
-;
+, while optional arguments are delimited by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-hebrew
+
+\change_inserted -584632292 1615846730
+[...]
+\change_unchanged
+
\end_layout
\end_inset
- for hebrew numerals.
+
\end_layout
-\end_deeper
-\begin_layout Standard
-If LabelString is not defined, a default value is constructed as follows:
- if the counter has a master counter
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-master
+
+\change_inserted -584632292 1615846730
+NewlineCmd
+\change_unchanged
+
\end_layout
\end_inset
- (defined via
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Within
-\end_layout
-\end_inset
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
-), the string
-\begin_inset Newline newline
-\end_inset
+\end_layout
+\end_inset
+ Option to define a different command (from the default
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+\change_inserted -584632292 1615846730
+
\backslash
-themaster.
+
\backslash
-arabic{counter}
-\end_layout
+
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+) to be used for line breaks.
+ The initial backslash must not be specified.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+Requires
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+[int=0]
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ defines another argument (by its number) which this argument requires to
+ be output if it is itself output.
+ E.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., in \SpecialChar LaTeX
+ commands, optional arguments often require previous optional arguments
+ to be output (at least empty), as in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+
+\backslash
+command[][argument]{text}
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+ This can be achieved by the statement
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+Requires 1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ within
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+Argument 2
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+LeftDelim
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ defines a custom left delimiter (instead of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+{
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+[
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+).
+ A line break in the output can be indicated by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+<br/>
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+RightDelim
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ defines a custom right delimiter (instead of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+}
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+]
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+).
+ A line break in the output can be indicated by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+<br/>
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+DefaultArg
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ defines an argument that is inserted if and only if no user-specified arguments
+ were given, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e.
+\begin_inset space \space{}
+\end_inset
+
+if no argument inset has been inserted (note that also an empty argument
+ inset omits the DefaultArg).
+ Multiple arguments need to be separated by comma.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+PresetArg
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+[string]
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ defines an argument that is inserted in any case (alone or in addition
+ to user-specified arguments).
+ Multiple arguments need to be separated by comma.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+Font
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ The font used for the argument content, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+FreeSpacing
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+
+\emph on
+0
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+LabelFont
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ The font used for the label; see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+Decoration
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+
+\emph on
+Classic
+\emph default
+, Minimalistic, Conglomerate
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] describes the rendering style used for the inset's frame and buttons.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+AutoInsert
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+[int=0]
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ If this is set to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, this argument is automatically inserted when the respective style is selected.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+InsertOnNewline
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+[int=0]
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ If this is set to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, this argument will be inserted on a new line with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+AutoInsert
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ (only available within Flex insets).
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+InsertCotext
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+[int=0]
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ If this is set to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, this argument will be inserted with a copy of the co-text (either selected
+ text or the whole paragraph) as content.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+PassThru
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+
+\emph on
+inherited
+\emph default
+, true, false
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] Whether the contents of this argument should be output in raw form, meaning
+ without special translations that \SpecialChar LaTeX
+ would require.
+ By default, the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+PassThru
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ status is inherited by the inset or paragraph layout the argument belongs
+ to, true and false change the status for the given argument only.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+PassThruChars
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+string of characters
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+]
+\family typewriter
+
+\family default
+Defines individual characters
+\begin_inset Newline linebreak
+\end_inset
+
+that should be output in raw form, meaning without special translations
+ that \SpecialChar LaTeX
+ would require.
+ Note that, contrary to PassThru, this needs to be explicitly defined for
+ arguments.
+ That is, arguments do not inherit PassThruChars from their parent inset
+ or layout.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -584632292 1615846730
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+IsTocCaption
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+
+\emph on
+0
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] If this is set to 1, the argument will output its content in the corresponding
+ item in the table of contents.
+ See AddToToc.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -584632292 1615846730
+By default, the text entered in the \SpecialChar LyX
+ workarea in the respective layout is
+ the last (mandatory) argument of a command if the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+LatexType
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+Command
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+ However, arguments with the prefix
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+post:
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ are output after this workarea argument.
+ Note that post-argument numbering restarts at 1, so the first argument
+ following the workarea argument is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+post:1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+ Post-arguments are ignored in any other
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+LatexType
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ than
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+Command
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -584632292 1615846730
+Arguments for list
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+
+\backslash
+item
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+s (as in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+
+\backslash
+item[foo]
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+) have the prefix
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+item:
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ followed by the number (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+Argument item:1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -584632292 1615846730
+Finally, there is a special argument type with the prefix
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+listpreamble:
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+ It is not really an argument, but uses the argument interface (thus, the
+ prefix is also followed by a number, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+Argument listpreamble:1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+).
+ As the name implies, it is targeted at lists such as
+\family sans
+Itemize
+\family default
+,
+\family sans
+Enumerate
+\family default
+,
+\family sans
+Description
+\family default
+, or
+\family sans
+Bibliography
+\family default
+.
+ Its content will be output at the list start, before the first
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1615846730
+
+\backslash
+item
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, on an own line (a place that is otherwise not accessible in \SpecialChar LyX
+).
+ This way, users can insert redefinitions (of lengths etc.) to individual
+ lists.
+ By default, these arguments do not have a delimiter.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Subsection
+Counters
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Counters"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+It is necessary to define the counters (
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+chapter
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+figure
+\end_layout
+
+\end_inset
+
+, \SpecialChar ldots
+) in the text class itself.
+ The standard counters are defined in the file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdcounters.inc
+\end_layout
+
+\end_inset
+
+, so you may have to do no more than add
+\end_layout
+
+\begin_layout LyX-Code
+Input stdcounters.inc
+\end_layout
+
+\begin_layout Standard
+to your layout file to get them to work.
+ But if you want to define custom counters, then you can do so.
+ The counter declaration must begin with:
+\end_layout
+
+\begin_layout LyX-Code
+Counter CounterName
+\end_layout
+
+\begin_layout Standard
+where of course `
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CounterName
+\end_layout
+
+\end_inset
+
+' is replaced by the name of the counter.
+ And it must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+End
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The following parameters can also be used:
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InitialValue
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+int=1
+\end_layout
+
+\end_inset
+
+] Sets the initial value for the counter, to which it will be reset whenever
+ that happens.
+ Normally, one will want the default, 1.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelString
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] When defined, this string defines how the counter is displayed.
+ Setting this value sets
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelStringAppendix
+\end_layout
+
+\end_inset
+
+ to the same value.
+ The following special constructs can be used in the string:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+thecounter
+\end_layout
+
+\end_inset
+
+ will be replaced by the expansion of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelString
+\end_layout
+
+\end_inset
+
+ (or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelStringAppendix
+\end_layout
+
+\end_inset
+
+) of the counter
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+counter
+\end_layout
+
+\end_inset
+
+.
+
+\end_layout
+
+\begin_layout Itemize
+counter values can be expressed using \SpecialChar LaTeX
+-like macros
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+
+\emph on
+numbertype
+\emph default
+{
+\emph on
+counter
+\emph default
+}
+\end_layout
+
+\end_inset
+
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+numbertype
+\end_layout
+
+\end_inset
+
+ can be:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Actually, the situation is a bit more complicated: any
+\family default
+\series default
+\shape default
+\emph default
+\bar default
+
+\size default
+\emph on
+\noun default
+\color inherit
+numbertype
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+ other than those described below will produce arabic numerals.
+ It would not be surprising to see this change in the future.
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+arabic
+\end_layout
+
+\end_inset
+
+: 1, 2, 3,\SpecialChar ldots
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+alph
+\end_layout
+
+\end_inset
+
+ for lower-case letters: a, b, c, \SpecialChar ldots
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Alph
+\end_layout
+
+\end_inset
+
+ for upper-case letters: A, B, C, \SpecialChar ldots
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+roman
+\end_layout
+
+\end_inset
+
+ for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Roman
+\end_layout
+
+\end_inset
+
+ for upper-case roman numerals: I, II, III\SpecialChar ldots
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+hebrew
+\end_layout
+
+\end_inset
+
+ for hebrew numerals.
+\end_layout
+
+\end_deeper
+\begin_layout Standard
+If LabelString is not defined, a default value is constructed as follows:
+ if the counter has a
+\change_deleted 731793113 1604355218
+master
+\change_inserted 731793113 1604355221
+parent
+\change_unchanged
+ counter
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_deleted 731793113 1604355223
+master
+\change_inserted 731793113 1604355226
+parent
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ (defined via
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Within
+\end_layout
+
+\end_inset
+
+), the string
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+the
+\change_inserted 731793113 1604355228
+parent
+\change_deleted 731793113 1604355230
+master
+\change_unchanged
+.
+\backslash
+arabic{counter}
+\end_layout
\end_inset
\end_inset
-=
-\begin_inset Quotes erd
+=
+\begin_inset Quotes eld
\end_inset
\end_inset
, but for use in the Appendix.
+\change_inserted -584632292 1607202551
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -584632292 1607202682
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+LaTeXName
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1607202576
+string
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ =
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] The counter name as used in \SpecialChar LaTeX
+.
+ (
+\change_inserted 34634807 1619711355
+e
+\change_deleted 34634807 1619711355
+E
+\change_inserted -584632292 1607202682
+.g., in \SpecialChar LyX
+, there is a counter named `theorem', but it is output to \SpecialChar LaTeX
+ as `thm'.)
+\change_unchanged
+
\end_layout
\begin_layout Description
\end_inset
[
+\change_deleted -712698321 1607682984
+
\begin_inset Flex Code
status collapsed
\end_inset
+
+\change_inserted -712698321 1607683139
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1607683135
+string
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] See appendix
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:Names-of-colors"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ for
+\change_deleted -712698321 1607683144
]
+\change_inserted -712698321 1607683146
+valid arguments.
+\change_unchanged
+
\end_layout
\begin_layout Description
\end_inset
- is true—then the contents of the inset will itself be output as paragraphs
- formatted according to the styles used for those paragraphs (standard,
- quote, and the like).
+ is true—then the contents of the inset will
+\change_deleted 34634807 1620029217
+itself
+\change_inserted 34634807 1620029219
+themselves
+\change_inserted -970929547 1515111183
+ be output as paragraphs formatted according to the styles used for those
+ paragraphs (standard, quote, and the like).
The inner tag is optional and, by default, does not appear.
\end_layout
\change_inserted 1075283030 1598469476
para
+\change_unchanged
+
\end_layout
\end_inset
\end_inset
-] Specifies attribute information to be output with the outer tag, replacing
-
+] Specifies attribute information to be output with the outer
+\change_inserted 34634807 1620057958
+wrapper
+\change_inserted -970929547 1515110832
+tag, replacing
\begin_inset Quotes eld
\end_inset
\begin_layout Standard
\change_inserted 1075283030 1597700112
-When the bibliographic entries are manually inserted into the LyX document
- as Bibliography Items, the user deals with formatting themself: there is
- no attempt of parsing what the user wrote, the string is directly used
- (with the
+When the bibliographic entries are manually inserted into the
+\change_deleted 34634807 1620057319
+LyX
+\change_inserted 34634807 1620057319
+\SpecialChar LyX
+
+\change_inserted 1075283030 1597700112
+ document as Bibliography Items, the user deals with formatting
+\change_unchanged
+them
+\change_inserted 1075283030 1597700112
+self: there is no attempt of parsing what the user wrote, the string is
+ directly used (with the
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-These are fixed colors that cannot be customized:
+These are fixed colors that cannot be customized
+\change_inserted -712698321 1607683177
+.
+ Please do
+\emph on
+not
+\emph default
+ use these colors in layout definitions, since they will not work well with
+ some color themes (such as dark themes)
+\change_unchanged
+:
\end_layout
\begin_layout Description
\begin_layout Description
tabularonoffline Table line color
+\change_inserted -712698321 1607682522
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1607682563
+textlabel1 Color 1 of layout and custom inset labels
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1607682565
+textlabel2 Color 2 of layout and custom inset labels
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1607682568
+textlabel3 Color 3 of layout and custom inset labels
+\change_unchanged
+
\end_layout
\begin_layout Description
projects / features.git / blobdiff