]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/Tutorial.lyx
Change the LaTeXBuiltin tag to a NeedsFloatPkg tag. Discussion on the
[lyx.git] / lib / doc / Tutorial.lyx
index 6bf74b937300582f69ae4b5b3e910a66ac7c7675..3410140554963443490eb5eb5f74ef5cfeb83c83 100644 (file)
@@ -1,4 +1,4 @@
-#LyX 1.6.4 created this file. For more info see http://www.lyx.org/
+#LyX 1.6.6svn created this file. For more info see http://www.lyx.org/
 \lyxformat 345
 \begin_document
 \begin_header
@@ -36,6 +36,9 @@
   {LyX}}
 \end_preamble
 \use_default_options false
+\begin_modules
+logicalmkup
+\end_modules
 \language english
 \inputencoding auto
 \font_roman default
@@ -826,13 +829,9 @@ exactly
 User's Guide
 \emph default
  has information about all that.
- It includes 
-\family sans
-HFill
-\family default
-s and vertical space — which are more powerful and versatile than multiple
- spaces or blank lines — and ways to change font sizes, character styles,
- and paragraph alignments by hand.
+ It includes horizontal fills and vertical space — which are more powerful
+ and versatile than multiple spaces or blank lines — and ways to change
+ font sizes, character styles, and paragraph alignments by hand.
  The idea, though, is that you can write your whole document, focusing on
  content, and just worry about that fine-tuning at the end.
  With standard word processors, you will be distracted by document formatting
@@ -1346,11 +1345,7 @@ The
 \family sans
 List
 \family default
-, or 
-\family sans
-Labelling
-\family default
-, environment is a variation on the 
+ environment is a variation on the 
 \family sans
 Description
 \family default
@@ -1436,7 +1431,7 @@ Ctrl+Return
 \family sans
 Standard
 \family default
