AsciiDoc Example Code Filter README
===================================

This simple minded filter highlights source code keywords and
comments.

NOTE: The filter is to demonstrate how to write a filter -- it's much
to simplistic to be passed off as a code syntax highlighter. If you
want a full featured highlighter see the source-highlight filter in
the distribution `./examples/source-highlight-filter/` directory.


Files
-----
code-filter.py::
	The filter Python script.
code-filter.conf::
	The AsciiDoc filter configuration file.
code-filter-test.txt::
	Short AsciiDoc document to test the filter.


Installation
------------
The code filter is installed in the distribution `./filters` directory
as part of the standard AsciiDoc install.

Test it on the `code-filter-test.txt` file:

  $ asciidoc -b xhtml11 code-filter-test.txt

Then take a look at the generated `code-filter-test.html`.


Help
----
Execute the filter with the help option:

  $ ./code-filter.py --help | less
