]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
Change the LaTeXBuiltin tag to a NeedsFloatPkg tag. Discussion on the
[lyx.git] / lib / doc / UserGuide.lyx
index f9885bce74eea1a643a68a662f5398f2d832b52c..28d5a8ae06a1a04bb1228e97db3108f3b2e6e38d 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 370
+\lyxformat 378
 \begin_document
 \begin_header
 \textclass scrbook
 \end_preamble
 \options intoc,bibtotoc,idxtotoc,BCOR7mm,tablecaptionabove
 \use_default_options false
+\maintain_unincluded_children false
 \language english
 \inputencoding auto
+\fontencoding global
 \font_roman default
 \font_sans default
 \font_typewriter default
@@ -92,7 +94,8 @@
 \papersize default
 \use_geometry false
 \use_amsmath 1
-\use_esint 0
+\use_esint 1
+\use_mhchem 1
 \cite_engine basic
 \use_bibtopic false
 \use_indices false
 \color #008000
 \end_index
 \secnumdepth 3
-\tocdepth 3
+\tocdepth 2
 \paragraph_separation indent
 \paragraph_indentation default
 \quotes_language english
 \papercolumns 1
 \papersides 2
 \paperpagestyle default
-\tracking_changes true
+\tracking_changes false
 \output_changes false
-\author 1 "Jürgen Spitzmüller" 
+\html_use_mathml true
+\html_be_strict true
 \end_header
 
 \begin_body
@@ -303,7 +307,7 @@ Like most applications, LyX has the familiar menu bar across the top of
 \end_layout
 
 \begin_layout Standard
-Note that there is no horizontal scroll bar.
+Note that there is no horizontal scrollbar.
  This is not a bug or an oversight, but intentional.
  When you read a book, you expect the end of a line to wrap around to the
  next line.
@@ -2372,9 +2376,10 @@ Letter for US-style letters
 
 \begin_layout Standard
 There are also some non-standard classes, which LyX only uses if you have
- installed them.
- Here are some of the classes, the full list with detailed explanations
- can be found in chapter 
+ installed the corresponding LaTeX class files, though most LaTeX distributions
+ will include many of these.
+ Here are some of the classes.
+ The full list with detailed explanations can be found in chapter 
 \emph on
 Special Document Classes
 \emph default
@@ -2493,7 +2498,7 @@ Kluwer Layout for journals of the Kluwer publishing group
 \end_layout
 
 \begin_layout Description
-koma-script a replacement for the standard classes, offers many useful features
+KOMA-Script a replacement for the standard classes, offers many useful features
  like caption formatting, automatic print space calculation etc.
 \end_layout
 
@@ -2592,8 +2597,7 @@ Document ! Modules
 \begin_layout Standard
 Modules load additional features to a document that are not by default available
  in the chosen document class.
- For example you might want to use write Braille (embossed printing) in
- a document.
+ For example you might want to write Braille (embossed printing) in a document.
  This is of course not available in any document class, so you have to load
  the corresponding module in the 
 \family sans
@@ -2647,6 +2651,7 @@ status open
 Note also:
 \series default
  Some modules require other modules, and some pairs of modules are incompatible.
+ LyX will advise you about these things.
 \end_layout
 
 \end_inset
@@ -3568,8 +3573,8 @@ Document ! Settings
 \end_layout
 
 \begin_layout Standard
-If you use a koma-script document class, you can use the default settings.
- Because koma-script calculates then the printspace automatically by taking
+If you use a KOMA-Script document class, you can use the default settings.
+ Because KOMA-Script calculates then the printspace automatically by taking
  the paper format and the font size into account.
 \end_layout
 
@@ -3584,16 +3589,23 @@ everything
 \emph default
  into the new class.
  That includes the paragraph environments.
- Some paragraph environments are standard; all of the document classes have
- them; but some classes have special paragraph environments.
- If this is the case, and you change the document class, LyX sets the missing
- paragraph environments to 
-\family sans
-Standard
-\family default
- and places an error box at the beginning of the paragraph.
- Just click on them and you'll get a message dialog that tells you about
- the conversion and why it failed.
+ Some paragraph environments are standard, in so far as all of the document
+ classes have them; but some classes have special paragraph environments.
+ If this is the case, and you change the document class, LyX will mark the
+ paragraphs whose styles it no longer understands as 
+\begin_inset Quotes eld
+\end_inset
+
+unknown
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The name of the style is retained, in case you should want to go back to
+ the old class.
+ But these paragraphs will be output with no special formatting, so you
+ will either need to create a new style yourself or else to convert these
+ paragraphs manually to a style present in your new document class.
 \end_layout
 
 \begin_layout Section
