]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/contrib/syntax.mdwn
Coding style change: Remove explcit vim folding markers.
[ikiwiki.git] / doc / plugins / contrib / syntax.mdwn
index 548b0a122381d2880f2563a8b7e02d3aebd7ada0..5ca6311f9d63c6151de5f6a17c103a827f608e2e 100644 (file)
@@ -1,9 +1,7 @@
-[[template id=plugin name=syntax author="[[VictorMoral]]"]]
-[[tag type/chrome type/slow]]
-[[meta title="syntax (third-party plugin)"]]
+[[!template id=plugin name=syntax author="[[VictorMoral]]"]]
+[[!tag type/chrome type/slow]]
 
-
-`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.
+The `syntax` plugin adds support to ikiwiki for syntax highlighting through the *vim* editor and its perl interface [[!cpan Text::VimColor]].  It depends on a functional vim installation.
 
 The plugin inserts a fragment of HTML with special marks from a file or a string text. It accepts the following parameters:
 
@@ -15,9 +13,11 @@ The plugin inserts a fragment of HTML with special marks from a file or a string
 
 The params *file* and *text* are mutually exclusive.
 
+In the case of file parameter, `syntax` will build a html link for direct download.
+
 Example:
 
-       \[[syntax type="perl" text="""  
+       \[[!syntax type="perl" text="""  
        #!/usr/bin/perl
 
        my $a = "World";
@@ -26,7 +26,7 @@ Example:
 
 or 
 
-       \[[syntax file="/examples/hello.pl" description="My first perl program"]]
+       \[[!syntax file="/examples/hello.pl" description="My first perl program"]]
 
 This plugin create the following CSS styles:
 
@@ -42,10 +42,17 @@ This plugin create the following CSS styles:
 * synTodo
 * synTitle
 
-It can be downloaded from [here](http://taquiones.net/files/misc/IkiWiki-Plugin-syntax-0.7.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>
+It can be downloaded from [here](http://taquiones.net/files/misc/) 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>.
 
+## version 0.9
+
+- Add a force_subpage parameter for link build
+- Fix a bug in syntax page link
+- Documented a bug with markdown indented text
+- Documented the syntax directive
+
 ## version 0.7
 
 - Version change to GPL