]> git.lyx.org Git - features.git/blobdiff - lib/doc/Customization.lyx
Distribute auto-nest documentation.
[features.git] / lib / doc / Customization.lyx
index 4d9a9b9ee355500143553f84ed9a7e81099754e8..462a374e19ff436b1b1019d1197f4b4322b9e722 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
@@ -1089,7 +1089,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
 .
@@ -3000,7 +3000,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
@@ -3431,8 +3431,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
@@ -3527,7 +3527,7 @@ status collapsed
 
 \begin_layout Plain Layout
 
-http://www.lyx.org/HowToUseGIT
+https://www.lyx.org/HowToUseGIT
 \end_layout
 
 \end_inset
@@ -3546,8 +3546,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
@@ -6566,7 +6566,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
@@ -7454,7 +7454,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
 
@@ -7648,8 +7651,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
@@ -8413,7 +8415,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
 
@@ -8426,7 +8428,7 @@ Preferably in English if the module should be published with \SpecialChar LyX
 
 \end_inset
 
-:
+
 \end_layout
 
 \begin_layout LyX-Code
@@ -8578,7 +8580,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
 
@@ -8591,7 +8593,7 @@ Preferably in English if the module should be published with \SpecialChar LyX
 
 \end_inset
 
-:
+
 \end_layout
 
 \begin_layout LyX-Code
@@ -11978,8 +11980,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.
@@ -12155,6 +12161,61 @@ Argument item:1
 \end_layout
 
 \end_deeper
+\begin_layout Description
+
+\change_inserted -712698321 1514539256
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1514534780
+AutoNests
+\end_layout
+
+\end_inset
+
+ Includes a comma-separated list of layout names that should be nested in
+ and after the current one.
+ 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
+
+\change_inserted -712698321 1514538124
+EndAutoNests
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See also 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1514539161
+IsAutoNestedBy
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
 \begin_layout Description
 \begin_inset Flex Code
 status collapsed
@@ -12884,6 +12945,63 @@ TitleLatexName
 \end_inset
 
  global entries).
+\change_inserted -712698321 1514539171
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1514539282
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1514539190
+IsAutoNestedBy
+\end_layout
+
+\end_inset
+
+ Includes a comma-separated list of layout names 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
+
+\change_inserted -712698321 1514539279
+EndIsAutoNestedBy
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See also 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1514710776
+AutoNests
+\end_layout
+
+\end_inset
+
+.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -13729,8 +13847,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
@@ -13744,7 +13872,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
@@ -14768,7 +14908,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
@@ -17816,7 +17956,11 @@ Multilingual
 \begin_inset space ~
 \end_inset
 
