lib/doc/BUGS.lyx

   1 #This file was created by <lasgoutt> Thu Jul  1 15:12:26 1999
   2 #LyX 1.0 (C) 1995-1999 Matthias Ettrich and the LyX Team
   3 \lyxformat 2.15
   4 \textclass article
   5 \language default
   6 \inputencoding default
   7 \fontscheme default
   8 \graphics default
   9 \paperfontsize default
  10 \spacing single
  11 \papersize Default
  12 \paperpackage a4
  13 \use_geometry 0
  14 \use_amsmath 0
  15 \paperorientation portrait
  16 \secnumdepth 3
  17 \tocdepth 3
  18 \paragraph_separation indent
  19 \defskip medskip
  20 \quotes_language english
  21 \quotes_times 2
  22 \papercolumns 1
  23 \papersides 1
  24 \paperpagestyle default
  25
  26 \layout Title
  27
  28 Known BUGS in LyX
  29 \layout Date
  30
  31 Last updated 1999-07-01
  32 \layout Standard
  33
  34 This file contains a compilation of bug reports that have been sent to the
  35  mailing list
  36 \family sans
  37 lyx-devel@lists.lyx.org
  38 \family default
  39 .
  40  We try to keep it up to date as far as possible, but of course it's better
  41  to spend time fixing bugs instead of archiving them.
  42  Since we cannot reproduce all of these bugs, please send us any details
  43  and updates and, of course, fixes.
  44 \layout Section
  45
  46 How do I submit a bug report?
  47 \layout Standard
  48
  49 All bug reports should always include information about which versions of
  50  LyX the bug appears in (you will be surprised to know how many forget that
  51  information).
  52  Try to get the latest version of LyX and see if the problem still exist
  53  before complaining.
  54  New releases will typically contain bug fixes :-)
  55 \layout Standard
  56
  57 Remember: the less time the developers have to spend to understand and fix
  58  a problem, the faster the problem is likely to be fixed.
  59 \layout Standard
  60
  61 Other than that, the good bug report is characterized by including
  62 \emph on
  63 all
  64 \emph default
  65  relevant information and only that.
  66  It's always relevant what the problem is, and how the problem is triggered.
  67  If it's a compilation problem, include
  68 \family typewriter
  69 \size small
  70 config.log
  71 \family default
  72 \size default
  73  and information about your system (
  74 \family typewriter
  75 \size small
  76 uname -a
  77 \family default
  78 \size default
  79 ), which compiler you use, versions of libraries and so on.
  80 \layout Standard
  81
  82 If you found a bug that causes LyX to crash, please take the time to produce
  83  a backtrace with a non-stripped lyx executable.
  84  The one built in the source directory is per default not stripped, while
  85  the installed binary is stripped.
  86  So, run LyX from gdb by typing
  87 \begin_inset Quotes eld
  88 \end_inset
  89
  90
  91 \family typewriter
  92 \size small
  93 gdb /users/bozo/lyx-1.0.x/src/lyx
  94 \family default
  95 \size default
  96
  97 \begin_inset Quotes erd
  98 \end_inset
  99
 100  and then
 101 \begin_inset Quotes eld
 102 \end_inset
 103
 104
 105 \family typewriter
 106 \size small
 107 run
 108 \family default
 109 \size default
 110
 111 \begin_inset Quotes erd
 112 \end_inset
 113
 114 .
 115  Make LyX crash and you'll return to gdb.
 116  Use
 117 \begin_inset Quotes eld
 118 \end_inset
 119
 120
 121 \family typewriter
 122 \size small
 123 bt
 124 \family default
 125 \size default
 126
 127 \begin_inset Quotes erd
 128 \end_inset
 129
 130  to produce a backtrace and include the output in the bug report
 131 \begin_float footnote
 132 \layout Standard
 133
 134 if you want to be thorough, use the
 135 \latex no_latex
 136
 137 \begin_inset Quotes eld
 138 \end_inset
 139
 140 info locals
 141 \begin_inset Quotes erd
 142 \end_inset
 143
 144  and
 145 \begin_inset Quotes eld
 146 \end_inset
 147
 148 up
 149 \begin_inset Quotes erd
 150 \end_inset
 151
 152  commands to print out the values of local variables at a few stack levels.
 153 \end_float
 154 .
 155  If possible, then a description of a way to reproduce the bug is more important
 156  than a backtrace, because then we have the possibility to roll our own
 157  backtrace.
 158  If the bug is not easily reproducible, a backtrace is essential, because
 159  then that might be all we've got.
 160 \layout Standard
 161
 162 Bug reports should be mailed to the developer's list at
 163 \family sans
 164  lyx-devel@lists.lyx.org
 165 \family default
 166 .
 167  However to avoid that we get cluttered with the same bug reports from many
 168  people, we recommend that you either check the archive of the developer's
 169  mailing list at
 170 \family typewriter
 171 http://www.mail-archive.com/lyx-devel@lists.lyx.org/
 172 \family default
 173  or subscribe to the list first.
 174  If you want to be a real sport, you provide a patch along with the bug
 175  report.
 176 \layout Section
 177
 178 Bugs
 179 \layout Enumerate
 180
 181 The LyX keyboard mappings, including dead-keys, do not work in pop-up dialogs.
 182  You can try cut & paste from a text editor.
 183 \layout Enumerate
 184
 185 It is not possible to enter
 186 \family typewriter
 187
 188 \backslash
 189 dj{}
 190 \family default
 191  or
 192 \family typewriter
 193
 194 \backslash
 195 DJ{}
 196 \family default
 197  as LaTeX accent insets; this means that these characters are not available
 198  to people who want to use latin1 as encoding.
 199 \layout Enumerate
 200
 201 On a very small (
 202 \begin_inset Formula \( 640\times 480 \)
 203 \end_inset
 204
 205 ?) screen, math panel pops up the subpanels off screen.
 206  It should check it's position, and put the panels somewhere visible.
 207 \layout Enumerate
 208
 209
 210 \family sans
 211 Options\SpecialChar \menuseparator
 212 Keyboard
 213 \family default
 214  has no
 215 \family sans
 216 Apply
 217 \family default
 218  and
 219 \family sans
 220 Cancel
 221 \family default
 222  buttons.
 223  [
 224 \emph on
 225 Note from Asger: Well, I think the entire form should be redesigned, such
 226  that it isn't dynamic.
 227  Also, it should not be possible to select a non-existing keyboard mapping.
 228  In other words, the drop-down list should show exactly those that are available.
 229  Similarly, the charset definition should be a droplist too.
 230
 231 \emph default
 232 ]
 233 \layout Enumerate
 234
 235 The vertical scroll bar of the preamble window is broken.
 236  If you resize the window, strange things can happen, including a fatal
 237  crash! This is a bug in XForms.
 238  [
 239 \emph on
 240 Note from Jean-Marc: things are a bit better now, but not perfect.
 241
 242 \emph default
 243  ]
 244 \layout Enumerate
 245
 246 Navigation by table of contents (ToC) is limited by Section Number Depth,
 247  rather than ToC Depth.
 248  If you have Section Number Depth of 1, but ToC of 2, clicking on any of
 249  the numbered sections takes you to the right point in the document.
 250  But clicking on a (unnumbered) Subsection takes you to the beginning of
 251  the Section, rather than to the subsection.
 252 \layout Enumerate
 253
 254 If you have a footnote (or margin note) in a section heading, the text after
 255  this not will not appear in the ToC popup.
 256 \layout Enumerate
 257
 258 When several insets are placed consecutively (this can happen with error
 259  insets), clicking on an inset can result in opening the wrong one.
 260  A workaround is to use
 261 \family sans
 262 C-o
 263 \family default
 264 , with the cursor placed just before the desired inset.
 265 \layout Enumerate
 266
 267 The
 268 \family sans
 269 Citation Reference
 270 \family default
 271  command doesn't escape
 272 \begin_inset Quotes eld
 273 \end_inset
 274
 275
 276 \family typewriter
 277 _
 278 \family default
 279
 280 \begin_inset Quotes erd
 281 \end_inset
 282
 283  characters in the remarks field when generating TeX documents.
 284  You have to type
 285 \begin_inset Quotes eld
 286 \end_inset
 287
 288
 289 \family typewriter
 290
 291 \backslash
 292 _
 293 \family default
 294
 295 \begin_inset Quotes erd
 296 \end_inset
 297
 298  by hand in these remarks if you want to use an underscore.
 299  Similar for other special characters.
 300 \layout Enumerate
 301
 302 If a figure is larger than one page down press would have taken you, the
 303  page down fails and you are left where you started.
 304  [
 305 \emph on
 306 Comment: behavior in this situation is improved but still imperfect.
 307  LyX now does the pageup or pagedown, but jumps from the top to the bottom
 308  of the figure, potentially skipping part of the middle.]
 309 \layout Enumerate
 310
 311 If you delete marked text, the text is not deleted, but
 312 \begin_inset Quotes eld
 313 \end_inset
 314
 315 cut
 316 \begin_inset Quotes erd
 317 \end_inset
 318
 319 , which deletes the current text in the clipboard.
 320 \layout Enumerate
 321
 322 Sometimes, when you delete large sections of text, the screen will appear
 323  empty, and you have to use the scrollbar to make the cursor visible again.
 324 \layout Enumerate
 325
 326 You can not export a selection from LyX to another X11 program.
 327  Not even between two instances of LyX.
 328  You can only paste into LyX using the middle mouse button.
 329
 330 \layout Enumerate
 331
 332 If you have edited and then undo all changes, then the
 333 \begin_inset Quotes eld
 334 \end_inset
 335
 336 Changed
 337 \begin_inset Quotes erd
 338 \end_inset
 339
 340  status is not reset.
 341 \layout Enumerate
 342
 343 If you have a margin note in itemize text and the first paragraph of the
 344  margin note is also itemize text it is possible to
 345 \begin_inset Quotes eld
 346 \end_inset
 347
 348 depth-increment
 349 \begin_inset Quotes erd
 350 \end_inset
 351
 352  and make the first itemize paragraph in the margin note deeper on-screen
 353  even though LaTeX doesn't permit this (and ignores this).
 354
 355 \layout Enumerate
 356
 357 A table which is larger than the screen manages to go outside the red lines
 358  drawn by a table float.
 359  Same goes for figures.
 360  A similar thing can happen with large mathematical equations.
 361  Resize your LyX window.
 362 \layout Enumerate
 363
 364 It is not possible to include footnotes in tables.
 365
 366 \layout Enumerate
 367
 368 The numbering policy of LyX does not exactly match what LaTeX does for sections:
 369  for example, LyX resets subsection
 370 \emph on
 371 and
 372 \emph default
 373  subsubsection counters at a new section, while LaTeX does not reset the
 374  subsubsection counter.
 375  As a workaround, you can add
 376 \family typewriter
 377
 378 \backslash
 379 setcounter{subsubsection}{0}
 380 \family default
 381 , marked as TeX, just after the section heading.
 382 \layout Enumerate
 383
 384 LyX is not able to render correctly
 385 \family sans
 386 Paragraph
 387 \family default
 388  and
 389 \family sans
 390 SubParagraph
 391 \family default
 392  headings which, in standard LaTeX classes, are just placed at the start
 393  of the following paragraph.
 394  This can be confusing.
 395 \layout Enumerate
 396
 397 LyX sometimes gets caught by TeX fonts ligatures: for example, in the sentence
 398
 399 \begin_inset Quotes eld
 400 \end_inset
 401
 402 He said 'Hello!'
 403 \begin_inset Quotes erd
 404 \end_inset
 405
 406 , the single and double closing quotes come out inverted (just try to preview
 407  this paragraph).
 408  The only sollution is to write it as
 409 \begin_inset Quotes eld
 410 \end_inset
 411
 412 He said 'Hello!'
 413 \latex latex
 414
 415 \backslash
 416 textcompwordmark
 417 \latex default
 418
 419 \begin_inset Quotes erd
 420 \end_inset
 421
 422 , which is admittedly not very nice.
 423 \layout Enumerate
 424
 425 When going into math text mode (which results in
 426 \family typewriter
 427
 428 \backslash
 429 mathrm{}
 430 \family default
 431  in the LaTeX output) it is impossible to enter punctuation, as this is
 432  always put back into math mode.
 433 \layout Enumerate
 434
 435 If a LaTeX command is partially bold, it doesn't generate correct LaTeX
 436  commands.
 437  LaTeX commands written using the LaTeX layout or the LaTeX font state should
 438  always use the standard font (this means no font changing commands should
 439  be allowed).
 440  Don't use font changing commands when you are in LaTeX mode.
 441 \layout Enumerate
 442
 443 If you change font in a special word (like in
 444 \begin_inset Quotes eld
 445 \end_inset
 446
 447
 448 \bar under
 449 L
 450 \bar default
 451 aTeX
 452 \begin_inset Quotes erd
 453 \end_inset
 454
 455 ), the whole word will have the font of the first character in dvi output.
 456  This can be solved by using for example
 457 \begin_inset Quotes eld
 458 \end_inset
 459
 460
 461 \bar under
 462 L
 463 \bar default
 464 \latex latex
 465 {}
 466 \latex default
 467 aTeX
 468 \begin_inset Quotes erd
 469 \end_inset
 470
 471 , thus disabling the automatic translation to the macro
 472 \family typewriter
 473
 474 \backslash
 475 LaTeX
 476 \family default
 477 .
 478 \layout Enumerate
 479
 480 In a LyX-Code environment, you can't have an empty line.
 481  You'll have to type a single space to make it work.
 482 \layout Enumerate
 483
 484 In LyX-Code and in paragraphs written completely using the typewriter font,
 485  all spaces are protected so that LaTeX isn't able to perform correct formatting
 486  of the text.
 487  You'll have to insert linebreaks manually.
 488 \layout Enumerate
 489
 490 It is possible to use the subfigure style to get two small figures (side-by-side
 491 ), each with a caption and label, and then a common caption and label for
 492  the entire figure.
 493  LyX currently seems to support this in the pop-up menu for an eps figure.
 494  However, I am unable to successfully add labels to each of the subfigures.
 495  If I insert a label next to each subfigure, the labels appear fine and
 496  can be cross-referenced in the usual manner.
 497  However, the actual output (dvi or ps) does not distinguish between the
 498  two labels and any cross-reference gets the same number.
 499  You have to use plain old raw LaTeX mode and do this by hand.
 500 \layout Enumerate
 501
 502 If you close a document while some included images are still in the rendering
 503  phase, all images in newly opened documents will stay in the rendering
 504  phase, making it impossible to preview or print the document.
 505  You can't fix this by killing gs-processes, because there aren't any.
 506  You'll have to restart LyX to work with figures again.
 507 \layout Enumerate
 508
 509 If you preview an empty document, no dvi-file will be created, and xdvi
 510  will not start.
 511  We should present a kind warning to the user rather than be silent.
 512 \layout Enumerate
 513
 514 Document that includes others: if LaTeX reports an error during the execution
 515  of LaTeX on a sub-document as a chain reaction of executing LaTeX on a
 516  higher level document, LyX places the error window on the correct position
 517  of the higher level doc, not of the lower one.
 518  There might be some spurious document corruption effects related to this.
 519  Be careful with raw LaTeX in sub-documents.
 520 \the_end