]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
A couple minor changes in the User's Guide.
[lyx.git] / lib / doc / UserGuide.lyx
index e14cbfab237b40c69eb7851856df30003a192142..429ecc2e26aef395d78136389915a9fa9e0712f4 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 369
+\lyxformat 373
 \begin_document
 \begin_header
 \textclass scrbook
@@ -58,6 +58,7 @@
 \use_default_options false
 \language english
 \inputencoding auto
+\fontencoding global
 \font_roman default
 \font_sans default
 \font_typewriter default
 \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
 \paperorientation portrait
+\suppress_date false
 \branch Question
 \selected 1
 \filename_suffix 0
 \filename_suffix 0
 \color #aa55ff
 \end_branch
+\index Index
+\shortcut idx
+\color #008000
+\end_index
 \secnumdepth 3
-\tocdepth 3
+\tocdepth 2
 \paragraph_separation indent
 \paragraph_indentation default
 \quotes_language english
@@ -21602,7 +21609,7 @@ Math ! Limits
 
 
 \begin_inset Formula \[
-\lim_{x\rightarrow\infty}f(x),\]
+\lim_{x\rightarrow\infty}f(x)\]
 
 \end_inset
 
@@ -21862,7 +21869,7 @@ sin
 \end_inset
 
  does normally mean 
-\begin_inset Formula $s·i·n$
+\begin_inset Formula $s\cdot i\cdot n$
 \end_inset
 
 .
@@ -25576,13 +25583,13 @@ Entry
 \end_inset
 
 .
- A gray box labeled 
+ A box labeled 
 \begin_inset Quotes eld
 \end_inset
 
 
 \family sans
-Idx
+Index
 \family default
 
 \begin_inset Quotes erd
@@ -25606,10 +25613,6 @@ key "latexcompanion,latexguide,latexbook"
 .
 \end_layout
 
-\begin_layout Standard
-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
@@ -26388,16 +26391,37 @@ name "sub:Index-Program"
 \end_layout
 
 \begin_layout Standard
-When the index entry program 
+If the index entry program 
 \family sans
 xindy
 \family default
-, which is only available for Linux, is installed, LyX uses it for index
- generation; otherwise the program 
+ 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.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+
+\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 than the English language, consider
+ to use 
+\family sans
+xindy
+\family default
+.
+\end_layout
+
+\end_inset
+
  Both programs can be controlled by options that can be set in LyX's preferences
  dialog, see section
 \begin_inset space ~
@@ -26419,24 +26443,179 @@ key "makeindex,xindy"
 \end_inset
 
 .
- You can also specify there another program to generate the index.
+ In this dialog, you can also specify an alternative program to generate
+ the index.
 \end_layout
 
 \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{}
+or the options in 
+\family sans
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \ldots{}
+\SpecialChar \menuseparator
+Indexes
+\family default
+.
+ This is especially useful if you need to pass language-specific options
+ to the index program or if you need a specific layout style.
+\end_layout
+
+\begin_layout Subsection
+Multiple Indexes
+\end_layout
+
+\begin_layout Standard
+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
+\end_inset
+
+Index of Names
+\begin_inset Quotes erd
+\end_inset
+
+ next to the standard index.
+ LaTeX does not provide this possibility out of the box, but there are many
+ packages that add this feature.
+ LyX uses the 
+\series bold
+splitidx
+\series default
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+LaTeX-packages ! splitidx
+\end_layout
+
+\end_inset
+
+ package to generate multiple indexes.
+ The package is included in all recent LaTeX distributions.
+ If yours does not ship it, consult the TeX Catalogue, 
+\begin_inset CommandInset citation
+LatexCommand cite
+key "TeXCatalogue"
+
+\end_inset
 
+.
+ Note that the package does not only consist of a LaTeX style, but it also
+ includes specific preprocessor programs that need to be installed as well.
+ Please consult the package's manual for details.
+\end_layout
+
+\begin_layout Standard
+To set up LyX for the use of multiple indexes, go to 
 \family sans
