]> git.lyx.org Git - lyx.git/blob - lib/doc/Intro.lyx
Spanish updates from Ignacio
[lyx.git] / lib / doc / Intro.lyx
1 #LyX 1.5.0svn created this file. For more info see http://www.lyx.org/
2 \lyxformat 256
3 \begin_document
4 \begin_header
5 \textclass article
6 \begin_preamble
7 % DO NOT ALTER THIS PREAMBLE!!!
8 %
9 %This preamble is designed to ensure that the document prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the document may not print out as expected.  If you
12 % have problems LaTeXing this file, please contact 
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
15
16 % provides missing characters,
17 \usepackage{textcomp}
18
19 \usepackage{ifpdf} % part of the hyperref bundle
20 \ifpdf % if pdflatex is used
21
22  % set fonts for nicer pdf view
23  \IfFileExists{lmodern.sty}{\usepackage{lmodern}}
24   {\usepackage[scaled=0.92]{helvet}
25     \usepackage{mathptmx}
26     \usepackage{courier} }
27
28  % the pages of the TOC are numbered roman
29  % and a pdf-bookmark for the TOC is added
30  \pagenumbering{roman}
31  \let\myTOC\tableofcontents
32  \renewcommand\tableofcontents{%
33    \pdfbookmark[1]{Contents}{}
34    \myTOC
35    \clearpage
36    \pagenumbering{arabic} }
37
38  % link all cross references and URLs in pdf output
39  \usepackage[colorlinks=true, bookmarks, bookmarksnumbered,
40   linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,
41   pdfpagelayout=OneColumn, pdfnewwindow=true,
42   pdfstartview=XYZ, plainpages=false, pdfpagelabels,
43   pdfauthor={LyX Team}, pdftex,
44   pdftitle={The LyX User's Guide},pdfsubject={LyX-documentation Intro},
45   pdfkeywords={LyX}]{hyperref}
46  
47 \else % if dvi or ps is produced
48
49  % link all cross references and URLs in dvi output
50  \usepackage[ps2pdf]{hyperref}
51
52  % the pages of the TOC are numbered roman
53  \pagenumbering{roman}
54  \let\myTOC\tableofcontents
55  \renewcommand\tableofcontents{%
56    \pdfbookmark[1]{Contents}{}
57    \myTOC
58    \clearpage
59    \pagenumbering{arabic} }
60    
61 \fi
62 \end_preamble
63 \language english
64 \inputencoding auto
65 \font_roman default
66 \font_sans default
67 \font_typewriter default
68 \font_default_family default
69 \font_sc false
70 \font_osf false
71 \font_sf_scale 100
72 \font_tt_scale 100
73 \graphics default
74 \paperfontsize 12
75 \spacing single
76 \papersize a4paper
77 \use_geometry false
78 \use_amsmath 1
79 \use_esint 0
80 \cite_engine basic
81 \use_bibtopic false
82 \paperorientation portrait
83 \secnumdepth 3
84 \tocdepth 2
85 \paragraph_separation indent
86 \defskip medskip
87 \quotes_language english
88 \papercolumns 1
89 \papersides 1
90 \paperpagestyle default
91 \tracking_changes false
92 \output_changes true
93 \author "usti" 
94 \end_header
95
96 \begin_body
97
98 \begin_layout Title
99 Introduction to LyX
100 \end_layout
101
102 \begin_layout Author
103 by the LyX Team
104 \begin_inset Foot
105 status collapsed
106
107 \begin_layout Standard
108 \noindent
109 If you have comments or error corrections, please send them to the LyX Documenta
110 tion mailing list: 
111 \family typewriter
112 lyx-docs@lists.lyx.org
113 \end_layout
114
115 \end_inset
116
117
118 \end_layout
119
120 \begin_layout Standard
121 \begin_inset LatexCommand tableofcontents
122
123 \end_inset
124
125
126 \end_layout
127
128 \begin_layout Section
129 The Philosophy of LyX
130 \end_layout
131
132 \begin_layout Subsection
133 What is LyX?
134 \end_layout
135
136 \begin_layout Standard
137 LyX is a document preparation system.
138  It excels at letting you create complex technical and scientific articles
139  with mathematics, cross-references, bibliographies, indices, etc.
140  It is very good at documents of any length in which the usual processing
141  abilities are required: automatic sectioning and pagination, spellchecking,
142  and so forth.
143  It can also be used to write a letter to your mom, though granted, there
144  are probably simpler programs available for that.
145  It is definitely not the best tool for creating banners, flyers, or advertiseme
146 nts (we'll explain why later), though with some effort all these can be
147  done, too.
148  Some examples of what it is used for: memos, letters, dissertations and
149  theses, lecture notes, seminar notebooks, conference proceedings, software
150  documentation, books, articles in refereed scientific journals, scripts
151  for plays and movies, business proposals, presentations \SpecialChar \ldots{}
152
153 \end_layout
154
155 \begin_layout Standard
156 LyX is a program that provides a modern approach to writing documents with
157  a computer by using a markup language paradigm, an approach that breaks
158  with the obsolete tradition of the 
159 \begin_inset Quotes eld
160 \end_inset
161
162 typewriter concept
163 \begin_inset Quotes erd
164 \end_inset
165
166 .
167  It is designed for authors who want professional output quickly with a
168  minimum of effort without becoming specialists in typesetting.
169  The job of typesetting is done mostly by the computer, not the author;
170  with LyX, the author can concentrate on the contents of her writing.
171 \end_layout
172
173 \begin_layout Standard
174 Part of the initial challenge of using LyX comes from the change in thinking
175  that you, the user, must make.
176  At one time, all we had for creating documents were typewriters, so we
177  all learned certain tricks to get around their limitations.
178  Underlining, which is little more than overstriking with the 
179 \begin_inset Quotes eld
180 \end_inset
181
182 _
183 \begin_inset Quotes erd
184 \end_inset
185
186  character, became a way to emphasize text.
187  You were forced to figure out column sizes and tab stops, and set them,
188  before creating a table.
189  The same applied for letters and other right justified text.
190  Hyphenation at the end of a line required a careful eye and a lot of foresight.
191 \end_layout
192
193 \begin_layout Standard
194 In other words, we've all been trained to worry about the little details
195  of which character goes where.
196  Consequently, almost all word processors have this mentality.
197  They still use tab stops for adding whitespace.
198  You still need to worry about exactly where on the page something will
199  appear.
200  Emphasizing text means changing a font, similar to changing the typewriter
201  wheel.
202  This is the underlying philosophy of a WYSIWYG word processor: 
203 \begin_inset Quotes eld
204 \end_inset
205
206 What You See Is What You Get
207 \begin_inset Quotes erd
208 \end_inset
209
210 .
211  Unfortunately, that paradigm often results in 
212 \begin_inset Quotes eld
213 \end_inset
214
215 What You See Is All You Get
216 \begin_inset Quotes erd
217 \end_inset
218
219 .
220 \end_layout
221
222 \begin_layout Standard
223 This is where LyX differs from an ordinary word processor.
224  You don't concern yourself with what character goes where.
225  You tell LyX 
226 \emph on
227 what you're doing
228 \emph default
229  and LyX takes care of the rest, following a set of rules called a 
230 \emph on
231 style.
232 \emph default
233
234 \begin_inset Foot
235 status collapsed
236
237 \begin_layout Standard
238 To be fair, most recent versions of the most popular office suites now have
239  some sort of style sheets which follow a similar markup method.
240  However, our experience is that they are still rarely used in practice.
241 \end_layout
242
243 \end_inset
244
245  Let's look at a little example:
246 \end_layout
247
248 \begin_layout Standard
249 Suppose you are writing a report.
250  To begin your report, you want a section called 
251 \begin_inset Quotes eld
252 \end_inset
253
254 Introduction\SpecialChar \@.
255
256 \begin_inset Quotes erd
257 \end_inset
258
259  So, you go into whatever menu it is in your word processor that changes
260  font sizes and decide on a new font size.
261  Then you turn on bold face.
262  Then you type, 
263 \begin_inset Quotes eld
264 \end_inset
265
266 1.\InsetSpace ~
267 \InsetSpace ~
268 Introduction
269 \begin_inset Quotes erd
270 \end_inset
271
272 .
273  Of course, if you later decide that this section belongs someplace else
274  in the document, or if you insert a new section before it, you need to
275  change the numbering for this and all following sections, as well as any
276  entry in the table of contents.
277  
278 \end_layout
279
280 \begin_layout Standard
281 In LyX, you go to the pull-down on the far left of the button bar and select
282  
283 \family sans
284 Section
285 \family default
286 , and type 
287 \begin_inset Quotes eld
288 \end_inset
289
290 Introduction\SpecialChar \@.
291
292 \begin_inset Quotes erd
293 \end_inset
294
295
296 \end_layout
297
298 \begin_layout Standard
299 Yes, that's all.
300  If you cut and paste the section, it will automatically be renumbered ---
301  everywhere.
302  And if you enter references to that section correctly (by inserting cross-refer
303 ence tags), LyX will automatically update them all throughout the file so
304  that you never, ever type a section number.
305 \end_layout
306
307 \begin_layout Standard
308 Now let's look at the problem of consistency.
309  Five days later, you reopen your report and start Section\InsetSpace ~
310 4.
311  However, you forget that you were using 18pt bold instead of 16pt, so you
312  type in the heading for Section\InsetSpace ~
313 4 in a different font that what you used
314  for Section\InsetSpace ~
315 1.
316  That problem doesn't even exist in LyX.
317  The computer takes care of all that silly bookkeeping about which thing
318  has what size font, not you.
319  After all, that's what a computer is good at.
320 \end_layout
321
322 \begin_layout Standard
323 Here's another example.
324  Suppose you're making a list.
325  In other word processors, a list is just a bunch of tab stops and newlines.
326  You need to figure out where to put the label for each list item, what
327  that label should be, how many blank lines to put between each item, and
328  so on.
329  Under LyX, you have only two concerns: what kind of list is this, and what
330  do I want to put in it.
331  That's it.
332 \end_layout
333
334 \begin_layout Standard
335 So, the basic idea behind LyX is: specify 
336 \emph on
337 what
338 \emph default
339  you're doing, not 
340 \emph on
341 how
342 \emph default
343  to do it.
344  Instead of 
345 \begin_inset Quotes eld
346 \end_inset
347
348 What You See Is What You Get,
349 \begin_inset Quotes erd
350 \end_inset
351
352  the LyX model is 
353 \begin_inset Quotes eld
354 \end_inset
355
356 What You See Is What You 
357 \emph on
358 Mean
359 \emph default
360
361 \begin_inset Quotes erd
362 \end_inset
363
364  or 
365 \begin_inset Quotes eld
366 \end_inset
367
368 WYSIWYM.
369 \begin_inset Quotes erd
370 \end_inset
371
372  It's a powerful idea that greatly simplifies the mechanics of writing documents.
373  This is also why LyX isn't so good for creating posters and flyers---in
374  this case, you 
375 \emph on
376 do
377 \emph default
378  want to specify exactly where everything goes, because there are no functional
379  units like paragraphs, sections, etc.
380  This doesn't mean LyX is missing some cool function.
381  It simply means that it isn't the right tool for the job --- you don't
382  use a screwdriver to drive in nails.
383 \end_layout
384
385 \begin_layout Subsection
386 Differences between LyX and Other Word Processors
387 \begin_inset OptArg
388 status collapsed
389
390 \begin_layout Standard
391 \begin_inset ERT
392 status collapsed
393
394 \begin_layout Standard
395
396
397 \backslash
398 texorpdfstring{
399 \end_layout
400
401 \end_inset
402
403 LyX
404 \begin_inset ERT
405 status collapsed
406
407 \begin_layout Standard
408
409 }{LyX}
410 \end_layout
411
412 \end_inset
413
414  and Other Word Processors
415 \end_layout
416
417 \end_inset
418
419
420 \end_layout
421
422 \begin_layout Standard
423 Here's a list of things you won't find in LyX:
424 \end_layout
425
426 \begin_layout Itemize
427 The document ruler
428 \end_layout
429
430 \begin_layout Itemize
431 Tab stops
432 \end_layout
433
434 \begin_layout Itemize
435 Extra whitespace (i.e.
436  hitting 
437 \family sans
438 Enter
439 \family default
440  or 
441 \family sans
442 Space
443 \family default
444  two or more times)
445 \end_layout
446
447 \begin_layout Standard
448 Tab stops, along with a ruler showing you the position of things on the
449  page, are useless in LyX.
450  The program worries about where things go on the page, not you.
451  Extra whitespace is similar; LyX adds them where necessary, depending on
452  context.
453  Not being able to type two blank lines in a row will be annoying at first,
454  but it makes more sense once you're thinking in WYSIWYM terms.
455 \end_layout
456
457 \begin_layout Standard
458 Here are some things that exist in LyX, but aren't used as you might think:
459 \end_layout
460
461 \begin_layout Itemize
462 Indenting controls
463 \end_layout
464
465 \begin_layout Itemize
466 Page breaks
467 \end_layout
468
469 \begin_layout Itemize
470 Line spacing (i.e.
471  single spaced, double spaced, etc.)
472 \end_layout
473
474 \begin_layout Itemize
475 Whitespace, horizontal and vertical
476 \end_layout
477
478 \begin_layout Itemize
479 Fonts and font sizes
480 \end_layout
481
482 \begin_layout Itemize
483 Typefaces (bold, italic, underline, etc.)
484 \end_layout
485
486 \begin_layout Standard
487 Although they exist in LyX, you generally don't need them.
488  LyX will take care of these things for you, depending on what you're doing.
489  Different parts of the document are automatically set in a different typeface
490  and font size.
491  Paragraph indenting is context dependent; different types of paragraphs
492  get indented differently.
493  Page breaks get handled automatically, as well.
494  In general, the space between lines, between words, and between paragraphs
495  is variable, set by LyX.
496 \begin_inset Foot
497 status collapsed
498
499 \begin_layout Standard
500 There are ways to adjust all of these (only some of which require knowledge
501  of LaTeX), either for a whole document or for a specific location in a
502  document.
503  See the 
504 \emph on
505 User's Guide
506 \emph default
507  and/or the 
508 \emph on
509 Extended Features
510 \emph default
511  manual for details.
512 \end_layout
513
514 \end_inset
515
516  
517 \end_layout
518
519 \begin_layout Standard
520 Lastly, there are a few areas where we believe LyX (and LaTeX) surpasses
521  many word processors:
522 \end_layout
523
524 \begin_layout Itemize
525 Hyphenation
526 \end_layout
527
528 \begin_layout Itemize
529 Lists of any type
530 \end_layout
531
532 \begin_layout Itemize
533 Mathematics
534 \end_layout
535
536 \begin_layout Itemize
537 Tables
538 \end_layout
539
540 \begin_layout Itemize
541 Cross-referencing
542 \end_layout
543
544 \begin_layout Standard
545 Granted, many modern word processors can handle mathematical symbols, tables,
546  and hyphenation, and many have moved towards style definitions and the
547  WYSIWYM concept.
548  However, they've only recently been able to do so, whereas LyX is built
549  upon the LaTeX document preparation system.
550  LaTeX has been around for over 20 years, and 
551 \emph on
552 works
553 \emph default
554 .
555 \end_layout
556
557 \begin_layout Subsection
558 What is LaTeX?
559 \end_layout
560
561 \begin_layout Standard
562 LaTeX is a document preparation system designed by Leslie Lamport in 1985.
563 \begin_inset Foot
564 status collapsed
565
566 \begin_layout Standard
567 The source for the info in this section is 
568 \begin_inset Quotes eld
569 \end_inset
570
571
572 \emph on
573 A Guide to LaTeX2e
574 \emph default
575 ,
576 \begin_inset Quotes erd
577 \end_inset
578
579  by Helmut Kopka and Patrick Daly, which has an entry in the bibliography
580  of the 
581 \emph on
582 User's Guide
583 \emph default
584 \SpecialChar \@.
585
586 \end_layout
587
588 \end_inset
589
590  It was built up from a typesetting language called TeX, created by Donald
591  Knuth in 1984.
592  TeX takes a sequence of typesetting commands, written in a script in an
593  ASCII file, and executes them.
594  Many of the 
595 \begin_inset Quotes eld
596 \end_inset
597
598 tricks
599 \begin_inset Quotes erd
600 \end_inset
601
602  of the printing trade were modeled by Knuth as computer algorithms and
603  incorporated into TeX, thus its excellent printed appearance.
604  What comes directly out of TeX is the portable document format 
605 \emph on
606 pdf
607 \emph default
608  or the so-called 
609 \begin_inset Quotes eld
610 \end_inset
611
612 device independent
613 \begin_inset Quotes erd
614 \end_inset
615
616  format file 
617 \emph on
618 dvi
619 \emph default
620 .
621  The dvi format is often used for previews and can later be converted to
622  other formats like PostScript.
623  
624 \end_layout
625
626 \begin_layout Standard
627 TeX isn't only a typesetting engine, it also allows you to define macros.
628  Most people who use TeX are actually using a macro package which Knuth
629  created to hide a lot of the typesetting details.
630  This is where Leslie Lamport enters our story.
631  He wanted a macro package that was more user- and less typesetter-oriented,
632  with a set of commands that consistently typeset things like sections,
633  tables or math formulas in an uniform, consistent fashion.
634  This is how LaTeX was born.
635 \end_layout
636
637 \begin_layout Standard
638 Now, in parallel with the development and growth of LaTeX, other folks were
639  creating their own custom macro packages for TeX, ones to make slides or
640  articles for math journals and so on.
641  Some used the raw TeX facilities to do this, others began modifying LaTeX.
642  To try and unify this mess, a team of LaTeX-nicians began to work on LaTeX2e,
643  the current version of LaTeX, during the late 1980's.
644  This new version of LaTeX has commands which provide an easier-to-use interface
645  to TeX's macro-creating commands, aid in the use of new fonts, and so on.
646  In fact, LaTeX is quite an extensive language in its own right! Users around
647  the world have been creating their own add-ons for LaTeX beyond the standard
648  ones.
649 \end_layout
650
651 \begin_layout Standard
652 There are two ways to extend LaTeX: classes and styles.
653  A 
654 \emph on
655 class
656 \emph default
657  is a set of LaTeX macros describing a new type of document, like a book,
658  or an article.
659  There are classes for slides, for physics and math journals\SpecialChar \ldots{}
660  many universities
661  even have a class for their thesis format! A 
662 \emph on
663 style
664 \emph default
665  differs from a class in that it doesn't define a new type of document,
666  but a different type of 
667 \emph on
668 behavior
669 \emph default
670  that any document can use.
671  For example, LyX controls page margins and line spacing using two different
672  LaTeX style-files designed for these purposes.
673  There are style-files for a whole slew of things: printing labels or envelopes,
674  changing indentation behavior, adding new fonts, manipulating graphics,
675  designing fancy page headings, customizing bibliographies, altering the
676  location and appearance of footnotes, tables, and figures, customizing
677  lists, etc.
678 \end_layout
679
680 \begin_layout Standard
681 Here is a summary:
682 \end_layout
683
684 \begin_layout Description
685 TeX: Typesetting language with macro capability.
686 \end_layout
687
688 \begin_layout Description
689 LaTeX: Macro package built upon TeX\SpecialChar \@.
690
691 \end_layout
692
693 \begin_layout Description
694 classes: Descriptions of a type of document, using LaTeX\SpecialChar \@.
695
696 \end_layout
697
698 \begin_layout Description
699 styles: Alters the default behavior of LaTeX in some way.
700 \end_layout
701
702 \begin_layout Description
703 LyX: Visual, WYSIWYM word-processor that uses LaTeX to do its printing.
704 \end_layout
705
706 \begin_layout Standard
707 LaTeX is the reason why LyX differs from other word processors.
708  LyX is a graphical user interface (GUI) frontend for LaTeX.
709  It is designed to typeset documents with by using LaTeX without knowing
710  its macro commands.
711  But although LyX can't never support all commands graphically, it offers
712  its usage, so that LyX is as functional as LaTeX.
713 \end_layout
714
715 \begin_layout Standard
716 Just like LaTeX, LyX focuses on the context of your writing --- 
717 \emph on
718 what
719 \emph default
720  you are typing.
721  The computer then handles how it should look.
722 \end_layout
723
724 \begin_layout Section
725 Navigating the Documentation
726 \end_layout
727
728 \begin_layout Standard
729 To make it easier to answer your questions and describe all of the features
730  of LyX, the documentation has been split up into several different files.
731  Each one has its own purpose, as described below.
732  Before you go plowing into any of those files, however, you should read
733  this chapter thoroughly first, since it contains a lot of useful information
734  and commentary that can save you some time.
735 \end_layout
736
737 \begin_layout Standard
738 The developing of LyX will hopefully never stop, so that some of the documentati
739 on may be incomplete or a bit out of date, though we try to keep up.
740  Like the rest of LyX, the manuals are the work of a group of volunteers
741  who have 
742 \begin_inset Quotes eld
743 \end_inset
744
745 Real Jobs
746 \begin_inset Quotes erd
747 \end_inset
748
749 , families, dishes to clean, kitty litter to dispose of, et cetera.
750  If you want to help out, be sure to read Section\InsetSpace ~
751
752 \begin_inset LatexCommand ref
753 reference "sec:Contrib"
754
755 \end_inset
756
757  in addition to the rest of this document.)
758 \end_layout
759
760 \begin_layout Standard
761 Also, please do us a favor -- if anything in these manuals confuses you,
762  is unclear, or wrong, don't hesitate to let us know! You can reach the
763  current document maintainers by mailing to 
764 \family typewriter
765 lyx-docs@lists.lyx.org
766 \family default
767 .
768  If you have questions which are not obviously answered in the documentation,
769  and need help fast, there is an active users' mailing list which you can
770  reach at 
771 \family typewriter
772 lyx-users@lists.lyx.org
773 \family default
774 .
775 \end_layout
776
777 \begin_layout Subsection
778 The Format of the Manuals
779 \end_layout
780
781 \begin_layout Standard
782 Some may have printed out the manuals.
783  Others may be reading it within LyX.
784  There are some differences between the LyX-file and the printed version.
785  First, the title is simply at the top of the document, not formatted on
786  a separate page as in some of the printed versions.
787  Nor are any of the footnotes or the Table of Contents fully visible.
788  To open a footnote, which looks like this: 
789 \begin_inset Graphics
790         filename ../clipart/footnoteQt4.png
791         scale 75
792
793 \end_inset
794
795 , click on it with the left mouse button.
796  For the Table of Contents, either click on the grey box or click on the
797  
798 \family sans
799 Navigate
800 \family default
801  menu, where the contents are displayed automatically\SpecialChar \@.
802
803 \end_layout
804
805 \begin_layout Standard
806 In the printed manuals, all cross-references appear as the actual numbers
807  for a chapter, section, subsection, and so on.
808  Online, however, all cross-references appear as a light-grey box like the
809  following: 
810 \begin_inset Graphics
811         filename ../clipart/referenceQt4.png
812         scale 75
813
814 \end_inset
815
816 .
817  If you click on that box with the left mouse button, a dialog box will
818  appear containing a list of all the cross-references in the document.
819  This introduction has only two, the first one is named 
820 \begin_inset Quotes eld
821 \end_inset
822
823 sec:Contrib
824 \begin_inset Quotes erd
825 \end_inset
826
827 .
828  You can go to the referred section by right-clicking on the box or by clicking
829  the button 
830 \family sans
831 Go\InsetSpace ~
832 to\InsetSpace ~
833 Label
834 \family default
835  in the opened dialog.
836  Going back to where you came from is just as easy.
837  Clicking on 
838 \family sans
839 Go back
840 \family default
841  to go back to your earlier location.
842 \end_layout
843
844 \begin_layout Standard
845 Now that we've cleared up some of the differences between the printed and
846  online versions of this file, we can start looking at the format of this
847  document.
848  You'll occasionally notice things in different fonts:
849 \end_layout
850
851 \begin_layout Itemize
852
853 \emph on
854 Emphasized Style
855 \emph default
856  is used for general emphasis, generic arguments, book titles, names of
857  sections of other manuals, and notes from the authors.
858 \end_layout
859
860 \begin_layout Itemize
861
862 \family typewriter
863 Typewriter
864 \family default
865  is used for program and file names, LyX code and functions.
866 \end_layout
867
868 \begin_layout Itemize
869
870 \family sans
871 Sans Serif
872 \family default
873  is used for menu, button, or dialog box names, and the names of keyboard
874  keys.
875 \end_layout
876
877 \begin_layout Itemize
878
879 \noun on
880 Noun Style
881 \noun default
882  is used for people's names.
883 \end_layout
884
885 \begin_layout Itemize
886
887 \series bold
888 Bold
889 \series default
890  is used for LaTeX code
891 \end_layout
892
893 \begin_layout Standard
894 For menu accelerator keys and keybindings, you'll probably get referred
895  to the 
896 \emph on
897 Key Bindings
898 \emph default
899  section of the 
900 \begin_inset Quotes eld
901 \end_inset
902
903
904 \emph on
905 Extended Features Manual
906 \emph default
907
908 \begin_inset Quotes erd
909 \end_inset
910
911  (the file 
912 \family typewriter
913 Extended.lyx
914 \family default
915 ).
916  When we do need to reference keys, we'll use the following prefixing convention
917 :
918 \end_layout
919
920 \begin_layout Itemize
921 \begin_inset Quotes eld
922 \end_inset
923
924
925 \family sans
926 C-
927 \family default
928
929 \begin_inset Quotes erd
930 \end_inset
931
932  indicates the 
933 \family sans
934 Control-
935 \family default
936  key.
937 \end_layout
938
939 \begin_layout Itemize
940 \begin_inset Quotes eld
941 \end_inset
942
943
944 \family sans
945 S-
946 \family default
947
948 \begin_inset Quotes erd
949 \end_inset
950
951  indicates the 
952 \family sans
953 Shift-
954 \family default
955  key.
956 \end_layout
957
958 \begin_layout Itemize
959 \begin_inset Quotes eld
960 \end_inset
961
962
963 \family sans
964 M-
965 \family default
966
967 \begin_inset Quotes erd
968 \end_inset
969
970  indicates the 
971 \family sans
972 Meta-
973 \family default
974  key, which on some keyboards will be the 
975 \family sans
976 Alt-
977 \family default
978  key.
979 \end_layout
980
981 \begin_layout Itemize
982 \begin_inset Quotes eld
983 \end_inset
984
985
986 \family sans
987 F1
988 \family default
989
990 \begin_inset Quotes erd
991 \end_inset
992
993  \SpecialChar \ldots{}
994  
995 \begin_inset Quotes eld
996 \end_inset
997
998
999 \family sans
1000 F12
1001 \family default
1002
1003 \begin_inset Quotes erd
1004 \end_inset
1005
1006  are the function keys.
1007 \end_layout
1008
1009 \begin_layout Itemize
1010 \begin_inset Quotes eld
1011 \end_inset
1012
1013
1014 \family sans
1015 Esc
1016 \family default
1017
1018 \begin_inset Quotes erd
1019 \end_inset
1020
1021  is the escape key.
1022 \end_layout
1023
1024 \begin_layout Itemize
1025 \begin_inset Quotes eld
1026 \end_inset
1027
1028
1029 \family sans
1030 Left
1031 \family default
1032
1033 \begin_inset Quotes erd
1034 \end_inset
1035
1036  
1037 \begin_inset Quotes eld
1038 \end_inset
1039
1040
1041 \family sans
1042 Right
1043 \family default
1044
1045 \begin_inset Quotes erd
1046 \end_inset
1047
1048  
1049 \begin_inset Quotes eld
1050 \end_inset
1051
1052
1053 \family sans
1054 Up
1055 \family default
1056
1057 \begin_inset Quotes erd
1058 \end_inset
1059
1060  
1061 \begin_inset Quotes eld
1062 \end_inset
1063
1064
1065 \family sans
1066 Down
1067 \family default
1068
1069 \begin_inset Quotes erd
1070 \end_inset
1071
1072 : self-explanatory.
1073 \end_layout
1074
1075 \begin_layout Itemize
1076
1077 \family sans
1078 \begin_inset Quotes eld
1079 \end_inset
1080
1081 Insert
1082 \family default
1083
1084 \begin_inset Quotes erd
1085 \end_inset
1086
1087  
1088 \begin_inset Quotes eld
1089 \end_inset
1090
1091
1092 \family sans
1093 Delete
1094 \family default
1095
1096 \begin_inset Quotes erd
1097 \end_inset
1098
1099  
1100 \begin_inset Quotes eld
1101 \end_inset
1102
1103
1104 \family sans
1105 Home
1106 \family default
1107
1108 \begin_inset Quotes erd
1109 \end_inset
1110
1111  
1112 \begin_inset Quotes eld
1113 \end_inset
1114
1115
1116 \family sans
1117 End
1118 \family default
1119
1120 \begin_inset Quotes erd
1121 \end_inset
1122
1123  
1124 \begin_inset Quotes eld
1125 \end_inset
1126
1127
1128 \family sans
1129 PageUp
1130 \family default
1131
1132 \begin_inset Quotes erd
1133 \end_inset
1134
1135  
1136 \begin_inset Quotes eld
1137 \end_inset
1138
1139
1140 \family sans
1141 PageDown
1142 \family default
1143
1144 \begin_inset Quotes erd
1145 \end_inset
1146
1147 : these are the 6 keys that appear above the cursor keys on many PC keyboards.
1148  
1149 \begin_inset Quotes eld
1150 \end_inset
1151
1152
1153 \family sans
1154 PageUp
1155 \family default
1156
1157 \begin_inset Quotes erd
1158 \end_inset
1159
1160  and 
1161 \begin_inset Quotes eld
1162 \end_inset
1163
1164
1165 \family sans
1166 PageDown
1167 \family default
1168
1169 \begin_inset Quotes erd
1170 \end_inset
1171
1172  are called 
1173 \begin_inset Quotes eld
1174 \end_inset
1175
1176
1177 \family sans
1178 Prior
1179 \family default
1180
1181 \begin_inset Quotes erd
1182 \end_inset
1183
1184  and 
1185 \begin_inset Quotes eld
1186 \end_inset
1187
1188
1189 \family sans
1190 Next
1191 \family default
1192
1193 \begin_inset Quotes erd
1194 \end_inset
1195
1196  on some keyboards.
1197 \end_layout
1198
1199 \begin_layout Itemize
1200
1201 \family sans
1202 Return
1203 \family default
1204  and 
1205 \family sans
1206 Enter
1207 \family default
1208  both refer to the same key.
1209  Some keyboards label the 
1210 \family sans
1211 Return
1212 \family default
1213  key as 
1214 \begin_inset Quotes eld
1215 \end_inset
1216
1217 Return,
1218 \begin_inset Quotes erd
1219 \end_inset
1220
1221  others as 
1222 \begin_inset Quotes eld
1223 \end_inset
1224
1225 Enter,
1226 \begin_inset Quotes erd
1227 \end_inset
1228
1229  still others have two keys.
1230  LyX treats all of them as the same key, so we'll use 
1231 \family sans
1232 Return
1233 \family default
1234  and 
1235 \family sans
1236 Enter
1237 \family default
1238  interchangeably.
1239 \end_layout
1240
1241 \begin_layout Standard
1242 You'll also see something like 
1243 \begin_inset Quotes eld
1244 \end_inset
1245
1246 (See 
1247 \emph on
1248
1249 \begin_inset Quotes els
1250 \end_inset
1251
1252 Extended
1253 \emph default
1254
1255 \begin_inset Quotes ers
1256 \end_inset
1257
1258 )
1259 \begin_inset Quotes erd
1260 \end_inset
1261
1262  from time to time.
1263  We've listed the possible default keybindings for a function in its entry
1264  in the 
1265 \begin_inset Quotes eld
1266 \end_inset
1267
1268
1269 \emph on
1270 Extended Features Manual
1271 \emph default
1272 ,
1273 \begin_inset Quotes erd
1274 \end_inset
1275
1276  so check there, too.
1277  Note that there are two different keybinding maps in common use in the
1278  LyX community: the 
1279 \begin_inset Quotes eld
1280 \end_inset
1281
1282 CUA
1283 \begin_inset Quotes erd
1284 \end_inset
1285
1286  style which is the default and familiar to those coming from the PC world,
1287  and the 
1288 \begin_inset Quotes eld
1289 \end_inset
1290
1291 emacs
1292 \begin_inset Quotes erd
1293 \end_inset
1294
1295  style, which is common with those who 
1296 \begin_inset Quotes eld
1297 \end_inset
1298
1299 grew up
1300 \begin_inset Quotes erd
1301 \end_inset
1302
1303  on Unix systems and use the Emacs editor.
1304  Unless specifically noted, the keybindings in the documentation are from
1305  the default CUA map.
1306  If you like Emacs, you should be smart enough to read the documentation
1307  and figure out the bindings on your own.
1308 \end_layout
1309
1310 \begin_layout Subsection
1311 Units used in the Manuals
1312 \end_layout
1313
1314 \begin_layout Standard
1315 To understand the units described in this documentation, Table\InsetSpace ~
1316
1317 \begin_inset LatexCommand ref
1318 reference "cap:Units-for-image"
1319
1320 \end_inset
1321
1322  explains all units available in LyX.
1323 \end_layout
1324
1325 \begin_layout Standard
1326 \begin_inset Float table
1327 placement t
1328 wide false
1329 sideways false
1330 status open
1331
1332 \begin_layout Caption
1333 \begin_inset LatexCommand label
1334 name "cap:Units-for-image"
1335
1336 \end_inset
1337
1338 Units
1339 \end_layout
1340
1341 \begin_layout Standard
1342 \begin_inset VSpace medskip
1343 \end_inset
1344
1345
1346 \end_layout
1347
1348 \begin_layout Standard
1349 \align center
1350 \begin_inset Tabular
1351 <lyxtabular version="3" rows="20" columns="2">
1352 <features>
1353 <column alignment="center" valignment="top" leftline="true" width="0">
1354 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0">
1355 <row topline="true" bottomline="true">
1356 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1357 \begin_inset Text
1358
1359 \begin_layout Standard
1360 unit
1361 \end_layout
1362
1363 \end_inset
1364 </cell>
1365 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1366 \begin_inset Text
1367
1368 \begin_layout Standard
1369 name/description
1370 \end_layout
1371
1372 \end_inset
1373 </cell>
1374 </row>
1375 <row topline="true">
1376 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1377 \begin_inset Text
1378
1379 \begin_layout Standard
1380 mm
1381 \end_layout
1382
1383 \end_inset
1384 </cell>
1385 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1386 \begin_inset Text
1387
1388 \begin_layout Standard
1389 millimeter
1390 \end_layout
1391
1392 \end_inset
1393 </cell>
1394 </row>
1395 <row topline="true">
1396 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1397 \begin_inset Text
1398
1399 \begin_layout Standard
1400 cm
1401 \end_layout
1402
1403 \end_inset
1404 </cell>
1405 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1406 \begin_inset Text
1407
1408 \begin_layout Standard
1409 centimeter
1410 \end_layout
1411
1412 \end_inset
1413 </cell>
1414 </row>
1415 <row topline="true">
1416 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1417 \begin_inset Text
1418
1419 \begin_layout Standard
1420 in
1421 \end_layout
1422
1423 \end_inset
1424 </cell>
1425 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1426 \begin_inset Text
1427
1428 \begin_layout Standard
1429 inch
1430 \end_layout
1431
1432 \end_inset
1433 </cell>
1434 </row>
1435 <row topline="true">
1436 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1437 \begin_inset Text
1438
1439 \begin_layout Standard
1440 pt
1441 \end_layout
1442
1443 \end_inset
1444 </cell>
1445 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1446 \begin_inset Text
1447
1448 \begin_layout Standard
1449 point (72.27
1450 \begin_inset Formula $\,$
1451 \end_inset
1452
1453 pt = 1
1454 \begin_inset Formula $\,$
1455 \end_inset
1456
1457 in)
1458 \end_layout
1459
1460 \end_inset
1461 </cell>
1462 </row>
1463 <row topline="true">
1464 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1465 \begin_inset Text
1466
1467 \begin_layout Standard
1468 pc
1469 \end_layout
1470
1471 \end_inset
1472 </cell>
1473 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1474 \begin_inset Text
1475
1476 \begin_layout Standard
1477 pica (1
1478 \begin_inset Formula $\,$
1479 \end_inset
1480
1481 pc = 12
1482 \begin_inset Formula $\,$
1483 \end_inset
1484
1485 pt)
1486 \end_layout
1487
1488 \end_inset
1489 </cell>
1490 </row>
1491 <row topline="true">
1492 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1493 \begin_inset Text
1494
1495 \begin_layout Standard
1496 sp
1497 \end_layout
1498
1499 \end_inset
1500 </cell>
1501 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1502 \begin_inset Text
1503
1504 \begin_layout Standard
1505 scaled point (65536
1506 \begin_inset Formula $\,$
1507 \end_inset
1508
1509 sp = 1
1510 \begin_inset Formula $\,$
1511 \end_inset
1512
1513 pt)
1514 \end_layout
1515
1516 \end_inset
1517 </cell>
1518 </row>
1519 <row topline="true">
1520 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1521 \begin_inset Text
1522
1523 \begin_layout Standard
1524 bp
1525 \end_layout
1526
1527 \end_inset
1528 </cell>
1529 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1530 \begin_inset Text
1531
1532 \begin_layout Standard
1533 big point (72
1534 \begin_inset Formula $\,$
1535 \end_inset
1536
1537 bp = 1
1538 \begin_inset Formula $\,$
1539 \end_inset
1540
1541 in)
1542 \end_layout
1543
1544 \end_inset
1545 </cell>
1546 </row>
1547 <row topline="true">
1548 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1549 \begin_inset Text
1550
1551 \begin_layout Standard
1552 dd
1553 \end_layout
1554
1555 \end_inset
1556 </cell>
1557 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1558 \begin_inset Text
1559
1560 \begin_layout Standard
1561 didot (72
1562 \begin_inset Formula $\,$
1563 \end_inset
1564
1565 dd 
1566 \begin_inset Formula $\approx$
1567 \end_inset
1568
1569  37.6
1570 \begin_inset Formula $\,$
1571 \end_inset
1572
1573 mm)
1574 \end_layout
1575
1576 \end_inset
1577 </cell>
1578 </row>
1579 <row topline="true">
1580 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1581 \begin_inset Text
1582
1583 \begin_layout Standard
1584 cc
1585 \end_layout
1586
1587 \end_inset
1588 </cell>
1589 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1590 \begin_inset Text
1591
1592 \begin_layout Standard
1593 cicero (1
1594 \begin_inset Formula $\,$
1595 \end_inset
1596
1597 cc = 12
1598 \begin_inset Formula $\,$
1599 \end_inset
1600
1601 dd)
1602 \end_layout
1603
1604 \end_inset
1605 </cell>
1606 </row>
1607 <row topline="true">
1608 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1609 \begin_inset Text
1610
1611 \begin_layout Standard
1612 Scale%
1613 \end_layout
1614
1615 \end_inset
1616 </cell>
1617 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1618 \begin_inset Text
1619
1620 \begin_layout Standard
1621 % of original image width
1622 \end_layout
1623
1624 \end_inset
1625 </cell>
1626 </row>
1627 <row topline="true">
1628 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1629 \begin_inset Text
1630
1631 \begin_layout Standard
1632 text%
1633 \end_layout
1634
1635 \end_inset
1636 </cell>
1637 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1638 \begin_inset Text
1639
1640 \begin_layout Standard
1641 % of text width
1642 \end_layout
1643
1644 \end_inset
1645 </cell>
1646 </row>
1647 <row topline="true">
1648 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1649 \begin_inset Text
1650
1651 \begin_layout Standard
1652 col%
1653 \end_layout
1654
1655 \end_inset
1656 </cell>
1657 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1658 \begin_inset Text
1659
1660 \begin_layout Standard
1661 % of column width
1662 \end_layout
1663
1664 \end_inset
1665 </cell>
1666 </row>
1667 <row topline="true">
1668 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1669 \begin_inset Text
1670
1671 \begin_layout Standard
1672 page%
1673 \end_layout
1674
1675 \end_inset
1676 </cell>
1677 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1678 \begin_inset Text
1679
1680 \begin_layout Standard
1681 % of paper width
1682 \end_layout
1683
1684 \end_inset
1685 </cell>
1686 </row>
1687 <row topline="true">
1688 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1689 \begin_inset Text
1690
1691 \begin_layout Standard
1692 line%
1693 \end_layout
1694
1695 \end_inset
1696 </cell>
1697 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1698 \begin_inset Text
1699
1700 \begin_layout Standard
1701 % of line width
1702 \end_layout
1703
1704 \end_inset
1705 </cell>
1706 </row>
1707 <row topline="true">
1708 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1709 \begin_inset Text
1710
1711 \begin_layout Standard
1712 theight%
1713 \end_layout
1714
1715 \end_inset
1716 </cell>
1717 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1718 \begin_inset Text
1719
1720 \begin_layout Standard
1721 % of text height
1722 \end_layout
1723
1724 \end_inset
1725 </cell>
1726 </row>
1727 <row topline="true">
1728 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1729 \begin_inset Text
1730
1731 \begin_layout Standard
1732 pheight%
1733 \end_layout
1734
1735 \end_inset
1736 </cell>
1737 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1738 \begin_inset Text
1739
1740 \begin_layout Standard
1741 % of paper height
1742 \end_layout
1743
1744 \end_inset
1745 </cell>
1746 </row>
1747 <row topline="true">
1748 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1749 \begin_inset Text
1750
1751 \begin_layout Standard
1752 ex
1753 \end_layout
1754
1755 \end_inset
1756 </cell>
1757 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1758 \begin_inset Text
1759
1760 \begin_layout Standard
1761 height of letter 
1762 \emph on
1763 x
1764 \emph default
1765  in current font
1766 \end_layout
1767
1768 \end_inset
1769 </cell>
1770 </row>
1771 <row topline="true">
1772 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1773 \begin_inset Text
1774
1775 \begin_layout Standard
1776 em
1777 \end_layout
1778
1779 \end_inset
1780 </cell>
1781 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1782 \begin_inset Text
1783
1784 \begin_layout Standard
1785 width of letter 
1786 \emph on
1787 M
1788 \emph default
1789  in current font
1790 \end_layout
1791
1792 \end_inset
1793 </cell>
1794 </row>
1795 <row topline="true" bottomline="true">
1796 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1797 \begin_inset Text
1798
1799 \begin_layout Standard
1800 mu
1801 \end_layout
1802
1803 \end_inset
1804 </cell>
1805 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1806 \begin_inset Text
1807
1808 \begin_layout Standard
1809 math unit (1
1810 \begin_inset Formula $\,$
1811 \end_inset
1812
1813 mu = 1/18
1814 \begin_inset Formula $\,$
1815 \end_inset
1816
1817 em)
1818 \end_layout
1819
1820 \end_inset
1821 </cell>
1822 </row>
1823 </lyxtabular>
1824
1825 \end_inset
1826
1827
1828 \end_layout
1829
1830 \end_inset
1831
1832
1833 \end_layout
1834
1835 \begin_layout Subsection
1836 The Manuals
1837 \end_layout
1838
1839 \begin_layout Standard
1840 The following list describes the contents of each of the files in the documentat
1841 ion:
1842 \end_layout
1843
1844 \begin_layout Description
1845 Introduction This file.
1846 \end_layout
1847
1848 \begin_layout Description
1849 Tutorial If you are new to LyX, and have never used LaTeX before, you should
1850  start here.
1851  If you
1852 \emph on
1853  
1854 \emph default
1855 have
1856 \emph on
1857  
1858 \emph default
1859 used LaTeX before, you should still read the 
1860 \emph on
1861 Tutorial
1862 \emph default
1863 , starting with the section on 
1864 \begin_inset Quotes eld
1865 \end_inset
1866
1867 LyX for LaTeX users.
1868 \begin_inset Quotes erd
1869 \end_inset
1870
1871  (Skimming the rest of the document wouldn't hurt, either.)
1872 \end_layout
1873
1874 \begin_layout Description
1875 User's\InsetSpace ~
1876 Guide The primary documentation.
1877  We'll cover 
1878 \emph on
1879 most
1880 \emph default
1881  of the basic operation and available features of LyX here.
1882  The main manual assumes that you've read the 
1883 \emph on
1884 Tutorial
1885 \emph default
1886 .
1887 \end_layout
1888
1889 \begin_layout Description
1890 ExtendedInsets Extension of the 
1891 \emph on
1892 User's Guide
1893 \emph default
1894 .
1895  Documents in detail how to use tables, graphics, floats, notes, and boxes.
1896  It
1897 \emph on
1898  
1899 \emph default
1900 also
1901 \emph on
1902  
1903 \emph default
1904 includes many tricks of the LaTeX masters.
1905 \end_layout
1906
1907 \begin_layout Description
1908 Extended\InsetSpace ~
1909 Features
1910 \emph on
1911  
1912 \emph default
1913 Extension of the 
1914 \emph on
1915 User's Guide
1916 \emph default
1917 .
1918  Documents how to use raw LaTeX commands, additional layouts, and special-purpos
1919 e editing features.
1920 \end_layout
1921
1922 \begin_layout Description
1923 Customization
1924 \emph on
1925  
1926 \emph default
1927 A description of advanced LyX features, including how to customize the overall
1928  behavior of LyX\SpecialChar \@.
1929  This includes such things as keybindings, internationalization,
1930  and configuration files.
1931 \end_layout
1932
1933 \begin_layout Description
1934 LaTeX\InsetSpace ~
1935 configuration LyX investigates your system upon installation.
1936  This file contains info on what LyX learned about your installation.
1937  Check it to see if you're missing something you might like to have.
1938 \end_layout
1939
1940 \begin_layout Standard
1941 These files will reference one another as necessary.
1942  For example, the 
1943 \emph on
1944 User's Guide
1945 \emph default
1946  contains 
1947 \emph on
1948 some
1949 \emph default
1950  information on installation and customization, but refers the reader to
1951  the 
1952 \emph on
1953 Customization Manual
1954 \emph default
1955  for more information.
1956 \end_layout
1957
1958 \begin_layout Standard
1959 We'll state again an important point:
1960 \end_layout
1961
1962 \begin_layout Standard
1963 \begin_inset VSpace bigskip
1964 \end_inset
1965
1966
1967 \end_layout
1968
1969 \begin_layout Standard
1970 \align center
1971 If you are new to LyX, read the 
1972 \emph on
1973 Tutorial
1974 \emph default
1975 .
1976  Now\SpecialChar \@.
1977
1978 \end_layout
1979
1980 \begin_layout Standard
1981 \begin_inset VSpace bigskip
1982 \end_inset
1983
1984
1985 \end_layout
1986
1987 \begin_layout Standard
1988 Otherwise, you could needlessly frustrate yourself.
1989  LyX does all that you need a word processor to do, but using a different
1990  approach.
1991 \end_layout
1992
1993 \begin_layout Section
1994 \begin_inset LatexCommand label
1995 name "sec:Contrib"
1996
1997 \end_inset
1998
1999 Contributing to the LyX Project
2000 \end_layout
2001
2002 \begin_layout Subsection
2003 Contributing to LyX
2004 \end_layout
2005
2006 \begin_layout Standard
2007 LyX is mostly written in C++ (the LaTeX importer is written in Python).
2008  It is a large project, and as a result it is not free from bugs, or the
2009  need for improvements in the source code.
2010 \end_layout
2011
2012 \begin_layout Subsubsection
2013 Reporting a bug
2014 \end_layout
2015
2016 \begin_layout Standard
2017 While using LyX, you may find behavior which you consider a bug.
2018  Crashes, though rare, can happen.
2019  User interface problems are considered major bugs by the LyX team: especially
2020  helpful are indications of parts of the LyX interface you find confusing,
2021  or unclear.
2022 \end_layout
2023
2024 \begin_layout Standard
2025 LyX has a bug tracking system, which you can find at 
2026 \family typewriter
2027
2028 \begin_inset LatexCommand url
2029 target "http://bugzilla.lyx.org/"
2030
2031 \end_inset
2032
2033
2034 \family default
2035 .
2036  You should check the bug tracker before reporting any bugs, in case it
2037  has already been reported.
2038  If you have a comment on an existing bug, or wish to report a new bug,
2039  you may either use the bug tracker, or send an e-mail to the development
2040  mailing list, 
2041 \family typewriter
2042 lyx-devel@lists.lyx.org
2043 \family default
2044 .
2045  Archives of this list are linked from the main LyX website, 
2046 \family typewriter
2047
2048 \begin_inset LatexCommand url
2049 target "http://www.lyx.org/"
2050
2051 \end_inset
2052
2053
2054 \family default
2055 .
2056 \end_layout
2057
2058 \begin_layout Standard
2059 A useful bug report will at a minimum include the version of LyX you are
2060  having the problem with.
2061  Accurate, detailed descriptions are preferred - the more time developers
2062  have to spend to pinpoint the source of a bug, the less time they have
2063  for other improvements.
2064  Mention the system and system version you are running LyX with.
2065  Give the versions of the libraries you have installed on your system, and,
2066  if relevant, the versions of external programs that LyX uses.
2067  If it's a compilation or configuration problem, include the file 
2068 \family typewriter
2069 config.log
2070 \family default
2071 , and mention which compiler you are using.
2072  
2073 \end_layout
2074
2075 \begin_layout Subsubsection
2076 Contributing fixes and new features
2077 \end_layout
2078
2079 \begin_layout Standard
2080 If you have made changes to LyX's source that you think should become part
2081  of LyX, send your changes as a diff file (in unified format) to the development
2082  list referenced above, along with a change log, and a description of what
2083  your patch does.
2084 \end_layout
2085
2086 \begin_layout Subsection
2087 Contributing to the Documentation
2088 \end_layout
2089
2090 \begin_layout Standard
2091 LyX's documentation is extensive; however LyX is under constant development,
2092  and each new release adds new features.
2093  You may find some documentation needs improvement.
2094  This section describes what to do if you find an error, or have some suggestion
2095 s for improving the documentation.
2096 \end_layout
2097
2098 \begin_layout Subsubsection
2099 Reporting Errors in the Manuals
2100 \end_layout
2101
2102 \begin_layout Standard
2103 If you find a problem with the documentation, send a message to the mailing
2104  list 
2105 \family typewriter
2106 lyx-docs@lists.lyx.org
2107 \family default
2108 .
2109  The documentation team will make any necessary fixes.
2110 \end_layout
2111
2112 \begin_layout Subsubsection
2113 Joining the Documentation Team.
2114 \end_layout
2115
2116 \begin_layout Standard
2117 The LyX Documentation Project, like anything else in the LyX project, can
2118  always use assistance! If you're interested in contributing to the Documentatio
2119 n Project, you need to do the following:
2120 \end_layout
2121
2122 \begin_layout Enumerate
2123 Get the latest LyX source code from 
2124 \newline
2125
2126 \begin_inset LatexCommand url
2127 target "http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/doc"
2128
2129 \end_inset
2130
2131  
2132 \newline
2133 Inside that directory is a file called 
2134 \family typewriter
2135 DocStyle.lyx
2136 \family default
2137 .
2138  Read it; it's the style sheet for the documentation.
2139 \end_layout
2140
2141 \begin_layout Enumerate
2142 Next, read the 
2143 \emph on
2144 User's Guide
2145 \emph default
2146  and the 
2147 \emph on
2148 Tutorial
2149 \emph default
2150
2151 \newline
2152 The point of this exercise is to give you ideas.
2153  The 
2154 \emph on
2155 Tutorial
2156 \emph default
2157  and 
2158 \emph on
2159 User's Guide
2160 \emph default
2161  is likely to be the most up-to-date of all of the documentation.
2162  You should be able to glean some insights into how we want the manuals
2163  to read and to look.
2164 \end_layout
2165
2166 \begin_layout Enumerate
2167 Contact the team at:
2168 \newline
2169
2170 \family typewriter
2171  lyx-docs@lists.lyx.org
2172 \family default
2173
2174 \newline
2175 to discuss your intended changes, and get some feedback on them.
2176 \end_layout
2177
2178 \begin_layout Standard
2179 The changes you wish to make may range from improving clarity of the text,
2180  to doing major re-structuring of the documentation.
2181  Any and all improvements are gladly received.
2182 \end_layout
2183
2184 \end_body
2185 \end_document