Annotator

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

Features
--------

- The ``authz``, ``identity``, and ``notification`` modules are now
exposed as public API on the ``annotator`` page global.

- The ``notifier``, ``identityPolicy`` and ``authorizationPolicy`` are now
retrieved from component registry. It should now be possible to register
alternative implementations.

- Performance of the highlighter should be slightly improved.

- Showing the viewer with a mouse hover should be much faster when there are
many overlapping highlights. (520)

- The ``getGlobal()`` function of the ``util`` module has been removed and
Annotator should now work with Content Security Policy rules that prevent
``eval`` of code.

- The ``markdown`` extension has been upgraded to require and support version
1.0 or greater of the Showdown library.

Bug Fixes
---------

- Fix a bug in the ``ui.filter`` extension so that the ``filters`` option
now works as specified.

- Make the highlighter work even when the global ``document`` symbol is not
``window.document``.

- Fix an issue with the editor where adding custom fields could result in
fields appearing more than once. (533)

- With the ``autoViewHighlights`` options of the ``viewer``, don't show the
viewer while the primary mouse button is pressed. Before, this prevention
applied to every button except the primary button, which was not the intended
behavior.

Documentation
-------------

- Fix some broken links.

- Fix some example syntax.

- Add example markup in the documentation for the ``document`` extension.

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

- Started changelog.

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

- FIXED: `Annotation.search` no longer mutates the passed query.

- FIXED/BREAKING CHANGE: `Document.get_by_uri()` no longer returns a list for
empty resultsets, instead returning `None`.

-----------------
- FIXED: Document plugin doesn't drop links without a type. The annotator
client generates a typeless link from the document href. (116)

- ADDED: the search endpoint now supports 'before' and 'after query parameters,
which can be used to return annotations created between a specific time
period.

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

- ADDED: the search endpoint now supports 'sort' and 'order' query parameters,
which can be used to control the sort order of the returned results.

- FIXED: previously only one document was returned when looking for equivalent
documents (110). Now the Document model tracks all discovered equivalent
documents and keeps each document object up-to-date with them all.

- BREAKING CHANGE: Document.get_all_by_uris() no longer exists. Use
Document.get_by_uri() which should return a single document containing all
equivalent URIs. (You may wish to update your index by fetching all documents
and resaving them.)

- FIXED: the search_raw endpoint no longer throws an exception when the
'fields' parameter is provided.

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

- Avoid a confusing error about reindexing when annotator is used as a
library and not a standalone application (107).