notes about this plugin, including a security issue

[ikiwiki.git] / doc / plugins / contrib / syntax.mdwn

diff --git a/doc/plugins/contrib/syntax.mdwn b/doc/plugins/contrib/syntax.mdwn
index 8d91b921d2771c9bd3692d33d8514dbda26bd5cd..56130471a228257ca0a8271de4651e6c486d682d 100644 (file)
--- a/doc/plugins/contrib/syntax.mdwn
+++ b/doc/plugins/contrib/syntax.mdwn
@@ -1,5 +1,5 @@
 [[template id=plugin name=syntax author="[[VictorMoral]]"]]
-[[tag type/chrome slow]]
+[[tag type/chrome type/slow]]
 [[meta title="syntax (third-party plugin)"]]
 
 `syntax` is a plugin that add support to ikiwiki for syntax highlighting through the *vim* editor and its perl interface [[cpan Text::VimColor]], so it depends on a vim functional installation.
@@ -15,18 +15,32 @@ The params *file* and *text* are mutually exclusive.
 
 Example:
 
-   \[[syntax type="perl" text="""
-   #!/usr/bin/perl
+       \[[syntax type="perl" text="""  
+       #!/usr/bin/perl
 
-   my $a = "World";
-   print "Hello, ${a}\n";
-   """]]
+       my $a = "World";
+       print "Hello, ${a}\n";
+       """]]
 
 or 
 
-   \\[[syntax file="hello.pl" description="My first perl program"]]
+       \[[syntax file="hello.pl" description="My first perl program"]]
 
-It can be downloaded from [here](http://taquiones.net/files/misc/Ikiwiki-plugin-syntax-0.5.tar.gz) or through my personal debian repository at <http://taquiones.net/files/debian/>.
+This plugin create the following CSS styles:
+
+* syntax
+* synComment
+* synConstant
+* syncIdentifier
+* synPreProc
+* synType
+* synSpecial
+* synUnderlined
+* synError
+* synTodo
+* synTitle
+
+It can be downloaded from [here](http://taquiones.net/files/misc/IkiWiki-Plugin-syntax-0.5.tar.gz) or through my personal debian repository at <http://taquiones.net/files/debian/>. There is a page with examples: <http://taquiones.net/software/syntax-examples.html>
 
 Any help, comments or critics are welcome at <victor@taquiones.net>.