-makeindex
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \ldots{}
+\SpecialChar \menuseparator
+Indexes
 \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 
+ and select 
+\begin_inset Quotes eld
+\end_inset
+
+Use multiple Indexes
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Note that the list of 
+\begin_inset Quotes eld
+\end_inset
+
+Available Indexes
+\begin_inset Quotes erd
+\end_inset
+
+ below already contains the standard index.
+ To add further indexes, add the name of the index (in the form that should
+ also appear as a heading) to the 
+\begin_inset Quotes eld
+\end_inset
+
+New
+\begin_inset Quotes erd
+\end_inset
+
+ input field and press the 
+\begin_inset Quotes eld
+\end_inset
+
+Add
+\begin_inset Quotes erd
+\end_inset
+
+ button.
+ The new index should now appear in the list as well.
+ If you like, you can attribute an alternative label color to the new index
+ by selecting the index in the list and hitting the 
+\begin_inset Quotes eld
+\end_inset
+
+Alter Color\SpecialChar \ldots{}
+
+\begin_inset Quotes erd
+\end_inset
+
+ button.
+ The label color may help you to differentiate index entries of different
+ indexes in the LyX work area.
+\end_layout
+
+\begin_layout Standard
+Once the document changes have been applied, you can find the new index
+ list in 
 \family sans
-xindy
+Insert\SpecialChar \menuseparator
+List
+\begin_inset space ~
+\end_inset
+
+/
+\begin_inset space ~
+\end_inset
+
+TOC
 \family default
+ and the 
+\family sans
+Insert
+\family default
+ menu has a separate index entry for each of the defined indexes.
+ The workflow is basically the same as for the default index, but there
+ are some additional features:
+\end_layout
+
+\begin_layout Itemize
+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
+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
+\end_inset
+
+Subindex
+\begin_inset Quotes erd
+\end_inset
+
 .
+ If you do that, the heading of that list will be decreased by one level.
+ E.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., if you use a book class, where the standard index heading is defined
+ as a chapter, subindexes will be defined as sections and can thus be nested
+ to the non-subindexes.
 \end_layout
 
 \begin_layout Section
@@ -28158,9 +28337,7 @@ preview
 Tools\SpecialChar \menuseparator
 Preferences 
 \family default
-dialog under 
-\family sans
-Look
+dialog under Look
 \begin_inset space ~
 \end_inset
 
@@ -28169,9 +28346,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
@@ -28768,7 +28952,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
@@ -34335,6 +34519,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
@@ -35208,13 +35400,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
@@ -39857,7 +40049,7 @@ Bibliography
 \end_layout
 
 \begin_layout Standard
-You can specify here a citation style using the LaTeX-packages 
+You can specify here a citation style using the LaTeX packages 
 \series bold
 natbib
 \series default
@@ -39885,7 +40077,22 @@ LaTeX-packages ! jurabib
 
 \end_inset
 
-.
+, you can enable subdivided bibliographies using the LaTeX package 
+\series bold
+bibtopic
+\series default
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+LaTeX-packages ! bibtopic
+\end_layout
+
+\end_inset
+
+ and you can customize how the bibliography of the given document is being
+ generated.
  For a further description see section
 \begin_inset space ~
 \end_inset
@@ -39900,6 +40107,27 @@ reference "sec:Bibliography"
 .
 \end_layout
 
+\begin_layout Section
+Indexes
+\end_layout
+
+\begin_layout Standard
+Here, you can customize how the index of your document is being generated
+ and you can define additional indexes.
+ Please refer to section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Index"
+
+\end_inset
+
+ for details.
+\end_layout
+
 \begin_layout Section
 PDF Properties
 \end_layout
@@ -40630,12 +40858,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
@@ -40644,7 +40872,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
@@ -40667,6 +40895,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