]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/Customization.lyx
Make doc/UserGuide.lyx independent of French and Spanish language LaTeX support.
[lyx.git] / lib / doc / Customization.lyx
index 27986fd7e3d8bf975b29ec88a1e435ff69620dc5..53e7687400e06edbc6856fec7fa633dc643a1229 100644 (file)
@@ -1,5 +1,5 @@
-#LyX 2.3 created this file. For more info see http://www.lyx.org/
-\lyxformat 544
+#LyX 2.4 created this file. For more info see https://www.lyx.org/
+\lyxformat 573
 \begin_document
 \begin_header
 \save_transient_properties true
@@ -44,8 +44,8 @@ logicalmkup
 \maintain_unincluded_children false
 \language english
 \language_package default
-\inputencoding auto
-\fontencoding global
+\inputencoding utf8
+\fontencoding auto
 \font_roman "lmodern" "default"
 \font_sans "lmss" "default"
 \font_typewriter "lmtt" "default"
@@ -124,12 +124,15 @@ logicalmkup
 \papercolumns 1
 \papersides 2
 \paperpagestyle headings
+\tablestyle default
 \tracking_changes true
 \output_changes false
 \html_math_output 0
 \html_css_as_file 0
 \html_be_strict true
 \author -712698321 "Jürgen Spitzmüller"
+\author -495245474 "Jean-Marc Lasgouttes"
+\author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
 \end_header
 
 \begin_body
@@ -6974,7 +6977,19 @@ Format
  Any format is acceptable, but one would normally use the format current
  at the time.
  (In \SpecialChar LyX
- 2.3, the current layout format is 63.)
+\begin_inset Info
+type  "lyxinfo"
+arg   "version"
+\end_inset
+
+, the current layout format is 
+\begin_inset Info
+type  "lyxinfo"
+arg   "layoutformat"
+\end_inset
+
+.)
 \end_layout
 
 \begin_layout Standard
@@ -7344,7 +7359,13 @@ DeclareLyXModule{My Class}
 \end_layout
 
 \begin_layout LyX-Code
-Format 63
+Format 
+\begin_inset Info
+type  "lyxinfo"
+arg   "layoutformat"
+\end_inset
+
+
 \begin_inset Newline newline
 \end_inset
 
@@ -8524,12 +8545,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
 
@@ -8577,10 +8625,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
 
@@ -10931,8 +10997,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
@@ -11781,6 +11995,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
@@ -13061,10 +13325,58 @@ FreeSpacing
 \end_inset
 
  can be enabled.
- Note that \SpecialChar LyX
- will create protected blanks for the additional blanks when
- in another mode than \SpecialChar LaTeX
+\change_deleted -495245474 1550490105
+Note that 
+\change_unchanged
+\SpecialChar LyX
+ will create protected blanks for the additional blanks when in 
+\change_inserted -495245474 1550490096
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -495245474 1550490089
+Passthru 1
+\end_layout
+
+\end_inset
+
+ is not specified.
+\change_deleted -495245474 1550490116
+another mode than \SpecialChar LaTeX
 -mode.
+
+\change_inserted -495245474 1550247760
+ Note that 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -495245474 1550247736
+FreeSpacing
+\end_layout
+
+\end_inset
+
+ implies 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -495245474 1550247755
+KeepEmpty
+\end_layout
+
+\end_inset
+
+.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -15029,7 +15341,7 @@ not
 
 \begin_layout Description
 
-\change_inserted -712698321 1523696969
+\change_inserted -712698321 1552395557
 \begin_inset Flex Code
 status collapsed
 
@@ -15091,16 +15403,18 @@ cprotect
 cprotect
 \family default
 ) if necessary and thus allows (some) verbatim stuff in macros.
-\change_unchanged
-
 \end_layout
 
 \begin_layout Description
+
+\change_inserted -712698321 1552395844
 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
-Newline
+
+\change_inserted -712698321 1552395561
+NeedMBoxProtect
 \end_layout
 
 \end_inset
@@ -15110,6 +15424,10 @@ Newline
 status collapsed
 
 \begin_layout Plain Layout
+
+\change_inserted -712698321 1552395557
+
+\emph on
 0
 \end_layout
 
@@ -15125,35 +15443,133 @@ status collapsed
 
 \begin_layout Plain Layout
 
-\emph on
+\change_inserted -712698321 1552395557
 1
 \end_layout
 
 \end_inset
 
-] Whether newlines are translated into \SpecialChar LaTeX
- newlines (
+] Whether specific commands in this style (such as 
 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
 
-\backslash
+\change_inserted -712698321 1552395655
 
 \backslash
+cite
+\change_unchanged
 
 \end_layout
 
 \end_inset
 
-) or not.
- The translation can be switched off to allow more comfortable \SpecialChar LaTeX
- editing
- inside \SpecialChar LyX
-.
-\end_layout
-
-\begin_layout Description
+ and 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395661
+
+\backslash
+ref
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+) should be protected in an 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395631
+
+\backslash
+mbox
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+ This is particularly needed for styles that draw on 
+\family sans
+ulem
+\family default
+ or 
+\family sans
+soul
+\family default
+ commands which parse their content in complex ways.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Newline
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Whether newlines are translated into \SpecialChar LaTeX
+ newlines (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+
+\backslash
+
+\end_layout
+
+\end_inset
+
+) or not.
+ The translation can be switched off to allow more comfortable \SpecialChar LaTeX
+ editing
+ inside \SpecialChar LyX
+.
+\end_layout
+
+\begin_layout Description
 \begin_inset Flex Code
 status collapsed
 
@@ -18778,6 +19194,34 @@ LatexName
 
  tags.
  Default is true.
+\change_inserted 731793113 1538674858
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 731793113 1538674891
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted 731793113 1538674863
+EditExternal
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\emph on
+0
+\emph default
+,1] Allow the contents of the inset to be edited externally (using whatever
+ editor is defined for the document's output format).
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -19862,6 +20306,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
@@ -20000,7 +20518,7 @@ not
 
 \begin_layout Description
 
-\change_inserted -712698321 1523634088
+\change_inserted -712698321 1552395786
 \begin_inset Flex Code
 status collapsed
 
@@ -20065,6 +20583,153 @@ cprotect
 \family default
 ) if necessary and thus allows (some) verbatim stuff in macros.
  Default is false.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1555579651
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395787
+NeedMBoxProtect
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395787
+
+\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 1552395787
+1
+\end_layout
+
+\end_inset
+
+] Whether specific commands in this inset (such as 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395787
+
+\backslash
+cite
+\end_layout
+
+\end_inset
+
+ and 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395787
+
+\backslash
+ref
+\end_layout
+
+\end_inset
+
+) should be protected in an 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1552395787
+
+\backslash
+mbox
+\end_layout
+
+\end_inset
+
+.
+ This is particularly needed for insets that draw on 
+\family sans
+ulem
+\family default
+ or 
+\family sans
+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