#LyX 2.4 created this file. For more info see https://www.lyx.org/
-\lyxformat 598
+\lyxformat 606
\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
\docbook_table_output 0
\author -970929547 "Thibaut Cuvelier"
\author -712698321 "Jürgen Spitzmüller"
+\author -584632292 "Richard Kimberly Heck"
\author -495245474 "Jean-Marc Lasgouttes"
\author 5863208 "ab"
+\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
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1612018466
+<type>
+\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
+\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
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1612018509
+<type>
+\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
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\change_unchanged
+
\end_layout
\begin_layout Description
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
\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
\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
\end_deeper
\begin_layout Standard
If LabelString is not defined, a default value is constructed as follows:
- if the counter has a master counter
+ 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
\begin_layout Plain Layout
\backslash
-themaster.
+the
+\change_inserted 731793113 1604355228
+parent
+\change_deleted 731793113 1604355230
+master
+\change_unchanged
+.
\backslash
arabic{counter}
\end_layout
\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
+.
+ (E.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
\change_inserted 1075283030 1598469476
para
+\change_unchanged
+
\end_layout
\end_inset
\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 / lyx.git / blobdiff