====================
``highlight`` module
====================

.. automodule:: whoosh.highlight

See :doc:`how to highlight terms in search results </highlight>`.


Manual highlighting
===================

.. autoclass:: Highlighter
   :members:

.. autofunction:: highlight


Fragmenters
===========

.. autoclass:: Fragmenter
   :members:

.. autoclass:: WholeFragmenter
.. autoclass:: SentenceFragmenter
.. autoclass:: ContextFragmenter
.. autoclass:: PinpointFragmenter


Scorers
=======

.. autoclass:: FragmentScorer
.. autoclass:: BasicFragmentScorer


Formatters
==========

.. autoclass:: UppercaseFormatter
.. autoclass:: HtmlFormatter
.. autoclass:: GenshiFormatter


Utility classes
===============

.. autoclass:: Fragment
    :members:
