Errers

=================

Added
-----
- Add rules for commands:
- | core:
| \\a, \\RequirePackage,
| \\pagestyle, \\thispagestyle,
| \\verb (replaced by ||)
- | amsthm:
| \\newtheoremstyle, \\theoremstyle
- | glossaries:
| \\setacronymstyle, \\loadglsentries
- | listings:
| \\lstinline (replaced by ||)
- | tikz:
| \\tikzset, \\tikzstyle
- Add rules for environments:
- | core:
| tabbing,
| verbatim (omit content)
- | listings:
| lstlisting (omit content)
- Add rules for classes:
- | drdc:
| \\rank
- Add rules for following ligatures: ff, fi, fl, ffi, and ffl (not
LaTeX-specific).
- Support creation of application shortcuts on macOS and Linux.
- Names of capturing groups for content of %c, %C, %s, and %r placeholders can
be specified explicitly by placing empty named capturing group after
placeholder; for instance: '%c(?P<custom_name>)'.

Changed
-------
- Improve reporting of runtime exceptions during shortcut creation.
- Referring to capturing groups by index in replacement patterns no longer
supported when using %c, %C, %s, and %r placeholders.
- Make \\author command of drdc document class an alias of its \\authors
command.
- Split setup rule function into three: core_insertion, core_removal and
core_setup.
- Rename core, cleanup_braces, and cleanup rule functions as core_main,
core_cleanup_braces, and core_cleanup, respectively.
- Add suffix to name of class, package, and style rule functions to indicate
when they are to be applied: insertion, removal, setup, main, and cleanup.
- Add optional phase argument to document rules to specify when they are to be
applied: insertion, removal, setup, main, and cleanup.
- Log names of rule functions as they are run.
- Rename not_in_comment argument of rule functions as not_commented. Add a
similar not_escaped argument.
- Replace delatexify-shortcuts by --shortcuts option to help with command
autocompletion at command line.

Fixed
-----
- Allow matching of non-bracketed content, with %C placeholder, before closing
curly bracket.
- Add space after colon in rule for \\item[].
- Support starred versions of align, alignat, flalign, gather, and multline
environments of amsmath package.
- Remove call to Path.with_stem method in processing of "Copy Log" button,
because it was introduced in Python 3.9.
- Remove white padding on left and right sides of shortcut window.
- Process rules for math environments earlier (setup phase rather than main) to
prevent automatic rules from inserting dollar signs into them before their
removal.
- Fix output of number of matches to times file.
- Replace \\i with a regular i rather than a dot-less i, because the latter
does not compose properly with accents.
- Move rules for \\url command to removal phase so URLs with % characters are
processed correctly.
- Omit space before percent signs to avoid issues in URLs.
- Modify rules for printing glossaries and indexes so all entries are printed
with re module even when more than two levels of curly braces are present.
- Fix bug in default rule for one-argument commands that made it match the
first argument of multi-argument commands when using re module.
- Replace \\clearpage, \\cleardoublepage, and \\newpage by two newlines rather
than just removing them.
- Detect language before checking grammar when opening converted text in
Microsoft Word.
- Run launch of Microsoft Word and creation of shortcuts in other threads so
busy cursor is displayed.

=================

Added
-----
- Add rules for commands:
- | core:
| \\( \\) \\[ \\] \\{ \\} \\>
| \\MakeLowercase, \\MakeUppercase,
| \\clearpage, \\cleardoublepage, \\newpage, \\enlargethispage,
| \\Huge, \\huge, \\LARGE, \\Large, \\large, \\normalsize,
| \\small, \\footnotesize, \\scriptsize, \\tiny,
| \\numberwithin, \\newtheorem
- | acronym:
| \\acrodef
- | graphics and graphicx:
| \\DeclareGraphicsRule
- | makeidx package:
| \\index, \\printindex
- Add rules for environments:
- | core:
| math
- Log number of times each remaining command appears in converted text.

Changed
-------
- Sort entries generated by glossaries package.
- In convert function, allow LaTeX input to be specified as string or path.

Fixed
-----
- Process commands inserting reserved characters during cleanup rather than
setup.
- Recognize command names composed of non-letters when identifying braces that
do not encapsulate command arguments.
- Replace tilde by space only if not preceded by backslash.
- When matching percent signs (for comments), check if character matched by
rule is preceded by one, two or three backslashes rather than checking only
for a single backslash.
- Fix bug in calculation of minimum window height.

=================

