]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
UserGuide.lyx - few notes for lineno.
[lyx.git] / lib / doc / UserGuide.lyx
index 8026d3190c9179b2975b79900bebad527063d946..3a8ddf60a340edc9ab461198e9d3945db292ea97 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.4 created this file. For more info see https://www.lyx.org/
-\lyxformat 566
+\lyxformat 575
 \begin_document
 \begin_header
 \save_transient_properties true
@@ -57,7 +57,7 @@ logicalmkup
 \maintain_unincluded_children false
 \language english
 \language_package default
-\inputencoding auto
+\inputencoding utf8
 \fontencoding auto
 \font_roman "lmodern" "default"
 \font_sans "lmss" "default"
@@ -141,12 +141,14 @@ logicalmkup
 \papercolumns 1
 \papersides 2
 \paperpagestyle default
+\tablestyle default
 \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"
+\author 5863208 "ab"
 \end_header
 
 \begin_body
@@ -622,6 +624,22 @@ Open
 \end_inset
 
 Recent
+\change_inserted -712698321 1553352530
+
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1553352546
+
+\family sans
+Open
+\begin_inset space ~
+\end_inset
+
+Example
+\change_unchanged
+
 \end_layout
 
 \begin_layout Itemize
@@ -636,6 +654,18 @@ arg   "view-close"
 \end_inset
 
 
+\change_inserted -712698321 1553353355
+
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1553353357
+
+\family sans
+Close All
+\change_unchanged
+
 \end_layout
 
 \begin_layout Itemize
@@ -676,6 +706,26 @@ arg   "buffer-write-as"
 \end_inset
 
 
+\change_inserted -712698321 1553352570
+
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1553352997
+
+\family sans
+Save
+\begin_inset space ~
+\end_inset
+
+As
+\begin_inset space ~
+\end_inset
+
+Template
+\change_unchanged
+
 \end_layout
 
 \begin_layout Itemize
@@ -723,8 +773,25 @@ from
 Template
 \family default
  command lists the available templates.
- Selecting a template will automatically set certain layout features for
- the document, features you would otherwise need to change manually.
+ Selecting a template will automatically set certain layout features 
+\change_inserted -712698321 1553353491
+and possibly propose text fragments 
+\change_unchanged
+for the document, features 
+\change_inserted -712698321 1553353500
+and text 
+\change_unchanged
+you would otherwise need to 
+\change_deleted -712698321 1553353510
+change
+\change_inserted -712698321 1553353510
+set
+\change_unchanged
+\change_inserted -712698321 1553353505
+or enter 
+\change_unchanged
+manually.
  They can be of use for certain classes, especially those for writing letters
  (see section
 \begin_inset space ~
@@ -738,6 +805,18 @@ reference "sec:Document-Classes"
 \end_inset
 
 ).
+
+\change_inserted -712698321 1553353657
+ You can also add your own templates to this list by means of storing a
+ \SpecialChar LyX
+ file with the 
+\family sans
+File\SpecialChar menuseparator
+Save As Template
+\family default
+ function.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Standard
@@ -8346,12 +8425,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
 
@@ -8364,6 +8445,7 @@ The following 2 lines are empty:
 \end_layout
 
 \begin_layout Verbatim
