petrodoc

package    = 'XSSFilter'
versions   = {
   {'10.12.28', 'December 28, 2010',  'adding UTF8 filtering'},
   {'9.02.15', 'February 15, 2009',  'removing an unnecessary global'},
   {'8.07.07', 'July 7, 2008',  'allowing more safe tags and attributes'},
   {'8.06.22', 'June 22, 2008', 'added anchors to the href/src patterns, and absolute local URLs (i.e. /blah)'},
   {'8.04.20', 'April 20, 2008', 'first public version'},
}
summary    = 'A filter to prevernt cross-site scripting (XSS) attacks'
maintainer = 'Yuri Takhteyev (yuri@freewisdom.org)'

detailed   = [[
     XSSFilter is a module for filtering out unsafe tags from (X)HTML.
     To avoid having second-guessing how different clients handle strange
     HTML input, the filter assumes that the input is subset of valid XML
     and returns nil if the input doesn't parse. If the input does parse,
     we then traverse the tree and check each element and its attributes
     against a configuration table, replacing anything that's not allowed
     with a message.  There is a default configuration table that shoots
     for a balance between security and features, but the client can either
     supply their own or modify the default.
]]

license    = 'MIT/X11'

homepage   = 'http://spu.tnik.org/lib/xssfilter/'
favicon    = 'http://spu.tnik.org/lib/xssfilter/xssfilter-shortcut.png'
download   = 'http://spu.tnik.org/files/xssfilter-$version.tar.gz'
logo       = 'http://spu.tnik.org/lib/xssfilter/xssfilter.png'
keywords   = 'lua, xss'
rss        = homepage.."releases.rss"
--------------------------------------------------------------------------------

dependencies = [[
]]

Installation = [[
  XSSFilter consists of a single module file (colors.lua).  Here is a list of recent
  releases:

  <ul>
  $do_versions[=[<li><a href="$url">$package-$version</a> - $comment ($date) </li> ]=]
  </ul>

  It installs like any other single-file Lua module: just put it somewhere in
  your Lua path.  

  You can also install XSSFilter as a LuaRock from the repository at 
  http://spu.tnik.org/rocks/earth/:

    luarocks install --from http://spu.tnik.org/rocks/fenchurch xssfilter
]]



TOC = {
   { "Overview",     "<p>"..detailed.."</p>" },
   { "Installation", markdown(Installation) },
   { "Using XSSFilter", markdown(include("doc/howto.txt")) },
   { "Contact",      "Please contact Yuri Takhteyev (yuri -at- freewisdom.org) with any questions."},
   { "LuaDoc",       make_luadoc{"xssfilter.lua"} },
   { "License",      markdown(include("LICENSE.txt")) }


}
-------------------------------------------------------------------------------