]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
Arabic Intro.lyx: fix LyX logo in section headings
[lyx.git] / lib / doc / UserGuide.lyx
index f0bb7dde72384f4e37374c756d54c6f67d471c03..d8a09d6c5d04c7e8acaea83e23d08749648793ee 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.2 created this file. For more info see http://www.lyx.org/
-\lyxformat 505
+\lyxformat 508
 \begin_document
 \begin_header
 \save_transient_properties true
@@ -1794,14 +1794,21 @@ Right-clicking on elements in the Outline opens in many cases a context
 \end_layout
 
 \begin_layout Standard
-The “Filter” field at the top allows you to restrict which entries appear
- in the Outline.
- For example, if you are displaying the list of Labels and References and
- wish to see only references to subsections, you can enter the text 
+The 
+\family sans
+Filter
+\family default
+ field at the top allows you to restrict which entries appear in the outline.
+ For example, if you are displaying the list of 
+\emph on
+Labels and References
+\emph default
+ and wish to see only references to subsections, you can enter the text
 \begin_inset Quotes eld
 \end_inset
 
-sub:
+sub
 \begin_inset Quotes erd
 \end_inset
 
@@ -1932,6 +1939,11 @@ Shift-Tab
 2.4.1.
 \end_layout
 
+\begin_layout Standard
+By right-clicking on a section in the outliner you can select the whole
+ section to copy, cut or delete it.
+\end_layout
+
 \begin_layout Subsection
 Horizontal Scrolling
 \begin_inset Index idx
@@ -3148,7 +3160,7 @@ IOP
 
 \begin_layout Standard
 If there is a document class you would like to use that is marked as 
-\begin_inset Quotes erd
+\begin_inset Quotes eld
 \end_inset
 
 Unavailable
@@ -4157,19 +4169,19 @@ Default
 \begin_layout Itemize
 
 \family sans
-A0 - A6
+A0  A6
 \end_layout
 
 \begin_layout Itemize
 
 \family sans
-B0 - B6
+B0  B6
 \end_layout
 
 \begin_layout Itemize
 
 \family sans
-C0 - C6
+C0  C6
 \end_layout
 
 \begin_layout Itemize
@@ -4181,7 +4193,7 @@ US letter, US legal, US executive
 \begin_layout Itemize
 
 \family sans
-JIS B0 - JIS B6
+JIS B0  JIS B6
 \end_layout
 
 \begin_layout Itemize