- environment (or just use the keybinding, 
+ environment (or just use the key binding, 
 \family sans
 Alt+P
 \begin_inset space ~
@@ -1749,7 +1744,7 @@ Environment
 
 \begin_layout Standard
 Font sizes, one- or two-column printing, and page headings are just some
- of the ways journals' typesettings differ from one another.
+ of the ways journals typesettings differ from one another.
  As the Computer Age continues to mature, journals have begun accepting
  electronic submissions, creating LaTeX 
 \begin_inset Quotes eld
@@ -2287,7 +2282,7 @@ Reference
  The Cross-reference dialog pops up.
  It shows a list of the possible labels you can reference.
  At the moment, there should be only one, `sec:About-This-Document'.
- First, select the drop-down menu labelled Format and select '<reference>
+ First, select the drop-down menu labeled Format and select '<reference>
  on page <page>.' Then select `sec:About-This-Document' (it may be selected
  by default), and a reference marker will appear containing `Ref+Text: sec:About
 -This-Document' (To be really correct, you should put a 
@@ -2322,7 +2317,11 @@ Ctrl+V
  than that.
  It refers to `Section 2' and depending how much text you have between the
  start of Section 2 and this cross-reference you may see `on this page,'
- 'on the previous page' or `on page n' (whereas n is the page number).
+ 'on the previous page' or `on page n' (whereas 
+\emph on
+n
+\emph default
+ is the page number).
 \end_layout
 
 \begin_layout Standard
@@ -2497,7 +2496,7 @@ LyX is a typesetting word processor.
 \end_layout
 
 \begin_layout Standard
-Now click on the button labelled 
+Now click on the button labeled 
 \begin_inset Quotes eld
 \end_inset
 
@@ -3014,9 +3013,9 @@ Esc
 \end_layout
 
 \begin_layout Standard
-Run LaTeX and look at the output.
- Notice that the expression was typeset nicely, with spaces between the
- letters and the equals sign, and a superscript 
+Looking at the output you will notice that the expression was typeset nicely,
+ with spaces between the letters and the equals sign, and a superscript
 \begin_inset Quotes eld
 \end_inset
 
@@ -3039,7 +3038,8 @@ This math editor is another example of the WYSIWYM philosophy.
 sqrt
 \family default
 ; this can be frustrating, because you cannot see what an expression looks
- like until you LaTeX the file, and may have to spend time to find e.
+ like until you run the file under LaTeX and you may have to spend time
+ finding e.
 \begin_inset space \thinspace{}
 \end_inset
 
@@ -3114,7 +3114,7 @@ Edit\SpecialChar \menuseparator
 Undo
 \family default
  works in math mode as well as cut and paste.
- One thing to be careful of: If you are left or right outside a formula
+ One thing to be careful of: if you are left or right outside a formula
  and you press 
 \family sans
 Delete
@@ -3123,7 +3123,7 @@ Delete
 \family sans
 Backspace
 \family default
-, respectively, you delete the whole formula.
+ respectively, you delete the whole formula.
  Luckily, you can just use 
 \family sans
 Undo
@@ -3186,7 +3186,7 @@ Up
 Down
 \family default
  will move the cursor back to the regular level.
When you hit 
If you hit 
 \family sans
 Space
 \family default
@@ -3245,16 +3245,16 @@ Esc
 \end_layout
 
 \begin_layout Standard
-Writing a subscript (index) is just as easy — start one by typing the underscore
- key, 
+Writing a subscript (index) is just easy; start one by typing the underscore
+ key 
 \begin_inset Quotes eld
 \end_inset
 
 _
-\begin_inset Quotes eld
+\begin_inset Quotes erd
 \end_inset
 
-.
+ .
  You can subscript and superscript both subscripts and superscripts like
  this: 
 \begin_inset Formula $A_{a_{0}+b^{2}}+C^{a_{0}+b^{2}}$
@@ -3277,7 +3277,7 @@ example_raw.lyx
 \end_layout
 
 \begin_layout Section
-The Math Toolbar
+The Math toolbar
 \end_layout
 
 \begin_layout Standard
@@ -3287,7 +3287,7 @@ Math
 \begin_inset space ~
 \end_inset
 
-Toolbar
+toolbar
 \family default
  is a convenient way to enter symbols or to perform complicated formula
  operations.
@@ -3308,16 +3308,24 @@ Math
 \begin_inset space ~
 \end_inset
 
-Toolbars
+toolbar
 \family default
 , just to let you know what is out there; you can learn keyboard shortcuts
- later, from other manuals.
+ and commands later from the 
+\emph on
+Math
+\emph default
+ manual.
 \end_layout
 
 \begin_layout Standard
 The 
 \family sans
-math toolbar
+Math
+\begin_inset space ~
+\end_inset
+
+toolbar
 \family default
  is shown when the cursor is in a formula and can also be turned on manually
  in the menu 
@@ -3391,29 +3399,13 @@ Math
 \begin_inset space ~
 \end_inset
 
-Toolbar
+toolbar
 \family default
- which allow you to choose from a large array of symbols used in math: various
- arrows, relations, operators, and sums and integrals.
+ allows you to choose from a large array of symbols used in math: operators,
+ arrows, relationships, delimiters, special characters, sums and integrals.
  Note that subscripting and superscripting allow you to put lower and upper
  limits on sums and integrals.
  
-\end_layout
-
-\begin_layout Standard
-\begin_inset Quotes eld
-\end_inset
-
-Nothing you can do that can not be done\SpecialChar \ldots{}
- All you need is 
-\begin_inset Formula $\heartsuit$
-\end_inset
-
-.
-\begin_inset Quotes erd
-\end_inset
-
 \end_layout
 
 \begin_layout Subsection
@@ -3460,8 +3452,8 @@ Accenting a character (
  point under (or over) it.
  Just type what you want in the insertion point.
  There are two sets of decorations: those that resize with the text you
- type, and those that have fixed size, and are most appropriate for a single
- letter.
+ type, and those that have a fixed size, and are most appropriate for a
single letter.
  
 \end_layout
 
@@ -3509,8 +3501,8 @@ Delimiter
  dialog.
  However, those parentheses will be the same size as regular text, which
  will look bad if you have a big fraction or matrix inside the parentheses.
- So better use in this case one of the three delimiter buttons that insert
- directly e.
+ So it is better in this case to use one of the three delimiter buttons
that insert directly e.
 \begin_inset space \thinspace{}
 \end_inset
 
@@ -3619,7 +3611,7 @@ example_raw.lyx
 \end_layout
 
 \begin_layout Subsection
-TeX mode: Limits, log, sin and others
+Functions: lim, log, sin and others
 \end_layout
 
 \begin_layout Standard
@@ -3758,7 +3750,7 @@ Backspace
 \end_layout
 
 \begin_layout Standard
-The function list include other trigonometric functions and their inverses,
+The function list includes other trigonometric functions and their inverses,
  hyperbolic functions, logarithms, limits, and quite a few others.
  These functions can take subscripts and superscripts, important for typing
  
@@ -3936,7 +3928,7 @@ User's Guide
 \end_layout
 
 \begin_layout Standard
-Click on the display button 
+While being in a formula, click on the display button 
 \begin_inset Graphics
        filename ../images/math-display.png
        scale 75
@@ -3952,11 +3944,9 @@ Math
 
 Toolbar
 \family default
-, which represents a couple lines of text before and after a centered blue
- box.
- LyX inserts a formula, but the insertion point is on a new line, and it
- is centered within that line.
- Now type an expression and run LaTeX to see how it looks.
+.
+ This centers the formula and adds a blank line before and after it.
+ Now type in an expression and compile your file to see how it looks.
  The display button is actually a toggle; use it now to change a couple
  of your expressions to display mode and back.
  
@@ -3980,7 +3970,7 @@ The default font is larger for a few symbols, like
 
 \begin_layout Itemize
 Subscripts and superscripts for limits and sums (but not integrals) are
- written under rather than next to the symbols
+ written under and over rather than next to the symbols
 \end_layout
 
 \begin_layout Itemize
@@ -4006,7 +3996,7 @@ Return
 after
 \emph default
  the formula to start a new paragraph.
- That text will therefore eventually be indented, depending on your document
+ That text will be indented or follow a blank line, depending on your document
  paragraph settings, which is probably not what you want.
 \end_layout
 
@@ -4028,7 +4018,7 @@ example_raw.lyx
 Exercise
 \series default
 : Using various tools you have  learned in this section, you should be able
- to write an equation like
+ to write an equation like:
 \begin_inset Foot
 status collapsed
 
@@ -4048,7 +4038,7 @@ Environment
 
 \end_inset
 
-: 
 \begin_inset Formula \[
 f(x)=\left\{ \begin{array}{cc}
 \log_{8}x & x>0\\
@@ -4065,8 +4055,8 @@ More Math Stuff
 \end_layout
 
 \begin_layout Standard
-LyX's math editor can do plenty more.
By now, you are familiar with the basics, so we refer to the 
+LyX's math editor can do a lot more.
Now you are familiar with the basics, you can refer to the 
 \emph on
 User's Guide
 \emph default
@@ -4074,11 +4064,11 @@ User's Guide
 \end_layout
 
 \begin_layout Itemize
-Labeling and numbering expressions
+Label and number expressions
 \end_layout
 
 \begin_layout Itemize
-Multi-line equations
+Create multi-line equations
 \end_layout
 
 \begin_layout Itemize
@@ -4105,7 +4095,7 @@ Write macros.
 \end_layout
 
 \begin_layout Itemize
-Do lots of other things that cannot be mentioned in this Tutorial.
+Do lots of other things that we have no space for in this Tutorial.
 \end_layout
 
 \begin_layout Chapter
@@ -4258,7 +4248,7 @@ reference "sec:tex2lyx"
 \end_layout
 
 \begin_layout Itemize
-Spellchecking, thesaurus, and word count facilities are available.
+Spell-checking, thesaurus, and word count facilities are available.
 \end_layout
 
 \begin_layout Itemize
@@ -4409,17 +4399,27 @@ Toolbar
 \end_layout
 
 \begin_layout Standard
-As a special case, if you type a brace in TeX mode, then the beginning 
+As a special case, if you type 
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+{
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ in a formula, the beginning 
 \emph on
 and
 \emph default
- ending braces will be inserted in red, then take you 
-\emph on
-out
-\emph default
- of TeX mode and place the cursor between the braces.
- This makes it more convenient to type commands that LyX does not know which
- take an argument.
+ ending braces will be inserted in red while the cursor is placed between
+ the braces.
+ This makes it more convenient to type those commands which take an argument.
 \end_layout
 
 \begin_layout Standard
@@ -4481,20 +4481,27 @@ LaTeX
 \family typewriter
 tex2lyx
 \family default
- which will create a file 
+ which will create a file foo.lyx from the file foo.tex.
+ LyX will then open that file.
+ If the translation does not work, you can try calling 
 \family typewriter
-foo.lyx
+tex2lyx
 \family default
- from the file 
+ from the command line, possibly using fancier options.
+\end_layout
+
+\begin_layout Standard
+Even when the translation does work, 
 \family typewriter
-foo.tex
+tex2lyx
 \family default
- and then open that file.
- If the translation does not work, you can try calling 
+ may not translate everything, though it does handle most legal LaTeX.
+ It will leave things it does not understand in TeX mode; so, after translating
+ a file with 
 \family typewriter
 tex2lyx
 \family default
- from the command line, possibly using fancier options.
+, you can look for the red text and manually edit it to get it right.
 \end_layout
 
 \begin_layout Standard
@@ -4502,24 +4509,54 @@ tex2lyx
 \family typewriter
 tex2lyx
 \family default
- will translate most legal LaTeX, but not everything.
- It will leave things it does not understand in TeX mode, so after translating
- a file with 
+ has its own documentation (manpage), which Unix/Linux users can access
+ via the console command 
 \family typewriter
+man
+\begin_inset space ~
+\end_inset
+
 tex2lyx
 \family default
-, you can look for red text and hand-edit it to look right.
+.
+ The manpage describes which LaTeX commands and environments are not supported,
+ what bugs you might run into (and how to get around them), and how to use
+ the various options.
 \end_layout
 
 \begin_layout Standard
+It is important to understand that 
+\family typewriter
+tex2lyx
+\family default
+ can only translate files whose document class is 
+\begin_inset Quotes eld
+\end_inset
 
+known
+\begin_inset Quotes erd
+\end_inset
+
+ to LyX, that is, for which there is a corresponding LyX 
+\family sans
+layout file
+\family default
+.
+ If there is no layout file, then you will get an error saying that the
+ conversion could not be performed.
+ So, unless you have a layout for the document class of your LaTeX file,
 \family typewriter
 tex2lyx
 \family default
- has its own manpage.
- Read it to find out about which LaTeX commands and environments are not
- supported, bugs (and how to get around them), and how to use the various
- options.
+ simply will not know how to translate the LaTeX that it finds there into
+ things LyX understands.
+ More about layout files and how they are created is explained in detail
+ in Chapter 5 of the 
+\emph on
+Customization
+\emph default
+ manual.
 \end_layout
 
 \begin_layout Subsection
@@ -4563,31 +4600,16 @@ The
 Document\SpecialChar \menuseparator
 Settings
 \family default
- dialog takes care of many of the options that you would input in a 
-\family typewriter
-
-\backslash
-documentclass
-\family default
- command.
- Change the class, default font size and paper size here.
- Put any extra options to the 
-\family typewriter
-
-\backslash
-documentclass
-\family default
- command in the 
+ dialog takes care of the document-wide options.
+ You can change there the document class, default font size and paper size.
+ Document class options but also options for LaTeX packages can be entered
+ there in the 
 \family sans
-E
-\bar under
-x
-\bar default
-tra
+Class
 \begin_inset space ~
 \end_inset
 
-Options
+options
 \family default
  area.
 \end_layout
@@ -4618,7 +4640,7 @@ Preamble
 \family default
  and type in the dialog window (or from the document settings dialog, depending
  on the frontend).
- Anything you type will (like with TeX mode) be sent directly to LaTeX.
+ Anything you type will (as with TeX mode) be sent directly to LaTeX.
 \end_layout
 
 \begin_layout Subsection
@@ -4632,11 +4654,11 @@ al references to be used in multiple documents.
 \family sans
 Insert\SpecialChar \menuseparator
 List
-\begin_inset space ~
+\begin_inset space \thinspace{}
 \end_inset
 
 /
-\begin_inset space ~
+\begin_inset space \thinspace{}
 \end_inset
 
 TOC\SpecialChar \menuseparator
@@ -4663,7 +4685,7 @@ Style
 \end_layout
 
 \begin_layout Standard
-After you have  done this, you can use citations from any bibliographies
+After you have done this, you can use citations from any bibliographies
  you are including with 
 \family sans
 Insert\SpecialChar \menuseparator
@@ -4698,8 +4720,8 @@ Errors!
 \end_layout
 
 \begin_layout Standard
-Sometimes when you LaTeX a document, there will be errors, things that LyX
- or LaTeX cannot understand.
+Sometimes when you try to view a document, there will be errors, things
that LyX or LaTeX cannot understand.
  When this happens, LyX will open a 
 \family sans
 LaTeX