]> git.lyx.org Git - features.git/blobdiff - lib/doc/Customization.lyx
Option to auto-insert a paragraph style option, particularly useful for specific...
[features.git] / lib / doc / Customization.lyx
index e733e8fec5dcc0147b9647345910288311f3236a..b852ed7a4384927f415da7c237274b59984bd7ea 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.1 created this file. For more info see http://www.lyx.org/
-\lyxformat 446
+\lyxformat 453
 \begin_document
 \begin_header
 \textclass scrbook
@@ -105,6 +105,7 @@ End
 \use_package mathdots 1
 \use_package mathtools 0
 \use_package mhchem 0
+\use_package stmaryrd 0
 \use_package undertilde 0
 \cite_engine basic
 \cite_engine_type numerical
@@ -140,6 +141,7 @@ End
 \author -712698321 "Jürgen Spitzmüller" 
 \author -195340706 "Georg Baum" 
 \author 5863208 "ab" 
+\author 155139281 "Jrgen Spitzmller" 
 \author 1082167584 "Kayvan Sylvan" kayvan@sylvan.com
 \author 1414654397 "Richard Heck" 
 \author 2090807402 "usti" 
@@ -10337,7 +10339,7 @@ Argument
 
 \begin_layout Itemize
 
-\change_inserted -712698321 1353691469
+\change_inserted -712698321 1355076779
 \begin_inset Flex Code
 status collapsed
 
@@ -10364,7 +10366,19 @@ status collapsed
 \end_inset
 
  The string that will appear both in the menu (to insert this argument)
- and on the argument inset button.
+ and on the argument inset button (unless you also specify a separate 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1355076779
+MenuString
+\end_layout
+
+\end_inset
+
+).
  For the menu, you can define an accelerator by appending the respective
  character to the string, divided by 
 \begin_inset Quotes eld
@@ -10405,6 +10419,85 @@ Short Title|S
 
 \begin_layout Itemize
 
+\change_inserted -712698321 1355076754
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1355076658
+MenuString
+\end_layout
+
+\end_inset
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1355076654
+[string]
+\end_layout
+
+\end_inset
+
+ A separate 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 Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1355076654
+\begin_inset Quotes eld
+\end_inset
+
+Short Title|S
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+).
+ This specification is optional.
+ If it is not given the 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1355076736
+LabelString
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ will be used instead for the menu.
+\end_layout
+
+\begin_layout Itemize
+
 \change_inserted -712698321 1353680665
 \begin_inset Flex Code
 status collapsed
@@ -10501,7 +10594,7 @@ status collapsed
 
 \begin_layout Itemize
 
-\change_inserted -712698321 1353681232
+\change_inserted -712698321 1353917199
 \begin_inset Flex Code
 status collapsed
 
@@ -10582,7 +10675,7 @@ Argument 2
 
 \begin_layout Itemize
 
-\change_inserted -712698321 1353681145
+\change_inserted -712698321 1354263104
 \begin_inset Flex Code
 status collapsed
 
@@ -10637,11 +10730,26 @@ status collapsed
 \end_inset
 
 ).
+ A line break in the output can be indicated by 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354263104
+<br/>
+\end_layout
+
+\end_inset
+
+.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Itemize
 
-\change_inserted -712698321 1353681155
+\change_inserted -712698321 1355144479
 \begin_inset Flex Code
 status collapsed
 
@@ -10677,19 +10785,309 @@ status collapsed
 
 \end_inset
 
