]> git.lyx.org Git - features.git/blobdiff - lib/doc/UserGuide.lyx
UserGuide: decimal separator updates.
[features.git] / lib / doc / UserGuide.lyx
index 3fcb051133e82ebbefe1bf79d147d1a88e575d0e..097bbfa30073167ff3d9dfb68145f2ac8aaeac54 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.4 created this file. For more info see https://www.lyx.org/
-\lyxformat 573
+\lyxformat 583
 \begin_document
 \begin_header
 \save_transient_properties true
@@ -60,22 +60,26 @@ logicalmkup
 \inputencoding utf8
 \fontencoding auto
 \font_roman "lmodern" "default"
-\font_sans "lmss" "default"
-\font_typewriter "lmtt" "default"
+\font_sans "default" "default"
+\font_typewriter "default" "default"
 \font_math "auto" "auto"
 \font_default_family default
 \use_non_tex_fonts false
 \font_sc false
-\font_osf false
+\font_roman_osf false
+\font_sans_osf false
+\font_typewriter_osf false
 \font_sf_scale 100 100
 \font_tt_scale 100 100
 \use_microtype false
 \use_dash_ligatures false
 \graphics default
-\default_output_format pdf2
+\default_output_format default
 \output_sync 0
 \bibtex_command bibtex
 \index_command default
+\float_placement class
+\float_alignment class
 \paperfontsize 12
 \spacing single
 \use_hyperref true
@@ -115,6 +119,7 @@ logicalmkup
 \justification true
 \use_refstyle 1
 \use_minted 0
+\use_lineno 0
 \notefontcolor #0000ff
 \branch Question
 \selected 1
@@ -147,7 +152,10 @@ logicalmkup
 \html_math_output 0
 \html_css_as_file 0
 \html_be_strict true
+\author -1402925745 "Günter Milde"
 \author -712698321 "Jürgen Spitzmüller"
+\author -563046850 "Jean-Marc LASGOUTTES"
+\author 5863208 "ab"
 \end_header
 
 \begin_body
@@ -2336,7 +2344,15 @@ Return
 \begin_layout Standard
 The completion options for math in the preferences do the same as the correspond
 ing options for text.
- The special math option 
+\change_inserted -563046850 1560340017
+Additionally, 
+\change_deleted -563046850 1560340019
+T
+\change_inserted -563046850 1560340019
+t
+\change_unchanged
+he special math option 
 \family sans
 Autocorrection
 \family default
@@ -2366,13 +2382,56 @@ autocorrect
 \family default
  that is in \SpecialChar LyX
 's installation folder.
- Math autocorrection can at any time be turned on by pressing the exclamation
+\change_deleted -563046850 1560340086
+Math autocorrection can at any time be turned on by pressing the exclamation
  mark key “!”.
  Pressing 
 \family sans
 Space
 \family default
  turns it off.
+\change_inserted -563046850 1560340324
+Note that using 
+\family sans
+Undo
+\family default
+ after autocorrection has done its magic leaves the un-corrected sequence.
+ In the example above, 
+\family sans
+Undo
+\family default
+ leads to 
+\begin_inset Quotes eld
+\end_inset
+
+
+\series bold
+=>
+\series default
+
+\begin_inset Quotes erd
+\end_inset
+
+, and a second 
+\family sans
+Undo
+\family default
+ yields 
+\begin_inset Quotes eld
+\end_inset
+
+
+\series bold
+=
+\series default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Section
@@ -8424,14 +8483,12 @@ Verbatim
 \end_layout
 
 \begin_layout Verbatim
-
 This is Verbatim.
 \end_layout
 
 \begin_layout Verbatim
 \noindent
 \align block
-
 The following 2 lines are empty:
 \end_layout
 
@@ -8444,7 +8501,6 @@ The following 2 lines are empty:
 \end_layout
 
 \begin_layout Verbatim
