lib/doc/FAQ.lyx

   1 #LyX 1.5.4svn created this file. For more info see http://www.lyx.org/
   2 \lyxformat 276
   3 \begin_document
   4 \begin_header
   5 \textclass article
   6 \language english
   7 \inputencoding latin1
   8 \font_roman default
   9 \font_sans default
  10 \font_typewriter default
  11 \font_default_family default
  12 \font_sc false
  13 \font_osf false
  14 \font_sf_scale 100
  15 \font_tt_scale 100
  16 \graphics default
  17 \paperfontsize default
  18 \spacing single
  19 \papersize default
  20 \use_geometry true
  21 \use_amsmath 0
  22 \use_esint 0
  23 \cite_engine basic
  24 \use_bibtopic false
  25 \paperorientation portrait
  26 \leftmargin 3cm
  27 \topmargin 2cm
  28 \rightmargin 3cm
  29 \bottommargin 3cm
  30 \secnumdepth 3
  31 \tocdepth 3
  32 \paragraph_separation indent
  33 \defskip medskip
  34 \quotes_language english
  35 \papercolumns 1
  36 \papersides 1
  37 \paperpagestyle default
  38 \tracking_changes false
  39 \output_changes false
  40 \author ""
  41 \end_header
  42
  43 \begin_body
  44
  45 \begin_layout Title
  46 LyX Frequently Asked Questions with Answers
  47 \end_layout
  48
  49 \begin_layout Author
  50 by the LyX Team
  51 \begin_inset Foot
  52 status open
  53
  54 \begin_layout Standard
  55 \noindent
  56 If you have comments or error corrections, please send them to the LyX Documenta
  57 tion mailing list, <lyx-docs@lists.lyx.org>.
  58 \end_layout
  59
  60 \end_inset
  61
  62
  63 \end_layout
  64
  65 \begin_layout Abstract
  66 This is the list of Frequently Asked Questions for LyX, the Open Source
  67  document processor that provides a What-You-See-Is-What-You-Mean environment
  68  for producing high quality documents.
  69  For further help, you may wish to contact the LyX User Group mailing list
  70  at
  71 \family typewriter
  72 lyx-users@lists.lyx.org
  73 \family default
  74
  75 \emph on
  76 after
  77 \emph default
  78  you have read through the docs.
  79
  80 \end_layout
  81
  82 \begin_layout Abstract
  83 \begin_inset LatexCommand tableofcontents
  84
  85 \end_inset
  86
  87
  88 \end_layout
  89
  90 \begin_layout Section
  91 Introduction and General Information
  92 \end_layout
  93
  94 \begin_layout Subsection
  95 What is LyX?
  96 \end_layout
  97
  98 \begin_layout Standard
  99 LyX is a program that provides a more modern approach to writing documents
 100  with a computer, an approach that breaks with the obsolete tradition of
 101  the
 102 \begin_inset Quotes eld
 103 \end_inset
 104
 105 typewriter concept.
 106 \begin_inset Quotes erd
 107 \end_inset
 108
 109  It is designed for authors who want professional output quickly with a
 110  minimum of effort without becoming specialists in typesetting.
 111  The job of typesetting is done mostly by the computer, not the author;
 112  with LyX, the author can concentrate on the contents of her writing.
 113 \end_layout
 114
 115 \begin_layout Standard
 116 LyX provides an
 117 \begin_inset Quotes eld
 118 \end_inset
 119
 120 almost-WYSIWYG
 121 \begin_inset Quotes erd
 122 \end_inset
 123
 124  view of the document.
 125
 126 \begin_inset Quotes eld
 127 \end_inset
 128
 129 Almost
 130 \begin_inset Quotes erd
 131 \end_inset
 132
 133  means that the line- and page-breaks are not displayed exactly as they
 134  will appear in the printed document.
 135  However, that's not really necessary, since LyX uses a separate typesetter
 136  program (called LaTeX) to perform the final formatting of your text.
 137  While LyX contains everything it needs to be a comfortable user interface,
 138  the typesetting program contains everything necessary to format text, and
 139  do so very, very well.
 140
 141 \end_layout
 142
 143 \begin_layout Standard
 144 So, line- and page-breaks aren't your problem anymore.
 145  Remembering which number to use for the next subsection isn't your problem
 146  anymore.
 147  Recalling what font you used for all of your section headings isn't your
 148  problem anymore.
 149  You tell LyX (and LaTeX) what
 150 \emph on
 151 kind
 152 \emph default
 153  of document you're editing and what
 154 \emph on
 155 type
 156 \emph default
 157  of paragraph this-or-that text is, the computer can typeset it accordingly.
 158  Of course you can also still do some low-level formatting for fine-tuning.
 159  However, the proper way with LyX is to tell the computer what the text
 160
 161 \emph on
 162 is
 163 \emph default
 164 , not what it should look like.
 165  So, we like to say that LyX gives you WYSIWYM editing (What You See Is
 166  What You
 167 \emph on
 168 Mean
 169 \emph default
 170 ).
 171 \end_layout
 172
 173 \begin_layout Subsection
 174 That's fine, but is it useful?
 175 \end_layout
 176
 177 \begin_layout Standard
 178 Absolutely.
 179  The following type of documents have been produced with LyX:
 180 \end_layout
 181
 182 \begin_layout Itemize
 183 Memos
 184 \end_layout
 185
 186 \begin_layout Itemize
 187 Letters
 188 \end_layout
 189
 190 \begin_layout Itemize
 191 Dissertations (260 pages in a single document, longer using include files)
 192 \end_layout
 193
 194 \begin_deeper
 195 \begin_layout Itemize
 196 for example,
 197 \begin_inset LatexCommand url
 198 target "http://www.fee.uva.nl/scholar/mdw/leuven/thesis.pdf"
 199
 200 \end_inset
 201
 202
 203 \end_layout
 204
 205 \end_deeper
 206 \begin_layout Itemize
 207 Lecture notes (133 pages, 27 figures on a 33 MHz 486 machine!)
 208 \end_layout
 209
 210 \begin_layout Itemize
 211 Seminar notebooks (500+ pages)
 212 \end_layout
 213
 214 \begin_layout Itemize
 215 Conference proceedings (Proceedings of the Second Continental Workshop on
 216  the Geoid in Europe, (Finnish Geodetic Institute Report 98:4), 292 pages)
 217 \end_layout
 218
 219 \begin_layout Itemize
 220 Software Documentation (the LyX User Guide is about 120 pages)
 221 \end_layout
 222
 223 \begin_layout Itemize
 224 Books
 225 \end_layout
 226
 227 \begin_deeper
 228 \begin_layout Itemize
 229 see
 230 \begin_inset LatexCommand url
 231 target "http://www.postgresql.org/docs/awbook.html"
 232
 233 \end_inset
 234
 235  for an example on PostgreSQL
 236 \end_layout
 237
 238 \begin_layout Itemize
 239 Donnay, J-P., Barnsley, M.J., and Longley, P.A., eds., 2001, Remote Sensing and
 240  Urban Analysis (Taylor and Francis: London).
 241 \end_layout
 242
 243 \begin_layout Itemize
 244 Herbert Voss: Praktische Kryptologie mit Java 286 pages, lots of equations,
 245  tables, figures.
 246  ISBN 3-8311-1458-7
 247 \end_layout
 248
 249 \begin_layout Itemize
 250 Yann Collette and Patrick Siarry, Optimisation multiobjectifs, 2002, Eyrolles
 251 \end_layout
 252
 253 \end_deeper
 254 \begin_layout Itemize
 255 Papers published in the following refereed journals:
 256 \end_layout
 257
 258 \begin_deeper
 259 \begin_layout Itemize
 260 Astronomy & Astrophysics (Suetterlin, P.
 261  1998, A&A, 333, 305; Suetterlin, P.
 262  & Wiehr, E.
 263  1998, A&A, 336, 367)
 264 \end_layout
 265
 266 \begin_layout Itemize
 267 Astronomical Journal (Ressler, M.
 268  E.
 269  & Barsony, M.
 270  2001, AJ, 121, 1098)
 271 \end_layout
 272
 273 \end_deeper
 274 \begin_layout Itemize
 275 Novels (400+ page novel due out in September 2000; an 836 page novel is
 276  currently with an agent)
 277 \end_layout
 278
 279 \begin_layout Itemize
 280 Scripts for plays and movies
 281 \end_layout
 282
 283 \begin_layout Itemize
 284 Business proposals for > $1 M (US)
 285 \end_layout
 286
 287 \begin_layout Subsection
 288 Where do I start?
 289 \end_layout
 290
 291 \begin_layout Standard
 292 The website
 293 \begin_inset LatexCommand url
 294 target "www.lyx.org"
 295
 296 \end_inset
 297
 298  is the first place to go for anything related to LyX.
 299  News, examples, downloads, and lots of other stuff is available there.
 300  After you have installed LyX and started it the first time, read the Tutorial
 301  (
 302 \family sans
 303 Help\SpecialChar \menuseparator
 304 Tutorial
 305 \family default
 306 ).
 307  Yes, I really mean that.
 308 \end_layout
 309
 310 \begin_layout Standard
 311 Another basic introductory guide may be found at
 312 \begin_inset LatexCommand url
 313 target "www.bilkent.edu.tr/~robin/lyxguide.pdf"
 314
 315 \end_inset
 316
 317
 318 \end_layout
 319
 320 \begin_layout Subsection
 321 Does LyX run on my computer?
 322 \end_layout
 323
 324 \begin_layout Standard
 325 At this time, you need to have the X Window system to run LyX.
 326  OS/2 and Win32 ports exist, but you need to have an Xserver installed and
 327  running on these systems.
 328  LyX is known to run on the following platforms (and probably a zillion
 329  others):
 330 \end_layout
 331
 332 \begin_layout Itemize
 333 Linux: RedHat 4.2, 5.0, 5.1, 6.0, 6.1, SUSE 5.x, Mandrake 7.0, 7.2
 334 \end_layout
 335
 336 \begin_layout Itemize
 337 SparcLinux: RedHat 6.0
 338 \end_layout
 339
 340 \begin_layout Itemize
 341 Sun Solaris 2.6, 2.7
 342 \end_layout
 343
 344 \begin_layout Itemize
 345 Tru64 Unix 4.0f
 346 \end_layout
 347
 348 \begin_layout Itemize
 349 HP-UX
 350 \end_layout
 351
 352 \begin_layout Itemize
 353 OSF1 flore V4.0 1091 alpha
 354 \end_layout
 355
 356 \begin_layout Subsection
 357 How much hard disk space does LyX need?
 358 \end_layout
 359
 360 \begin_layout Standard
 361 On my system, the LyX binary consumes 2.0 MB of disk space, while the supporting
 362  files occupy another 12.6 MB (9.1 MB of which is consumed by the docs! You
 363  can delete the languages you don't care about to save some space).
 364  Of course, you do need to have something like teTeX installed which consumes
 365  a mere 115 MB, as well as ghostscript, which is another 10 MB!
 366 \end_layout
 367
 368 \begin_layout Subsection
 369 Is LyX really Open Source?
 370 \end_layout
 371
 372 \begin_layout Standard
 373 Yes.
 374  The freely available X toolkit that LyX uses, xforms, was until recently
 375  closed source.
 376  Also the other toolkit that LyX uses, Qt, although a proprietary product
 377  of Troll Tech, is used in its open source variant.
 378  The LyX source itself is available under the GPL, so it qualifies.
 379
 380 \end_layout
 381
 382 \begin_layout Standard
 383 Version 1.0 of xforms is available under the LGPL and its sources (and binaries)
 384  can be found from
 385 \begin_inset LatexCommand url
 386 target "http://savannah.nongnu.org/download/xforms/xforms-1.0.tar.gz"
 387
 388 \end_inset
 389
 390 , which however requires some tinkering to get running.
 391  Qt tends to come with your distribution.
 392 \end_layout
 393
 394 \begin_layout Section
 395 Internet Resources
 396 \end_layout
 397
 398 \begin_layout Subsection
 399 Where should I look on the World Wide Web for LyX stuff?
 400 \end_layout
 401
 402 \begin_layout Itemize
 403 \begin_inset LatexCommand url
 404 target "www.lyx.org"
 405
 406 \end_inset
 407
 408
 409 \end_layout
 410
 411 \begin_layout Itemize
 412 \begin_inset LatexCommand url
 413 target "bugzilla.lyx.org"
 414
 415 \end_inset
 416
 417 , if you want to report a bug in LyX.
 418 \end_layout
 419
 420 \begin_layout Itemize
 421 \begin_inset LatexCommand url
 422 target "www.devel.lyx.org"
 423
 424 \end_inset
 425
 426 , if you are interested in the real blood and guts.
 427 \end_layout
 428
 429 \begin_layout Itemize
 430 Known mirror sites include:
 431 \end_layout
 432
 433 \begin_deeper
 434 \begin_layout Itemize
 435 \begin_inset LatexCommand url
 436 target "www.mx.lyx.org"
 437
 438 \end_inset
 439
 440
 441 \end_layout
 442
 443 \begin_layout Itemize
 444 \begin_inset LatexCommand url
 445 target "www.no.lyx.org"
 446
 447 \end_inset
 448
 449
 450 \end_layout
 451
 452 \begin_layout Itemize
 453 \begin_inset LatexCommand url
 454 target "www.it.lyx.org"
 455
 456 \end_inset
 457
 458
 459 \end_layout
 460
 461 \end_deeper
 462 \begin_layout Subsection
 463 Where can I get LyX material by FTP?
 464 \end_layout
 465
 466 \begin_layout Itemize
 467 ftp.lyx.org in /pub/lyx (also known as ftp.via.ecp.fr)
 468 \end_layout
 469
 470 \begin_layout Subsection
 471 What mailing lists are there?
 472 \end_layout
 473
 474 \begin_layout Itemize
 475 lyx-announce@lists.lyx.org (very low volume), for announcements related to
 476  LyX
 477 \end_layout
 478
 479 \begin_layout Itemize
 480 lyx-users@lists.lyx.org (medium volume), for general usage issues
 481 \end_layout
 482
 483 \begin_layout Itemize
 484 lyx-devel@lists.lyx.org (high volume), for development and debugging issues
 485 \end_layout
 486
 487 \begin_layout Itemize
 488 lyx-docs@lists.lyx.org (excruciatingly low volume), for documentation issues
 489
 490 \end_layout
 491
 492 \begin_layout Standard
 493 Generally, you would send email to lyx-foo-subscribe@lists.lyx.org to subscribe
 494  to these lists or to lyx-foo-unsubscribe@lists.lyx.org to unsubscribe, where
 495
 496 \begin_inset Quotes eld
 497 \end_inset
 498
 499 foo
 500 \begin_inset Quotes erd
 501 \end_inset
 502
 503  is one of
 504 \begin_inset Quotes eld
 505 \end_inset
 506
 507 announce
 508 \begin_inset Quotes erd
 509 \end_inset
 510
 511 ,
 512 \begin_inset Quotes eld
 513 \end_inset
 514
 515 users
 516 \begin_inset Quotes erd
 517 \end_inset
 518
 519 ,
 520 \begin_inset Quotes eld
 521 \end_inset
 522
 523 devel
 524 \begin_inset Quotes erd
 525 \end_inset
 526
 527 , or
 528 \begin_inset Quotes eld
 529 \end_inset
 530
 531 docs
 532 \begin_inset Quotes erd
 533 \end_inset
 534
 535 ; definitely see
 536 \begin_inset LatexCommand url
 537 target "http://www.lyx.org/internet/mailing.php3"
 538
 539 \end_inset
 540
 541  for the full details.
 542 \end_layout
 543
 544 \begin_layout Subsection
 545 Are the mailing lists archived anywhere?
 546 \end_layout
 547
 548 \begin_layout Standard
 549 Yes.
 550  :-)
 551 \end_layout
 552
 553 \begin_layout Subsection
 554 Okay, wise guy! Where are they archived?
 555 \end_layout
 556
 557 \begin_layout Itemize
 558 Announce:
 559 \begin_inset LatexCommand url
 560 target "http://www.mail-archive.com/lyx-announce@lists.lyx.org/"
 561
 562 \end_inset
 563
 564
 565 \end_layout
 566
 567 \begin_layout Itemize
 568 Users:
 569 \begin_inset LatexCommand url
 570 target "http://www.mail-archive.com/lyx-users@lists.lyx.org/"
 571
 572 \end_inset
 573
 574
 575 \end_layout
 576
 577 \begin_layout Itemize
 578 Devel:
 579 \begin_inset LatexCommand url
 580 target "http://www.mail-archive.com/lyx-devel@lists.lyx.org/"
 581
 582 \end_inset
 583
 584
 585 \end_layout
 586
 587 \begin_layout Section
 588 Compatibility with other word/document processors
 589 \end_layout
 590
 591 \begin_layout Subsection
 592 Can I read/write LaTeX files?
 593 \end_layout
 594
 595 \begin_layout Standard
 596 Yes.
 597  LyX outputs LaTeX files that are either machine or human friendly.
 598  The
 599 \family typewriter
 600 tex2lyx
 601 \family default
 602  program that comes with LyX does a decent job of converting LaTeX into
 603  LyX.
 604  It's not perfect, but it will usually get at least 95% of the job done
 605  for you.
 606 \end_layout
 607
 608 \begin_layout Subsection
 609 Can I read/write Word files?
 610 \end_layout
 611
 612 \begin_layout Standard
 613 Not trivially.
 614  People have had some level of success with the following sequence: LyX
 615 \begin_inset Formula $\rightarrow$
 616 \end_inset
 617
 618 LaTeX
 619 \begin_inset Formula $\rightarrow$
 620 \end_inset
 621
 622 RTF
 623 \begin_inset Formula $\rightarrow$
 624 \end_inset
 625
 626 Word, and vice versa.
 627  However, Word is inherently not a markup language like LyX and LaTeX are,
 628  so conversions are usually difficult and almost meaningless.
 629 \end_layout
 630
 631 \begin_layout Standard
 632 However, here are a few suggestions which were sent in:
 633 \end_layout
 634
 635 \begin_layout Description
 636 word2x produces LaTeX, HTML and plain text output.
 637  The LaTeX is importable in principle (and is rather clean) but I often
 638  prefer plain text and add the formatting back in.
 639  (This requires that you have knowledge on the original formatting).
 640  On last writing did not yet handle Office 2000 Word.
 641 \end_layout
 642
 643 \begin_layout Description
 644 wvware (found at www.wvware.com, or the abisource CVS repository for the latest).
 645  This was previously called msWordView.
 646  Very good, only tends to produce visually formatted LaTeX/HTML.
 647  Is however highly configurable: a config file
 648 \family typewriter
 649 wvLaTeX.xml
 650 \family default
 651  guides the translation process.
 652  Handles also the newest Office formats.
 653 \end_layout
 654
 655 \begin_layout Description
 656 Ted This is the editor to use when someone sends you an RTF file created
 657  by Word.
 658  Fine product.
 659  Mail yourself the converted version (plain text or HTML).
 660 \end_layout
 661
 662 \begin_layout Standard
 663 Finally, when all else fails, use any word processor (WordPerfect, StarOffice/Op
 664 enOffice, ...) which understands Word.
 665  Then export as the file as plain text and add the formatting by hand in
 666  LyX.
 667
 668 \end_layout
 669
 670 \begin_layout Standard
 671 For me personally, at least, it's faster doing this than cleaning up attempts
 672  at a conversion, though it is certainly unsatisfactory if you need to go
 673  back and forth a lot.
 674 \end_layout
 675
 676 \begin_layout Subsection
 677 Can I read/write HTML files?
 678 \end_layout
 679
 680 \begin_layout Standard
 681 You can output HTML files using the
 682 \begin_inset Quotes eld
 683 \end_inset
 684
 685 tth
 686 \begin_inset Quotes erd
 687 \end_inset
 688
 689  converter program, amongst others.
 690  There may be a HTML
 691 \begin_inset Formula $\rightarrow$
 692 \end_inset
 693
 694 LaTeX program available which allows you to convert the other direction.
 695 \end_layout
 696
 697 \begin_layout Section
 698 Obtaining and Compiling LyX
 699 \end_layout
 700
 701 \begin_layout Subsection
 702 What do I need?
 703 \end_layout
 704
 705 \begin_layout Itemize
 706 LyX source code: lyx-1.x.x.tar.gz
 707 \end_layout
 708
 709 \begin_layout Itemize
 710 XForms library: xforms-0.88 or higher (using the latest version available
 711  is recommended)
 712 \end_layout
 713
 714 \begin_layout Itemize
 715 A LaTeX installation: we strongly recommend teTeX-1.0 or higher
 716 \end_layout
 717
 718 \begin_layout Itemize
 719 A PostScript® interpreter: ghostscript 7.0 or higher
 720 \end_layout
 721
 722 \begin_layout Itemize
 723 A modern C++ compiler.
 724  If you are using gcc, LyX requires at least version 2.95.2.
 725 \end_layout
 726
 727 \begin_layout Subsection
 728 How do I compile it?
 729 \end_layout
 730
 731 \begin_layout Itemize
 732 ./configure
 733 \end_layout
 734
 735 \begin_layout Itemize
 736 make
 737 \end_layout
 738
 739 \begin_layout Itemize
 740 make install (usually as root, though you don't have to be if you add flags
 741  to the configure command)
 742 \end_layout
 743
 744 \begin_layout Standard
 745 See the INSTALL file for more details.
 746 \end_layout
 747
 748 \begin_layout Subsection
 749 I hate compiling.
 750  Where are precompiled binaries?
 751 \end_layout
 752
 753 \begin_layout Standard
 754 Most of the above packages are available as precompiled binaries for a variety
 755  of Linux systems, perhaps others as well.
 756  The LyX binaries are available as RPMS and a few other formats and may
 757  be obtained from
 758 \begin_inset LatexCommand url
 759 target "ftp://ftp.lyx.org/pub/lyx/bin/"
 760
 761 \end_inset
 762
 763 .
 764 \end_layout
 765
 766 \begin_layout Section
 767 Questions about Evil Red Text (IMPORTANT!)
 768 \end_layout
 769
 770 \begin_layout Subsection
 771 What is Evil Red Text (aka ERT)?
 772 \end_layout
 773
 774 \begin_layout Standard
 775 ERT (Evil Red Text) refers to raw LaTeX commands which are inserted into
 776  your LyX document.
 777  Certain troglodytes in the development group coined this term when they
 778  complained about the unsightly appearance it leads to in LyX documents.
 779  The more enlightened among us know that it is extremely useful, even though
 780  it does qualify as URT (Ugly Red Text), but ERT seems to have stuck.
 781
 782 \end_layout
 783
 784 \begin_layout Subsection
 785 How do I enter Evil Red Text?
 786 \end_layout
 787
 788 \begin_layout Standard
 789 Aesthetic arguments aside, many of the answers in this FAQ require that
 790  you use ERT, so whenever we say
 791 \begin_inset Quotes eld
 792 \end_inset
 793
 794 insert the following LaTeX code
 795 \begin_inset Quotes erd
 796 \end_inset
 797
 798 , do the following
 799 \end_layout
 800
 801 \begin_layout Enumerate
 802 Click the TeX toolbar button or select
 803 \family sans
 804 \bar under
 805 I
 806 \bar default
 807 nsert\SpecialChar \menuseparator
 808
 809 \bar under
 810 T
 811 \bar default
 812 eX
 813 \family default
 814 .
 815 \end_layout
 816
 817 \begin_layout Enumerate
 818 Type the command as it is written in the normal way
 819 \end_layout
 820
 821 \begin_layout Subsection
 822 The new ERT inset is really inconvenient !
 823 \end_layout
 824
 825 \begin_layout Standard
 826 A lot of people have been complaining about the ERT inset introduced in
 827  version 1.2.0.
 828  However, since there is little hope of to see the old LaTeX font return
 829  from the grave (it was really a hack), here are a couple of things to ponder:
 830 \end_layout
 831
 832 \begin_layout Itemize
 833 You can collapse the ERT like any other floats by using
 834 \family sans
 835 \bar under
 836 E
 837 \bar default
 838 dit\SpecialChar \menuseparator
 839 Open/C
 840 \bar under
 841 l
 842 \bar default
 843 ose float
 844 \family default
 845  (bound to
 846 \family sans
 847 C-i
 848 \family default
 849  by default)
 850 \end_layout
 851
 852 \begin_layout Itemize
 853 You can also set it to
 854 \begin_inset Quotes eld
 855 \end_inset
 856
 857 inlined
 858 \begin_inset Quotes erd
 859 \end_inset
 860
 861  by using the properties dialog obtained by right-clicking anywhere in the
 862  inset
 863 \end_layout
 864
 865 \begin_layout Subsection
 866 Is there an alternative?
 867 \end_layout
 868
 869 \begin_layout Standard
 870 LaTeX commands can also be inserted in the
 871 \begin_inset Quotes eld
 872 \end_inset
 873
 874 LaTeX Preamble
 875 \begin_inset Quotes erd
 876 \end_inset
 877
 878 , a form in LyX that is inserted verbatim into the LaTeX file which is generated
 879  during processing.
 880  This is especially useful for including nonstandard LaTeX packages, defining
 881  global shortcuts to be used within the document, etc.
 882 \end_layout
 883
 884 \begin_layout Section
 885 Questions Related to Using LyX
 886 \end_layout
 887
 888 \begin_layout Standard
 889 In this section, we attempt to address the truly most frequently asked questions.
 890  For a broader range of not-so-frequently asked questions and many
 891 \begin_inset Quotes eld
 892 \end_inset
 893
 894 how do I?
 895 \begin_inset Quotes erd
 896 \end_inset
 897
 898  topics, see Herbert Voss' spectacular collection at
 899 \begin_inset LatexCommand url
 900 target "http://tug.org/TeXnik/"
 901
 902 \end_inset
 903
 904 .
 905  You are doing yourself a large disservice if you don't check there before
 906  sending a message to the mailing lists!
 907 \end_layout
 908
 909 \begin_layout Subsection
 910 General questions
 911 \end_layout
 912
 913 \begin_layout Subsubsection
 914 How do I get rid of the date under the title?
 915 \end_layout
 916
 917 \begin_layout Standard
 918 The simplest solution is to open the menu
 919 \family sans
 920 \bar under
 921 L
 922 \bar default
 923 ayout\SpecialChar \menuseparator
 924 P
 925 \bar under
 926 r
 927 \bar default
 928 eamble
 929 \family default
 930  and add the line
 931 \end_layout
 932
 933 \begin_layout LyX-Code
 934
 935 \backslash
 936 date{}
 937 \end_layout
 938
 939 \begin_layout Standard
 940 in the preamble window.
 941 \end_layout
 942
 943 \begin_layout Subsubsection
 944 How do I change the spacing in an Itemize/\SpecialChar \-
 945 Enumerate/\SpecialChar \-
 946 Description list environment
 947 ?
 948 \end_layout
 949
 950 \begin_layout Standard
 951 You'll have to do this by hand: for example, for one particular list, you
 952  can add the following LaTeX code at the beginning of the list:
 953 \end_layout
 954
 955 \begin_layout Standard
 956
 957 \family typewriter
 958
 959 \backslash
 960 setlength{
 961 \backslash
 962 itemsep}{0mm}
 963 \end_layout
 964
 965 \begin_layout Subsubsection
 966 How do I number equations by section?
 967 \end_layout
 968
 969 \begin_layout Standard
 970 Add the following two lines to your LaTeX preamble:
 971 \end_layout
 972
 973 \begin_layout LyX-Code
 974
 975 \backslash
 976 @addtoreset{equation}{section}
 977 \end_layout
 978
 979 \begin_layout LyX-Code
 980
 981 \backslash
 982 renewcommand{
 983 \backslash
 984 theequation}{
 985 \backslash
 986 thesection.
 987 \backslash
 988 arabic{equation}}
 989 \end_layout
 990
 991 \begin_layout Subsubsection
 992 Is it possible to do this for figures and tables as well?
 993 \end_layout
 994
 995 \begin_layout Standard
 996 Replace the phrase
 997 \family typewriter
 998
 999 \backslash
