]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
* LaTeXUI.ui:
[lyx.git] / lib / doc / UserGuide.lyx
index 7e0b8a82caf53015e7cb145541fd1f5e12cdae2f..ac15b55ccf75ca5d757a721fe78a827cd6d86a46 100644 (file)
@@ -1,5 +1,5 @@
-#LyX 1.6.0 created this file. For more info see http://www.lyx.org/
-\lyxformat 345
+#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
+\lyxformat 346
 \begin_document
 \begin_header
 \textclass scrbook
@@ -143,7 +143,7 @@ type "mailto:"
 \begin_inset Newline newline
 \end_inset
 
-Version 2.0svn
+Version 1.6.1
 \begin_inset Note Note
 status open
 
@@ -1455,8 +1455,8 @@ Outline
 
 \begin_layout Standard
 The outline window shows you the content of the document's table of contents
- (TOC) that is described in sec.
-\begin_inset space \thinspace{}
+ (TOC) that is described in section
+\begin_inset space ~
 \end_inset
 
 
@@ -1471,7 +1471,11 @@ reference "sub:Table-of-Contents"
  In the pull-down box at the top of the outline window, you can choose between
  different lists of document objects, like the list of footnotes.
  Some of them, the list of tables, figures, and algorithms can also be added
- to the document, see 
+ to the document, see section
+\begin_inset space ~
+\end_inset
+
+
 \begin_inset CommandInset ref
 LatexCommand ref
 reference "sub:List-of-Figures"
@@ -1639,6 +1643,7 @@ Word completion|see
 status collapsed
 
 \begin_layout Plain Layout
+
 {
 \end_layout
 
@@ -1649,6 +1654,7 @@ Input completion
 status collapsed
 
 \begin_layout Plain Layout
+
 }
 \end_layout
 
@@ -23172,369 +23178,24 @@ Math ! Macros
 \end_inset
 
 
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:math-macros"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-LyX allows you to define macros for formulas.
- For example we assume that solutions of the quadratic equation often occur
- in our document in various forms and we want to create a macro to print
- them.
-\begin_inset Newline newline
-\end_inset
-
-The general form of a quadratic equation is:
-\begin_inset Formula \[
-0=\lambda^{2}+p\lambda+q\]
-
-\end_inset
-
-The general form of its solution is:
-\begin_inset Formula \[
-\lambda_{1,2}=-\frac{p}{2}\pm\sqrt{\frac{p^{2}}{4}-q}\]
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-The macro should print the parameters 
-\begin_inset Formula $\lambda$
-\end_inset
-
-, 
-\begin_inset Formula $p$
-\end_inset
-
- and 
-\begin_inset Formula $q$
-\end_inset
-
- like in the equation above.
-\end_layout
-
-\begin_layout Standard
-A macro is created by executing the command
 \end_layout
 
 \begin_layout Standard
-
-\series bold
-math-macro
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-
-\backslash
-spce 
-\end_layout
-
-\end_inset
-
-Name
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-
-\backslash
-spce 
-\end_layout
-
-\end_inset
-
-Number
-\begin_inset space ~
-\end_inset
-
-of
+LyX allows you to define macros for formulas what is very useful when you
+ have in a document several times the same form of equations.
+ Math macros are explained in section 
+\emph on
+Math
 \begin_inset space ~
 \end_inset
 
