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