]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
UserGuide.lyx: describe the new preview inset and revise the section about previewing...
[lyx.git] / lib / doc / UserGuide.lyx
index 3b6b0b87edc4ee544577255e05902bb8e60ad8e2..8752000947c088baac2e2c39b5e3831628ecba5a 100644 (file)
@@ -12028,10 +12028,9 @@ reference "sub:LaTeX-font-support"
 \end_inset
 
 ).
- You will then not have access to TeX's own fonts (the selection described
- below).
- Note that LyX lists all available fonts in either of the three lists (roman,
- sans
+ You will then not have access to TeX's own fonts.
+ Note that LyX then lists all available fonts in each of the three lists
+ (roman, sans
 \begin_inset space ~
 \end_inset
 
@@ -12039,7 +12038,7 @@ serif, and typewriter), since LyX cannot determine the family.
  Also note that the output might fail with some of the listed fonts, due
  to the encoding of the fonts and\SpecialChar \slash{}
 or font failures.
Again, LyX cannot determine this in advance, so you might need to experiment.
+ LyX cannot determine this in advance, so you might need to experiment.
 \end_layout
 
 \begin_layout Standard
@@ -12585,10 +12584,20 @@ status collapsed
 X font encoding
 \family default
  selection is an expert setting which lets you change the value passed to
- the LaTeX-package
-\emph on
- fontenc
-\emph default
+ the LaTeX-package 
+\series bold
+fontenc
+\series default
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+LaTeX-packages ! fontenc
+\end_layout
+
+\end_inset
+
  (see also sec.
 \begin_inset space ~
 \end_inset
@@ -12624,16 +12633,18 @@ Use True Small Caps
 \family sans
 Use Old Style Figures
 \family default
- is checked, the font uses old style (also known as medieval or text) figures,
- i.
+ is checked, old style figures (also known as medieval or text figures)
+ are used.
+ Old style figures are the numerals (0
 \begin_inset space \thinspace{}
 \end_inset
 
-e.
-\begin_inset space ~
+-
+\begin_inset space \thinspace{}
 \end_inset
 
-figures with varying height that fit nicely with lower letters.
+9) with ascenders and descenders, which makes them fit nicely with lower
+ letters.
  
 \family sans
 Use True Small Caps
@@ -12660,11 +12671,20 @@ The font will be the argument for the commands of the LaTeX-package
 CJK
 \series default
 .
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+LaTeX-packages ! CJK
+\end_layout
+
+\end_inset
+
  So this has no effect for the document language 
 \family sans
 Japanese
 \family default
- that doesn't use 
+ that does not use 
 \series bold
 CJK
 \series default
@@ -30712,17 +30732,15 @@ Document ! Preview
 \begin_layout Standard
 LyX allows you to generate previews of sections of your document on the
  fly so you can see how they will look in the final document without having
- to break your train of thought with 
-\family sans
-View\SpecialChar \menuseparator
-DVI
-\family default
-.
+ to break your train of thought with viewing the output.
+\end_layout
+
+\begin_layout Subsection
+Prerequisites
 \end_layout
 
 \begin_layout Standard
-If you would for example like to see in LyX your math formulas typeset by
- LaTeX, install the LaTeX-package 
+To get previews working, you need the LaTeX package 
 \series bold
 preview-latex
 \series default
@@ -30736,20 +30754,54 @@ LaTeX-packages ! preview-latex
 
 \end_inset
 
- as explained below, and turn on 
+ (on some systems named simply 
+\series bold
+preview
+\series default
+) installed.
+ If it is not already installed, you will find it in the TeX-catalogue,
+\begin_inset CommandInset citation
+LatexCommand cite
+key "TeXCatalogue"
+
+\end_inset
+
+ or in the package manager of your LaTeX-system.
+ You obtain prettier results if you install the program 
+\family typewriter
+pnmcrop
+\family default
+ from the 
+\family typewriter
+netpbm
+\family default
+ package; for LyX on Windows this program and also the LaTeX-package is
+ automatically installed together with LyX.
+\end_layout
+
+\begin_layout Subsection
+Enabling previews
+\end_layout
+
+\begin_layout Standard
+If you would for example like to see in LyX your math formulas typeset by
+ LaTeX, activate the option 
 \family sans
-Instant
+Display
 \begin_inset space ~
 \end_inset
 
-preview
+Graphics
 \family default
  in the 
 \family sans
 Tools\SpecialChar \menuseparator
 Preferences 
 \family default
-dialog under Look
+dialog under 
+\family sans
+Look
 \begin_inset space ~
 \end_inset
 
@@ -30758,7 +30810,22 @@ and
 \end_inset
 
 feel\SpecialChar \menuseparator
-Display.
+Display
+\family default
+.
+ Then set 
+\family sans
+Instant
+\begin_inset space ~
+\end_inset
+
+Preview
+\family default
+ to 
+\family sans
+On
+\family default
+.
  The 
 \family sans
 Preview
@@ -30773,77 +30840,296 @@ Size
 \begin_layout Standard
 Previews are generated when you load a document into LyX and when you finish
  editing an inset.
- Previews of an already loaded document are 
-\emph on
-not
-\emph default
- generated just by selecting the 
+\end_layout
+
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+Note:
+\series default
+ Previews of an already loaded document are not in every case immediately
+ generated by activating the option 
 \family sans
-Instant
+Display
 \begin_inset space ~
 \end_inset
 
-preview
+Graphics
 \family default
- check box, you have to reopen the documents to activate the previews.
+.
+ Reopening the documents assures to get previews.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+Selected document parts
 \end_layout
 
 \begin_layout Standard
-LyX will generate previews of math insets.
- It will also generate previews of included insets if you select the 
+Besides math there are other cases where you might like to see a preview,
+ fox example things that LyX cannot render like rotated parts or things
+ which are not yet supported by LyX.
+ To do this, insert a preview inset via the menu 
 \family sans
-Show
+Insert\SpecialChar \menuseparator
+Preview
+\family default
+.
+ Insert or paste the stuff that you want to preview into this inset.
+ The preview will be generated when the cursor is outside the preview inset.
+ If you click on the preview, you can edit the previewed stuff.
+\end_layout
+
+\begin_layout Standard
+An example: To create rotated boxes, you use the LaTeX command 
+\series bold
+
+\backslash
+rotatebox
+\series default
+ which is not yet supported by LyX.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+
+\series bold
+
+\backslash
+rotatebox
+\series default
+ is explained in section 
+\emph on
+Rotated and Scaled Boxes
+\emph default
+ of the 
+\emph on
+Embedded
 \begin_inset space ~
 \end_inset
 
-preview
-\family default
- check box in the insert dialog.
- This is useful if you wish to generate a preview of a LaTeX figure, for
- example.
+Objects
+\emph default
+ manual.
+\end_layout
+
+\end_inset
+
+ Instead of the TeX Code boxes you want to see in LyX the final rotated
+ boxes, for example to adjust the rotation angle to fit with the surrounding
+ text.
+ Therefore you create a preview inset and copy the text with the rotated
+ boxes into in.
+ Here is the result:
 \end_layout
 
 \begin_layout Standard
-To get previews working, you need the LaTeX package 
+\begin_inset Preview
+
+\begin_layout Standard
+This is a line
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+rotatebox[origin=r]{-60}{
+\end_layout
+
+\end_inset
+
+
+\begin_inset Box Doublebox
+position "c"
+hor_pos "c"
+has_inner_box 0
+inner_pos "c"
+use_parbox 0
+use_makebox 0
+width "1in"
+special "width"
+height "1in"
+height_special "totalheight"
+status collapsed
+
+\begin_layout Plain Layout
+with rotated
+\end_layout
+
+\end_inset
+
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+}
+\end_layout
+
+\end_inset
+
+ framed text 
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+rotatebox[origin=lb]{60}{
+\end_layout
+
+\end_inset
+
+
+\begin_inset Formula $\int A\,\mathrm{d}x=B$
+\end_inset
+
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+}
+\end_layout
+
+\end_inset
+
+ and a formula.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Previewing works also for colors.
+ In this example a special framed, colored box was created using the LaTeX
+ command 
 \series bold
-preview-latex
+
+\backslash
+fcolorbox
 \series default
- (on some systems named simply 
+:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+
 \series bold
-preview
+
+\backslash
+fcolorbox
 \series default
-) installed.
- If it is not already installed, you will find it in the TeX-catalogue,
-\begin_inset CommandInset citation
-LatexCommand cite
-key "TeXCatalogue"
+ is explained in section 
+\emph on
+Colored Boxes
+\emph default
+ of the 
+\emph on
+Embedded
+\begin_inset space ~
+\end_inset
+
+Objects
+\emph default
+ manual.
+\end_layout
 
 \end_inset
 
- or in the package manager of your LaTeX-system.
- You obtain prettier results if you install the program 
-\family typewriter
-pnmcrop
-\family default
- from the 
-\family typewriter
-netpbm
-\family default
- package; for LyX on Windows this program is automatically installed together
- with LyX.
+
 \end_layout
 
 \begin_layout Standard
-\begin_inset VSpace bigskip
+\begin_inset Preview
+
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+fboxrule 1mm 
+\backslash
+fboxsep 1mm
+\end_layout
+
+\end_inset
+
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+fcolorbox{cyan}{magenta}{
+\end_layout
+
+\end_inset
+
+This is text within a colored, framed box.
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
 \end_inset
 
 
 \end_layout
 
 \begin_layout Standard
-You can furthermore preview the LaTeX source of the whole document or parts
- of it.
+\begin_inset VSpace medskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+If LyX does not show a preview, assure that you enabled previews as described
+ above and also assure that TeX Code in the preview inset is valid and that
+ you loaded the LaTeX packages in your document preamble that are required
+ by the TeX Code.
+ If LyX cannot create a preview, you will in most cases also not be able
+ to view your document due to LaTeX errors.
+ So if you have to use some TeX Code and don't know if it is correct, the
+ preview inset is a nice method to check it without the need to view the
+ whole document.
+\end_layout
+
+\begin_layout Subsection
+LaTeX source code
+\end_layout
+
+\begin_layout Standard
+You can preview the LaTeX source of the whole document or parts of it.
  Use the menu 
 \family sans
 View\SpecialChar \menuseparator
@@ -40233,6 +40519,25 @@ Objects
  manual.
 \end_layout
 
+\begin_layout Subsection
+Preview
+\end_layout
+
+\begin_layout Standard
+Inserts a preview inset, see section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Previewing-snippets-of"
+
+\end_inset
+
+ for a description.
+\end_layout
+
 \begin_layout Section
 The Navigate Menu
 \begin_inset Index idx
@@ -46512,19 +46817,6 @@ reference "sec:Language-encodings"
 .
 \end_layout
 
-\begin_layout Description
-Default
-\begin_inset space ~
-\end_inset
-
-Decimal
-\begin_inset space ~
-\end_inset
-
-Point Define the default decimal point for the use in tables (decimal point
- alignment)
-\end_layout
-
 \begin_layout Description
 Command
 \begin_inset space ~
@@ -46577,6 +46869,19 @@ Command start
  command toggles the package on and off.
 \end_layout
 
+\begin_layout Description
+Default
+\begin_inset space ~
+\end_inset
+
+Decimal
+\begin_inset space ~
+\end_inset
+
+Point Define the default decimal point for the use in tables (decimal point
+ alignment).
+\end_layout
+
 \begin_layout Description
 Set
 \begin_inset space ~
@@ -46709,142 +47014,40 @@ Outputs
 \end_layout
 
 \begin_layout Subsection
-Printer
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Printer"
-
-\end_inset
-
-
-\begin_inset Index idx
-status collapsed
-
-\begin_layout Plain Layout
-Printer
-\end_layout
-
-\end_inset
-
-
-\begin_inset Index idx
-status collapsed
-
-\begin_layout Plain Layout
-Settings ! Printer
-\end_layout
-
-\end_inset
-
-
+General
 \end_layout
 
 \begin_layout Description
-Default
+Output
 \begin_inset space ~
 \end_inset
 
-printer Here you can specify the name of your default printer.
- The name will be used when the 
-\family sans
-Printer command
-\family default
- is executed.
-\begin_inset Newline newline
-\end_inset
-
-
-\begin_inset Note Greyedout
-status open
-
-\begin_layout Plain Layout
-
-\series bold
-Note:
-\series default
- You can leave this field empty on Windows systems because it has no effect.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Description
-Printer
+line
 \begin_inset space ~
 \end_inset
 
-command is the command LyX
-\begin_inset space \thinspace{}
-\end_inset
-
-/
-\begin_inset space \thinspace{}
-\end_inset
-
-LaTeX uses for printing.
- The default is on most systems 
+length sets the maximum number of characters printed in one line when using
+ the menu 
 \family sans
-dvips
-\family default
-.
-\end_layout
-
-\begin_layout Description
-Printer
-\begin_inset space ~
-\end_inset
-
-Command
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+Plain
 \begin_inset space ~
 \end_inset
 
-Options Here you can specify printer options.
- A list of printer options with explanations can be found in the documentation
- of the program that provides the 
-\family sans
-Printer command
+text
 \family default
- you are using.
+.
+ Setting the line line length to 0 means all text is printed in one endless
+ line.
 \end_layout
 
 \begin_layout Description
-Adapt
-\begin_inset space ~
-\end_inset
-
-output
-\begin_inset space ~
-\end_inset
-
-to
+Date
 \begin_inset space ~
 \end_inset
 
-printer This option works only for the 
-\family sans
-Printer command
-\family default
-\begin_inset Quotes eld
-\end_inset
-
-
-\family sans
-dvips
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- It activates a configuration file for dvips.
- This is an option only for dvips experts.
-\end_layout
-
-\begin_layout Subsection
-Date Format
+format
 \begin_inset Index idx
 status collapsed
 
@@ -46864,11 +47067,7 @@ Settings ! Date format
 
 \end_inset
 
-
-\end_layout
-
-\begin_layout Standard
-The date format can be one or a mixture of the formats listed here:
+ The date format can be one or a mixture of the formats listed here:
 \begin_inset Newline newline
 \end_inset
 
@@ -46898,47 +47097,181 @@ For example the format
 prints the date as day/month/year.
 \end_layout
 
-\begin_layout Subsection
-Plain Text
+\begin_layout Description
+Overwrite
+\begin_inset space ~
+\end_inset
+
+on
+\begin_inset space ~
+\end_inset
+
+export Setting what LyX is allowed to overwrite on export.
 \end_layout
 
 \begin_layout Description
-Output
+Forward
 \begin_inset space ~
 \end_inset
 
-line
+search Commands that will be used for the menu 
+\family sans
+Navigate\SpecialChar \menuseparator
+Forward
 \begin_inset space ~
 \end_inset
 
-length sets the maximum number of characters printed in one line when using
- the menu 
+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
+Printer
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Printer"
+
+\end_inset
+
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+Printer
+\end_layout
+
+\end_inset
+
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+Settings ! Printer
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Description
+Default
+\begin_inset space ~
+\end_inset
+
+printer Here you can specify the name of your default printer.
+ The name will be used when the 
 \family sans
-File\SpecialChar \menuseparator
-Export\SpecialChar \menuseparator
-Plain
+Printer command
+\family default
+ is executed.
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+Note:
+\series default
+ You can leave this field empty on Windows systems because it has no effect.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Description
+Printer
 \begin_inset space ~
 \end_inset
 
-text
+command is the command LyX
+\begin_inset space \thinspace{}
+\end_inset
+
+/
+\begin_inset space \thinspace{}
+\end_inset
+
+LaTeX uses for printing.
+ The default is on most systems 
+\family sans
+dvips
 \family default
 .
- Setting the line line length to 0 means all text is printed in one endless
- line.
 \end_layout
 
 \begin_layout Description
-roff
+Printer
 \begin_inset space ~
 \end_inset
 
-command defines an additional command used to produce better ASCII tables
- with the 
-\family typewriter
-groff/troff/nroff
+Command
+\begin_inset space ~
+\end_inset
+
+Options Here you can specify printer options.
+ A list of printer options with explanations can be found in the documentation
+ of the program that provides the 
+\family sans
+Printer command
 \family default
- UNIX-commands (refer to their manuals for more information about them).
- Setting this as empty tells LyX to use the internal formatter.
+ you are using.
+\end_layout
+
+\begin_layout Description
+Adapt
+\begin_inset space ~
+\end_inset
+
+output
+\begin_inset space ~
+\end_inset
+
+to
+\begin_inset space ~
+\end_inset
+
+printer This option works only for the 
+\family sans
+Printer command
+\family default
+\begin_inset Quotes eld
+\end_inset
+
+
+\family sans
+dvips
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ It activates a configuration file for dvips.
+ This is an option only for dvips experts.
 \end_layout
 
 \begin_layout Subsection
@@ -47059,65 +47392,42 @@ Default
  value depends on your LaTeX-system setup.
 \end_layout
 
-\begin_layout Standard
-You can also specify here commands with parameters for the listed applications.
- But before you change something, it is strongly recommended to read the
- manuals of the applications.
- Currently the following commands can be set:
-\end_layout
-
 \begin_layout Description
-CheckTe
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
+DVI
+\begin_inset space ~
+\end_inset
 
-{}
-\end_layout
+viewer
+\begin_inset space ~
+\end_inset
 
+paper
+\begin_inset space ~
 \end_inset
 
-X
+size
 \begin_inset space ~
 \end_inset
 
-command Command for the program 
+options They only have an effect when the program 
 \family sans
-CheckTeX
+xdvi
 \family default
- that is described in the section 
-\emph on
-Checking TeX
-\emph default
- of the 
-\emph on
-Additional Features
-\emph default
- manual.
+ is used as DVI-viewer, read its manual to find out more.
 \end_layout
 
-\begin_layout Description
-BibTe
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-{}
+\begin_layout Standard
+You can also specify here options and commands with parameters for processors.
+ But before you change something, it is strongly recommended to read the
+ manuals of the applications.
 \end_layout
 
-\end_inset
-
-X
+\begin_layout Description
+Bibliography
 \begin_inset space ~
 \end_inset
 
-command Command for the program 
-\family sans
-BibTeX
-\family default
- that generates the bibliography, see section
+generation Settings for the generation of the bibliography, see section
 \begin_inset space ~
 \end_inset
 
@@ -47136,7 +47446,7 @@ Index
 \begin_inset space ~
 \end_inset
 
-command Command for the program that generates the index, see section
+generation Settings for the generation of the index, see section
 \begin_inset space ~
 \end_inset
 
@@ -47170,27 +47480,34 @@ reference "sub:Nomenclature-Program"
 \end_layout
 
 \begin_layout Description
-DVI
-\begin_inset space ~
-\end_inset
+CheckTe
+\begin_inset ERT
+status collapsed
 
-viewer
-\begin_inset space ~
-\end_inset
+\begin_layout Plain Layout
+
+{}
+\end_layout
 
-paper
-\begin_inset space ~
 \end_inset
 
-size
+X
 \begin_inset space ~
 \end_inset
 
-options They only have an effect when the program 
+command Command for the program 
 \family sans
-xdvi
+CheckTeX
 \family default
- is used as DVI-viewer.
+ that is described in the section 
+\emph on
+Checking TeX
+\emph default
+ of the 
+\emph on
+Additional Features
+\emph default
+ manual.
 \end_layout
 
 \begin_layout Standard
@@ -47440,51 +47757,26 @@ Here you find the list of defined file formats that LyX can handle.
 
 \begin_layout Standard
 Furthermore, you can define the 
-\begin_inset Quotes eld
-\end_inset
-
+\family sans
 Default output format
-\begin_inset Quotes erd
-\end_inset
-
- that is used when you hit 
-\begin_inset Quotes eld
-\end_inset
-
-View
-\begin_inset Quotes erd
-\end_inset
-
-, 
-\begin_inset Quotes eld
-\end_inset
-
-Update
-\begin_inset Quotes erd
-\end_inset
-
-, 
-\begin_inset Quotes eld
-\end_inset
-
-View Master Document
-\begin_inset Quotes erd
-\end_inset
-
- and 
-\begin_inset Quotes eld
-\end_inset
-
+\family default
+ that is used when you use 
+\family sans
+View, Update, View Master Document
+\family default
+ or 
+\family sans
 Update Master Document
-\begin_inset Quotes erd
-\end_inset
-
- in the Edit menu or the toolbar.
+\family default
+ in the 
+\family sans
+View
+\family default
+ menu or the toolbar.
 \end_layout
 
 \begin_layout Standard
-More about formats, like the options that can be used in the format definition,
- is described in the section 
+More about formats and their options is described in the section 
 \emph on
 Formats
 \emph default