@@ -4135,7 +4147,7 @@ Document Title
 status collapsed
 
 \begin_layout Plain Layout
-Document !Title
+Document ! Title
 \end_layout
 
 \end_inset
@@ -10877,8 +10889,8 @@ cm
 \family typewriter
 ec
 \family default
- are bitmap fonts, they often looks pixeled in PDF output, especially when
- you read the PDF in a zoomed size.
+ are bitmap fonts, they often looks pixelated in PDF output, especially
when you read the PDF in a zoomed size.
 \begin_inset Foot
 status collapsed
 
@@ -10897,7 +10909,7 @@ Reader
 
 \end_inset
 
- To get rid of pixeled fonts, you have to use a vector font.
+ To get rid of pixelated fonts, you have to use a vector font.
  There are three ways to use one:
 \end_layout
 
@@ -12718,7 +12730,7 @@ device-independent
 \end_layout
 
 \begin_layout Standard
-DVI files doen't contain images, they only link them.
+DVI files do not contain images, they only link them.
  So don't forget to deliver the images together with your DVIs.
  Because the DVI-viewer has to convert the image in the background to make
  it visible when you scroll the DVI, this can slow down your computer when
@@ -13050,6 +13062,87 @@ dvipdfm
  is no longer under development and therefore a bit outdated.
 \end_layout
 
+\begin_layout Subsubsection
+XHTML
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+FileFormats ! XHTML
+\end_layout
+
+\end_inset
+
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+HTML
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+This file type has the extension 
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+.xhtml
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ It is a file suitable for viewing in web browsers.
+ It does not itself contain images and the like but only links them, and
+ when LyX produces XHTML, it also generates corresponding images in formats
+ suitable for the purpose.
+ Math is output as MathML, which renders nicely in browsers that support
+ it, but not all do.
+\end_layout
+
+\begin_layout Standard
+XHTML output remains 
+\begin_inset Quotes eld
+\end_inset
+
+under development
+\begin_inset Quotes erd
+\end_inset
+
+, and not all LyX features are supported yet.
+ See the chapter 
+\begin_inset Quotes eld
+\end_inset
+
+LyX and the World Wide Web
+\begin_inset Quotes erd
+\end_inset
+
+, in the 
+\emph on
+Additional Features
+\emph default
+ manual, for more information.
+\end_layout
+
+\begin_layout Standard
+You can export your document as an XHTML file using the menu item 
+\family sans
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LyXHTML
+\family default
+.
+\end_layout
+
 \begin_layout Subsection
 Previewing
 \begin_inset Index idx
@@ -15582,7 +15675,7 @@ reference "sub:Output-file-formats"
 , every output document format allows only a few image formats.
  LyX uses therefore the program 
 \family typewriter
-Imagemagick
+ImageMagick
 \family default
  in the background to convert the images to the right format.
  To increase your workflow by avoiding these conversions in the background,
@@ -15610,7 +15703,7 @@ Bitmap
 \end_inset
 
 images consist of pixel values, often in a compressed form.
- They are therefore not fully scalable and look pixeled in large zooms.
+ They are therefore not fully scalable and look pixelated in large zooms.
  Well-known bitmap image formats are 
 \begin_inset Quotes eld
 \end_inset
@@ -18962,7 +19055,7 @@ To have multi-line entries in table cells, you have to declare a fixed width
 \bar no
 \noun off
 \color none
-This is a multiline entry in a table.
+This is a multi-line entry in a table.
 \end_layout
 
 \end_inset
@@ -19074,7 +19167,7 @@ This is longer now.
 \bar no
 \noun off
 \color none
-This is a multiline entry in a table.
+This is a multi-line entry in a table.
  This is longer now.
 \end_layout
 
@@ -20248,7 +20341,7 @@ sideways
 
 \begin_layout Standard
 Rotated floats are always placed on their own pages (or columns, when you
- have a multi-column document).
+ have a multicolumn document).
  You can let them span several columns using the float settings option 
 \family sans
 Span
