]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/Customization.lyx
de/EmbeddedObjects: make compilable with utf8 encoding
[lyx.git] / lib / doc / Customization.lyx
index cf6d7bab7481806bada59b0949d0be1d8e9c577d..9e7c136fa796b6a8f23de67fd940bbea4c9c2c66 100644 (file)
@@ -2409,6 +2409,10 @@ status collapsed
 
 \begin_layout Plain Layout
 latex
+\change_inserted -712698321 1524656940
+=flavor
+\change_unchanged
+
 \end_layout
 
 \end_inset
@@ -2418,6 +2422,55 @@ latex
  This will make \SpecialChar LyX
 's \SpecialChar LaTeX
  error logs available.
+
+\change_inserted -712698321 1524657018
+ The optional 
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657012
+flavor
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ value specifies the form of \SpecialChar LaTeX
+ that is run (
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657005
+latex, pdflatex, platex, xetex, luatex
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+).
+ If no value is specified, 
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657018
+latex
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ is used.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Labeling
@@ -2427,6 +2480,10 @@ status collapsed
 
 \begin_layout Plain Layout
 needaux
+\change_inserted -712698321 1524656935
+=flavor
+\change_unchanged
+
 \end_layout
 
 \end_inset
@@ -2443,6 +2500,61 @@ status collapsed
 \end_inset
 
  file for the conversion.
+
+\change_inserted -712698321 1524657047
+ The optional 
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657030
+flavor
+\end_layout
+
+\end_inset
+
+ value specifies the form of \SpecialChar LaTeX
+ that is run in order to generate the 
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657047
+.aux
+\end_layout
+
+\end_inset
+
+ file (
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657030
+latex, pdflatex, platex, xetex, luatex
+\end_layout
+
+\end_inset
+
+).
+ If no value is specified, 
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657030
+latex
+\end_layout
+
+\end_inset
+
+ is used.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Labeling
@@ -2516,6 +2628,35 @@ value
  format:
 \end_layout
 
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+
+\change_inserted -712698321 1523206314
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523206193
+hyperref-driver
+\end_layout
+
+\end_inset
+
+ The name of the driver that needs to be loaded with the 
+\family sans
+hyperref
+\family default
+ package for this converter.
+ The loading of the correct driver is necessary to get some PDF-specific
+ features.
+ See the 
+\family sans
+hyperref
+\family default
+ manual for details.
+\end_layout
+
 \begin_layout Labeling
 \labelwidthstring 00.00.0000
 \begin_inset Flex Code
@@ -2623,8 +2764,34 @@ $$b
 \end_layout
 
 \begin_layout Standard
-None of these last three are presently used in any of the converters that
- are installed with \SpecialChar LyX
+
+\change_inserted -712698321 1523206384
+A suitable hyperref-driver is set for some converters that are installed
+ with \SpecialChar LyX
+.
+\change_deleted -712698321 1523206388
+None of these
+\change_inserted -712698321 1523206389
+The
+\change_unchanged
+ last three
+\change_inserted -712698321 1523206400
+ flags, however,
+\change_unchanged
+ are presently 
+\change_inserted -712698321 1523206407
+not 
+\change_unchanged
+used in any of the 
+\change_inserted -712698321 1523206437
+pre-installed 
+\change_unchanged
+converters
+\change_deleted -712698321 1523206442
+ that are installed with \SpecialChar LyX
+
+\change_unchanged
 .
  
 \end_layout
@@ -12162,22 +12329,19 @@ Argument item:1
 
 \end_deeper
 \begin_layout Description
-
-\change_inserted -712698321 1514534780
 \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) 
+ 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
 
@@ -12186,8 +12350,6 @@ AutoNests
 status collapsed
 
 \begin_layout Plain Layout
-
-\change_inserted -712698321 1514538124
 EndAutoNests
 \end_layout
 
@@ -12197,6 +12359,17 @@ EndAutoNests
 \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
 
@@ -12935,6 +13108,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
@@ -14656,6 +14874,76 @@ protect
 not
 \emph default
  whether this command should itself be protected.)
+\change_inserted -712698321 1523696949
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1523696969
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523696950
+NeedCProtect
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523696950
+
+\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 1523696950
+1
+\end_layout
+
+\end_inset
+
+] This causes macros that contain this layout to be protected with 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523696950
+
+\backslash
+cprotect
+\end_layout
+
+\end_inset
+
+ (cf.
+ package 
+\family sans
+cprotect
+\family default
+) if necessary and thus allows (some) verbatim stuff in macros.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -19557,6 +19845,79 @@ protect
 not
 \emph default
  whether the command should itself be protected.) Default is false.
+\change_inserted -712698321 1523633958
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1523634088
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523633961
+NeedCProtect
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523633958
+
+\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 1523633958
+1
+\end_layout
+
+\end_inset
+
+] This causes macros that contain this inset to be protected with 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523634038
+
+\backslash
+cprotect
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ (cf.
+ package 
+\family sans
+cprotect
+\family default
+) if necessary and thus allows (some) verbatim stuff in macros.
+ Default is false.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -22900,7 +23261,7 @@ The second sort of special definition might look like this:
 \end_layout
 
 \begin_layout LyX-Code
-_pptext pp.
+B_pptext pp.
 \end_layout
 
 \begin_layout Standard
@@ -22911,13 +23272,37 @@ This defines a translatable piece of text, which allows relevant parts of
 status collapsed
 
 \begin_layout Plain Layout
-%_pptext%
+%B_pptext%
 \end_layout
 
 \end_inset
 
 .
- Several of these are predefined in 
+ Note that there are two different translation paths: All definitions starting
+ with 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+B_
+\end_layout
+
+\end_inset
+
+, such as in the example above, will be translated to the currently active
+ buffer language (so the translation will match the generated document).
+ All definitions starting with underscore only will be translated to the
+ GUI language.
+ This is the proper translation for strings that only occur in the dialogs
+ or on buttons, such as this one:
+\end_layout
+
+\begin_layout LyX-Code
+_addtobib Add to bibliography only.
+\end_layout
+
+\begin_layout Standard
+Several of these translatable strings are predefined in 
 \begin_inset Flex Code
 status collapsed
 
@@ -22943,7 +23328,7 @@ status collapsed
 \end_layout
 
 \begin_layout Standard
-So here then is an example that use all these features:
+So here then is an example that uses several of these features:
 \begin_inset VSpace defskip
 \end_inset
 
@@ -22954,7 +23339,7 @@ So here then is an example that use all these features:
 \noindent
 
 \family sans
-!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
+!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
 \end_layout
 
 \begin_layout Standard
@@ -22978,7 +23363,7 @@ author
 status collapsed
 
 \begin_layout Plain Layout
-_edtext
+B_edtext
 \end_layout
 
 \end_inset
@@ -27915,11 +28300,11 @@ commandframe Frame color for command insets
 \end_layout
 
 \begin_layout Description
-commentbg Background color of comments
+comment Label color for comments
 \end_layout
 
 \begin_layout Description
-commentlabel Label color for comments
+commentbg Background color of comments
 \end_layout
 
 \begin_layout Description
@@ -28061,11 +28446,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