X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FUserGuide.lyx;h=1dcc9874dab25180cc50726015ff05c78e324666;hb=978ecc33092206c9d3ffcead33af5442f3370a5b;hp=b001c33056cc59664db71a3faa60cda947edecf7;hpb=d1d6f12a93964f627db064eb62ffd3141fe98884;p=lyx.git

diff --git a/lib/doc/UserGuide.lyx b/lib/doc/UserGuide.lyx
index b001c33056..1dcc9874da 100644
--- a/lib/doc/UserGuide.lyx
+++ b/lib/doc/UserGuide.lyx
@@ -1,5 +1,5 @@
 #LyX 2.1 created this file. For more info see http://www.lyx.org/
-\lyxformat 471
+\lyxformat 474
 \begin_document
 \begin_header
 \textclass scrbook
@@ -32179,7 +32179,7 @@ There are 2
 \end_inset
 
 files for each language.
- To install a dictionary, copy the 2
+ To install a dictionary on Windows, copy the 2
 \begin_inset space ~
 \end_inset
 
@@ -32192,6 +32192,28 @@ Resources
 dicts
 \family default
  and restart LyX.
+\begin_inset Newline newline
+\end_inset
+
+With Linux one needs to install the packages for the desired language.
+ The number of these packages vary depending on the Linux distribution,
+ but in most cases these are 
+\family typewriter
+aspell-xx
+\family default
+, 
+\family typewriter
+hunspell-xx
+\family default
+,
+\family typewriter
+ myspell-xx
+\family default
+, etc., where 
+\family sans
+xx
+\family default
+ is the language code.
 \end_layout
 
 \begin_layout Subsection
@@ -37023,7 +37045,7 @@ Generates with the help of the program
 \family typewriter
 ChkTeX
 \family default
- a log of possible LaTeX-errorsand displays it in a dialog.
+ a log of possible LaTeX-errors and displays it in a dialog.
  This feature is not available on Windows.
 \end_layout
 
@@ -40635,30 +40657,33 @@ European
  sign, the œ-ligature and some characters used for French and Finnish
 \end_layout
 
-\begin_layout Standard
-Finally, the dialog lets you select a specific language package for the
- current document.
- See sec.
-\begin_inset space \thinspace{}
+\begin_layout Section
+Colors
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+Color ! main text
+\end_layout
+
 \end_inset
 
 
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Prefs-Language"
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+Color ! background
+\end_layout
 
 \end_inset
 
- for more information on the language package.
-\end_layout
 
-\begin_layout Section
-Colors
 \begin_inset Index idx
 status collapsed
 
 \begin_layout Plain Layout
-Color ! main text
+Color ! Shaded boxes
 \end_layout
 
 \end_inset
@@ -40668,7 +40693,7 @@ Color ! main text
 status collapsed
 
 \begin_layout Plain Layout
-Color ! background
+Color ! Greyed-out notes
 \end_layout
 
 \end_inset
@@ -40677,12 +40702,31 @@ Color ! background
 \end_layout
 
 \begin_layout Standard
-Here you can alter the font color for the main text (default: black) and
- for Greyed
+Here you can alter the font color for the 
+\family sans
+Main text
+\family default
+ (default: black), for 
+\family sans
+Greyed
+\begin_inset space ~
+\end_inset
+
+out notes
+\family default
+ (default: light grey)for the background color for the 
+\family sans
+Page
+\family default
+ (default: white) and for 
+\family sans
+Shaded
 \begin_inset space ~
 \end_inset
 
-out notes (default: light grey).
+boxes
+\family default
+ (default: red).
  The button 
 \family sans
 Reset
@@ -40691,17 +40735,23 @@ Reset
 \end_layout
 
 \begin_layout Standard
-You can also change the background color for the pages (default: white)
- and for Shaded
-\begin_inset space ~
-\end_inset
-
-boxes (default: red).
+Clicking any button showing 
+\family sans
+Default
+\family default
+ or 
+\family sans
+Change
+\family default
+ opens a dialog enabling you to choose from a selection of colors or from
+ a color-picker or to specify a color using HSL or RGB values.
+ In the dialog you can add any color to the custom colors to select them
+ later more quickly.
 \end_layout
 
 \begin_layout Standard
 \begin_inset Note Greyedout
-status collapsed
+status open
 
 \begin_layout Plain Layout
 The colors are not shown within LyX, only in the output.
@@ -40718,31 +40768,23 @@ out note appears blue in the output.)
 \end_layout
 
 \begin_layout Standard
-Note, if you change the main text font color and use the option 
+Note, if you change the 
 \family sans
-Color
-\begin_inset space ~
-\end_inset
-
-links
-\family default
- in the document settings under 
-\family sans
-PDF
+Main
 \begin_inset space ~
 \end_inset
 
-properties
+text
 \family default
-, you probably also need to change the link font color by using 
+ font color and use the option 
 \family sans
-Additional
+Color
 \begin_inset space ~
 \end_inset
 
