]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
- Additional.lyx, Math.lyx, UserGuide.lyx: fix typos
[lyx.git] / lib / doc / UserGuide.lyx
index 24c1bf3232cc411bee2f35aeb12d4c05e0ad1330..e5fb1ac5e4d147c738c8c1574ae738f53bdd3434 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 374
+\lyxformat 387
 \begin_document
 \begin_header
 \textclass scrbook
@@ -56,6 +56,7 @@
 \end_preamble
 \options intoc,bibtotoc,idxtotoc,BCOR7mm,tablecaptionabove
 \use_default_options false
+\maintain_unincluded_children false
 \language english
 \inputencoding auto
 \fontencoding global
 \papercolumns 1
 \papersides 2
 \paperpagestyle default
-\tracking_changes false
+\tracking_changes true
 \output_changes false
-\html_use_mathml true
+\html_math_output 0
 \html_be_strict true
+\html_math_img_scale 1
+\html_latex_start "<span class='latex'>"
+\html_latex_end "</span>"
+\author 1 "Richard Heck" 
 \end_header
 
 \begin_body
@@ -306,7 +311,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.
@@ -431,31 +436,35 @@ name "sec:LaTeX-Setup"
 \end_layout
 
 \begin_layout Standard
-LyX needs several LaTeX packages to work properly.
- The packages found on the system by LyX are listed in the file 
-\emph on
-LaT
-\emph default
-
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
 
-{}
+\change_inserted 1 1269457017
+You can edit documents in LyX without having LaTeX installed, but you will
+ not to able to create PDFs or print your documents unless you do have it
+ installed.
+ Actually, that isn't quite true.
+ Some LyX documents use DocBook as the `backend' that produces PDFs and
+ the like, and any LyX document can be outupt as plain text or as XHTML.
+ Still, most of the documents people edit in LyX use LaTeX as the backend,
+ and so exporting these documents to PDF, or printing them, requires you
+ to have LaTeX properly installed.
 \end_layout
 
-\end_inset
-
+\begin_layout Standard
 
-\emph on
-eX
-\begin_inset space ~
-\end_inset
+\change_inserted 1 1269457113
+Moreover, specific document classes may depend upon specific LaTeX or DocBook
+ classes or packages.
+ Again, such document classes can be used even if you do not have the required
+ files installed, but you will not be able to produce certain kinds of output.
+\end_layout
 
-Configuration
-\emph default
- that will be created when using the menu 
+\begin_layout Standard
+The 
+\change_inserted 1 1269457161
+LaTeX 
+\change_unchanged
+packages that LyX has found on your system are listed in a file you can
+ view from the menu 
 \family sans
 Help\SpecialChar \menuseparator
 LaT
@@ -476,7 +485,17 @@ eX
 Configuration
 \family default
 .
- You should install the required missing packages and then reconfigure LyX.
+
+\change_inserted 1 1269457187
+ If you are missing packages you need, then
+\change_unchanged
+\change_deleted 1 1269457188
+Y
+\change_inserted 1 1269457189
+y
+\change_unchanged
+ou should install the required missing packages and then reconfigure LyX.
 \begin_inset Note Note
 status collapsed
 
@@ -489,7 +508,7 @@ LaTeX
 \begin_inset Quotes erd
 \end_inset
 
is printed with sub- and superscript letters.
from being printed with sub- and superscript letters.
  More about TeX Code is described in section
 \begin_inset space ~
 \end_inset
@@ -528,6 +547,14 @@ Reconfiguration of LyX
 \end_inset
 
 
+\change_inserted 1 1269457202
+ See section 5.1 of the 
+\emph on
+Customization
+\emph default
+ manual for more information on installing additional LaTeX packages.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Chapter
@@ -1705,7 +1732,7 @@ Return
 \end_layout
 
 \begin_layout Standard
-In the preferences dialog, that is opened with the menu 
+In the preferences dialog, which is opened with the menu 
 \family sans
 Tools\SpecialChar \menuseparator
 Preferences
@@ -2332,6 +2359,11 @@ You can select a class using the
 \family sans
 Document\SpecialChar \menuseparator
 Settings
+\change_inserted 1 1269457473
+\SpecialChar \menuseparator
+Document Class
+\change_unchanged
+
 \begin_inset Index idx
 status collapsed
 
@@ -2375,9 +2407,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
@@ -2496,7 +2529,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
 
@@ -2562,13 +2595,140 @@ TUGboat
 \begin_layout Standard
 We won't go into any detail about how to use these different document classes
  here.
- You can find all the details about the non-standard classes in the 
+ You can find all the details about the non-standard classes in Chapter
+ 6 of the 
 \emph on
 Additional Features
 \emph default
  manual.
  Here, we will settle with a list of some of the common properties of all
  of the document classes.
+\change_inserted 1 1269457401
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\change_inserted 1 1269457704
+Why Is My Document Class `Unavailable'?
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 1 1269458954
+New users are sometimes puzzled by the fact that many of the document classes
+ listed under 
+\family sans
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Document Class
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 1 1269457484
+Document ! Settings
+\end_layout
+
+\end_inset
+
+\family default
+are marked as 
+\begin_inset Quotes eld
+\end_inset
+
+Unavailable
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Or they are surprised that, when they try to open the 
+\family sans
+hollywood
+\family default
+ template, they receive a message saying that the document class requires
+ external files to produce output, files that are not installed.
+ Surely something is wrong.
+ Right?
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 1 1269458991
+Nothing is wrong.
+ LyX includes many more document classes than you will ever need to use,
+ and some of them, like 
+\family sans
+hollywood
+\family default
+ (which is used for screenplays), are highly specialized.
+ Indeed, we want LyX to support as many different types of documents as
+ possible, and, as of LyX 2.0, it includes almost one hundred different layout
+ files, with the number growing all the time.
+ No sensible LaTeX distribution will install all of the different files
+ that might be needed by some LyX document class by default.
+ There are too many, and they are too various.
+ That is why some of the document classes are unavailable.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 1 1269459048
+So, if there is a document class you would like to use that is marked as
+ `Unavailable', all you need to do is install the appropriate class or package
+ files.
+ The easiest way to find out which files you need to install is to try selecting
+ that document class.
+ LyX will display a dialog that, among other things, will list the missing
+ files.
+ Most TeX distributions now include a See section 5.1 of the 
+\emph on
+Customization
+\emph default
+ manual for information on how to install them.
+\end_layout
+
+\begin_layout Subsubsection
+
+\change_inserted 1 1269458726
+I Need a Document Class That Isn't Even Listed
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 1 1269459092
+Although, as said, LyX provides support for many different sorts of documents,
+ it does not include support for every document class people might want
+ to use.
+ For example, many universities provide LaTeX class files to be used for
+ dissertations submitted to those universities.
+ For example, the LaTeX document class 
+\family sans
+ucthesis
+\family default
+ is used for dissertations at the University of California.
+ The LyX team cannot write `layout files' to support every one of these.
+ There are too many.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 1 1269459143
+Fortunately, however, users can write their own layout files, and many users
+ have done so.
+ Sometimes, this is quite easy, but sometimes it can be quite hard.
+ Chapter 5 of the 
+\emph on
+Customization
+\emph default
+ manual contains information on how to add support for your favorite document
+ type.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Subsubsection
@@ -2593,12 +2753,11 @@ Document ! Modules
 \end_layout
 
 \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.
