This is a very small and simple plugin to place defined snippets of a file onto your page or just output a code snipped with line numbering.

This plugin delivers following:

• code snippets directly from files or just copy-paste a code block
• code line numbering
• direct link of commands to online descriptions (e.g. php.net)
• downloadable code blocks
• css supported box style
• adds code buttons to the Editor Toolbar

The following syntax does apply:   {(xssnipper>,[start line],[code language] [code block file] [slider] ,[code])} where [code language] [code block file] [slider] are optional and [code] is the snipped you want to show.

Remark: click on the red arrow to show/hide the code block

test

// 1. check if $xssnipper['filepath'] exist, else error message if(!file_exists($xssnipper['filepath'])) { msg('file '.$xssnipper['filepath'].' not found',-1); return false; }

1.  
2. // 1. check if $xssnipper['filepath'] exist, else error message
3.    if(!file_exists($xssnipper['filepath'])) {
4.       msg('file '.$xssnipper['filepath'].' not found',-1);
5.       return false;
6.    }
7.  

The following Syntax was used for upper example:

{(xssnipper>,1,php test slide,
// 1. check if $xssnipper['filepath'] exist, else error message
   if(!file_exists($xssnipper['filepath'])) {
      msg('file '.$xssnipper['filepath'].' not found',-1);
      return false;
   }
)}

The following syntax does apply:   {(xssnipper>[PATH],[from line],[to line],[code language] [code block file] [slider])}.

Simply place the following syntax into the page mark-up:

{(xssnipper>./lib/plugins/xssnipper/plugin.info.txt,1,15,txt  test.txt)}

This should deliver lines 1 to 15 as plain text (downloadable as test.txt file) from the current plugin info file as follows:

plugin.info.txt

# PLUGIN INFO - DO NOT EDIT! base xssnipper author Taggic email taggic@t-online.de date 2012-06-22 name xssnipper desc provides syntax plugin to retrieve code snippeds from files url http://www.dokuwiki.org/plugin:xssnipper

1. # PLUGIN INFO - DO NOT EDIT!
2.  
3. base    xssnipper
4. author  Taggic
5. email   taggic@t-online.de
6. date    2012-06-22
7. name    xssnipper
8. desc    provides syntax plugin to retrieve code snippeds from files
9. url     http://www.dokuwiki.org/plugin:xssnipper
10.  
11.  

You see the output stops before line 15 was reached beacuse end of file reached.

The snippets are displayed with Syntax Highlighting of DokuWiki GeSHi implementation. The output can be styled via a css-file.
The filename will be taken from the path you passed else you provided another filename after the [code language] parameter.
The following example visualize it for better understanding:

{(xssnipper>./lib/plugins/xssnipper/syntax.php,85,104,php)}

syntax.php

$xssnipper['filepath'] = $params[0]; $xssnipper['from'] = $params[1]; $xssnipper['until'] = $params[2]; $alpha = explode(' ',$params[3]); $xssnipper['type'] = $alpha[0]; $xssnipper['file'] = $alpha[1]; $xssnipper['block'] = $alpha[2]; } return $xssnipper; } /******************************************************************************/ /* render output * @author Taggic */ function render($mode, &$renderer, $xssnipper) { global $ID; if(!$xssnipper['type']) $xssnipper['type']='txt'; if($this->_codeblock<1) $this->_codeblock=1;

85.           $xssnipper['filepath']    = $params[0];
86.           $xssnipper['from']        = $params[1];
87.           $xssnipper['until']       = $params[2];
88.           $alpha                    = explode(' ',$params[3]);
89.           $xssnipper['type']        = $alpha[0];
90.           $xssnipper['file']        = $alpha[1];
91.           $xssnipper['block']       = $alpha[2];
92.         }        
93.         return $xssnipper;
94.      }
95. /******************************************************************************/
96. /* render output
97. * @author Taggic <taggic@t-online.de>
98. */  
99.     function render($mode, &$renderer, $xssnipper) {
100.         global $ID;
101.         if(!$xssnipper['type'])  $xssnipper['type']='txt';
102.         if($this->_codeblock<1)  $this->_codeblock=1;
103.  
104.  

The plugin will show all codelines from defined start parameter until end of file if you leave the [to line] parameter empty.

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin.
Refer to Plugins on how to install plugins manually.

Or just download and extract it as folder “xssnipper” into your “\lib\plugins” directory.

External requirements:

• none

• An error occurred while fetching this feed: http://github.com/feeds/Taggic/commits/xssnipper/master

• none

The plugin was tested with DW 2011-05-25 “Rincewind” and also with related on the Stick version.
Our standard browser is Internet Explorer 9 due to majority of customers using it.
However, that is no guarantee that it works for all environmental configuration.

Please use the Contact us form or the xsSnipper - IssueTracker to send us your wish or Feature Request.

Please use only the DokuWiki Forum for discussion and xsSnipper - IssueTracker to raise issues.
The plugin development is still ongoing. There might be something be corrected, to implement and to improve.