]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
Adapt documentation.
[lyx.git] / lib / doc / UserGuide.lyx
index 0c93a024773bcbb7342857fd7f677139b8a38b22..aade685e3fe32fdfe1c74fe30387a2723c0caa4d 100644 (file)
@@ -140,11 +140,12 @@ enumitem
 \papercolumns 1
 \papersides 2
 \paperpagestyle default
-\tracking_changes false
+\tracking_changes true
 \output_changes false
 \html_math_output 0
 \html_css_as_file 0
 \html_be_strict true
+\author -712698321 "Jürgen Spitzmüller"
 \end_header
 
 \begin_body
@@ -16563,7 +16564,7 @@ literal "false"
 \end_layout
 
 \begin_layout Subsection
-Dashes and line breaks
+Dashes and Line Breaks
 \begin_inset CommandInset label
 LatexCommand label
 name "subsec:Dashes-and-line-breaks"
@@ -16574,8 +16575,13 @@ name "subsec:Dashes-and-line-breaks"
 \end_layout
 
 \begin_layout Standard
-Whether line breaks around dashes are allowed depends on the use case and
- locale:
+Whether line breaks 
+\change_deleted -712698321 1513438804
+around
+\change_inserted -712698321 1513438805
+at
+\change_unchanged
+ dashes are allowed depends on the use case and locale:
 \end_layout
 
 \begin_layout Itemize
@@ -16595,9 +16601,22 @@ In French and Spanish, dashes around parenthetical statements are treated
 \end_layout
 
 \begin_layout Standard
+
+\change_deleted -712698321 1513437551
 In \SpecialChar LyX
-, line breaks after en-dashes and em-dashes are only allowed (without
- manual intervention), if the option 
+, 
+\change_inserted -712698321 1513437622
+The dashes that are output by \SpecialChar LyX
+ to \SpecialChar LaTeX
+ by default generally allow for 
+\change_unchanged
+line breaks after en-dashes and em-dashes
+\change_deleted -712698321 1513498469
+\change_inserted -712698321 1513437597
+.
+\change_deleted -712698321 1513438851
+are only allowed (without manual intervention), if the option 
 \family sans
 Document\SpecialChar menuseparator
 Settings\SpecialChar menuseparator
@@ -16636,6 +16655,8 @@ In this case, the dashes are output as
 \end_inset
 
 
+\change_unchanged
+
 \end_layout
 
 \begin_layout Standard
@@ -16643,12 +16664,22 @@ Please note:
 \end_layout
 
 \begin_layout Enumerate
+
+\change_deleted -712698321 1513437637
 This results in optional line breaks after 
 \emph on
 all
 \emph default
  en- and em-dashes.
- Unwanted line breaks must be prevented by wrapping in a makebox
+\change_unchanged
+Unwanted line breaks 
+\change_deleted -712698321 1513437645
+must
+\change_inserted -712698321 1513437646
+can
+\change_unchanged
+ be prevented by wrapping in a makebox
 \begin_inset Foot
 status collapsed
 
@@ -16784,6 +16815,8 @@ An incorrect line break is easily overlooked because
 
 \end_deeper
 \begin_layout Enumerate
+
+\change_deleted -712698321 1513437701
 The setting is ignored for documents using non-\SpecialChar TeX
  fonts.
 \begin_inset Foot
@@ -16814,9 +16847,13 @@ XeTeXdashbreakstate=0
 \end_inset
 
 
+\change_unchanged
+
 \end_layout
 
 \begin_layout Enumerate
+
+\change_deleted -712698321 1513437705
 Em dashes in 
 \family typewriter
 typewriter
@@ -16830,22 +16867,63 @@ typewriter
 ---
 \family default
  in the output.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Enumerate