- This is of course not available in any document class, so you have to load
- the corresponding module in the 
+Modules load additional features that are not by default available in the
+ chosen document class.
+ For example you might want to write Braille (embossed printing) in a document.
+ This is not available in any document class, so you have to load the correspond
+ing module in the 
 \family sans
 Modules
 \family default
@@ -2620,23 +2779,42 @@ Document ! Settings
  dialog.
  Highlighting a module in the dialog will bring up a description of the
  module.
+\change_inserted 1 1269456873
+
 \end_layout
 
 \begin_layout Standard
-\begin_inset Note Greyedout
-status open
+
+\change_inserted 1 1269456922
+Some modules require LaTeX packages that are not always installed by default.
+ LyX will warn you if you do not have the needed package.
+ You can still use the module while editing your file, but you will not
+ be able to export PDF or print your document, since LyX will not be able
+ to compile the LaTeX file without the missing package.
+ If you want to be able to produce output, then you need to install the
+ missing package and then reconfigure LyX by selecting 
+\family sans
+Tools\SpecialChar \menuseparator
+Reconfigure
+\family default
+.
+\begin_inset Index idx
+status collapsed
 
 \begin_layout Plain Layout
 
-\series bold
-Note:
-\series default
- Some modules require LaTeX packages that are not always installed by default.
- LyX will warn you if you do not have the needed package.
+\change_inserted 1 1269456873
+Reconfiguration of LyX
 \end_layout
 
 \end_inset
 
+ See section 5.1 of the 
+\emph on
+Customization
+\emph default
+ manual for more information on installing needed packages.
+\change_unchanged
 
 \end_layout
 
@@ -2650,6 +2828,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
@@ -3571,8 +3750,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
 
@@ -3587,16 +3766,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
@@ -4138,7 +4324,7 @@ Document Title
 status collapsed
 
 \begin_layout Plain Layout
-Document !Title
+Document ! Title
 \end_layout
 
 \end_inset