-
 Almost everything is allowed in Verbatim:"%&$§#~'`
 \backslash
 }][{|
@@ -8468,7 +8524,6 @@ Verbatim
 \end_layout
 
 \begin_layout Verbatim*
-
 This is Verbatim*.
 \end_layout
 
@@ -13450,6 +13505,27 @@ Use True Small Caps
  of scaled capitals.
  Real small caps are often part of expert font sets; they generally look
  better than faked small caps but might have to be purchased separately.
+\change_inserted -712698321 1563000270
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1563000448
+Furthermore, with some fonts, you can add additional (comma-separated) options
+ provided by the font package (or the 
+\family sans
+fontspec
+\family default
+ package, if you use non-TeX fonts), into the 
+\family sans
+Options
+\family default
+ field.
+ This presupposes that you are familiar with the respective \SpecialChar LaTeX
+ font package.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Standard
@@ -17912,7 +17988,13 @@ ligature dashes
 
  (-- and ---).
  \SpecialChar LaTeX
- allows line breaks after hyphens, en-dashes and em-dashes.
+ allows line breaks after hyphens
+\change_deleted -1402925745 1558782973
+,
+\change_inserted -1402925745 1558782983
+ and these
+\change_unchanged
+ en-dashes and em-dashes.
 \end_layout
 
 \begin_layout Enumerate
@@ -17932,7 +18014,17 @@ The Elements of Typographic Style
 \end_layout
 
 \begin_layout Enumerate
-Unwanted line breaks after dashes can be prevented by wrapping in a makebox
+Unwanted line breaks 
+\series bold
+after
+\series default
+ dashes 
+\change_inserted -1402925745 1558782702
+must
+\change_deleted -1402925745 1558782715
+can
+\change_unchanged
+ be prevented by wrapping in a makebox
 \begin_inset Foot
 status collapsed
 
@@ -17961,8 +18053,33 @@ Objects
 nobreakdash
 \series default
  in \SpecialChar TeX
- code.
- Examples:
+ code
+\change_inserted -1402925745 1558782753
+, a protected space does not suffice
+\change_unchanged
+.
+ Examples
+\change_inserted -1402925745 1558782332
+
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -1402925745 1558782431
+It is generally recommended to set the correct language for text parts not
+ in the document language.
+ We don't do this here to prevent a dependency on LaTeX support for French
+ and Spanish.
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\change_unchanged
+:
 \end_layout
 
 \begin_deeper
@@ -18000,8 +18117,6 @@ status open
 \end_layout
 
 \begin_layout Itemize
-
-\lang french
 Les incises 
 \begin_inset Box Frameless
 position "t"
@@ -18022,8 +18137,6 @@ backgroundcolor "none"
 status open
 
 \begin_layout Plain Layout
-
-\lang french
 –
 \begin_inset space ~
 \end_inset
@@ -18041,8 +18154,6 @@ même
 \end_layout
 
 \begin_layout Itemize
-
-\lang spanish
 En una frase 
 \begin_inset ERT
 status collapsed
@@ -18095,8 +18206,6 @@ Line breaks are still allowed after spaced dashes.
 
 \begin_deeper
 \begin_layout Itemize
-
-\lang french
 Les incises –
 \begin_inset space ~
 \end_inset
@@ -29406,7 +29515,7 @@ name "subsec:Table-of-Contents"
 The Table of Contents (TOC) is inserted with the menu 
 \family sans
 Insert\SpecialChar menuseparator
-List/TOC\SpecialChar menuseparator
+List/Contents/References\SpecialChar menuseparator
 Table
 \begin_inset space ~
 \end_inset
@@ -29497,7 +29606,7 @@ Table, figure, listings and algorithm lists are very much like the table
  You can insert them via the 
 \family sans
 Insert\SpecialChar menuseparator
-List/TOC
+List/Contents/References
 \family default
  submenus.
  The list entries are the float captions and the float number.
@@ -30454,11 +30563,7 @@ To access a database via Bib\SpecialChar TeX
 , use the menu 
 \family sans
 Insert\SpecialChar menuseparator
-List
-\family default
-/
-\family sans
-TOC\SpecialChar menuseparator
+List/Contents/References\SpecialChar menuseparator
 Bib(la)TeX
 \begin_inset space ~
 \end_inset
@@ -30585,11 +30690,7 @@ biblatex
 : Use the menu 
 \family sans
 Insert\SpecialChar menuseparator
-List
-\family default
-/
-\family sans
-TOC\SpecialChar menuseparator
+List/Contents/References\SpecialChar menuseparator
 Bib(la)TeX
 \begin_inset space ~
 \end_inset
@@ -31503,7 +31604,7 @@ arg   "index-insert"
 The index list is inserted in the document with the menu 
 \family sans
 Insert\SpecialChar menuseparator
-List/TOC\SpecialChar menuseparator
+List/Contents/References\SpecialChar menuseparator
 Index
 \begin_inset space ~
 \end_inset
@@ -32383,7 +32484,7 @@ Once the document changes have been applied, you can find the new index
  list in 
 \family sans
 Insert\SpecialChar menuseparator
-List/TOC
+List/Contents/References
 \family default
  and the 
 \family sans
@@ -33338,7 +33439,7 @@ Nomenclature ! Printing
 To print the nomenclature, use the menu 
 \family sans
 Insert\SpecialChar menuseparator
-Lists/TOC\SpecialChar menuseparator
+List/Contents/References\SpecialChar menuseparator
 Nomenclature
 \family default
 .
@@ -40879,7 +40980,9 @@ Other\SpecialChar ldots
 \end_layout
 
 \begin_layout Subsection
-List/TOC
+
+\family sans
+List/Contents/References
 \end_layout
 
 \begin_layout Standard
@@ -46777,6 +46880,55 @@ reference "subsec:Numbering-depth"
 \end_inset
 
 .
+\change_inserted 5863208 1558620045
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 5863208 1558620379
+You can typeset lines numbering in the output file by enabling the checkbox
+ at the bottom.
+ The functionality is handled by package lineno and and additional options
+ of this package can be used as well.
+ The most common one are:
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 5863208 1558620630
+right Line numbers to the right margin
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 5863208 1558620589
+switch Line number to the outer margin (left – even pages, right – odd pages)
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 5863208 1558620637
+switch* Line numbers to the inner margin 
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 5863208 1558620780
+modulo Print numbers only on multiples of five lines
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 5863208 1558620792
+displaymath,
+\begin_inset space ~
+\end_inset
+
+mathlines Line numbers for math environments (both options needed).
+\change_unchanged
+
 \end_layout
 
 \begin_layout Section
@@ -49577,6 +49729,16 @@ literal "false"
 \end_inset
 
 
+\change_inserted -712698321 1563708959
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\change_inserted -712698321 1563708986
+LaTeX Language Support
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -49665,14 +49827,63 @@ Command
 \begin_inset space ~
 \end_inset
 
-start If a special \SpecialChar LaTeX
+start 
+\change_deleted -712698321 1563708374
+If a special \SpecialChar LaTeX
 -package is needed to write in a certain document language,
- you can here specify the command to start the package.
- An example is the start command 
+ you can h
+\change_inserted -712698321 1563708374
+H
+\change_unchanged
+ere
+\change_inserted -712698321 1563708377
+ you
+\change_unchanged
+\change_deleted -712698321 1563708382
+specify
+\change_inserted -712698321 1563708384
+customize
+\change_unchanged
+ the command 
+\change_inserted -712698321 1563708639
+that is used to switch to a different language
+\change_deleted -712698321 1563708410
+to start the package
+\change_unchanged
+.
+\change_inserted -712698321 1563708611
+This might be useful if you want to use a different command with 
+\series bold
+babel
+\series default
+ (which provides several alternative commands with different behavior),
+ or if you use a custom language package with specific commands, such as
+\series bold
+Arab\SpecialChar TeX
+
+\series default
+\begin_inset CommandInset citation
+LatexCommand cite
+key "Arabic"
+literal "true"
+
+\end_inset
+
+, which needs 
+\change_deleted -712698321 1563708616
+An example is 
+\change_unchanged
+the start command 
 \family sans
 
 \backslash
 begin{arabtext}
+\change_deleted -712698321 1563708621
+
 \family default
  that is needed to write Arabic using the package 
 \series bold
@@ -49687,18 +49898,39 @@ literal "true"
 
 \end_inset
 
+
+\change_unchanged
 .
  The default is the 
 \series bold
 babel
 \series default
  command 
-\family sans
+\family typewriter
 
 \backslash
 selectlanguage{$$lang}
+\change_inserted -712698321 1563708571
+
 \family default
+, whereby 
+\family sans
+$$lang
+\family default
+ is a placeholder that is substituted with the respective language name
+ in the \SpecialChar LaTeX
+ output
+\change_unchanged
 .
+
+\change_inserted -712698321 1563708571
+ Note that with 
+\series bold
+polyglossia
+\series default
+, this setting is ignored.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -49711,11 +49943,56 @@ end Counterpart to
 Command start
 \family default
 .
- Some packages, like the default, don't have an end command since the start
- command toggles the package on and off.
+\change_inserted -712698321 1563708846
+Use this if the language switch needs to be explicitly ended, as in 
+\series bold
+babel
+\series default
+'s alternative command 
+\family typewriter
+
+\backslash
+begin{otherlanguage*}\SpecialChar ldots
+
+\backslash
+end{otherlanguage*}
+\family default
+.
+\change_deleted -712698321 1563708866
+Some packages, like the default, don't have an end command since the start
+ command toggles the package on and off
+\change_inserted -712698321 1563711115
+Empty by default, as 
+\family typewriter
+
+\backslash
+selectlanguage{$$lang}
+\family default
+ does not need to be explicitly ended (it is valid until the next 
+\family typewriter
+
+\backslash
+selectlanguage{$$lang}
+\family default
+)
+\change_unchanged
+.
+
+\change_inserted -712698321 1563708925
+ Note that with 
+\series bold
+polyglossia
+\series default
+, this setting is ignored.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
+
+\change_deleted -712698321 1563708996
 Default
 \begin_inset space ~
 \end_inset
@@ -49729,6 +50006,8 @@ separator Defines the default decimal point for use in tables (decimal point
 \end_layout
 
 \begin_layout Description
+
+\change_deleted -712698321 1563708996
 Default
 \begin_inset space ~
 \end_inset
@@ -49739,6 +50018,8 @@ length
 
 unit Defines the unit that is used as default for lengths in \SpecialChar LyX
 's dialogs.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -49750,24 +50031,99 @@ languages
 \begin_inset space ~
 \end_inset
 
-globally When this option is set, the languages used in the document will
- be added as options to the document class options, so that they can be
- used by all \SpecialChar LaTeX
--packages.
- Otherwise they will only be used as options for the 
+globally 
+\change_deleted -712698321 1563709051
+When
+\change_inserted -712698321 1563709052
+If
+\change_unchanged
+ this option is set, the languages used in the document will be added 
+\change_deleted -712698321 1563709127
+as options 
+\change_unchanged
+to the document class options
+\change_inserted -712698321 1563709259
+ rather than the language package options.
+\change_deleted -712698321 1563709186
+,
+\change_unchanged
+\change_deleted -712698321 1563709191
+so that they can be used by all \SpecialChar LaTeX
+-packages
+\change_inserted -712698321 1563709305
+Since the document class passes all options in gets to all loaded \SpecialChar LaTeX
+-packages,
+ all language-aware packages will be informed about the used languages this
+ way
+\change_unchanged
+.
+\change_deleted -712698321 1563709264
+Otherwise they will only be used as options for the 
 \series bold
 babel
 \series default
  package.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
+
+\change_deleted -712698321 1563709314
 Auto
 \begin_inset space ~
 \end_inset
 
-begin When this option is set, documents start with the chosen document
- language.
+begin
+\change_inserted -712698321 1563709328
+Set
+\begin_inset space ~
+\end_inset
+
+document
+\begin_inset space ~
+\end_inset
+
+language
+\begin_inset space ~
+\end_inset
+
+explicitly
+\change_unchanged
+\change_deleted -712698321 1563709331
+When
+\change_inserted -712698321 1563709331
+If
+\change_unchanged
+ this option is set, 
+\change_inserted -712698321 1563709808
+the language switch defined in 
+\family sans
+Command
+\begin_inset space ~
+\end_inset
+
+start
+\family default
+ is output at the beginning of the document, thereby explicitly switching
+ to the document language.
+ This assures that the correct language is used in any case.
+ This might be needed if you use a non-default 
+\family sans
+Command
+\begin_inset space ~
+\end_inset
+
+start
+\family default
+ or if a package resets the document language.
+ If not set, the language that is active at document start is used (this
+ usually should be the document language).
+\change_deleted -712698321 1563709548
+documents start with the chosen document language.
  When this option is not set, the 
 \family sans
 Command
@@ -49787,23 +50143,55 @@ Command
 start
 \family default
  than the default.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
+
+\change_deleted -712698321 1563709354
 Auto
 \begin_inset space ~
 \end_inset
 
-end Counterpart to 
+end
+\change_inserted -712698321 1563709358
+Unset
+\begin_inset space ~
+\end_inset
+
+document
+\begin_inset space ~
+\end_inset
+
+language
+\begin_inset space ~
+\end_inset
+
+explicitly
+\change_unchanged
+ Counterpart to 
+\change_deleted -712698321 1563709361
+
 \family sans
 Auto
 \begin_inset space ~
 \end_inset
 
 begin
+\change_inserted -712698321 1563709392
+Set document language explicitly
+\change_unchanged
+
 \family default
 .
- When it is not set, the 
+\change_deleted -712698321 1563709618
+When it is not
+\change_inserted -712698321 1563709618
+If
+\change_unchanged
+ set, the 
 \family sans
 Command
 \begin_inset space ~
@@ -49811,7 +50199,30 @@ Command
 
 end
 \family default
- is set to the end of the document.
+ is 
+\change_deleted -712698321 1563709625
+set
+\change_inserted -712698321 1563709626
+output
+\change_unchanged
+\change_inserted -712698321 1563709628
+at
+\change_deleted -712698321 1563709628
+to
+\change_unchanged
+ the end of the document.
+\change_inserted -712698321 1563709816
+
+\end_layout
+
+\begin_layout Subsubsection
+\paragraph_spacing single
+
+\change_inserted -712698321 1563709833
+Editor Settings
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -49819,15 +50230,81 @@ Mark
 \begin_inset space ~
 \end_inset
 
+
+\change_inserted -712698321 1563709847
+additional
+\change_deleted -712698321 1563709845
 foreign
+\change_unchanged
+
 \begin_inset space ~
 \end_inset
 
-languages Text marked formatted in a language different from the document
- language will be underlined in blue.
+languages 
+\change_inserted -712698321 1563709877
+If set, all 
+\change_deleted -712698321 1563709877
+T
+\change_inserted -712698321 1563709878
+t
+\change_unchanged
+ext 
+\change_deleted -712698321 1563709882
+marked formatted 
+\change_unchanged
+in a language different 
+\change_deleted -712698321 1563709886
+from
+\change_inserted -712698321 1563709886
+to
+\change_unchanged
+ the document language will be 
+\change_inserted -712698321 1563709907
+marked (by default with a blue 
+\change_unchanged
+underline
+\change_deleted -712698321 1563709911
+d in blue
+\change_inserted -712698321 1563709911
+)
+\change_unchanged
+.
+\change_inserted -712698321 1563709927
+
 \end_layout
 
 \begin_layout Description
+
+\change_inserted -712698321 1563711969
+Respect
+\begin_inset space ~
+\end_inset
+
+OS
+\begin_inset space ~
+\end_inset
+
+keyboard
+\begin_inset space ~
+\end_inset
+
+language If set, \SpecialChar LyX
+ will switch the input language if the keyboard map is
+ switched via the operating system.
+ This is particularly useful if you switch between languages with different
+ scripts (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., English and Hebrew: in this case, switching the keyboard to Hebrew will
+ automatically switch the input language to Hebrew as well, and vice versa).
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
+
+\change_deleted -712698321 1563709926
 Enable
 \begin_inset space ~
 \end_inset
 
 support Enables the use of languages, written from right to left (RTL),
  like Arabic, Hebrew or Farsi.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
-Cursor
+
+\change_inserted -712698321 1563710132
+Right-to-left
+\begin_inset space ~
+\end_inset
+
+
+\change_deleted -712698321 1563710132
+C
+\change_inserted -712698321 1563710132
+c
+\change_unchanged
+ursor
 \begin_inset space ~
 \end_inset
 
-movement When writing RTL, you can define if the left and right arrow keys
- move the cursor visually to the left or right, respectively, or logically.
- Logical means that the cursor is moved to the left when pressing the right
- arrow key and the cursor is inside text in an RTL language.
+movement 
+\change_inserted -712698321 1563710265
+Here you can define how cursor movement (with the arrow keys) behaves 
+\change_deleted -712698321 1563710266
+W
+\change_inserted -712698321 1563710267
+w
+\change_unchanged
+hen writing 
+\change_deleted -712698321 1563710171
+RTL
+\change_inserted -712698321 1563710286
+scripts with right-to-left direction (e.g., Arabic, Hebrew or Farsi).
+\change_deleted -712698321 1563710294
+, you can define if the left and right arrow keys move the cursor visually
+ to the left or right, respectively, or logically.
+\change_unchanged
+
+\family sans
+Logical
+\family default
+ means that the cursor is moved to the left 
+\change_deleted -712698321 1563710342
+when
+\change_inserted -712698321 1563710342
+if
+\change_unchanged
+ pressing the right arrow key 
+\change_inserted -712698321 1563712351
+(so right arrow key means: move forward), and to the right if pressing the
+ left arrow key (which then means: move backward).
+ This setting might be useful in texts that mix left-to-right and right-to-left
+ scripts, since the cursor then follows a coherent 
+\begin_inset Quotes eld
+\end_inset
+
+text logic
+\begin_inset Quotes erd
+\end_inset
+
+.
+\family sans
+Visual
+\family default
+ means: always move to the direction towards which the arrows really point.
+\change_deleted -712698321 1563710407
+and the cursor is inside text in an RTL language.
+\change_inserted -712698321 1563710219
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\change_inserted -712698321 1563710235
+Local Preferences
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1563776004
+Default
+\begin_inset space ~
+\end_inset
+
+decimal
+\begin_inset space ~
+\end_inset
+
+separator Defines the default decimal separator for use in tables (decimal
+ separator alignment).
+ By default, the appropriate character for the current language is selected
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., dot for English, comma for German), but you can also specify a specific
+ (static) custom character here.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1563709001
+Default
+\begin_inset space ~
+\end_inset
+
+length
+\begin_inset space ~
+\end_inset
+
+unit Defines the unit that is used as default for lengths in \SpecialChar LyX
+'s dialogs.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Subsection