]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/Customization.lyx
Some corrections to the Russian User Guide, by Yuriy
[lyx.git] / lib / doc / Customization.lyx
index 9aeabd5d4f30e618bc954455714e3571327b9d88..0a90aaefb5aa5b8467595f776b92a81770639012 100644 (file)
@@ -1,9 +1,9 @@
 #LyX 2.4 created this file. For more info see https://www.lyx.org/
-\lyxformat 567
+\lyxformat 587
 \begin_document
 \begin_header
 \save_transient_properties true
-\origin /buildlyxdir/doc/
+\origin /systemlyxdir/doc/
 \textclass scrbook
 \begin_preamble
 % DO NOT ALTER THIS PREAMBLE!!!
@@ -44,7 +44,7 @@ logicalmkup
 \maintain_unincluded_children false
 \language english
 \language_package default
-\inputencoding auto
+\inputencoding utf8
 \fontencoding auto
 \font_roman "lmodern" "default"
 \font_sans "lmss" "default"
@@ -53,7 +53,9 @@ logicalmkup
 \font_default_family default
 \use_non_tex_fonts false
 \font_sc false
-\font_osf false
+\font_roman_osf false
+\font_sans_osf false
+\font_typewriter_osf false
 \font_sf_scale 100 100
 \font_tt_scale 100 100
 \use_microtype false
@@ -102,6 +104,7 @@ logicalmkup
 \justification true
 \use_refstyle 0
 \use_minted 0
+\use_lineno 0
 \notefontcolor #0000ff
 \branch OutDated
 \selected 0
@@ -124,6 +127,7 @@ logicalmkup
 \papercolumns 1
 \papersides 2
 \paperpagestyle headings
+\tablestyle default
 \tracking_changes true
 \output_changes false
 \html_math_output 0
@@ -8544,12 +8548,39 @@ A module must begin with a line like the following:
 \begin_layout LyX-Code
 #
 \backslash
-DeclareLyXModule[endnotes.sty]{Endnotes} 
+DeclareLyXModule[endnotes.sty]{Endnotes}
+\change_inserted -712698321 1554395911
+
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -712698321 1554395924
+
+\size small
+#
+\backslash
+DeclareCategory{Foot- and Endnotes}
+\change_deleted -712698321 1554395911
+
+\size default
+\change_unchanged
+
 \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
+\change_inserted -712698321 1554395956
+ of 
+\family typewriter
+
+\backslash
+DeclareLyXModule
+\change_unchanged
+
+\family default
+, in curly brackets, is the name of the module, as it should appear in 
 \begin_inset Flex Noun
 status collapsed
 
@@ -8597,10 +8628,28 @@ to
 \end_inset
 
 '.
+
+\change_inserted -712698321 1554396133
+ The 
+\family typewriter
+
+\backslash
+DeclareCategory
+\family default
+ declaration is not strictly mandatory, but you should add it, since it
+ is helpful to find the module.
+ Please have a look at the existing module categories and if appropriate,
+ use one of those.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Standard
-The module declaration should then be followed by lines like the following:
+The module 
+\change_inserted -712698321 1554395988
+and category 
+\change_unchanged
+declaration should then be followed by lines like the following:
 \begin_inset Foot
 status collapsed
 
@@ -9059,6 +9108,87 @@ EndPreamble
 \end_inset
 
 .
+\change_inserted -712698321 1562592950
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1562593040
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1562592954
+BibInToc
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1562592950
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1562592950
+1
+\end_layout
+
+\end_inset
+
+] If the document class adds the bibliography to the table of contents,
+ add this option with value 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1562592996
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ (or 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1562593006
+true
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+).
+ This prevents the bibliography from being added twice.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -10372,6 +10502,45 @@ natbib
 \end_inset
 
 .)
+\change_inserted -712698321 1565102364
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1565102470
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565102365
+PageSize
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565105222
+
+\emph on
+custom
+\emph default
+, letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
+ b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
+\end_layout
+
+\end_inset
+
+] The default page size.
+ This is used by some converters.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -10951,8 +11120,156 @@ reference "subsec:Paragraph-Styles"
 \end_inset
 
  for details on paragraph styles.
+\change_inserted -712698321 1553617804
+
 \end_layout
 
