]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/Customization.lyx
UserGuide.lyx: load math packages automatically
[lyx.git] / lib / doc / Customization.lyx
index ae983cfb221819f242dfb94a87b6553bf6f58838..5e41ae52b207b043f5d2b4d86e2bd13c9a26e157 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.3 created this file. For more info see http://www.lyx.org/
-\lyxformat 528
+\lyxformat 541
 \begin_document
 \begin_header
 \save_transient_properties true
@@ -36,7 +36,7 @@
  }
 }{}
 \end_preamble
-\options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
+\options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
 \use_default_options false
 \begin_modules
 logicalmkup
@@ -57,6 +57,7 @@ logicalmkup
 \font_sf_scale 100 100
 \font_tt_scale 100 100
 \use_microtype false
+\use_dash_ligatures true
 \graphics default
 \default_output_format pdf2
 \output_sync 0
@@ -114,6 +115,7 @@ logicalmkup
 \tocdepth 3
 \paragraph_separation indent
 \paragraph_indentation default
+\is_math_indent 1
 \quotes_style english
 \dynamic_quotes 0
 \papercolumns 1
@@ -125,6 +127,7 @@ logicalmkup
 \html_css_as_file 0
 \html_be_strict true
 \author -712698321 "Jürgen Spitzmüller"
+\author 2047637253 "Guillaume Munch"
 \author 2089657418 "Usti"
 \end_header
 
@@ -150,6 +153,7 @@ n mailing list,
 LatexCommand href
 target "lyx-docs@lists.lyx.org"
 type "mailto:"
+literal "false"
 
 \end_inset
 
@@ -907,6 +911,49 @@ status collapsed
 .
  That is, the files define which items appear in which menus and the items
  appearing on the toolbar.
+\change_inserted -712698321 1490533733
+
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+
+\change_inserted -712698321 1490533849
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1490533738
+xtemplates/
+\end_layout
+
+\end_inset
+
+ contains files with the extension 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1490533759
+.xtemplate
+\end_layout
+
+\end_inset
+
+ which define the templates for the insertion of external material to a
+ \SpecialChar LyX
+ document; see 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:Including-External-Material"
+
+\end_inset
+
+.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Subsection
@@ -1003,6 +1050,8 @@ encodings
 
 \begin_layout Labeling
 \labelwidthstring 00.00.0000
+
+\change_deleted -712698321 1490533856
 \begin_inset Flex Code
 status collapsed
 
@@ -1034,6 +1083,8 @@ reference "chap:Including-External-Material"
 \end_inset
 
 .
+\change_unchanged
+
 \end_layout
 
 \begin_layout Labeling
@@ -1616,6 +1667,7 @@ MIME
 LatexCommand href
 name "IANA"
 target "http://www.iana.org/assignments/media-types/"
+literal "false"
 
 \end_inset
 
@@ -1626,6 +1678,7 @@ target "http://www.iana.org/assignments/media-types/"
 LatexCommand href
 name "freedesktop.org"
 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
+literal "false"
 
 \end_inset
 
@@ -3008,6 +3061,7 @@ Check out the \SpecialChar LyX
 LatexCommand href
 name "information on the web"
 target "http://www.lyx.org/HowToUseGIT"
+literal "false"
 
 \end_inset
 
@@ -3439,6 +3493,7 @@ Check out the documentation translation web page at
 LatexCommand href
 name "http://www.lyx.org/Translation"
 target "http://www.lyx.org/Translation"
+literal "false"
 
 \end_inset
 
@@ -3553,6 +3608,7 @@ Sometimes the original document (from the \SpecialChar LyX
 LatexCommand href
 name "http://www.lyx.org/trac/timeline"
 target "http://www.lyx.org/trac/timeline"
+literal "false"
 
 \end_inset
 
@@ -6032,6 +6088,7 @@ Get the package from
 LatexCommand href
 name "CTAN"
 target "http://www.ctan.org/"
+literal "false"
 
 \end_inset
 
@@ -6567,6 +6624,7 @@ As you prepare to write a new layout, it is extremely helpful to look at
 LatexCommand href
 name "layout section on the LyX wiki"
 target "http://wiki.lyx.org/Layouts/Layouts"
+literal "false"
 
 \end_inset
 
@@ -9929,6 +9987,76 @@ status collapsed
 \end_inset
 
 ] Deletes an existing style.