- or 
+ or 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353681161
+]
+\end_layout
+
+\end_inset
+
+).
+ A line break in the output can be indicated by 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354263106
+<br/>
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1355144578
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1355144487
+PresetArg
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1355144500
+[string]
+\end_layout
+
+\end_inset
+
+ defines an argument that is inserted in any case (alone or in addition
+ to user-specified arguments).
+ Multiple arguments need to be separated by comma.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1353917320
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353917320
+Font
+\end_layout
+
+\end_inset
+
+ The font used for the argument content.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1353917320
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353917320
+LabelFont
+\end_layout
+
+\end_inset
+
+ The font used for the label.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1355661048
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353917320
+Decoration
+\end_layout
+
+\end_inset
+
+ can be 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353917320
+Classic
+\end_layout
+
+\end_inset
+
+, 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353917320
+Minimalistic
+\end_layout
+
+\end_inset
+
+, or 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353917320
+Conglomerate
+\end_layout
+
+\end_inset
+
+, describing the rendering style used for the inset's frame and buttons.
+ Default is 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353917320
+Classic
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1355661160
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1355661057
+AutoInsert
+\end_layout
+
+\end_inset
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1355661049
+[int=0]
+\end_layout
+
+\end_inset
+
+ If this is set to 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1355661077
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, this argument is automatically inserted when the respective style is selected.
+ This option is currently only available for paragraph styles, not for InsetLayo
+uts.
+\change_inserted 155139281 1354198988
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 155139281 1354199102
+Arguments for list 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 155139281 1354199013
+
+\backslash
+item
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+s (as in 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 155139281 1354199102
+
+\backslash
+item[foo]
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+) have the prefix 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 155139281 1354199044
+item:
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ followed by the number (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
 
-\change_inserted -712698321 1353681161
-]
+\change_inserted 155139281 1354199064
+Argument item:1
+\change_unchanged
+
 \end_layout
 
 \end_inset
 
-).
+)
 \change_unchanged
 
 \end_layout
@@ -12175,7 +12573,42 @@ LatexName
 \end_inset
 
  stuff.
- This parameter cannot be changed from within LyX.
+ This parameter cannot be changed from within LyX
+\change_inserted -712698321 1355144804
+ (use 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1355144804
+Argument
+\end_layout
+
+\end_inset
+
+ for customizable parameters)
+\change_unchanged
+.
+
+\change_inserted -712698321 1355144804
+ This will be output as is after all LaTeX 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1355144658
+Arguments
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -12444,7 +12877,7 @@ depending upon the LaTeX type.
 \end_deeper
 \begin_layout Description
 
-\change_inserted -712698321 1353866861
+\change_inserted -712698321 1354263086
 \begin_inset Flex Code
 status collapsed
 
@@ -12469,6 +12902,21 @@ string
 \end_inset
 
 ] A string that is put at the beginning of the style content.
+ A line break in the output can be indicated by 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354263086
+<br/>
+\end_layout
+
+\end_inset
+
+.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -13473,7 +13921,7 @@ CopyStyle
 
 \begin_layout Description
 
-\change_inserted -712698321 1353866881
+\change_inserted -712698321 1354263074
 \begin_inset Flex Code
 status collapsed
 
@@ -13498,6 +13946,21 @@ string
 \end_inset
 
 ] A string that is put at the end of the layout content.
+ A line break in the output can be indicated by 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354263069
+<br/>
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
 \end_layout
 
 \begin_layout Description
@@ -15836,6 +16299,81 @@ LabelFont
 \end_inset
 
  later if you want them to be different.
+\change_inserted 155139281 1354130923
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 155139281 1354130923
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 155139281 1354130923
+ForceLocalFontSwitch
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 155139281 1354130923
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 155139281 1354130923
+1
+\end_layout
+
+\end_inset
+
+] When using babel, always use a local font switch (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 155139281 1354130923
+
+\backslash
+foreignlanguage
+\end_layout
+
+\end_inset
+
+), never a global one (such as 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 155139281 1354130923
+
+\backslash
+selectlanguage
+\end_layout
+
+\end_inset
+
+).
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -16212,7 +16750,40 @@ status collapsed
 \end_inset
 
 .