+\begin_layout Description
+
+\change_inserted -712698321 1553617862
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1553617809
+TableStyle
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1553617805
+<name>
+\end_layout
+
+\end_inset
+
+] defines the default table style that is used when inserting a table.
+ The following styles are available:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+
+\change_inserted -712698321 1554308039
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1554307928
+Formal_with_Footline
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+: formal (
+\begin_inset Quotes eld
+\end_inset
+
+booktabs
+\begin_inset Quotes erd
+\end_inset
+
+) style with horizontal lines only, using a bold top and bottom line, the
+ first and last row are additionally separated from the table body with
+ a thin middle line.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1554308087
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1554308042
+Formal_without_Footline
+\end_layout
+
+\end_inset
+
+: same as the above, but the last row is not separated with a middle line
+ from the body.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1553618031
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1553618006
+Simple_Grid
+\end_layout
+
+\end_inset
+
+: Simple table lines.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1553618309
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1553618031
+Grid_with_Head
+\end_layout
+
+\end_inset
+
+: Like 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1553618043
+Simple_Grid
+\end_layout
+
+\end_inset
+
+, but with the header column offset with a second horizontal line.
+ This is also the default style of \SpecialChar LyX
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1553618280
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1553618261
+No_Borders
+\end_layout
+
+\end_inset
+
+: Table without lines.
+\change_unchanged
+
+\end_layout
+
+\end_deeper
 \begin_layout Description
 \begin_inset Flex Code
 status collapsed
@@ -11216,6 +11533,68 @@ status collapsed
 \end_inset
 
 .
+
+\change_inserted -712698321 1565110196
+ Any number is possible.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1565110259
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565110199
+FontSizeFormat
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565110196
+string
+\end_layout
+
+\end_inset
+
+] The format for the font size option.
+ Default: 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565110238
+$$spt
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565110248
+$$s
+\end_layout
+
+\end_inset
+
+ is a placeholder for the font size.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -11242,6 +11621,147 @@ g.: PUBLIC
 \end_inset
 
 .
+\change_inserted -712698321 1565101761
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1565180598
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565101918
+PageSize
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565105399
+string="letter|\SpecialChar allowbreak
+legal|\SpecialChar allowbreak
+executive|\SpecialChar allowbreak
+a0|\SpecialChar allowbreak
+a1|\SpecialChar allowbreak
+a2|\SpecialChar allowbreak
+a3|\SpecialChar allowbreak
+a4|\SpecialChar allowbreak
+a5|\SpecialChar allowbreak
+a6|\SpecialChar allowbreak
+b0|\SpecialChar allowbreak
+b1|\SpecialChar allowbreak
+b2|\SpecialChar allowbreak
+b3|\SpecialChar allowbreak
+b4|\SpecialChar allowbreak
+b5|\SpecialChar allowbreak
+b6|\SpecialChar allowbreak
+c0|\SpecialChar allowbreak
+c1|\SpecialChar allowbreak
+c
+2|\SpecialChar allowbreak
+c3|\SpecialChar allowbreak
+c4|\SpecialChar allowbreak
+c5|\SpecialChar allowbreak
+c6|\SpecialChar allowbreak
+b0j|\SpecialChar allowbreak
+b1j|\SpecialChar allowbreak
+b2j|\SpecialChar allowbreak
+b3j|\SpecialChar allowbreak
+b4j|\SpecialChar allowbreak
+b5j|\SpecialChar allowbreak
+b6j"
+\end_layout
+
+\end_inset
+
+] The list of available page sizes, separated by 
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565101779
+|
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Currently, only the listed sizes are supported.
+ Other sizes might be entered as custom class option.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1565180623
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565180605
+PageSizeFormat
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565180601
+string
+\end_layout
+
+\end_inset
+
+] The format for the page size option.
+ Default: 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565180618
+$$spaper
+\end_layout
+
+\end_inset
+
+.
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565180601
+$$s
+\end_layout
+
+\end_inset
+
+ is a placeholder for the paper size.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -11801,6 +12321,56 @@ status collapsed
 \end_inset
 
 
