.. -*- coding: utf-8; indent-tabs-mode: nil; -*-

*********
 Filters
*********

The package contains the following filters:

.. include:: filterlist.rst


The AlgPseudocode lexer yields an error token for the following code block.
`Sphinx`_ therefore suppresses highlighting completely:

.. code-block:: none

   \EXPR{TEST}

With a custom AlgPseudocode lexer that has ``prohibit_raiseonerror_filter``
activated the output in `Sphinx`_ is as:

.. code-block:: no-raiseonerror-algpseudocode

   \EXPR{TEST}


With the "errortogenericerror" filter the very same block is highlighted
as:

.. code-block:: genericerror-algpseudocode

   \EXPR{TEST}


ErrorToGenericErrorTokenFilter
==============================

:Name: errortogenericerror
:Filter Options: none

Replace all :py:class:`pygments.token.Token.Error` tokens in a stream by
:py:class:`pygments.token.Token.Generic.Error` tokens.


TokenReplaceFilter
==================

:Name: tokenreplace
:Required Filter Options:
   **token_from**
     **Type:** :py:class:`str` or :py:class:`pygments.token.Token`

     The name of a token type (like ``Error``) or a token object
     (like :py:class:`pygments.token.Token.Error`).

   **token_to**
     **Type:** :py:class:`str` or :py:class:`pygments.token.Token`

     The name of a token type (like ``Generic.Error``) or a token object
     (like :py:class:`pygments.token.Token.Generic.Error`).

Replace all token types given in `token_from` by the token type given
in `token_to`.
