]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
- UserGuide.lyx: describe the new features
[lyx.git] / lib / doc / UserGuide.lyx
index b00054e487672475ee79efdba644f818c6027121..02284baf4fd84cf293eaa2c3d11cb18458a5b0ec 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 369
+\lyxformat 371
 \begin_document
 \begin_header
 \textclass scrbook
@@ -97,6 +97,7 @@
 \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
 \paragraph_separation indent
@@ -6817,11 +6822,11 @@ two
 
 \begin_deeper
 \begin_layout Enumerate
-sublist - item #1
+sublist  item #1
 \end_layout
 
 \begin_layout Enumerate
-sublist - item #2
+sublist  item #2
 \end_layout
 
 \end_deeper
@@ -7710,7 +7715,7 @@ level #6
 \end_layout
 
 \begin_layout Enumerate
-level #1 - outermost
+level #1  outermost
 \end_layout
 
 \begin_deeper
@@ -7889,7 +7894,7 @@ arg   "depth-increment"
 Standard
 \family default
 .
- Do this to create list items with more than one paragraph - it also works
+ Do this to create list items with more than one paragraph  it also works
  for the 
 \family sans
 Description
@@ -7933,7 +7938,7 @@ arg   "break-paragraph inverse"
 List
 \family default
 .
- Remember - we can't nest anything inside a 
+ Remember  we can't nest anything inside a 
 \family sans
 Standard
 \family default
@@ -11404,7 +11409,7 @@ A more widely used character style is the
 Emphasized
 \family default
  style.
- You can activate (or deactivate - it's also a toggle) the 
+ You can activate (or deactivate  it's also a toggle) the 
 \family sans
 Emphasized
 \family default
@@ -12074,7 +12079,7 @@ yet again
 : don't go crazy with this feature.
  You should almost never need to change the font size.
  LyX automatically changes the font size for different paragraph environments
- use that instead.
 use that instead.
  This is here for fine-tuning only!
 \end_layout
 
@@ -13174,7 +13179,7 @@ Ghostscript
 \end_layout
 
 \begin_layout Standard
-You can choose to print only even-numbered or odd-numbered pages - this
+You can choose to print only even-numbered or odd-numbered pages  this
  is useful for printing on two sides: You can re-insert the pages after
  printing one set to print on the other side.
  Some printers spit out pages face-up, others, face-down.
@@ -25576,13 +25581,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 +25611,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 +26389,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 +26441,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 +28335,7 @@ preview
 Tools\SpecialChar \menuseparator
 Preferences 
 \family default
-dialog under 
-\family sans
-Look
+dialog under Look
 \begin_inset space ~
 \end_inset
 
@@ -28169,9 +28344,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 +28950,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
@@ -34778,6 +34960,49 @@ reference "sub:Printing-the-File"
 .
 \end_layout
 
+\begin_layout Subsection
+Fax
+\end_layout
+
+\begin_layout Standard
+This menu entry will only appear when you have a fax program installed (on
+ Windows you additionally need to register its program path to LyX's PATH
+ prefix, see section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Paths"
+
+\end_inset
+
+).
+ With this menu entry you can send your document to a fax program like 
+\family typewriter
+hylapex
+\family default
+ or 
+\family typewriter
+kdeprintfax
+\family default
+.
+ The default format of the sent file is PostScript.
+ The format can be changed in LyX's preferences as described in section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Converters"
+
+\end_inset
+
+.
+\end_layout
+
 \begin_layout Subsection
 New and Close Window
 \end_layout
@@ -35021,7 +35246,7 @@ View
  menu contains a list of available formats in which you can view the actual
  document with an external program.
  The menu entries for the viewing formats are not the same on all installations
- it depends on the LaTeX programs that are found while LyX was configured.
 it depends on the LaTeX programs that are found while LyX was configured.
  All possible formats are formats listed in section
 \begin_inset space ~
 \end_inset
@@ -39814,7 +40039,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
@@ -39842,7 +40067,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
@@ -39857,6 +40097,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
@@ -40587,12 +40848,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
@@ -40601,7 +40862,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
@@ -40624,6 +40885,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
@@ -41056,6 +41337,13 @@ reference "sec:Input-Completion"
 
 \begin_layout Section
 Paths
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Paths"
+
+\end_inset
+
+
 \begin_inset Index idx
 status collapsed
 
@@ -42197,6 +42485,13 @@ File handling
 
 \begin_layout Subsection
 Converters
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Converters"
+
+\end_inset
+
+
 \begin_inset Index idx
 status collapsed