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