]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
UserGuide.lyx: fix bug 4192 (hopefully)
[lyx.git] / lib / doc / UserGuide.lyx
index efd97bf25f5f4dc03533edf756aacc86d39a94d0..39061a74a317232ed055b15dcfc29845ef21f3cb 100644 (file)
@@ -4042,7 +4042,7 @@ Standard
  If you want to keep both the current nesting depth and paragraph environment,
  you should use 
 \family sans
-M-Return
+C-Return
 \family default
  to break paragraphs.
 \end_layout
@@ -19435,7 +19435,13 @@ The
 Math\InsetSpace ~
 Panel
 \family default
- contains a number of functions, such as 
+ contains under the button 
+\begin_inset Graphics
+       filename ../images/math/functions.png
+
+\end_inset
+
+ a number of functions, such as 
 \begin_inset Formula $\sin$
 \end_inset
 
@@ -20160,8 +20166,14 @@ You can choose one of the accents by selecting an item from the
 Frame\InsetSpace ~
 decorations
 \family default
- symbol set in the math panel; this will apply to any selection you have
- made within a formula too.
+ symbol set button 
+\begin_inset Graphics
+       filename ../images/math/hat.png
+
+\end_inset
+
+ in the math panel ; this will apply to any selection you have made within
+ a formula too.
 \end_layout
 
 \begin_layout Section
@@ -23868,7 +23880,7 @@ The nomenclature entries are sorted alphabetically by the LaTeX-code of
 a
 \begin_inset LatexCommand nomenclature
 symbol "a"
-description "dummy entry for the character \"a\"\\nomnorefpage"
+description "dummy entry for the character \"a\""
 
 \end_inset
 
@@ -24178,24 +24190,6 @@ nomnorefpage,\InsetSpace ~
 nomnorefeqpage Turns off the corresponding options
 \end_layout
 
-\begin_layout Standard
-The option 
-\series bold
-
-\backslash
-nomnorefpage
-\series default
- was used in this document in the nomenclature entry for the 
-\begin_inset Quotes eld
-\end_inset
-
-a
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
 \begin_layout Subsection
 Printing the Nomenclature
 \begin_inset LatexCommand index
@@ -24373,7 +24367,7 @@ Here is an example, where only the question text appears, the answer branch
 status open
 
 \begin_layout Standard
-Question: Who was the first Physics Nobel prize winner?
+Question: Who was the first physics Nobel prize winner?
 \end_layout
 
 \end_inset
@@ -24383,7 +24377,7 @@ Question: Who was the first Physics Nobel prize winner?
 
 \begin_layout Standard
 \begin_inset Branch Answer
-status collapsed
+status open
 
 \begin_layout Standard
 Answer: Wilhelm Conrad Röntgen
@@ -24687,6 +24681,26 @@ usepackage[labelfont=bf]{caption}
 
 \begin_layout Standard
 to the preamble and the problem is solved.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Standard
+For more commands provided by the 
+\series bold
+caption
+\series default
+ package, have a look at its documentation, 
+\begin_inset LatexCommand cite
+key "caption"
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Standard
@@ -24717,8 +24731,7 @@ bfseries}
 in the preamble and the problem is solved.
  So if you plan to write a large document, you should have a look at the
  documentation of the document class you want to use.