-options
+links
 \family default
- in the 
+ in the document settings under 
 \family sans
 PDF
 \begin_inset space ~
@@ -40750,36 +40792,14 @@ PDF
 
 properties
 \family default
-.
- For example the option
-\end_layout
-
-\begin_layout Standard
-
-\series bold
-linkcolor=black
-\end_layout
-
-\begin_layout Standard
-sets the link text color to black.
- For more information, see the manual of the LaTeX-package 
-\series bold
-hyperref
-\series default
-
-\begin_inset Index idx
-status collapsed
-
-\begin_layout Plain Layout
-LaTeX-packages ! hyperref
-\end_layout
-
+, you probably also need to change the link font color as described in section
+\begin_inset space ~
 \end_inset
 
-, 
-\begin_inset CommandInset citation
-LatexCommand cite
-key "hyperref"
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:PDF-Properties"
 
 \end_inset
 
@@ -40794,12 +40814,24 @@ key "hyperref"
 \end_layout
 
 \begin_layout Standard
-You can adapt the main text font color and the page background for every
- page in your document if you use these commands as TeX
+You can adapt the 
+\family sans
+Main
 \begin_inset space ~
 \end_inset
 
-Code behind a forced page break:
+text
+\family default
+ font color and the 
+\family sans
+Page
+\family default
+ background for every page in your document if you use these commands as
+ TeX
+\begin_inset space ~
+\end_inset
+
+Code after a forced page break:
 \end_layout
 
 \begin_layout Itemize
@@ -40827,7 +40859,7 @@ color{color name}
 \end_layout
 
 \begin_layout Standard
-The color name can hereby be one of these: 
+You are restricted to one of 
 \series bold
 black
 \series default
@@ -40855,20 +40887,40 @@ red
 \series bold
 white
 \series default
-, 
+ or 
 \series bold
 yellow
 \series default
+ for the 
+\series bold
+color name
+\series default
+ unless you have defined your own color (see the 
+\emph on
+Colored Tables
+\emph default
+ section of the 
+\emph on
+Embedded
+\begin_inset space ~
+\end_inset
 
+Objects
+\emph default
+ Manual).
 \begin_inset Newline newline
 \end_inset
 
-If you have changed a text or background color, you can use them under the
- following names:
+If you have changed a text or background color, you can use the following
+ names to refer to them:
 \end_layout
 
 \begin_layout Itemize
-For the page background color:
+For the 
+\family sans
+Page
+\family default
+ background color:
 \begin_inset Newline newline
 \end_inset
 
@@ -40878,7 +40930,15 @@ page_backgroundcolor
 \end_layout
 
 \begin_layout Itemize
-For the main text color:
+For the 
+\family sans
+Main
+\begin_inset space ~
+\end_inset
+
+text
+\family default
+ color:
 \begin_inset Newline newline
 \end_inset
 
@@ -40888,11 +40948,15 @@ document_fontcolor
 \end_layout
 
 \begin_layout Itemize
-For the Shaded
+For the 
+\family sans
+Shaded
 \begin_inset space ~
 \end_inset
 
-box background color:
+boxes
+\family default
+ background color:
 \begin_inset Newline newline
 \end_inset
 
@@ -40902,11 +40966,15 @@ shadecolor
 \end_layout
 
 \begin_layout Itemize
-For the Greyed
+For the 
+\family sans
+Greyed
 \begin_inset space ~
 \end_inset
 
-out note text color:
+out notes
+\family default
+ text color:
 \begin_inset Newline newline
 \end_inset
 
@@ -40916,23 +40984,15 @@ note_fontcolor
 \end_layout
 
 \begin_layout Standard
-To see how to define and use custom colors, see section 
-\emph on
-Colored
+To see how to define and use custom colors, see section Colored
 \begin_inset space ~
 \end_inset
 
-Cells
-\emph default
- of the 
-\emph on
-Embedded
+Cells of the Embedded
 \begin_inset space ~
 \end_inset
 
-Objects
-\emph default
- manual.
+Objects manual.
 \end_layout
 
 \begin_layout Section
@@ -40940,8 +41000,15 @@ Numbering & TOC
 \end_layout
 
 \begin_layout Standard
-Here you can adjust the numbering depth of section headings and the section
- depth in the table of contents as described in section
+Here you can adjust the 
+\family sans
+Numbering
+\family default
+ depth of section headings and the section depth in the 
+\family sans
+Table of Contents
+\family default
+ as described in section
 \begin_inset space ~
 \end_inset
 
@@ -40960,7 +41027,7 @@ Bibliography
 \end_layout
 
 \begin_layout Standard
-Here you can specify a citation style using the LaTeX packages 
+Here you can specify if a citation style using the LaTeX packages 
 \series bold
 natbib
 \series default
@@ -40988,8 +41055,12 @@ LaTeX-packages ! jurabib
 
 \end_inset
 
