]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/Customization.lyx
GuiSearch: make search options visible/accessible in minimal mode
[lyx.git] / lib / doc / Customization.lyx
index 40ecdc535895bc8c9b3b6bd1f3dc82f17c2ff777..5c165df9a9704a010c98891161daa213f33c5785 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.4 created this file. For more info see https://www.lyx.org/
-\lyxformat 599
+\lyxformat 606
 \begin_document
 \begin_header
 \save_transient_properties true
@@ -109,7 +109,7 @@ logicalmkup
 \branch OutDated
 \selected 0
 \filename_suffix 0
-\color #f5fae7
+\color #f5fae7 #0a0518
 \end_branch
 \index Index
 \shortcut idx
@@ -138,6 +138,7 @@ logicalmkup
 \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"
@@ -159,7 +160,6 @@ by the \SpecialChar LyX
 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, 
@@ -181,7 +181,17 @@ literal "false"
 \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
@@ -6167,6 +6177,10 @@ Preferences
 \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
@@ -10361,6 +10375,131 @@ stdclass.inc
 \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
@@ -10513,6 +10652,57 @@ noprefix "false"
 ).
 \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
@@ -11089,6 +11279,61 @@ EndPreamble
 \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
@@ -19602,7 +19847,7 @@ name
 
 \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 
@@ -19662,7 +19907,7 @@ name
 
 \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
@@ -20534,9 +20779,9 @@ status collapsed
 
 \end_inset
 
-] Force 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
 
@@ -22867,8 +23112,8 @@ string
 
 \end_inset
 
-=
-\begin_inset Quotes erd
+= 
+\begin_inset Quotes eld
 \end_inset
 
 
@@ -22886,6 +23131,51 @@ LabelString
 \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
@@ -23048,6 +23338,8 @@ Color
 \end_inset
 
  [
+\change_deleted -712698321 1607682984
+
 \begin_inset Flex Code
 status collapsed
 
@@ -23249,7 +23541,43 @@ violet
 
 \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
@@ -32832,7 +33160,17 @@ Static colors
 \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
@@ -33209,6 +33547,28 @@ tabularline Table line color
 
 \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