+\change_inserted -712698321 1555579782
+
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1555579780
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555579780
+NewlineCmd
+\end_layout
+
+\end_inset
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555579780
+[string]
+\end_layout
+
+\end_inset
+
+ Option to define a different command (from the default 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555579780
+
+\backslash
+
+\backslash
+
+\end_layout
+
+\end_inset
+
+) to be used for line breaks.
+ The initial backslash must not be specified.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Itemize
@@ -12034,24 +12604,82 @@ status collapsed
  Multiple arguments need to be separated by comma.
 \end_layout
 
-\begin_layout Itemize
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\end_layout
+
+\end_inset
+
+ The font used for the argument content, see 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
+\end_inset
+
+.
+\change_inserted -712698321 1559484228
+
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1559484228
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559484228
+FreeSpacing
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559484228
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
-Font
+
+\change_inserted -712698321 1559484228
+1
 \end_layout
 
 \end_inset
 
- The font used for the argument content, see 
+] As with paragraph styles, see 
 \begin_inset CommandInset ref
 LatexCommand ref
-reference "subsec:Font-description"
+reference "subsec:Paragraph-Styles"
 
 \end_inset
 
 .
+\change_unchanged
+
 \end_layout
 
 \begin_layout Itemize
@@ -12132,8 +12760,65 @@ status collapsed
 \end_inset
 
 , this argument is automatically inserted when the respective style is selected.
+
+\change_deleted -712698321 1559484200
  Currently, only one argument per style\SpecialChar breakableslash
 layout can be automatically inserted.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1559491402
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559490711
+InsertOnNewline
+\end_layout
+
+\end_inset
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559490703
+[int=0]
+\end_layout
+
+\end_inset
+
+ If this is set to 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559490703
+1
+\end_layout
+
+\end_inset
+
+, this argument will be inserted on a new line with 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491402
+AutoInsert
+\end_layout
+
+\end_inset
+
+ (only available within Flex insets).
 \end_layout
 
 \begin_layout Itemize
@@ -17721,6 +18406,46 @@ OFF
 \end_inset
 
 , which must be all caps.
+\change_inserted -712698321 1565605014
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1565605014
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565605014
+Requires
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1565605014
+string
+\end_layout
+
+\end_inset
+
+] As with paragraph styles, see 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -20062,6 +20787,80 @@ LyxType
 \end_inset
 
 .
+\change_inserted -712698321 1555575738
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1555575844
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555575740
+MenuString
+\end_layout
+
+\end_inset
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555575740
+[string]
+\end_layout
+
+\end_inset
+
+ A dedicated string for the menu.
+ You can define an accelerator by appending the respective character to
+ the string, divided by 
+\begin_inset Quotes eld
+\end_inset
+
+|
+\begin_inset Quotes erd
+\end_inset
+
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555575781
+My Inset|M
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+).
+ This specification is optional.
+ If it is not given the inset name as specified in the type declaration
+ will be used instead for the menu.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -20269,7 +21068,7 @@ cprotect
 
 \begin_layout Description
 
-\change_inserted -712698321 1552395824
+\change_inserted -712698321 1555579651
 \begin_inset Flex Code
 status collapsed
 
@@ -20364,6 +21163,54 @@ soul
 \family default
  commands which parse their content in complex ways.
  Default is false.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1555579742
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555579658
+NewlineCmd
+\end_layout
+
+\end_inset
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555579651
+[string]
+\end_layout
+
+\end_inset
+
+ Option to define a different command (from the default 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555579742
+
+\backslash
+
+\backslash
+
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+) to be used for line breaks.
+ The initial backslash must not be specified.
 \change_unchanged
 
 \end_layout
@@ -20453,6 +21300,74 @@ InsetLayout
 \end_inset
 
 , while keeping backward compatibility.
+\change_inserted -712698321 1559491850
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1559492002
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491854
+ParbreakIgnored
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491850
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491850
+1
+\end_layout
+
+\end_inset
+
+] If this is set to 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491881
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, paragraph breaks will be ignored in the output.
+ This might be useful for insets where the content should be alignable on
+ different lines only in the \SpecialChar LyX
+ workarea, without any effect in the output.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -28604,7 +29519,7 @@ Static colors
 \end_layout
 
 \begin_layout Standard
-These are fixed colors that cannot me customized:
+These are fixed colors that cannot be customized:
 \end_layout
 
 \begin_layout Description