-.
- You can enable a sectioned bibliography using the LaTeX package 
+ should be used.
+ You can enable a 
+\family sans
+Sectioned bibliography
+\family default
+ using the LaTeX package 
 \series bold
 bibtopic
 \series default
@@ -41003,8 +41074,11 @@ LaTeX-packages ! bibtopic
 
 \end_inset
 
- and you can customize how the bibliography of the given document is being
- generated.
+ and you can select a 
+\family sans
+Processor
+\family default
+ for the generation of the bibliography.
  For a further description see section
 \begin_inset space ~
 \end_inset
@@ -41024,9 +41098,12 @@ Indexes
 \end_layout
 
 \begin_layout Standard
-Here, you can customize how the index of your document is being generated
- and you can define additional indexes.
- Please refer to section
+Here you can define the 
+\family sans
+Processor
+\family default
+ that will generate your index and you can define additional indexes (see
+ section
 \begin_inset space ~
 \end_inset
 
@@ -41037,7 +41114,7 @@ reference "sec:Index"
 
 \end_inset
 
- for details.
+ for details).
 \end_layout
 
 \begin_layout Section
@@ -41181,7 +41258,7 @@ Float Placement
 \end_layout
 
 \begin_layout Standard
-The float placement options are described in section 
+The float placement options are described in the section 
 \emph on
 Float
 \begin_inset space ~
@@ -41205,7 +41282,7 @@ Listings
 \end_layout
 
 \begin_layout Standard
-The listings settings are explained in chapter 
+The listings settings are explained in the chapter 
 \emph on
 Program Code Listings
 \emph default
@@ -41225,7 +41302,19 @@ Bullets
 \end_layout
 
 \begin_layout Standard
-Here you can adjust the characters for the itemize levels.
+Here you can adjust the characters used for the itemize 
+\family sans
+Level
+\family default
+s, specify the 
+\family sans
+Font
+\family default
+ set to be used and set the 
+\family sans
+Size
+\family default
+ of the bullets.
  The itemize environment is described in section
 \begin_inset space ~
 \end_inset
@@ -41240,6 +41329,89 @@ reference "sec:Itemize"
 .
 \end_layout
 
+\begin_layout Standard
+You can furthermore specify a 
+\family sans
+Custom
+\begin_inset space ~
+\end_inset
+
+Bullet
+\family default
+ by inserting in this field the LaTeX command of the desired character.
+ For example to use the € sign, you have to insert the command 
+\series bold
+
+\backslash
+texteuro
+\series default
+.
+ For math symbols you additionally need to enclose the command with $ signs.
+ To use e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+the symbol 
+\begin_inset Formula $\circlearrowright$
+\end_inset
+
+ you need to enter 
+\series bold
+$
+\backslash
+circlearrowright$
+\series default
+.
+ To find the command for a math symbol, create a formula and hover the mouse
+ over the desired symbol in the math toolbar.
+\end_layout
+
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+Note:
+\series default
+ Some characters require to load special LaTeX-packages in the preamble
+ (menu 
+\family sans
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+LaTeX
+\begin_inset space ~
+\end_inset
+
+Preamble
+\family default
+).
+ For example for the € sign one needs to add the line 
+\series bold
+
+\backslash
+usepackage{textcomp}
+\series default
+ to the preamble.
+ For most math symbols it is sufficient to add the line 
+\series bold
+
+\backslash
+usepackage{amssymb}
+\series default
+.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
 \begin_layout Section
 Branches
 \end_layout
@@ -41283,7 +41455,7 @@ Output
 \begin_inset space ~
 \end_inset
 
-Format: The format that is used when you hit 
+Format: The format that is used when you enter 
 \begin_inset Quotes eld
 \end_inset
 
@@ -41388,9 +41560,20 @@ Output
 \begin_inset space ~
 \end_inset
 
-Options settings for the export format 
+Options offers settings for the export format 
 \family sans
-LyXHTML
+Ly
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+{}
+\end_layout
+
+\end_inset
+
+XHTML
 \family default
 .
  
@@ -41427,7 +41610,57 @@ Additional
 Features
 \emph default
  manual.
- The scaling is used for the size of equations in the output.
+ 
+\family sans
+Math
+\begin_inset space ~
+\end_inset
+
+image
+\begin_inset space ~
+\end_inset
+
+scaling
+\family default
+ is used for the size of equations in the output.
+\end_layout
+
+\begin_layout Section
+LaT
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+{}
+\end_layout
+
+\end_inset
+
+eX Preamble
+\end_layout
+
+\begin_layout Standard
+In this text field you can enter commands to load special LaTeX-packages
+ or to define LaTeX-commands.
+ The preamble is a thing for LaTeX-experts.
+ You should not enter commands here until you know exactly what you are
+ doing.
+\end_layout
+
+\begin_layout Standard
+An introduction to the LaTeX-syntax is given in section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:LaTeX-Syntax"
+
+\end_inset
+
+.
 \end_layout
 
 \begin_layout Section