]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/Customization.lyx
Customization: use info-inset for layout format
[lyx.git] / lib / doc / Customization.lyx
index 2e8953012985f1f027e5d924a427343b6edcb5a6..ad79d65e3382c5f18d00dac403e0adec8511e574 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 564
 \begin_document
 \begin_header
 \save_transient_properties true
@@ -45,7 +45,7 @@ logicalmkup
 \language english
 \language_package default
 \inputencoding auto
-\fontencoding global
+\fontencoding auto
 \font_roman "lmodern" "default"
 \font_sans "lmss" "default"
 \font_typewriter "lmtt" "default"
@@ -124,11 +124,12 @@ logicalmkup
 \papercolumns 1
 \papersides 2
 \paperpagestyle headings
-\tracking_changes false
+\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"
 \end_header
 
 \begin_body
@@ -2408,6 +2409,10 @@ status collapsed
 
 \begin_layout Plain Layout
 latex
+\change_inserted -712698321 1524656940
+=flavor
+\change_unchanged
+
 \end_layout
 
 \end_inset
@@ -2417,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
@@ -2426,6 +2480,10 @@ status collapsed
 
 \begin_layout Plain Layout
 needaux
+\change_inserted -712698321 1524656935
+=flavor
+\change_unchanged
+
 \end_layout
 
 \end_inset
@@ -2442,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
@@ -2515,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
@@ -2622,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
@@ -2999,7 +3167,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
@@ -3111,9 +3279,7 @@ status open
 
 \begin_layout Plain Layout
 
-https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
-\backslash
-#PO-Mode
+https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
 \end_layout
 
 \end_inset
@@ -3430,8 +3596,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
@@ -3526,7 +3692,7 @@ status collapsed
 
 \begin_layout Plain Layout
 
-http://www.lyx.org/HowToUseGIT
+https://www.lyx.org/HowToUseGIT
 \end_layout
 
 \end_inset
@@ -3545,8 +3711,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
@@ -6565,7 +6731,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
@@ -6808,7 +6974,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
@@ -7178,7 +7356,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
 
@@ -8742,6 +8926,49 @@ status collapsed
  A module can contain any layout tag.)
 \end_layout
 
+\begin_layout Description
+
+\change_inserted -712698321 1526899478
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1526898610
+AddToCiteEngine <engine>
+\end_layout
+
+\end_inset
+
+ Extends the possibilities for displaying citation references.
+ See 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Citation-engine-description"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ for details.
+ Must end with 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1526898823
+End
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
 \begin_layout Description
 \begin_inset Flex Code
 status collapsed
@@ -8884,6 +9111,27 @@ noprefix "false"
 \end_inset
 
 ).
+
+\change_inserted -712698321 1526898530
+ Note that if you specify this in a layout file or module, any cite engine
+ definition will be overridden.
+ Also see 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1526898530
+AddToCiteEngine
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -8935,6 +9183,12 @@ noprefix "false"
 \end_inset
 
 ).
+
+\change_inserted -712698321 1526898585
+ A cite format defined in a layout or module will override the cite engine
+ definition.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -12157,6 +12411,87 @@ Argument item:1
 \end_inset
 
 ).
+\change_inserted -712698321 1534487781
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1534488561
+Finally, there is a special argument type with the prefix 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1534487844
+listpreamble:
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+ It is not really an argument, but uses the argument interface (thus, the
+ prefix is also followed by a number, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1534488412
+Argument listpreamble:1
+\end_layout
+
+\end_inset
+
+).
+ As the name implies, it is targeted at lists such as 
+\family sans
+Itemize
+\family default
+, 
+\family sans
+Enumerate
+\family default
+, 
+\family sans
+Description
+\family default
+, or 
+\family sans
+Bibliography
+\family default
+.
+ Its content will be output at the list start, before the first 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1534488058
+
+\backslash
+item
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, on an own line (a place that is otherwise not accessible in \SpecialChar LyX
+).
+ This way, users can insert redefinitions (of lengths etc.) to individual
+ lists.
+ By default, these arguments do not have a delimiter.
+\change_unchanged
+
 \end_layout
 
 \end_deeper
@@ -12164,6 +12499,51 @@ Argument item:1
 \begin_inset Flex Code
 status collapsed
 
+\begin_layout Plain Layout
+AutoNests
+\end_layout
+
+\end_inset
+
+ 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
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndAutoNests
+\end_layout
+
+\end_inset
+
+
+\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
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
 \begin_layout Plain Layout
 BabelPreamble
 \end_layout
@@ -12895,6 +13275,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
@@ -14616,6 +15041,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
@@ -19517,6 +20012,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
@@ -21738,6 +22306,36 @@ Biblatex
 Biblatex
 \family default
  manual for details.
+\change_inserted -712698321 1526898670
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1526899524
+If you want to add a cite command to a cite engine (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., add a specific command provided by a class), you can use 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1526898768
+AddToCiteEngine <engine type> \SpecialChar ldots
+ End
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+ Note that only cite commands that do not exist yet are added.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Subsection
@@ -22860,7 +23458,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
@@ -22871,13 +23469,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
 
@@ -22903,7 +23525,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
 
@@ -22914,7 +23536,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
@@ -22938,7 +23560,7 @@ author
 status collapsed
 
 \begin_layout Plain Layout
-_edtext
+B_edtext
 \end_layout
 
 \end_inset
@@ -27875,11 +28497,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
@@ -28021,11 +28643,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