Added
-----
- Add "Copy" button that copies converted text to clipboard.
- Create rules automatically for commands defined in LaTeX document using
\\def, \\edef, \\gdef, and \\xdef.
- Add initial support for package: glossaries.
- Add rules for the following spacing commands in setup:
| \\, \\: \\; \\!,
| \\thinspace, \\medspace, \\thickspace,
| \\negthinspace, \\negmedspace, \\negthickspace
- Add rules for more accents.
- Add rule that replaces %m by pattern that matches the name of LaTeX commands
("m" stands for "macros").
- Add rule that replaces %C by pattern that matches non-bracketed LaTeX command
or character in addition to matching arbitrary content in curly brackets.
- Replace %c by %C in most rules.
- Add option to create a %o-patterns.txt file that lists the expanded
matching patterns (%o = stem of output file name).
- Report location of error in replacement string when available. (This was
already done for matching patterns.)
- Provide function to create pattern and rule classes for users who would like
to experiment with them outside of DeLaTeXify.
- Log document rules as they are read.

Changed
-------
- Replace "Shortcuts" button with separate application.
- Replace "Email log" button with "Copy log", which copies log to clipboard.
- Reduce size of conversion log and move it to the left of the GUI, while
moving the controls to the right, to reduce window size -- which was an issue
on macOS.
- Wrap conversion log dynamically up resize.
- Print unexpanded form of matching pattern in error messages and in steps,
times, and trace files.
- Indent trace file to indicate hierarchy of replacement function calls.
- Use UTF-8 encoding explicitly in all output files.
- Replace DEFAULT flag of Rule objects by an argument to rule functions.
- Replace "flags" argument of Rule and RuleList object initializers with an
"iterative" argument.
- Write patterns and replacements strings as raw strings in log files only if
they contain backslashes.
- Allow escaped quotes in document rules.
- Increase resolution of title-bar icon in macOS and Linux.

Fixed
-----
- Ignore Unicode errors when reading LaTeX log file.
- Detect and log when Tk library is missing or too old rather than crash.
- Create output directory if it does not exist yet.
- Catch and log errors that were previously ignored silently.
- Prevent empty window from flashing on screen at startup.

=================

Fixed
-----
- Fix bug that led to pywintypes.error when win32api.pyd file did not contain
version information.

=================

Added
-----
- Generate rules automatically for commands defined in LaTeX document using
\\newcommand, \\renewcommand, and \\ensurecommand.
- Add rules for commands:
- | core:
| \\ensuremath
- Add automatic detection of catastrophic backtracking using a timeout for
individual matching patterns and conversion rules (with third-party regex
module only).
- Add status bar indicating elapsed time during conversion, which can be used
to detect catastrophic backtracking when using re module.
- Add "Reset" button to GUI.
- Add description of software to GUI and CLI with link to user manual and
contact information.
- Use logging module for log messages. Save log to file in addition to
streaming to standard error. Save steps and trace to file (when used).
- Add verbose option, which increases the level of detail streamed to the
conversion box or standard error.
- Add automatic clearing of Python COM cache (on Microsoft Windows) when facing
COM errors.
- Add DeLaTeXify icon to title bar in GUI.
- Reorganize as package.
- Provide a function as part of the Application Programming Interface (API)
that performs the conversion without writing anything to the file system.
- Add configuration files for creation of sdist and wheel packages.

Changed
-------
- Change default location of input file dialog to current working directory,
and change initial working directory of shortcuts on Microsoft Windows to
Document folder.
- Change default pattern for output file (%i-dy.txt rather than %i.txt, where
%i = stem of input file name).
- Change matching pattern for document rules so only white space is allowed
between the comment character (%) at the beginning of line and the beginning
of the word Rule. Document rules can now be commented out using "%%".
- Updated and added several log messages.
- Group debugging options into three groups: logging, conversion rules, and
regular expression module.
- Rename "Debugging log" to "Conversion log" and move it to the right of the
window.
- Increase initial size of conversion log box.
- Make dependency on pywin32 optional; without it, Microsoft-Windows-specific
GUI elements are omitted.
- Change function signature of rule functions following reorganization as
package. They now access all classes and objects that they need via keyword
arguments.

Removed
-------
- Remove support for Python 2.7 and 3.2 to 3.5.
- Remove "Save log" button from GUI, since it is now saved automatically.
- Remove ability to create shortcut from CLI (was on Microsoft Windows only).
- Remove obsolete LaTeX._unpercent rule.

Fixed
-----
- Fix bug that prevented user from seeing error message when exception was
thrown during GUI initialization.
- Make rule that removes non-command curly braces iterative with the regex
module, so inner-most braces are not left behind when a pair of braces is
located within another pair.
- Run conversion in another thread so busy cursor is also displayed on
Microsoft Windows.

=================

Added
-----
- Add rules for commands:
- | core:
| \\- (discretionary hyphen)
- | fixme package:
| \\FXRegisterAuthor, \\fxloadtargetlayouts, \\fxusetargetlayout
- Add limited support for packages array (\\newcolumntype) and siunitx
(\\sisetup).
- Add visual cues to GUI to indicate that conversion is in progress.

Changed
-------
- Change shebang line from python to python3 in accordance with PEP 394.

Fixed
-----
- Fix bug in detection of Microsoft Outlook.
- Fix bugs in \\input and \\bibliography rules.