]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
Translate a sentence
[lyx.git] / lib / doc / UserGuide.lyx
index 369f6784192bca7e3e023e8b696fffe51495e890..9b189b31091461f656539b656dfb46e64511908d 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.2 created this file. For more info see http://www.lyx.org/
-\lyxformat 507
+\lyxformat 508
 \begin_document
 \begin_header
 \save_transient_properties true
@@ -1932,6 +1932,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 +3153,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 +4162,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 +4186,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 +4630,7 @@ begin{
 \emph on
 environment
 \emph default
-} ...
+} \SpecialChar ldots
  
 \backslash
 end{
@@ -6680,7 +6685,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
@@ -12276,8 +12281,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
 
@@ -16118,7 +16123,7 @@ reference "sec:File-Formats"
 
 \begin_inset CommandInset ref
 LatexCommand ref
-reference "sec:Doc-Output"
+reference "sec:Doc-Formats"
 
 \end_inset
 
@@ -17053,15 +17058,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
@@ -19344,7 +19341,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 ~
@@ -26100,7 +26097,6 @@ arg   "label-insert"
  A gray label box like this: 
 \begin_inset Graphics
        filename clipart/label.png
-       scale 85
 
 \end_inset
 
@@ -26174,7 +26170,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
 
@@ -26484,8 +26479,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
 
@@ -26513,8 +26512,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"
@@ -31019,7 +31051,11 @@ Modules
 \begin_inset Quotes eld
 \end_inset
 
+
+\emph on
 Custom Header/Footerlines
+\emph default
+
 \begin_inset Quotes erd
 \end_inset
 
@@ -31028,7 +31064,7 @@ Custom Header/Footerlines
 \begin_inset space ~
 \end_inset
 
-styles:
+environments:
 \end_layout
 
 \begin_layout Description
@@ -31081,6 +31117,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
@@ -31183,7 +31220,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
@@ -31328,12 +31365,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
 
@@ -31425,8 +31463,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.
@@ -31470,12 +31508,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{}
@@ -31507,9 +31549,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
@@ -31523,7 +31565,7 @@ headheight
 \backslash
 footheight
 \series default
in this entry in 
with this entry in 
 \family sans
 Document\SpecialChar menuseparator
 Settings\SpecialChar menuseparator
@@ -31547,14 +31589,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
@@ -32486,10 +32548,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
@@ -37569,7 +37631,7 @@ Format
 
 \begin_inset CommandInset ref
 LatexCommand ref
-reference "sec:Doc-Output"
+reference "sec:Doc-Formats"
 
 \end_inset
 
@@ -37836,7 +37898,7 @@ Format
 
 \begin_inset CommandInset ref
 LatexCommand ref
-reference "sec:Doc-Output"
+reference "sec:Doc-Formats"
 
 \end_inset
 
@@ -37933,7 +37995,7 @@ Format
 
 \begin_inset CommandInset ref
 LatexCommand ref
-reference "sec:Doc-Output"
+reference "sec:Doc-Formats"
 
 \end_inset
 
@@ -42728,10 +42790,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
 
@@ -42910,6 +42972,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
@@ -44682,7 +44777,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