Dragonfly

--------------------

Added
~~~~~
* Add Kaldi support for special user-modifiable Dictation elements (thanks
`daanzu`_).

Changed
~~~~~~~
* Bump required KaldiAG version to 1.8.0 for various improvements. See
`KaldiAG release notes`_ (thanks `daanzu`_).
* Change X11Window.maximize() method to use Extended Window Manager Hints
instead of a hardcoded shortcut.
* Add the *wmctrl* command-line program as a **new required X11 session
dependency** for properly maximizing X11 windows via maximization hints.
* Improve Kaldi engine error messages for failed compilation (thanks
`daanzu`_).
* Reorganize, fix and improve various parts of the documentation.

Fixed
~~~~~
* Fix Repetition element so the *max* argument is an exclusive bound (thanks
`starwarswii`_).
* Fix Windows bug where the printscreen key cannot be pressed.

--------------------

Added
~~~~~
* Add useful audio-related initialization arguments to Kaldi engine back-end
(thanks `daanzu`_).

Changed
~~~~~~~
* Bump required Kaldi-Active-Grammar version to 1.7.0 fix bugs.
* Change the get_engine() function to stop overriding the default (first)
engine if another engine is initialized.

Fixed
~~~~~
* Add missing high numbers to short integer elements (thanks `mrob95`_).
* Fix Python 2.7 bug where StartApp action args may only use ASCII
characters.
* Fix bug with BasicRule where it can only be used as a derived class.
* Fix various Kaldi engine bugs and documentation issues (thanks
`daanzu`_).

--------------------

Fixed
~~~~~
* Fix Kaldi & Sphinx recognition delays on macOS by optimizing window
attribute checks in those engine back-ends.

--------------------

Added
~~~~~
* Add BasicRule class for defining commands using elements directly.
* Add Kaldi engine support for recognition confidence information, plus
various new engine arguments (thanks `daanzu`_).
* Add convenience method Window.matches(context) (thanks `daanzu`_).

Changed
~~~~~~~
* Move SAPI 5 engine process_grammars_context() method into the EngineBase
class.
* Update required versions for lark-parser and KaldiAG version.

Fixed
~~~~~
* Add missing WordParserDns11 entry for the special em dash word.
* Add partial fix for dictation-related DNS recognition failures.
* Change the Windows Clipboard class to poll for clipboard access like the
cross-platform class does.
* Fix CLI error reporting and file pattern matching issues.
* Fix bug causing Win32Window.set_foreground() to fail sometimes.
* Fix bug in the NatlinkEngine.disconnect() method.
* Fix some Kaldi engine bugs.

Removed
~~~~~~~
* Remove old and unused compile() method from ElementBase (thanks
`kb100`_).

--------------------

Added
~~~~~
* Add optional 'results' arguments to recognition and grammar callbacks that
expose internal engine results objects for Natlink and SAPI 5 SR engines.
* Add support for quoted words in rules, which can potentially fix certain
recognition issues with Dragon.

Changed
~~~~~~~
* Change the setup_log() function to output log messages to stderr.
* Make Dictation-only rules work with the Sphinx engine again.
* Make keyboard input faster on X11 by passing '--delay 0' as an argument to
Xdotool.
* Update, fix and improve various parts of the documentation.
* Use the old Win32 Clipboard class on Windows instead of the cross-platform
class.

Fixed
~~~~~
* Fix sdist package installs by including missing files like version.txt
(thanks `thatch`_).
* Fix the Win32 Clipboard class handling of empty clipboard errors and the
CF_TEXT format.
* Raise an error if args were passed to get_engine() but silently ignored
(thanks `shervinemami`_).

--------------------

Fixed
~~~~~
* Add missing __str__ visualization method for UnsafeActionSeries.
* Add missing catch for IOErrors in the Function.__str__() method.
* Fix __str__ visualization methods that break Unicode support.
* Fix some bugs with how Dragonfly command modules are loaded.