- (Btw.
+ (
 \series bold
 
 \backslash
@@ -25104,8 +25117,11 @@ reference "sub:Settings"
 
 \end_inset
 
- Enable this if you can't spell check words with international letters in
- them.
+ Only enable this if you use 
+\family typewriter
+ispell
+\family default
+ and can't spell check words with international letters in them.
  There have been reports that this does not work with all dictionaries,
  so this is disabled by default.
 \end_layout
@@ -25754,18 +25770,12 @@ Choose your language in the
 \family sans
 Language
 \family default
- section of the 
-\family sans
-Document\SpecialChar \menuseparator
-Settings
-\family default
- dialog.
+ section of this dialog.
  The default is 
 \family sans
 English
 \family default
 .
- Scroll to find the language you want and then click on your choice.
 \end_layout
 
 \begin_layout Standard
@@ -25773,25 +25783,14 @@ The
 \family sans
 Encoding
 \family default
- box lets you choose the character encoding map you want to use.
- When you select the encoding 
-\family sans
-LaTeX\InsetSpace ~
-default
-\family default
- or the option 
-\family sans
-Use language's default encoding
-\family default
-, the encoding is used that LaTeX uses by default for the selected language,
- e.\InsetSpace \thinspace{}
-g.\InsetSpace ~
-for English it is 
+ box lets you choose the character encoding map you want to use for LaTeX
+ export.
+ The option 
 \family sans
-latin9
+use language's default encoding
 \family default
-.
The different encodings are explained in section\InsetSpace ~
+ is the preferred choice and works well in most cases.
For details abhout the different encoding options see section\InsetSpace ~
 
 \begin_inset LatexCommand ref
 reference "sub:Settings"
@@ -25801,62 +25800,6 @@ reference "sub:Settings"
 .
 \end_layout
 
-\begin_layout Standard
-LyX also supports Unicode output, which is particularly useful if you need
- lots of special symbols or non-alphabetic scripts, respectively.
- If you want to use this (and your LaTeX installation supports Unicode,
- for that matter), the 
-\family typewriter
-utf8
-\family default
- encoding is the right choice for most purposes.
- Besides this, you will find some alternative Unicode encodings for specific
- purposes: 
-\family typewriter
-UTF8
-\family default
- and 
-\family typewriter
-utf8x
-\family default
- are provided for CJK languages (Chinese, Japanese, Korean), 
-\family typewriter
-utf8-plain
-\family default
-, finally, should be chosen for 
-\family sans
-XeTeX
-\family default
-, which uses Unicode directly, without the help of the LaTeX-package 
-\series bold
-inputenc
-\series default
-
-\begin_inset LatexCommand index
-name "LaTeX-packages ! inputenc"
-
-\end_inset
-
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-See section\InsetSpace ~
-
-\begin_inset LatexCommand ref
-reference "sub:Settings"
-
-\end_inset
-
- for details.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
 \begin_layout Subsection
 Keyboard mapping configuration
 \end_layout
@@ -31222,7 +31165,7 @@ name "Reconfiguration of LyX"
 
 \begin_layout Standard
 Invoking a menu will start a viewer program.
- The viewer can be set in the preferences, see section\InsetSpace ~
+ The viewer can be set or changed in the preferences, see section\InsetSpace ~
 
 \begin_inset LatexCommand ref
 reference "cha:The-Preferences-dialog"
@@ -31230,8 +31173,7 @@ reference "cha:The-Preferences-dialog"
 \end_inset
 
 .
- The default viewers are set by LyX while it is first configured or later
- reconfigured.
+ The default viewers are set by LyX while it is first configured.
 \end_layout
 
 \begin_layout Standard
@@ -31996,7 +31938,7 @@ Short Title
 Inserts a short title, see section\InsetSpace ~
 
 \begin_inset LatexCommand ref
-reference "sec:Footnotes"
+reference "sec:Short-Titles"
 
 \end_inset
 
@@ -32389,11 +32331,27 @@ name "Language ! Encoding"
 
 \begin_layout Standard
 The document language and quote styles are set here.
- The encoding is necessary to be able to enter characters in the document
- language.
- E.g.
- you want to enter the æ-ligature directly with the keyboard and not by
- using LaTeX-commands.
+ The encoding specifies how the document content is exported to LaTeX (the
+ LyX file is always encoded in utf8).
+ All characters that cannot be encoded using the specified encoding will
+ be exported as LaTeX-commands (this can fail if a LaTeX-command is not
+ known for a particular character).
+\begin_inset Foot
+status collapsed
+
+\begin_layout Standard
+The known commands are defined in a text file.
+ You can add commands for unknown symbols to that file yourself, see the
+\emph on
+Customization
+\emph default
+ manual for details.
+\end_layout
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Standard
@@ -32401,7 +32359,52 @@ If you use the option
 \family sans
 use language's default encoding
 \family default
-, the default encoding for the selected language is used.
+, LyX determines the encoding of a portion of text 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 LaTeX file.
+ If you do not use this option then the complete document will always use
+ exactly one encoding.
+ Checking this option is the preferred setting unless you use 
+\family sans
+XeTeX
+\family default
+
+\begin_inset Foot
+status collapsed
+
+\begin_layout Standard
+XeTeX is a TeX typesetting engine, an alternative for LaTeX.
+ It natively supports Unicode while its input file is assumed to be in UTF-8
+ encoding.
+ More about using LyX with XeTeX can be found in 
+\begin_inset LatexCommand cite
+key "XeTeX"
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+ (see below).
+\end_layout
+
+\begin_layout Standard
+LyX also supports Unicode output, which is particularly useful if you need
+ lots of special symbols or non-alphabetic scripts, respectively.
+ If you want to use this (and your LaTeX installation supports Unicode,
+ for that matter), choose one of the four utf8 variants from the list below.
+ Unfortunately the unicode support of standard LaTeX is quite incomplete,
+ so it is not uncommon that a file with lots of unicode symbols works fine
+ with 
+\family sans
+use language's default encoding
+\family default
+ (when LyX uses it's list of known LaTeX-commands), but does not work with
+ a fixed utf8 encoding (when the list of known LaTeX-commands is ot used,
+ because all unicode symbols can be encoded in utf8).
 \end_layout
 
 \begin_layout Standard
@@ -32409,7 +32412,32 @@ Here is a list with the important encodings:
 \end_layout
 
 \begin_layout Description
-amscii8 encoding for Armenian
+LaTeX\InsetSpace ~
+default Same as 
+\family sans
+use language's default encoding
+\family default
+, but the LaTeX-package 
+\series bold
+inputenc
+\series default
+
+\begin_inset LatexCommand index
+name "LaTeX-packages ! inputenc"
+
+\end_inset
+
+ is not used.
+ You probably need to load some other packages manually in the preamble.
+\end_layout
+
+\begin_layout Description
+armscii8 encoding for Armenian
+\end_layout
+
+\begin_layout Description
+ascii the ASCII encoding, covers only plain English, may result in a big
+ file because lots of LaTeX-commands may be needed
 \end_layout
 
 \begin_layout Description
@@ -32508,52 +32536,67 @@ pt154 Cyrillic for Kazakh
 \end_layout
 
 \begin_layout Description
-utf8 code page for Unicode utf8
+utf8 Unicode utf8 with the LaTeX-package 
+\series bold
+inputenc
+\series default
+
+\begin_inset LatexCommand index
+name "LaTeX-packages ! inputenc"
+
+\end_inset
+
+ (first variant, for latin symbols and some others).
 \end_layout
 
 \begin_layout Description
-UTF8 code page provided for CJK languages (Chinese, Japanese, Korean)
+utf8x Unicode utf8 with the LaTeX-package 
+\series bold
+inputenc
+\series default
+ (second variant, for greek and CJK symbols and some others).
 \end_layout
 
 \begin_layout Description
-utf8-plain code page provided to be used with for 
-\family sans
-XeTeX
-\family default
-
-\begin_inset Foot
-status collapsed
+UTF8 Unicode utf8 with the LaTeX-package 
+\series bold
+CJK
+\series default
 
-\begin_layout Standard
-XeTeX is a TeX typesetting engine, an alternative for LaTeX.
- It natively supports Unicode while its input file is assumed to be in UTF-8
- encoding.
- More about using LyX with XeTeX can be found here: 
-\begin_inset LatexCommand url
-target "http://wiki.lyx.org/LyX/XeTeX"
+\begin_inset LatexCommand index
+name "LaTeX-packages ! CJK"
 
 \end_inset
 
-
+ (for the languages Chinese, Japanese and Korean)
 \end_layout
 
-\end_inset
-
+\begin_layout Description
+utf8-plain Unicode utf8 to be used with 
+\family sans
+XeTeX
+\family default
 , which uses Unicode directly, without the help of the LaTeX-package 
 \series bold
 inputenc
 \series default
+\begin_inset Foot
+status collapsed
 
-\begin_inset LatexCommand index
-name "LaTeX-packages ! inputenc"
+\begin_layout Standard
+More about using LyX with XeTeX can be found in 
+\begin_inset LatexCommand cite
+key "XeTeX"
 
 \end_inset
 
 .
 \end_layout
 
-\begin_layout Description
-utf8x code page provided for CJK languages
+\end_inset
+
+
 \end_layout
 
 \begin_layout Subsubsection*
@@ -34709,7 +34752,13 @@ name "sec:ui"
 
 
 \begin_inset LatexCommand index
-name "User Interface File"
+name "Customization ! of toolbars"
+
+\end_inset
+
+
+\begin_inset LatexCommand index
+name "Customization ! of menus"
 
 \end_inset
 
@@ -34735,6 +34784,18 @@ Note:
 
 \begin_layout Subsubsection
 User Interface File
+\begin_inset LatexCommand index
+name "Customization ! of toolbars"
+
+\end_inset
+
+
+\begin_inset LatexCommand index
+name "Customization ! of menus"
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Standard
@@ -34790,7 +34851,7 @@ Separators
 \family default
 , 
 \family sans
-Icons
+Icons,
 \family default
  and in the case of the 
 \begin_inset Quotes eld
@@ -34800,7 +34861,7 @@ file
 \begin_inset Quotes erd
 \end_inset
 
- menus, a 
+ menus a 
 \family sans
 Lastfiles
 \family default
@@ -34818,7 +34879,7 @@ Item
 \begin_inset Quotes erd
 \end_inset
 
-menu / button name
+menu or button name
 \begin_inset Quotes erd
 \end_inset
 
@@ -35001,8 +35062,8 @@ Save\InsetSpace \thinspace{}
 /\InsetSpace \thinspace{}
 restore window size, or use fixed size
 \family default
- is not checked, you can specify the window size of LyX's main window when
LyX is started.
+ is not checked, you can specify the size of LyX's main window when LyX
+ is started.
 \end_layout
 
 \begin_layout Standard
@@ -35074,11 +35135,28 @@ Cursor follows scrollbar
 
 \begin_layout Subsection
 Screen Fonts
+\begin_inset LatexCommand index
+name "Font ! Screen"
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Standard
 These fonts are used to display your documents on the screen.
- Note that this section only deals with the fonts 
+\end_layout
+
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Standard
+
+\series bold
+Note:
+\series default
+ This section only deals with the fonts 
 \emph on
 inside
 \emph default
@@ -35092,6 +35170,11 @@ Document
 .
 \end_layout
 
+\end_inset
+
+
+\end_layout
+
 \begin_layout Standard
 By default, LyX uses 
 \family typewriter
@@ -35135,7 +35218,7 @@ Zoom
 Screen DPI
 \family default
  is the screen resolution in dpi (dots per inch).
- The Font Sizes are adjusted as letter height in units of points.
+ The Font Sizes are calculated as letter height in units of points.
  72\InsetSpace \thinspace{}
 points have the size of 1\InsetSpace \thinspace{}
 inch, see Appendix\InsetSpace ~
@@ -35207,17 +35290,24 @@ reference "sec:Previewing-snippets-of"
 
 \begin_layout Subsection
 Keyboard Map
+\begin_inset LatexCommand index
+name "Keyboard Map"
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Standard
 Normally keyboard settings have to be done in a menu of your operating system.
  For the case that this is not possible, LyX provides keyboard maps.
- If you have e.g.
- a Czech keyboard but want to write with it like with a Romanian one, you
- can use the keyboard map file named 
-\family sans
+ If you have e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+a Czech keyboard but want to write with it like with a Romanian
+ one, you can use the keyboard map file named 
+\emph on
 romanian.kmap
-\family default
+\emph default
 .
 \end_layout
 
@@ -35230,12 +35320,12 @@ status open
 \series bold
 Note:
 \series default
- Keyboard maps are only provided as makeshift and doesn't work on all systems.
+ Keyboard maps are only provided as makeshift and don't work on all systems.
 \end_layout
 
 \end_inset
 
+
 \end_layout
 
 \begin_layout Section
@@ -36507,7 +36597,7 @@ href
 \series default
  is explained in the 
 \emph on
-Extended Features
+Embedded Objects
 \emph default
  manual.
  It creates a hyperlink.
@@ -36515,6 +36605,14 @@ Extended Features
 
 \end_inset
 
+:
+\newline
+
+\begin_inset LatexCommand url
+target "http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/CREDITS"
+
+\end_inset
+
 
 \end_layout
 
@@ -36602,12 +36700,63 @@ key "LaTeXFAQ"
 
 
 \begin_inset LatexCommand url
-name "LaTeX FAQ"
+name "The LaTeX FAQ:"
 target "http://www.tex.ac.uk/cgi-bin/texfaq2html"
 
 \end_inset
 
 
+\end_layout
+
+\begin_layout Bibliography
+\begin_inset LatexCommand bibitem
+key "caption"
+
+\end_inset
+
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+
+\backslash
+href{ftp://tug.ctan.org/pub/tex-archive/macros/latex/contrib/caption/caption.pdf}{
+\end_layout
+
+\end_inset
+
+Documentation
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+}
+\end_layout
+
+\end_inset
+
+ of the LaTeX-package 
+\series bold
+caption
+\series default
+
+\begin_inset LatexCommand index
+name "LaTeX-packages ! caption"
+
+\end_inset
+
+:
+\newline
+
+\begin_inset LatexCommand url
+target "ftp://tug.ctan.org/pub/tex-archive/macros/latex/contrib/caption/caption.pdf"
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Bibliography
@@ -36651,6 +36800,14 @@ name "LaTeX-packages ! fancyhdr"
 
 \end_inset
 
+:
+\newline
+
+\begin_inset LatexCommand url
+target "ftp://tug.ctan.org/pub/tex-archive/macros/latex/contrib/fancyhdr/fancyhdr.pdf"
+
+\end_inset
+
 
 \end_layout
 
@@ -36695,6 +36852,14 @@ name "LaTeX-packages ! floatflt"
 
 \end_inset
 
+:
+\newline
+
+\begin_inset LatexCommand url
+target "ftp://tug.ctan.org/pub/tex-archive/macros/latex/contrib/floatflt/floatflt.pdf"
+
+\end_inset
+
 
 \end_layout
 
@@ -36738,6 +36903,14 @@ name "LaTeX-packages ! nomencl"
 
 \end_inset
 
+:
+\newline
+
+\begin_inset LatexCommand url
+target "ftp://tug.ctan.org/pub/tex-archive/macros/latex/contrib/nomencl/nomencl.pdf"
+
+\end_inset
+
 
 \end_layout
 
@@ -36781,6 +36954,55 @@ name "LaTeX-packages ! tipa"
 
 \end_inset
 
+:
+\newline
+
+\begin_inset LatexCommand url
+target "http://www.ctan.org/tex-archive/fonts/tipa/tipaman.pdf"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Bibliography
+\begin_inset LatexCommand bibitem
+key "XeTeX"
+
+\end_inset
+
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+
+\backslash
+href{http://wiki.lyx.org/LyX/XeTeX}{
+\end_layout
+
+\end_inset
+
+Wiki-page
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+}
+\end_layout
+
+\end_inset
+
+ how to use LyX with XeTeX:
+\newline
+
+\begin_inset LatexCommand url
+target "http://wiki.lyx.org/LyX/XeTeX"
+
+\end_inset
+
 
 \end_layout
 
@@ -36814,7 +37036,15 @@ status collapsed
 
 \end_inset
 
- how to set up LyX for Arabic
+ how to set up LyX for Arabic:
+\newline
+
+\begin_inset LatexCommand url
+target "http://wiki.lyx.org/Windows/Arabic"
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Bibliography
@@ -36847,7 +37077,15 @@ status collapsed
 
 \end_inset
 
- how to set up LyX for Armenian
+ how to set up LyX for Armenian:
+\newline
+
+\begin_inset LatexCommand url
+target "http://wiki.lyx.org/Windows/Armenian"
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Bibliography
@@ -36880,7 +37118,15 @@ status collapsed
 
 \end_inset
 
- how to set up LyX for Farsi
+ how to set up LyX for Farsi:
+\newline
+
+\begin_inset LatexCommand url
+target "http://wiki.lyx.org/Windows/Farsi"
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Bibliography
@@ -36913,7 +37159,15 @@ status collapsed
 
 \end_inset
 
- how to set up LyX for Hebrew
+ how to set up LyX for Hebrew:
+\newline
+
+\begin_inset LatexCommand url
+target "http://wiki.lyx.org/Windows/Hebrew"
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Bibliography
@@ -36946,13 +37200,21 @@ status collapsed
 
 \end_inset
 
- with a list of all available LyX-functions
+ with a list of all available LyX-functions:
+\newline
+
+\begin_inset LatexCommand url
+target "http://wiki.lyx.org/LyX/LyxFunctionList1-5-1"
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Standard
 
 \newpage
-Bibliography created from a BibTeX-database:
+
 \begin_inset LatexCommand bibtex
 options "biblio/alphadin"
 bibfiles "biblio/LyXDocs"
@@ -36960,6 +37222,13 @@ bibfiles "biblio/LyXDocs"
 \end_inset
 
 
+\end_layout
+
+\begin_layout Standard
+The above bibliography is created from a BibTeX-database.
+\end_layout
+
+\begin_layout Standard
 \begin_inset ERT
 status collapsed