The LYX Tutorial
The LYX Tutorial
1 If
you have comments or error corrections, please send them to the LYX Doc-
umentation mailing list, [email protected].
2
Contents
1 Introduction 1
1.1 Welcome to LYX! . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2 What the Tutorial is and what it is not . . . . . . . . . . . . . 1
1.2.1 Getting the most out of the Tutorial . . . . . . . . . . 2
1.2.2 What you will not find . . . . . . . . . . . . . . . . . . 2
3 Writing Documents 11
3.1 Document Classes . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.2 Templates: Writing a Letter . . . . . . . . . . . . . . . . . . . 12
3.3 Document Titles . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.4 Labels and Cross-References . . . . . . . . . . . . . . . . . . . 14
3.4.1 Your first label . . . . . . . . . . . . . . . . . . . . . . 14
3.4.2 Your first cross-reference . . . . . . . . . . . . . . . . . 14
3.4.3 More fun with labels . . . . . . . . . . . . . . . . . . . 15
3.5 Footnotes and Margin Notes . . . . . . . . . . . . . . . . . . . 16
3.6 Bibliographies . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.7 Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . 18
i
ii CONTENTS
4 Using Math 19
4.1 Math Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.2 Navigating an Equation . . . . . . . . . . . . . . . . . . . . . 20
4.3 Exponents and Indices . . . . . . . . . . . . . . . . . . . . . . 21
4.4 The Math toolbar . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.4.1 Greek and symbols . . . . . . . . . . . . . . . . . . . . 21
4.4.2 Square roots, accents, and delimiters . . . . . . . . . . 22
4.4.3 Fractions . . . . . . . . . . . . . . . . . . . . . . . . . . 22
4.4.4 Functions: lim, log, sin and others . . . . . . . . . . . . 23
4.4.5 Matrices . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.4.6 Display mode . . . . . . . . . . . . . . . . . . . . . . . 24
4.5 More Math Stuff . . . . . . . . . . . . . . . . . . . . . . . . . 25
5 Miscellaneous 27
5.1 Other major LYX Features . . . . . . . . . . . . . . . . . . . . 27
5.2 LYX for LATEX Users . . . . . . . . . . . . . . . . . . . . . . . 28
5.2.1 TEX Mode . . . . . . . . . . . . . . . . . . . . . . . . 28
5.2.2 Importing LATEX Documents — tex2lyx . . . . . . . . 29
5.2.3 Converting LYX Documents to LATEX . . . . . . . . . . 30
5.2.4 LATEX Preamble . . . . . . . . . . . . . . . . . . . . . . 30
5.2.5 BibTEX . . . . . . . . . . . . . . . . . . . . . . . . . . 30
5.3 Errors! . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Chapter 1
Introduction
1
2 CHAPTER 1. INTRODUCTION
3
4 CHAPTER 2. GETTING STARTED WITH LYX
• Run LATEX to create a DVI file, with View . DVI or the toolbar button
. LYX will open a DVI-viewer program displaying your document as
it will look when printed.3
• Export the ready to print document with File . Export to a format you
want.
Congratulations! You have written your first LYX document. All of the rest
is just details, which are covered in the other manuals.
Undo LYX has multiple levels of undo, which means you can undo every-
thing you have done since your current editing session started, by se-
lecting Edit . Undo (toolbar button ) over and over again. If you
undo too much, just select Edit . Redo (toolbar button ) to get it
back.
Currently, undo is limited to 100 steps.
blank line. As many times as you hit Space, you will only get one space. On
a blank line, LYX will not let you type even one space. The Tab key will not
move you forward one tab stop; in fact there are no tab stops! There is no
ruler at the top of the page to let you set tabs or margins, either.
Many word processors are based on the WYSIWYG principle: “What You
See Is What You Get.” LYX, on the other hand, is based on the principle
that “What You See Is What You Mean.” You type what you mean, and
LYX will take care of typesetting it for you, so that the output looks nice.
A Return grammatically separates paragraphs, and a Space grammatically
separates words, so there is no reason to have several of them in a row; a
Tab has no grammatical function at all, so LYX does not support it. Using
LYX, you will spend more of your time worrying about the content of your
document, and less time worrying about the format. See the Introduction
for more information on the WYSIWYM concept.
LYX does have (many) ways to fine-tune the formatting of your document.
After all, LYX might not typeset exactly what you mean. The User’s Guide
has information about all that. It includes horizontal fills and vertical space
— which are more powerful and versatile than multiple spaces or blank lines
— and ways to change font sizes, character styles, and paragraph alignments
by hand. The idea, though, is that you can write your whole document,
focusing on content, and just worry about that fine-tuning at the end. With
standard word processors, you will be distracted by document formatting
throughout the writing process.
2.2 Environments
Different parts of a document have different purposes; we call these parts
environments. Most of a document is made up of regular text. Section titles
(chapter, subsection, etc.) let the reader know that a new topic or subtopic
will be discussed. Certain types of documents have special environments. A
journal article will have an abstract and a title. A letter will have neither of
these, but will probably have an environment that gives the writer’s address.
Environments are a major part of the “What You See Is What You Mean”
philosophy of LYX. A given environment may require a certain font style, font
size, indenting, line spacing, and more. This problem is aggravated, because
the exact formatting for a given environment may change: one journal may
use boldface, 18 point, centered type for section titles while another uses
2.2. ENVIRONMENTS 7
italicized, 15 point, left justified type; different languages may have different
standards for indenting; and bibliography formats can vary widely. LYX lets
you avoid learning all the different formatting styles.
The Environment choice box is located on the left end of the toolbar and
looks like this: . It indicates in which environment you
are currently writing. While you were writing your first document, it said
“Standard,” which is the default environment for text. Now you will put a
number of environments in your new document so that you can see how they
work.
Hit Return again, and select Section from the Environment box again. LYX
writes a “2” and waits for you to type a title. Type “More Stuff”, and you
will see that LYX again sets it as a section title.
It gets better. Go to the end of Section 1 again (after “my first LYX
document”) and hit Return again, and select Section from the Environment
box again. Again, LYX writes “2” and waits for you to type a title. Type
About This Document. Section “More Stuff”, which was Section 2, has been
automatically renumbered to Section 3! In true WYSIWYM fashion, you just
need to identify the text that makes up the section titles, and LYX takes care
of numbering the sections and typesetting them.
Hit Return to get back to the Standard environment, and type the following
five lines:
5
You do not have to select the line. If nothing is selected, LYX changes the paragraph
you are currently in to the selected environment. Alternatively, you can change several
paragraphs to a different environment by selecting them before picking an environment.
8 CHAPTER 2. GETTING STARTED WITH LYX
Click on the second line and select Subsection from the Environment box.
LYX numbers the subsection “2.1”, and typesets it in a font which is big-
ger than regular text but smaller than the section title. Change the fourth
line Subsection environment as well. As you probably expected, LYX auto-
matically numbered the section “2.2”. If you put yet another section before
Section 2, Section 2 will be renumbered as Section 3, and the subsections
will be renumbered to “3.1” and “3.2”.
Further levels of sectioning include Subsubsection, Paragraph, and Sub-
paragraph. We will let you play with these on your own. You may notice
that paragraph and subparagraph headings are not numbered by default,
and that subparagraphs are indented; see the User’s Guide for an explana-
tion and how to change this. Chapter headings are actually the highest level
of sectioning, above Sections, but you are only allowed to use them in certain
types (text classes) of LYX documents (see Section 3.1).
Finally, you may want to have sections or subsections that are not num-
bered. There are environments for this as well. If you change one of your
section headings to the Section* environment (you may have to scroll down
in the Environment box to find it), LYX will use the same font size for the
heading as it uses for a regular section, but it will not number that section.
There are corresponding “starred” heading environments for Subsection and
Subsubsection. Try changing some of your sections or subsections to the
starred environments, and note how the other section numbers are updated.
Exercise: Fix the section and subsection headings in example_raw.lyx.
Let us write a list of reasons why LYX is better than other word processors.
Somewhere in your document, type:
LYX is better than other word processors because:
and hit Return. Now select Itemize from the Environment box. LYX writes
a “bullet” on the line. Type in your reasons:
List environments, unlike headings, do not end when you type Return. In-
stead, LYX assumes you are going on to the next item in the list. The above
will therefore result in a three-item list. If you want more than one paragraph
within one list item, one way is to use the Protected Break, which you get by
typing Ctrl+Return. In order to get out of the list, you need to reselect the
Standard environment (or just use the key binding, Alt+P S).
You have got a beautiful itemized list. You might want to run LATEX to
see how the list looks when printed out. But what if you wanted to number
the reasons? Well, just select the whole list6 and choose Enumerate from the
Environment box. Pow! As we mentioned, if you add or delete a list item,
LYX will fix the numbering.
While the list is still selected, you can change to the other two list en-
vironments, Description and List, in order to see what they look like. For
6
LYX will not let you select the first bullet unless you also select the paragraph before
the list, which you probably do not want to do. Similarly, you cannot select the actual
number in a numbered section title. This is on purpose because the bullet or number
depends on the document settings or text position, respectively.
10 CHAPTER 2. GETTING STARTED WITH LYX
those two environments, each list item is made up of a term, which is the
item’s first word, followed by a definition, which is the rest of the paragraph
(until you hit Return.) The term is either typeset in boldface (Description)
or separated by a “Tab”7 (List) from the rest of the paragraph. If you want
to have more than one word in the definition, then separate the words with
Protected Spaces.
Exercise: Typeset the list in example_raw.lyx
You can nest lists within each other in all sorts of interesting ways. An
obvious example would be writing outlines. Numbered and bulleted lists will
have different numbering and bulleting schemes for sublists. See the User’s
Guide for details on the different sorts of lists and for examples of nestings.
7
But a typesetter’s tab, which will change to fit the size of the largest term, not a
pathetic, rigid, unchangeable typewriter Tab.
8
used in this Tutorial for the long typing examples
Chapter 3
Writing Documents
The previous chapter hopefully allowed you to get used to writing in LYX. It
introduced you to the basic editing operations in LYX, as well as the powerful
method of writing with environments. Most people who use LYX, though,
will want to write documents: papers, articles, books, manuals, or letters.
This chapter is meant to take you from simply writing text with LYX to
writing a complete document. It will introduce you to text classes, which
allow you to write different sorts of documents. It will then describe many of
the additions that turn text into a document, such as titles, footnotes, cross
references, bibliographies, and tables of contents.
11
12 CHAPTER 3. WRITING DOCUMENTS
Try changing to other document classes (using the Document . Settings dia-
log) to see how they are typeset differently. If you change your document to
the Book document class and look at the Environment box, you will see that
most of the allowed environments are the same. However, you can now use
the Chapter environment. If you are ever unsure about which environments
you can use in a given document class, just consult the Environment box.
Font sizes, one- or two-column printing, and page headings are just some
of the ways journals typesettings differ from one another. As the Computer
Age continues to mature, journals have begun accepting electronic submis-
sions, creating LATEX “style files” so that authors can submit correctly typeset
articles. LYX is set up to support this as well. For example, LYX supports
typesetting (and extra environments) for the American Mathematics Society
journals using the Article (AMS) document class.
Here is a very quick reference to some of the document classes. See the
Special Document Classes section of the Additional Features manual for many
more details.
Name Notes
article one-sided, no chapters
article (AMS) layout & environments for American Math Society
report longer than article, two-sided
book report + front and back matter
presentation transparencies
letter lots of extra environments for address, signature. . .
When you look at the Environment box, you will see several environments,
like the My Address environment, which do not even exist in most other
document classes. Others, like Quote and Description, are familiar. You can
play around for a while to figure out how the various environments work.
You will notice for example that the Signature environment has the word
“Signature:“ in red before the actual text of the signature. This word does
not show up in the actual letter, as you will see if you view/export the file.
It is just there to let you know where the signature goes. Also, note that
it does not matter where in the file the Signature line is placed. Remember,
LYX is WYSIWYM; you can put the Signature environment anywhere you
want, but LYX knows that in the printout, the signature should be at the
end.
A template is just a regular LYX file. This means you can fill in your
address and signature and save the file as a new template. From now on, any
time you want to write a letter, you can use the new template to save time.
We do not have to suggest an actual “exercise” here; just write a letter to
someone!3
Templates can be a huge time-saver, and we urge you to use them when-
ever possible. In addition, they can help a person learn how to use some of
the fancier document classes. Finally, they may be useful for a person who
is configuring LYX for a bunch of less computer-aware users. When they
are first learning LYX, it will be much less intimidating if they have a letter
template customized for their company, for example.
environment. On the next line, type your name and change it to the Author
environment. On the next line, write the date in the Date environment.
Type a paragraph or two summarizing your document using the Abstract
environment. Notice how the title is presented when it is printed out. If you
change the document format to Book, you will get a separate title page, like
the first page of this tutorial.
Exercise: Fix the title, date, and author in example_raw.lyx
allow titles.
5
Floats are explained in the User’s Guide and the Embedded Objects manual.
3.4. LABELS AND CROSS-REFERENCES 15
Now — with the cursor after the word ‘Section’ — choose Insert . Cross Ref-
erence or the toolbar button . The Cross-reference dialog pops up. It
shows a list of the possible labels you can reference. At the moment, there
should be only one, ‘sec:About-This-Document’. First, select the drop-down
menu labeled Format and select ’<reference> on page <page>.’ Then select
‘sec:About-This-Document’ (it may be selected by default), and a reference
marker will appear containing ‘Ref+Text: sec:About-This-Document’ (To be
really correct, you should put a Protected Space in between the word ‘Sec-
tion’ and the reference). Alternatively to that method, you can right-click
on a label and use in the appearing context menu Copy as Reference. The
cross-reference to this label is now in the clipboard and can be copied to
the actual cursor position via the menu Edit . Paste (shortcut Ctrl+V). In the
printed document, this reference marker will be replaced with the section
number and then the page number. View your document as DVI, and you
will see that LATEX has been even cleverer than that. It refers to ‘Section 2’
and depending how much text you have between the start of Section 2 and
this cross-reference you may see ‘on this page,’ ’on the previous page’ or ‘on
page n’ (whereas n is the page number).
Conveniently, a cross-reference acts as a hyperlink when you are editing
a document in LYX; clicking on it will pop up the Cross-reference dialog,
clicking Go to Label will move the cursor to the referenced label.
If you want to make sure that the cross-referencing gets the pages right
even for larger documents, Copy a couple pages of text from the User’s Guide
to the clipboard, and Paste the stolen text into your document.6
Exercise: Fix the references in example_raw.lyx
Now click on the button labeled “foot”. The footnote box is closed, leaving
the button showing where the footnote marker will be in the printed text;
this is called “folding” the footnote. You can unfold the footnote at any time
and re-edit its text by clicking again on the “foot” button.
A footnote can be cut and pasted like normal text. Go ahead; try it!
All you need to do is select the footnote button7 and Cut and Paste it. In
addition, you can change regular text to a footnote, by selecting it and hitting
the button; change a footnote to regular text by hitting the Backspace key
when the cursor is in the first position of a footnote, or by hitting the Delete
key when the cursor is in the very last position of the footnote, respectively.
Margin notes can be added using the menu Insert . Marginal Note or the
toolbar button . Margin notes are like footnotes, except that:
• the notes will be placed in the margin, instead of below the text
Change your LYX footnote back to text, then select and change it to a margin
note. Run LATEX again to see what the margin note looks like.
Exercise: Fix the footnote in example_raw.lyx
3.6 Bibliographies
Bibliographies (at least in the exact sciences) are similar to cross references.
The bibliography contains a list of references at the end of the document, and
they can be referenced from within the document. Like section titles, LYX
and LATEX make your job easier by automatically numbering the bibliography
items and changing citations when the item numbers change.
Go to the end of the document and switch to the Bibliography environ-
ment. Now, each paragraph you type will be a reference. Type “The Lyx
Tutorial, by the LYX Documentation Team” as your first reference. Note
that LYX automatically puts a number in a box before each reference. Click
on the boxed reference number, and the Bibliography item dialog box appears.
The Key is to refer to this reference within the LYX document, the Label ap-
pears in output. When no Label is set (default), you will see the number of
the bibliography in the output. Change now the Key field to “lyxtutorial” to
make it easy to remember.
Now pick somewhere in your document that you would like to insert a
reference. Do so with Insert . Citation or the toolbar button . A Citation
dialog appears. The right panel in this dialog lists all the bibliography entries,
and this field allows you to choose which bibliography item you want to cite.
Select “lyxtutorial” (right now, that is the only item in the bibliography),
then use the Add button in the center to insert it. (You can have multiple
citations in the same place by transferring a number of keys this way.) Now
view your file as DVI, and you will see that the citation appears in brackets
in the text, referring to the bibliography at the end of the document.
The Text after field in the Citation dialog will put a remark (such as a
reference to a page or chapter within the referenced book or article) in the
brackets after the reference. If you want the references to have labels instead
of numbers in the printed output (for example, some journals would use
“[Smi95]” to refer to a paper written by Smith in 1995), use the Label field
in the Bibliography item dialog. As usual, see the User’s Guide for details.
Exercise: Fix the bibliography and citation in example_raw.lyx
18 CHAPTER 3. WRITING DOCUMENTS
Using Math
Now, that equation does not look very good in LYX and in the output; there is
no space between the letters and the equals sign, and you would like to write
an actual superscript for the “2”. That bad typesetting happened because
we did not tell LYX that we were writing a mathematical expression, so it
typeset the equation like regular old text.
Instead, we create a formula that will get typeset properly. In order to
create a formula, just click the toolbar button or use the menu Insert .
Math . Inline Formula. LYX will insert a little blue square, which is an empty
19
20 CHAPTER 4. USING MATH
math formula. Now just type E=mc^2 again. The expression is typed in blue,
and the blue square disappears as soon as the formula is not empty. Now
type Esc to leave the equation The purple markers disappear, leaving the
cursor to the right of the expression, and now if you type something, it will
be regular text.
Looking at the output you will notice that the expression was typeset
nicely, with spaces between the letters and the equals sign, and a superscript
“2”. Letters in math mode are assumed to be variables, and come out in
italics. Numbers are just numbers.
This math editor is another example of the WYSIWYM philosophy. In
L TEX, you write a mathematical expression using text and commands like
A
\sqrt; this can be frustrating, because you cannot see what an expression
looks like until you run the file under LATEX and you may have to spend time
finding e. g. missing brackets. LYX does not attempt to get the expression
to look perfect (WYSIWYG), but it gives you an extremely good idea of
what the expression will look like. LATEX then takes care of the professional
typesetting.
4.4.3 Fractions
To create a fraction, click on the fraction button in the Math Toolbar. LYX
writes two insertion points in a fraction. As you would expect, you can use
arrow keys or the mouse to move around a fraction. Click on the top square
and type “1”. Now hit Down and type “2”. You have made a fraction! Of
4.4. THE MATH TOOLBAR 23
course you can type anything within each of the two boxes: variables with
exponents, square roots, other fractions, whatever.
Exercise: Put equation 2 of example_raw.lyx into math mode.
4.4.5 Matrices
Click on the matrix button in the Math Toolbar. The appearing dialog
allows you to choose how many rows and columns you want in your matrix.
Choose 2 rows and 3 columns and hit OK. LYX prints 6 insertion points in a
2 × 3 matrix. As usual, you can put any sort of formula expression (a square
root, another matrix, etc.) in each insertion point. You can also leave some
of the insertion points empty if you want.
Tab can be used to move horizontally between the columns of a matrix.
Alternatively, you can use the arrow keys to move around - hitting Right at
the end of one box will move to the next box, Down will move to the next
row, etc.
24 CHAPTER 4. USING MATH
If you need to change the number of rows and columns, use the menu
Edit . Rows & Columns or the math toolbar buttons , , , .
See the User’s Guide for information on how to change the horizontal
alignment of each column, and how to change the vertical position of the
whole matrix. Note that if you want to write a table containing text, you
should use LYX’s wonderful table support, rather than trying to write text
in a matrix.
• Subscripts and superscripts for limits and sums (but not integrals) are
written under and over rather than next to the symbols
• Text is centered
Other than these differences, though, displayed expressions and inline ex-
pressions are very similar.
One final note about the way displayed formulas are typeset: Be careful
about whether you are putting your equation into a new paragraph or not.
If your formula is in the middle of a sentence or paragraph, then do not
press Return. Doing so will cause the text after the formula to start a new
paragraph. That text will be indented or follow a blank line, depending on
your document paragraph settings, which is probably not what you want.
4.5. MORE MATH STUFF 25
• Fine-tune font sizes and spacing within an expression. (Do not worry
about this until your final draft!)
• Write macros. These are very powerful, because you just define them
once at the top of the document, and then you can use them throughout
the document.
1
After you have done it the hard way, give Insert . Math . Cases Environment a try.
26 CHAPTER 4. USING MATH
Chapter 5
Miscellaneous
• LYX has WYSIWYM support for tables. Use the Insert . Table (toolbar
button ) to get a table. Click on the table with the right button to
get a Table Settings dialog box which allows extensive table editing.
27
28 CHAPTER 5. MISCELLANEOUS
• The LYX menus feature keybindings. This means that you can do File .
Open by pressing Alt+F followed by O or by using the binding which is
shown next to it in the menu (Ctrl+O by default). Keybindings are also
configurable. For information on this, check out Help . Customization.
options.
It is important to understand that tex2lyx can only translate files whose
document class is “known” to LYX, that is, for which there is a corresponding
LYX layout file. If there is no layout file, then you will get an error saying
that the conversion could not be performed. So, unless you have a layout for
the document class of your LATEX file, tex2lyx simply will not know how to
translate the LATEX that it finds there into things LYX understands. More
about layout files and how they are created is explained in detail in Chapter
5 of the Customization manual.
5.2.5 BibTEX
LYX has support for BibTEX, which allows you to build databases of bib-
liographical references to be used in multiple documents. Select Insert .
5.3. ERRORS! 31
5.3 Errors!
Sometimes when you try to view a document, there will be errors, things
that LYX or LATEX cannot understand. When this happens, LYX will open a
LATEX Errors dialog. Clicking on individual errors in this dialog will take you
to the place in the LYX document where the error occurs and also display
the detailed LATEX error message.