@@ -4625,7 +4637,7 @@ begin{
 \emph on
 environment
 \emph default
-} ...
+} \SpecialChar ldots
  
 \backslash
 end{
@@ -6680,7 +6692,7 @@ The default numbering of numbered lists can be changed by adding an optional
  argument (menu 
 \family sans
 Insert\SpecialChar menuseparator
-Short Title
+Enumerate Options
 \family default
 ) to the first item of each level in the list.
  There you add the command
@@ -12272,8 +12284,8 @@ You shouldn't use forced line breaks to correct \SpecialChar LaTeX
 's line breaking, as \SpecialChar LaTeX
  is
  very good at line breaking.
- There are, however, a number of situations where it is necessaryactively
to set a line break, for example, in a poem or for an address (see sections
+ There are, however, a number of situations where it is necessary to set
a line break actively, for example, in a poem or for an address (see sections
 \begin_inset space ~
 \end_inset
 
@@ -16114,7 +16126,7 @@ reference "sec:File-Formats"
 
 \begin_inset CommandInset ref
 LatexCommand ref
-reference "sec:Doc-Output"
+reference "sec:Doc-Formats"
 
 \end_inset
 
@@ -17049,15 +17061,7 @@ Text
 
 
 \family default
- Use quotes like 
-\begin_inset Quotes sld
-\end_inset
-
-this
-\begin_inset Quotes srd
-\end_inset
-
-
+ Use quotes like ”this”
 \end_layout
 
 \begin_layout Labeling
 \end_layout
 
 \begin_layout Subsection
-The Table dialog
+Table Dialog
 \end_layout
 
 \begin_layout Standard
@@ -19285,12 +19289,12 @@ Default
 \end_layout
 
 \begin_layout Subsection
-Longtables
+Multi-page Tables
 \begin_inset Index idx
 status collapsed
 
 \begin_layout Plain Layout
-Tables ! Longtables
+Tables ! Multi-page
 \end_layout
 
 \end_inset
@@ -19300,7 +19304,7 @@ Tables ! Longtables
 status collapsed
 
 \begin_layout Plain Layout
-Longtables
+Multi-page tables
 \end_layout
 
 \end_inset
@@ -19315,7 +19319,7 @@ Use
 \begin_inset space ~
 \end_inset
 
-long
+multi-page
 \begin_inset space ~
 \end_inset
 
@@ -19323,7 +19327,11 @@ table
 \family default
  in the tab 
 \family sans
-Longtable
+Multi-page
+\begin_inset space ~
+\end_inset
+
+table
 \family default
  of the table dialog to split the table automatically over more pages.
  Doing this enables some check boxes and you can now define:
@@ -19336,7 +19344,7 @@ Header
 \family default
 : The current row and all rows above, that don't have any special options
  defined, are defined to be the header rows of all pages of the longtable.
except for the first page, if 
Except for the first page, if 
 \family sans
 First
 \begin_inset space ~
@@ -19399,7 +19407,7 @@ Insert\SpecialChar menuseparator
 Caption
 \family default
 .
- More about longtable captions can be found in the 
+ More about multi-page table captions can be found in the 
 \emph on
 Embedded
 \begin_inset space ~
@@ -26092,7 +26100,6 @@ arg   "label-insert"
  A gray label box like this: 
 \begin_inset Graphics
        filename clipart/label.png
-       scale 85
 
 \end_inset
 
@@ -26166,7 +26173,6 @@ arg   "dialog-show-new-inset ref"
  A gray cross-reference box like this: 
 \begin_inset Graphics
        filename clipart/reference.png
-       scale 85
 
 \end_inset
 
@@ -26476,8 +26482,12 @@ newref
 \series default
  (refstyle) in the \SpecialChar LaTeX
  preamble of the document.
- For example redefining all references to figures (which have the label
- shortcut 
+ For example, if you are using 
+\series bold
+refstyle
+\series default
+, then redefining all references to figures (which have the label shortcut
 \begin_inset Quotes eld
 \end_inset
 
@@ -26505,8 +26515,41 @@ pageref{#1}}}
 \begin_inset Newline newline
 \end_inset
 
-For more information about the format, have a look at the package documentations
-, 
+Please note that neither 
+\series bold
+prettyref
+\series default
+ nor 
+\series bold
+refstyle
+\series default
+ (nor LyX itself) defines reference formats for all available types.
+ This is especially true for the wide variety of mathematical `theorem'
+ environments.
+ So if you want to make formatted references to, say, Propositions, then
+ you will need to define the relevant format yourself.
+ For 
+\series bold
+prettyref
+\series default
+, you might do so as follows: 
+\begin_inset Newline newline
+\end_inset
+
+
+\series bold
+
+\backslash
+newrefformat{prop}{Proposition 
+\backslash
+ref{#1}}
+\series default
+
+\begin_inset Newline newline
+\end_inset
+
+For more information about the defining formatted references, have a look
+ at the package documentations, 
 \begin_inset CommandInset citation
 LatexCommand cite
 key "prettyref,refstyle"
@@ -30434,8 +30477,17 @@ You can insert complete or incomplete commands as \SpecialChar TeX
  Code.
  Incomplete means that the command argument can be Standard \SpecialChar LyX
  text.
- For example, if you want to draw a frame around a word and are therefore
- using the \SpecialChar LaTeX
+ For example, if you want to draw a frame around a word
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+The LyX way would be to use a framed box.
+\end_layout
+
+\end_inset
+
+ and are therefore using the \SpecialChar LaTeX
 -command 
 \series bold
 
@@ -30463,7 +30515,7 @@ fbox{
 \begin_layout Standard
 \begin_inset Graphics
        filename clipart/ERT.png
-       scale 89
+       scale 95
 
 \end_inset
 
@@ -30759,7 +30811,7 @@ key "latexcompanion,latexguide"
 \end_layout
 
 \begin_layout Standard
-\begin_inset Newpage cleardoublepage
+\begin_inset Newpage clearpage
 \end_inset
 
 
@@ -31011,7 +31063,11 @@ Modules
 \begin_inset Quotes eld
 \end_inset
 
+
+\emph on
 Custom Header/Footerlines
+\emph default
+
 \begin_inset Quotes erd
 \end_inset
 
@@ -31020,7 +31076,7 @@ Custom Header/Footerlines
 \begin_inset space ~
 \end_inset
 
-styles:
+environments:
 \end_layout
 
 \begin_layout Description
@@ -31073,6 +31129,7 @@ Footer
 
 \begin_layout Standard
 for the different positions in the header/footer.
+ These environments can be selected in the environment pull-down box.
 \end_layout
 
 \begin_layout Standard
@@ -31175,7 +31232,7 @@ The normal text on the page goes here.
  The running header is above the text, and the footer is below (including
  footnotes).
  Headers/footers typically contain things like the page number, title of
- the chapter, company logo but your can use almost anything, except of floats.
+ the chapter, company logo but you can use almost anything, except of floats.
 \end_layout
 
 \end_inset
@@ -31320,12 +31377,13 @@ Definition
 \end_layout
 
 \begin_layout Standard
-To define your header line, add all three header styles.
- The things you add to the styles appear on odd numbered pages, the things
- in the optional arguments on even numbered pages.
+To define your header line, add all three header environments.
+ The things you add to each environment appear on odd numbered pages, the
things in the optional arguments on even numbered pages.
  For single-sided documents, the optional arguments will not be used and
  can be omitted.
- If you leave a style or its argument empty, nothing appears in the output.
+ If you leave a header environment or its argument empty, nothing appears
+ in the output.
  Defining the footer line works similarly.
 \end_layout
 
@@ -31417,8 +31475,8 @@ Appearance
 \begin_layout Standard
 The header and footer will appear on normal pages.
  Some pages are different.
- The title page has a style of its own, and so does any page that starts
- a new part or chapter in your book.
+ The title page has a header/footer environment of its own, and so does
+ any page that starts a new part or chapter in your book.
  Such pages will not have the custom headers/footers, but that is normal.
  There is for example no need to print a header with the chapter name on
  the chapter page where the chapter heading is in big bold letters anyway.
@@ -31462,12 +31520,16 @@ headrulewidth}{thickness}
 \begin_layout Standard
 where thickness is a size in standard units like 
 \family sans
+\emph on
 pt
 \family default
+\emph default
  or 
 \family sans
+\emph on
 mm
 \family default
+\emph default
 .
  If you don't want a line, set the thickness to 0
 \begin_inset space \thinspace{}
@@ -31499,9 +31561,9 @@ Several header/footer lines
 
 \begin_layout Standard
 In case you need more than one text line as a header/footer, you can do
- this by adding a normal line break in the style definition.
- However, the default height of the header/footer is only the one of one
- text line.
+ this by adding a ragged line break in the style definition.
+ However, the default height of the header/footer is only the height of
one text line.
  To expand the height, redefine the \SpecialChar LaTeX
  length 
 \series bold
@@ -31515,7 +31577,7 @@ headheight
 \backslash
 footheight
 \series default
in this entry in 
with this entry in 
 \family sans
 Document\SpecialChar menuseparator
 Settings\SpecialChar menuseparator
@@ -31539,14 +31601,34 @@ headheight}{height}
 \end_layout
 
 \begin_layout Standard
-where height is a size in standard units.
- If you don't know which amount of space is needed for the height, define
- your header/footer and preview your document as a PDF.
+where 
+\series bold
+height
+\series default
+ is a size in standard units (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\series bold
+1cm
+\series default
+).
+ If you don't know how much space is needed for the height, define your
+ header/footer and preview your document as a PDF.
  Then open the \SpecialChar LaTeX
  logfile with the menu 
 \family sans
 Document\SpecialChar menuseparator
-LaTeX Log
+LaTeX
+\begin_inset space ~
+\end_inset
+
+Log
 \family default
  and use the button 
 \family sans
@@ -32478,10 +32560,10 @@ 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 
-\begin_inset Formula $\frac{x^{2}}{\sqrt{\frac{x^{2}}{1+x^{2}}}}.$
+\begin_inset Formula $\frac{x^{2}}{\sqrt{\frac{x^{2}}{1+x^{2}}}}$
 \end_inset
 
-
+.
 \end_layout
 
 \begin_layout Subsubsection
@@ -35557,43 +35639,33 @@ Layout
 \end_layout
 
 \begin_layout Subsection
-Table
+Table and Rows & Columns
 \end_layout
 
 \begin_layout Standard
-This menu only appears if the cursor is inside a table.
+These menus only appear if the cursor is inside a table.
  It allows you to create multicolumn and multirow cells, add or remove borders
- of a cell and to set the vertical alignment of the cell.Table Settings and
- Math
+ of a cell and to set the alignment of the cell.
 \end_layout
 
-\begin_layout Standard
-These two menus are only fully active if the cursor is inside a table or
- a formula.
- Here you can change the properties of tables and formulas.
- The properties of tables are described in section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Tables"
-
-\end_inset
-
-, the properties of formulas in chapter
-\begin_inset space ~
-\end_inset
-
+\begin_layout Subsection
+Dissolve Inset
+\end_layout
 
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "chap:Mathematical-Formulas"
+\begin_layout Standard
+This menu only appears if the cursor is inside an inset.
+ It will dissolve this inset.
+ This means that the inset is deleted and its content is left as normal
+ text.
+\end_layout
 
-\end_inset
+\begin_layout Subsection
+Settings or Math
+\end_layout
 
-.
+\begin_layout Standard
+This menu is only active if the cursor is inside an inset or a formula.
+ Here you can change the properties of the inset or the formula.
 \end_layout
 
 \begin_layout Subsection
@@ -36957,7 +37029,7 @@ Captions
 status collapsed
 
 \begin_layout Plain Layout
-Longtables ! Caption
+Tables ! Multi-page ! Caption
 \end_layout
 
 \end_inset
@@ -36966,7 +37038,7 @@ Longtables ! Caption
 \end_layout
 
 \begin_layout Standard
-Inserts a caption in a float or longtable.
+Inserts a caption in a float or multi-page table.
  Floats are described in section
 \begin_inset space ~
 \end_inset
@@ -36978,9 +37050,9 @@ reference "sec:Floats"
 
 \end_inset
 
-; captions in longtables are described in the section 
+; captions in multi-page tables are described in the section 
 \emph on
-Longtable Captions
+Multi-page Captions
 \emph default
  of the 
 \emph on
@@ -37571,7 +37643,7 @@ Format
 
 \begin_inset CommandInset ref
 LatexCommand ref
-reference "sec:Doc-Output"
+reference "sec:Doc-Formats"
 
 \end_inset
 
@@ -37838,7 +37910,7 @@ Format
 
 \begin_inset CommandInset ref
 LatexCommand ref
-reference "sec:Doc-Output"
+reference "sec:Doc-Formats"
 
 \end_inset
 
@@ -37935,7 +38007,7 @@ Format
 
 \begin_inset CommandInset ref
 LatexCommand ref
-reference "sec:Doc-Output"
+reference "sec:Doc-Formats"
 
 \end_inset
 
@@ -42730,10 +42802,10 @@ reference "sec:Branches"
 \end_layout
 
 \begin_layout Section
-Output
+Formats
 \begin_inset CommandInset label
 LatexCommand label
-name "sec:Doc-Output"
+name "sec:Doc-Formats"
 
 \end_inset
 
@@ -42912,6 +42984,39 @@ scaling
  is used for the size of equations in the output.
 \end_layout
 
+\begin_layout Description
+LyX
+\begin_inset space ~
+\end_inset
+
+Format The option 
+\family sans
+Save transient properties
+\family default
+ controls whether document settings that are frequently switched or that
+ are specific to the user are saved with the document.
+ The properties that are affected by option are currently:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+the activation of change tracking
+\end_layout
+
+\begin_layout Itemize
+the output of tracked changes
+\end_layout
+
+\begin_layout Itemize
+the recording of the document directory path.
+\end_layout
+
+\begin_layout Standard
+Disabling the option can prevent issues in collaborative work and/or when
+ using a version control system (for instance unnecessary merge conflicts).
+\end_layout
+
+\end_deeper
 \begin_layout Section
 La
 \family sans
@@ -44684,7 +44789,7 @@ prefix The TEXINPUTS environment variable allows you to use external files
  Note that any non-absolute path listed in the TEXINPUTS prefix is considered
  to be relative to the directory of your \SpecialChar LyX
  file.
- It is recommended that you always include .' as one of the paths; otherwise
+ It is recommended that you always include '.' as one of the paths; otherwise
  compilation may fail for some documents.
 \end_layout
 
@@ -45249,36 +45354,6 @@ export Setting what \SpecialChar LyX
  is allowed to overwrite on export.
 \end_layout
 
-\begin_layout Description
-Forward
-\begin_inset space ~
-\end_inset
-
-search Commands that will be used for the menu 
-\family sans
-Navigate\SpecialChar menuseparator
-Forward
-\begin_inset space ~
-\end_inset
-
-search
-\family default
-.
- For a detailed description see section 
-\emph on
-Reverse DVI/PDF search
-\emph default
- of the 
-\emph on
-Additional
-\begin_inset space ~
-\end_inset
-
-Features
-\emph default
- manual.
-\end_layout
-
 \begin_layout Subsection
 La
 \family sans