]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/Customization.lyx
remerge he.po
[lyx.git] / lib / doc / Customization.lyx
index e36cb2a47363cbf84c8184c251ae0b5f2db70fe4..96c478af17f439c423793f24037c2237de3bbbf8 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.4 created this file. For more info see https://www.lyx.org/
-\lyxformat 614
+\lyxformat 618
 \begin_document
 \begin_header
 \save_transient_properties true
@@ -103,6 +103,7 @@ logicalmkup
 \suppress_date false
 \justification true
 \use_refstyle 0
+\use_formatted_ref 0
 \use_minted 0
 \use_lineno 0
 \notefontcolor #0000ff
@@ -144,6 +145,7 @@ logicalmkup
 \author 177693 "x"
 \author 5863208 "ab"
 \author 34634807 "Jean-Pierre"
+\author 47243155 "Jean-Marc"
 \author 232239728 "Owner"
 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
 \author 1075283030 "Thibaut"
@@ -288,7 +290,13 @@ This chapter aims to help you to find your way through the \SpecialChar LyX
  configuration files.
  Before continuing to read this chapter,
  you should find out where your \SpecialChar LyX
- library and user directories are by using 
+\change_deleted -712698321 1693046672
+library
+\change_inserted -712698321 1693046674
+system
+\change_unchanged
+ and user directories are by using 
 \begin_inset Flex Noun
 status collapsed
 
@@ -304,7 +312,13 @@ LyX
 \end_inset
 
 .
- The library directory is the place where \SpecialChar LyX
+ The 
+\change_deleted -712698321 1693046679
+library
+\change_inserted -712698321 1693046679
+system
+\change_unchanged
+ directory is the place where \SpecialChar LyX
  places its system-wide configuration files;
  the user directory is where you can place your modified versions.
  We will call the former 
@@ -2836,6 +2850,40 @@ latex
 
 \end_layout
 
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+
+\change_inserted -712698321 1676553236
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1676552303
+needauth
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ This converter is considered non-safe and needs authorization by the user.
+ Depending on the settings in 
+\family sans
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+Converters
+\family default
+,
+ users will (a.) be asked whether they trust the current document temporarily,
+ permanently,
+ or not,
+ (b.) be informed that conversion is not possible due to security concerns,
+ or (c.) not be informed as they gave permanent consent.
+ Set this flag for converters that might execute arbitrary programs.
+\end_layout
+
 \begin_layout Labeling
 \labelwidthstring 00.00.0000
 \begin_inset Flex Code
@@ -14664,7 +14712,11 @@ string
 \end_inset
 
 ] Copies all the features of an existing style into the current one.
-\change_inserted 1075283030 1671679774
+
+\change_inserted -584632292 1678808972
+ Note that this copies the style as it is defined at that point.
+ Later changes to it will not affect styles into which it has been copied.
+\change_unchanged
 
 \end_layout
 
@@ -14706,6 +14758,8 @@ status collapsed
 
 \change_inserted 1075283030 1672014789
 title
+\change_unchanged
+
 \end_layout
 
 \end_inset
@@ -14741,6 +14795,8 @@ status collapsed
 
 \change_inserted 1075283030 1672014801
 figure
+\change_unchanged
+
 \end_layout
 
 \end_inset
@@ -19918,6 +19974,103 @@ tbp
 \end_inset
 
 .
+\change_inserted -584632292 1690588297
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -584632292 1690593080
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1690588298
+PrettyFormat
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1690588298
+string
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] A format for use with formatted references to this counter.
+ For example,
+ one might want to have references to tables appear as 
+\begin_inset Quotes eld
+\end_inset
+
+Table 2
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The string may contain 
+\begin_inset Quotes eld
+\end_inset
+
+##
+\begin_inset Quotes erd
+\end_inset
+
+ or a counter specification.
+ (See the documentation for 
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1690588298
+LabelString
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ in 
+\begin_inset CommandInset ref
+LatexCommand formatted
+reference "subsec:Counters"
+plural "false"
+caps "false"
+noprefix "false"
+nolink "false"
+
+\end_inset
+
+.) The former will be replaced by the counter number itself.
+ So,
+ for sections,
+ it would be:
+ Section ##,
+ or perhaps:
+ section 
+\backslash
+arabic{section} (which might render as:
+ section 2.7).
 \end_layout
 
 \begin_layout Description
