X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/436c3fbefcaf06bf68d8e79813f68951039a1cff..a9e0ad0a5e0978756cf9ef2a1c0fe32d9e841f40:/doc/plugins/contrib/syntax.mdwn?ds=sidebyside
diff --git a/doc/plugins/contrib/syntax.mdwn b/doc/plugins/contrib/syntax.mdwn
index 56130471a..3aed3d425 100644
--- a/doc/plugins/contrib/syntax.mdwn
+++ b/doc/plugins/contrib/syntax.mdwn
@@ -2,6 +2,7 @@
[[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.
The plugin inserts a fragment of HTML with special marks from a file or a string text. It accepts the following parameters:
@@ -10,9 +11,12 @@ The plugin inserts a fragment of HTML with special marks from a file or a string
* **file**: Path to the source file. It must exist on every rebuild of the wiki.
* **text**: Text string with the source.
* **description** (optional): little description about the content.
+* **linenumbers** (optional): enable the line numering of the source page. A value greater than zero is the first line number.
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="""
@@ -24,7 +28,7 @@ Example:
or
- \[[syntax file="hello.pl" description="My first perl program"]]
+ \[[syntax file="/examples/hello.pl" description="My first perl program"]]
This plugin create the following CSS styles:
@@ -40,7 +44,22 @@ This plugin create the following CSS styles:
* 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 . There is a page with examples:
+It can be downloaded from [here](http://taquiones.net/files/misc/) or through my personal debian repository at . There is a page with examples:
Any help, comments or critics are welcome at .
+## 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
+- Add *linenumbers* parameter
+- The *file* parameter should be point to a ikiwiki source page.
+- The *description* parameter will be converted on a URL if the *file* parameter exist.
+
+I need help for debugging this module. Thanks in advance.