- This parameter cannot be changed from within LyX.
+\change_inserted -712698321 1355144715
+This will be output as is after all LaTeX 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1355144713
+Arguments
+\end_layout
+
+\end_inset
+
+.
+\change_unchanged
+This parameter cannot be changed from within LyX
+\change_inserted -712698321 1355144775
+ (use 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1355144747
+Argument
+\end_layout
+
+\end_inset
+
+ for customizable parameters)
+\change_unchanged
+.
 \end_layout
 
 \begin_layout Description
@@ -16231,10 +16802,20 @@ status collapsed
 
 \begin_layout Plain Layout
 
+\change_deleted -712698321 1353867544
+
 \emph on
 Paragraph
 \emph default
-, Command, Environment, Item_Environment,
+, 
+\change_unchanged
+Command, Environment, 
+\change_inserted -712698321 1353867573
+None
+\change_deleted -712698321 1353867557
+Item_Environment,
+\change_unchanged
+
 \end_layout
 
 \end_inset
@@ -16244,7 +16825,15 @@ Paragraph
 status collapsed
 
 \begin_layout Plain Layout
-List_Environment, Bib_Environment
+
+\change_deleted -712698321 1353867564
+List_Environment
+\change_unchanged
+, 
+\change_deleted -712698321 1353867569
+Bib_Environment
+\change_unchanged
+
 \end_layout
 
 \end_inset
@@ -16278,7 +16867,13 @@ LatexType
 status collapsed
 
 \begin_layout Plain Layout
+
+\change_deleted -712698321 1353867582
 Paragraph
+\change_inserted -712698321 1353867583
+None
+\change_unchanged
+
 \end_layout
 
 \end_inset
@@ -16355,6 +16950,8 @@ LatexName
 \end_layout
 
 \begin_layout Itemize
+
+\change_deleted -712698321 1353867600
 \begin_inset Flex Code
 status collapsed
 
@@ -16391,6 +16988,8 @@ item
 \end_layout
 
 \begin_layout Itemize
+
+\change_deleted -712698321 1353867600
 \begin_inset Flex Code
 status collapsed
 
@@ -16456,6 +17055,8 @@ settings
 
  dialog.
  
+\change_unchanged
+
 \end_layout
 
 \begin_layout Standard
@@ -16489,7 +17090,7 @@ depending upon the LaTeX type.
 \end_deeper
 \begin_layout Description
 
-\change_inserted -712698321 1353866797
+\change_inserted -712698321 1354263128
 \begin_inset Flex Code
 status collapsed
 
@@ -16516,6 +17117,19 @@ string
 \end_inset
 
 ] A string that is put at the beginning of the layout content.
+ A line break in the output can be indicated by 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354263128
+<br/>
+\end_layout
+
+\end_inset
+
+.
 \change_unchanged
 
 \end_layout
@@ -16945,7 +17559,81 @@ reference "des:FreeSpacing"
 \end_inset
 
 ) for information on `features'.
+\change_inserted -712698321 1354439699
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1354439705
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354439699
+ResetArgs
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354439699
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354439699
+1
+\end_layout
+
+\end_inset
+
+] Resets the LaTeX arguments of this layout (as defined via the 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354439699
+Argument
+\end_layout
+
+\end_inset
+
+ tag).
+ This is useful if you have copied a style via 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354439699
+CopyStyle
+\end_layout
+
+\end_inset
+
+, but you do not want to inherit its (required and optional) arguments.
+
+\change_deleted -712698321 1354439698
  
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -16989,7 +17677,7 @@ status collapsed
 
 \begin_layout Description
 
-\change_inserted -712698321 1353866814
+\change_inserted -712698321 1354263134
 \begin_inset Flex Code
 status collapsed
 
@@ -17014,6 +17702,19 @@ string
 \end_inset
 
 ] A string that is put at the end of the layout content.
+ A line break in the output can be indicated by 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354263134
+<br/>
+\end_layout
+
+\end_inset
+
+.
 \change_unchanged
 
 \end_layout