@@ -21868,7 +21961,7 @@ sin
 \end_inset
 
  does normally mean 
-\begin_inset Formula $s·i·n$
+\begin_inset Formula $s\cdot i\cdot n$
 \end_inset
 
 .
@@ -25079,7 +25172,7 @@ reference "sub:Biblio_environment"
 
 .
  If you want anything other than numerical citations that are used in this
- document, like author-year cituations, then you must
+ document, like author-year citations, then you must
 \emph on
  
 \emph default
@@ -25582,25 +25675,13 @@ Entry
 \end_inset
 
 .
- A 
-\change_deleted 1 1250501350
-gray 
-\change_unchanged
-box labeled 
+ A box labeled 
 \begin_inset Quotes eld
 \end_inset
 
 
 \family sans
-I
-\change_inserted 1 1250501353
-n
-\change_unchanged
-d
-\change_inserted 1 1250501354
-e
-\change_unchanged
-x
+Index
 \family default
 
 \begin_inset Quotes erd
@@ -25624,12 +25705,6 @@ key "latexcompanion,latexguide,latexbook"
 .
 \end_layout
 
-\begin_layout Standard
-
-\change_deleted 1 1250501388
-You can change index entries by clicking on the index box.
-\end_layout
-
 \begin_layout Standard
 The index list is inserted in the document with the menu 
 \family sans
@@ -26384,8 +26459,6 @@ key "makeindex,xindy"
 \end_inset
 
 .
-\change_inserted 1 1250502076
-
 \end_layout
 
 \begin_layout Subsection
@@ -26410,34 +26483,20 @@ name "sub:Index-Program"
 \end_layout
 
 \begin_layout Standard
-
-\change_deleted 1 1250501423
-When
-\change_inserted 1 1250501423
-If
-\change_unchanged
- the index entry program 
+If the index entry program 
 \family sans
 xindy
-\change_deleted 1 1250501596
-
 \family default
-, which is only available for Linux,
-\change_unchanged
  is installed, LyX uses it for index generation; otherwise the program 
 \family sans
 makeindex
 \family default
 , that is part of every LaTeX distribution, is used.
-\change_inserted 1 1250501973
-
 \begin_inset Foot
 status collapsed
 
 \begin_layout Plain Layout
 
-\change_inserted 1 1250502015
-
 \family sans
 Makeindex
 \family default
@@ -26451,14 +26510,10 @@ Makeindex
 xindy
 \family default
 .
-\change_unchanged
-
 \end_layout
 
 \end_inset
 
-
-\change_unchanged
  Both programs can be controlled by options that can be set in LyX's preferences
  dialog, see section
 \begin_inset space ~
@@ -26480,30 +26535,13 @@ key "makeindex,xindy"
 \end_inset
 
 .
-\change_inserted 1 1250501656
-In this dialog, 
-\change_deleted 1 1250501657
-Y
-\change_inserted 1 1250501657
-y
-\change_unchanged
-ou can also specify 
-\change_deleted 1 1250501665
-there another
-\change_inserted 1 1250501676
-an alternative
-\change_unchanged
- program to generate the index.
-\change_inserted 1 1250501450
-
+ In this dialog, you can also specify an alternative program to generate
+ the index.
 \end_layout
 
 \begin_layout Standard
-
-\change_inserted 1 1250501906
 If you need specific options or an alternative index program only for a
- given document, you can define the programm and\SpecialChar \slash{}
+ given document, you can define the program and\SpecialChar \slash{}
 or the options in 
 \family sans
 Document\SpecialChar \menuseparator
@@ -26514,40 +26552,13 @@ Indexes
 .
  This is especially useful if you need to pass language-specific options
  to the index program or if you need a specific layout style.
-\change_deleted 1 1250501980
-
-\end_layout
-
-\begin_layout Standard
-
-\change_deleted 1 1250501966
-
-\family sans
-makeindex
-\family default
- is very old, no longer under development and has many pitfalls, notably
- that it was developed with only the English language in mind.
- So it fails to sort anything other than a monolingual English text correctly.
- We have shown above how to fix this sorting.
- However, if you are writing in another language and using Linux, consider
- to use 
-\family sans
-xindy
-\family default
-.
-\change_inserted 1 1250502093
-
 \end_layout
 
 \begin_layout Subsection