+\change_inserted 2047637253 1483900342
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 2047637253 1483900479
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 2047637253 1483900346
+OutlinerName
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 2047637253 1483900369
+<type>
+\end_layout
+
+\end_inset
+
+] [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 2047637253 1483900418
+<string>
+\end_layout
+
+\end_inset
+
+] Define a new table of contents with type 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 2047637253 1483900414
+<type>
+\end_layout
+
+\end_inset
+
+ and name 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 2047637253 1483900419
+<string>
+\end_layout
+
+\end_inset
+
+.
+ See also the AddToToc commands.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -11193,6 +11321,38 @@ End
 where the following commands are allowed:
 \end_layout
 
+\begin_layout Description
+
+\change_inserted 2047637253 1483963019
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 2047637253 1483901753
+AddToToc
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 2047637253 1483963007
+string
+\end_layout
+
+\end_inset
+
+=""] This paragraph will appear in the table of contents of the given type.
+ An empty string disables.
+ See also the OutlinerName and the IsTocCaption commands.
+ Default: disabled.
+\end_layout
+
 \begin_layout Description
 \begin_inset Flex Code
 status collapsed
@@ -12023,6 +12183,59 @@ Defines individual characters that should be output in raw form, meaning
  arguments.
  That is, arguments do not inherit PassThruChars from their parent inset
  or layout.
+\change_inserted 2047637253 1483899840
+
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted 2047637253 1483900841
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 2047637253 1483900841
+IsTocCaption
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 2047637253 1483900841
+
+\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 2047637253 1483900841
+1
+\end_layout
+
+\end_inset
+
+] If this is set to 1, the argument will output its content in the corresponding
+ item in the table of contents.
+ See AddToToc.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Standard
@@ -12883,6 +13096,55 @@ TitleLatexName
  global entries).
 \end_layout
 
+\begin_layout Description
+
+\change_inserted 2047637253 1483902824
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 2047637253 1483902211
+IsTocCaption
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 2047637253 1483902211
+
+\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 2047637253 1483902211
+1
+\end_layout
+
+\end_inset
+
+] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
+ of its contents in its item in the table of contents.
+ Otherwise, only the label, if it exists, appears.
+\end_layout
+
 \begin_layout Description
 \begin_inset Flex Code
 status collapsed
@@ -17833,6 +18095,39 @@ InsetLayout
  definition can contain the following entries:
 \end_layout
 
+\begin_layout Description
+
+\change_inserted 2047637253 1483963036
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 2047637253 1483900123
+AddToToc
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 2047637253 1483962897
+string
+\end_layout
+
+\end_inset
+
+=""] This inset will appear in the table of contents of the given type.
+ An empty string disables.
+ See also the OutlinerName and the IsTocCaption commands.
+ This is only implemented for Flex insets.
+ Default: disabled.
+\end_layout
+
 \begin_layout Description
 \begin_inset Flex Code
 status collapsed
@@ -18693,11 +18988,68 @@ status collapsed
 \end_inset
 
 ] Whether to include the contents of this inset in the strings generated
- for the `Outline' pane.
+ for the `Outline' pane
+\change_inserted 2047637253 1483900773
+ for all table of contents, regardless of the AddToToc setting
+\change_unchanged
+.
  One would not, for example, want the content of a footnote in a section
  header to be included in the TOC displayed in the outline, but one would
  normally want the content of a character style displayed.
  Default is false: not to include.