-Hyphenation is suppressed in words adjacent to hyphens and ligature dashes.
+
+\change_inserted -712698321 1513437950
+The default dashes output to \SpecialChar LaTeX
+ disable 
+\change_deleted -712698321 1513437951
+H
+\change_inserted -712698321 1513437954
+h
+\change_unchanged
+yphenation 
+\change_deleted -712698321 1513437961
+is suppressed 
+\change_unchanged
+in words adjacent to hyphens and ligature dashes.
 \end_layout
 
 \begin_layout Standard
-If the option 
+If 
+\change_inserted -712698321 1513498511
+you want to globally disable line breaks after dashes, you can select 
+\change_unchanged
+the option 
 \family sans
 Document\SpecialChar menuseparator
 Settings\SpecialChar menuseparator
 Fonts\SpecialChar menuseparator
+
+\change_inserted -712698321 1513498530
+Disallow line breaks after dashes
+\family default
+.
+ In this case optional line breaks after individual
+\family sans
+ dashes
+\change_deleted -712698321 1513438124
 Output en- and em-dashes as ligatures
 \family default
- has not been selected, you can insert optional line breaks via the menu
+ has not been selected, you
+\change_unchanged
+ can 
+\change_inserted -712698321 1513438126
+be 
+\change_deleted -712698321 1513438191
+insert
+\change_inserted -712698321 1513438193
+re-allowed
+\change_unchanged
  
+\change_deleted -712698321 1513438149
+optional line breaks 
+\change_unchanged
+via the menu 
 \family sans
 Insert\SpecialChar menuseparator
 Formatting\SpecialChar menuseparator
@@ -16862,12 +16940,55 @@ should be broken
 \end_layout
 
 \begin_layout Standard
+
+\change_inserted -712698321 1513440855
+Note: Up to \SpecialChar LyX
+
+\begin_inset space ~
+\end_inset
+
+2.1, you could insert en-dashes and em-dashes as -- and ---, respectively;
+ they were automatically merged to proper (breakable) dashes in the output,
+ but kept as consecutive hyphen characters in the LyX document.
+ If you inserted literal dash characters, however, they were output to \SpecialChar LaTeX
+
+ as 
+\emph on
+non-breakable
+\emph default
+ dashes (this was actually rather by accident than intentionally, but some
+ used these two forms of dashes deliberately).
+\change_unchanged
 As of \SpecialChar LyX
 
 \begin_inset space ~
 \end_inset
 
-2.2, -- and --- are exported to LaTeX as -{}- and -{}-{}- to prevent ligation
+2.2, 
+\change_inserted -712698321 1513439795
+things work differently: consecutive hyphens are merged to dashes immediately
+ in the input.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1513439552
+The behavior was changed since it led to different look in \SpecialChar LyX
+, text export,
+ HTML export and the PDF export.
+\end_layout
+
+\end_inset
+
+ If you copy consecutive hyphens, by contrast, they are output as consecutive
+ hyphen characters.
+ An unintended consequence of this change was that all dashes now were output
+ as non-breakable dashes.
+\change_deleted -712698321 1513438403
+-- and --- are exported to LaTeX as -{}- and -{}-{}- to prevent ligation
  to dashes.
 \begin_inset Foot
 status collapsed
@@ -16885,16 +17006,117 @@ Up to \SpecialChar LyX
 
 \end_inset
 