-Captions 
+Captions
+\begin_inset Newline linebreak
+\end_inset
+
+
 \family default
 (
 \begin_inset Flex Code
@@ -22882,7 +23026,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
 
@@ -23052,6 +23196,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
@@ -23064,6 +23210,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <labeltag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23076,10 +23224,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
 
@@ -23092,6 +23244,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
@@ -23104,6 +23258,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <itemtag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23124,10 +23280,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
 
@@ -23142,6 +23302,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
@@ -23154,6 +23316,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <itemtag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23174,6 +23338,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <itemtag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23194,6 +23360,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 </tag>
 \end_layout
 
@@ -23202,6 +23370,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <tag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23214,6 +23384,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <labeltag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23234,6 +23406,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <labeltag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23254,6 +23428,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 </tag>
 \end_layout
 
@@ -23529,7 +23705,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
 
@@ -23671,7 +23851,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
 
@@ -24201,7 +24385,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
 
@@ -27584,45 +27772,24 @@ name "chap:Names-of-colors"
 \end_layout
 
 \begin_layout Standard
-The colors listed 
-\change_deleted -712698321 1505048041
-here
-\change_inserted -712698321 1505048041
-below
-\change_unchanged
- are the standard colors and 
-\change_deleted -712698321 1505048036
-the 
-\change_unchanged
-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.
-\change_inserted -712698321 1505047917
-
 \end_layout
 
 \begin_layout Section
-
-\change_inserted -712698321 1505048046
 Color functions
 \end_layout
 
 \begin_layout Standard
-
-\change_inserted -712698321 1505048063
 The following are no real colors, but rather act on color definitions:
-\change_unchanged
-
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505049948
 ignore The color is ignored
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505049948
 inherit The color is inherited
 \end_layout
 
@@ -27640,22 +27807,14 @@ none
 \noun off
 \color none
  No particular color – clear or default
-\change_inserted -712698321 1505049946
-
 \end_layout
 
 \begin_layout Section
-
-\change_inserted -712698321 1505048068
 Static colors
 \end_layout
 
 \begin_layout Standard
-
-\change_inserted -712698321 1505048080
 These are fixed colors that cannot me customized:
-\change_unchanged
-
 \end_layout
 
 \begin_layout Description
@@ -27664,151 +27823,81 @@ black
 
 \begin_layout Description
 white
-\change_inserted -712698321 1505047780
-
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505047787
 blue
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505047791
 brown
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505047799
 cyan
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505047807
 darkgray
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505047809
 gray
-\change_unchanged
-
-\end_layout
-
-\begin_layout Description
-
-\change_deleted -712698321 1505047820
-red
-\change_unchanged
-
 \end_layout
 
 \begin_layout Description
 green
-\change_inserted -712698321 1505047824
-
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505047828
 lightgray
-\change_unchanged
-
-\end_layout
-
-\begin_layout Description
-
-\change_deleted -712698321 1505047798
-blue
-\end_layout
-
-\begin_layout Description
-
-\change_deleted -712698321 1505047798
-cyan
-\change_inserted -712698321 1505047834
-
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505047835
 lime
-\change_unchanged
-
 \end_layout
 
 \begin_layout Description
 magenta
-\change_inserted -712698321 1505047840
-
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505047846
 olive
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505047850
 orange
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505047861
 pink
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505047863
 purple
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505047867
 red
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505047881
 teal
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505047878
 violet
-\change_unchanged
-
 \end_layout
 
 \begin_layout Description
 yellow
-\change_inserted -712698321 1505047947
-
 \end_layout
 
 \begin_layout Section
-
-\change_inserted -712698321 1505048092
 Dynamic colors
 \end_layout
 
 \begin_layout Standard
-
-\change_inserted -712698321 1505048589
 These are the colors allocated to specific elements in 
 \begin_inset Info
 type  "menu"
@@ -27816,16 +27905,10 @@ arg   "dialog-show prefs"
 \end_inset
 
 :
-\change_unchanged
-
 \end_layout
 
 \begin_layout Description
-added_space Added space 
-\change_deleted -712698321 1505049692
-marker 
-\change_unchanged
-color
+added_space Added space color
 \end_layout
 
 \begin_layout Description
@@ -27850,30 +27933,16 @@ branchlabel Label color for branches
 
 \begin_layout Description
 buttonbg Color used for button background
-\change_inserted -712698321 1505049724
-
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505049724
 buttonframe Color for inset button frames
-\change_unchanged
-
 \end_layout
 
 \begin_layout Description
 buttonhoverbg Color used for button background under focus
 \end_layout
 
-\begin_layout Description
-
-\change_deleted -712698321 1505049722
-buttonframe Color for inset button frames
-\change_unchanged
-
-\end_layout
-
 \begin_layout Description
 changebar Changebar color
 \end_layout
@@ -27896,30 +27965,14 @@ changedtextauthor4 Changed text color author 4
 
 \begin_layout Description
 changedtextauthor5 Changed text color author 5
-\change_inserted -712698321 1505049811
-
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505049811
-collapsable Collapsable insets text color
+collapsible Collapsible insets text color
 \end_layout
 
 \begin_layout Description
-collapsable
-\change_deleted -712698321 1505049817
-_inset_
-\change_unchanged
-frame Collapsable insets framecolor
-\end_layout
-
-\begin_layout Description
-
-\change_deleted -712698321 1505049809
-collapsable_inset_text Collapsable insets text color
-\change_unchanged
-
+collapsibleframe Collapsible insets framecolor
 \end_layout
 
 \begin_layout Description
@@ -27932,30 +27985,14 @@ commandbg Background color for command insets
 
 \begin_layout Description
 commandframe Frame color for command insets
-\change_inserted -712698321 1505048865
-
-\end_layout
-
-\begin_layout Description
-
-\change_deleted -712698321 1505049843
-comment color for comments
-\change_unchanged
-
 \end_layout
 
 \begin_layout Description
 commentbg Background color of comments
-\change_inserted -712698321 1505048888
-
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505048891
 commentlabel Label color for comments
-\change_unchanged
-
 \end_layout
 
 \begin_layout Description
@@ -27985,42 +28022,22 @@ error Color of the \SpecialChar LaTeX
 
 \begin_layout Description
 footlabel Label color for footnotes
-\change_inserted -712698321 1505048777
-
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505048785
 foreground Foreground color
-\change_unchanged
-
 \end_layout
 
 \begin_layout Description
 graphicsbg Graphics inset background color
 \end_layout
 
-\begin_layout Description
-
-\change_deleted -712698321 1505049909
-greyedout Label color for greyedout insets
-\change_unchanged
-
-\end_layout
-
 \begin_layout Description
 greyedoutbg Background color of greyedout inset
-\change_inserted -712698321 1505048914
-
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505049907
 greyedoutlabel Label color for greyedout insets
-\change_unchanged
-
 \end_layout
 
 \begin_layout Description
@@ -28031,20 +28048,6 @@ greyedouttext Color for greyedout inset text
 indexlabel Label color for index insets
 \end_layout
 
-\begin_layout Description
-
-\change_deleted -712698321 1505049940
-ignore The color is ignored
-\end_layout
-
-\begin_layout Description
-
-\change_deleted -712698321 1505049940
-inherit The color is inherited
-\change_unchanged
-
-\end_layout
-
 \begin_layout Description
 inlinecompletion Inline completion color
 \end_layout
@@ -28160,16 +28163,10 @@ previewframe Preview frame color
 
 \begin_layout Description
 regexpframe Color for regexp frame
-\change_inserted -712698321 1505050082
-
 \end_layout
 
 \begin_layout Description
-
-\change_inserted -712698321 1505050082
 scroll Color that indicates when a row can be scrolled 
-\change_unchanged
-
 \end_layout
 
 \begin_layout Description