<?xml version="1.0" encoding="ISO-8859-1"?>
<!-- LyX 1.4.0cvs created this file. For more info see http://www.lyx.org/-->
<lyxdocument format="236">
<header>
<param name="textclass" value="book"/>
<param name="language" value="english"/>
<param name="inputencoding" value="default"/>
<param name="fontscheme" value="default"/>
<param name="graphics" value="default"/>
<param name="paperfontsize" value="default"/>
<param name="spacing" value="single"/>
<param name="papersize" value="true"/>
<param name="paperpackage" value="true"/>
<param name="use_geometry" value="false"/>
<param name="use_amsmath" value="0"/>
<param name="cite_engine" value="basic"/>
<param name="use_bibtopic" value="false"/>
<param name="paperorientation" value="true"/>
<param name="secnumdepth" value="2"/>
<param name="tocdepth" value="2"/>
<param name="paragraph_separation" value="true"/>
<param name="defskip" value="medskip"/>
<param name="quotes_language" value="true"/>
<param name="quotes_times" value="true"/>
<param name="papercolumns" value="1"/>
<param name="papersides" value="1"/>
<param name="paperpagestyle" value="default"/>
<param name="tracking_changes" value="false"/>
</header>
<body>
<paragraph layout="Title">
Introduction to LyX
</paragraph>
<paragraph layout="Author">
by the LyX Team<Foot>
<text>
<paragraph layout="Standard">
Principal maintainer of this file is <font noun="on">John Weiss</font>.
If you have comments or error corrections, please send them to the LyX
Documentation mailing list, <[EMAIL PROTECTED]>.
</paragraph>
</text>
</Foot>
</paragraph>
<paragraph layout="Standard">
<latexcommand><![CDATA[\tableofcontents{}]]></latexcommand>
</paragraph>
<paragraph layout="Chapter">
The Philosophy of LyX
</paragraph>
<paragraph layout="Quote">
<quotes type="eld"/>Uncle Cosmo, why do they call this a word processor?<quotes type="erd"/>
</paragraph>
<paragraph layout="Quote">
<quotes type="eld"/>It's simple, Skyler.
You've seen what food processors do to food, right?<quotes type="erd"/>
</paragraph>
<paragraph layout="Quote">
<latexcommand><![CDATA[\hfill{}]]></latexcommand>--- Jeff MacNelly in <quotes type="eld"/>Shoe<quotes type="erd"/>
</paragraph>
<paragraph layout="Section">
What is LyX?
</paragraph>
<paragraph layout="Standard">
LyX is a document preparation system.
It excels at letting you create complex technical and scientific articles
with mathematics, cross-references, bibliographies, indices, etc.
It is very good at documents of any length in which the usual processing
abilities are required: automatic sectioning and pagination, spellchecking,
and so forth.
It can also be used to write a letter to your mom, though granted, there
are probably simpler programs available for that.
It is definitely not the best tool for creating banners, flyers, or advertiseme
nts (we'll explain why later), though with some effort all these can be
done, too.
Some examples of what it is used for: memos, letters, dissertations and
theses, lecture notes, seminar notebooks, conference proceedings, software
documentation, books (on PostgreSQL, remote sensing, cryptology, fictional
novels, poetry, and even a children's book or two), articles in refereed
scientific journals, scripts for plays and movies, business proposals <specialchar type="ldots"/>
you get the idea.
</paragraph>
<paragraph layout="Standard">
LyX is a program that provides a modern approach to writing documents with
a computer by using a markup language paradigm, an approach that breaks
with the obsolete tradition of the <quotes type="eld"/>typewriter concept.<quotes type="erd"/> It is designed for
authors who want professional output quickly with a minimum of effort without
becoming specialists in typesetting.
The job of typesetting is done mostly by the computer, not the author;
with LyX, the author can concentrate on the contents of her writing.
</paragraph>
<paragraph layout="Standard">
Part of the initial challenge of using LyX comes from the change in thinking
that you, the user, must make.
At one time, all we had for creating documents were typewriters, so we
all learned certain tricks to get around their limitations.
Underlining, which is little more than overstriking with the <quotes type="eld"/>_<quotes type="erd"/> character,
became a way to emphasize text.
You were forced to figure out column sizes and tab stops, and set them,
before creating a table.
The same applied for letters and other right justified text.
Hyphenation at the end of a line required a careful eye and a lot of foresight.
</paragraph>
<paragraph layout="Standard">
In other words, we've all been trained to worry about the little details
of which character goes where.
Consequently, almost all word processors have this mentality.
They still use tab stops for adding whitespace.
You still need to worry about exactly where on the page something will
appear.
Emphasizing text means changing a font, similar to changing the typewriter
wheel.
This is the underlying philosophy of a WYSIWYG word processor: <quotes type="eld"/>What You
See Is What You Get<quotes type="erd"/>.
Unfortunately, that paradigm often results in <quotes type="eld"/>What You See Is All You Get<quotes type="erd"/>.
</paragraph>
<paragraph layout="Standard">
This is where LyX differs from an ordinary word processor.
You don't concern yourself with what character goes where.
You tell LyX <font emph="on">what you're doing</font> and LyX takes care of the rest, following a set of rules called a <font emph="on">style.</font><Foot>
<text>
<paragraph layout="Standard">
To be fair, most recent versions of the most popular office suites now have
some sort of style sheets which follow a similar markup method.
However, our experience is that they are still rarely used in practice.
</paragraph>
</text>
</Foot>
Let's look at a little example:
</paragraph>
<paragraph layout="Standard">
Suppose you are writing a report.
To begin your report, you want a section called <quotes type="eld"/>Introduction<specialchar type="eos"/><quotes type="erd"/> So, you go
into whatever menu it is in your word processor that changes font sizes
and decide on a new font size.
Then you turn on bold face.
Then you type, <quotes type="eld"/>1.<space type="nobrspc"/><space type="nobrspc"/>Introduction<quotes type="erd"/>.
Of course, if you later decide that this section belongs someplace else
in the document, or if you insert a new section before it, you need to
change the numbering for this and all following sections, as well as any
entry in the table of contents.
</paragraph>
<paragraph layout="Standard">
In LyX, you go to the pull-down on the far left of the button bar and select
<font family="sans">Section</font>, and type <quotes type="eld"/>Introduction<specialchar type="eos"/><quotes type="erd"/>
</paragraph>
<paragraph layout="Standard">
Yes, that's all.
If you cut and paste the section, it will automatically be renumbered ---
everywhere.
And if you enter references to that section correctly (by inserting cross-refer
ence tags), LyX will automatically update them all throughout the file so
that you never, ever type a section number.
</paragraph>
<paragraph layout="Standard">
Now let's look at the problem of consistency.
Five days later, you reopen your report and start Section<space type="nobrspc"/>4.
However, you forget that you were using 18pt bold instead of 16pt, so you
type in the heading for Section<space type="nobrspc"/>4 in a different font that what you used
for Section<space type="nobrspc"/>1.
That problem doesn't even exist in LyX.
The computer takes care of all that silly bookkeeping about which thing
has what size font, not you.
After all, that's what a computer is good at.
</paragraph>
<paragraph layout="Standard">
Here's another example.
Suppose you're making a list.
In other word processors, a list is just a bunch of tab stops and newlines.
You need to figure out where to put the label for each list item, what
that label should be, how many blank lines to put between each item, and
so on.
Under LyX, you have only two concerns: what kind of list is this, and what
do I want to put in it.
That's it.
</paragraph>
<paragraph layout="Standard">
So, the basic idea behind LyX is: specify <font emph="on">what</font> you're doing, not <font emph="on">how</font> to do it.
Instead of <quotes type="eld"/>What You See Is What You Get,<quotes type="erd"/> the LyX model is <quotes type="eld"/>What You See
Is What You <font emph="on">Mean</font><quotes type="erd"/> or <quotes type="eld"/>WYSIWYM.<quotes type="erd"/> It's a powerful idea that greatly simplifies the mechanics of
writing documents.
This is also why LyX isn't so good for creating posters and flyers---in
this case, you <font emph="on">do</font> want to specify exactly where everything goes, because there are no functional
units like paragraphs, sections, etc.
This doesn't mean LyX is missing some cool function.
It simply means that it isn't the right tool for the job --- you don't
use a screwdriver to drive in nails (unless your screwdriver comes with
a lifetime warranty).
</paragraph>
<paragraph layout="Section">
Differences between LyX and Other Word
<newline/>
Processors<optarg>
status collapsed
\begin_layout Standard
LyX and Other Word Processors
\end_layout
</optarg>
<Foot>
<text>
<paragraph layout="Standard">
No, we're not trying to start (or win) a word processor holy war here.
But we do think it's important to describe LyX's features.
And one of LyX's main features, WYSIWYM, is a fundamentally different concept
than the one that most of people have about word processing.
</paragraph>
</text>
</Foot>
</paragraph>
<paragraph layout="Standard">
Here's a list of things you won't find in LyX:
</paragraph>
<paragraph layout="Itemize">
The document ruler
</paragraph>
<paragraph layout="Itemize">
Tab stops
</paragraph>
<paragraph layout="Itemize">
Extra whitespace (i.e.
hitting <font family="sans">Enter</font> or <font family="sans">Space</font> two or more times)
</paragraph>
<paragraph layout="Standard">
Tab stops, along with a ruler showing you the position of things on the
page, are useless in LyX.
The program worries about where things go on the page, not you.
Extra whitespace is similar; LyX adds them where necessary, depending on
context.
Not being able to type two blank lines in a row will be annoying at first,
but it makes more sense once you're thinking in WYSIWYM terms.
</paragraph>
<paragraph layout="Standard">
Here are some things that exist in LyX, but aren't used as you might think:
</paragraph>
<paragraph layout="Itemize">
Indenting controls
</paragraph>
<paragraph layout="Itemize">
Page breaks
</paragraph>
<paragraph layout="Itemize">
Line spacing (i.e.
single spaced, double spaced, etc.)
</paragraph>
<paragraph layout="Itemize">
Whitespace, horizontal and vertical
</paragraph>
<paragraph layout="Itemize">
Fonts and font sizes
</paragraph>
<paragraph layout="Itemize">
Typefaces (bold, italic, underline, etc.)
</paragraph>
<paragraph layout="Standard">
Although they exist in LyX, you generally don't need them.
LyX will take care of these things for you, depending on what you're doing.
Different parts of the document are automatically set in a different typeface
and font size.
Paragraph indenting is context dependent; different types of paragraphs
get indented differently.
Page breaks get handled automatically, as well.
In general, the space between lines, between words, and between paragraphs
is variable, set by LyX.<Foot>
<text>
<paragraph layout="Standard">
There are ways to adjust all of these (only some of which require knowledge
of LaTeX), either for a whole document or for a specific location in a
document.
See the <font emph="on">User's Guide</font> and/or the <font emph="on">Extended Features</font> manual for details.
</paragraph>
</text>
</Foot>
</paragraph>
<paragraph layout="Standard">
Lastly, there are a few areas where we believe LyX (and LaTeX) surpasses
many word processors:
</paragraph>
<paragraph layout="Itemize">
Hyphenation
</paragraph>
<paragraph layout="Itemize">
Lists of any type
</paragraph>
<paragraph layout="Itemize">
Mathematics
</paragraph>
<paragraph layout="Itemize">
Tables
</paragraph>
<paragraph layout="Itemize">
Cross-referencing
</paragraph>
<paragraph layout="Standard">
Granted, many modern word processors can handle mathematical symbols, tables,
and hyphenation, and many have moved towards style definitions and the
WYSIWYM concept.
However, they've only recently been able to do so, whereas LyX is built
upon the LaTeX document preparation system.
LaTeX has been around for over 15 years, and <font emph="on">works</font>.
</paragraph>
<paragraph layout="Section">
What the heck <font emph="on">is</font> LaTeX (and why do I care)?
</paragraph>
<paragraph layout="Standard">
LaTeX is a document preparation system designed by Leslie Lamport in 1985.<Foot>
<text>
<paragraph layout="Standard">
The source for the info in this section is <quotes type="eld"/><font emph="on">A Guide to LaTeX2e</font>,<quotes type="erd"/> by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
of the <font emph="on">User's Guide</font><specialchar type="eos"/>
</paragraph>
</text>
</Foot>
It, in turn, was built up from a typesetting language called TeX, created
by Donald Knuth in 1984.
<quotes type="eld"/>TeX<quotes type="erd"/> is pronounced like <quotes type="eld"/>blech!<quotes type="erd"/> which is how many people feel about it.
However, most folks don't understand just what TeX is.
TeX takes a sequence of typesetting commands, written in a script in an
ASCII file, and executes them.
It's a bit more complicated than a typewriter, but not nearly as involved
as an actual printing press; however, many of the <quotes type="eld"/>tricks<quotes type="erd"/> of the printing
trade were modeled by Knuth as computer algorithms and incorporated into
TeX, thus its excellent printed appearance.
In any case, what comes directly out of TeX is the so-called <quotes type="eld"/>device independent<quotes type="erd"/>
format file, or <font family="typewriter">dvi</font> for short.
You can then feed the <font family="typewriter">dvi</font> file to anything that understands <font family="typewriter">dvi</font>, or converts <font family="typewriter">dvi</font> to other formats like PostScript®, PDF, etc.
</paragraph>
<paragraph layout="Standard">
If it weren't for one other feature, all TeX would be is a typesetting engine.
However, TeX also allows you to define macros.
This is where the action begins.
</paragraph>
<paragraph layout="Standard">
Most people who use TeX are actually using a macro package which Knuth created
to hide a lot of the typesetting details.
This is what most people think of when they think of TeX<specialchar type="eos"/> Ordinary users
don't work with raw TeX, which are the bare-bones typesetting commands.
People creating new macro-packages do that.
This is where Leslie Lamport enters our story.
He wanted a macro package that was more user-oriented and less typesetter-orien
ted, a set of commands that consistently typeset things like sections or
tables or math formulae in a uniform, consistent fashion with as little
fuss as possible.
This is how LaTeX was born.
</paragraph>
<paragraph layout="Standard">
Now, in parallel with the development and growth of LaTeX, other folks were
creating their own custom macro packages for TeX, ones to make slides or
articles for math journals and so on.
Some used the raw TeX facilities to do this, others began modifying LaTeX.
To try and unify this mess, a team of LaTeX-nicians (including Lamport,
of course) began to work on LaTeX2e, the current version of LaTeX, during
the late 1980's.
This new version of LaTeX has commands which provide an easier-to-use interface
to TeX's macro-creating commands (remember TeX?), aid in the use of new
fonts, and so on.
In fact, LaTeX is quite an extensive language in its own right! Users around
the world have been creating their own add-ons for LaTeX beyond the standard
ones.
</paragraph>
<paragraph layout="Standard">
There are two ways to extend LaTeX: classes and styles.
A <font emph="on">class</font> is a set of LaTeX (and TeX) macros describing a new type of document, like
a book, or an article.
There are classes for slides, for physics and math journals<specialchar type="ldots"/> many universities
even have a class for their thesis format! A <font emph="on">style</font> differs from a class in that it doesn't define a new type of document,
but a different type of <font emph="on">behavior</font> that any document can use.
For example, LyX controls page margins and line spacing using two different
LaTeX style-files designed for these purposes.
There are style-files for a whole slew of things: printing labels or envelopes,
changing indentation behavior, adding new fonts, manipulating graphics,
designing fancy page headings, customizing bibliographies, altering the
location and appearance of footnotes, tables, and figures, customizing
lists, et cetera.
</paragraph>
<paragraph layout="Standard">
Here's a summary:
</paragraph>
<paragraph layout="List">
<labelwidthstring>00.00.0000</labelwidthstring>
TeX: Typesetting language with macro capability.
</paragraph>
<paragraph layout="List">
<labelwidthstring>00.00.0000</labelwidthstring>
LaTeX: Macro package built upon TeX<specialchar type="eos"/>
</paragraph>
<paragraph layout="List">
<labelwidthstring>00.00.0000</labelwidthstring>
classes: Descriptions of a type of document, using LaTeX<specialchar type="eos"/>
</paragraph>
<paragraph layout="List">
<labelwidthstring>00.00.0000</labelwidthstring>
styles: Alters the default behavior of LaTeX in some way.
</paragraph>
<paragraph layout="List">
<labelwidthstring>00.00.0000</labelwidthstring>
LyX: Visual, WYSIWYM word-processor that uses LaTeX in all its glory to
do its printing.
</paragraph>
<paragraph layout="Standard">
The idea of this section was to try and explain <font emph="on">why</font> LyX works somewhat differently from other word processors.
The reason is simple: LyX uses LaTeX as its printing backend.
Just like LaTeX, LyX focuses on the context of your writing --- <font emph="on">what</font> you are typing.
The computer then handles how it should look.
</paragraph>
<paragraph layout="Standard">
Oh --- one last thing.
LaTeX is pronounced like TeX is.
It rhymes with <quotes type="eld"/>hey blech.<quotes type="erd"/><Foot>
<text>
<paragraph layout="Standard">
or <quotes type="eld"/>ha blech<quotes type="erd"/>, depending on how you pronounce your <quotes type="eld"/>a<quotes type="erd"/>s<specialchar type="ldots"/>
</paragraph>
</text>
</Foot>
Usually.
Lamport says in his book, though, that <quotes type="eld"/><font emph="on">lay</font>-tecks is also possible<quotes type="erd"/>.
<quotes type="eld"/>LyX,<quotes type="erd"/> on the other hand, is pronounced <quotes type="eld"/>licks.<quotes type="erd"/> Or <quotes type="eld"/>lucks,<quotes type="erd"/> or <quotes type="eld"/>looks,<quotes type="erd"/> depending
on what country you're from <specialchar type="ldots"/> but numerous holy wars and flame fests have
been started over this issue on the LyX mailing lists, so please just pronounce
it however you please.
Just don't pronounce it <quotes type="eld"/>word<quotes type="erd"/>.
<font family="typewriter">:-)</font>
</paragraph>
<paragraph layout="Chapter">
Navigating the Documentation
</paragraph>
<paragraph layout="Standard">
To make it easier to answer your questions and describe all of the features
of LyX, the documentation has been split up into several different files.
Each one has its own purpose, as described below.
Before you go plowing into any of those files, however, you should read
this chapter thoroughly first, since it contains a lot of useful information
and commentary that can save you some time.
</paragraph>
<paragraph layout="Standard">
Although LyX is now well past the <quotes type="eld"/>version 1.0<quotes type="erd"/> mark, some of the documentation
may be incomplete or a bit out of date, though we try to keep up.
Like the rest of LyX, the manuals are the work of a group of volunteers
who have <quotes type="eld"/>Real Jobs<quotes type="erd"/>, families, dishes to clean, kitty litter to dispose
of, et cetera.
If you want to help out, be sure to read Section<space type="nobrspc"/><latexcommand><![CDATA[\ref{sec:Contrib}]]></latexcommand> in addition to the rest
of this document.)
</paragraph>
<paragraph layout="Standard">
Also, please do us a favor---if anything in these manuals confuses you,
is unclear, or wrong, don't hesitate to let us know! You can reach the
current document maintainers by mailing to <font family="typewriter">[EMAIL PROTECTED]</font>.
If you have questions which are not obviously answered in the documentation,
and need help fast, there is an active users' mailing list which you can
reach at <font family="typewriter">[EMAIL PROTECTED]</font>.
</paragraph>
<paragraph layout="Section">
The Format of the Manuals
</paragraph>
<paragraph layout="Standard">
Some of you may have printed out the manual(s).
Others may be reading it online, within LyX as a file.
For those reading online, there are some differences from the printed version.
First, the title is simply at the top of the document, not formatted on
a separate page as in some of the printed versions.
Nor are any of the footnotes or the Table of Contents visible.
To open a footnote, which looks like this,<Foot>
<text>
<paragraph layout="Standard">
Hi!
</paragraph>
<paragraph layout="Standard">
To close me, click on the grey box on the top left of this box, the one
with the word <quotes type="eld"/>foot<quotes type="erd"/> in it.
</paragraph>
</text>
</Foot>
click on it with the left mouse
button.
For the Table of Contents, either click on the grey box, or click on the
<font family="sans" bar="under">N</font><font family="sans">avigate</font> menu, where the contents are displayed automatically<specialchar type="eos"/> (Try it!)
</paragraph>
<paragraph layout="Standard">
In the printed manuals, all cross-references appear as the actual numbers
for a chapter, section, subsection, and so on.
Online, however, all cross-references appear as a grey box like the following:
<latexcommand><![CDATA[\ref{sec:Contrib}]]></latexcommand>.
(The printed manuals show a number instead.) If you click on that box with
the left mouse button, a dialog box will appear containing a list of all
the cross-references in the document.
This introduction has only one named <quotes type="eld"/>sec:Contrib<quotes type="erd"/>.
You can go to the section the referred to by clicking the button labeled
"Go to reference".
Going back to where you came from is just as easy.
Clicking on <quotes type="eld"/>Go back<quotes type="erd"/> or typing <font family="sans">C-<</font> will take you back to your earlier location.
(What does <quotes type="eld"/><font family="sans">C-<</font><quotes type="erd"/> mean? See below.)
</paragraph>
<paragraph layout="Standard">
Now that we've cleared up some of the differences between the printed and
online versions of this file, we can start looking at the format of this
document.
You'll occasionally notice things in different fonts:
</paragraph>
<paragraph layout="Itemize">
<font emph="on">Emphasized Style</font> is used for general emphasis, generic arguments, book titles, names of
sections of other manuals, and notes from the authors.
</paragraph>
<paragraph layout="Itemize">
<font family="typewriter">Typewriter</font> is used for program and file names, LaTeX code, and LyX code and functions.
</paragraph>
<paragraph layout="Itemize">
<font family="sans">Sans Serif</font> is used for menu, button, or dialog box names, and the names of keyboard
keys.
</paragraph>
<paragraph layout="Itemize">
<font noun="on">Noun Style</font> is used for people's names.
</paragraph>
<paragraph layout="Standard">
For menu accelerator keys and other more obscure keybindings, you'll probably
get referred to the <font emph="on">Key Bindings</font> section of the <quotes type="eld"/><font emph="on">Extended Features Manual</font><quotes type="erd"/> (the file <font family="typewriter">Extended.lyx</font>).
When we do need to reference keys, we'll use the following prefixing convention
:
</paragraph>
<paragraph layout="Itemize">
<quotes type="eld"/><font family="sans">C-</font><quotes type="erd"/> indicates the <font family="sans">Control-</font> key.
</paragraph>
<paragraph layout="Itemize">
<quotes type="eld"/><font family="sans">S-</font><quotes type="erd"/> indicates the <font family="sans">Shift-</font> key.
</paragraph>
<paragraph layout="Itemize">
<quotes type="eld"/><font family="sans">M-</font><quotes type="erd"/> indicates the <font family="sans">Meta-</font> key, which on some keyboards will be the <font family="sans">Alt-</font> key.
</paragraph>
<paragraph layout="Itemize">
<quotes type="eld"/><font family="sans">F1</font><quotes type="erd"/> <specialchar type="ldots"/> <quotes type="eld"/><font family="sans">F12</font><quotes type="erd"/> are the function keys.
</paragraph>
<paragraph layout="Itemize">
<quotes type="eld"/><font family="sans">Esc</font><quotes type="erd"/> is the escape key.
</paragraph>
<paragraph layout="Itemize">
<quotes type="eld"/><font family="sans">Left</font><quotes type="erd"/> <quotes type="eld"/><font family="sans">Right</font><quotes type="erd"/> <quotes type="eld"/><font family="sans">Up</font><quotes type="erd"/> <quotes type="eld"/><font family="sans">Down</font><quotes type="erd"/>: self-explanatory.
</paragraph>
<paragraph layout="Itemize">
<font family="sans"><quotes type="eld"/>Insert</font><quotes type="erd"/> <quotes type="eld"/><font family="sans">Delete</font><quotes type="erd"/> <quotes type="eld"/><font family="sans">Home</font><quotes type="erd"/> <quotes type="eld"/><font family="sans">End</font><quotes type="erd"/> <quotes type="eld"/><font family="sans">PageUp</font><quotes type="erd"/> <quotes type="eld"/><font family="sans">PageDown</font><quotes type="erd"/>: these are the 6 keys that appear above the cursor keys on many PC keyboards.
<quotes type="eld"/><font family="sans">PageUp</font><quotes type="erd"/> and <quotes type="eld"/><font family="sans">PageDown</font><quotes type="erd"/> are called <quotes type="eld"/><font family="sans">Prior</font><quotes type="erd"/> and <quotes type="eld"/><font family="sans">Next</font><quotes type="erd"/> on some keyboards.
</paragraph>
<paragraph layout="Itemize">
<font family="sans">Return</font> and <font family="sans">Enter</font> both refer to the same key.
Some keyboards label the <font family="sans">Return</font> key as <quotes type="eld"/>Return,<quotes type="erd"/> others as <quotes type="eld"/>Enter,<quotes type="erd"/> still others have two keys.
LyX treats all of them as the same key, so we'll use <font family="sans">Return</font> and <font family="sans">Enter</font> interchangeably.
</paragraph>
<paragraph layout="Standard">
You'll also see something like <quotes type="eld"/>(See <font emph="on"><quotes type="els"/>Extended</font><quotes type="ers"/>)<quotes type="erd"/> from time to time.
We've listed the possible default keybindings for a function in its entry
in the <quotes type="eld"/><font emph="on">Extended Features Manual</font>,<quotes type="erd"/> so check there, too.
Note that there are two different keybinding maps in common use in the
LyX community: the <quotes type="eld"/>CUA<quotes type="erd"/> style which is the default and familiar to those
coming from the PC world, and the <quotes type="eld"/>emacs<quotes type="erd"/> style, which is common with those
who <quotes type="eld"/>grew up<quotes type="erd"/> on Unix systems and use the Emacs editor.
Unless specifically noted, the keybindings in the documentation are from
the default CUA map.
If you like Emacs, you should be smart enough to read the documentation
and figure out the bindings on your own.
</paragraph>
<paragraph layout="Section">
The Manuals
</paragraph>
<paragraph layout="Standard">
The following list describes the contents of each of the files in the documentat
ion:
</paragraph>
<paragraph layout="Description">
<font emph="on">Introduction</font>
</paragraph>
<deeper>
<paragraph layout="Standard">
This file.
</paragraph>
</deeper>
<paragraph layout="Description">
<font emph="on">Tutorial </font>
</paragraph>
<deeper>
<paragraph layout="Standard">
If you are new to LyX, and have never used LaTeX before, you should start
here.
If you think LaTeX is the stuff they make condoms out of, then you definitely
need to reread Chapter 1, then read the <font emph="on">Tutorial</font>.
Note that after you read the <font emph="on">Tutorial</font>, you'll probably still think LaTeX is some stretchy substance --- but you
<font emph="on">will</font> know how to use LyX.
</paragraph>
<paragraph layout="Standard">
If you <font emph="on">have</font> used LaTeX before, you should still read the <font emph="on">Tutorial</font>, starting with the section on <quotes type="eld"/>LyX for LaTeX users.<quotes type="erd"/> (Skimming the rest of
the document wouldn't hurt, either.)
</paragraph>
<paragraph layout="Standard">
If, at any time, you find yourself feeling a bit clueless with respect to
LyX, try perusing the <font emph="on">Tutorial</font> before diving into any of the other manuals.
It's a good springboard.
</paragraph>
</deeper>
<paragraph layout="Description">
<font emph="on">User's<space type="nobrspc"/>Guide</font>
</paragraph>
<deeper>
<paragraph layout="Standard">
The primary documentation.
We'll cover <font emph="on">most</font> of the basic operation and available features of LyX here.
The main manual assumes that you've read the <font emph="on">Tutorial</font>.
</paragraph>
</deeper>
<paragraph layout="Description">
<font emph="on">Extended<space type="nobrspc"/>Features</font>
</paragraph>
<deeper>
<paragraph layout="Standard">
Extension of the <font emph="on">User's Guide</font>.
Documents how to use raw LaTeX commands, additional layouts, and special-purpos
e editing features, and includes some of the (rather bizarre, but nifty)
tricks of the LaTeX masters.
</paragraph>
</deeper>
<paragraph layout="Description">
<font emph="on">Customization</font>
</paragraph>
<deeper>
<paragraph layout="Standard">
A description of advanced LyX features, including how to customize the overall
behavior of LyX<specialchar type="eos"/> This includes such things as keybindings, internationalization,
and configuration files.
Don't even think of going in here until you read the <font emph="on">Tutorial</font>.
</paragraph>
</deeper>
<paragraph layout="Description">
<font emph="on">LaTeX<space type="nobrspc"/>configuration</font>
</paragraph>
<deeper>
<paragraph layout="Standard">
LyX investigates your system upon installation.
This file contains info on what LyX learned about your installation.
Check it to see if you're missing something you might like to have.
</paragraph>
</deeper>
<paragraph layout="Standard">
These files will reference one another as necessary.
For example, the <font emph="on">User's Guide</font> contains <font emph="on">some</font> information on installation and customization, but refers the reader to
the <font emph="on">Customization Manual</font> for more information.
</paragraph>
<paragraph layout="Standard">
We'll state again an important point:
</paragraph>
<paragraph layout="Standard">
<vspace type="bigskip"/>
</paragraph>
<paragraph layout="Standard">
<align>center</align>
If you are new to LyX, read the <font emph="on">Tutorial</font>.
Now<specialchar type="eos"/>
</paragraph>
<paragraph layout="Standard">
<vspace type="bigskip"/>
</paragraph>
<paragraph layout="Standard">
Otherwise, you could needlessly frustrate yourself.
LyX does all that you need a word processor to do, but using a different
approach.
</paragraph>
<paragraph layout="Chapter">
<latexcommand><![CDATA[\label{sec:Contrib}]]></latexcommand>Contributing to the LyX Project
</paragraph>
<paragraph layout="Section">
Contributing to LyX
</paragraph>
<paragraph layout="Standard">
LyX is mostly written in C++ (the LaTeX importer is written in Perl).
It is a large project, and as a result it is not free from bugs, or the
need for improvements in the source code.
</paragraph>
<paragraph layout="Subsection">
Reporting a bug
</paragraph>
<paragraph layout="Standard">
While using LyX, you may find behaviour which you consider a bug.
Crashes, though rare, can happen.
User interface problems are considered major bugs by the LyX team: especially
helpful are indications of parts of the LyX interface you find confusing,
or unclear.
</paragraph>
<paragraph layout="Standard">
LyX has a bug tracking system, which you can find at <font family="typewriter"></font><latexcommand><![CDATA[\htmlurl[LyX bug tracker]{http://bugzilla.lyx.org/}]]></latexcommand>.
You should check the bug tracker before reporting any bugs, in case it
has already been reported.
If you have a comment on an existing bug, or wish to report a new bug,
you may either use the bug tracker, or send an e-mail to the development
mailing list, <font family="typewriter">[EMAIL PROTECTED]</font>.
Archives of this list are linked from the main LyX website, <font family="typewriter"></font><latexcommand><![CDATA[\htmlurl[LyX website]{http://www.lyx.org/}]]></latexcommand>.
</paragraph>
<paragraph layout="Standard">
A good (useful) bug report will at a minimum include the version of LyX
you are having the problem with.
Accurate, detailed descriptions are preferred - the more time developers
have to spend to pinpoint the source of a bug, the less time they have
for other improvements.
Mention the system and system version you are running LyX with.
Give the versions of the libraries you have installed on your system, and,
if relevant, the versions of external programs that LyX uses.
If it's a compilation or configuration problem, include the file <font family="typewriter">config.log</font>, and mention which compiler you are using.
</paragraph>
<paragraph layout="Standard">
If you can make LyX crash, please take the time to produce a backtrace with
a non-stripped lyx executable.
The one built in the source directory is per default not stripped, while
the installed binary is stripped.
So, run LyX from gdb by typing, for example, <quotes type="eld"/><font family="typewriter" size="small">gdb /users/steve/lyx-1.0.x/src/lyx</font><quotes type="erd"/> and then <quotes type="eld"/><font family="typewriter" size="small">run</font><quotes type="erd"/>.
Make LyX crash and you'll return to gdb.
Use <quotes type="eld"/><font family="typewriter" size="small">bt</font><quotes type="erd"/> to produce a backtrace and include the output in the bug report<Foot>
<text>
<paragraph layout="Standard">
if you want to be thorough, use the <quotes type="eld"/><font family="typewriter">info locals</font><quotes type="erd"/> and <quotes type="eld"/><font family="typewriter">up</font><quotes type="erd"/> commands to print out the values of local variables at a few stack levels.
</paragraph>
</text>
</Foot>
.
If possible, then a description of a way to reproduce the bug is more important
than a backtrace, because then we have the possibility to roll our own
backtrace.
If the bug is not easily reproducible, a backtrace is essential, because
then that might be all we've got.
</paragraph>
<paragraph layout="Subsection">
Contributing fixes and new features
</paragraph>
<paragraph layout="Standard">
If you have made changes to LyX's source that you think should become part
of LyX, send your changes as a diff file (in unified format) to the development
list referenced above, along with a change log, and a description of what
your patch does.
</paragraph>
<paragraph layout="Section">
Contributing to the Documentation
</paragraph>
<paragraph layout="Standard">
LyX's documentation is extensive; however LyX is under constant development,
and each new release adds new features.
You may find some documentation needs improvement.
This section describes what to do if you find an error, or have some suggestion
s for improving the documentation.
</paragraph>
<paragraph layout="Subsection">
Reporting Errors in the Manuals
</paragraph>
<paragraph layout="Standard">
If you find a problem with the documentation, send a message to the mailing
list <font family="typewriter">[EMAIL PROTECTED]</font>.
The documentation team will make any necessary fixes.
</paragraph>
<paragraph layout="Subsection">
Joining the Documentation Team.
</paragraph>
<paragraph layout="Standard">
The LyX Documentation Project, like anything else in the LyX project, can
always use assistance! If you're interested in contributing to the Documentatio
n Project, you need to do the following assignment <font emph="on">first</font>:
</paragraph>
<paragraph layout="Enumerate">
Get the latest LyX source code.
Untar it.<Foot>
<text>
<paragraph layout="Standard">
The more adventurous can grab the latest documentation anonymously from
the LyX CVS repository - it is contained in the <font family="typewriter">lyxdoc</font> module.
</paragraph>
</text>
</Foot>
You will find a directory inside the main tree called <font family="typewriter">lib/doc/</font>.
Inside that directory is a file called <font family="typewriter">DocStyle.lyx</font>.
Read it; it's the style sheet for the documentation.
</paragraph>
<paragraph layout="Enumerate">
Next, read the <font emph="on">User's Guide</font> and the <font emph="on">Tutorial</font>.
</paragraph>
<deeper>
<paragraph layout="Standard">
The point of this exercise is to give you ideas.
The <font emph="on">Tutorial</font> and <font emph="on">User's Guide</font> is likely to be the most up-to-date of all of the documentation.
You should be able to glean some insights into how we want the manuals
to read and to look.
</paragraph>
</deeper>
<paragraph layout="Enumerate">
Contact the team at:
</paragraph>
<deeper>
<paragraph layout="Standard">
<font family="typewriter">[EMAIL PROTECTED]</font>
</paragraph>
<paragraph layout="Standard">
to discuss your intended changes, and get some feedback on them.
</paragraph>
</deeper>
<paragraph layout="Standard">
The changes you wish to make may range from improving clarity of the text,
to doing major re-structuring of the documentation.
Any and all improvements are gladly received.
</paragraph>
</body>
</lyxdocument>
--
Lgb
