X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/b5d3c31edaed159933bff29bdd8462be0e1ccd43..44ca50db9d87142d860b1d9d959a27ede0402b0d:/doc/plugins/contrib/syntax.mdwn?ds=inline diff --git a/doc/plugins/contrib/syntax.mdwn b/doc/plugins/contrib/syntax.mdwn index 6910e71eb..5ca6311f9 100644 --- a/doc/plugins/contrib/syntax.mdwn +++ b/doc/plugins/contrib/syntax.mdwn @@ -1,8 +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: @@ -10,12 +9,15 @@ 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=""" + \[[!syntax type="perl" text=""" #!/usr/bin/perl my $a = "World"; @@ -24,9 +26,38 @@ 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: -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 . +* syntax +* synComment +* synConstant +* syncIdentifier +* synPreProc +* synType +* synSpecial +* synUnderlined +* synError +* synTodo +* synTitle + +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.