]> git.lyx.org Git - features.git/blobdiff - lib/doc/Customization.lyx
Customization.lyx: distribute and accept recent changes
[features.git] / lib / doc / Customization.lyx
index b8231516507125dd691c6063ed460f2cf7e996df..551a14b35546672ac9b07cab94f687a799e3c097 100644 (file)
@@ -82,16 +82,16 @@ logicalmkup
 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
 \papersize default
 \use_geometry false
-\use_package amsmath 0
-\use_package amssymb 0
-\use_package cancel 0
-\use_package esint 0
+\use_package amsmath 1
+\use_package amssymb 1
+\use_package cancel 1
+\use_package esint 1
 \use_package mathdots 1
-\use_package mathtools 0
-\use_package mhchem 0
-\use_package stackrel 0
-\use_package stmaryrd 0
-\use_package undertilde 0
+\use_package mathtools 1
+\use_package mhchem 1
+\use_package stackrel 1
+\use_package stmaryrd 1
+\use_package undertilde 1
 \cite_engine basic
 \cite_engine_type default
 \biblio_style plain
@@ -1088,7 +1088,7 @@ unicodesymbols
 
 \end_inset
 
- this file contains information about unicode-encoded glyphs and the way
+ this file contains information about Unicode-encoded glyphs and the way
  they are supported by \SpecialChar LyX
  via \SpecialChar LaTeX
 .
@@ -2999,7 +2999,7 @@ Check out the \SpecialChar LyX
 \begin_inset CommandInset href
 LatexCommand href
 name "information on the web"
-target "http://www.lyx.org/HowToUseGIT"
+target "https://www.lyx.org/HowToUseGIT"
 literal "false"
 
 \end_inset
@@ -3430,8 +3430,8 @@ DocName
 Check out the documentation translation web page at 
 \begin_inset CommandInset href
 LatexCommand href
-name "http://www.lyx.org/Translation"
-target "http://www.lyx.org/Translation"
+name "https://www.lyx.org/Translation"
+target "https://www.lyx.org/Translation"
 literal "false"
 
 \end_inset
@@ -3526,7 +3526,7 @@ status collapsed
 
 \begin_layout Plain Layout
 
-http://www.lyx.org/HowToUseGIT
+https://www.lyx.org/HowToUseGIT
 \end_layout
 
 \end_inset
@@ -3545,8 +3545,8 @@ Sometimes the original document (from the \SpecialChar LyX
  Use the source viewer at 
 \begin_inset CommandInset href
 LatexCommand href
-name "http://www.lyx.org/trac/timeline"
-target "http://www.lyx.org/trac/timeline"
+name "https://www.lyx.org/trac/timeline"
+target "https://www.lyx.org/trac/timeline"
 literal "false"
 
 \end_inset
@@ -6177,7 +6177,6 @@ status collapsed
 \begin_layout Plain Layout
 
 \family sans
-\lang french
 $HOME/.texliveXXXX
 \end_layout
 
@@ -6477,11 +6476,7 @@ Now the package is installed.
 status collapsed
 
 \begin_layout Plain Layout
-Slides
-\begin_inset space ~
-\end_inset
-
-(FoilTex)
+FoilTex
 \end_layout
 
 \end_inset
@@ -6498,7 +6493,15 @@ Document Class
 
 \end_inset
 
-.
+ (in the 
+\begin_inset Quotes eld
+\end_inset
+
+Presentations
+\begin_inset Quotes erd
+\end_inset
+
+ category).
  
 \end_layout
 
@@ -6562,7 +6565,7 @@ As you prepare to write a new layout, it is extremely helpful to look at
 \begin_inset CommandInset href
 LatexCommand href
 name "layout section on the LyX wiki"
-target "http://wiki.lyx.org/Layouts/Layouts"
+target "https://wiki.lyx.org/Layouts/Layouts"
 literal "false"
 
 \end_inset
@@ -6805,7 +6808,7 @@ Format
  Any format is acceptable, but one would normally use the format current
  at the time.
  (In \SpecialChar LyX
- 2.2, the current layout format is 60.)
+ 2.3, the current layout format is 63.)
 \end_layout
 
 \begin_layout Standard
@@ -6972,7 +6975,7 @@ myclass.layout
 \begin_layout LyX-Code
 
 \backslash
-DeclareLaTeXClass{report}
+DeclareLaTeXClass{Report (Standard Class)}
 \end_layout
 
 \begin_layout Standard
@@ -6982,7 +6985,7 @@ to read
 \begin_layout LyX-Code
 
 \backslash
-DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
+DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
 \end_layout
 
 \begin_layout Standard