@@ -9899,7 +10085,7 @@ Edge
 \end_inset
 
 ) at the beginning of the last two lines.
- The command prints out the phrase within the the two braces, but invisible.
+ The command prints out the phrase within the two braces, but invisible.
  That is why it is named 
 \begin_inset Quotes eld
 \end_inset
@@ -10880,8 +11066,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
 
@@ -10900,7 +11086,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
 
@@ -12721,7 +12907,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
@@ -13053,6 +13239,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
@@ -15585,7 +15852,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,
@@ -15613,7 +15880,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
@@ -18965,7 +19232,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
@@ -19077,7 +19344,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
 
@@ -20251,7 +20518,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
@@ -24471,8 +24738,12 @@ LaTeX-packages ! prettyref
 \end_layout
 
 \begin_layout Standard
-Note that the style <page> won't print the page number if the label is on
- the previous, the same, or the next page.
+
+\family sans
+<page>
+\family default
+ will not print the page number if the label is on the previous, the same,
+ or the next page.
  You will e.
 \begin_inset space \thinspace{}
 \end_inset
@@ -24494,6 +24765,11 @@ on this page
 \end_inset
 
  instead.
+ The style 
+\family sans
+<reference> on page <page>
+\family default
+ will not print anything about the page if the label is on the same page.
 \end_layout
 
 \begin_layout Standard
@@ -24504,7 +24780,7 @@ The number and current page of the referenced document part in the output,
 Format
 \family default
  of the cross-reference window, that appear when you click on the cross-referenc
-e box.
+e.
 \end_layout
 
 \begin_layout Standard
@@ -24520,9 +24796,9 @@ You can only use the style
 \end_layout
 
 \begin_layout Standard
-If you want to reference a section, put the label in the section heading,
- to reference a float, put the label in the caption.
For footnotes you can put the label somewhere in it.
+If you want to reference a section, put the label in the section heading;
+ for floats put the label in the caption; for footnotes put the label in
+ it.
  Referencing formulas is explained in section
 \begin_inset space ~
 \end_inset
@@ -24538,7 +24814,8 @@ reference "sec:Formula-Numbering-and"
 \end_layout
 
 \begin_layout Standard
-The button 
+Right-clicking on a cross-reference opens a context menu.
+ The entry 
 \family sans
 Go
 \begin_inset space ~
@@ -24550,9 +24827,8 @@ to
 
 Label
 \family default
- in the cross-reference window sets the the cursor before the referenced
- label.
- The button text changes then to 
+ sets the cursor before the referenced label.
+ This entry will be renamed in the context menu of the label to 
 \family sans
 Go
 \begin_inset space ~
@@ -24560,9 +24836,8 @@ Go
 
 Back
 \family default
- and you can use it to set the cursor back to the cross-reference.
- Right-clicking on a cross-reference box also sets the cursor before the
- referred label and you can go back with the toolbar button 
+ so that you can use it to set the cursor back to the cross-reference.
+ You can also go back with the toolbar button 
 \begin_inset Graphics
        filename ../images/bookmark-goto_0.png
        BoundingBox 0bp 5bp 20bp 25bp
@@ -24574,13 +24849,13 @@ Back
 \end_layout
 
 \begin_layout Standard
-You can change labels at any time by clicking on the label box.
- References to the changed label will automatically change its link to the
new label text, so that you don't need to take care about this.
+You can change labels at any time.
+ References to the changed label will automatically be updated so that you
do not need to take care about this.
 \end_layout
 
 \begin_layout Standard
-If a cross-reference refers to a non-existent label, you'll see two question
+If a cross-reference refers to a non-existent label, you will see two question
  marks in the output instead of the reference.
 \end_layout
 
@@ -25082,7 +25357,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
@@ -26451,7 +26726,7 @@ key "makeindex,xindy"
 
 \begin_layout Standard
 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
@@ -28215,7 +28490,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
@@ -28502,13 +28777,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
@@ -34634,8 +34914,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
 
@@ -34659,7 +34939,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
@@ -34671,7 +34955,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
@@ -34783,7 +35071,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
 
@@ -35424,7 +35712,7 @@ Using this menu entry or pressing F11 removes the menu bar and all toolbars
  so that you will see nothing but your text.
  It furthermore displays LyX's main window fullscreen.
  To return from fullscreen to the normal view, press F11, or right-click
- and turn off the fullscreen mode in the the context menu.
+ and turn off the fullscreen mode in the context menu.
 \end_layout
 
 \begin_layout Subsection
@@ -41086,7 +41374,7 @@ Some bind-files, like
 math.bind
 \emph default
 , have only a small scope.
- When looking at the the end of the file 
+ When looking at the end of the file 
 \shape italic
 cua.bind
 \shape default
@@ -44427,8 +44715,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"