]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
UserGuide.lyx: remove myThes license and point to its location in our sources instead
[lyx.git] / lib / doc / UserGuide.lyx
index 06373ff04f80c59888f6b1a6fb0e2c18503c72cc..5d836987ccf513752ecbd797e5bb2519b75aff3d 100644 (file)
 % redefine the greyed out note
 \renewenvironment{lyxgreyedout}
  {\textcolor{blue}\bgroup}{\egroup}
+
+% workaround for a makeindex bug 
+\newcommand*{\OrgIndex}{} 
+\let\OrgIndex\index 
+\renewcommand*{\index}[1]{\OrgIndex{#1}}
 \end_preamble
 \options intoc,bibtotoc,idxtotoc,BCOR7mm,tablecaptionabove
 \use_default_options false
@@ -89,7 +94,6 @@
 \use_bibtopic false
 \use_indices false
 \paperorientation portrait
-\backgroundcolor #ffffff
 \branch Question
 \selected 1
 \color #00ff00
 \papercolumns 1
 \papersides 2
 \paperpagestyle default
-\tracking_changes true
+\tracking_changes false
 \output_changes false
-\author "rgheck
+\author "" 
 \author "" 
 \end_header
 
@@ -3330,22 +3334,12 @@ LaTeX-packages ! fancyhdr
  At the moment, support in LyX is limited to this setting.
  To use the full power of this package, you have to add code to your document
  preamble.
-\change_deleted 0 1241791541
-Check the documentation for the 
-\series bold
-fancyhdr
-\series default
- package for more details, 
-\change_inserted 0 1241791541
-See the Additional Features manual for more information, or check the documentat
-ion for the 
+ See the Additional Features manual for more information, or check the documenta
+tion for the 
 \series bold
 fancyhdr
 \series default
  package 
-\change_unchanged
-
 \begin_inset CommandInset citation
 LatexCommand cite
 key "fancyhdr"
@@ -4391,17 +4385,15 @@ Subsection
 \family default
 s are divided into 
 \family sans
-Subsubsection
-\family default
-s
+Subsubsections
 \end_layout
 
 \begin_layout Itemize
 
 \family sans
-Subsubsection
+Subsubsections
 \family default
-s are divided into 
+ are divided into 
 \family sans
 Paragraph
 \family default
@@ -4415,9 +4407,7 @@ Paragraph
 \family default
 s are divided into 
 \family sans
-Subparagraph
-\family default
-s
+Subparagraphs
 \end_layout
 
 \begin_layout Standard
@@ -10040,22 +10030,22 @@ Spacing ! Fills
  one at the bottom, because the space between them is then maximal.
  
 \family sans
-VFill
+VFills
 \family default
-s work like 
+ work like 
 \family sans
-HFill
+HFills
 \family default
-s: they fill the remaining vertical space on a page with blank space.
+: they fill the remaining vertical space on a page with blank space.
 \begin_inset Foot
 status collapsed
 
 \begin_layout Plain Layout
 
 \family sans
-HFill
+HFills
 \family default
-s are described in section
+ are described in section
 \begin_inset space ~
 \end_inset
 
@@ -10073,14 +10063,14 @@ reference "sub:Horizontal-Space"
 
  If there are several 
 \family sans
-VFill
+VFills
 \family default
-s on a page, they divide the remaining vertical space equally between themselves.
+ on a page, they divide the remaining vertical space equally between themselves.
  You can therefore use 
 \family sans
-VFill
+VFills
 \family default
-s to center text on a page, or even place text 2/3 down a page.
+ to center text on a page, or even place text 2/3 down a page.
 \end_layout
 
 \begin_layout Standard
@@ -26049,6 +26039,103 @@ The previous entry needn't to be a real existing entry, you can also use
  an example.
 \end_layout
 
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+In some cases the index entry order is not correct when you are using the
+ program 
+\family sans
+makeindex 
+\family default
+to generate the index (see sec.
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Index-Program"
+
+\end_inset
+
+).
+\family sans
+makeindex
+\family default
+ would for example print the index entry for the LaTeX-package aeguill in
+ sec.
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Document-Font"
+
+\end_inset
+
+ after the the index entries of the other LaTeX-packages although all these
+ index commands start with 
+\begin_inset Quotes eld
+\end_inset
+
+
+\series bold
+LaTeX-packages ! 
+\series default
+
+\begin_inset Quotes eld
+\end_inset
+
+.
+ The reason is that the index entry for aeguill is in a footnote.
+ To fix this 
+\family sans
+makeindex
+\family default
+ bug, add these commands to the preamble of your document:
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+
+\backslash
+newcommand*{
+\backslash
+OrgIndex}{}
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+
+\backslash
+let
+\backslash
+OrgIndex
+\backslash
+index
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+
+\backslash
+renewcommand*{
+\backslash
+index}[1]{
+\backslash
+OrgIndex{#1}}
+\end_layout
+
 \begin_layout Subsection
 Index Entry Layout
 \begin_inset Index idx
@@ -28461,39 +28548,13 @@ name "sec:Thesaurus"
 \end_layout
 
 \begin_layout Standard
-LyX provides support for two different thesaurus frameworks:
-\end_layout
-
-\begin_layout Enumerate
-The 
-\emph on
-AikSaurus
-\emph default
- library,
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-\begin_inset CommandInset href
-LatexCommand href
-target "http://aiksaurus.sourceforge.net"
-
-\end_inset
-
-
-\end_layout
-
-\end_inset
-
- which is also used by Abiword, but which is English only.
-\end_layout
-
-\begin_layout Enumerate
-The 
+LyX provides a multilingual thesaurus.
+ It uses the same thesaurus framework as OpenOffice and Firefox (namely
+ the 
 \emph on
 MyThes
 \emph default
- library,
+
 \begin_inset Foot
 status collapsed
 
@@ -28509,16 +28570,14 @@ target "http://lingucomponent.openoffice.org/thesaurus.html"
 
 \end_inset
 
- which is also used by OpenOffice, and which supports many languages.
+ thesaurus library, which is included in LyX).
+ Therefore, LyX can directly access OpenOffice thesaurus dictionaries, which
+ are available for many languages.
 \end_layout
 
 \begin_layout Standard
-You need to have one of these libraries installed in order to use the thesaurus
- (if both are installed, 
-\emph on
-MyThes
-\emph default
- will be chosen automatically).
+This section describes how new dictionaries are installed and set up for
+ the use with LyX.
 \end_layout
 
 \begin_layout Subsection
@@ -28528,20 +28587,26 @@ Setting up the thesaurus
 \begin_layout Standard
 The 
 \emph on
-MyThes
+MyThes/
 \emph default
- library can directly access the OpenOffice thesauri, which consist of two
- files per language: A file with the ending 
+OpenOffice thesauri consist of two files per language: A file with the suffix
 \emph on
 *.dat
 \emph default
- containing the data and an index file with the ending 
+ containing the data and an index file with the suffix 
 \emph on
 *.idx
 \emph default
 .
- The file names include the language code for the given language, so the
- English files are named:
+ The standardized file names include the language code for the given language
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+ en_EN for English).
+ For instance, the English files are named:
 \end_layout
 
 \begin_layout Itemize
@@ -28553,16 +28618,16 @@ th_en_EN_v2.dat
 \end_layout
 
 \begin_layout Standard
-If you have OpenOffice installed including its thesaurus, these files should
be already on your system.
- If not, you can get dictionaries from the site
-\begin_inset Newline newline
-\end_inset
+If you have OpenOffice and its thesaurus installed, these files should be
+ already on your system.
+ If not, you can get dictionaries from the site 
+\begin_inset Flex URL
+status collapsed
 
+\begin_layout Plain Layout
 
-\begin_inset CommandInset href
-LatexCommand href
-target "http://extensions.services.openoffice.org"
+http://extensions.services.openoffice.org
+\end_layout
 
 \end_inset
 
@@ -28588,7 +28653,7 @@ Put the
 *.dat
 \emph default
  files of all languages you want to use into one directory (do not use subfolder
-s), and the specify the path to this directory in 
+s), and specify the path to this directory in 
 \family sans
 Tools\SpecialChar \menuseparator
 Preferences\SpecialChar \menuseparator
@@ -28695,6 +28760,40 @@ s), then you get proposals without adjusting the query in the dialog, and
  part will be replaced, thus the ending remains).
 \end_layout
 
+\begin_layout Subsection
+Lincense of the Thesaurus library
+\end_layout
+
+\begin_layout Standard
+The 
+\emph on
+MyThes
+\emph default
+ library, which is used by LyX for the thesaurus, was created by 
+\noun on
+Kevin B.
+ Hendricks
+\noun default
+ as a standalone program.
+ Version 1.1 of the library is included in LyX.
+ The library was released under the 
+\emph on
+Berkeley Database License
+\emph default
+, which is compatible with LyX's license, the GPL.
+ In order to meet the requirements of the Berkeley Database License, the
+ MyThes license file is included in the LyX sources in the folder 
+\family sans
+~src/support/mythes/license.readme
+\family default
+.
+ In LyX Windows installations it is additionally available in the file 
+\family sans
+MyThes-License.txt
+\family default
+ that is in the same folder as the file lyx.exe.
+\end_layout
+
 \begin_layout Section
 Change Tracking
 \begin_inset Index idx