@@ -7028,7 +7031,7 @@ Reconfigure
 status collapsed
 
 \begin_layout Plain Layout
-report (myclass)
+Report (My Class)
 \end_layout
 
 \end_inset
@@ -7155,7 +7158,7 @@ myclass.sty
 \begin_layout LyX-Code
 #
 \backslash
-DeclareLyXModule{My Package
+DeclareLyXModule{My Class
 \end_layout
 
 \begin_layout LyX-Code
@@ -7163,7 +7166,7 @@ DeclareLyXModule{My Package}
 \end_layout
 
 \begin_layout LyX-Code
-#Support for mypkg.sty.
+#Support for myclass.sty.
 \end_layout
 
 \begin_layout LyX-Code
@@ -7175,7 +7178,7 @@ DeclareLyXModule{My Package}
 \end_layout
 
 \begin_layout LyX-Code
-Format 60
+Format 63
 \begin_inset Newline newline
 \end_inset
 
@@ -7189,7 +7192,7 @@ Preamble
 
     
 \backslash
-usepackage{mypkg}
+usepackage{myclass}
 \begin_inset Newline newline
 \end_inset
 
@@ -7450,7 +7453,10 @@ Paths
 
 \begin_layout Standard
 Note, by the way, that there is a template which has a particular meaning:
+\begin_inset Newline linebreak
+\end_inset
+
+
 \begin_inset Flex Code
 status collapsed
 
@@ -7644,8 +7650,7 @@ More specifically, it is defined which packages \SpecialChar LyX
  in 
 \family sans
 Document\SpecialChar menuseparator
-Settings\SpecialChar ldots
-\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
 Bibliography\SpecialChar menuseparator
 Style engine
 \family default
@@ -8244,7 +8249,6 @@ Reconfigure
 Once the layout file is installed, you can edit it and see your changes
  without having to reconfigure or to restart \SpecialChar LyX
 .
 \begin_inset Foot
 status collapsed
 
@@ -8410,7 +8414,7 @@ to
 \end_layout
 
 \begin_layout Standard
-The module declaration should then be followed by lines like the following
+The module declaration should then be followed by lines like the following:
 \begin_inset Foot
 status collapsed
 
@@ -8423,7 +8427,7 @@ Preferably in English if the module should be published with \SpecialChar LyX
 
 \end_inset
 
-:
+
 \end_layout
 
 \begin_layout LyX-Code
@@ -8555,8 +8559,8 @@ DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
 \end_layout
 
 \begin_layout Standard
-The mandatory argument, in curly brackets, is the name of the module, as
- it should appear in 
+The mandatory argument, in curly brackets, is the name of the cite style,
as it should appear in 
 \begin_inset Flex Noun
 status collapsed
 
@@ -8575,7 +8579,7 @@ Bibliography
 \end_layout
 
 \begin_layout Standard
-The cite engine declaration should then be followed by lines like the following
+The cite engine declaration should then be followed by lines like the following:
 \begin_inset Foot
 status collapsed
 
@@ -8588,7 +8592,7 @@ Preferably in English if the module should be published with \SpecialChar LyX
 
 \end_inset
 
-:
+
 \end_layout
 
 \begin_layout LyX-Code
@@ -11975,8 +11979,12 @@ string of characters
 \family typewriter
  
 \family default
-Defines individual characters that should be output in raw form, meaning
- without special translations that \SpecialChar LaTeX
+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.
@@ -12156,6 +12164,51 @@ Argument item:1
 \begin_inset Flex Code
 status collapsed
 
+\begin_layout Plain Layout
+AutoNests
+\end_layout
+
+\end_inset
+
+ Includes a comma-separated list of layouts that should be nested in and
+ after the current layout.
+ Only makes sense for nestable layouts (such as environments).
+ Must be ended by 
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndAutoNests
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See also 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+IsAutoNestedBy
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
 \begin_layout Plain Layout
 BabelPreamble
 \end_layout
@@ -12887,6 +12940,51 @@ TitleLatexName
 \begin_inset Flex Code
 status collapsed
 
+\begin_layout Plain Layout
+IsAutoNestedBy
+\end_layout
+
+\end_inset
+
+ Includes a comma-separated list of layouts after which this one should
+ be nested.
+ Only makes sense with regard to nestable layouts (such as environments).
+ Must be ended by 
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndIsAutoNestedBy
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See also 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AutoNests
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
 \begin_layout Plain Layout
 IsTocCaption
 \end_layout
@@ -13726,8 +13824,18 @@ Enumerate
 \end_inset
 
  produces the usual sort of enumeration labels.
- At present, it is hardcoded to use Arabic numerals, lowercase letters,
- small Roman numerals, and uppercase letters for the four possible depths.
+ The number type needs to be set in the 
+\family sans
+Counter
+\family default
+, see 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Counters"
+
+\end_inset
+
+.
 \end_layout
 
 \begin_layout Description
@@ -13741,7 +13849,19 @@ Itemize
 \end_inset
 
  produces various bullets at the different levels.
- It is also hardcoded.
+ The bullet types displayed can be set via 
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Bullets
+\end_layout
+
+\end_inset
+
+.
 \end_layout
 
 \begin_layout Description
@@ -14765,7 +14885,7 @@ status collapsed
 
 \end_inset
 
-] Determines whether consecutive pragraphs of the same type are treated
+] Determines whether consecutive paragraphs of the same type are treated
  as belonging together.
  This has the effect that the 
 \begin_inset Flex Code