-
-\change_inserted 1 1250502212
 Multiple Indexes
 \end_layout
 
 \begin_layout Standard
-
-\change_inserted 1 1250502759
 In many fields, it is common to have more than one index.
  For instance, you might need to set up a separate 
 \begin_inset Quotes eld
@@ -26569,8 +26580,6 @@ splitidx
 status collapsed
 
 \begin_layout Plain Layout
-
-\change_inserted 1 1250502516
 LaTeX-packages ! splitidx
 \end_layout
 
@@ -26592,8 +26601,6 @@ key "TeXCatalogue"
 \end_layout
 
 \begin_layout Standard
-
-\change_inserted 1 1250503374
 To set up LyX for the use of multiple indexes, go to 
 \family sans
 Document\SpecialChar \menuseparator
@@ -26654,8 +26661,6 @@ Alter Color\SpecialChar \ldots{}
 \end_layout
 
 \begin_layout Standard
-
-\change_inserted 1 1250503916
 Once the document changes have been applied, you can find the new index
  list in 
 \family sans
@@ -26680,15 +26685,11 @@ Insert
 \end_layout
 
 \begin_layout Itemize
-
-\change_inserted 1 1250503922
 If you want to change the attribution of a specific index entry, right-clicking
  on the entry will open a dialog where you can do that.
 \end_layout
 
 \begin_layout Itemize
-
-\change_inserted 1 1250504088
 By right-clicking on an index, you can change its type.
  Furthermore, you can specify an index list to be a 
 \begin_inset Quotes eld
@@ -28304,7 +28305,7 @@ Note that some document classes have built-in solutions for well known problems
  like your case.
  For example if you use a 
 \family sans
-koma-script
+KOMA-Script
 \family default
  class, you don't need the package 
 \series bold
@@ -28428,9 +28429,7 @@ preview
 Tools\SpecialChar \menuseparator
 Preferences 
 \family default
-dialog under 
-\family sans
-Look
+dialog under Look
 \begin_inset space ~
 \end_inset
 
@@ -28439,9 +28438,16 @@ and
 \end_inset
 
 feel\SpecialChar \menuseparator
-Graphics
+Display.
+ The 
+\family sans
+Preview
+\begin_inset space ~
+\end_inset
+
+Size
 \family default
-.
+ is the multiplication factor for the size.
 \end_layout
 
 \begin_layout Standard
@@ -28586,13 +28592,18 @@ aspell
 \family typewriter
 ispell
 \family default
-, so that it is recommended to use aspell.
+, and contrary to 
+\family typewriter
+ispell
+\family default
+, it supports multiple languages in parallel, so it is recommended to use
+ aspell.
  
 \family typewriter
 hspell
 \family default
  is a Hebrew spell-checker.
- The used spell checker ind its settings are specified in LyX's preferences
+ The used spell checker and its settings are specified in LyX's preferences
  under 
 \family sans
 Language Settings
@@ -29038,7 +29049,7 @@ s), then you get proposals without adjusting the query in the dialog, and
 \end_layout
 
 \begin_layout Subsection
-Lincense of the Thesaurus library
+License of the Thesaurus library
 \end_layout
 
 \begin_layout Standard
@@ -34605,6 +34616,14 @@ Close
 Closes the current document.
 \end_layout
 
+\begin_layout Subsection
+Close All
+\end_layout
+
+\begin_layout Standard
+Closes all opened documents.
+\end_layout
+
 \begin_layout Subsection
 Save
 \end_layout
@@ -34710,8 +34729,8 @@ You can export your document to various file formats.
 \end_layout
 
 \begin_layout Standard
-Here is a list of all available entries; they are explained in detail in
- section
+Here is a list of all available entries; some of them are explained in detail
in section
 \begin_inset space ~
 \end_inset
 
@@ -34735,7 +34754,11 @@ CJK
 LyX 
 \family default
 format of the special LyX 1.4.x versions for Chinese, Japanese, and Korean
- (CJK); (Since LyX 1.5.0 CJK support is fully integrated to LyX.)
+ (CJK)
+\begin_inset Newline newline
+\end_inset
+
+ Since LyX 1.5.0 CJK support is fully integrated to LyX.
 \end_layout
 
 \begin_layout Description