-Arguments
-\end_layout
-
-\begin_layout Standard
-in the minibuffer at the bottom of the LyX screen.
- Name is the name of the new macro which mustn't contain numbers.
- The number of arguments can be a number in the range 1-9.
- If you want to define a macro without arguments, don't declare the number
- of arguments.
-\end_layout
-
-\begin_layout Standard
-We have three arguments and name the macro 
-\begin_inset Quotes eld
-\end_inset
-
-qE
-\begin_inset Quotes erd
-\end_inset
-
-, so that the command is:
-\end_layout
-
-\begin_layout Standard
-
-\series bold
-math-macro
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-
-\backslash
-spce 
-\end_layout
-
-\end_inset
-
-qE
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-
-\backslash
-spce 
-\end_layout
-
-\end_inset
-
-3
-\end_layout
-
-\begin_layout Standard
-This results in the following macro definition box: 
-\begin_inset Graphics
-       filename clipart/macrobox.png
-
-\end_inset
-
-\begin_inset FormulaMacro
-\newcommand{\qE}[3]{#1_{1,\,2}=-\frac{#2}{2}\pm\sqrt{\frac{#2^{2}}{4}-#3}}
-{\textrm{qE: }#1\textrm{ , }#2\textrm{ , }#3}
-\end_inset
-
-
-\begin_inset Note Note
-status collapsed
-
-\begin_layout Plain Layout
-The first box is an image to show the behavior in the output.
- The second one is the definition box, that doesn't appear in the output.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-The first blue box is for the definition, where you insert the formula via
- the math panel or commands.
- The placeholder for the arguments are inserted as a backslash and sharp
- followed by the argument number, e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\backslash
-#1
-\begin_inset Quotes erd
-\end_inset
-
- for the first argument.
- Placeholders will be displayed in red.
- The second blue box is for the appearance in LyX.
- This is useful when you have a large structure that shouldn't be displayed
- in LyX with its full size.
- If you want to see the macro as it is defined, leave the box blank.
- In our example we insert the sequence
-\begin_inset Newline newline
-\end_inset
-
-
-\series bold
-qE: 
-\backslash
-#1
-\series default
-\series bold
-,
-\series default
-\series bold
-
-\backslash
-#2
-\series default
-\series bold
-,
-\series default
-\series bold
-
-\backslash
-#3
-\begin_inset Newline newline
-\end_inset
-
-
-\series default
-The macro will then be shown as the macro name followed by the three arguments.
-\end_layout
-
-\begin_layout Standard
-To use the macro in a formula, type its name as command, in our case 
-\begin_inset Quotes eld
-\end_inset
-
-
-\series bold
-
-\backslash
-qE
-\series default
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- The macro is inserted with boxes for the arguments looking similar to this:
-\end_layout
-
-\begin_layout Standard
-\align center
-\begin_inset Graphics
-       filename clipart/macrouse.png
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-The arguments are inserted in the blue boxes.
- If the cursor is outside the macro, the arguments are put in the macro.
- To change the arguments, put the cursor in the formula before or after
- the macro and press the right or left arrow key respectively.
- The arguments appear now again below the macro definition.
-\end_layout
-
-\begin_layout Standard
-If you change the macro definition all macros are changed automatically
- to the new definition.
- Here an example of our macro with the arguments 
-\begin_inset Formula $x$
-\end_inset
-
-, 
-\begin_inset Formula $\ln(x)$
-\end_inset
-
-, and 
-\begin_inset Formula $B$
-\end_inset
-
-:
-\begin_inset Formula \[
-\qE x{\ln(y)}B\]
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-When the document is exported to LaTeX, the macro definition will be inserted
- as the command:
-\end_layout
-
-\begin_layout Standard
-
-\series bold
-
-\backslash
-newcommand{
-\backslash
-qE}[3]{#1_{1,
-\backslash
-,2}=-
-\backslash
-frac{#2}{2}
-\backslash
-pm
-\begin_inset Newline newline
-\end_inset
-
-
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-
-\backslash
-hphantom{
-\end_layout
-
-\end_inset
-
-
-\backslash
-newcommand
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-}
-\end_layout
-
-\end_inset
-
-
-\backslash
-sqrt{
-\backslash
-frac{#2^{2}}{4}-#3}}
-\end_layout
-
-\begin_layout Standard
-The command is not inserted in the document preamble.
- That means you can only use macros in formulas that are below the macro
- definition box in your document.
- There are also some other restrictions: The command 
-\backslash
-newcommand supports optional arguments, which are not available in LyX's
- macros.
- You can also not change subsequently the name of the macro and the number
- of arguments.
+Macros
+\emph default
+ of the 
+\emph on
+Math
+\emph default
+ manual.
 \end_layout
 
 \begin_layout Section
@@ -27389,6 +27050,60 @@ reference "cha:Units-available-in"
 cm.
 \end_layout
 
+\begin_layout Subsection
+Nomenclature Program
+\begin_inset Index
+status collapsed
+
+\begin_layout Plain Layout
+Nomenclature ! Program
+\end_layout
+
+\end_inset
+
+
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Nomenclature-Program"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+LyX uses the program 
+\family sans
+makeindex
+\family default
+ to generate the nomenclature, that is part of every LaTeX distribution.
+ LyX's preferences dialog allows to specify another program or to control
+\family sans
+makeindex
+\family default
+ by adding options, see section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:LaTeX-settings"
+
+\end_inset
+
+.
+ The available options are listed and explained in 
+\begin_inset CommandInset citation
+LatexCommand cite
+key "nomencl,makeindex"
+
+\end_inset
+
+.
+\end_layout
+
 \begin_layout Section
 Branches
 \begin_inset Index
@@ -27669,18 +27384,12 @@ x^{2}-2x-2\Rightarrow\question{x_{1}}\answer{x_{2}}=1\question{+\sqrt{3}}\answer
 \end_layout
 
 \begin_layout Standard
-Inside math, the same effect can be achieved using math macros, see section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:math-macros"
-
-\end_inset
-
-.
+Inside math, the same effect can be achieved using math macros, see the
+\emph on
+Math
+\emph default
+ manual.
 \end_layout
 
 \begin_layout Section
@@ -35002,11 +34711,11 @@ Unfolds/folds the current math macro.
 \end_layout
 
 \begin_layout Standard
-More about math macros will be described in the 
+Math macros are described in the 
 \emph on
 Math
 \emph default
- manual.??
+ manual.
 \end_layout
 
 \begin_layout Subsection
@@ -38617,7 +38326,17 @@ Toolbar ! Table
 \emph on
 Embedded Objects
 \emph default
- manual, the math macro toolbar in the 
+ manual, the math macro toolbar
+\begin_inset Index
+status collapsed
+
+\begin_layout Plain Layout
+Toolbar ! Macro
+\end_layout
+
+\end_inset
+
+ in the 
 \emph on
 Math
 \emph default
@@ -38679,8 +38398,8 @@ Document Class
 \end_layout
 
 \begin_layout Standard
-Here you set the document class, class options, a Postscript driver, and
master document.
+Here you set the document class, class options, a graphics driver, and a
+ master document.
  Document classes are described in section
 \begin_inset space ~
 \end_inset
@@ -38701,13 +38420,14 @@ Predefined
  and you can decide to use them or not.
  If you don't exactly know what the default class options are for, it is
  recommended not to touch them.
- The Postscript driver is used for LaTeX's color and graphics packages.
+ The graphics driver is used for LaTeX's graphics, color and page layout
+ packages.
  When using 
 \family sans
 Default
 \family default
 , the default driver for the LaTeX-packages are used.
- It is recommended to use the default unless your know what you are doing.
+ It is recommended to use the default unless you know what you are doing.
 \begin_inset Foot
 status collapsed
 
@@ -41108,6 +40828,30 @@ Settings ! Language
 Language
 \end_layout
 
+\begin_layout Description
+User
+\begin_inset space ~
+\end_inset
+
+Interface
+\begin_inset space ~
+\end_inset
+
+language Here you can select the language of LyX's menus.
+ Unfortunately this doesn't work on Mac and Windows.
+ It works so far on Linux, but not for every language you can select here
+ exists a translation of the LyX menus.
+ You find the actual translation status here: 
+\begin_inset CommandInset href
+LatexCommand href
+name "http://www.lyx.org/I18n"
+target "http://www.lyx.org/I18n"
+
+\end_inset
+
+
+\end_layout
+
 \begin_layout Description
 Default
 \begin_inset space ~
@@ -41172,7 +40916,7 @@ Table
 \begin_inset Quotes erd
 \end_inset
 
- at the beginning of every table-caption.
+ at the beginning of every table caption.
 \end_layout
 
 \begin_layout Description
@@ -41806,7 +41550,14 @@ command Command for the program that generates the nomenclature, see section
 \begin_inset space ~
 \end_inset
 
-??.
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Nomenclature-Program"
+
+\end_inset
+
+.
 \end_layout
 
 \begin_layout Description
@@ -42069,24 +41820,6 @@ Copiers
 Here you find the list of defined file formats that LyX can handle.
  You can modify the viewer and editor program that should be used for certain
  formats.
- To create a new format, select an existing one, change the entry of the
- fields 
-\family sans
-Format
-\family default
- and 
-\family sans
-GUI
-\begin_inset space ~
-\end_inset
-
-name
-\family default
-, and press the 
-\family sans
-Add
-\family default
- button.
 \end_layout
 
 \begin_layout Standard