]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
Add to credit, sorry Edwin your 2c seem to be the only ones
[lyx.git] / lib / doc / UserGuide.lyx
index e14cbfab237b40c69eb7851856df30003a192142..0f7818061fa94edeac3b2ddbf0fbefd22b5886ab 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 369
+\lyxformat 376
 \begin_document
 \begin_header
 \textclass scrbook
 \end_preamble
 \options intoc,bibtotoc,idxtotoc,BCOR7mm,tablecaptionabove
 \use_default_options false
+\maintain_unincluded_children 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
 \paperpagestyle default
 \tracking_changes false
 \output_changes false
+\html_use_mathml true
+\html_be_strict true
+\author 1 "Richard Heck" 
 \end_header
 
 \begin_body
@@ -2366,9 +2377,26 @@ 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
+\change_deleted 1 1263338271
+m
+\change_inserted 1 1263338359
+ corresponding LaTeX class files, though most TeX distributions will include
+ many of these
+\change_unchanged
+.
+ Here are some of the classes
+\change_inserted 1 1263338393
+.
+\change_unchanged
+, 
+\change_deleted 1 1263338396
+t
+\change_inserted 1 1263338397
+T
+\change_unchanged
+he full list with detailed explanations can be found in chapter 
 \emph on
 Special Document Classes
 \emph default
@@ -2586,8 +2614,11 @@ Document ! Modules
 \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.
+ For example you might want to 
+\change_deleted 1 1263338413
+use 
+\change_unchanged
+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 
 \family sans
@@ -2641,6 +2672,11 @@ status open
 Note also:
 \series default
  Some modules require other modules, and some pairs of modules are incompatible.
+
+\change_inserted 1 1263338440
+ LyX will also advise you about these things.
+\change_unchanged
+
 \end_layout
 
 \end_inset
@@ -3578,16 +3614,34 @@ 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 
+ 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 
+\change_inserted 1 1263335989
+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.
+\change_deleted 1 1263335996
+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.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Section
@@ -4129,7 +4183,7 @@ Document Title
 status collapsed
 
 \begin_layout Plain Layout
-Document !Title
+Document ! Title
 \end_layout
 
 \end_inset
@@ -10572,6 +10626,20 @@ Special Character\SpecialChar \menuseparator
 Symbols
 \family default
 .
+
+\change_inserted 1 1263338624
+ You can also enter some sorts of accented characters by using the mini-buffer.
+ For example, entering 
+\begin_inset Quotes eld
+\end_inset
+
+accent-umlaut e
+\begin_inset Quotes erd
+\end_inset
+
+ will produce the character: ë.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Standard
@@ -13044,6 +13112,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
@@ -21862,7 +22011,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 +25725,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 +25755,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 +26533,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 +26585,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 +28479,7 @@ preview
 Tools\SpecialChar \menuseparator
 Preferences 
 \family default
-dialog under 
-\family sans
-Look
+dialog under Look
 \begin_inset space ~
 \end_inset
 
@@ -28169,9 +28488,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
@@ -28316,13 +28642,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
@@ -28768,7 +29099,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 +34666,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
@@ -34440,8 +34779,9 @@ 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
+\change_deleted 1 1262887786
+; they are explained in detail in section
 \begin_inset space ~
 \end_inset
 
@@ -34453,6 +34793,10 @@ reference "sub:Output-file-formats"
 \end_inset
 
 :
+\change_inserted 1 1262887786
+:
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -34465,7 +34809,25 @@ 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)
+\change_deleted 1 1262887560
+;
+\change_inserted 1 1262887561
+
+\begin_inset Newline newline
+\end_inset
+
+
+\change_unchanged
+\change_deleted 1 1262887562
+(
+\change_unchanged
+Since LyX 1.5.0 CJK support is fully integrated to LyX.
+\change_deleted 1 1262887564
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -34474,11 +34836,61 @@ format of the special LyX 1.4.x versions for Chinese, Japanese, and Korean
 DVI
 \family default
  DVI-format
+\change_inserted 1 1262887797
+ (see 
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sub:Output-file-formats"
+
+\end_inset
+
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
-HTML HTML-format (the HTML-converter is a third-party product and doesn't
- work in all cases)
+HTML HTML-format
+\change_inserted 1 1262887568
+
+\begin_inset Newline newline
+\end_inset
+
+
+\change_deleted 1 1262887572
+ (t
+\change_inserted 1 1262887573
+T
+\change_unchanged
+he HTML
+\change_inserted 1 1262887602
+\change_deleted 1 1262887603
+-
+\change_unchanged
+conver
+\change_inserted 1 1262887606
+sion
+\change_deleted 1 1262887609
+ter
+\change_unchanged
+ is 
+\change_inserted 1 1262887612
+performed by 
+\change_unchanged
+a third-party product and 
+\change_inserted 1 1262887674
+may 
+\change_deleted 1 1262887617
+doesn't 
+\change_unchanged
+work in all cases
+\change_inserted 1 1262887618
+.
+\change_deleted 1 1262887618
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
 \end_inset
 
  is replaced by the version number)
+\change_inserted 1 1262887695
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 1 1262887844
+LyXHTML HTML-format, using LyX's internal XHTML engine (see 
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sub:Output-file-formats"
+
+\end_inset
+
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -34589,8 +35018,46 @@ KOffice
 Abiword
 \family default
 , etc.
- (the OpenDocument-converter is a third-party product and doesn't work in
- all cases)
+\change_inserted 1 1262887646
+
+\begin_inset Newline newline
+\end_inset
+
+
+\change_deleted 1 1262887649
+ (t
+\change_inserted 1 1262887649
+T
+\change_unchanged
+he OpenDocument
+\change_inserted 1 1262887652
+\change_deleted 1 1262887652
+-
+\change_unchanged
+conver
+\change_inserted 1 1262887656
+sion
+\change_deleted 1 1262887654
+ter
+\change_unchanged
+ is 
+\change_inserted 1 1262887659
+performed by 
+\change_unchanged
+a third-party product and 
+\change_inserted 1 1262887665
+may not 
+\change_deleted 1 1262887667
+doesn't 
+\change_unchanged
+work in all cases
+\change_inserted 1 1262887669
+.
+\change_deleted 1 1262887670
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -34605,6 +35072,19 @@ PDF
  PDF-format using the program 
 \family typewriter
 dvipdfm
+\change_inserted 1 1262887911
+\family default
+(see 
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sub:Output-file-formats"
+
+\end_inset
+
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -34619,6 +35099,19 @@ PDF
  PDF-format using the program 
 \family typewriter
 pdflatex
+\change_inserted 1 1262887913
+\family default
+(see 
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sub:Output-file-formats"
+
+\end_inset
+
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -34633,6 +35126,19 @@ PDF
  PDF-format using the program 
 \family typewriter
 ps2pdf
+\change_inserted 1 1262887914
+\family default
+(see 
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sub:Output-file-formats"
+
+\end_inset
+
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -34674,6 +35180,19 @@ Postscript
  PostScript format using the program 
 \family typewriter
 dvips
+\change_inserted 1 1262887921
+\family default
+(see 
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sub:Output-file-formats"
+
+\end_inset
+
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -35208,13 +35727,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 +40376,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 +40404,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 +40434,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 +41185,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 +41199,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 +41222,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
@@ -44177,8 +44752,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"