AsciiDoc Filters
================


AsciiDoc link:userguide#X59[filters] allow external commands to
process AsciiDoc 'Paragraph', 'DelimitedBlock' and 'Table' contents.
Filters are primarily an extension mechanism for generating
specialized outputs. Filters are available as external
<<_filter_plugins,plugins>> and come
<<_built_in_filters,pre-installed>>.


Filter Plugins
--------------
Filter plugins are a simple mechanism (introduced in AsciiDoc 8.6.4)
for distributing AsciiDoc filters.  A filter plugin is a Zip file
containing the files that constitute a filter. The asciidoc(1)
link:manpage.html[--filter option] implements commands to install,
remove and list filter plugins.

Here is a list of publically available filter plugins (if you have
implemented a plugin and it's not in the list please post a message to
the http://groups.google.com/group/asciidoc[asciidoc discussion list]
and I'll include it in the list).

[cols="1e,1,3,3",frame="topbot",options="header"]
.Filter Plugins list
|====
|Filter name |Author |Home page |Description

|ditaa |Henrik Maier
|http://code.google.com/p/asciidoc-ditaa-filter/
|ASCII line art filter

|aafigure |Henrik Maier
|http://code.google.com/p/asciidoc-aafigure-filter/
|ASCII line art filter

|mscgen |Henrik Maier
|http://code.google.com/p/asciidoc-mscgen-filter/
|Message sequence chart filter

|====


Built-in Filters
----------------

[cols="1e,5",frame="topbot",options="header"]
.Built-in filters list
|====
|Filter name |Description

|music
|A link:music-filter.html[music filter] is included in the
distribution `./filters/` directory. It translates music in
http://lilypond.org/[LilyPond] or http://abcnotation.org.uk/[ABC]
notation to standard classical notation

|source
|A link:source-highlight-filter.html[source code highlight filter] is
included in the distribution `./filters/` directory.


|latex
|The link:latex-filter.html[AsciiDoc LaTeX filter] translates LaTeX
source to a PNG image that is automatically inserted into the AsciiDoc
output documents.

|graphviz
|Gouichi Iisaka has written a http://www.graphviz.org/[Graphviz]
filter for AsciiDoc.  Graphviz generates diagrams from a textual
specification. Gouichi Iisaka's Graphviz filter is included in the
AsciiDoc distribution. Here are some
link:asciidoc-graphviz-sample.html[AsciiDoc Graphviz examples].

|====


Other filters
-------------
=== matplotlib filter
Leonid Volnitsky has written a
http://volnitsky.com/project/mplw/index.html[matplotlib] filter for
AsciiDoc.  Using this filter you can generate charts from inline
matplotlib scripts.