@@ -20900,6 +21053,293 @@ string
  This is only implemented for Flex insets.
  Default:
  disabled.
+\change_inserted -712698321 1690284265
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1690284544
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1690284277
+AllowedInInsets
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ Includes a comma-separated list of insets to which this inset can be inserted.
+ Must be ended by 
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1690284318
+EndAllowedInInsets
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ If you you also want the insertion to be allowed in specific arguments of the target insets,
+ append the argument name after @ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1690284445
+My_Inset@post:1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+).
+ Note that this currently only supports immediately containing insets (no deeper nesting).
+ See also 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1690284329
+AllowedInLayouts
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1690292495
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1690284338
+AllowedInLayouts
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ Includes a comma-separated list of layouts within which this inset can be inserted.
+ Must be ended by 
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1690284353
+EndAllowedInLayouts
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Note that this currently only supports immediately containing layouts (no deeper nesting).
+ See also 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1690284358
+AllowedInInsets
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1690357747
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1690292501
+AllowedOccurrences
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1690292507
+int
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] If 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1690292530
+AllowedInInsets
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ or 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1690292536
+AllowedInLayouts
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ has been defined,
+ this can be used to determine how many times the inset can be inserted to a given inset or the paragraph (group).
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1690357828
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1690357753
+AllowedOccurrencesPerItem
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1690357747
+
+\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 -712698321 1690357747
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] If this is set to true,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1690357774
+AllowedOccurrences
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ applies to single paragraphs if we are in a list-type environment (with 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1690357825
+
+\backslash
+item
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+s).
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -21401,7 +21841,7 @@ and
  the label.
  See 
 \begin_inset CommandInset ref
-LatexCommand ref
+LatexCommand formatted
 reference "subsec:Font-description"
 nolink "false"
 
@@ -21707,28 +22147,106 @@ status collapsed
 
 \end_inset
 
-] Indicates whether the 
+] Indicates whether the 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PlainLayout
+\end_layout
+
+\end_inset
+
+ should be used or,
+ instead,
+ the user can change the paragraph style used in the inset.
+ Default is false.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+FreeSpacing
+\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
+
+] As with paragraph styles,
+ see 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+nolink "false"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
-PlainLayout
+HTML*
 \end_layout
 
 \end_inset
 
- should be used or,
- instead,
- the user can change the paragraph style used in the inset.
- Default is false.
+ These tags control the XHTML output.
+ See 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Tags-for-XHTML"
+nolink "false"
+
+\end_inset
+
+.
+\change_inserted 47243155 1689528605
+
 \end_layout
 
 \begin_layout Description
+
+\change_inserted 47243155 1689528735
 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
-FreeSpacing
+
+\change_inserted 47243155 1689528630
+InheritFont
+\change_unchanged
+
 \end_layout
 
 \end_inset
@@ -21739,8 +22257,10 @@ status collapsed
 
 \begin_layout Plain Layout
 
-\emph on
+\change_inserted 47243155 1689528607
 0
+\change_unchanged
+
 \end_layout
 
 \end_inset
@@ -21754,43 +22274,23 @@ status collapsed
 status collapsed
 
 \begin_layout Plain Layout
-1
-\end_layout
-
-\end_inset
-
-] As with paragraph styles,
- see 
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
-nolink "false"
-
-\end_inset
 
-.
-\end_layout
+\change_inserted 47243155 1689528607
 
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\emph on
+1
+\change_unchanged
 
-\begin_layout Plain Layout
-HTML*
 \end_layout
 
 \end_inset
 
- These tags control the XHTML output.
- See 
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Tags-for-XHTML"
-nolink "false"
-
-\end_inset
+] The font inside the inset is inherited from the parent for \SpecialChar LaTeX
+ export if this parameter is 1,
+ as well as on screen.
+ Otherwise the document default font is used.
+\change_unchanged
 
-.
 \end_layout
 
 \begin_layout Description
@@ -25712,7 +26212,13 @@ Section 2.4
 \end_inset
 
 .