1000 theequation
1001 \family default
1002  with
1003 \family typewriter
1004
1005 \backslash
1006 thetable
1007 \family default
1008  or
1009 \family typewriter
1010
1011 \backslash
1012 thefigure
1013 \family default
1014  and then replace
1015 \family typewriter
1016 equation
1017 \family default
1018  with
1019 \family typewriter
1020 table
1021 \family default
1022  or
1023 \family typewriter
1024 figure
1025 \family default
1026 .
1027  Don't forget to adapt the
1028 \backslash
1029 @addtoreset command, too.
1030 \end_layout
1031
1032 \begin_layout Subsubsection
1033 How do I change to footnote numbers to symbols (star, dagger, etc.)?
1034 \end_layout
1035
1036 \begin_layout Standard
1037 Add
1038 \family typewriter
1039
1040 \backslash
1041 renewcommand{
1042 \backslash
1043 thefootnote}{
1044 \backslash
1045 fnsymbol{footnote}}
1046 \family default
1047  to your LaTeX preamble.
1048 \end_layout
1049
1050 \begin_layout Subsubsection
1051 How do I kill widows and orphans?
1052 \end_layout
1053
1054 \begin_layout Standard
1055 Okay, we are not playing Duke Nukem here! To eliminate widows and orphans
1056  (first line from a paragraph at the bottom of the page and the last line
1057  from a paragraph at the top of the page), add the following to the LaTeX
1058  preamble:
1059 \end_layout
1060
1061 \begin_layout LyX-Code
1062
1063 \backslash
1064 widowpenalty=10000
1065 \end_layout
1066
1067 \begin_layout LyX-Code
1068
1069 \backslash
1070 clubpenalty=10000
1071 \end_layout
1072
1073 \begin_layout Standard
1074 and perhaps
1075 \end_layout
1076
1077 \begin_layout LyX-Code
1078
1079 \backslash
1080 raggedbottom
1081 \end_layout
1082
1083 \begin_layout LyX-Code
1084
1085 \end_layout
1086
1087 \begin_layout Subsubsection
1088 How do I get a formatted list which starts with e.g.
1089  1.
1090  a)?
1091 \end_layout
1092
1093 \begin_layout Standard
1094 If you want a list which looks like
1095 \end_layout
1096
1097 \begin_layout LyX-Code
1098 1.
1099  a) First alternative
1100 \end_layout
1101
1102 \begin_layout LyX-Code
1103    b) Second alternative
1104 \end_layout
1105
1106 \begin_layout LyX-Code
1107    c) Third alternative
1108 \end_layout
1109
1110 \begin_layout Standard
1111 then try the following
1112 \end_layout
1113
1114 \begin_layout LyX-Code
1115 1.
1116  {}
1117 \end_layout
1118
1119 \begin_layout LyX-Code
1120    a) First alternative
1121 \end_layout
1122
1123 \begin_layout LyX-Code
1124    b) Second alternative
1125 \end_layout
1126
1127 \begin_layout LyX-Code
1128    c) Third
1129 \end_layout
1130
1131 \begin_layout Standard
1132 where {} is in ERT (i.e.
1133  a placeholder not generating output.
1134  Specifically, set the style to
1135 \begin_inset Quotes eld
1136 \end_inset
1137
1138 enumerate
1139 \begin_inset Quotes erd
1140 \end_inset
1141
1142 , enter the brackets in ERT, change the environment depth, and add the three
1143  elements.
1144  LyX will auto-label the entries.
1145 \end_layout
1146
1147 \begin_layout Subsubsection
1148 How do I count words in LyX?
1149 \end_layout
1150
1151 \begin_layout Standard
1152 Run a spellcheck; it will display the total number of words checked.
1153  Make sure the cursor is at the top of the document when you start the spellchec
1154 ker so that everything is counted.
1155 \end_layout
1156
1157 \begin_layout Subsubsection
1158 How do I insert a fixed amount of horizontal space?
1159 \end_layout
1160
1161 \begin_layout Standard
1162 There are various ERT commands to use:
1163 \family typewriter
1164
1165 \backslash
1166 enspace
1167 \family default
1168  (1/2 em),
1169 \family typewriter
1170
1171 \backslash
1172 thinspace
1173 \family default
1174  (1/6 em),
1175 \family typewriter
1176
1177 \backslash
1178 negthinspace
1179 \family default
1180  (-1/6 em),
1181 \family typewriter
1182
1183 \backslash
1184 quad
1185 \family default
1186  (1 em),
1187 \family typewriter
1188
1189 \backslash
1190 qquad
1191 \family default
1192  (2 em),
1193 \family typewriter
1194
1195 \backslash
1196 hspace{
1197 \emph on
1198 length
1199 \emph default
1200 }
1201 \family default
1202 , etc.
1203  An
1204 \begin_inset Quotes eld
1205 \end_inset
1206
1207 em
1208 \begin_inset Quotes erd
1209 \end_inset
1210
1211  is roughly the width of the letter
1212 \begin_inset Quotes eld
1213 \end_inset
1214
1215 m
1216 \begin_inset Quotes erd
1217 \end_inset
1218
1219  in the current font.
1220  The length argument of the
1221 \family typewriter
1222
1223 \backslash
1224 hspace
1225 \family default
1226  command is any valid TeX length; units can be
1227 \family typewriter
1228 mm
1229 \family default
1230  (millimeters),
1231 \family typewriter
1232 cm
1233 \family default
1234  (centimeters),
1235 \family typewriter
1236 in
1237 \family default
1238  (inches),
1239 \family typewriter
1240 pt
1241 \family default
1242  (points = 1/72 inch),
1243 \family typewriter
1244 em
1245 \family default
1246  (width of letter
1247 \begin_inset Quotes eld
1248 \end_inset
1249
1250 m
1251 \begin_inset Quotes erd
1252 \end_inset
1253
1254 ), or
1255 \family typewriter
1256 ex
1257 \family default
1258  (height of letter
1259 \begin_inset Quotes eld
1260 \end_inset
1261
1262 x
1263 \begin_inset Quotes erd
1264 \end_inset
1265
1266 ).
1267  Examples:
1268 \family typewriter
1269
1270 \backslash
1271 hspace{1in}
1272 \family default
1273 ,
1274 \family typewriter
1275
1276 \backslash
1277 hspace{2.5em}
1278 \family default
1279 , etc.
1280 \end_layout
1281
1282 \begin_layout Subsubsection
1283 How can I make citations show up as [1,2,3,6] or [1-3,6] rather than [1][2][3][6
1284 ]?
1285 \end_layout
1286
1287 \begin_layout Standard
1288 Insert
1289 \family typewriter
1290
1291 \backslash
1292 usepackage{cite}
1293 \family default
1294  into the LaTeX preamble.
1295  Most LaTeX distributions should have this package included.
1296  LyX supports this package, if you insert multiple citations separated by
1297  commas into the citation dialog, e.
1298  g.
1299  [Smalley_JCP,Jarrold_Sci], instead of just one citation after the other:
1300  [Smalley_JCP] [Jarrold_Sci].
1301 \end_layout
1302
1303 \begin_layout Subsection
1304 Figure related questions
1305 \end_layout
1306
1307 \begin_layout Subsubsection
1308 What is the difference between a
1309 \begin_inset Quotes eld
1310 \end_inset
1311
1312 figure
1313 \begin_inset Quotes erd
1314 \end_inset
1315
1316  and a
1317 \begin_inset Quotes eld
1318 \end_inset
1319
1320 figure float
1321 \begin_inset Quotes erd
1322 \end_inset
1323
1324 ?
1325 \end_layout
1326
1327 \begin_layout Standard
1328 This is an example of less-than-ideal terminology.
1329
1330 \begin_inset Quotes eld
1331 \end_inset
1332
1333 Figure
1334 \begin_inset Quotes erd
1335 \end_inset
1336
1337  is what I would really call a
1338 \begin_inset Quotes eld
1339 \end_inset
1340
1341 graphic
1342 \begin_inset Quotes erd
1343 \end_inset
1344
1345 ; it basically means insert a picture file.
1346
1347 \begin_inset Quotes eld
1348 \end_inset
1349
1350 Figure float
1351 \begin_inset Quotes erd
1352 \end_inset
1353
1354  is more what one means by a figure in a paper: it includes the graphic,
1355  the caption, the figure label, etc.
1356  You should almost always insert a figure float first, then put a figure
1357  inside that.
1358 \end_layout
1359
1360 \begin_layout Standard
1361 Tables work in the same manner.
1362  Put a table float in first, then insert the table within that.
1363 \end_layout
1364
1365 \begin_layout Subsubsection
1366 How do I get LyX to put the figure exactly where I want it?
1367 \end_layout
1368
1369 \begin_layout Standard
1370 Select
1371 \family sans
1372 Layout\SpecialChar \menuseparator
1373 Document
1374 \family default
1375 .
1376  In the
1377 \family sans
1378 Float Placement
1379 \family default
1380  box, type
1381 \begin_inset Quotes eld
1382 \end_inset
1383
1384
1385 \family typewriter
1386 !htp
1387 \family default
1388
1389 \begin_inset Quotes erd
1390 \end_inset
1391
1392 .
1393  This tells LaTeX to try really hard to put the figure here first, then
1394  the top of a page, then on a page by itself.
1395  This is a global setting: all figure will then obey this rule set.
1396 \end_layout
1397
1398 \begin_layout Standard
1399 If you want to control how each figure behaves, right-click in the figure
1400  float and you will get a dialog allowing to control the figure behavior.
1401 \end_layout
1402
1403 \begin_layout Subsubsection
1404 What does
1405 \begin_inset Quotes eld
1406 \end_inset
1407
1408 Too many unprocessed floats
1409 \begin_inset Quotes erd
1410 \end_inset
1411
1412  mean?
1413 \end_layout
1414
1415 \begin_layout Standard
1416 LaTeX can handle only a limited number of floating elements floating at
1417  a given time.
1418  For example, if Figure 4 can't be fit in a good location (using the default
1419  rules of top of the page, then bottom, then a page of its own) and Figure
1420  5 comes along, they will both continue to float toward the end of the document
1421  until a good location can be found.
1422  If nothing good turns up, they will just be placed at the end of the document.
1423  If there are too many of these, LaTeX overruns a counter and emits the
1424
1425 \begin_inset Quotes eld
1426 \end_inset
1427
1428 too many unprocessed floats
1429 \begin_inset Quotes erd
1430 \end_inset
1431
1432  error.
1433  This is not a bug in LaTeX, this is simply too many figures with too little
1434  text :-)
1435 \end_layout
1436
1437 \begin_layout Standard
1438 The easiest way to work around this is to insert a
1439 \family typewriter
1440
1441 \backslash
1442 clearpage
1443 \family default
1444  command somewhere in the document where a pagebreak would be appropriate.
1445  While a pagebreak would simply start a new page,
1446 \family typewriter
1447
1448 \backslash
1449 clearpage
1450 \family default
1451  processes all remaining floats, then begins a new page.
1452  This may lead to an unsightly stack of figures in the middle of your document;
1453  you may need to use several
1454 \family typewriter
1455
1456 \backslash
1457 clearpages
1458 \family default
1459  to make things balance nicely.
1460 \end_layout
1461
1462 \begin_layout Subsection
1463 Math related questions
1464 \end_layout
1465
1466 \begin_layout Subsubsection
1467 How do I put normal text inside a mathematical equation?
1468 \end_layout
1469
1470 \begin_layout Standard
1471 Type
1472 \begin_inset Quotes eld
1473 \end_inset
1474
1475
1476 \family typewriter
1477 M-m m
1478 \family default
1479
1480 \begin_inset Quotes erd
1481 \end_inset
1482
1483  while inside the equation to enter
1484 \begin_inset Quotes eld
1485 \end_inset
1486
1487 math text mode
1488 \begin_inset Quotes erd
1489 \end_inset
1490
1491 .
1492 \end_layout
1493
1494 \begin_layout Subsubsection
1495 How do I make a cube root (or higher)?
1496 \end_layout
1497
1498 \begin_layout Standard
1499 Type
1500 \begin_inset Quotes eld
1501 \end_inset
1502
1503
1504 \family typewriter
1505 M-m r
1506 \family default
1507
1508 \begin_inset Quotes erd
1509 \end_inset
1510
1511  to insert a nifty
1512 \begin_inset Quotes eld
1513 \end_inset
1514
1515 root box
1516 \begin_inset Quotes erd
1517 \end_inset
1518
1519 .
1520  Use the cursor keys to navigate the entry boxes.
1521 \end_layout
1522
1523 \begin_layout Section
1524 Questions Related to Running LyX
1525 \end_layout
1526
1527 \begin_layout Subsection
1528 How do I convert LyX files to LaTeX from the command line?
1529 \end_layout
1530
1531 \begin_layout Standard
1532 File export was vastly improved in version 1.1.6.
1533  Simply say
1534 \end_layout
1535
1536 \begin_layout LyX-Code
1537 lyx --export latex <yourfile>.lyx
1538 \end_layout
1539
1540 \begin_layout Standard
1541 and that is all you need to do.
1542 \end_layout
1543
1544 \begin_layout Standard
1545 If you have an older version of LyX, you can use the same syntax if you
1546  are running X, because it will cause LyX windows to pop up onto your screen.
1547  If you have the Xvfb command available, you can resort to a deeper level
1548  of subterfuge (under
1549 \family typewriter
1550 bash
1551 \family default
1552 ):
1553 \end_layout
1554
1555 \begin_layout Standard
1556
1557 \family typewriter
1558 (Xvfb :1 -once -terminate &); rm <file>.tex; lyx -display :1 --export latex
1559  <file>.lyx
1560 \end_layout
1561
1562 \begin_layout Standard
1563 \noindent
1564 Under csh/tcsh it is simply
1565 \end_layout
1566
1567 \begin_layout Standard
1568
1569 \family typewriter
1570 Xvfb :1 -once -terminate &; rm <file>.tex; lyx -display :1 --export latex
1571  <file>.lyx
1572 \end_layout
1573
1574 \begin_layout Standard
1575 \noindent
1576 This should work anywhere, whether or not X is actually running.
1577 \end_layout
1578
1579 \begin_layout Subsection
1580 How do I create PDF files from my LyX document?
1581 \end_layout
1582
1583 \begin_layout Standard
1584 Read Section 5.3.6 of the
1585 \emph on
1586 Extended Features
1587 \emph default
1588  manual.
1589 \end_layout
1590
1591 \begin_layout Subsection
1592 Why do the fonts in my document look so bad in
1593 \family typewriter
1594 acroread
1595 \family default
1596  ?
1597 \end_layout
1598
1599 \begin_layout Standard
1600 The problem and the solution are also discussed in Section 5.3.6 of the
1601 \emph on
1602 Extended Features
1603 \emph default
1604  manual.
1605 \end_layout
1606
1607 \begin_layout Subsection
1608 Why doesn't my latest and greatest version of Ghostscript render EPS inline
1609  figures properly?
1610 \end_layout
1611
1612 \begin_layout Standard
1613 [Note: this only applies to versions of LyX older than 1.2.0, since the graphics
1614  rendering code has been rewritten in this version]
1615 \end_layout
1616
1617 \begin_layout Standard
1618 A couple of users reported that they couldn't get recent Ghostscript versions
1619  to display inline figures in LyX.
1620  It transpires that this is a Ghostscript bug:
1621 \end_layout
1622
1623 \begin_layout Standard
1624 \begin_inset LatexCommand url
1625 target "http://sourceforge.net/bugs/?func=detailbug&bug_id=124957&group_id=1897"
1626
1627 \end_inset
1628
1629
1630 \end_layout
1631
1632 \begin_layout Standard
1633 \noindent
1634 This bug appears to affect Ghostscript 6.22 and upwards.
1635  After applying the above mentioned patch, rendering in Lyx works fine again.
1636  GNU Ghostscript 6.53 and above include this fix.
1637 \end_layout
1638
1639 \begin_layout Section
1640 Questions Related to LyX on Windows
1641 \end_layout
1642
1643 \begin_layout Subsection
1644 Why do the menus and the toolbar flicker ?
1645 \end_layout
1646
1647 \begin_layout Standard
1648 You are probably using the XWin32 X server.
1649  This is a bug in XWin32: you can work around the problem by disabling the
1650
1651 \begin_inset Quotes eld
1652 \end_inset
1653
1654 Use Reserved Colors
1655 \begin_inset Quotes erd
1656 \end_inset
1657
1658  option of XWin32, and using a color mode other than PseudoColor.
1659 \end_layout
1660
1661 \begin_layout Section
1662 How to get further assistance
1663 \end_layout
1664
1665 \begin_layout Subsection
1666 You still haven't answered my question!
1667 \end_layout
1668
1669 \begin_layout Standard
1670 Then RTFM, especially the Tutorial.
1671  The documentation really is quite good.
1672  (Besides, I helped write parts of it :-) If you think your problem may
1673  be LaTeX related, then look in
1674 \emph on
1675 LaTeX, A Document Preparation System, 2nd Ed.
1676
1677 \emph default
1678  by Leslie Lamport (1994).
1679  There are also numerous example files included with LyX.
1680  Try
1681 \family sans
1682 File\SpecialChar \menuseparator
1683 Open\SpecialChar \menuseparator
1684 Examples
1685 \family default
1686 .
1687 \end_layout
1688
1689 \begin_layout Subsection
1690 I want to mail someone about my problem.
1691
1692 \end_layout
1693
1694 \begin_layout Standard
1695 Send email to the LyX Users list lyx-users@lists.lyx.org.
1696  If LyX is actually crashing or otherwise non-functional, then try the developer
1697 s' list at lyx-devel@lists.lyx.org.
1698 \end_layout
1699
1700 \begin_layout Subsection
1701 What to put in a request for help.
1702 \end_layout
1703
1704 \begin_layout Standard
1705 Include your version of LyX and a description of what you are trying to
1706  do, along with evidence that you've actually read the docs.
1707 \end_layout
1708
1709 \begin_layout Standard
1710 If LyX has crashed, include the version of LyX, the operating system, the
1711  version of xforms (if it seems to be a screen drawing problem), and a precise
1712  description of the events that lead to the crash.
1713  The easier it is for the developers to reproduce your crash, the more likely
1714  it will get fixed.
1715  If you're brave and like to hack, use gdb to generate a backtrace and include
1716  the results with your mail.
1717  If you have no clue what I'm talking about, just describe what you did
1718  as completely as you can.
1719 \end_layout
1720
1721 \begin_layout Section
1722 Administrative information and acknowledgments
1723 \end_layout
1724
1725 \begin_layout Subsection
1726 Feedback is invited.
1727
1728 \end_layout
1729
1730 \begin_layout Standard
1731 Send comments, suggested additions, world record document claims, etc.
1732  to
1733 \emph on
1734 lyx-docs@lists.lyx.org.
1735 \end_layout
1736
1737 \begin_layout Subsection
1738 Formats in which this FAQ is available.
1739
1740 \end_layout
1741
1742 \begin_layout Standard
1743 The LyX file original is included in the LyX source distribution, converted
1744  versions in HTML and ASCII should soon be available at the website.
1745  A German version is also available with the distribution.
1746 \end_layout
1747
1748 \begin_layout Subsection
1749 Authorship and acknowledgments.
1750 \end_layout
1751
1752 \begin_layout Standard
1753 Bernhard Iselborn, David Johnson, and Paul Evans were responsible for the
1754  FAQ through version 0.2.2 which covered LyX-0.10.7.
1755  The FAQ as of version 0.3.0 was written from scratch and covers LyX-1.0 and
1756  higher.
1757  Many people contributed pieces to the current version; Mike Ressler of
1758  the Doc Team collected them into this file.
1759 \end_layout
1760
1761 \begin_layout Subsection
1762 Disclaimer and Copyright.
1763
1764 \end_layout
1765
1766 \begin_layout Standard
1767 I don't claim anything in this document is accurate to within a factor of
1768
1769 \begin_inset Formula $\pi$
1770 \end_inset
1771
1772 ; after all, I'm just an astronomer, and we like to set
1773 \begin_inset Formula $c=h=k=\pi=1$
1774 \end_inset
1775
1776 .
1777  When the answer is wrong, we just redefine the units.
1778  This file is distributed in the hope that it will be useful, but WITHOUT
1779  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
1780  FOR A PARTICULAR PURPOSE.
1781  See the GNU General Public License for more details.
1782  In other words, it's not my fault if you lose your dissertation the night
1783  before your doctoral defense because you forgot to save it before the power
1784  failed while wondering how a fundamental physical constant expressed in
1785  units of
1786 \begin_inset Formula $\textrm{m s}^{-1}$
1787 \end_inset
1788
1789  could possibly be equal to one expressed as
1790 \begin_inset Formula $\textrm{kg m s}^{-2}\textrm{ K}^{-1}$
1791 \end_inset
1792
1793 .
1794  This file is Copyright © 2000 by Michael E.
1795  Ressler on behalf of the LyX Documentation Team.
1796 \end_layout
1797
1798 \end_body
1799 \end_document