+
 Almost everything is allowed in Verbatim:"%&$§#~'`
 \backslash
 }][{|
@@ -8387,6 +8469,7 @@ Verbatim
 \end_layout
 
 \begin_layout Verbatim*
+
 This is Verbatim*.
 \end_layout
 
@@ -16006,9 +16089,9 @@ those
 \change_unchanged
 even when the dialog isn't visible.
 
-\change_inserted -712698321 1545899208
- A short press will apply the most recent setting again, a longer press
- will open a menu with the (max.
+\change_inserted -712698321 1545905101
+ A press on the button will apply the most recent setting again, a press
on the down-arrow will open a menu with the (max.
  20) most recently applied settings, from which you can select one.
 \change_unchanged
 
@@ -16021,12 +16104,32 @@ character style
 \change_inserted -712698321 1525600823
 text properties of a selection
 \change_unchanged
- to the default, use 
+ to the default, use
+\change_inserted -712698321 1545917704
+ either 
+\change_deleted -712698321 1545917700
+\change_unchanged
+
 \begin_inset Info
 type  "shortcut"
 arg   "font-default"
 \end_inset
 
+
+\change_inserted -712698321 1545917733
+ or select 
+\family sans
+Reset to default
+\family default
+ from the menu of the toolbar button 
+\begin_inset Info
+type  "icon"
+arg   "textstyle-apply"
+\end_inset
+
+
+\change_unchanged
 .
  
 \change_deleted -712698321 1525600803
@@ -21186,7 +21289,11 @@ Insert\SpecialChar menuseparator
 Table
 \family default
 .
- A dialog will appear, asking you for the number of rows and columns.
+ A dialog will appear, asking you for the number of rows and columns
+\change_inserted -712698321 1554288358
+, and you can select a specific (border) style
+\change_unchanged
+.
  The default table has lines around any cell and the first row appears separated
  from the rest of the table.
  This separation appears due to a double line: The cells of the first row
 \end_inset
 
 
+\change_inserted -712698321 1554288479
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1554288540
+This corresponds to the 
+\begin_inset Quotes eld
+\end_inset
+
+Grid with Head
+\begin_inset Quotes erd
+\end_inset
+
+ table style listed in the style selection.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1554288387
+Other available styles include:
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1554288551
+A 
+\begin_inset Quotes eld
+\end_inset
+
+simple grid
+\begin_inset Quotes erd
+\end_inset
+
+ which looks line the above table, but without the first row being separated
+ via double line,
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1554288764
+a border-less table with no lines at all,
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1554289543
+and a so-called 
+\begin_inset Quotes eld
+\end_inset
+
+formal table
+\begin_inset Quotes erd
+\end_inset
+
+ as often used in professional publishing with horizontal lines only and
+ bold top/bottom lines (see 
+\emph on
+Embedded Objects
+\emph default
+ manual, section 
+\emph on
+Formal Tables
+\emph default
+).
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1554288823
+The default style used in the dialog as well as the style used by the toolbar
+ button can be changed in 
+\family sans
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Text Layout
+\family default
+.
+ So if the default style above is not the one you need, you should alter
+ this setting.
 \end_layout
 
 \begin_layout Subsection
@@ -29884,7 +30072,9 @@ status collapsed
 \end_inset
 
 .
- In order to do so, the label needs to be given the form 
+ In order to do so, 
+\change_deleted -712698321 1555659455
+the label needs to be given the form 
 \begin_inset Quotes eld
 \end_inset
 
@@ -29906,7 +30096,9 @@ without
 \emph default
  a blank between the author(s) and the opening parenthesis that delimits
  the year.
- Then, if you select 
+ Then, if you 
+\change_unchanged
+select 
 \family sans
 Natbib
 \begin_inset space ~
@@ -29943,7 +30135,91 @@ noprefix "false"
 
 \end_inset
 
-), you can select between different author-year or author-number styles.
+)
+\change_inserted -712698321 1555660530
+.
+ Once you have done that, the 
+\family sans
+Bibliography
+\family default
+ dialog has three input fields instead of the 
+\family sans
+Label
+\family default
+ field:
+\family sans
+ Author Names
+\family default
+, 
+\family sans
+Year
+\family default
+ and 
+\family sans
+All Author Names
+\family default
+.
+ The first one takes the Author list as it should be displayed in the citation
+ reference, the second the year (without parentheses).
+ These two are madatory.
+ If there are multiple authors and you want to both refer to them as a full
+ list (
+\emph on
+Baker, Jones, and Williams
+\emph default
+) and in abrreviated form (
+\emph on
+Baker et al.
+\emph default
+)
+\change_unchanged
+,
+\change_inserted -712698321 1555660544
+ add the abbreviated form to 
+\family sans
+Author Names
+\family default
+ and the full list to the optional 
+\family sans
+All Author Names
+\family default
+ field.
+
+\change_unchanged
+\change_inserted -712698321 1555659886
+If specified like this, 
+\change_unchanged
+you can select between different author-year or author-number styles
+\change_inserted -712698321 1555660646
+ in the 
+\family sans
+Insert\SpecialChar menuseparator
+Citation
+\family default
+ dialog, and if 
+\family sans
+All Author Names
+\family default
+ is specified, toggling 
+\begin_inset Quotes eld
+\end_inset
+
+All authors
+\begin_inset Quotes erd
+\end_inset
+
+ in the citation dialog or the citation context menu will switch between
+ full and abbreviated list
+\change_unchanged
+.
+
+\change_inserted -712698321 1555660793
+ Note that the author and year specified in the dialog are only used for
+ the citation references.
+ In the bibliography entry, author and year must be added manually.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Standard
@@ -38191,6 +38467,12 @@ New from Template
 This menu entry prompts you for a template to use.
  Selecting a template will automatically set certain layout features for
  the document, features you would otherwise need to change manually.
+
+\change_inserted -712698321 1553353209
+ Furthermore, templates can provide text structures and fragments for recurring
+ writing tasks.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Subsection
@@ -38210,6 +38492,19 @@ The submenu shows a list of the recently opened files.
  Click there on a file to open it.
 \end_layout
 
+\begin_layout Subsection
+
+\change_inserted -712698321 1553352812
+Open Example
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1553352848
+This menu entry gives you quick access to all \SpecialChar LyX
+ example files.
+\end_layout
+
 \begin_layout Subsection
 Close
 \end_layout
@@ -38240,6 +38535,23 @@ Save As
 
 \begin_layout Standard
 Saves the actual document under a new name to create a copy.
+\change_inserted -712698321 1553352868
+
+\end_layout
+
+\begin_layout Subsection
+
+\change_inserted -712698321 1553352875
+Save As Template
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1553352904
+Saves the document in the appropriate templates directory for later use
+ as a template.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Subsection
@@ -40738,13 +41050,25 @@ Inserts document class-specific insets.
  Such insets only exist if they are defined in the layout file for a certain
  document class.
  An example is the document class 
+\change_deleted -712698321 1553354540
+
 \begin_inset Quotes eld
 \end_inset
 
-article (Elsevier)
+article (
+\change_unchanged
+
+\emph on
+Elsevier
+\change_deleted -712698321 1553354543
+
+\emph default
+)
 \begin_inset Quotes erd
 \end_inset
 
+
+\change_unchanged
  with three custom insets.
  The section 
 \emph on
@@ -42768,6 +43092,15 @@ arg   "paste"
 \family sans
 Edit\SpecialChar menuseparator
 Paste
+\change_inserted -712698321 1545905310
+\family default
+or
+\family sans
+ Edit\SpecialChar menuseparator
+Paste Recent
+\change_unchanged
+
 \end_layout
 
 \end_inset
@@ -44905,6 +45238,24 @@ Use justification in \SpecialChar LyX
  justifies the text on screen.
  This only affects the text inside \SpecialChar LyX
  not in the output.
+\change_inserted -712698321 1554288869
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1554288904
+The 
+\family sans
+Default Style
+\family default
+ setting in 
+\family sans
+Table Style
+\family default
+ lets you select which style newly inserted tables should use by default.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Section
@@ -44984,24 +45335,162 @@ The document language and quote styles are set here.
 -commands (this can fail if a \SpecialChar LaTeX
 -command is not known for
  a particular character).
+\change_inserted -712698321 1557594829
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1557596095
+By default, \SpecialChar LyX
+ outputs \SpecialChar LaTeX
+ files in Unicode – or utf8, for that matter (which
+ is nowadays also \SpecialChar LaTeX
+'s default encoding).
+ This should normally fit your needs, since \SpecialChar LaTeX
+'s Unicode support covers the
+ characters of most scripts.
+ Nonetheless it is not yet comprehensive, so there might be cases where
+ using one of the traditional, or 
+\begin_inset Quotes eld
+\end_inset
+
+legacy
+\begin_inset Quotes erd
+\end_inset
+
+, encodings is necessary.
 \end_layout
 
 \begin_layout Standard
+
+\change_inserted -712698321 1557596136
+\SpecialChar LyX
+ provides support for these traditional encodings.
+ If you chose 
+\family sans
+Traditional (auto-selected)
+\family default
+ from the 
+\family sans
+Encodings
+\family default
+ dropdown, \SpecialChar LyX
+ automatically selects the appropriate traditional encoding for
+ the given language(s).
+\change_deleted -712698321 1557595310
+
+\end_layout
+
+\begin_layout Standard
+
+\change_deleted -712698321 1557595310
 If you use the option 
 \family sans
 Language Default
 \family default
 , \SpecialChar LyX
  determines the encoding of a text part from the language of this text.
- If the document contains text in more than one language you may get more
- than one encoding in the \SpecialChar LaTeX
+\change_unchanged
+If the document contains text in more than one language you 
+\change_inserted -712698321 1557595342
+thus 
+\change_unchanged
+may get more than one encoding in the \SpecialChar LaTeX
  file.
- If you do not use this option then the complete document will always use
+\change_deleted -712698321 1557595350
+If you do not use this option then the complete document will always use
  exactly one encoding.
  Checking this option is the preferred setting.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1557596155
+As a third option, \SpecialChar LyX
+ provides the 
+\family sans
+ASCII
+\family default
+ selection.
+ If this is chosen, any character outside the 7bit ASCII range will be output
+ as a \SpecialChar LaTeX
+ command.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1557645585
+Finally, you can also select 
+\family sans
+Custom
+\family default
+, which lets you specify a specific (single) encoding for the whole document.
+ Note that this encoding is then used for 
+\emph on
+any
+\emph default
+ language.
+ The custom list (which is spelled out below) consists of traditional encodings
+ and some special cases of Unicode for specific purposes (see explanation
+ below).
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1557645268
+The 
+\family sans
+Do not load inputenc
+\family default
+ checkbox does what it states: It prevents \SpecialChar LyX
+ from automatically loading the
+ \SpecialChar LaTeX
+-package 
+\series bold
+inputenc
+\series default
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1557645185
+\SpecialChar LaTeX
+ packages ! inputenc
+\end_layout
+
+\end_inset
+
+.
+ This option might be useful if you use a class or package that pre-loads
+ inputenc or if inputenc must not be used for some reason.
+ When using this, you probably need to load some additional packages manually
+ in the preamble and specify the used encoding for text parts in foreign
+ languages in \SpecialChar TeX
+ code.
+ Note that this option is only available for the standard 
+\family sans
+Unicode
+\family default
+ and 
+\family sans
+Traditional (auto-selected)
+\family default
+ encodings.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Standard
+
+\change_deleted -712698321 1557596063
 \SpecialChar LyX
  also supports Unicode output, which is particularly useful if you need
  lots of special symbols or non-alphabetic scripts, respectively.
@@ -45069,6 +45558,8 @@ reference "subsec:Output-file-formats"
 Language Default
 \family default
  fails, you might try out one of these new engines.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Standard
@@ -45203,6 +45694,8 @@ Here is a list with the important encodings:
 \end_layout
 
 \begin_layout Description
+
+\change_deleted -712698321 1557645284
 Language
 \begin_inset space ~
 \end_inset
@@ -45240,6 +45733,8 @@ status collapsed
  in the preamble and specify the used encoding for text parts in foreign
  languages in \SpecialChar TeX
  code.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -45249,6 +45744,19 @@ ASCII the ASCII encoding, covers only plain English (7-bit ASCII).
  commands, which may result in a big
  file when lots of \SpecialChar LaTeX
 -commands are needed.
+
+\change_inserted -712698321 1557596221
+ This is the same as the 
+\family sans
+ASCII
+\family default
+ option in the main 
+\family sans
+Encoding
+\family default
+ dropdown list.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -45720,6 +46228,21 @@ status collapsed
 \end_inset
 
  (for the languages Chinese, Japanese and Korean)
+\change_inserted -712698321 1557596410
+.
+ This encoding is selected by \SpecialChar LyX
+ with the default encoding (
+\family sans
+Unicode (utf8) [default]
+\family default
+ in the main 
+\family sans
+Encoding
+\family default
+ dropdown list) with CJK languages.
+ Normally you do not need to set this encoding manually.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -45783,7 +46306,24 @@ status collapsed
 
 \end_inset
 
- (comprehensive, including Latin, Greek, Cyrillic and CJK scripts).
+ (
+\change_deleted -712698321 1557596443
+comprehensive, 
+\change_unchanged
+including Latin, Greek, Cyrillic and CJK scripts).
+
+\change_inserted -712698321 1557596475
+ This used to be more comprehensive than 
+\family sans
+Unicode
+\begin_inset space ~
+\end_inset
+
+(utf8)
+\family default
+, but meanwhile it is rather outdated.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -45808,8 +46348,24 @@ status collapsed
 \end_inset
 
 .
- Currently only a limited range of characters (mainly for Latin scripts)
+\change_deleted -712698321 1557596266
+Currently only a limited range of characters (mainly for Latin scripts)
  is supported.
+\change_inserted -712698321 1557596400
+This encoding is selected by \SpecialChar LyX
+ with the default encoding (
+\family sans
+Unicode (utf8) [default]
+\family default
+ in the main 
+\family sans
+Encoding
+\family default
+ dropdown list) with non-CJK languages.
+ Normally you do not need to set this encoding manually.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -46222,6 +46778,55 @@ reference "subsec:Numbering-depth"
 \end_inset
 
 .
+\change_inserted 5863208 1558620045
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 5863208 1558620379
+You can typeset lines numbering in the output file by enabling the checkbox
+ at the bottom.
+ The functionality is handled by package lineno and and additional options
+ of this package can be used as well.
+ The most common one are:
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 5863208 1558620630
+right Line numbers to the right margin
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 5863208 1558620589
+switch Line number to the outer margin (left – even pages, right – odd pages)
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 5863208 1558620637
+switch* Line numbers to the inner margin 
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 5863208 1558620780
+modulo Print numbers only on multiples of five lines
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 5863208 1558620792
+displaymath,
+\begin_inset space ~
+\end_inset
+
+mathlines Line numbers for math environments (both options needed).
+\change_unchanged
+
 \end_layout
 
 \begin_layout Section
@@ -48621,7 +49226,15 @@ Document
 \begin_inset space ~
 \end_inset
 
-templates This directory will be opened when you use the menu 
+templates This directory 
+\change_inserted -712698321 1553354019
+contains the templates that are shown 
+\change_deleted -712698321 1553354025
+will be opened when you use the menu
+\change_inserted -712698321 1553354026
+in
+\change_unchanged
 \family sans
 File\SpecialChar menuseparator
 New
@@ -48642,16 +49255,34 @@ Example
 \begin_inset space ~
 \end_inset
 
-files This directory will be opened when you use the button 
+files This directory 
+\change_deleted -712698321 1553354035
+will be opened when you use the
+\change_inserted -712698321 1553354048
+contains the example files that are listed in
+\change_unchanged
+\change_deleted -712698321 1553352959
+button 
 \family sans
 Examples
 \family default
- in the 
+ in the
+\change_unchanged
 \family sans
 File\SpecialChar menuseparator
 Open
+\change_inserted -712698321 1553352950
+ Example
+\change_deleted -712698321 1553352963
+
 \family default
- dialog.
+ dialog
+\change_unchanged
+.
+\change_deleted -712698321 1553354004
+
 \begin_inset Newline newline
 \end_inset
 
@@ -48675,6 +49306,8 @@ Examples
 \end_inset
 
 
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -50924,7 +51557,7 @@ status collapsed
 
 \begin_layout Plain Layout
 
-http://texcatalogue.ctan.org/bytopic.html
+https://ctan.org/topic
 \end_layout
 
 \end_inset