trunk/base/bugs.txt

   1                          LaTeX Error Reports
   2
   3                            28 March 2005
   4
   5 ERROR REPORTS
   6
   7 Before you report an error, please check that:
   8
   9   * Your LaTeX system is not too old, i.e., your version is the
  10     current or the previous release. Information about the latest
  11     release can be found at http://www.latex-project.org/ltnews/.
  12
  13  * The error is not already mentioned in the documentation of the
  14    distribution, e.g. in a .dtx file (in this case it is a feature :-).
  15
  16  * The error has not already been reported.  If you have WWW
  17    access, you can search the LaTeX bugs database using this URL:
  18
  19      http://www.latex-project.org/bugs.html
  20
  21  * The error is not caused by software other than the core LaTeX
  22    software that is produced and maintained by the LaTeX3 project
  23    team. please report problems with other software to the authors
  24    or suppliers of that software, and not to us!
  25
  26    Thus you should check that the problem is not caused by, for
  27    example, the viewer or printing software you use.
  28
  29    Also, the test file demonstrating the error should not use any
  30    classes or packages other than those authored and supported by the
  31    LaTeX3 team.  The files for the package or class will tell you how
  32    it is supported.
  33
  34  * The error is not caused by using an obsolete version of any file or
  35    of other software.
  36
  37  * You are using the original version of all files, not one that has
  38    been modified elsewhere.
  39
  40 If you think you have found a genuine bug in a recent version of the
  41 core LaTeX software, please report it in the following way:
  42
  43  * Prepare a *short* test file, as described above, that clearly
  44    demonstrates your problem; see below for a discussion of `short'.
  45
  46  * Run this file through latex to obtain the transcript file
  47    (often .log) since you will need to submit this file also.
  48
  49  * There are two ways to submit a bug report:
  50     a) Submit the test and transcript files through the Web interface at:
  51
  52          http://www.latex-project.org/bugs-upload.html
  53
  54     Please fill in all required fields; in particular, make sure
  55     that your name, email address, and the summary description
  56     are correct.
  57
  58     b) Submit your bug report by electronic mail. To do this, you need to
  59
  60     * Generate a bug report template by running the file
  61       latexbug.tex through LaTeX.
  62
  63     * Fill in the spaces in the generated template file. Please note that
  64       the reporting language is *English*, irregardless of the fact that
  65       the address you are sending the bug report to might not be in an
  66       English speaking country. Reports received in a language other than
  67       English might not be understandable to the person currently
  68       looking at bug reports!
  69
  70     * Include all necessary information, especially a complete input
  71       file, a complete transcript file, and all other files used (if they
  72       are not standard).
  73
  74       Please check carefully to ensure that any non-standard files are
  75       essential to the bug; and remember that we cannot debug files not
  76       supplied by us.
  77
  78       Any such non-standard files should be included in a `filecontents'
  79       environment at the start of your input file!  This allows us to
  80       run your test file without a lot of manual preparation; this is
  81       essential since we have to deal with many reports, not just with
  82       the one written by you.
  83
  84     * Please note that it is important to make the input file as short
  85       as possible since this will enable us to find and fix the error
  86       quickly.  It also helps us because then we can often use it as a test
  87       file for future releases.
  88
  89       We would expect most files to be less than 60 lines, and very
  90       rarely to be longer than 100 lines.
  91
  92       This can often be achieved by defining a command to be some
  93       arbitrary text and using this several times if it is necessary
  94       to generate longer bits of text.
  95
  96    Error reports concerning UNCHANGED versions of CORE LaTeX files
  97    which are less than five years old should be sent by E-mail to:
  98
  99      latex-bugs@latex-project.org
 100
 101 You will receive an acknowledgement by E-mail containing at the
 102 beginning of its subject line a problem reference of the form
 103 category/number:, e.g. latex/1234:. Please use this subject line in ALL
 104 further E-mails concerning the problem. Otherwise your reply will be
 105 categorized and filed separately from the original.
 106
 107
 108 LAYOUT PROBLEMS
 109
 110 If you think you have found a bug or some problematic behavior that
 111 has been present in LaTeX for a long time (e.g., it was already in
 112 LaTeX 2.09) you are, of course, equally welcome to report this, using
 113 the above procedure.  However, please note that we will normally not
 114 change layout decisions made in the LaTeX standard classes (which are
 115 derived from their 2.09 counterparts); nor will we change layout
 116 decisions or the behaviour of core commands, even when these are
 117 questionable from a typographic point of view, since such changes
 118 would make thousands of documents invalid.  See also the file
 119 ltnews07.tex with regard to this policy.
 120
 121
 122
 123 DOCUMENTATION ERRORS
 124
 125 If you find an error in one of the following books:
 126
 127  TITLE                     Author                         Errata File
 128
 129  The LaTeX Manual, 2ed     Lamport                        manual.err
 130  The LaTeX Companion, 2ed  Mittelbach, Goossens, et al    tlc2.err
 131  The LaTeX Graphics
 132      Companion             Goossens, Mittelbach, Rahtz    grphcomp.err
 133  Der LaTeX Begleiter, 2ed  Mittelbach, Goossens, et al    lb2.err
 134  The LaTeX Web Companion   Goossens, Rahtz                webcomp.err
 135
 136
 137 then please check first whether it is already mentioned in the errata
 138 file for that book (these files are part of the LaTeX distribution).
 139 If this is not the case then please report the error to the address
 140 given in that corresponding errata file.
 141
 142 Please *do not* send such reports to the latex-bugs address.
 143
 144
 145 --- Copyright 1997,1998,2006,2008 the LaTeX3 project.  All rights reserved ---
 146
 147