- Occurrences in older documents are converted to literal Unicode dashes.
- This led to different line breaks in some documents.
+
+\change_unchanged
+\change_inserted -712698321 1513439864
+Since furthermore, in order to maintain the output, 
+\change_deleted -712698321 1513439597
+O
+\change_inserted -712698321 1513439745
+o
+\change_unchanged
+ccurrences 
+\change_inserted -712698321 1513439745
+of consecutive hyphens 
+\change_unchanged
+in 
+\change_deleted -712698321 1513439612
+older 
+\change_unchanged
+documents
+\change_inserted -712698321 1513439745
+ that were saved by
+\change_unchanged
+\change_inserted -712698321 1513439745
+\SpecialChar LyX
+
+\begin_inset space ~
+\end_inset
+
+2.1 or earlier versions, 
+\change_deleted -712698321 1513439871
+a
+\change_inserted -712698321 1513439871
+we
+\change_unchanged
+re converted to literal 
+\change_deleted -712698321 1513438458
+Unicode 
+\change_inserted -712698321 1513439745
+en- and em-
+\change_unchanged
+dash
+\change_inserted -712698321 1513439745
+ charact
+\change_unchanged
+e
+\change_inserted -712698321 1513439745
+r
+\change_unchanged
+s
+\change_inserted -712698321 1513439884
+, respectively, these were output to \SpecialChar LaTeX
+ in \SpecialChar LyX
+
+\begin_inset space ~
+\end_inset
+
+2.2 as 
+\emph on
+non-breakable
+\emph default
+ dashes as well
+\change_unchanged
+.
+\change_inserted -712698321 1513439888
+An obvious drawback of all this was that 
+\change_deleted -712698321 1513438506
+This
+\change_inserted -712698321 1513439745
+it 
+\change_deleted -712698321 1513440124
+ led to
+\change_inserted -712698321 1513440127
+resulted in
+\change_unchanged
+ different line breaks in some documents.
  \SpecialChar LyX
 
 \begin_inset space ~
 \end_inset
 
-2.3 provides the aforementioned option 
+2.3
+\change_inserted -712698321 1513439906
+, by contrast and as outlined above, outputs
+\change_unchanged
+\change_inserted -712698321 1513441767
+
+\emph on
+breakable
+\emph default
+ dashes by default, so if you load a document saved previous to LyX 2.2,
+ you should get the identical output with LyX 2.3 for the dashes inserted
+ with -- and ---.
+ Furthermore, \SpecialChar LyX
+
+\begin_inset space ~
+\end_inset
+
+2.3 
+\change_unchanged
+provides the aforementioned option 
+\change_deleted -712698321 1513438447
+
 \family sans
 Output en- and em-dashes as ligatures
+\change_inserted -712698321 1513498544
+Disallow line breaks after dashes
+\change_unchanged
+
 \family default
  in the menu 
 \family sans
@@ -16903,12 +17125,28 @@ Settings\SpecialChar menuseparator
 Fonts.
 
 \family default
- It is on by default but unselected when opening documents edited with \SpecialChar LyX
+ It is o
+\change_deleted -712698321 1513438517
+n
+\change_inserted -712698321 1513441759
+ff
+\change_unchanged
+ by default but 
+\change_deleted -712698321 1513438522
+un
+\change_unchanged
+selected when opening documents edited with \SpecialChar LyX
 
 \begin_inset space ~
 \end_inset
 
-2.2.
+2.2
+\change_inserted -712698321 1513441759
+ in order to maintain line breaking between \SpecialChar LyX
+ 2.2 and 2.3 (so these document
+ have non-breakable dashes)
+\change_unchanged
+.
 \begin_inset Newline newline
 \end_inset
 
@@ -16917,27 +17155,55 @@ Note the following side-effects of the changes in \SpecialChar LyX
 \end_layout
 
 \begin_layout Itemize
-If you used literal em- and en dashes in pre-\SpecialChar LyX
+If you used 
+\change_inserted -712698321 1513440192
+only 
+\change_unchanged
+literal em- and en dashes in pre-\SpecialChar LyX
 
 \begin_inset space ~
 \end_inset
 
-2.2 documents, you must manually unselect 
+2.2 documents, you must manually 
+\change_deleted -712698321 1513438688
+un
+\change_unchanged
+select 
+\change_deleted -712698321 1513438687
+
 \family sans
 Output en- and em-dashes as ligatures
+\change_inserted -712698321 1513498551
+Disallow line breaks after dashes
+\change_unchanged
+
 \family default
  to ensure unchanged behavior.
  
 \end_layout
 
 \begin_layout Itemize