@@ -16252,7 +16372,7 @@ g.
 \begin_inset space \space{}
 \end_inset
 
-from 2.0.x to 2.1.y) will introduce new translations or corrections.
+from 2.0.x to 2.1.0) will introduce new translations or corrections.
 \end_layout
 
 \begin_layout Subsection
@@ -17813,7 +17933,11 @@ Multilingual
 \begin_inset space ~
 \end_inset
 
-Captions 
+Captions
+\begin_inset Newline linebreak
+\end_inset
+
+
 \family default
 (
 \begin_inset Flex Code
 \emph default
  LabelFont
 \emph on
- or
+\family roman
+or
+\family default
 \emph default
  DefaultFont
 \end_layout
@@ -21149,7 +21276,7 @@ name "subsec:Citation-engine-description"
 
 \end_inset
 
-Citation engine description
+Cite engine description
 \end_layout
 
 \begin_layout Standard
@@ -21710,7 +21837,7 @@ name "subsec:Citation-format-description"
 
 \end_inset
 
-Citation format description
+Cite format description
 \end_layout
 
 \begin_layout Standard
@@ -22534,7 +22661,7 @@ MaxCiteNames
 \begin_layout Enumerate
 And finally name lists which consist of family names only, as used in author-yea
 r citation labels.
these do not take a 
These do not take a 
 \begin_inset Flex Code
 status collapsed
 
@@ -22876,7 +23003,7 @@ So here then is an example that use all these features:
 \begin_layout Standard
 \noindent
 
-\family typewriter
+\family sans
 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
 \end_layout
 
@@ -23046,6 +23173,8 @@ For a command or normal paragraph, the output XHTML has the following form:
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <tag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23058,6 +23187,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <labeltag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23070,10 +23201,14 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 Contents of the paragraph.
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 </tag>
 \end_layout
 
@@ -23086,6 +23221,8 @@ For an environment that is not some sort of list, the XHTML takes this form:
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <tag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23098,6 +23235,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <itemtag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23118,10 +23257,14 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <itemtag>Second paragraph.</itemtag>
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 </tag>
 \end_layout
 
@@ -23136,6 +23279,8 @@ For a list, we have one of these forms:
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <tag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23148,6 +23293,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <itemtag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23168,6 +23315,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <itemtag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23188,6 +23337,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 </tag>
 \end_layout
 
@@ -23196,6 +23347,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <tag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23208,6 +23361,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <labeltag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23228,6 +23383,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <labeltag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23248,6 +23405,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 </tag>
 \end_layout
 
@@ -23523,7 +23682,11 @@ string
 \end_inset
 
 ] Attributes for the item tag.
- Defaults to 
+ Defaults to
+\begin_inset Newline newline
+\end_inset
+
+
 \begin_inset Quotes eld
 \end_inset
 
@@ -23665,7 +23828,11 @@ string
 \end_inset
 
 ] Attributes for the label tag.
- Defaults to 
+ Defaults to
+\begin_inset Newline newline
+\end_inset
+
+
 \begin_inset Quotes eld
 \end_inset
 
@@ -24195,7 +24362,11 @@ string
 \end_inset
 
 ] Attributes for the inner tag.
- Defaults to 
+ Defaults to
+\begin_inset Newline newline
+\end_inset
+
+
 \begin_inset Quotes eld
 \end_inset
 
@@ -27578,11 +27749,27 @@ name "chap:Names-of-colors"
 \end_layout
 
 \begin_layout Standard
-The colors listed here are the standard colors and the those that you can
adjust in the \SpecialChar LyX
+The colors listed below are the standard colors and those that you can adjust
+ in the \SpecialChar LyX
  preferences.
 \end_layout
 
+\begin_layout Section
+Color functions
+\end_layout
+
+\begin_layout Standard
+The following are no real colors, but rather act on color definitions:
+\end_layout
+
+\begin_layout Description
+ignore The color is ignored
+\end_layout
+
+\begin_layout Description
+inherit The color is inherited
+\end_layout
+
 \begin_layout Description
 none
 \family roman