+\change_inserted 2047637253 1483900609
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 2047637253 1483901257
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 2047637253 1483900725
+IsTocCaption
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 2047637253 1483900620
+
+\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 2047637253 1483900620
+1
+\end_layout
+
+\end_inset
+
+] If this is set to 1 and AddToToc is enabled, the inset adds a summary
+ of its contents in its item in the table of contents.
+ Otherwise, only the label appears.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -21303,8 +21655,8 @@ The full syntax is:
 
 \begin_layout LyX-Code
 
-\change_inserted -712698321 1483870927
-LyXName|alias*<!_stardesc!_stardesctooltip>[][]=latexcmd
+\change_inserted -712698321 1484997816
+LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
 \end_layout
 
 \begin_layout Itemize
@@ -21753,11 +22105,50 @@ _stardesc Sta&rred command label
 
 \begin_layout LyX-Code
 
-\change_inserted -712698321 1483872184
+\change_inserted -712698321 1484997832
 _stardesctooltip Tooltip for the starred command checkbox.
 \end_layout
 
 \end_deeper
+\begin_layout Itemize
+
+\change_inserted -712698321 1484997948
+A dollar sign 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1484997871
+$
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ indicates that this command features 
+\begin_inset Quotes eld
+\end_inset
+
+qualified citation lists
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This is a 
+\family sans
+Biblatex
+\family default
+-specific feature for multi-reference citations where an individual pre-
+ and postnote can be given to each reference in the list.
+ Please refer to the 
+\family sans
+Biblatex
+\family default
+ manual for details.
+\end_layout
+
 \begin_layout Subsection
 \begin_inset CommandInset label
 LatexCommand label
@@ -22375,7 +22766,7 @@ status collapsed
 
 \begin_layout Itemize
 
-\change_inserted -712698321 1483978548
+\change_inserted -712698321 1484997600
 \begin_inset Flex Code
 status collapsed
 
@@ -22409,6 +22800,36 @@ status collapsed
 \end_inset
 
 )
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1484997681
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1484997608
+{%ifqualified%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the 
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ part if the current citation is a qualified citation list (a specific 
+\family sans
+Biblatex
+\family default
+ format for multi-reference citations), the false part if this is not the
+ case.
 \change_unchanged
 
 \end_layout
@@ -25283,6 +25704,10 @@ Besides supporting the production of different products according to the
 
 \begin_layout Section
 The external template configuration file
+\change_inserted -712698321 1490533960
+s
+\change_unchanged
+
 \end_layout
 
 \begin_layout Standard
@@ -25310,27 +25735,84 @@ Having said that, we encourage you to submit any interesting templates that
 \end_layout
 
 \begin_layout Standard
-The external templates are defined in the 
+The external templates are defined in the
+\change_inserted -712698321 1490534022
 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
-LyXDir/lib/external_templates
+
+\change_inserted -712698321 1490533996
+*.xtemplate
 \end_layout
 
 \end_inset
 
- file.
- You can place your own version in 
+ files that are stored in the
+\change_unchanged
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXDir/lib/
+\change_deleted -712698321 1490533984
+external_
+\change_inserted -712698321 1490533984
+x
+\change_unchanged
+templates
+\change_inserted -712698321 1490534077
+/
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+\change_deleted -712698321 1490534025
+file
+\change_inserted -712698321 1490534028
+directory
+\change_unchanged
+.
+\change_inserted -712698321 1490534233
+Each template is defined in a file of its own.
+\change_unchanged
+You can place your own 
+\change_deleted -712698321 1490534089
+version
+\change_inserted -712698321 1490534090
+templates
+\change_unchanged
+ in 
 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
-UserDir/external_templates
+UserDir/
+\change_deleted -712698321 1490534069
+external_
+\change_inserted -712698321 1490534069
+x
+\change_unchanged
+templates
+\change_inserted -712698321 1490534080
+/
+\change_unchanged
+
 \end_layout
 
 \end_inset
 
+
+\change_inserted -712698321 1490534112
+ or copy existing templates to that directory in order to modify them
+\change_unchanged
 .
 \end_layout