@@ -34747,7 +34770,7 @@ DVI
 \end_layout
 
 \begin_layout Description
-HTML HTML-format (the HTML-converter is a third-party product and doesn't
+HTML HTML-format (the HTML-converter is a third-party product and may not
  work in all cases)
 \end_layout
 
  is replaced by the version number)
 \end_layout
 
+\begin_layout Description
+LyXHTML HTML-format, using LyX's internal XHTML engine
+\end_layout
+
 \begin_layout Description
 OpenDocument OpenDocument-formatted text file, to be opened with 
 \family sans
@@ -34859,7 +34886,7 @@ KOffice
 Abiword
 \family default
 , etc.
- (the OpenDocument-converter is a third-party product and doesn't work in
+ (The OpenDocument-converter is a third-party product and may not work in
  all cases)
 \end_layout
 
@@ -35478,13 +35505,13 @@ This will split LyX's main window vertically or horizontally.
  or more documents at the same time.
  To return to an unsplit view, use the menu 
 \family sans
-Close Tab Group
+Close Current View
 \family default
 .
 \end_layout
 
 \begin_layout Subsection
-Close Tab Group
+Close Current View
 \end_layout
 
 \begin_layout Standard
@@ -40127,13 +40154,7 @@ Bibliography
 \end_layout
 
 \begin_layout Standard
-You can specify here a citation style using the LaTeX
-\change_inserted 1 1250501112
-\change_deleted 1 1250501112
--
-\change_unchanged
-packages 
+You can specify here a citation style using the LaTeX packages 
 \series bold
 natbib
 \series default
@@ -40161,8 +40182,6 @@ LaTeX-packages ! jurabib
 
 \end_inset
 
-
-\change_inserted 1 1250501161
 , you can enable subdivided bibliographies using the LaTeX package 
 \series bold
 bibtopic
@@ -40172,17 +40191,13 @@ bibtopic
 status collapsed
 
 \begin_layout Plain Layout
-
-\change_inserted 1 1250501123
 LaTeX-packages ! bibtopic
 \end_layout
 
 \end_inset
 
  and you can customize how the bibliography of the given document is being
- generated
-\change_unchanged
-.
+ generated.
  For a further description see section
 \begin_inset space ~
 \end_inset
@@ -40195,19 +40210,13 @@ reference "sec:Bibliography"
 \end_inset
 
 .
-\change_inserted 1 1250501100
-
 \end_layout
 
 \begin_layout Section
-
-\change_inserted 1 1250500845
 Indexes
 \end_layout
 
 \begin_layout Standard
-
-\change_inserted 1 1250501193
 Here, you can customize how the index of your document is being generated
  and you can define additional indexes.
  Please refer to section
@@ -40222,8 +40231,6 @@ reference "sec:Index"
 \end_inset
 
  for details.
-\change_unchanged
-
 \end_layout
 
 \begin_layout Section
@@ -40956,12 +40963,12 @@ Alter
 \end_layout
 
 \begin_layout Subsection
-Graphics
+Display
 \begin_inset Index idx
 status collapsed
 
 \begin_layout Plain Layout
-Settings ! Graphics
+Settings ! Display
 \end_layout
 
 \end_inset
@@ -40970,7 +40977,7 @@ Settings ! Graphics
 \end_layout
 
 \begin_layout Standard
-Here you can specify how graphics inside LyX are displayed.
+Here you can specify if graphics inside LyX are displayed.
 \end_layout
 
 \begin_layout Standard
@@ -40993,6 +41000,26 @@ reference "sec:Previewing-snippets-of"
 .
 \end_layout
 
+\begin_layout Standard
+The option 
+\family sans
+Mark
+\begin_inset space ~
+\end_inset
+
+end
+\begin_inset space ~
+\end_inset
+
+of
+\begin_inset space ~
+\end_inset
+
+paragraphs
+\family default
+ displays a pilcrow (¶) at the end of every paragraph.
+\end_layout
+
 \begin_layout Section
 Editing
 \begin_inset Index idx
@@ -44503,8 +44530,6 @@ The above bibliography is created from a BibTeX-database.
 \end_layout
 
 \begin_layout Standard
-
-\series bold
 \begin_inset CommandInset nomencl_print
 LatexCommand printnomenclature
 set_width "none"