-If you used both, literal and ligature dashes in pre-\SpecialChar LyX
+If you used both
+\change_deleted -712698321 1513441852
+,
+\change_unchanged
+ literal and 
+\change_deleted -712698321 1513441864
+ligature
+\change_inserted -712698321 1513441867
+--/---
+\change_unchanged
+ dashes in pre-\SpecialChar LyX
 
 \begin_inset space ~
 \end_inset
 
 2.2 documents, you may need to enable or prevent individual line breaks as
- shown above to restore the correct line breaking behaviour.
+ shown above to restore the correct line breaking behavio
+\change_deleted -712698321 1513441864
+u
+\change_unchanged
+r.
 \end_layout
 
 \begin_layout Itemize
@@ -28179,7 +28445,7 @@ Name
 \begin_inset CommandInset href
 LatexCommand href
 name "LyX's homepage"
-target "http://www.lyx.org"
+target "https://www.lyx.org"
 literal "false"
 
 \end_inset
@@ -28236,7 +28502,7 @@ Hyperlinks will automatically be hyphenated if necessary in the PDF output,
 \begin_inset CommandInset href
 LatexCommand href
 name "LyX's homepage"
-target "http://www.lyx.org"
+target "https://www.lyx.org"
 literal "false"
 
 \end_inset
@@ -45678,7 +45944,7 @@ Set
 \begin_inset CommandInset href
 LatexCommand href
 name "this image"
-target "http://wiki.lyx.org/uploads/LyX/NewInLyX20/themes.png"
+target "https://wiki.lyx.org/uploads/LyX/NewInLyX20/themes.png"
 literal "false"
 
 \end_inset
@@ -49076,7 +49342,7 @@ The \SpecialChar LyX
 \begin_inset CommandInset href
 LatexCommand href
 name "Credits"
-target "http://www.lyx.org/Credits"
+target "https://www.lyx.org/Credits"
 literal "false"
 
 \end_inset
@@ -49236,7 +49502,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Documentation"
-target "http://mirrors.ctan.org/biblio/bibtex/contrib/doc/btxdoc.pdf"
+target "https://www.ctan.org/tex-archive/biblio/bibtex/contrib/doc/btxdoc.pdf"
 literal "false"
 
 \end_inset
@@ -49276,7 +49542,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Documentation"
-target "http://www.ctan.org/tex-archive/info/bibtex/tamethebeast/ttb_en.pdf"
+target "https://www.ctan.org/tex-archive/info/bibtex/tamethebeast/ttb_en.pdf"
 literal "false"
 
 \end_inset
@@ -49316,7 +49582,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Documentation"
-target "http://www.ctan.org/macros/latex/contrib/biblatex/doc/biblatex.pdf"
+target "https://www.ctan.org/tex-archive/macros/latex/contrib/biblatex/doc/biblatex.pdf"
 literal "false"
 
 \end_inset
@@ -49367,7 +49633,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Documentation"
-target "http://mirrors.ctan.org/biblio/biber/documentation/biber.pdf"
+target "https://www.ctan.org/tex-archive/biblio/biber/documentation/biber.pdf"
 literal "false"
 
 \end_inset
@@ -49418,7 +49684,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Documentation"
-target "http://mirrors.ctan.org/indexing/makeindex/doc/makeindex.pdf"
+target "https://www.ctan.org/tex-archive/indexing/makeindex/doc/makeindex.pdf"
 literal "false"
 
 \end_inset
@@ -49457,7 +49723,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Options"
-target "http://mirrors.ctan.org/indexing/makeindex/doc/manpages.dvi"
+target "https://www.ctan.org/tex-archive/indexing/makeindex/doc/manpages.dvi"
 literal "false"
 
 \end_inset
@@ -49535,7 +49801,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Documentation"
-target "http://www.ams.org/publications/authors/tex/amslatex"
+target "https://www.ams.org/publications/authors/tex/amslatex"
 literal "false"
 
 \end_inset
@@ -49571,7 +49837,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Documentation"
-target "http://mirrors.ctan.org/macros/latex/contrib/caption/caption-eng.pdf"
+target "https://www.ctan.org/tex-archive/macros/latex/contrib/caption/caption-eng.pdf"
 literal "false"
 
 \end_inset
@@ -49622,7 +49888,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Documentation"
-target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
+target "https://www.ctan.org/tex-archive/macros/latex/contrib/enumitem/enumitem.pdf"
 literal "false"
 
 \end_inset
@@ -49673,7 +49939,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Documentation"
-target "http://mirrors.ctan.org/macros/latex/contrib/fancyhdr/fancyhdr.pdf"
+target "https://www.ctan.org/tex-archive/macros/latex/contrib/fancyhdr/fancyhdr.pdf"
 literal "false"
 
 \end_inset
@@ -49724,7 +49990,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Documentation"
-target "http://www.ctan.org/pkg/hyperref"
+target "https://www.ctan.org/tex-archive/macros/latex/contrib/hyperref/doc/manual.pdf"
 literal "false"
 
 \end_inset
@@ -49775,7 +50041,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Documentation"
-target "http://mirrors.ctan.org/macros/latex/contrib/microtype/microtype.pdf"
+target "https://www.ctan.org/tex-archive/macros/latex/contrib/microtype/microtype.pdf"
 literal "false"
 
 \end_inset
@@ -49826,7 +50092,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Documentation"
-target "http://mirrors.ctan.org/macros/latex/contrib/nomencl/nomencl.pdf"
+target "https://www.ctan.org/tex-archive/macros/latex/contrib/nomencl/nomencl.pdf"
 literal "false"
 
 \end_inset
@@ -49877,7 +50143,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Documentation"
-target "http://www.ctan.org/tex-archive/macros/latex/contrib/prettyref/prettyref.pdf"
+target "https://www.ctan.org/tex-archive/macros/latex/contrib/prettyref/prettyref.pdf"
 literal "false"
 
 \end_inset
@@ -49928,7 +50194,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Documentation"
-target "http://www.ctan.org/tex-archive/macros/latex/contrib/refstyle/refstyle.pdf"
+target "https://www.ctan.org/tex-archive/macros/latex/contrib/refstyle/refstyle.pdf"
 literal "false"
 
 \end_inset
@@ -49979,7 +50245,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Wiki-page"
-target "http://wiki.lyx.org/Windows/Arabic"
+target "https://wiki.lyx.org/Windows/Arabic"
 literal "false"
 
 \end_inset
@@ -50015,7 +50281,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Wiki-page"
-target "http://wiki.lyx.org/Windows/Armenian"
+target "https://wiki.lyx.org/Windows/Armenian"
 literal "false"
 
 \end_inset
@@ -50051,7 +50317,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Wiki-page"
-target "http://wiki.lyx.org/Windows/Cyrillic"
+target "https://wiki.lyx.org/Windows/Cyrillic"
 literal "false"
 
 \end_inset
@@ -50087,7 +50353,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Wiki-page"
-target "http://wiki.lyx.org/Windows/Farsi"
+target "https://wiki.lyx.org/Windows/Farsi"
 literal "false"
 
 \end_inset
@@ -50123,7 +50389,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Wiki-page"
-target "http://wiki.lyx.org/Windows/Hebrew"
+target "https://wiki.lyx.org/Windows/Hebrew"
 literal "false"
 
 \end_inset
@@ -50159,7 +50425,7 @@ literal "true"
 \begin_inset CommandInset href
 LatexCommand href
 name "Wiki-page"
-target "http://wiki.lyx.org/Windows/Japanese"
+target "https://wiki.lyx.org/Windows/Japanese"
 literal "false"
 
 \end_inset