[rt.cpan.org #56513] update filter plugins documentation

diff --git a/Changes b/Changes
index 2a463f816f6f7d6df4790f7d845c2b1b39152116..0dad68e01e551a0647621bc9cd39d5bd37c0e0d3 100644 (file)
--- a/Changes
+++ b/Changes
@@ -10,6 +10,9 @@ Bug fixes:
  - paletted writes to a masked image are now masked correctly.
    Revealed by new coverage tests.
 
+ - update the filter plugin documentation.
+   https://rt.cpan.org/Ticket/Display.html?id=56513
+
 Imager 0.80 - 17 Jan 2011
 ===========
 

diff --git a/lib/Imager/Filters.pod b/lib/Imager/Filters.pod
index cdff7d1c03f973f830028f3bd51e7fa4382564bb..9e79383f206cc5375d1d370ffa75797125852937 100644 (file)
--- a/lib/Imager/Filters.pod
+++ b/lib/Imager/Filters.pod
@@ -606,7 +606,7 @@ The function you supply must modify the image in place.
 
 =back
 
-See Imager::Filter::Mandelbrot for an example.
+See L<Imager::Filter::Mandelbrot> for an example.
 
 =back
 
@@ -615,15 +615,14 @@ See Imager::Filter::Mandelbrot for an example.
 =head2 Plug-ins
 
 The plug in interface is deprecated.  Please use the Imager API, see
-L</Imager::API> and L<External Filters> for details
+L<Imager::API> and L<External Filters> for details
 
-It is possible to add filters to the module without recompiling the
-module itself.  This is done by using DSOs (Dynamic shared object)
-available on most systems.  This way you can maintain our own filters
-and not have to get me to add it, or worse patch every new version of
-the Module.  Modules can be loaded AND UNLOADED at run time.  This
-means that you can have a server/daemon thingy that can do something
-like:
+It is possible to add filters to the module without recompiling Imager
+itself.  This is done by using DSOs (Dynamic shared object) available
+on most systems.  This way you can maintain your own filters and not
+have to have it added to Imager, or worse patch every new version of
+Imager.  Modules can be loaded AND UNLOADED at run time.  This means
+that you can have a server/daemon thingy that can do something like:
 
   load_plugin("dynfilt/dyntest.so")
     or die "unable to load plugin\n";
@@ -634,21 +633,17 @@ like:
     or die "unable to load plugin\n";
 
 Someone decides that the filter is not working as it should -
-F<dyntest.c> modified and recompiled.
+F<dyntest.c> can be modified and recompiled, and then reloaded:
 
   load_plugin("dynfilt/dyntest.so")
     or die "unable to load plugin\n";
 
   $img->filter(%hsh);
 
-An example plugin comes with the module - Please send feedback to
-addi@umich.edu if you test this.
+=for stopwords Linux Solaris HPUX OpenBSD FreeBSD TRU64 OSF1 AIX Win32 OS X
 
-=for stopwords Linux Solaris HPUX OpenBSD FreeBSD TRU64 OSF1 AIX
-
-Note: This seems to test successfully on the following systems: Linux,
-Solaris, HPUX, OpenBSD, FreeBSD, TRU64/OSF1, AIX.  If you test this on
-other systems please let me know.
+Note: This has been tested successfully on the following systems:
+Linux, Solaris, HPUX, OpenBSD, FreeBSD, TRU64/OSF1, AIX, Win32, OS X.
 
 =over
 
@@ -675,6 +670,36 @@ Returns true on success.  Check Imager->errstr on failure.
 
 =back
 
+A few example plug-ins are included and built (but not installed):
+
+=over
+
+=item *
+
+F<plugins/dyntest.c> - provides the C<null> (no action) filter, and
+C<lin_stretch> filters.  C<lin_stretch> stretches sample values
+between C<a> and C<b> out to the full sample range.
+
+=item *
+
+F<plugins/dt2.c> - provides the C<html_art> filter that writes the
+image to the HTML fragment file supplied in C<fname> as a HTML table.
+
+=item *
+
+F<plugins/flines.c> - provides the C<flines> filter that dims
+alternate lines to emulate an old CRT display.
+L<Imager::Filter::Flines> provides the same functionality.
+
+=item *
+
+F<plugins/mandelbrot.c> - provides the C<mandelbrot> filter that
+renders the Mandelbrot set within the given range of x [-2, 0.5) and y
+[-1.25, 1,25).  L<Imager::Filter::Mandelbrot> provides a more flexible
+Mandelbrot set renderer.
+
+=back
+
 =head2 Image Difference
 
 =over

diff --git a/t/x20spell.t b/t/x20spell.t
index cf7f141f6a95cda788097f6216110ab4ae9622d4..309dd27ff8d6603fcd6a7dd8163c7e3b943e47d2 100644 (file)
--- a/t/x20spell.t
+++ b/t/x20spell.t
@@ -44,6 +44,7 @@ RGBA
 postfix
 infix
 unary
+renderer
 Uncategorized
 Blit
 /;