mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-12-23 05:25:26 +00:00
Extended.lyx: remove the sections about glossaries and indices as they are now (more complete and revised) in the UserGuide.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@19816 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Uwe Stöhr
parent
77b575e562
commit
4172485013
@ -1,4 +1,4 @@
|
||||
#LyX 1.5.0svn created this file. For more info see http://www.lyx.org/
|
||||
#LyX 1.5.2svn created this file. For more info see http://www.lyx.org/
|
||||
\lyxformat 276
|
||||
\begin_document
|
||||
\begin_header
|
||||
@ -37,8 +37,8 @@
|
||||
\paperpagestyle headings
|
||||
\tracking_changes false
|
||||
\output_changes false
|
||||
\author ""
|
||||
\author ""
|
||||
\author ""
|
||||
\author ""
|
||||
\end_header
|
||||
|
||||
\begin_body
|
||||
@ -2515,453 +2515,6 @@ every
|
||||
Also, the btUnits cannot be nested.
|
||||
\end_layout
|
||||
|
||||
\begin_layout Section
|
||||
Making an Index
|
||||
\end_layout
|
||||
|
||||
\begin_layout Standard
|
||||
A good index is one of the hardest things to make in a lengthy document,
|
||||
but LyX helps make things a bit simpler by interfacing to the
|
||||
\family typewriter
|
||||
makeindex
|
||||
\family default
|
||||
program which is found in most recent LaTeX distributions.
|
||||
\begin_inset Foot
|
||||
status collapsed
|
||||
|
||||
\begin_layout Standard
|
||||
|
||||
\family roman
|
||||
\series medium
|
||||
\shape up
|
||||
\size normal
|
||||
\emph off
|
||||
\bar no
|
||||
\noun off
|
||||
\color none
|
||||
In the
|
||||
\family default
|
||||
\series default
|
||||
\shape default
|
||||
\emph default
|
||||
\bar default
|
||||
|
||||
\family sans
|
||||
\size default
|
||||
\noun default
|
||||
Outputs\SpecialChar \menuseparator
|
||||
LaT\SpecialChar \textcompwordmark{}
|
||||
eX
|
||||
\family roman
|
||||
\series medium
|
||||
\shape up
|
||||
\size normal
|
||||
\emph off
|
||||
\bar no
|
||||
\noun off
|
||||
section of the preferences dialog, however, you can customize the index
|
||||
command, if you prefer an alternative program like
|
||||
\family default
|
||||
\series default
|
||||
\shape default
|
||||
\emph default
|
||||
\bar default
|
||||
|
||||
\family typewriter
|
||||
\size default
|
||||
\noun default
|
||||
xindy
|
||||
\family roman
|
||||
\series medium
|
||||
\shape up
|
||||
\size normal
|
||||
\emph off
|
||||
\bar no
|
||||
\noun off
|
||||
.
|
||||
\end_layout
|
||||
|
||||
\end_inset
|
||||
|
||||
Inserting an index and marking words to include in it works much the same
|
||||
way as preparing a bibliography as mentioned in the last section.
|
||||
\end_layout
|
||||
|
||||
\begin_layout Standard
|
||||
First, go to the end of your file and select
|
||||
\family sans
|
||||
\bar under
|
||||
I
|
||||
\bar default
|
||||
nsert\SpecialChar \menuseparator
|
||||
List
|
||||
\family default
|
||||
\InsetSpace ~
|
||||
/\InsetSpace ~
|
||||
|
||||
\family sans
|
||||
T
|
||||
\bar under
|
||||
O
|
||||
\bar default
|
||||
C\SpecialChar \menuseparator
|
||||
|
||||
\bar under
|
||||
I
|
||||
\bar default
|
||||
ndex
|
||||
\family default
|
||||
\InsetSpace ~
|
||||
|
||||
\family sans
|
||||
List
|
||||
\family default
|
||||
.
|
||||
Then, for each word you would like to include in the index, go to the end
|
||||
of that word and click on
|
||||
\family sans
|
||||
\bar under
|
||||
I
|
||||
\bar default
|
||||
nsert\SpecialChar \menuseparator
|
||||
|
||||
\bar under
|
||||
I
|
||||
\bar default
|
||||
ndex
|
||||
\family default
|
||||
\InsetSpace ~
|
||||
|
||||
\family sans
|
||||
Entry
|
||||
\family default
|
||||
.
|
||||
This will insert a tag showing the word as it will appear in the index.
|
||||
That's all there is to it; LyX will automatically call
|
||||
\family typewriter
|
||||
makeindex
|
||||
\family default
|
||||
for you and create the index itself.
|
||||
The text in the dialog available from right-clicking on the index button
|
||||
accepts LaTeX, so you'll need to be careful to avoid using any special
|
||||
characters.
|
||||
On the positive side, you can use the advanced options - have a look at
|
||||
the documentation which comes with your LaTeX distribution to find out
|
||||
how to do things like
|
||||
\begin_inset Quotes eld
|
||||
\end_inset
|
||||
|
||||
nested entries
|
||||
\begin_inset Quotes erd
|
||||
\end_inset
|
||||
|
||||
, etc.
|
||||
\end_layout
|
||||
|
||||
\begin_layout Standard
|
||||
Be careful not to put spaces between the word in the text and the index
|
||||
marker; apparently the wrong page number can be produced if this happens.
|
||||
\end_layout
|
||||
|
||||
\begin_layout Section
|
||||
Glossaries
|
||||
\end_layout
|
||||
|
||||
\begin_layout Standard
|
||||
by
|
||||
\noun on
|
||||
Özgür Ug̃raş Baran
|
||||
\end_layout
|
||||
|
||||
\begin_layout Standard
|
||||
Sometimes you need to compile a list of symbols that are mentioned in your
|
||||
document with a brief explanation of them.
|
||||
A LaTeX package named
|
||||
\family typewriter
|
||||
nomencl
|
||||
\family default
|
||||
provides an easy way of compiling such lists.
|
||||
|
||||
\family typewriter
|
||||
nomencl
|
||||
\family default
|
||||
is included in most standard Linux distributions.
|
||||
If your distribution doesn't contain it, you should download it from a
|
||||
CTAN mirror and install the package in order to use this feature of LyX.
|
||||
\end_layout
|
||||
|
||||
\begin_layout Standard
|
||||
A glossary entry is created if you place the cursor after a symbol entry
|
||||
and then use the menu
|
||||
\family sans
|
||||
Insert\SpecialChar \menuseparator
|
||||
Glossary\InsetSpace ~
|
||||
Entry
|
||||
\family default
|
||||
.
|
||||
A gray box labeled
|
||||
\begin_inset Quotes eld
|
||||
\end_inset
|
||||
|
||||
|
||||
\family sans
|
||||
Not
|
||||
\family default
|
||||
|
||||
\begin_inset Quotes erd
|
||||
\end_inset
|
||||
|
||||
is inserted and a window pops up asking for the glossary entry.
|
||||
A glossary entry consists of two main entries.
|
||||
The first is the symbol that you want to refer to.
|
||||
You should enter a valid LaTeX code for the corresponding field in the
|
||||
glossary dialog.
|
||||
The second is the description of the symbol.
|
||||
You should fill the corresponding field to complete the glossary entry.
|
||||
\end_layout
|
||||
|
||||
\begin_layout Subsection
|
||||
Sort Order of Glossary Entries
|
||||
\end_layout
|
||||
|
||||
\begin_layout Standard
|
||||
Suppose you have two glossary entries for the symbols
|
||||
\begin_inset Formula $a$
|
||||
\end_inset
|
||||
|
||||
and
|
||||
\begin_inset Formula $\sigma$
|
||||
\end_inset
|
||||
|
||||
.
|
||||
The
|
||||
\family typewriter
|
||||
nomencl
|
||||
\family default
|
||||
package automatically sorts these two entries considering the symbol entry,
|
||||
while printing the Glossary.
|
||||
However, this can lead to an undesired sort order.
|
||||
For the example given, the first entry appears as
|
||||
\family typewriter
|
||||
$a$
|
||||
\family default
|
||||
, while the second is
|
||||
\family typewriter
|
||||
$
|
||||
\backslash
|
||||
sigma$
|
||||
\family default
|
||||
.
|
||||
Note that, in this case
|
||||
\begin_inset Formula $\sigma$
|
||||
\end_inset
|
||||
|
||||
is located in front of the
|
||||
\begin_inset Formula $a$
|
||||
\end_inset
|
||||
|
||||
, since the character
|
||||
\begin_inset Quotes eld
|
||||
\end_inset
|
||||
|
||||
|
||||
\backslash
|
||||
|
||||
\begin_inset Quotes erd
|
||||
\end_inset
|
||||
|
||||
is considered in sorting.
|
||||
In order to control the sort order, you can edit the
|
||||
\family sans
|
||||
Sort\InsetSpace ~
|
||||
as
|
||||
\family default
|
||||
field of the glossary dialog.
|
||||
For the given example, you can edit this field as
|
||||
\family typewriter
|
||||
a
|
||||
\family default
|
||||
and
|
||||
\family typewriter
|
||||
sigma
|
||||
\family default
|
||||
correspondingly.
|
||||
Then, these entries will be effective in the sort ordering and
|
||||
\begin_inset Formula $a$
|
||||
\end_inset
|
||||
|
||||
will be located before
|
||||
\begin_inset Formula $\sigma$
|
||||
\end_inset
|
||||
|
||||
.
|
||||
\end_layout
|
||||
|
||||
\begin_layout Standard
|
||||
This feature provides exciting ways of ordering the entries.
|
||||
For subgrouping and tips for using sort entries see the official nomencl
|
||||
documentation.
|
||||
\end_layout
|
||||
|
||||
\begin_layout Subsection
|
||||
Referencing
|
||||
\end_layout
|
||||
|
||||
\begin_layout Standard
|
||||
You can turn on referencing to the equations and pages in the glossary entries.
|
||||
For this purpose, you should add referencing options commands at the end
|
||||
of description field.
|
||||
There are six referencing options in nomencl package:
|
||||
\end_layout
|
||||
|
||||
\begin_layout Paragraph*
|
||||
|
||||
\backslash
|
||||
refeq:
|
||||
\end_layout
|
||||
|
||||
\begin_layout Standard
|
||||
Adds reference to the equation by adding the phrase
|
||||
\begin_inset Quotes eld
|
||||
\end_inset
|
||||
|
||||
, see equation (#)
|
||||
\begin_inset Quotes erd
|
||||
\end_inset
|
||||
|
||||
|
||||
\end_layout
|
||||
|
||||
\begin_layout Paragraph*
|
||||
|
||||
\backslash
|
||||
refpage:
|
||||
\end_layout
|
||||
|
||||
\begin_layout Standard
|
||||
Adds reference to the page by adding the phrase
|
||||
\begin_inset Quotes eld
|
||||
\end_inset
|
||||
|
||||
, page (#)
|
||||
\begin_inset Quotes erd
|
||||
\end_inset
|
||||
|
||||
|
||||
\end_layout
|
||||
|
||||
\begin_layout Paragraph*
|
||||
|
||||
\backslash
|
||||
refeqpage:
|
||||
\end_layout
|
||||
|
||||
\begin_layout Standard
|
||||
Is the short notation of
|
||||
\backslash
|
||||
refeq
|
||||
\backslash
|
||||
refpage.
|
||||
\end_layout
|
||||
|
||||
\begin_layout Paragraph*
|
||||
|
||||
\backslash
|
||||
norefeq,
|
||||
\backslash
|
||||
norefpag,
|
||||
\backslash
|
||||
norefeqpage:
|
||||
\end_layout
|
||||
|
||||
\begin_layout Standard
|
||||
Turns off corresponding referencing options if they are turned on globally
|
||||
(see reference documentation of nomencl).
|
||||
\end_layout
|
||||
|
||||
\begin_layout Subsection
|
||||
Printing Glossary
|
||||
\end_layout
|
||||
|
||||
\begin_layout Standard
|
||||
You can insert the glossary with the menu
|
||||
\family sans
|
||||
Insert\SpecialChar \menuseparator
|
||||
Lists\InsetSpace ~
|
||||
&TOC\SpecialChar \menuseparator
|
||||
Glossary
|
||||
\family default
|
||||
.
|
||||
A light blue box labeled
|
||||
\begin_inset Quotes eld
|
||||
\end_inset
|
||||
|
||||
|
||||
\family sans
|
||||
Glossary
|
||||
\family default
|
||||
|
||||
\begin_inset Quotes erd
|
||||
\end_inset
|
||||
|
||||
will show the place where the index is printed in the output.
|
||||
The index list box is not clickable like other LyX-boxes.
|
||||
In the printed output the title of the glossary appears as
|
||||
\series bold
|
||||
Nomenclature
|
||||
\series default
|
||||
|
||||
\begin_inset Foot
|
||||
status collapsed
|
||||
|
||||
\begin_layout Standard
|
||||
This is translated to the document language for a small number of languages,
|
||||
amongst others French and German
|
||||
\end_layout
|
||||
|
||||
\end_inset
|
||||
|
||||
.
|
||||
If you are not happy with the title, you can change it by re-defining the
|
||||
command
|
||||
\family typewriter
|
||||
|
||||
\backslash
|
||||
nomname
|
||||
\family default
|
||||
in the preamble.
|
||||
For example, in order to change the title
|
||||
\emph on
|
||||
List of Symbols
|
||||
\emph default
|
||||
for the
|
||||
\emph on
|
||||
Glossary
|
||||
\emph default
|
||||
add the following line to the preamble.
|
||||
\end_layout
|
||||
|
||||
\begin_layout LyX-Code
|
||||
|
||||
\backslash
|
||||
renewcommand{
|
||||
\backslash
|
||||
nomname}{List of Symbols}
|
||||
\end_layout
|
||||
|
||||
\begin_layout Standard
|
||||
If you're unhappy with the amount of space for symbols, you can alter it
|
||||
by adding following line to the preamble.
|
||||
\end_layout
|
||||
|
||||
\begin_layout LyX-Code
|
||||
|
||||
\backslash
|
||||
renewcommand{
|
||||
\backslash
|
||||
nomlabelwidth}{3.0cm}
|
||||
\end_layout
|
||||
|
||||
\begin_layout Section
|
||||
Multipart Documents
|
||||
\end_layout
|
||||
|
||||
Loading…
Reference in New Issue
Block a user