Bug ReportReporting bugs helps to improve software, which is great. Unfortunately, fixing bugs is time-consuming. I'm self-employed and my income mostly comes from book sales. This means writing, producing and marketing those books must take priority over unpaid work, which includes developing free software, so please don't expect a rapid response. Please read the notes below before submitting a bug report.
- Please only list one issue per bug report. If you mention more than one issue, the report may be prematurely closed before all issues are fixed.
- Check the bug tracker to see if the bug has already been reported. Also check the FAQs.
- Check you are using the latest version. (You can find the latest version number on the CTAN package listing or on the application's home page.)
- If you want to report a typo in the documentation please use the report a typo form.
- If you want to request a feature please use the feature request form instead.
- If you have found an error in one of the sample files accompanying a package, you can use that file as the MWE when using this form, but make sure you have the latest version of the package installed in case you have picked up a sample file accompanying a new version.
- If you're in an urgent hurry for a fix, post a query on a site such as TeX on StackExchange or the LaTeX Community to ask for a workaround. It's possible that someone there might be able to provide a patch until the bug is fixed. You can include a link to the post in your message.
- If you are reporting a bug for a LaTeX class or package, this form will require
a Minimal Working Example (MWE) that demonstrates the bug. This must be a short self-contained
LaTeX document with all unnecessary packages and commands removed, as described in
Creating a LaTeX minimal example. You will also need to upload the corresponding .log file.
So make sure you have both files prepared before using this form. (A MWE is optional for bug reports for applications.)
The MWE file will be named mwe.tex (mwe.log, correspondingly) when it is saved to ensure no problematic characters appear in the file name, so use \jobname if you need to reference the file name in the document.
- Avoid the use of internal commands (commands that contain the @ symbol) in your MWE. If a user command doesn't behave as documented, then it's a bug. Internal commands are not intended for use in the document and their behaviour may change and this generally won't be considered a bug if it doesn't affect any of the user commands. If you can't find a user command that does what you want, consider posting a feature request.
- The bug report will be checked for spam before being added to the bug tracker. After this you will receive an email with a link to the
bug report. Since I'm not online 24/7 there may be some delay before this happens. (If the online store is closed,
then it's likely that I have limited or no Internet access for a while.) Once the email has been sent, your email address will be automatically
removed from the records. If you want to be updated on the report's progress you need to explicitly opt-in using the "Watch This Report"
form in the bug tracker. Your details won't be passed on to any third parties as per this site's
You don't have to provide your email any more but, if you don't supply it, you won't know when your report has been logged and you will have to keep searching for it until it turns up in the bug tracker.
- glossaries language support: as from version 4.12, the glossaries language support has been separated into independent language modules. You need to install the appropriate language module in addition to installing/upgrading the glossaries package. (You should see a warning message in the transcript if the required module is missing when you build your document.) If you have found a bug in a language module, please report it to the maintainer of that module. If there is no maintainer, you can volunteer using the contact form. I can't arbitrate over issues regarding languages that I can't speak. If the language module is unmaintained I will fix any syntactic errors that cause the LaTeX run to fail, but I won't make any other modifications. If you ignore this and send in a bug report for a language module that involves issues with translations or language styles, the report will be closed or deleted. Each individual language module is quite small, so please consider volunteering.
- Likewise for the datetime2.sty language support.
You may cross-reference another bug report using the "Link to bug report(s)" field (optional).
Page 1 of 3Is the problem with an application or a LaTeX Package/Class? For example:
- If something goes wrong when you are running makeglossaries, but not if you explictly call makeindex or xindy with the options manually set, then the problem is with the application.
- If something goes wrong when you are using datatooltk (either in batch or GUI mode) then the problem is with the application.
- If LaTeX code generated by an application such as makeglossaries or datatooltk causes a problem when it's input into your document and you're not sure if the problem is with the application or package, then select application and provide a MWE. If it turns out to be a problem with the package I can switch the category later.