aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-10-24 13:20:32 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-10-24 13:20:32 +0000
commit7a1dfbc49f16111d22dcd47788676c9883f15e41 (patch)
tree6a85d47c2f0c009a6c9cf9e142b31e5be3fe60dc /doc/plugins
parentdf2354b0092efa4c03be6d9ee4b2509359f6bbc4 (diff)
downloadikiwiki-7a1dfbc49f16111d22dcd47788676c9883f15e41.tar
ikiwiki-7a1dfbc49f16111d22dcd47788676c9883f15e41.tar.gz
web commit by VictorMoral
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/contrib/syntax.mdwn12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/plugins/contrib/syntax.mdwn b/doc/plugins/contrib/syntax.mdwn
index 56130471a..ddad9db67 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,6 +11,7 @@ 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.
@@ -24,7 +26,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:
@@ -44,3 +46,11 @@ It can be downloaded from [here](http://taquiones.net/files/misc/IkiWiki-Plugin-
Any help, comments or critics are welcome at <victor@taquiones.net>.
+## 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.