DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:xssnipper

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:xssnipper [2012-02-10 21:39] – [Feature Overview] 93.199.227.181plugin:xssnipper [2024-02-13 06:58] (current) Aleksandr
Line 1: Line 1:
-====== xssnipper Plugin ====== +====== xsSnipper Plugin ======
----- pluginnews ---- +
-headline: Plugins by same author +
-style: sameauthor +
-----+
  
 ---- plugin ---- ---- plugin ----
-description: Exctract a snippet of a file and publish it on your page.+description: Exctract a snippet of a file and publish it on your page
 author     : Taggic author     : Taggic
 email      : taggic@t-online.de  email      : taggic@t-online.de 
 type       : syntax type       : syntax
-lastupdate : 2012-02-10 +lastupdate : 2016-06-02 
-compatible : 2011-05-25+compatible : Rincewind, Angua
 depends    :  depends    : 
 conflicts  conflicts 
Line 39: Line 35:
 ====== Syntax ====== ====== Syntax ======
 ===== Case 1: Standard code snipped ===== ===== Case 1: Standard code snipped =====
-The following syntax does apply: //%%{(xssnipper>%%**,**[start line]**,**[code language] [code block file]**,**[ code ]%%)}%%// \\ +The following syntax does apply: //%%{(xssnipper>%%**,**[start line]**,**[code language] [code block file] [slide]**,**[ code ]%%)}%%// \\ 
 where // [ code ] // is the snipped you want to show. \\  where // [ code ] // is the snipped you want to show. \\ 
  
-__**Syntax Example:**__\\ +__**Syntax Example (no slide):**__\\ 
   {(xssnipper>,1,php test,   {(xssnipper>,1,php test,
   // 1. check if $xssnipper['filepath'] exist, else error message   // 1. check if $xssnipper['filepath'] exist, else error message
Line 51: Line 47:
   )}   )}
 ===== Case 2: Code snipped from file ===== ===== Case 2: Code snipped from file =====
-The following syntax does apply: //%%{(xssnipper>%%[PATH],[from line],[to line],[code language] [code block file]%%)}%%// \\.+The following syntax does apply: //%%{(xssnipper>%%[PATH],[from line],[to line],[code language] [code block file] [slide]%%)}%%// \\.
 ^Parameter ^Necessity ^ Meaning | ^Parameter ^Necessity ^ Meaning |
 | //[PATH]//  | mandatory  |specifies the file where content to be picked up | | //[PATH]//  | mandatory  |specifies the file where content to be picked up |
Line 57: Line 53:
 | //[to line]//  | optional   |defines the last line to be displayed, if empty it will be set to end of file; if further parameter will be given at least the colon separator to be written  | | //[to line]//  | optional   |defines the last line to be displayed, if empty it will be set to end of file; if further parameter will be given at least the colon separator to be written  |
 | //[code language]//  | optional   |tells code block/GeSHi what language file to be used for coloring, file extension of the [path] parameter will be used if empty    | //[code language]//  | optional   |tells code block/GeSHi what language file to be used for coloring, file extension of the [path] parameter will be used if empty   
-| //[code block file]//  | optional   |enables the download cod blocks feature and specifies the file name, if empty no downloadable code block provided  |+| //[code block file]//  | optional   |enables the download cod blocks feature and specifies the file name, if empty no downloadable code block provided. **(file name must not contain space character !)**  | 
 +| //[slide]//   | optional   |enables the view/hide (slide) function of the code block. Any value will switch on this function (e.g. 1 or on or slide). If set the code will be hidden initially. 
  
 Simply place syntax like following into your page markup:  Simply place syntax like following into your page markup: 
Line 67: Line 65:
 {{http://img846.imageshack.us/img846/8528/xssnipperexample.jpg?nolink|output example}} {{http://img846.imageshack.us/img846/8528/xssnipperexample.jpg?nolink|output example}}
  
-Live demo examples can be found here: [[http://www.fristercons.de/fcon/doku.php?id=xssnipper:xssnipper#intro]]+FIXME Live demo examples can be found here: [[http://www.fristercons.de/fcon/doku.php?id=xssnipper:xssnipper#intro]]
  
  
 ===== Installation ===== ===== Installation =====
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. \\  +Search and install the plugin using the [[plugin:extension|Extension Manager]]. 
-Refer to [[Plugins|Plugins]] on how to install plugins manually.+
  
-Or just [[https://github.com/Taggic/xssnipper/archives/master|download]] and extract it as folder "xssnipper" into your “\lib\plugins” directory.+Alternatively, refer to [[:Plugins]] on how to install plugins manually. Or just [[https://github.com/Taggic/xssnipper/archives/master|download]] and extract it as folder "xssnipper" into your “\lib\plugins” directory.
  
-:!: **External requirements:**   
-  * none 
  
 ==== Changes ==== ==== Changes ====
-{{rss>http://github.com/feeds/Taggic/commits/xssnipper/master date}}+{{rss>https://github.com/Taggic/xssnipper/commits/master.atom date}}
  
 ==== Configuration ==== ==== Configuration ====
plugin/xssnipper.1328906393.txt.gz · Last modified: 2012-02-10 21:39 by 93.199.227.181

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki