]> git.lyx.org Git - features.git/blobdiff - lib/doc/UserGuide.lyx
UG: add nopagebreak section
[features.git] / lib / doc / UserGuide.lyx
index 2efde46e8331e250260fcdb96d5f1ec6f1995b84..b3a827d7ab5ec42b92128f426d8db1615c5e2860 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.4 created this file. For more info see https://www.lyx.org/
-\lyxformat 598
+\lyxformat 599
 \begin_document
 \begin_header
 \save_transient_properties true
@@ -204,7 +204,13 @@ literal "false"
 \begin_inset Newline newline
 \end_inset
 
-Version 2.3.x
+Version 2.
+\change_deleted -131811572 1600339801
+3
+\change_inserted -131811572 1600339801
+4
+\change_unchanged
+.x
 \begin_inset Note Note
 status collapsed
 
@@ -1726,6 +1732,8 @@ steps to minimize memory overhead.
 \end_layout
 
 \begin_layout Standard
+
+\change_deleted -131811572 1600338243
 Note that if you undo all changes to arrive at the document as it was last
  saved, the 
 \begin_inset Quotes eld
@@ -8742,12 +8750,14 @@ 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
 
@@ -8760,6 +8770,7 @@ The following 2 lines are empty:
 \end_layout
 
 \begin_layout Verbatim
+
 Almost everything is allowed in Verbatim:"%&$§#~'`
 \backslash
 }][{|
@@ -8783,6 +8794,7 @@ Verbatim
 \end_layout
 
 \begin_layout Verbatim*
+
 This is Verbatim*.
 \end_layout
 
@@ -12776,6 +12788,65 @@ Page
 \family default
  to insert a clear page break that assures that the next page is a right-hand
  page (odd-numbered), if necessary by adding a page.
+\change_inserted 5863208 1602706231
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\change_inserted 5863208 1602706295
+Suppressing Page Breaks
+\change_unchanged
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 5863208 1602706382
+Page Breaks !
+\change_unchanged
+\change_inserted 5863208 1602706335
+No Page Break
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\change_inserted 5863208 1602706444
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 5863208 1602706504
+To discourage page break at certain point you can use 
+\family sans
+Insert
+\change_unchanged
+\SpecialChar menuseparator
+
+\change_inserted 5863208 1602706512
+Formatting
+\change_unchanged
+\SpecialChar menuseparator
+
+\change_inserted 5863208 1602706556
+No Page Break
+\change_unchanged
+
+\family default
+.
+
+\change_inserted 5863208 1602707015
+ This is typically useful for paragraphs which should stay together or when
+ you want to keep close the description for tables and pictures in case
+ using floats or boxes is not appropriate.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Subsection
@@ -13170,7 +13241,7 @@ text
 \change_unchanged
  styles rather than specifying a particular font.
  For example, instead of changing to an italicized version of the current
- font to emphasize text, you use an 
+ font, to emphasize text you use an 
 \begin_inset Quotes eld
 \end_inset
 
@@ -13178,7 +13249,7 @@ emphasized style
 \begin_inset Quotes erd
 \end_inset
 
- instead.
+.
  This concept fits in perfectly with \SpecialChar LyX
 .
  In \SpecialChar LyX
@@ -17027,12 +17098,28 @@ name "subsec:Output-file-formats"
 \end_layout
 
 \begin_layout Subsubsection
-Simple text (ASCII)
+
+\change_deleted -131811572 1600337594
+Simple
+\change_inserted -131811572 1600337596
+Plain
+\change_unchanged
+ text
+\change_deleted -131811572 1600337574
+ (ASCII)
+\change_unchanged
+
 \begin_inset Index idx
-status collapsed
+status open
 
 \begin_layout Plain Layout
-File formats ! ASCII
+File formats ! 
+\change_deleted -131811572 1600337607
+ASCII
+\change_inserted -131811572 1600337612
+Plain text
+\change_unchanged
+
 \end_layout
 
 \end_inset
@@ -17054,7 +17141,11 @@ This file type has the extension
 \end_inset
 
 .
- It contains your document as plain text following the rules of the 
+ It contains your document as plain text 
+\change_inserted -131811572 1600337643
+in UTF-8 encoding
+\change_deleted -131811572 1600337647
+following the rules of the 
 \begin_inset Quotes eld
 \end_inset
 
@@ -17062,11 +17153,19 @@ American Standard Code for Information Interchange
 \begin_inset Quotes erd
 \end_inset
 
- (ASCII).
+ (ASCII)
+\change_unchanged
+.
 \end_layout
 
 \begin_layout Standard
-You can export your document to ASCII with the menu 
+You can export your document to 
+\change_deleted -131811572 1600337684
+ASCII
+\change_inserted -131811572 1600337686
+plain text
+\change_unchanged
+ with the menu 
 \family sans
 File\SpecialChar menuseparator
 Export\SpecialChar menuseparator
@@ -17123,7 +17222,13 @@ text
 \family default
 .
  This will first internally export your document to PostScript (generating
- thereby the external material) and then do the conversion to ASCII.
+ thereby the external material) and then do the conversion to 
+\change_deleted -131811572 1600337720
+ASCII
+\change_inserted -131811572 1600337722
+plain text
+\change_unchanged
+.
 \end_layout
 
 \begin_layout Subsubsection
@@ -20036,6 +20141,16 @@ g., in Japan)
 status collapsed
 
 \begin_layout Plain Layout
+
+\change_inserted -131811572 1600338376
+\begin_inset CommandInset label
+LatexCommand label
+name "fn:cjk-quotes"
+
+\end_inset
+
+
+\change_unchanged
 Note that these characters are just emulated with similar-looking math symbols
  in many encodings that do not cover these glyphs.
 \end_layout
@@ -20103,6 +20218,32 @@ these inner
 \end_inset
 
 g., in North Korea and China)
+\change_inserted -131811572 1600338410
+
+\begin_inset script superscript
+
+\begin_layout Plain Layout
+
+\change_inserted -131811572 1600338410
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "fn:cjk-quotes"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\change_deleted -131811572 1600338417
+
 \begin_inset Foot
 status collapsed
 
@@ -20114,6 +20255,8 @@ Note that these characters are just emulated with similar-looking math symbols
 \end_inset
 
 
+\change_unchanged
+
 \end_layout
 
 \begin_layout Standard
@@ -21767,7 +21910,6 @@ Each image can define a new group of image settings or join an existing
  the same way.
  So you can for example change the size for a bunch of images without the
  need to manually change each of them.
 \end_layout
 
 \begin_layout Standard
 
 \begin_layout Plain Layout
 
-\size normal
-\noun off
-\color none
 \end_layout
 
 \end_inset
@@ -22658,7 +22796,7 @@ TEL.
 \begin_inset Text
 
 \begin_layout Plain Layout
+
 \series bold
 Example Phone List
 \end_layout
@@ -22722,7 +22860,7 @@ TEL.
 \begin_inset Text
 
 \begin_layout Plain Layout
+
 \series bold
 continue ...
 \end_layout
@@ -23714,7 +23852,7 @@ Franz
 \begin_inset Text
 
 \begin_layout Plain Layout
+
 \end_layout
 
 \end_inset
@@ -25021,12 +25159,11 @@ This is a multi-line entry in a table.
 Cutting and pasting between tables and table cells works reasonably well.
  You can even cut and paste more than one row.
 \begin_inset Foot
-status collapsed
+status open
 
 \begin_layout Plain Layout
 Note that you cannot paste into a multicell selection because it would not
  be clear what to do when pasting a single word in a selected 2×3.
 \end_layout
 
 \end_inset
@@ -25840,7 +25977,6 @@ Minipages
 \end_inset
 
 apply.
 \end_layout
 
 \begin_layout Standard
@@ -29157,7 +29293,25 @@ Enabling AMS-Support
 
 \begin_layout Standard
 You can make the facilities of the AMS-packages explicitly available in
- the document by selecting the checkbox 
+ the document by
+\change_inserted -131811572 1600338725
+ setting 
+\family sans
+Load always
+\family default
+ for 
+\series bold
+amsmath
+\series default
+ and 
+\series bold
+amssymb
+\series default
+ packages
+\change_unchanged
+\change_deleted -131811572 1600338685
+selecting the checkbox 
 \family sans
 Use
 \begin_inset space ~
@@ -29172,6 +29326,8 @@ math
 \end_inset
 
 package
+\change_unchanged
+
 \family default
  in the 
 \family sans
@@ -29700,7 +29856,8 @@ prettyref
 \series bold
 
 \backslash
-newrefformat
+newref\SpecialChar ligaturebreak
+format
 \series default
  (prettyref) or 
 \series bold
@@ -29768,7 +29925,8 @@ prettyref
 \series bold
 
 \backslash
-newrefformat{prop}{Proposition 
+newref\SpecialChar ligaturebreak
+format{prop}{Proposition 
 \backslash
 ref{#1}}
 \series default
 Label
 \family default
  sets the cursor before the referenced label.
+\change_inserted -584632292 1599757593
+(Ctrl-clicking on a cross-reference will also take you to its corresponding
+ label.)
+\change_unchanged
  This entry will be renamed in the context menu of the label to 
 \family sans
 Go
@@ -29945,13 +30107,25 @@ type  "icon"
 arg   "bookmark-goto 0"
 \end_inset
 
+
+\change_inserted -584632292 1599757706
+ or, using the menu: Navigate\SpecialChar menuseparator
+Bookmarks\SpecialChar menuseparator
+Navigate Back
+\change_unchanged
 .
 \end_layout
 
 \begin_layout Standard
 You can change labels at any time.
  References to the changed label will automatically be updated so that you
- do not need to think about this.
+ do not need to 
+\change_deleted -584632292 1599757720
+think about this
+\change_inserted -584632292 1599757724
+change them all manually
+\change_unchanged
+.
 \end_layout
 
 \begin_layout Standard
@@ -29962,21 +30136,13 @@ If a cross-reference refers to a non-existent label, you will see in \SpecialCha
 \end_layout
 
 \begin_layout Standard
-References are described in detail in the section
-\begin_inset space ~
-\end_inset
-
-
+References are described in detail in the section 
 \emph on
 Referencing Floats
 \emph default
  of the 
 \emph on
-Embedded
-\begin_inset space ~
-\end_inset
-
-Objects
+Embedded Objects
 \emph default
  manual.
 \end_layout
@@ -30385,19 +30551,34 @@ name "sec:Counters"
 
 \begin_layout Standard
 
-\change_inserted -584632292 1588374084
+\change_inserted -584632292 1602541139
 One powerful feature of \SpecialChar LaTeX
  is its ability to manage counters.
  Mostly, this is handled automatically, but there are times one wants to
  modify counters directly.
  This can be done in LyX using the counter inset, which is accessible from
- the Insert menu.
- This allows one to set a counter's value; to reset it (to zero); to add
- to the value (or subtract from it, since the value added can be negative);
- to save it; to restore the saved value; and to print the value.
+ the Edit menu.
+ This allows one to set a counter's value; to reset it (to zero);
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -584632292 1602541231
+Note that the section counter, e.g., starts with its value at zero and then
+ is incremented to one when the first section is created.
+ So, if you want the next section to be section five, say, then you need
+ to set the section counter to four.
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ to add to the value (or subtract from it, since the value added can be
+ negative); to save it; to restore the saved value; and to print the value.
  These effects can also be limited to LyX itself.
  And they will appear in HTML and DocBook output, as well as in LaTeX.
 \end_layout
 
 \begin_layout Standard
@@ -31647,184 +31828,6 @@ Additional Features
 
 \end_layout
 
-\begin_layout Subsection
-
-\change_inserted 5863208 1598273424
-Bibliography entries allowing external view of the cited material
-\end_layout
-
-\begin_layout Standard
-
-\change_inserted 5863208 1598273449
-\SpecialChar LyX
- supports viewing the material the selected citation points to – though
- you need to satisfy some conditions so the 
-\family sans
-Open
-\begin_inset space ~
-\end_inset
-
-Citation
-\begin_inset space ~
-\end_inset
-
-Content
-\family default
- in the context menu of the citation inset is active and working.
-\end_layout
-
-\begin_layout Standard
-
-\change_inserted 5863208 1598270259
-There are several ways how to make this feature available:
-\end_layout
-
-\begin_layout Itemize
-
-\change_inserted 5863208 1598273631
-Have citations entries including any of the following fields: 
-\begin_inset Flex Code
-status open
-
-\begin_layout Plain Layout
-
-\change_inserted 5863208 1598273574
-url
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
- or 
-\begin_inset Flex Code
-status open
-
-\begin_layout Plain Layout
-
-\change_inserted 5863208 1598273595
-doi
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
- for BibTeX, 
-\begin_inset Flex Code
-status open
-
-\begin_layout Plain Layout
-
-\change_inserted 5863208 1598273611
-eprint
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
- for BibLaTeX (covering arXiv, JSTOR, PubMed, HDL, Google Books 
-\begin_inset Flex Code
-status open
-
-\begin_layout Plain Layout
-
-\change_inserted 5863208 1598273631
-eprinttype
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
-).
- This will launch web browser with the appropriate link.
-\end_layout
-
-\begin_layout Itemize
-
-\change_inserted 5863208 1598273665
-Having fields pointing to local files on your disk: 
-\begin_inset Flex Code
-status open
-
-\begin_layout Plain Layout
-
-\change_inserted 5863208 1598273656
-file
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
- (filled by JabRef), 
-\begin_inset Flex Code
-status open
-
-\begin_layout Plain Layout
-
-\change_inserted 5863208 1598273665
-localfile
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
- (filled by KBibTeX).
- This will launch appropriate file viewer.
- At the moment only absolute paths are accepted.
-\change_unchanged
-
-\end_layout
-
-\begin_layout Itemize
-
-\change_inserted 5863208 1598273865
-Supplying your own script named either 
-\begin_inset Flex Code
-status open
-
-\begin_layout Plain Layout
-
-\change_inserted 5863208 1598273683
-lyxpaperview
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
- or 
-\begin_inset Flex Code
-status open
-
-\begin_layout Plain Layout
-
-\change_inserted 5863208 1598273697
-lyxpaperview.py
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
-, which takes year and first author name as an input.
- It will be responsibility of this script to search for the appropriate
- file on your disk and launch the viewer.
- This script needs to be found among other executables so 
-\family sans
-Tools\SpecialChar menuseparator
-Reconfigure
-\family default
- can recognize it.
- Example templates with identical names can be found within your installation.
-\change_unchanged
-
-\end_layout
-
 \begin_layout Subsection
 Citation Format
 \begin_inset Index idx
@@ -32350,6 +32353,223 @@ General text after
  fields you can add pre- and postnotes that apply to the whole list.
 \end_layout
 
+\begin_layout Subsection
+
+\change_inserted -712698321 1598509964
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Opening-cited-documents"
+
+\end_inset
+
+Opening cited documents from within \SpecialChar LyX
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1598509000
+\SpecialChar LyX
+ supports opening documents selected citations point to via the 
+\family sans
+Try
+\begin_inset space ~
+\end_inset
+
+to
+\begin_inset space ~
+\end_inset
+
+Open
+\begin_inset space ~
+\end_inset
+
+Citation
+\begin_inset space ~
+\end_inset
+
+Content\SpecialChar ldots
+
+\family default
+ context menu if specific conditions are met:
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1598526971
+If citation entries include any of the fields 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1598508820
+url
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ or 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1598508820
+doi
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ for BibTeX and BibLaTeX, 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1598508820
+eprint
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ for BibLaTeX (covering arXiv, JSTOR, PubMed, HDL, Google Books 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1598508820
+eprinttype
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+), the action will launch a web browser with the appropriate link.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1598509157
+If citation entries include any of the fields 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1598508820
+file
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ (filled by JabRef) or 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1598508820
+localfile
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ (filled by KBibTeX) containing an URL that points to a file on your local
+ drive, the action will launch an appropriate file viewer.
+ At the moment only absolute paths are accepted.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1598526494
+In addition to that, \SpecialChar LyX
+ also searches your disk for matching files if you
+ enable 
+\family sans
+Search drive for cited files
+\family default
+ in 
+\family sans
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar ldots
+\SpecialChar menuseparator
+Edit\SpecialChar menuseparator
+Control
+\family default
+.
+ It uses the tokens supplied at 
+\family sans
+Pattern
+\family default
+ in the same preferences section (by default: year and authors).
+ Any of the tokens in the pattern must occur in the title of the file (at
+ arbitrary position).
+ \SpecialChar LyX
+ opens the first matching file it finds.
+ This might or might not be the file you are looking for; the more systematic
+ your file naming is, and the less ambiguous keywords you use, the greater
+ the chance this works for you.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1598527586
+The pattern syntax uses specific keywords.
+ These are basically Bib\SpecialChar TeX
+ fields (such as 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1598527586
+title
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+) embraced in 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1598509565
+%
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, but there are also special keys, which are documented in the Customization
+ manual, sec.
+\emph on
+Cite format description
+\emph default
+.
+\change_unchanged
+
+\end_layout
+
 \begin_layout Section
 Index
 \begin_inset Index idx
@@ -34947,7 +35167,6 @@ status collapsed
  This means that the reader of your document will be able to click on a
  table of contents entry or on a reference to move to the cross-referenced
  part of the document.
 \end_layout
 
 \begin_layout Standard
@@ -45580,6 +45799,14 @@ arg   "master-buffer-view"
 
 \family sans
 Document\SpecialChar menuseparator
+
+\change_inserted -131811572 1600333746
+View
+\begin_inset space ~
+\end_inset
+
+
+\change_unchanged
 Master
 \begin_inset space ~
 \end_inset
@@ -45653,7 +45880,13 @@ arg   "buffer-toggle-output-sync"
 \family sans
 Document\SpecialChar menuseparator
 Settings\SpecialChar menuseparator
-Output\SpecialChar menuseparator
+
+\change_deleted -131811572 1600333766
+Output
+\change_inserted -131811572 1600333762
+Formats
+\change_unchanged
+\SpecialChar menuseparator
 Synchronize with Output
 \end_layout
 
@@ -45899,7 +46132,6 @@ reference "sec:Document-Classes"
 \end_inset
 
 .
 \end_layout
 
 \begin_layout Standard
@@ -47807,12 +48039,18 @@ switch* Line numbers to the inner margin
 
 \begin_layout Description
 
-\change_inserted 5863208 1558620780
+\change_inserted 5863208 1601989692
 modulo Print numbers only on multiples of five lines
 \end_layout
 
 \begin_layout Description
 
+\change_inserted 5863208 1601989752
+pagewise Restart numbering for each page
+\end_layout
+
+\begin_layout Description
+
 \change_inserted 5863208 1558620792
 displaymath,
 \begin_inset space ~
@@ -49818,6 +50056,59 @@ Math Macros
 Math
 \emph default
  manual.
+\change_inserted -712698321 1598509726
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1598509987
+The option 
+\family sans
+Search drive for cited files
+\family default
+ allows \SpecialChar LyX
+ to query your disk for cited documents when using the 
+\family sans
+Try
+\begin_inset space ~
+\end_inset
+
+to
+\begin_inset space ~
+\end_inset
+
+Open
+\begin_inset space ~
+\end_inset
+
+Citation
+\begin_inset space ~
+\end_inset
+
+Content\SpecialChar ldots
+
+\family default
+ context menu on a citation.
+ The 
+\family sans
+Patterns
+\family default
+ field determines the search pattern.
+ See sec.
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Opening-cited-documents"
+
+\end_inset
+
+ for details.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Subsubsection
@@ -50044,12 +50335,21 @@ Modify
 Modifying an existing shortcut is done the same way.
  You can also bind multiple functions to one shortcut by starting the \SpecialChar LyX
  Function
- definition with “command alternatives” and following it with the different
- function names as a semicolon separated list.
+ definition with “
+\family typewriter
+command
+\change_deleted -131811572 1600337868
+\change_inserted -131811572 1600337869
+-
+\change_unchanged
+alternatives
+\family default
+” and following it with the different function names as a semicolon separated
+ list.
  \SpecialChar LyX
  will then use the first function that is enabled in the current document
  part.
 \end_layout
 
 \begin_layout Standard
@@ -50170,7 +50470,7 @@ Settings ! Keyboard Map
 
 \begin_layout Standard
 Normally keyboard settings are made in a menu of your operating system.
- For the case thatWhere this is not possible, \SpecialChar LyX
+ For the case where this is not possible, \SpecialChar LyX
  provides keyboard maps.
  If, for example, you have a Czech keyboard but want to use it as if it
  is a Romanian one, you can enable