- The string should contain 
+ The string 
+\change_deleted -584632292 1690588038
+should 
+\change_inserted -584632292 1690588041
+may 
+\change_unchanged
+contain 
 \begin_inset Quotes eld
 \end_inset
 
@@ -25720,12 +26226,208 @@ Section 2.4
 \begin_inset Quotes erd
 \end_inset
 
+
+\change_inserted -584632292 1690588059
+ or a counter specification as in 
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1690588059
+LabelString
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\change_unchanged
 .
- This will be replaced by the counter number itself.
+ Th
+\change_inserted -584632292 1690588078
+e former
+\change_deleted -584632292 1690588076
+is
+\change_unchanged
+ will be replaced by the counter number itself.
  So,
  for sections,
  it would be:
- Section ##.
+ Section ##
+\change_inserted -584632292 1690588159
+,
+ or perhaps:
+\change_deleted -712698321 1691671418
+
+\backslash
+S
+\backslash
+arabic{section}
+\change_inserted -712698321 1691671418
+
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1691671418
+
+\backslash
+S
+\backslash
+arabic{section}
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\change_inserted -584632292 1690588159
+ (which might render as ยง2.7)
+\change_unchanged
+.
+\change_inserted -584632292 1690587966
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -584632292 1690588264
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1690587970
+RefFormat
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1690587966
+string
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1690587981
+string
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] For use with `formatted references',
+ specifically when a single counter is used with multiple sorts of styles.
+ For example,
+ the 
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1690588222
+theorem
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ counter is often used for all sorts of theorem-like environments:
+ Theorem,
+ Lemma,
+\change_deleted -712698321 1691671691
+e
+\change_inserted -584632292 1690588264
+etc.
+ The first argument gives a prefix used in the labels (e.g.,
+\begin_inset Quotes eld
+\end_inset
+
+thm
+\begin_inset Quotes erd
+\end_inset
+
+ or 
+\begin_inset Quotes eld
+\end_inset
+
+lem
+\begin_inset Quotes erd
+\end_inset
+
+),
+ and the second a formatting string,
+ as for 
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1690588181
+LabelString
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ or 
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1690588177
+PrettyFormat
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+ If this is not given,
+ then 
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1690588264
+PrettyFormat
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ is used.
 \end_layout
 
 \begin_layout Description
@@ -36254,6 +36956,16 @@ appendix Appendix marker color
 
 \begin_layout Description
 background Background color
+\change_inserted 5863208 1681507589
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 5863208 1681507597
+bookmark Bookmark indicator color
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -36274,6 +36986,16 @@ buttonframe Color for inset button frames
 
 \begin_layout Description
 buttonhoverbg Color used for button background under focus
+\change_inserted -712698321 1681555554
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1681555554
+buttonhoverbg_broken Color used for broken inset button under focus 
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -36298,6 +37020,16 @@ changedtextauthor4 Changed text color author 4
 
 \begin_layout Description
 changedtextauthor5 Changed text color author 5
+\change_inserted 5863208 1681507402
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 5863208 1681507414
+changedtextcomparison Changed text color document comparison (workarea)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -36318,6 +37050,42 @@ commandbg Background color for command insets
 
 \begin_layout Description
 commandframe Frame color for command insets
+\change_inserted 5863208 1681507735
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 5863208 1681507880
+command_broken Text color for broken
+\change_inserted -712698321 1681555620
+\change_inserted 5863208 1681507880
+(
+\change_deleted -712698321 1681555620
+-
+\change_inserted 5863208 1681507880
+reference) insets 
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 5863208 1681507827
+commandbg_broken Background color for broken insets
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 5863208 1681507835
+commandframe_broken Frame color for broken insets 
+\end_layout
+
+\begin_layout Description
+
+\change_deleted -712698321 1681555548
+buttonhoverbg_broken Color used for broken inset button under focus 
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -36338,6 +37106,16 @@ deletedtext Deleted text color
 
 \begin_layout Description
 deletedtextmodifier Deleted text modifying color
+\change_inserted 5863208 1681507525
+ (for adjusting the 
+\change_deleted -712698321 1681555611
+brightnes
+\change_inserted -712698321 1681555611
+brightness
+\change_inserted 5863208 1681507525
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description