]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
CMake export tests now correctly check return code
[lyx.git] / lib / doc / UserGuide.lyx
index 2c438461c655c02821b2e63510374ff28d4890f7..78e6e3ef454706aca927a17c522130507a551648 100644 (file)
@@ -4370,9 +4370,7 @@ Return
 Standard
 \family default
 .
- LyX will still reset the nesting depth, however.
- Usually, starting a new paragraph resets both the paragraph environment
- and the nesting depth (for more on nesting see section
+ Also the nesting depth is preserved (for more on nesting see section
 \begin_inset space ~
 \end_inset
 
@@ -4384,20 +4382,6 @@ reference "sec:Nesting"
 \end_inset
 
 ).
- At the moment, all this is context-specific; you're better off expecting
-\family sans
-Return
-\family default
- to reset the paragraph environment and depth.
- If you want a new paragraph to keep the current environment and depth,
- use 
-\begin_inset Info
-type  "shortcut"
-arg   "paragraph-break inverse"
-\end_inset
-
- instead.
 \end_layout
 
 \begin_layout Subsection
@@ -5353,7 +5337,7 @@ Standard
  depth, you can use 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
  to break paragraphs.
@@ -7199,7 +7183,7 @@ Return
 \family default
  is the 
 \family typewriter
-paragraph-break
+break-paragraph
 \family default
  function, and the individual lines of an address are not paragraphs.
  Thus, you have to use 
@@ -8841,7 +8825,7 @@ List
  We created it by using 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
  followed by 
@@ -8872,7 +8856,7 @@ arg   "depth-increment"
  by hitting 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
  followed by 
@@ -8903,7 +8887,7 @@ Standard
  We did this by hitting 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
 , then 
@@ -8941,7 +8925,7 @@ Standard
  paragraph, also at level #4, made with just a 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
 .
@@ -8953,7 +8937,7 @@ arg   "paragraph-break inverse"
  We hit 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
  and changed the paragraph environment back to 
@@ -9003,7 +8987,7 @@ and this is level #6.
  Just hit 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
  followed by a 
@@ -9021,7 +9005,7 @@ arg   "depth-decrement"
 #4-b After another 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
  followed by a 
@@ -9192,7 +9176,7 @@ This is level #2.
  We used 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
  followed by 
@@ -9226,7 +9210,7 @@ Itemize
  (We got here by using 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
 , then 
@@ -9247,7 +9231,7 @@ Itemize
 Here's level #4, produced using 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
 , then 
@@ -9315,7 +9299,7 @@ don't
 Oh, as if you couldn't guess by now, we're just using 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
  to keep the current environment and depth but create a new item.
@@ -9331,7 +9315,7 @@ arg   "depth-decrement"
  to decrease the depth after the next 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
 .
@@ -9372,7 +9356,7 @@ did
 Another 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
  
@@ -9395,7 +9379,7 @@ Enumerate
 The same thing happens if we do another 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
  
@@ -9526,7 +9510,7 @@ Bippitey boppitey boo!
 (
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
 
@@ -9641,7 +9625,7 @@ blue-fish
 (
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
 
@@ -9657,7 +9641,7 @@ arg   "depth-increment"
  3 times, 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
 
@@ -9733,7 +9717,7 @@ Quotation
  We will use 
 \begin_inset Info
 type  "shortcut"
-arg   "paragraph-break inverse"
+arg   "break-paragraph inverse"
 \end_inset
 
  to preserve the depth.
@@ -26023,7 +26007,7 @@ of
 Contents
 \family default
 .
- Is is displayed in LyX as a gray box.
+ It is displayed in LyX as a gray box.
  If you click on it, the 
 \family sans
 Outline
@@ -28328,6 +28312,39 @@ emph
 .
 \end_layout
 
+\begin_layout Standard
+If the characters |
+\begin_inset space \space{}
+\end_inset
+
+,
+\begin_inset space \space{}
+\end_inset
+
+!
+\begin_inset space \space{}
+\end_inset
+
+, @ and
+\begin_inset space \space{}
+\end_inset
+
+"
+\begin_inset space \space{}
+\end_inset
+
+should appear in nomenclature entries they need to be escaped by adding
+ a quote character in front of them.
+\begin_inset CommandInset nomenclature
+LatexCommand nomenclature
+symbol "\"@, \"|, \"!, \"\""
+description "The quote sign is output by writing ' \"\"\"\" '"
+
+\end_inset
+
+
+\end_layout
+
 \begin_layout Subsection
 Sort Order of Nomenclature Entries
 \begin_inset Index idx
@@ -31303,7 +31320,7 @@ e.
 \begin_inset space ~
 \end_inset
 
-all lowercase, all uppercase, first uppercase followed by lowercase)
+all lowercase, all uppercase, first letter uppercase followed by lowercase)
 \end_layout
 
 \begin_layout Subsection
@@ -31358,26 +31375,29 @@ Find
 Find Next
 \family default
  button at the bottom of the dialog (or just press the 
-\family sans
-Return
-\family default
+\begin_inset Info
+type  "shortcut"
+arg   "break-paragraph"
+\end_inset
+
  key).
  The entered word is found both in text mode and in math mode, and in emphasized
 , bold or normal face, and in both in section titles and in standard text.
  Pressing repeatedly 
+\begin_inset Info
+type  "shortcut"
+arg   "break-paragraph"
+\end_inset
+
+ keeps searching forward while pressing 
 \family sans
-Enter
-\family default
- keeps searching forward.
- Similarly, pressing 
-\family sans
-Shift+Enter
+Shift+Return
 \family default
- searches for the entered text backwards.
+ searches backwards.
 \end_layout
 
 \begin_layout Standard
-While searching, the 
+The 
 \family sans
 Case sensitive
 \family default
@@ -31399,11 +31419,11 @@ Searching for mathematics
 \end_layout
 
 \begin_layout Standard
-Mathematical formulas may be searched for by typing in the 
+Mathematical formulas may be searched for by typing them the 
 \family sans
 Find
 \family default
- editor a mathematical formula, such as 
+ editor, such as 
 \begin_inset Formula $x^{2}$
 \end_inset
 
@@ -31413,8 +31433,8 @@ Find
 
 .
  When searching for a formula, it is found both when it is alone and when
- it occurs in sub-formulas and nested parts of sub-formulas, for example
- the mentioned segments would be found in something like 
+ it occurs in sub-formulas and nested parts of sub-formulas.
For example the mentioned segments would be found in something like 
 \begin_inset Formula $\frac{x^{2}}{\sqrt{\frac{x^{2}}{1+x^{2}}}}.$
 \end_inset
 
@@ -31451,8 +31471,6 @@ a plain word and searching for it would not find instances of the word occurring
 \begin_layout Itemize
 an emphasized or boldface word and searching for it would find the respective
  instances with same face only, and within the same text style only.
- Note that, for example, an emphasized text is found not only when occurring
- alone, but also when it is contained in a longer emphasized sentence.
 \end_layout
 
 \begin_layout Itemize
@@ -31464,8 +31482,8 @@ a plain word in a section heading, and searching for it, finds occurrences
 \end_layout
 
 \begin_layout Itemize
-some mathematics in a displayed formula will only find instances of this
formula that are also displayed formulas (and not inline formulas).
+a displayed formula will only find instances of this formula that are also
+ displayed formulas (and not inline formulas).
 \end_layout
 
 \begin_layout Subsubsection
@@ -31473,11 +31491,11 @@ Replace
 \end_layout
 
 \begin_layout Standard
-The text segments matching the text entered in the 
+The document segments entered in the 
 \family sans
 Find
 \family default
- editor may be replaced with the text segments entered in the 
+ editor can be replaced with the text segments entered in the 
 \family sans
 Replace
 \family default
@@ -31494,14 +31512,16 @@ Replace
  
 \noun default
 press 
-\family sans
-Enter
-\family default
+\begin_inset Info
+type  "shortcut"
+arg   "break-paragraph"
+\end_inset
+
  or 
 \family sans
-Shift+Enter
+Shift+Return
 \family default
- while being in the 
+ while the cursor is in the 
 \family sans
 Replace
 \family default
@@ -31512,8 +31532,7 @@ editor.
 \end_layout
 
 \begin_layout Standard
-You can replace full-featured formatted LyX segments in place of the matching
- text segments in your document.
+You can replace with full-featured formatted LyX segments.
  Typical scenarios in which to use this capability may be (just to mention
  a few):
 \end_layout
@@ -31529,16 +31548,18 @@ func()
 \end_inset
 
  with its typewriter version 
-\family typewriter
-
 \begin_inset Quotes eld
 \end_inset
 
+
+\family typewriter
 func()
+\family default
+
 \begin_inset Quotes erd
 \end_inset
 
-;
+
 \end_layout
 
 \begin_layout Itemize
@@ -31656,7 +31677,7 @@ status collapsed
 
 \begin_layout Plain Layout
 Under the constraint that any (sub)expression must match a well-formed LyX
text segment, i.
+ segment, i.
 \begin_inset space \thinspace{}
 \end_inset
 
@@ -31672,7 +31693,7 @@ when matching LaTeX code, no segments with unbalanced {} braces are allowed
 
 , while text entered outside regexp insets is matched exactly against the
  same text in the document.
Note that it is allowed to cut and paste regexp-mode insets as usual.
It is allowed to cut and paste regexp-mode insets as usual.
  Examples of using such a feature may be:
 \end_layout
 
@@ -31723,8 +31744,8 @@ Settings
 \end_layout
 
 \begin_layout Standard
-Finally, references to (sub)expressions in regexp may be used as usual,
enclosing parts of the expression within round braces 
+Finally, references to (sub)expressions in regexp may be used as usual:
Enclosing parts of the expression within round braces 
 \begin_inset Formula $()$
 \end_inset
 
@@ -31737,17 +31758,37 @@ Finally, references to (sub)expressions in regexp may be used as usual,
 \end_inset
 
 , etc..
- For example, try searching for the regexp 
-\begin_inset Formula $([a-z]+)[[:blank:]]\backslash1$
+ For example, try searching for the regexp
+\begin_inset Newline newline
+\end_inset
+
+[[:space:]]([[:alpha:]]+)[[:space:]]
+\backslash
+1[[:space:]]
+\begin_inset Newline newline
 \end_inset
 
- in order to find word repetitions, if there are any.
+in order to find word repetitions, if there are any.
+\end_layout
+
+\begin_layout Standard
+The usage of back references in the replaced text is not (yet) implemented.
 \end_layout
 
 \begin_layout Standard
-Note that back references work both when occurring within the same regexp,
- and when occurring in multiple different regexps, where the numbering of
- back-referenced sub-expressions is absolute, i.
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+\color none
+Note:
+\series default
+ Back references work both when occurring within the same regexp, and when
+ occurring in multiple different regexps, where the numbering of back-referenced
+ sub-expressions is absolute.
+ I.
 \begin_inset space \thinspace{}
 \end_inset
 
@@ -31755,7 +31796,7 @@ e.
 \begin_inset space ~
 \end_inset
 
+
 \begin_inset Formula $\backslash1$
 \end_inset
 
@@ -31766,9 +31807,9 @@ e.
  in all entered regexps.
 \end_layout
 
-\begin_layout Standard
-Note also that the use of back references in the replaced text is not (yet)
- implemented.
+\end_inset
+
+
 \end_layout
 
 \begin_layout Section
@@ -31836,7 +31877,7 @@ Settings
  You can specify the language of a word in the spellchecker dialog by choosing
  a different one at the top of the dialog.
  LyX can correctly spell check documents containing multiple languages.
- This work if you have marked the different languages appropriately and
+ This works if you have marked the different languages appropriately and
  have the spell checker dictionaries installed.
  LyX automatically switches to the appropriate dictionary file.
 \end_layout
@@ -47250,8 +47291,7 @@ Plain
 text
 \family default
 .
- Setting the line line length to 0 means all text is printed in one endless
- line.
+ Setting the line length to 0 means all text is printed in one endless line.
 \end_layout
 
 \begin_layout Description
@@ -48711,7 +48751,6 @@ Bibliography
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 label "Credits"
@@ -48746,7 +48785,6 @@ http://www.lyx.org/Credits
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "latexcompanion"
@@ -48762,7 +48800,6 @@ The LaTeX Companion Second Edition.
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "latexguide"
@@ -48779,7 +48816,6 @@ A Guide to LaTeX Fourth Edition.
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "latexbook"
@@ -48795,7 +48831,6 @@ LaTeX: A Document Preparation System.
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "texbook"
@@ -48813,7 +48848,6 @@ The TeXbook.
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "TeXCatalogue"
@@ -48839,7 +48873,6 @@ http://www.ctan.org/tex-archive/help/Catalogue/bytopic.html
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "LaTeXFAQ"
@@ -48865,7 +48898,6 @@ http://www.tex.ac.uk/cgi-bin/texfaq2html
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "BibTeX"
@@ -48903,7 +48935,6 @@ http://mirrors.ctan.org/biblio/bibtex/contrib/doc/btxdoc.pdf
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "BibTeX-2"
@@ -48941,7 +48972,6 @@ http://www.ctan.org/tex-archive/info/bibtex/tamethebeast/ttb_en.pdf
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "makeindex"
@@ -48979,7 +49009,6 @@ http://mirrors.ctan.org/indexing/makeindex/doc/makeindex.pdf
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "xindy"
@@ -49017,7 +49046,6 @@ http://www.xindy.org/documentation.html
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "caption"
@@ -49065,7 +49093,6 @@ ftp://tug.ctan.org/pub/tex-archive/macros/latex/contrib/caption/caption.pdf
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "enumitem"
@@ -49113,7 +49140,6 @@ http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "fancyhdr"
@@ -49161,7 +49187,6 @@ ftp://tug.ctan.org/pub/tex-archive/macros/latex/contrib/fancyhdr/fancyhdr.pdf
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "hyperref"
@@ -49169,8 +49194,6 @@ key "hyperref"
 \end_inset
 
 
-\series bold
-
 \begin_inset CommandInset href
 LatexCommand href
 name "Documentation"
@@ -49178,8 +49201,6 @@ target "ftp://tug.ctan.org/pub/tex-archive/macros/latex/contrib/hyperref/hyperre
 
 \end_inset
 
-
-\series default
  of the LaTeX-package 
 \series bold
 hyperref
@@ -49213,7 +49234,6 @@ ftp://tug.ctan.org/pub/tex-archive/macros/latex/contrib/hyperref/hyperref.pdf
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "nomencl"
@@ -49261,7 +49281,6 @@ ftp://tug.ctan.org/pub/tex-archive/macros/latex/contrib/nomencl/nomencl.pdf
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "prettyref"
@@ -49309,7 +49328,6 @@ http://www.ctan.org/tex-archive/macros/latex/contrib/prettyref/prettyref.pdf
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "refstyle"
@@ -49357,7 +49375,6 @@ http://mirrors.ctan.org/macros/latex/contrib/refstyle/refstyle.pdf
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "tipa"
@@ -49405,7 +49422,6 @@ http://www.ctan.org/tex-archive/fonts/tipa/tipaman.pdf
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "Arabic"
@@ -49439,7 +49455,6 @@ http://wiki.lyx.org/Windows/Arabic
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "Armenian"
@@ -49473,7 +49488,6 @@ http://wiki.lyx.org/Windows/Armenian
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "Farsi"
@@ -49507,7 +49521,6 @@ http://wiki.lyx.org/Windows/Farsi
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "Hebrew"
@@ -49541,7 +49554,6 @@ http://wiki.lyx.org/Windows/Hebrew
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "Japanese"
@@ -49575,7 +49587,6 @@ http://wiki.lyx.org/Windows/Japanese
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "Latvian"
@@ -49609,7 +49620,6 @@ http://wiki.lyx.org/Windows/Latvian
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "Lithuanian"
@@ -49643,7 +49653,6 @@ http://wiki.lyx.org/Windows/Lithuanian
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "Mongolian"
@@ -49677,7 +49686,6 @@ http://wiki.lyx.org/Windows/Mongolian
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "Vietnamese"
@@ -49711,7 +49719,6 @@ http://wiki.lyx.org/Windows/Vietnamese
 \end_layout
 
 \begin_layout Bibliography
-\labelwidthstring Literaturverzeichnis
 \begin_inset CommandInset bibitem
 LatexCommand bibitem
 key "NewInLyX20"