@@ -27599,6 +27786,14 @@ none
  No particular color – clear or default
 \end_layout
 
+\begin_layout Section
+Static colors
+\end_layout
+
+\begin_layout Standard
+These are fixed colors that cannot me customized:
+\end_layout
+
 \begin_layout Description
 black
 \end_layout
@@ -27608,7 +27803,23 @@ white
 \end_layout
 
 \begin_layout Description
-red
+blue
+\end_layout
+
+\begin_layout Description
+brown
+\end_layout
+
+\begin_layout Description
+cyan
+\end_layout
+
+\begin_layout Description
+darkgray
+\end_layout
+
+\begin_layout Description
+gray
 \end_layout
 
 \begin_layout Description
@@ -27616,23 +27827,65 @@ green
 \end_layout
 
 \begin_layout Description
-blue
+lightgray
 \end_layout
 
 \begin_layout Description
-cyan
+lime
 \end_layout
 
 \begin_layout Description
 magenta
 \end_layout
 
+\begin_layout Description
+olive
+\end_layout
+
+\begin_layout Description
+orange
+\end_layout
+
+\begin_layout Description
+pink
+\end_layout
+
+\begin_layout Description
+purple
+\end_layout
+
+\begin_layout Description
+red
+\end_layout
+
+\begin_layout Description
+teal
+\end_layout
+
+\begin_layout Description
+violet
+\end_layout
+
 \begin_layout Description
 yellow
 \end_layout
 
+\begin_layout Section
+Dynamic colors
+\end_layout
+
+\begin_layout Standard
+These are the colors allocated to specific elements in 
+\begin_inset Info
+type  "menu"
+arg   "dialog-show prefs"
+\end_inset
+
+:
+\end_layout
+
 \begin_layout Description
-added_space Added space marker color
+added_space Added space color
 \end_layout
 
 \begin_layout Description
@@ -27660,11 +27913,11 @@ buttonbg Color used for button background
 \end_layout
 
 \begin_layout Description
-buttonhoverbg Color used for button background under focus
+buttonframe Color for inset button frames
 \end_layout
 
 \begin_layout Description
-buttonframe Color for inset button frames
+buttonhoverbg Color used for button background under focus
 \end_layout
 
 \begin_layout Description
@@ -27692,11 +27945,11 @@ changedtextauthor5 Changed text color author 5
 \end_layout
 
 \begin_layout Description
-collapsable_inset_frame Collapsable insets framecolor
+collapsible Collapsible insets text color
 \end_layout
 
 \begin_layout Description
-collapsable_inset_text Collapsable insets text color
+collapsibleframe Collapsible insets framecolor
 \end_layout
 
 \begin_layout Description
@@ -27712,7 +27965,7 @@ commandframe Frame color for command insets
 \end_layout
 
 \begin_layout Description
-comment color for comments
+comment Label color for comments
 \end_layout
 
 \begin_layout Description
@@ -27749,11 +28002,11 @@ footlabel Label color for footnotes
 \end_layout
 
 \begin_layout Description
-graphicsbg Graphics inset background color
+foreground Foreground color
 \end_layout
 
 \begin_layout Description
-greyedout Label color for greyedout insets
+graphicsbg Graphics inset background color
 \end_layout
 
 \begin_layout Description
@@ -27761,19 +28014,15 @@ greyedoutbg Background color of greyedout inset
 \end_layout
 
 \begin_layout Description
-greyedouttext Color for greyedout inset text
+greyedoutlabel Label color for greyedout insets
 \end_layout
 
 \begin_layout Description
-indexlabel Label color for index insets
-\end_layout
-
-\begin_layout Description
-ignore The color is ignored
+greyedouttext Color for greyedout inset text
 \end_layout
 
 \begin_layout Description
-inherit The color is inherited
+indexlabel Label color for index insets
 \end_layout
 
 \begin_layout Description
@@ -27862,11 +28111,11 @@ nonunique_inlinecompletion Inline completion color for the non-unique part
 \end_layout
 
 \begin_layout Description
-notebg Background color of notes
+note Label color for notes
 \end_layout
 
 \begin_layout Description
-notelabel Label color for notes
+notebg Background color of notes
 \end_layout
 
 \begin_layout Description
@@ -27893,6 +28142,10 @@ previewframe Preview frame color
 regexpframe Color for regexp frame
 \end_layout
 
+\begin_layout Description
+scroll Color that indicates when a row can be scrolled 
+\end_layout
+
 \begin_layout Description
 selection Background color of selected text
 \end_layout