diff options
author | Stuart Rackham <srackham@methods.co.nz> | 2011-02-11 18:20:10 +1300 |
---|---|---|
committer | Stuart Rackham <srackham@methods.co.nz> | 2011-02-11 18:20:10 +1300 |
commit | dafdcfc65d3491e5f2b51a3a33c122e1728db938 (patch) | |
tree | 0294cced3c22ea395d77b2e3a3a18ebdf7e553dd | |
parent | 13dec419a694d72e05a90810d85e4b1c4d5cd690 (diff) | |
download | asciidoc-dafdcfc65d3491e5f2b51a3a33c122e1728db938.tar.gz |
- Filter plugin documentation.
- Filter plugins web page.
-rw-r--r-- | doc/asciidoc.txt | 39 | ||||
-rw-r--r-- | examples/website/filter-plugins.txt | 33 | ||||
-rw-r--r-- | examples/website/index.txt | 60 | ||||
-rw-r--r-- | examples/website/main.aap | 1 |
4 files changed, 85 insertions, 48 deletions
diff --git a/doc/asciidoc.txt b/doc/asciidoc.txt index b596730..782d5f0 100644 --- a/doc/asciidoc.txt +++ b/doc/asciidoc.txt @@ -1197,9 +1197,6 @@ Predefined delimited block underlines: ExampleBlock: ========================== OpenBlock: -- -The <<X56,code>>, <<X57,source>> and <<X58,music>> filter blocks are -detailed in the <<X59,Filters>> section. - .Default DelimitedBlock substitutions [cols="2e,7*^",frame="topbot",options="header,autowidth"] |===================================================== @@ -2061,7 +2058,7 @@ Including callouts in included code You can annotate working code examples with callouts -- just remember to put the callouts inside source code comments. This example displays the `test.py` source file (containing a single callout) using the -<<X57,Source Code Highlighter Filter>>: +'source' (code highlighter) filter: .AsciiDoc source --------------------------------------------------------------------- @@ -4542,8 +4539,8 @@ asciidoc(1) auto-loads all `.conf` files found in the filter search paths (see previous section). [[X56]] -Code Filter -~~~~~~~~~~~ +Example Filter +~~~~~~~~~~~~~~ AsciiDoc comes with a toy filter for highlighting source code keywords and comments. See also the `./filters/code/code-filter-readme.txt` file. @@ -4551,7 +4548,7 @@ file. NOTE: This filter primarily 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 multi-language highlighter use the -<<X57,Source Code Highlighter Filter>>. +{website}source-highlight-filter.html[source code highlighter filter]. [listing] ..................................................................... @@ -4586,22 +4583,22 @@ def sub_word(mo): return word ---------------------------------------------- -[[X57]] -Source Code Highlighter Filter -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -A -{website}source-highlight-filter.html[source code highlighter filter] -can be found in the AsciiDoc distribution `./filters` directory. +Built-in filters +~~~~~~~~~~~~~~~~ +The AsciiDoc distribution includes 'source', 'music', 'latex' and +'graphviz' filters, details are on the +{website}index.html#_filters[AsciiDoc website]. [[X58]] -Music Filter -~~~~~~~~~~~~ -A {website}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 Western classical notation in the form of a -trimmed PNG image which is automatically inserted into the output -document. +Filter plugins +~~~~~~~~~~~~~~ +Filter plugins are a simple mechanism for distributing AsciiDoc +filters. A filter plugin is a Zip file containing the files that +constitute a filter. The asciidoc(1) `--filter` option implements +commands to install, remove and list filter plugins. Filter plugin +commands and conventions are documented in the asciidoc(1) man page. +You can find a list of filter plugins on the +{website}filter-plugins.html[AsciiDoc website]. [[X12]] diff --git a/examples/website/filter-plugins.txt b/examples/website/filter-plugins.txt new file mode 100644 index 0000000..c7a23db --- /dev/null +++ b/examples/website/filter-plugins.txt @@ -0,0 +1,33 @@ +AsciiDoc Filter Plugins +======================= + +Filter plugins are a simple mechanism 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. + +IMPORTANT: Until AsciiDoc 8.6.4 is released you will need to run from +the +link:INSTALL.html#_installing_from_the_mercurial_repository[AsciiDoc +trunk] to use the new asciidoc(1) filter plugin commands, +alternatively you could manually unzip to the appropriately named +filters subdirectory. + +[cols="1e,1,3,3",options="header"] +|==== +|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 + +|==== diff --git a/examples/website/index.txt b/examples/website/index.txt index ad2e146..1446584 100644 --- a/examples/website/index.txt +++ b/examples/website/index.txt @@ -147,30 +147,6 @@ http://wordpress.org/[WordPress] blog hosts. It creates and updates weblog posts and pages directly from AsciiDoc source documents.
-Music Filter
-------------
-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 Code Highlight Filter
-----------------------------
-A link:source-highlight-filter.html[source code highlight filter] is
-included in the distribution `./filters/` directory.
-
-
-[[X4]]
-Graphviz Filter
----------------
-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].
-
-
[[X3]]
Mathematical Formulae
---------------------
@@ -179,7 +155,7 @@ link:asciimathml.html[ASCIIMathML] or link:latexmathml.html[LaTeXMathML] notation.
The link:latex-filter.html[AsciiDoc LaTeX filter] translates LaTeX
-source to PNG image which is automatically inserted into the AsciiDoc
+source to a PNG image that is automatically inserted into the AsciiDoc
output documents.
AsciiDoc also has 'latexmath' macros for DocBook outputs -- they are
@@ -218,14 +194,44 @@ image::images/highlighter.png[height=400,caption="",link="images/highlighter.png for AsciiDoc.
+Filters
+-------
+link:userguide#X9[AsciiDoc Filters] are distributed as
+link:filter-plugins.html[Filter Plugins] and a few are included in the
+AsciiDoc distribution.
+
+=== Music filter
+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 Code Highlight filter
+A link:source-highlight-filter.html[source code highlight filter] is
+included in the distribution `./filters/` directory.
+
+
+=== LaTeX filter
+The link:latex-filter.html[AsciiDoc LaTeX filter] translates LaTeX
+source to a PNG image that is automatically inserted into the AsciiDoc
+output documents.
+
[[X5]]
-matplotlib Filter
------------------
+=== 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.
+[[X4]]
+== Graphviz filter
+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].
+
Try AsciiDoc on the Web
-----------------------
diff --git a/examples/website/main.aap b/examples/website/main.aap index a908ba4..0114b04 100644 --- a/examples/website/main.aap +++ b/examples/website/main.aap @@ -47,6 +47,7 @@ WEB_ROOT = newlists slidy slidy-example + filter-plugins WEB_PAGES = $*(WEB_ROOT).html WEB_SOURCE = $*(WEB_ROOT).txt |